dazscript-framework 1.0.29 → 1.0.31

package/src/scripts/init.test.ts

@@ -0,0 +1,131 @@
+import fs from 'node:fs'
+import os from 'node:os'
+import path from 'node:path'
+import { afterEach, describe, expect, it } from 'vitest'
+
+const { initIntegrationTests, initUnitTests } = require('../../dist/scripts/init')
+
+const tempDirs: string[] = []
+
+const makeProject = (name = 'toolbox-test'): string => {
+    const projectDir = fs.mkdtempSync(path.join(os.tmpdir(), `${name}-`))
+    tempDirs.push(projectDir)
+    fs.writeFileSync(path.join(projectDir, 'package.json'), JSON.stringify({
+        private: true,
+        scripts: {
+            test: 'vitest run',
+        },
+    }, null, 2))
+    return projectDir
+}
+
+const toFixtureName = (projectDir: string): string =>
+    path.basename(projectDir)
+        .toLowerCase()
+        .replace(/[^a-z0-9]+/g, '-')
+        .replace(/^-+|-+$/g, '') || 'project'
+
+afterEach(() => {
+    while (tempDirs.length > 0) {
+        const dir = tempDirs.pop()
+        if (dir) fs.rmSync(dir, { recursive: true, force: true })
+    }
+})
+
+describe('init integration tests', () => {
+    it('creates the fixture, docs, env examples, npm script, and ignore entries', () => {
+        const projectDir = makeProject('toolbox-test')
+        const fixtureBaseName = toFixtureName(projectDir)
+
+        initIntegrationTests(projectDir, { force: false })
+
+        const fixturePath = path.join(projectDir, `test/integration/fixtures/${fixtureBaseName}-smoke.dsa.ts`)
+        const packageJson = JSON.parse(fs.readFileSync(path.join(projectDir, 'package.json'), 'utf8'))
+        const gitignore = fs.readFileSync(path.join(projectDir, '.gitignore'), 'utf8')
+
+        expect(fs.existsSync(fixturePath)).toBe(true)
+        expect(fs.existsSync(path.join(projectDir, 'test/integration/README.md'))).toBe(true)
+        expect(fs.existsSync(path.join(projectDir, '.env.integration.linux.example'))).toBe(true)
+        expect(fs.existsSync(path.join(projectDir, '.env.integration.windows.example'))).toBe(true)
+        expect(packageJson.scripts['test:integration']).toBe(
+            `dazscript integration --fixture ./test/integration/fixtures/${fixtureBaseName}-smoke.dsa.ts`
+        )
+        expect(gitignore).toContain('test/integration/out/')
+        expect(gitignore).toContain('.env.integration.local')
+    })
+
+    it('does not replace an existing integration script or duplicate ignore entries', () => {
+        const projectDir = makeProject('existing-test')
+        const packageJsonPath = path.join(projectDir, 'package.json')
+        const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'))
+        packageJson.scripts['test:integration'] = 'custom command'
+        fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2))
+        fs.writeFileSync(path.join(projectDir, '.gitignore'), 'test/integration/out/\n')
+
+        initIntegrationTests(projectDir, { force: false })
+        initIntegrationTests(projectDir, { force: false })
+
+        const updatedPackageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'))
+        const gitignore = fs.readFileSync(path.join(projectDir, '.gitignore'), 'utf8')
+
+        expect(updatedPackageJson.scripts['test:integration']).toBe('custom command')
+        expect(gitignore.match(/test\/integration\/out\//g)?.length).toBe(1)
+        expect(gitignore.match(/\.env\.integration\.local/g)?.length).toBe(1)
+    })
+})
+
+describe('init unit tests', () => {
+    it('creates Vitest config, sample test, docs, npm scripts, and dev dependency', () => {
+        const projectDir = makeProject('unit-test')
+        const packageJsonPath = path.join(projectDir, 'package.json')
+        const initialPackageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'))
+        delete initialPackageJson.scripts.test
+        fs.writeFileSync(packageJsonPath, JSON.stringify(initialPackageJson, null, 2))
+
+        initUnitTests(projectDir, { force: false })
+
+        const packageJson = JSON.parse(fs.readFileSync(path.join(projectDir, 'package.json'), 'utf8'))
+
+        expect(fs.existsSync(path.join(projectDir, 'vitest.config.ts'))).toBe(true)
+        expect(fs.existsSync(path.join(projectDir, 'tsconfig.test.json'))).toBe(true)
+        expect(fs.existsSync(path.join(projectDir, 'test/unit/smoke.test.ts'))).toBe(true)
+        expect(fs.existsSync(path.join(projectDir, 'test/unit/README.md'))).toBe(true)
+        expect(packageJson.scripts.test).toBe('vitest run')
+        expect(packageJson.scripts['test:watch']).toBe('vitest')
+        expect(packageJson.devDependencies.vitest).toBe('^3.0.0')
+    })
+
+    it('does not replace existing unit test scripts or duplicate Vitest dependency', () => {
+        const projectDir = makeProject('existing-unit-test')
+        const packageJsonPath = path.join(projectDir, 'package.json')
+        const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'))
+        packageJson.scripts.test = 'custom test'
+        packageJson.scripts['test:watch'] = 'custom watch'
+        packageJson.devDependencies = {
+            vitest: '^4.0.0',
+        }
+        fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2))
+
+        initUnitTests(projectDir, { force: false })
+
+        const updatedPackageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'))
+
+        expect(updatedPackageJson.scripts.test).toBe('custom test')
+        expect(updatedPackageJson.scripts['test:watch']).toBe('custom watch')
+        expect(updatedPackageJson.devDependencies.vitest).toBe('^4.0.0')
+    })
+
+    it('replaces the default npm init failing test script', () => {
+        const projectDir = makeProject('npm-default-unit-test')
+        const packageJsonPath = path.join(projectDir, 'package.json')
+        const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'))
+        packageJson.scripts.test = 'echo "Error: no test specified" && exit 1'
+        fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2))
+
+        initUnitTests(projectDir, { force: false })
+
+        const updatedPackageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'))
+
+        expect(updatedPackageJson.scripts.test).toBe('vitest run')
+    })
+})

