Skip to content

Commit

Permalink
chore: upgrade jest to v29 (#194)
Browse files Browse the repository at this point in the history
  • Loading branch information
@kormide
kormide authored Jan 9, 2025
1 parent 0bbb6c3 commit ad4297f
Show file tree
Hide file tree
Showing 16 changed files with 1,195 additions and 1,139 deletions.
370 changes: 185 additions & 185 deletions e2e/__snapshots__/e2e.spec.ts.snap
View file

Large diffs are not rendered by default.

185 changes: 6 additions & 179 deletions jest.config.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,198 +4,25 @@
*/

export default {
// 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/pd/mpctclh50bd0bxp2n1th3z_w0000gn/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: 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,

// 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: {
"ts-jest": {
useESM: true,
},
},

// 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: {
// We compile TypeScript to ES6 which requires extensions in module specifiers,
// however adding the extension fails under jest tests. Remove the ".js" extension
// from module names when running tests.
"^(\\.{1,2}/.*)\\.js$": "$1",
},

// 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: ["src", "e2e"],

// 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: [],
// An array of regexp pattern strings that are matched against all module paths before those paths are to be considered 'visible' to the module loader.
modulePathIgnorePatterns: ["<rootDir>/dist"],

// 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: "jest-environment-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/"
// ],

// 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",
setupFilesAfterEnv: ["./jest.setup.ts"],

// A map from regular expressions to paths to transformers
transform: {
"^.+\\.ts?$": "ts-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,
};
78 changes: 11 additions & 67 deletions jest.setup.ts
View file
Original file line number Diff line number Diff line change
@@ -1,73 +1,9 @@
import { MatcherFunction } from 'expect'
import { expect } from "@jest/globals";

declare global {
namespace jest {
interface Matchers<R> {
toThrowErrorContaining<T extends Error>(
errorType: new (...args: any[]) => T,
message: string
): R;
}
interface Expect {
matchesPredicate(predicate: (actual: any) => boolean): any;
}
interface ExpectExtendMap {
matchesPredicate: MatcherFunction<[predicate: (actual: any) => boolean]>;
}
}
}
import { toThrowWithMessage } from "jest-extended";
expect.extend({ toThrowWithMessage });

expect.extend({
toThrowErrorContaining<T extends Error>(
func: Function,
errorType: new (...args: any[]) => T,
message: string
) {
try {
func();
} catch (e) {
if (!(e instanceof errorType)) {
return {
pass: false,
message: () => `\
Expected error to throw:
${errorType}
But instead it threw:
${e.constructor}
`,
};
}

if (!e.message.includes(message)) {
return {
pass: false,
message: () => `\
Expected error message to contain:
${message}
But instead it was:
${e.message}
`,
};
}

return {
pass: true,
message: () => "",
};
}

return {
pass: false,
message: () => "Expected function to throw but it did not",
};
},

matchesPredicate(actual: any, predicate: (actual: any) => boolean) {
return {
pass: predicate(actual),
Expand All @@ -76,4 +12,12 @@ But instead it was:
},
});

declare global {
namespace jest {
interface Expect {
matchesPredicate(predicate: (actual: any) => boolean): any;
}
}
}

export default undefined;
10 changes: 6 additions & 4 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,12 @@
"yaml": "^2.1.1"
},
"devDependencies": {
"@jest/globals": "^29.7.0",
"@octokit/webhooks-methods": "^4.0.0",
"@types/archiver": "^6.0.2",
"@types/diff": "^5.0.2",
"@types/imapflow": "1.0.17",
"@types/jest": "^28.0.0",
"@types/jest": "^29.5.14",
"@types/mailparser": "^3.4.4",
"@types/node": "^18.6.2",
"@types/nodemailer": "^6.4.5",
Expand All @@ -57,12 +58,13 @@
"expect": "^28.1.3",
"globby": "^14.0.0",
"imapflow": "^1.0.147",
"jest": "^28.1.3",
"jest-mock": "^28.1.3",
"jest": "^29.7.0",
"jest-extended": "^4.0.2",
"jest-mock": "^29.7.0",
"mailparser": "3.6.6",
"mockttp": "^3.10.0",
"portfinder": "^1.0.32",
"ts-jest": "^28.0.7",
"ts-jest": "^29.2.5",
"ts-node": "^10.9.1",
"typescript": "^5.0.0"
},
Expand Down
Loading

0 comments on commit ad4297f

Please sign in to comment.