chore: tests that mock the fs

Author: jherr

packages/cta-engine/tests/config-file.test.ts

@@ -1,11 +1,19 @@
-import { describe, expect, it } from 'vitest'
+import { beforeEach, describe, expect, it, vi } from 'vitest'
+import { fs, vol } from 'memfs'
 import { resolve } from 'node:path'
 
-import { writeConfigFile } from '../src/config-file.js'
+import { readConfigFile, writeConfigFile } from '../src/config-file.js'
 import { CONFIG_FILE } from '../src/constants.js'
 
 import type { AddOn, Environment, Framework, Options } from '../src/types.js'
 
+vi.mock('node:fs', () => fs)
+vi.mock('node:fs/promises', () => fs.promises)
+
+beforeEach(() => {
+  vol.reset()
+})
+
 describe('writeConfigFile', () => {
   it('should write the config file', async () => {
     const options = {
@@ -37,3 +45,20 @@ describe('writeConfigFile', () => {
     await writeConfigFile(env, targetDir, options)
   })
 })
+
+describe('readConfigFile', () => {
+  it('should read the config file', async () => {
+    const persistedOptions = {
+      version: 1,
+      framework: 'react-cra',
+      existingAddOns: ['add-on-1'],
+    }
+    vol.mkdirSync('/test')
+    vol.writeFileSync(
+      resolve('/test', CONFIG_FILE),
+      JSON.stringify(persistedOptions, null, 2),
+    )
+    const config = await readConfigFile('/test')
+    expect(config).toEqual(persistedOptions)
+  })
+})

packages/cta-engine/tests/create-app.test.ts

@@ -138,7 +138,6 @@ describe('createApp', () => {
       },
     )
 
-    console.log(output.commands)
     expect(output.files['/src/test2.txt']).toEqual('hello')
     expect(output.commands.some(({ command }) => command === 'echo')).toBe(true)
   })

packages/cta-engine/tests/environment.test.ts

@@ -1,13 +1,31 @@
-import { describe, expect, it } from 'vitest'
+import { beforeEach, describe, expect, it, vi } from 'vitest'
+import { fs, vol } from 'memfs'
 
-import { createMemoryEnvironment } from '../src/environment.js'
+vi.mock('node:fs', () => fs)
+vi.mock('node:fs/promises', () => fs.promises)
+
+beforeEach(() => {
+  vol.reset()
+})
+
+import {
+  createMemoryEnvironment,
+  createDefaultEnvironment,
+} from '../src/environment.js'
 
 describe('createMemoryEnvironment', () => {
   it('should handle basic file operations', async () => {
     const { environment, output } = createMemoryEnvironment()
 
     environment.startRun()
+
+    await environment.writeFile('/test.txt', 'test')
+
+    environment.deleteFile('/test.txt')
+    expect(environment.exists('/test.txt')).toBe(false)
+
     await environment.writeFile('/test.txt', 'test')
+
     environment.finishRun()
 
     expect(output.files['/test.txt']).toEqual('test')
@@ -25,3 +43,54 @@ describe('createMemoryEnvironment', () => {
     expect(output.commands[0].args).toEqual(['test'])
   })
 })
+
+describe('createDefaultEnvironment', () => {
+  it('should create a default environment', async () => {
+    const environment = createDefaultEnvironment()
+    expect(environment).toBeDefined()
+  })
+
+  it('should write to the file system', async () => {
+    const environment = createDefaultEnvironment()
+    environment.startRun()
+    await environment.writeFile('/test.txt', 'test')
+    await environment.appendFile('/test.txt', 'test2')
+    await environment.copyFile('/test.txt', '/test2.txt')
+    environment.finishRun()
+
+    expect(fs.readFileSync('/test.txt', 'utf8')).toEqual('testtest2')
+  })
+
+  it('should allow deletes', async () => {
+    const environment = createDefaultEnvironment()
+    await environment.writeFile('/test.txt', 'test')
+    expect(fs.readFileSync('/test.txt', 'utf8')).toEqual('test')
+    await environment.deleteFile('/test.txt')
+    expect(environment.exists('/test.txt')).toBe(false)
+  })
+
+  it('should record errors', async () => {
+    const environment = createDefaultEnvironment()
+    environment.startRun()
+    await environment.execute('command-that-does-not-exist', ['test'], '')
+    environment.finishRun()
+    expect(environment.getErrors()).toEqual([
+      'Command "command-that-does-not-exist test" did not run successfully. Please run this manually in your project.',
+    ])
+  })
+
+  it('should have UI methods', async () => {
+    const environment = createDefaultEnvironment()
+    environment.startRun()
+    environment.intro('test')
+    environment.outro('test')
+    environment.info('test')
+    environment.error('test')
+    environment.warn('test')
+    const s = environment.spinner()
+    s.start('foo')
+    s.stop('bar')
+    environment.finishRun()
+    expect(await environment.confirm('test')).toEqual(true)
+  })
+})

packages/cta-engine/tests/file-helper.test.ts

@@ -1,6 +1,19 @@
-import { describe, expect, it } from 'vitest'
+import { beforeEach, describe, expect, it, vi } from 'vitest'
+import { fs, vol } from 'memfs'
 
-import { relativePath } from '../src/file-helpers.js'
+import {
+  findFilesRecursively,
+  isDirectory,
+  readFileHelper,
+  relativePath,
+} from '../src/file-helpers.js'
+
+vi.mock('node:fs', () => fs)
+vi.mock('node:fs/promises', () => fs.promises)
+
+beforeEach(() => {
+  vol.reset()
+})
 
 describe('relativePath', () => {
   it('relative path with the same directory', () => {
@@ -35,3 +48,43 @@ describe('relativePath', () => {
     ).toBe('../integrations/tanstack-query/layout.tsx')
   })
 })
+
+describe('readFileHelper', () => {
+  it('should read a file', async () => {
+    vol.mkdirSync('/src')
+    fs.writeFileSync('/src/test.txt', 'Hello')
+    expect(readFileHelper('/src/test.txt')).toBe('Hello')
+  })
+  it('should read a binary file', async () => {
+    vol.mkdirSync('/src')
+    fs.writeFileSync('/src/test.jpg', 'Hello')
+    expect(readFileHelper('/src/test.jpg')).toBe('base64::SGVsbG8=')
+  })
+})
+
+describe('isDirectory', () => {
+  it('should check on files and directories', () => {
+    vol.mkdirSync('/src')
+    fs.writeFileSync('/src/test.txt', 'Hello')
+    expect(isDirectory('/src/test.txt')).toBe(false)
+    expect(isDirectory('/src')).toBe(true)
+  })
+})
+
+describe('findFilesRecursively', () => {
+  it('find files recursively', () => {
+    vol.mkdirSync('/src/subdir/subdir2', { recursive: true })
+    fs.writeFileSync('/src/test.txt', 'Hello')
+    fs.writeFileSync('/src/subdir/test.txt', 'Hello')
+    fs.writeFileSync('/src/subdir/subdir2/test.txt', 'Hello')
+
+    const files = {}
+    findFilesRecursively('/src', files)
+
+    expect(Object.keys(files)).toEqual([
+      '/src/subdir/subdir2/test.txt',
+      '/src/subdir/test.txt',
+      '/src/test.txt',
+    ])
+  })
+})

packages/cta-engine/tests/frameworks.test.ts

@@ -0,0 +1,95 @@
+import { beforeEach, describe, expect, it, vi } from 'vitest'
+import { fs, vol } from 'memfs'
+
+import {
+  getFrameworks,
+  getFrameworkById,
+  getFrameworkByName,
+  registerFramework,
+} from '../src/frameworks.js'
+
+vi.mock('node:fs', () => fs)
+vi.mock('node:fs/promises', () => fs.promises)
+
+beforeEach(() => {
+  vol.reset()
+})
+
+describe('registerFramework', () => {
+  it('should register a framework', async () => {
+    const addOnPackageJSON = {
+      id: 'test',
+      name: 'Test',
+      description: 'Test',
+      version: '1.0.0',
+    }
+    const basePackageJSON = {
+      name: 'Test',
+      version: '1.0.0',
+    }
+
+    vol.mkdirSync('/test/add-ons/test/assets', { recursive: true })
+    vol.writeFileSync(
+      '/test/add-ons/test/info.json',
+      JSON.stringify({
+        id: 'test',
+        name: 'Test',
+        description: 'Test',
+        version: '1.0.0',
+      }),
+    )
+    vol.writeFileSync(
+      '/test/add-ons/test/package.json',
+      JSON.stringify({
+        id: 'test',
+        name: 'Test',
+        description: 'Test',
+        version: '1.0.0',
+      }),
+    )
+    vol.writeFileSync(
+      '/test/add-ons/test/assets/package.json',
+      JSON.stringify(addOnPackageJSON),
+    )
+    vol.writeFileSync('/test/add-ons/test/README.md', 'foo')
+    vol.mkdirSync('/test/project/base/assets', { recursive: true })
+    vol.writeFileSync(
+      '/test/project/base/package.json',
+      JSON.stringify(basePackageJSON),
+    )
+    vol.writeFileSync(
+      '/test/project/packages.json',
+      JSON.stringify({
+        typescript: {},
+      }),
+    )
+
+    registerFramework({
+      id: 'test',
+      name: 'Test',
+      addOnsDirectories: ['/test/add-ons'],
+      description: 'Test',
+      version: '1.0.0',
+      baseDirectory: '/test/project',
+      examplesDirectory: '/test/examples',
+    })
+
+    const f = getFrameworkById('test')!
+
+    const baseFiles = await f.getFiles()
+    expect(baseFiles).toEqual(['./package.json'])
+
+    const fileContents = await f.getFileContents('./package.json')
+    expect(fileContents).toEqual(JSON.stringify(basePackageJSON))
+
+    const addOns = await f.getAddOns()
+    const addOnFiles = await addOns[0].getFiles()
+    expect(addOnFiles).toEqual(['./package.json'])
+
+    const addOnFileContents = await addOns[0].getFileContents('./package.json')
+    expect(addOnFileContents).toEqual(JSON.stringify(addOnPackageJSON))
+
+    expect(getFrameworkByName('Test')).not.toBeUndefined()
+    expect(getFrameworks().length).toEqual(1)
+  })
+})

packages/cta-engine/tests/index.test.ts

@@ -0,0 +1,9 @@
+import { describe, expect, it } from 'vitest'
+
+import { createApp } from '../src/index.js'
+
+describe('index', () => {
+  it('should be a test', () => {
+    expect(createApp).toBeDefined()
+  })
+})

packages/cta-engine/tests/template-file.test.ts

@@ -154,8 +154,6 @@ describe('createTemplateFile', () => {
     )
     environment.finishRun()
 
-    console.log(output.files['/test/test.txt'])
-
     expect(output.files['/test/test.txt']).toEqual('/test')
   })
 

packages/cta-engine/vitest.config.ts

@@ -0,0 +1,19 @@
+import { defineConfig } from 'vitest/config'
+import path from 'node:path'
+
+export default defineConfig({
+  test: {
+    deps: {
+      moduleDirectories: ['node_modules', path.resolve('../../packages')],
+    },
+    coverage: {
+      exclude: [
+        'node_modules',
+        'dist',
+        'build',
+        '**/types.ts',
+        'vitest.config.ts',
+      ],
+    },
+  },
+})