package/src/scripts/integration.test.ts

@@ -0,0 +1,97 @@
+import fs from 'node:fs'
+import os from 'node:os'
+import path from 'node:path'
+import { afterEach, describe, expect, it } from 'vitest'
+
+const {
+    loadEnvFile,
+    readIntegrationResult,
+    resolveIntegrationOptions,
+} = require('../../dist/scripts/integration')
+
+const tempDirs: string[] = []
+
+const makeProject = (): string => {
+    const projectDir = fs.mkdtempSync(path.join(os.tmpdir(), 'dsf-integration-'))
+    tempDirs.push(projectDir)
+    fs.mkdirSync(path.join(projectDir, 'test/integration/fixtures'), { recursive: true })
+    fs.writeFileSync(path.join(projectDir, 'test/integration/fixtures/smoke.dsa.ts'), 'action({}, function() {})\n')
+    fs.writeFileSync(path.join(projectDir, 'DAZStudio.exe'), '')
+    return projectDir
+}
+
+afterEach(() => {
+    while (tempDirs.length > 0) {
+        const dir = tempDirs.pop()
+        if (dir) fs.rmSync(dir, { recursive: true, force: true })
+    }
+})
+
+describe('integration env loader', () => {
+    it('loads simple values without overriding existing values', () => {
+        const projectDir = makeProject()
+        const envPath = path.join(projectDir, '.env.integration.local')
+        fs.writeFileSync(envPath, [
+            '# local machine settings',
+            'DAZ_STUDIO_EXE=/from/file/DAZStudio.exe',
+            'DAZ_TEST_TIMEOUT_MS="12345"',
+            'INVALID KEY=ignored',
+            '',
+        ].join('\n'))
+
+        const env: Record<string, string> = {
+            DAZ_STUDIO_EXE: '/from/shell/DAZStudio.exe',
+        }
+
+        expect(loadEnvFile(envPath, env)).toBe(true)
+        expect(env.DAZ_STUDIO_EXE).toBe('/from/shell/DAZStudio.exe')
+        expect(env.DAZ_TEST_TIMEOUT_MS).toBe('12345')
+        expect(env['INVALID KEY']).toBeUndefined()
+    })
+})
+
+describe('integration option resolution', () => {
+    it('uses project-relative fixture and output defaults without requiring content', () => {
+        const projectDir = makeProject()
+        const options = resolveIntegrationOptions(projectDir, {
+            fixture: './test/integration/fixtures/smoke.dsa.ts',
+        }, {
+            DAZ_STUDIO_EXE: path.join(projectDir, 'DAZStudio.exe'),
+        })
+
+        expect(options.fixturePath).toBe(path.join(projectDir, 'test/integration/fixtures/smoke.dsa.ts'))
+        expect(options.outDir).toBe(path.join(projectDir, 'test/integration/out'))
+        expect(options.fixtureRoot).toBe(path.join(projectDir, 'test/integration/out/fixture'))
+        expect(options.resultPath).toBe(path.join(projectDir, 'test/integration/out/fixture/result.json'))
+        expect(options.contentPath).toBe('')
+    })
+
+    it('requires content only when requested', () => {
+        const projectDir = makeProject()
+
+        expect(() => resolveIntegrationOptions(projectDir, {
+            fixture: './test/integration/fixtures/smoke.dsa.ts',
+            requireContent: true,
+        }, {
+            DAZ_STUDIO_EXE: path.join(projectDir, 'DAZStudio.exe'),
+        })).toThrow(/DAZ_TEST_CONTENT_DUF/)
+    })
+})
+
+describe('integration result reader', () => {
+    it('accepts successful result JSON', () => {
+        const projectDir = makeProject()
+        const resultPath = path.join(projectDir, 'result.json')
+        fs.writeFileSync(resultPath, JSON.stringify({ ok: true }))
+
+        expect(readIntegrationResult(resultPath)).toEqual({ ok: true })
+    })
+
+    it('reports fixture failures', () => {
+        const projectDir = makeProject()
+        const resultPath = path.join(projectDir, 'result.json')
+        fs.writeFileSync(resultPath, JSON.stringify({ ok: false, failures: ['bad frame'] }))
+
+        expect(() => readIntegrationResult(resultPath)).toThrow(/bad frame/)
+    })
+})