Merge pull request #41 from mathjax/jest_move

Jest move

Author: zorkow

.travis.yml

@@ -5,4 +5,4 @@ sudo: false
 branches:
 install:
   - cd tests; npm install
-script: cd tests; ./tests.sh
+script: npm test

README.md

@@ -161,18 +161,55 @@ samples/test-adaptor.js
 samples/test-styles.js
 ```
 
-## Running TeX Parser Tests
+## Tests
 
-You first need to install tape:
+All tests are located in the `./tests/` directory. We use
+[Jest](https://jestjs.io) as test framework.
+
+### Running Tests
+
+Just go to the `./tests/` directory and run the following two commands:
 
 ``` shell
-nmp install tape
+npm install
+npm test
 ```
 
-Then run tests with
+TeX parser tests in particular are run with the command:
 
 ``` shell
-./tests.sh
+npx jest src/parser.test.js
+```
+
+To only test a single file run
+
+``` shell
+npx jest src/parser.test.js json/FILE.json
+```
+
+Tests initially run against `mathjax-full` package. They can be run against your
+local repository by rerouting the `js` and `es5` directories.
+
+### Test Format
+
+Tests are provided in a JSON test format.
+
+
+``` json
+{
+  "name": NameOfTest,
+  "factory": TestFactory,
+  "tests": {
+    "TEST1": {
+    "input": INPUT
+    "expected": EXPECTED
+    ...rest
+    }
+    ...more tests
+  }
+}
+
 ```
 
-Tests are located in the `tests` sub-directory.
+To add new tests, simply add a new `.json` file in the `json` sub-directory. For
+new test classes add a new entry in `src/test-factory.js`.

tests/.babelrc

@@ -0,0 +1,4 @@
+{
+    "presets": ["@babel/preset-env"],
+    "plugins": ["transform-class-properties"]
+}

tests/jest.config.js

@@ -0,0 +1,195 @@
+// For a detailed explanation regarding each configuration property, visit:
+// https://jestjs.io/docs/en/configuration.html
+
+module.exports = {
+  // 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 and instances between 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: "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,
+
+  // 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",
+  //   "json",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "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 between 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 between 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: "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: "jasmine2",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+  "transform":  {
+    "^.+\\.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,
+};

tests/json/ParserActionTest.json

@@ -259,4 +259,4 @@
       }
     }
   }
-}
+}

tests/json/ParserBaseTest.json

@@ -1,13 +1,6 @@
 {
   "name": "ParserBaseTest",
   "factory": "parserTest",
-  "packages": [
-    "ams",
-    "base"
-  ],
-  "settings": {
-    "tags": "none"
-  },
   "tests": {
     "Identifier": {
       "input": "x",
@@ -10771,4 +10764,4 @@
       }
     }
   }
-}
+}

tests/json/ParserBussproofsRegInfTest.json

@@ -1,6 +1,6 @@
 {
   "name": "ParserBussproofsRegInfTest",
-  "factory": "parserOutputTest",
+  "factory": "parserOutput",
   "packages": [
     "base",
     "ams",

tests/json/ParserBussproofsRegProofsTest.json

@@ -1,6 +1,6 @@
 {
   "name": "ParserBussproofsRegProofsTest",
-  "factory": "parserOutputTest",
+  "factory": "parserOutput",
   "packages": [
     "base",
     "ams",

tests/json/ParserDigitsTest.json

@@ -6,8 +6,7 @@
     "base"
   ],
   "settings": {
-    "tags": "none",
-    "digits": {}
+    "tags": "none"
   },
   "tests": {
     "Integer": {
@@ -381,4 +380,4 @@
       }
     }
   }
-}
+}

tests/json/ParserPhysicsTest1_1.json

@@ -2006,4 +2006,4 @@
       }
     }
   }
-}
+}