Skip to content

Commit f677545

Browse files
MarcLMarcL
authored
test: add static tests (#55)
* test: add static tests
1 parent 85aac60 commit f677545

File tree

8 files changed

+506
-1464
lines changed

8 files changed

+506
-1464
lines changed

‎package-lock.json

+313-1,458
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/build/content/static-pages.test.ts

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
import { expect, test, vi, afterEach } from 'vitest'
2+
import { join } from 'node:path'
3+
import { BUILD_DIR } from '../constants.js'
4+
import { copyStaticContent } from './static.js'
5+
import { createFsFixture, FixtureTestContext } from '../../../tests/utils/fixture.js'
6+
import { globby } from 'globby'
7+
8+
// Globby wasn't easy to mock so instead we're using a temporary
9+
// directory and the actual file system to test static pages
10+
11+
afterEach(() => {
12+
vi.restoreAllMocks()
13+
})
14+
15+
test<FixtureTestContext>('should copy the static pages to the publish directory if they have no corresponding JSON files', async (ctx) => {
16+
const { cwd } = await createFsFixture(
17+
{
18+
[`${BUILD_DIR}/.next/static/test.js`]: '',
19+
[`${BUILD_DIR}/.next/server/pages/test.html`]: '',
20+
[`${BUILD_DIR}/.next/server/pages/test2.html`]: '',
21+
},
22+
ctx,
23+
)
24+
25+
const PUBLISH_DIR = join(cwd, 'publish')
26+
await copyStaticContent({ PUBLISH_DIR })
27+
28+
const files = await globby('**/*', { cwd, extglob: true })
29+
30+
expect(files).toEqual(
31+
expect.arrayContaining([
32+
'publish/_next/static/test.js',
33+
'publish/test.html',
34+
'publish/test2.html',
35+
]),
36+
)
37+
})
38+
39+
test<FixtureTestContext>('should not copy the static pages to the publish directory if they have corresponding JSON files', async (ctx) => {
40+
const { cwd } = await createFsFixture(
41+
{
42+
[`${BUILD_DIR}/.next/static/test.js`]: '',
43+
[`${BUILD_DIR}/.next/server/pages/test.html`]: '',
44+
[`${BUILD_DIR}/.next/server/pages/test.json`]: '',
45+
[`${BUILD_DIR}/.next/server/pages/test2.html`]: '',
46+
[`${BUILD_DIR}/.next/server/pages/test2.json`]: '',
47+
},
48+
ctx,
49+
)
50+
51+
const PUBLISH_DIR = join(cwd, 'publish')
52+
await copyStaticContent({ PUBLISH_DIR })
53+
54+
const files = await globby('**/*', { cwd, extglob: true })
55+
56+
expect(files).toEqual(expect.arrayContaining(['publish/_next/static/test.js']))
57+
})

‎src/build/content/static.test.ts

+81
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
import { vol, fs } from 'memfs'
2+
import { expect, test, vi, afterEach } from 'vitest'
3+
import { join } from 'node:path'
4+
import { BUILD_DIR } from '../constants.js'
5+
import { copyStaticContent } from './static.js'
6+
import { mockFileSystem, fsCpHelper } from '../../../tests/index.js'
7+
8+
vi.mock('node:fs', () => fs)
9+
vi.mock('node:fs/promises', () => {
10+
return {
11+
...fs.promises,
12+
cp: (src, dest, options) => fsCpHelper(src, dest, options),
13+
}
14+
})
15+
16+
afterEach(() => {
17+
vol.reset()
18+
vi.restoreAllMocks()
19+
})
20+
21+
test('should copy the static assets from the build to the publish directory', async () => {
22+
const cwd = mockFileSystem({
23+
[`${BUILD_DIR}/.next/static/test.js`]: '',
24+
[`${BUILD_DIR}/.next/static/sub-dir/test2.js`]: '',
25+
})
26+
27+
const PUBLISH_DIR = join(cwd, 'publish')
28+
await copyStaticContent({ PUBLISH_DIR })
29+
30+
const filenamesInVolume = Object.keys(vol.toJSON())
31+
expect(filenamesInVolume).toEqual(
32+
expect.arrayContaining([
33+
`${PUBLISH_DIR}/_next/static/test.js`,
34+
`${PUBLISH_DIR}/_next/static/sub-dir/test2.js`,
35+
]),
36+
)
37+
})
38+
39+
test('should throw expected error if no static assets directory exists', async () => {
40+
const cwd = mockFileSystem({})
41+
42+
const PUBLISH_DIR = join(cwd, 'publish')
43+
const staticDirectory = join(cwd, '.netlify/.next/static')
44+
45+
await expect(copyStaticContent({ PUBLISH_DIR })).rejects.toThrowError(
46+
`Failed to copy static assets: Error: ENOENT: no such file or directory, readdir '${staticDirectory}'`,
47+
)
48+
})
49+
50+
test('should copy files from the public directory to the publish directory', async () => {
51+
const cwd = mockFileSystem({
52+
[`${BUILD_DIR}/.next/static/test.js`]: '',
53+
'public/fake-image.svg': '',
54+
'public/another-asset.json': '',
55+
})
56+
57+
const PUBLISH_DIR = join(cwd, 'publish')
58+
await copyStaticContent({ PUBLISH_DIR })
59+
60+
const filenamesInVolume = Object.keys(vol.toJSON())
61+
expect(filenamesInVolume).toEqual(
62+
expect.arrayContaining([
63+
`${PUBLISH_DIR}/public/fake-image.svg`,
64+
`${PUBLISH_DIR}/public/another-asset.json`,
65+
]),
66+
)
67+
})
68+
69+
test('should not copy files if the public directory does not exist', async () => {
70+
const cwd = mockFileSystem({
71+
[`${BUILD_DIR}/.next/static/test.js`]: '',
72+
})
73+
74+
const PUBLISH_DIR = join(cwd, 'publish')
75+
await expect(copyStaticContent({ PUBLISH_DIR })).resolves.toBeUndefined()
76+
77+
expect(vol.toJSON()).toEqual({
78+
[join(cwd, `${BUILD_DIR}/.next/static/test.js`)]: '',
79+
[`${PUBLISH_DIR}/_next/static/test.js`]: '',
80+
})
81+
})

‎src/build/content/static.ts

+4-2
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ const copyStaticAssets = async ({
3939
const src = join(process.cwd(), BUILD_DIR, '.next/static')
4040
const dist = join(PUBLISH_DIR, '_next/static')
4141
await mkdir(dist, { recursive: true })
42-
cp(src, dist, { recursive: true, force: true })
42+
await cp(src, dist, { recursive: true, force: true })
4343
} catch (error) {
4444
throw new Error(`Failed to copy static assets: ${error}`)
4545
}
@@ -64,7 +64,9 @@ const copyPublicAssets = async ({
6464
/**
6565
* Move static content to the publish dir so it is uploaded to the CDN
6666
*/
67-
export const copyStaticContent = async ({ PUBLISH_DIR }: NetlifyPluginConstants): Promise<void> => {
67+
export const copyStaticContent = async ({
68+
PUBLISH_DIR,
69+
}: Pick<NetlifyPluginConstants, 'PUBLISH_DIR'>): Promise<void> => {
6870
await Promise.all([
6971
copyStaticPages(join(process.cwd(), BUILD_DIR, '.next'), PUBLISH_DIR),
7072
copyStaticAssets({ PUBLISH_DIR }),

‎tests/utils/fixture.ts

+29-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { BlobsServer, type getStore } from '@netlify/blobs'
2-
import { TestContext, assert, expect, vi } from 'vitest'
2+
import { TestContext, assert, vi } from 'vitest'
33

44
import type {
55
NetlifyPluginConstants,
@@ -10,9 +10,9 @@ import type { LambdaResponse } from '@netlify/serverless-functions-api/dist/lamb
1010
import { zipFunctions } from '@netlify/zip-it-and-ship-it'
1111
import { execaCommand } from 'execa'
1212
import { execute } from 'lambda-local'
13-
import { cp, mkdtemp, rm } from 'node:fs/promises'
13+
import { cp, mkdtemp, rm, mkdir, writeFile } from 'node:fs/promises'
1414
import { tmpdir } from 'node:os'
15-
import { join } from 'node:path'
15+
import { join, dirname } from 'node:path'
1616
import { fileURLToPath } from 'node:url'
1717
import { SERVER_FUNCTIONS_DIR, SERVER_HANDLER_NAME } from '../../src/build/constants.js'
1818
import { streamToString } from './stream-to-string.js'
@@ -62,6 +62,32 @@ export const createFixture = async (fixture: string, ctx: FixtureTestContext) =>
6262
return { cwd: ctx.cwd }
6363
}
6464

65+
export const createFsFixture = async (fixture: Record<string, string>, ctx: FixtureTestContext) => {
66+
ctx.cwd = await mkdtemp(join(tmpdir(), 'netlify-next-runtime-'))
67+
vi.spyOn(process, 'cwd').mockReturnValue(ctx.cwd)
68+
ctx.cleanup = async () => {
69+
try {
70+
await rm(ctx.cwd, { recursive: true, force: true })
71+
} catch {
72+
// noop
73+
}
74+
}
75+
76+
try {
77+
await Promise.all(
78+
Object.entries(fixture).map(async ([key, value]) => {
79+
const filepath = join(ctx.cwd, key)
80+
await mkdir(dirname(filepath), { recursive: true })
81+
await writeFile(filepath, value, 'utf-8')
82+
}),
83+
)
84+
} catch (error) {
85+
throw new Error(`could not prepare the fixture from json ${error}`)
86+
}
87+
88+
return { cwd: ctx.cwd }
89+
}
90+
6591
/**
6692
* This method does basically two main parts
6793
* 1. Running the `onBuild` plugin with a set of defined constants

‎tests/utils/fsCpHelper.ts

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
import { readdirSync, existsSync, mkdirSync, statSync, copyFileSync } from 'node:fs'
2+
import { join } from 'node:path'
3+
4+
export function fsCpHelper(sourceDir: string, targetDir: string, options): void {
5+
if (!existsSync(targetDir)) {
6+
mkdirSync(targetDir)
7+
}
8+
9+
const files = readdirSync(sourceDir)
10+
11+
for (const file of files) {
12+
const sourceFilePath = join(sourceDir, file)
13+
const targetFilePath = join(targetDir, file)
14+
15+
if (statSync(sourceFilePath).isDirectory()) {
16+
fsCpHelper(sourceFilePath, targetFilePath, options)
17+
} else {
18+
copyFileSync(sourceFilePath, targetFilePath)
19+
}
20+
}
21+
}

‎tests/utils/index.ts

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
export * from './helpers.js'
22
export * from './mock-file-system.js'
33
export * from './stream-to-string.js'
4+
export * from './fsCpHelper.js'

‎tests/utils/mock-file-system.ts

-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
import fs from 'node:fs'
21
import { platform } from 'node:os'
32
import { join } from 'node:path'
43

0 commit comments

Comments
 (0)