Adding jest tests (#617)

* Adding jest tests
* adding more jest
* more tests
* fixing dependencies

Author: DaanV2

.github/workflows/publish-to-vscode.yml

@@ -1,6 +1,9 @@
 # This is a basic workflow to help you get started with Actions
 name: 📦 Publish To Vscode
 
+env:
+  FORCE_COLOR: true
+
 on:
   workflow_dispatch:
   push:

.github/workflows/pull-request.yml

@@ -2,6 +2,9 @@
 # For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
 name: PR
 
+env:
+  FORCE_COLOR: true
+
 on:
   pull_request: {}
   workflow_dispatch: {}

.github/workflows/unit-test.yml

@@ -1,6 +1,9 @@
 # This is a basic workflow to help you get started with Actions
 name: 📋 Unit Test
 
+env:
+  FORCE_COLOR: true
+
 on:
   workflow_dispatch: {}
   workflow_call: {}
@@ -35,4 +38,3 @@ jobs:
         run: |
           npx vsce package
           echo "Size of package: $(du -h *.vsix | cut -f1)" >> $GITHUB_STEP_SUMMARY
-

.gitignore

@@ -8,6 +8,7 @@ dist/
 log.txt
 out
 node_modules
+coverage
 client/server
 .vscode-test
 /documentation/cheat-sheet/*.html

.mocharc.json

@@ -31,6 +31,8 @@ CONTRIBUTING.md
 contributing.mdp
 Debugging.md
 documentation/**
+server/coverage/**
+client/coverage/**
 log.txt
 minecraft colours.json
 NOTE.md
@@ -53,6 +55,7 @@ webpack.config.js
 **/webpack.config.js
 **/package-lock.json
 
+
 !documentation/cheat-sheet
 !documentation/cheat-sheet/*html
 !media/**/*

.vscodeignore

@@ -0,0 +1,193 @@
+/**
+ * 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: "C:\\Users\\daanv\\AppData\\Local\\Temp\\jest",
+
+  // 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: true,
+
+  // 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: "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: {},
+
+  // 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: "ts-jest",
+
+  // 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"],
+
+  // 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: "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",
+
+  // 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,
+
+  // 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;

client/.mocharc.json

@@ -16,7 +16,7 @@
   "scripts": {
     "compile": "tsc -b ./tsconfig.json",
     "pretest": "npm run compile",
-    "test": "mocha -r ts-node/register '**/*.test.ts'",
+    "test": "jest",
     "update": "npm update && npm audit fix"
   },
   "engines": {
@@ -30,13 +30,11 @@
     "vscode-languageclient": "^9.0.1"
   },
   "devDependencies": {
-    "@types/chai": "^4.3.9",
-    "@types/mocha": "^10.0.3",
-    "@types/node": "^20.14.2",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.14.11",
     "@types/vscode": "^1.90.0",
-    "chai": "^4.3.10",
     "json-loader": "^0.5.7",
-    "mocha": "^10.1.0",
+    "ts-jest": "^29.2.2",
     "ts-loader": "^9.4.4",
     "ts-node": "^10.9.2",
     "typescript": "^5.5.3",

client/jest.config.ts

@@ -1,12 +1,11 @@
-import { expect } from "chai";
 import { Languages, ToolIdentification } from "@blockception/shared";
 
 describe("Constants", () => {
   it("values", () => {
-    expect(Languages.McFunctionIdentifier).to.equal(Languages.McFunctionIdentifier.toLowerCase());
+    expect(Languages.McFunctionIdentifier).toEqual(Languages.McFunctionIdentifier.toLowerCase());
   });
 
   it("Tool Identification", () => {
-    expect(ToolIdentification.length).to.be.lessThanOrEqual(32);
+    expect(ToolIdentification.length).toBeLessThanOrEqual(32);
   });
 });

client/package.json

@@ -1,8 +1,9 @@
 {
   "compilerOptions": {
     "alwaysStrict": true,
-    "baseUrl": ".",
     "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "baseUrl": ".",
     "lib": ["ES2019"],
     "module": "commonjs",
     "moduleResolution": "node",
@@ -20,10 +21,9 @@
     "strictNullChecks": true,
     "strictPropertyInitialization": true,
     "target": "es2019",
-    "types": ["node", "mocha"],
-    "forceConsistentCasingInFileNames": true
+    "types": ["node", "jest"]
   },
-  "exclude": ["node_modules", ".vscode-test", "*.test.ts"],
+  "exclude": ["node_modules", ".vscode-test", "*.test.ts", "__tests__"],
   "include": ["./src"],
   "references": [
     { "path": "../shared" }