Visualize Your Ideas With Code
refactor: improve e2e tests (#857)
Jacobad01441d2cfd
diff --git a/.github/workflows/verify.yml b/.github/workflows/verify.ymlindex 7cc9e1eb..c45b51e9 100644--- a/.github/workflows/verify.yml+++ b/.github/workflows/verify.yml@@ -19,7 +19,7 @@ jobs:with:node-version: 18cache: npm- - run: npm ci+ - run: PUPPETEER_PRODUCT=firefox npm ci- uses: actions/cache/save@v3with:key: ${{ github.run_id }}-node-modules@@ -187,6 +187,11 @@ jobs:packages/player/distpackages/vite-plugin/lib- run: npm run e2e:test+ - uses: actions/upload-artifact@v3+ if: failure()+ with:+ name: image-diffs+ path: packages/e2e/src/__image_snapshots__/__diff_output__docs:name: Documentationneeds: builddiff --git a/packages/e2e/package.json b/packages/e2e/package.jsonindex cd253a9d..365ccb29 100644--- a/packages/e2e/package.json+++ b/packages/e2e/package.json@@ -4,6 +4,7 @@"version": "0.0.0","type": "module","scripts": {+ "dev": "vite","test": "vitest"},"dependencies": {diff --git a/packages/e2e/src/__image_snapshots__/circle.png b/packages/e2e/src/__image_snapshots__/circle.pngnew file mode 100644index 00000000..68d50377Binary files /dev/null and b/packages/e2e/src/__image_snapshots__/circle.png differdiff --git a/packages/e2e/src/__image_snapshots__/rect.png b/packages/e2e/src/__image_snapshots__/rect.pngnew file mode 100644index 00000000..1604331fBinary files /dev/null and b/packages/e2e/src/__image_snapshots__/rect.png differdiff --git a/packages/e2e/src/__image_snapshots__/rendering-test-ts-src-rendering-test-ts-rendering-animation-renders-correctly-1-snap.png b/packages/e2e/src/__image_snapshots__/rendering-test-ts-src-rendering-test-ts-rendering-animation-renders-correctly-1-snap.pngdeleted file mode 100644index 8f653425..00000000Binary files a/packages/e2e/src/__image_snapshots__/rendering-test-ts-src-rendering-test-ts-rendering-animation-renders-correctly-1-snap.png and /dev/null differdiff --git a/packages/e2e/src/app.ts b/packages/e2e/src/app.tsindex 1a86e477..daa647e3 100644--- a/packages/e2e/src/app.ts+++ b/packages/e2e/src/app.ts@@ -14,18 +14,16 @@ export async function start(): Promise<App> {const [browser, server] = await Promise.all([puppeteer.launch({headless: 'new',+ product: 'firefox',}),createServer({root: Root,configFile: path.resolve(Root, '../vite.config.ts'),- server: {- port: 9000,- },}).then(server => server.listen()),]);const page = await browser.newPage();- await page.goto('http://localhost:9000');+ await page.goto(`http://localhost:${server.config.server.port}`);await page.waitForSelector('main');return {diff --git a/packages/e2e/src/global.d.ts b/packages/e2e/src/global.d.tsindex 306afed6..b3eb7adf 100644--- a/packages/e2e/src/global.d.ts+++ b/packages/e2e/src/global.d.ts@@ -1,6 +1,6 @@declare namespace jest {interface Matchers<R> {- toMatchImageSnapshot(): R;+ toMatchImageSnapshot(...args: unknown[]): R;}}diff --git a/packages/e2e/src/rendering.test.ts b/packages/e2e/src/rendering.test.tsindex 56a446d5..e63c475e 100644--- a/packages/e2e/src/rendering.test.ts+++ b/packages/e2e/src/rendering.test.ts@@ -1,4 +1,4 @@-import {readFileSync} from 'fs';+import * as fs from 'fs';import {toMatchImageSnapshot} from 'jest-image-snapshot';import {afterAll, beforeAll, describe, expect, test} from 'vitest';import {App, start} from './app';@@ -20,6 +20,30 @@ describe('Rendering', () => {await app.page.click('#render');await app.page.waitForSelector('#render:not([data-rendering="true"])');- expect(readFileSync('./output/project/000300.png')).toMatchImageSnapshot();+ const images = await readOutputFiles();+ for (const {name, content} of images) {+ expect(content).toMatchImageSnapshot({+ customSnapshotIdentifier: name,+ });+ }});});++async function readOutputFiles() {+ const files = await fs.promises.readdir('./output/project');+ const images = await Promise.all(+ files.map(async file => {+ const stat = await fs.promises.stat(`./output/project/${file}`);+ return stat.isDirectory()+ ? {+ name: file,+ content: await fs.promises.readFile(+ `./output/project/${file}/000000.png`,+ ),+ }+ : null;+ }),+ );++ return images.filter(image => image !== null);+}diff --git a/packages/e2e/tests/motion-canvas.d.ts b/packages/e2e/tests/motion-canvas.d.tsnew file mode 100644index 00000000..067c6a44--- /dev/null+++ b/packages/e2e/tests/motion-canvas.d.ts@@ -0,0 +1 @@+/// <reference types="@motion-canvas/core/project" />diff --git a/packages/e2e/tests/project.meta b/packages/e2e/tests/project.metanew file mode 100644index 00000000..2bc37465--- /dev/null+++ b/packages/e2e/tests/project.meta@@ -0,0 +1,32 @@+{+ "version": 0,+ "shared": {+ "background": "rgb(255,255,255)",+ "range": [+ 0,+ null+ ],+ "size": {+ "x": 320,+ "y": 320+ },+ "audioOffset": 0+ },+ "preview": {+ "fps": 30,+ "resolutionScale": 1+ },+ "rendering": {+ "fps": 30,+ "resolutionScale": 1,+ "colorSpace": "srgb",+ "exporter": {+ "name": "@motion-canvas/core/image-sequence",+ "options": {+ "fileType": "image/png",+ "quality": 100,+ "groupByScene": true+ }+ }+ }+}\ No newline at end of filediff --git a/packages/e2e/tests/project.ts b/packages/e2e/tests/project.tsnew file mode 100644index 00000000..4ddbe4b5--- /dev/null+++ b/packages/e2e/tests/project.ts@@ -0,0 +1,8 @@+import {makeProject} from '@motion-canvas/core';++import circle from './scenes/circle?scene';+import rect from './scenes/rect?scene';++export default makeProject({+ scenes: [circle, rect],+});diff --git a/packages/e2e/tests/scenes/circle.meta b/packages/e2e/tests/scenes/circle.metanew file mode 100644index 00000000..04009bec--- /dev/null+++ b/packages/e2e/tests/scenes/circle.meta@@ -0,0 +1,5 @@+{+ "version": 0,+ "timeEvents": [],+ "seed": 4241314046+}\ No newline at end of filediff --git a/packages/e2e/tests/scenes/circle.tsx b/packages/e2e/tests/scenes/circle.tsxnew file mode 100644index 00000000..b2fff4fc--- /dev/null+++ b/packages/e2e/tests/scenes/circle.tsx@@ -0,0 +1,20 @@+import {Circle, makeScene2D} from '@motion-canvas/2d';++export default makeScene2D(function* (view) {+ view.add(+ <Circle+ size={200}+ stroke={'blue'}+ lineWidth={40}+ arrowSize={40}+ fill={'lightseagreen'}+ strokeFirst={true}+ endArrow+ endAngle={-90}+ end={0.5}+ lineCap={'round'}+ cache+ />,+ );+ yield;+});diff --git a/packages/e2e/tests/scenes/rect.meta b/packages/e2e/tests/scenes/rect.metanew file mode 100644index 00000000..62606f0c--- /dev/null+++ b/packages/e2e/tests/scenes/rect.meta@@ -0,0 +1,5 @@+{+ "version": 0,+ "timeEvents": [],+ "seed": 2621987976+}\ No newline at end of filediff --git a/packages/e2e/tests/scenes/rect.tsx b/packages/e2e/tests/scenes/rect.tsxnew file mode 100644index 00000000..e259d24b--- /dev/null+++ b/packages/e2e/tests/scenes/rect.tsx@@ -0,0 +1,14 @@+import {makeScene2D, Rect} from '@motion-canvas/2d';++export default makeScene2D(function* (view) {+ view.add(+ <Rect+ width={300}+ height={200}+ fill={'#0008'}+ radius={[0, 100, 30, 200]}+ start={0.35}+ />,+ );+ yield;+});diff --git a/packages/e2e/tsconfig.json b/packages/e2e/tsconfig.jsonindex e7d53477..fcb1045b 100644--- a/packages/e2e/tsconfig.json+++ b/packages/e2e/tsconfig.json@@ -1,4 +1,4 @@{"extends": "@motion-canvas/2d/tsconfig.project.json",- "include": ["src"]+ "include": ["src", "tests"]}diff --git a/packages/e2e/vite.config.ts b/packages/e2e/vite.config.tsindex ad6d09ce..f70d4fe3 100644--- a/packages/e2e/vite.config.ts+++ b/packages/e2e/vite.config.ts@@ -6,7 +6,7 @@ import {defineConfig} from 'vite';export default defineConfig({plugins: [motionCanvas.default({- project: ['@motion-canvas/template/src/project.ts'],+ project: ['./tests/project.ts'],}),],test: {