Add Jest testing framework

This commit is contained in:
Catalin Constantin Mititiuc 2025-03-06 15:27:27 -08:00
parent c0b2d77d14
commit f0b5c1a511
9 changed files with 4208 additions and 16 deletions

View File

@ -74,12 +74,40 @@ window.addEventListener('load', function () {
## Start the demo ## Start the demo
### Docker
1. Install the development server packages. 1. Install the development server packages.
$ docker run --rm -w /app -v $PWD:/app -u $(id -u):$(id -u) node npm install $ docker run --rm -w /app -v $PWD:/app -u $(id -u):$(id -u) node npm install
2. Start the server. 2. Start the server.
$ docker run --rm --init -it -w /app -v $PWD:/app -p 8080:8080 node node dev-server.js $ docker run --rm --init -it -w /app -v $PWD:/app -p 8080:8080 node npm run start
3. Visit `localhost:8080` to view. 3. Visit `localhost:8080` to view.
### Debian
1. Install the development server packages.
$ npm install
2. Start the server.
$ npm run start
3. Visit `localhost:8080` to view.
## Tests
Requires Chrome/ChromeDriver or Chromium/ChromiumDriver.
### Docker
$ docker run --rm --init -it -w /app -v $PWD:/app node bash -c "apt-get \
update && apt-get install -y chromium-driver chromium && npm run test"
### Debian
$ apt-get update && apt-get install chromium-driver chromium
$ npm run test

View File

@ -0,0 +1,21 @@
const { Builder } = require('selenium-webdriver');
const chrome = require('selenium-webdriver/chrome');
const chromeOptions = new chrome.Options();
let driver;
chromeOptions.addArguments('--headless', '--disable-gpu', '--no-sandbox');
beforeEach(async () => {
const builder = new Builder().forBrowser('chrome').setChromeOptions(chromeOptions);
driver = builder.build();
});
it('loads the page', async () => {
await driver.get('http://localhost:8080');
expect(await driver.getTitle()).toEqual('SVG Element Pan & Zoom Demo');
});
afterEach(async () => {
await driver.quit();
});

View File

@ -0,0 +1,21 @@
const { spawn } = require('child_process');
module.exports = async function (globalConfig, projectConfig) {
console.info('\nSpawning server process...');
const child = spawn('node', ['server.js']);
child.stdout.on('data', data => {
console.log(`${data}`);
});
globalThis.__INTEG_TEST_SERVER_PID__ = child.pid;
child.stderr.on('data', data => {
const str = data.toString();
console.log('[server]', str);
if (str.includes(projectConfig.globals.testServerUrl)) {
setTimeout(resolve, 200);
}
});
};

View File

@ -0,0 +1,4 @@
module.exports = async function (globalConfig, projectConfig) {
console.info('Stopping server.');
process.kill(globalThis.__INTEG_TEST_SERVER_PID__);
};

View File

@ -1,11 +0,0 @@
require('esbuild-server')
.createServer(
{
bundle: true,
entryPoints: ['src/app.js'],
},
{
static: 'public',
}
)
.start();

219
jest.config.js Normal file
View File

@ -0,0 +1,219 @@
/**
* For a detailed explanation regarding each configuration property, visit:
* https://jestjs.io/docs/configuration
*/
/** @type {import('jest').Config} */
const 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: "/tmp/jest_rs",
// 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: undefined,
// 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: "v8",
// 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,
// 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,
globalSetup: './__tests__/integration/setup.js',
// A path to a module which exports an async function that is triggered once after all test suites
// globalTeardown: undefined,
globalTeardown: './__tests__/integration/teardown.js',
// 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"
// ],
// 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: {},
// 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: [
// "<rootDir>"
// ],
// 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: [],
// 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",
testEnvironment: "node",
// 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/"
// ],
testPathIgnorePatterns: [
"/node_modules/",
"setup.js",
"teardown.js",
],
// 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: undefined,
// 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,
verbose: true,
// 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,
// Shuffle the order of the tests within a file
randomize: true,
};
console.info('Jest config file read.');
module.exports = config;

3883
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -7,7 +7,7 @@
"./src/modules" "./src/modules"
], ],
"scripts": { "scripts": {
"test": "echo \"Error: no test specified\" && exit 1" "test": "jest"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
@ -18,10 +18,12 @@
"pan", "pan",
"zoom" "zoom"
], ],
"author": "Catalin Mititiuc", "author": "Catalin Mititiuc <webdevcat@proton.me> (https://webdevcat.me)",
"license": "ISC", "license": "ISC",
"devDependencies": { "devDependencies": {
"esbuild": "^0.20.2", "esbuild": "^0.20.2",
"esbuild-server": "^0.3.0" "esbuild-server": "^0.3.0",
"jest": "^29.7.0",
"selenium-webdriver": "^4.29.0"
} }
} }

27
server.js Normal file
View File

@ -0,0 +1,27 @@
const { createServer } = require('esbuild-server');
//https://esbuild.github.io/api/#build
const buildOptions = {
bundle: true,
entryPoints: ['src/app.js'],
};
//https://github.com/oblador/esbuild-server?tab=readme-ov-file#serveroptions
const serverOptions = {
static: 'public',
};
const env = process.env.NODE_ENV === 'test' ? 'Test' : 'Development';
const server = createServer(buildOptions, serverOptions);
const buildStart = Date.now();
server
.start()
.then(() => {
console.log(`Build completed in ${Date.now() - buildStart}ms`);
})
.catch(() => {
console.error('Build failed');
});
console.log(`${env} server running at ${server.url}`);