Skip to content
Source
Sign inSign up
TanStack/cli
Open History to see the last commit

environment.test.ts

128 lines3.9 KB

1import { beforeEach, describe, expect, it, vi } from 'vitest'
2import { fs, vol } from 'memfs'
3​
4vi.mock('node:fs', () => fs)
5vi.mock('node:fs/promises', () => fs.promises)
6​
7beforeEach(() => {
8 vol.reset()
9})
10​
11import {
12 createMemoryEnvironment,
13 createDefaultEnvironment,
14} from '../src/environment.js'
15​
16describe('createMemoryEnvironment', () => {
17 it('should handle basic file operations', async () => {
18 const { environment, output } = createMemoryEnvironment()
19​
20 environment.startRun()
21​
22 await environment.writeFile('/test.txt', 'test')
23​
24 environment.deleteFile('/test.txt')
25 expect(environment.exists('/test.txt')).toBe(false)
26​
27 await environment.writeFile('/test.txt', 'test')
28​
29 environment.finishRun()
30​
31 expect(output.files['/test.txt']).toEqual('test')
32 })
33​
34 it('should remove empty directories', async () => {
35 const { environment, output } = createMemoryEnvironment()
36​
37 environment.startRun()
38​
39 await environment.writeFile('/test.txt', 'test')
40​
41 await environment.writeFile('/foo/test1.txt', 'test')
42 await environment.writeFile('/foo/test2.txt', 'test')
43 environment.deleteFile('/foo/test1.txt')
44 environment.deleteFile('/foo/test2.txt')
45​
46 await environment.writeFile('/bar/test1.txt', 'test')
47​
48 environment.finishRun()
49​
50 expect(Object.keys(output.files)).toEqual(['/test.txt', '/bar/test1.txt'])
51 })
52​
53 it('should track command execution', async () => {
54 const { environment, output } = createMemoryEnvironment()
55​
56 environment.startRun()
57 await environment.execute('echo', ['test'], '')
58 environment.finishRun()
59​
60 expect(output.commands.length).toEqual(1)
61 expect(output.commands[0].command).toEqual('echo')
62 expect(output.commands[0].args).toEqual(['test'])
63 })
64})
65​
66describe('createDefaultEnvironment', () => {
67 it('treats an unavailable version probe as unknown without recording a command error', async () => {
68 const environment = createDefaultEnvironment()
69 await expect(environment.getPackageManagerVersion?.(
70 'pnpm', '/unavailable-pnpm-version-probe-fixture',
71 )).resolves.toBeUndefined()
72 expect(environment.getErrors()).toEqual([])
73 })
74​
75 it('should create a default environment', async () => {
76 const environment = createDefaultEnvironment()
77 expect(environment).toBeDefined()
78 })
79​
80 it('should write to the file system', async () => {
81 const environment = createDefaultEnvironment()
82 environment.startRun()
83 await environment.writeFile('/test.txt', 'test')
84 await environment.appendFile('/test.txt', 'test2')
85 await environment.copyFile('/test.txt', '/test2.txt')
86 environment.finishRun()
87​
88 expect(fs.readFileSync('/test.txt', 'utf8')).toEqual('testtest2')
89 })
90​
91 it('should allow deletes', async () => {
92 const environment = createDefaultEnvironment()
93 await environment.writeFile('/test.txt', 'test')
94 expect(fs.readFileSync('/test.txt', 'utf8')).toEqual('test')
95 await environment.deleteFile('/test.txt')
96 expect(environment.exists('/test.txt')).toBe(false)
97 })
98​
99 it('should record errors', async () => {
100 const environment = createDefaultEnvironment()
101 environment.startRun()
102 const result = await environment.execute(
103 'command-that-does-not-exist',
104 ['test'],
105 '',
106 )
107 expect(result).toEqual({ stdout: '', failed: true })
108 environment.finishRun()
109 expect(environment.getErrors()).toEqual([
110 'Command "command-that-does-not-exist test" did not run successfully. Please run this manually in your project.',
111 ])
112 })
113​
114 it('should have UI methods', async () => {
115 const environment = createDefaultEnvironment()
116 environment.startRun()
117 environment.intro('test')
118 environment.outro('test')
119 environment.info('test')
120 environment.error('test')
121 environment.warn('test')
122 const s = environment.spinner()
123 s.start('foo')
124 s.stop('bar')
125 environment.finishRun()
126 expect(await environment.confirm('test')).toEqual(true)
127 })
128})