From ca6ea5298f12d71109b97e278b5dc8c659e61202 Mon Sep 17 00:00:00 2001 From: TheTallJerry <67441706+TheTallJerry@users.noreply.github.com> Date: Fri, 23 Feb 2024 22:36:09 -0500 Subject: [PATCH] Jest setup for demo website (#19) --- demo/babel.config.json | 7 + demo/jest.config.ts | 203 +++ demo/package.json | 8 +- demo/src/App.tsx | 10 +- demo/src/MemoryModels.tsx | 15 +- demo/src/SvgDisplay.tsx | 15 +- demo/src/__tests__/App.spec.tsx | 44 + .../__tests__/MemoryModelsUserInput.spec.tsx | 70 + demo/src/__tests__/SvgDisplay.spec.tsx | 56 + jest.config.ts | 13 +- package-lock.json | 1382 ++++++++++++++++- package.json | 2 +- src/jest.config.ts | 203 +++ .../tests}/__snapshots__/draw.spec.tsx.snap | 0 {tests => src/tests}/draw.spec.tsx | 2 +- 15 files changed, 1982 insertions(+), 48 deletions(-) create mode 100644 demo/babel.config.json create mode 100644 demo/jest.config.ts create mode 100644 demo/src/__tests__/App.spec.tsx create mode 100644 demo/src/__tests__/MemoryModelsUserInput.spec.tsx create mode 100644 demo/src/__tests__/SvgDisplay.spec.tsx create mode 100644 src/jest.config.ts rename {tests => src/tests}/__snapshots__/draw.spec.tsx.snap (100%) rename {tests => src/tests}/draw.spec.tsx (96%) diff --git a/demo/babel.config.json b/demo/babel.config.json new file mode 100644 index 00000000..39450fb7 --- /dev/null +++ b/demo/babel.config.json @@ -0,0 +1,7 @@ +{ + "presets": [ + "@babel/preset-env", + "@babel/preset-typescript", + "@babel/preset-react" + ] +} diff --git a/demo/jest.config.ts b/demo/jest.config.ts new file mode 100644 index 00000000..0d4c754f --- /dev/null +++ b/demo/jest.config.ts @@ -0,0 +1,203 @@ +/** + * For a detailed explanation regarding each configuration property, visit: + * https://jestjs.io/docs/configuration + */ + +import type { Config } from "jest"; + +const config: Config = { + // All imported modules in your tests should be mocked automatically + // automock: false, + + // Stop running tests after `n` failures + // bail: 0, + + // The directory where Jest should store its cached dependency information + // cacheDirectory: "/private/var/folders/tl/mq0ry9mn37n2_djks873jbj80000gn/T/jest_dx", + + // Automatically clear mock calls, instances, contexts and results before every test + clearMocks: true, + + // Indicates whether the coverage information should be collected while executing the test + collectCoverage: false, + + // An array of glob patterns indicating a set of files for which coverage information should be collected + // collectCoverageFrom: undefined, + + // The directory where Jest should output its coverage files + coverageDirectory: "coverage", + + // An array of regexp pattern strings used to skip coverage collection + // coveragePathIgnorePatterns: [ + // "/node_modules/" + // ], + + // Indicates which provider should be used to instrument code for coverage + // coverageProvider: "babel", + + // A list of reporter names that Jest uses when writing coverage reports + // coverageReporters: [ + // "json", + // "text", + // "lcov", + // "clover" + // ], + + // An object that configures minimum threshold enforcement for coverage results + // coverageThreshold: undefined, + + displayName: "jsdom tests for demo website", + // A path to a custom dependency extractor + // dependencyExtractor: undefined, + + // Make calling deprecated APIs throw helpful error messages + // errorOnDeprecated: false, + + // The default configuration for fake timers + // fakeTimers: { + // "enableGlobally": false + // }, + + // Force coverage collection from ignored files using an array of glob patterns + // forceCoverageMatch: [], + + // A path to a module which exports an async function that is triggered once before all test suites + // globalSetup: undefined, + + // A path to a module which exports an async function that is triggered once after all test suites + // globalTeardown: undefined, + + // A set of global variables that need to be available in all test environments + // globals: {}, + + // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers. + // maxWorkers: "50%", + + // An array of directory names to be searched recursively up from the requiring module's location + // moduleDirectories: ["node_modules", "../src", "../dist"], + + // An array of file extensions your modules use + // moduleFileExtensions: [ + // "js", + // "mjs", + // "cjs", + // "jsx", + // "ts", + // "tsx", + // "json", + // "node" + // ], + + // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module + moduleNameMapper: { + // Force module roughjs to resolve with the CJS entry point, because Jest does not support package.json.exports. Elaborated in PR#15. + roughjs: require.resolve("roughjs"), + }, + + // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader + // modulePathIgnorePatterns: [], + + // Activates notifications for test results + // notify: false, + + // An enum that specifies notification mode. Requires { notify: true } + // notifyMode: "failure-change", + + // A preset that is used as a base for Jest's configuration + // preset: undefined, + + // Run tests from one or more projects + // projects: undefined, + + // Use this configuration option to add custom reporters to Jest + // reporters: undefined, + + // Automatically reset mock state before every test + // resetMocks: false, + + // Reset the module registry before running each individual test + // resetModules: false, + + // A path to a custom resolver + // resolver: undefined, + + // Automatically restore mock state and implementation before every test + // restoreMocks: false, + + // The root directory that Jest should scan for tests and modules within + // rootDir: undefined, + + // A list of paths to directories that Jest should use to search for files in + // roots: [ + // "" + // ], + + // Allows you to use a custom runner instead of Jest's default test runner + // runner: "jest-runner", + + // The paths to modules that run some code to configure or set up the testing environment before each test + // setupFiles: [], + + // A list of paths to modules that run some code to configure or set up the testing framework before each test + setupFilesAfterEnv: ["jest-canvas-mock"], + + // The number of seconds after which a test is considered as slow and reported as such in the results. + // slowTestThreshold: 5, + + // A list of paths to snapshot serializer modules Jest should use for snapshot testing + // snapshotSerializers: [], + + // The test environment that will be used for testing + testEnvironment: "jsdom", + + // Options that will be passed to the testEnvironment + // testEnvironmentOptions: {}, + + // Adds a location field to test results + // testLocationInResults: false, + + // The glob patterns Jest uses to detect test files + // testMatch: [ + // "**/__tests__/**/*.[jt]s?(x)", + // "**/?(*.)+(spec|test).[tj]s?(x)" + // ], + + // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped + // testPathIgnorePatterns: [ + // "/node_modules/" + // ], + + // The regexp pattern or array of patterns that Jest uses to detect test files + // testRegex: [], + + // This option allows the use of a custom results processor + // testResultsProcessor: undefined, + + // This option allows use of a custom test runner + // testRunner: "jest-circus/runner", + + // A map from regular expressions to paths to transformers + // transform: { + // "^.+\\.(ts|tsx|js|jsx)$": "babel-jest", + // }, + + // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation + // transformIgnorePatterns: [ + // "/node_modules/", + // "\\.pnp\\.[^\\/]+$" + // ], + + // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them + // unmockedModulePathPatterns: undefined, + + // Indicates whether each individual test should be reported during the run + // verbose: undefined, + + // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode + // watchPathIgnorePatterns: [], + + // Whether to use watchman for file crawling + // watchman: true, +}; + +export default config; diff --git a/demo/package.json b/demo/package.json index 4d2b871c..1b378d40 100644 --- a/demo/package.json +++ b/demo/package.json @@ -3,7 +3,8 @@ "version": "0.1.0", "description": "Demo website for memory-models-rough", "scripts": { - "test": "echo \"Error: no test specified\" && exit 1", + "test": "jest --no-cache", + "test-cov": "jest --no-cache --coverage", "build-dev": "webpack", "start": "webpack serve" }, @@ -23,17 +24,22 @@ "@babel/preset-env": "^7.23.6", "@babel/preset-react": "^7.23.3", "@babel/preset-typescript": "^7.23.3", + "@testing-library/react": "^14.2.1", "@types/react": "^18.2.45", "@types/react-dom": "^18.2.18", + "babel-jest": "^29.7.0", "babel-loader": "^9.1.3", "css-loader": "^6.8.1", "html-webpack-plugin": "^5.6.0", + "jest-canvas-mock": "^2.5.2", + "jest-environment-jsdom": "^29.7.0", "style-loader": "^3.3.3", "typescript": "^5.3.3", "webpack": "^5.89.0", "webpack-cli": "^5.1.4" }, "dependencies": { + "@emotion/styled": "^11.11.0", "@mui/material": "^5.15.7", "@picocss/pico": "^1.5.10", "react": "^18.2.0", diff --git a/demo/src/App.tsx b/demo/src/App.tsx index 7d80a2e7..aedec23b 100644 --- a/demo/src/App.tsx +++ b/demo/src/App.tsx @@ -12,7 +12,7 @@ export default function App() { try { setJsonResult(JSON.parse(formData)); } catch (error) { - console.error("Error parsing inputted JSON: ", error); + console.error(`Error parsing inputted JSON: ${error.message}`); setJsonResult(null); } }; @@ -26,7 +26,13 @@ export default function App() { />

Output

- Something went wrong}> + + Something went wrong + + } + >
diff --git a/demo/src/MemoryModels.tsx b/demo/src/MemoryModels.tsx index 2eaff012..70b647ac 100644 --- a/demo/src/MemoryModels.tsx +++ b/demo/src/MemoryModels.tsx @@ -1,13 +1,21 @@ import React from "react"; import { Button, Card, CardContent, TextField, Grid } from "@mui/material"; -export default function MemoryModelsUserInput(props) { +type MemoryModelsUserInputPropTypes = { + onSubmit: (event: React.MouseEvent) => void; + setFormData: React.Dispatch>; + formData: string; +}; + +export default function MemoryModelsUserInput( + props: MemoryModelsUserInputPropTypes +) { const handleTextFieldChange = (event) => { props.setFormData(event.target.value); }; return ( -
+ @@ -18,7 +26,6 @@ export default function MemoryModelsUserInput(props) { multiline fullWidth rows={10} - maxRows={20} variant="outlined" value={props.formData} onChange={handleTextFieldChange} @@ -31,8 +38,10 @@ export default function MemoryModelsUserInput(props) {