1
0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00

Add package for shared jest configurations for Lens applications, Features and libraries.

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>
This commit is contained in:
Janne Savolainen 2023-01-30 07:54:33 +02:00
parent 84c6df8714
commit dfc9b2b981
No known key found for this signature in database
GPG Key ID: 8C6CFB2FFFE8F68A
7 changed files with 230 additions and 0 deletions

View File

@ -0,0 +1,55 @@
# @k8slens/jest
This package contains jest configurations and scripts for Lens packages.
## Install
```
$ npm install @k8slens/jest
```
## Features
### Package configurations
Shared configurations for minimal duplication.
#### Node
**./packages/<any-package>/jest.config.js**
```javascript
module.exports = require("@k8slens/jest").monorepoPackageConfig(__dirname).configForNode;
```
#### React
**./packages/<any-package>/jest.config.js**
```javascript
module.exports = require("@k8slens/jest").monorepoPackageConfig(__dirname).configForReact;
```
### Root configuration
You may want to enable testing of packages using single command from root level. This allows you to utilize `jest --watch` between all packages.
**./jest.config.js**
```javascript
module.exports = require("@k8slens/jest").monorepoRootConfig(__dirname);
```
### Scripts
#### lens-test
Test package with coverage enforcement. Automatically opens coverage report in case of failure.
**./packages/<any-package>/package.json**
```json
{
"scripts": {
"test": "lens-test"
}
}
```

View File

@ -0,0 +1,6 @@
jest --coverage --runInBand
result=$?
[ $result != 0 ] && [ -v $CI ] && open ./coverage/lcov-report/index.html
exit $result

View File

@ -0,0 +1,4 @@
module.exports = {
monorepoRootConfig: require("./monorepo-root-config"),
monorepoPackageConfig: require("./monorepo-package-config"),
};

View File

@ -0,0 +1,56 @@
module.exports = (rootDir) => {
const shared = {
transform: {
"^.+\\.(t|j)sx?$": ["@swc/jest", { cwd: rootDir }],
},
clearMocks: true,
coverageDirectory: "coverage",
coverageProvider: "v8",
coverageReporters: ["lcov"],
collectCoverage: true,
testMatch: ["**/?(*.)+(test).{js,ts,tsx}"],
watchPathIgnorePatterns: ["/node_modules/", "/coverage/", "/build/"],
collectCoverageFrom: [
"<rootDir>/src/**/*.{ts,tsx}",
"!<rootDir>/src/**/*.no-coverage.ts",
],
moduleNameMapper: {
"^electron$": "identity-obj-proxy",
},
// Todo: restore threshold after initial hurry.
// coverageThreshold: {
// global: {
// branches: 100,
// functions: 100,
// lines: 100,
// statements: 100,
// },
// },
};
const configForNode = {
...shared,
testEnvironment: "node",
};
const configForReact = {
...shared,
moduleNameMapper: {
"\\.(css|scss)$": "identity-obj-proxy",
...shared.moduleNameMapper,
},
testEnvironment: "jsdom",
setupFilesAfterEnv: [`${__dirname}/setup-react-tests.ts`],
};
return {
configForReact,
configForNode,
};
};

View File

@ -0,0 +1,73 @@
const path = require("path");
const glob = require("glob");
const { omit } = require("lodash/fp");
const getProjectColor = (projectNumber) => {
const colors = [
"red",
"green",
"yellow",
"magenta",
"cyan",
"white",
"redBright",
"greenBright",
"yellowBright",
"blueBright",
"magentaBright",
"cyanBright",
"whiteBright",
];
return colors[projectNumber % colors.length];
};
const nonMultiProjectConfigs = [
"coverageDirectory",
"coverageProvider",
"coverageReporters",
"collectCoverage",
"collectCoverageFrom",
"coveragePathIgnorePatterns",
"coverageThreshold",
];
const toJestMultiProjectConfig = (
{ packageJson, jestConfig, packagePath },
projectNumber
) => ({
rootDir: packagePath,
displayName: {
name: packageJson.name,
color: getProjectColor(projectNumber),
},
...omit(nonMultiProjectConfigs, jestConfig),
});
const getJestConfigsAndPackageJsons = (rootDir) => {
const packageJsonPaths = glob
.sync(`${rootDir}/packages/**/jest.config.js`, {
ignore: "./**/node_modules/**/*",
})
.map((filePath) => path.dirname(filePath));
return packageJsonPaths.map((packagePath) => ({
packagePath,
packageJson: require(`${packagePath}/package.json`),
jestConfig: require(`${packagePath}/jest.config.js`),
}));
};
module.exports = (rootDir) => ({
projects: getJestConfigsAndPackageJsons(rootDir).map(
toJestMultiProjectConfig
),
watchPlugins: [
"jest-watch-typeahead/filename",
"jest-watch-typeahead/testname",
"jest-watch-select-projects",
],
});

View File

@ -0,0 +1,35 @@
{
"name": "@k8slens/jest",
"private": false,
"version": "0.0.1",
"description": "Jest configuration and scripts for Lens packages.",
"type": "commonjs",
"repository": {
"type": "git",
"url": "git+https://github.com/lensapp/monorepo.git"
},
"main": "index.js",
"author": {
"name": "OpenLens Authors",
"email": "info@k8slens.dev"
},
"license": "MIT",
"homepage": "https://github.com/lensapp/lens",
"bin": {
"lens-test": "bin/test.sh"
},
"dependencies": {
"@swc/core": "^1.3.20",
"@swc/jest": "^0.2.23",
"@testing-library/jest-dom": "^5.16.5",
"@testing-library/react": "^13.4.0",
"@types/jest": "^29.2.2",
"identity-obj-proxy": "^3.0.0",
"jest": "^29.3.1",
"jest-environment-jsdom": "^29.3.1",
"jest-watch-select-projects": "^2.0.0",
"jest-watch-typeahead": "^2.2.1",
"lodash": "^4.17.21",
"ts-jest": "^29.0.3"
}
}

View File

@ -0,0 +1 @@
import "@testing-library/jest-dom";