1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
/**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
import { getUserStartupWarnings } from './userStartupWarnings.js';
import * as os from 'os';
import fs from 'fs/promises';
import path from 'path';
vi.mock('os', () => ({
default: { homedir: vi.fn() },
homedir: vi.fn(),
}));
vi.mock('fs/promises', () => ({
default: { realpath: vi.fn() },
}));
describe('getUserStartupWarnings', () => {
const homeDir = '/home/user';
beforeEach(() => {
vi.mocked(os.homedir).mockReturnValue(homeDir);
vi.mocked(fs.realpath).mockImplementation(async (path) => path.toString());
});
afterEach(() => {
vi.clearAllMocks();
});
describe('home directory check', () => {
it('should return a warning when running in home directory', async () => {
vi.mocked(fs.realpath)
.mockResolvedValueOnce(homeDir)
.mockResolvedValueOnce(homeDir);
const warnings = await getUserStartupWarnings(homeDir);
expect(warnings).toContainEqual(
expect.stringContaining('home directory'),
);
});
it('should not return a warning when running in a project directory', async () => {
vi.mocked(fs.realpath)
.mockResolvedValueOnce('/some/project/path')
.mockResolvedValueOnce(homeDir);
const warnings = await getUserStartupWarnings('/some/project/path');
expect(warnings).not.toContainEqual(
expect.stringContaining('home directory'),
);
});
it('should handle errors when checking directory', async () => {
vi.mocked(fs.realpath)
.mockRejectedValueOnce(new Error('FS error'))
.mockResolvedValueOnce(homeDir);
const warnings = await getUserStartupWarnings('/error/path');
expect(warnings).toContainEqual(
expect.stringContaining('Could not verify'),
);
});
});
// // Example of how to add a new check:
// describe('node version check', () => {
// // Tests for node version check would go here
// // This shows how easy it is to add new test sections
// });
describe('root directory check', () => {
it('should return a warning when running in root directory on Unix', async () => {
vi.mocked(fs.realpath)
.mockResolvedValueOnce('/')
.mockResolvedValueOnce(homeDir);
const warnings = await getUserStartupWarnings('/');
expect(warnings).toContainEqual(
expect.stringContaining('root directory'),
);
expect(warnings).toContainEqual(
expect.stringContaining('folder structure will be used'),
);
});
it('should return a warning when running in root directory on Windows', async () => {
vi.mocked(fs.realpath)
.mockResolvedValueOnce('C:\\')
.mockResolvedValueOnce(homeDir);
vi.spyOn(path, 'dirname').mockImplementation(path.win32.dirname);
const warnings = await getUserStartupWarnings('C:\\');
expect(warnings).toContainEqual(
expect.stringContaining('root directory'),
);
expect(warnings).toContainEqual(
expect.stringContaining('folder structure will be used'),
);
});
it('should not return a warning when running in a non-root directory', async () => {
vi.mocked(fs.realpath)
.mockResolvedValueOnce('/some/project/path')
.mockResolvedValueOnce(homeDir);
const warnings = await getUserStartupWarnings('/some/project/path');
expect(warnings).not.toContainEqual(
expect.stringContaining('root directory'),
);
});
it('should handle errors when checking root directory', async () => {
vi.mocked(fs.realpath)
.mockRejectedValueOnce(new Error('FS error'))
.mockResolvedValueOnce(homeDir);
const warnings = await getUserStartupWarnings('/');
expect(warnings).toContainEqual(
expect.stringContaining('Could not verify'),
);
});
});
});
|
