Skip to content

test: add unit tests for build adapter #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
elio-Wang wants to merge 3 commits into from
Closed

test: add unit tests for build adapter #12

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
337f2a7
test: add unit tests for build adapter
elio-Wang May 13, 2026
49004a2
fix(test): use Promise.allSettled with retry opts for afterEach cleanup
elio-Wang May 13, 2026
15c015b
fix(test): warn on cleanup failure with manual deletion hint
elio-Wang May 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 98 additions & 0 deletions packages/devframe/src/adapters/build.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
import type { DevframeDefinition } from '../types/devframe'
import { existsSync } from 'node:fs'
import fs from 'node:fs/promises'
import { resolve } from 'pathe'
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import { createBuild } from './build'

// Minimal stub definition
function stubDefinition(overrides: Partial<DevframeDefinition> = {}): DevframeDefinition {
return {
id: 'test-devframe',
setup: vi.fn(async () => {}),
cli: { distDir: '/tmp/test-spa-dist' },
...overrides,
} as any
}

describe('createBuild', () => {
const outDir = resolve('/tmp/devframe-build-test-out')
const distDir = resolve('/tmp/test-spa-dist')

beforeEach(async () => {
// Create a fake SPA dist directory with an index.html
await fs.mkdir(distDir, { recursive: true })
await fs.writeFile(resolve(distDir, 'index.html'), '<html></html>')
})
Comment on lines +18 to +26

afterEach(async () => {
await fs.rm(outDir, { recursive: true, force: true })
await fs.rm(distDir, { recursive: true, force: true })

@userquin userquin May 13, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use try-finally block or use await Promise.allSettled, if something is wrong deleting outDir then distDir won't be removed: it would be also nice if we can add some retry options:

// fs comes from `import fs from 'node:fs/promises`
    await fs.rm(tempPath, {
      recursive: true,
      force: true,
      maxRetries: 3,
      retryDelay: 100,
    }).catch((err) => {
      console.error(`Failed to cleanup sandbox at ${tempPath}:`, err)
    })

})

it('throws when no distDir is provided', async () => {
const d = stubDefinition({ cli: undefined })
await expect(createBuild(d, { outDir })).rejects.toThrow('no distDir')
})

it('creates output directory', async () => {
const d = stubDefinition()
await createBuild(d, { outDir, distDir })
expect(existsSync(outDir)).toBe(true)
})

it('copies SPA dist into outDir', async () => {
const d = stubDefinition()
await createBuild(d, { outDir, distDir })
expect(existsSync(resolve(outDir, 'index.html'))).toBe(true)
})

it('writes __connection.json with backend: static', async () => {
const d = stubDefinition()
await createBuild(d, { outDir, distDir })
const meta = JSON.parse(await fs.readFile(resolve(outDir, '__connection.json'), 'utf-8'))
expect(meta.backend).toBe('static')
})

it('creates __rpc-dump directory', async () => {
const d = stubDefinition()
await createBuild(d, { outDir, distDir })
expect(existsSync(resolve(outDir, '__rpc-dump'))).toBe(true)
})

it('writes __rpc-dump/index.json manifest', async () => {
const d = stubDefinition()
await createBuild(d, { outDir, distDir })
expect(existsSync(resolve(outDir, '__rpc-dump/index.json'))).toBe(true)
})

it('writes spa-loader.json when d.spa is defined', async () => {
const d = stubDefinition({ spa: { loader: 'query' } } as any)
await createBuild(d, { outDir, distDir, base: '/app/' })
const loader = JSON.parse(await fs.readFile(resolve(outDir, 'spa-loader.json'), 'utf-8'))
expect(loader.version).toBe(1)
expect(loader.mode).toBe('query')
expect(loader.base).toBe('/app/')
})

it('does not write spa-loader.json when d.spa is undefined', async () => {
const d = stubDefinition()
await createBuild(d, { outDir, distDir })
expect(existsSync(resolve(outDir, 'spa-loader.json'))).toBe(false)
})

it('removes existing outDir before building', async () => {
await fs.mkdir(outDir, { recursive: true })
await fs.writeFile(resolve(outDir, 'stale.txt'), 'old')
const d = stubDefinition()
await createBuild(d, { outDir, distDir })
expect(existsSync(resolve(outDir, 'stale.txt'))).toBe(false)
})

it('calls d.setup with build mode context', async () => {
const setup = vi.fn(async () => {})
const d = stubDefinition({ setup })
await createBuild(d, { outDir, distDir })
expect(setup).toHaveBeenCalledOnce()
})
})