Switch from jasmine to jest (#747)

Summary:
The reasons for switching to jest:
- easy snapshot testing so that we can easily verify the structure of the parse tree and MathML tree
- easy compilation of ES6 features for tests as we continue to expand our use of ES6

Test Plan:
- npm test

.gitignore

@@ -12,3 +12,4 @@ diff.png
 /test/symgroups.log
 /test/symgroups.pdf
 /test/screenshotter/unicode-fonts
+coverage/

CONTRIBUTING.md

@@ -60,18 +60,22 @@ This will host an interactive editor at
 [http://localhost:7936/](http://localhost:7936/) to play around with and test
 changes.
 
-#### Jasmine tests
+#### Jest tests
 
-The JavaScript parser and some of the tree
-builder is tested with Jasmine. These tests can be run either using node with
-`make test`, or in the browser by visiting
-[http://localhost:7936/test/test.html](http://localhost:7936/test/test.html).
+The JavaScript parser and some of the HTML and MathML tree
+builders are tested with Jest. These tests can be run using node with
+`make test`.  If you need to debug the tests see
+[https://facebook.github.io/jest/docs/troubleshooting.html](https://facebook.github.io/jest/docs/troubleshooting.html)
 
-The Jasmine tests should be run after every change, even the addition of small
+The interactive editor can also be used for debugging tests in the browser by
+copy/pasting the test case to be debugged into the editor.  The permalink option
+can come in really useful when doing repeated runs of the same test case.
+
+The Jest tests should be run after every change, even the addition of small
 symbols. However, [Travis](https://travis-ci.org/Khan/KaTeX/) will run these
 tests when you submit a pull request, in case you forget.
 
-If you make any changes to Parser.js, add Jasmine tests to ensure they work.
+If you make any changes to Parser.js, add Jest tests to ensure they work.
 
 #### Screenshot tests
 

Makefile

@@ -1,4 +1,4 @@
-.PHONY: build dist lint setup copy serve clean metrics test zip contrib
+.PHONY: build dist lint setup copy serve clean metrics test coverage zip contrib
 build: lint build/katex.min.js build/katex.min.css contrib zip compress
 
 ifeq ($(KATEX_DIST),skip)
@@ -101,7 +101,10 @@ serve: $(NIS)
 	$(NODE) server.js
 
 test: $(NIS)
-	JASMINE_CONFIG_PATH=test/jasmine.json node_modules/.bin/jasmine
+	node_modules/.bin/jest
+
+coverage: $(NIS)
+	node_modules/.bin/jest --coverage
 
 PERL=perl
 PYTHON=$(shell python2 --version >/dev/null 2>&1 && echo python2 || echo python)

contrib/auto-render/auto-render-spec.js

@@ -1,5 +1,4 @@
 /* global beforeEach: false */
-/* global jasmine: false */
 /* global expect: false */
 /* global it: false */
 /* global describe: false */
@@ -7,10 +6,8 @@
 const splitAtDelimiters = require("./splitAtDelimiters");
 
 beforeEach(function() {
-    jasmine.addMatchers({
-        toSplitInto: function() {
-            return {
-                compare: function(actual, left, right, result) {
+    expect.extend({
+        toSplitInto: function(actual, left, right, result) {
             const message = {
                 pass: true,
                 message: "'" + actual + "' split correctly",
@@ -60,8 +57,6 @@ beforeEach(function() {
 
             return message;
         },
-            };
-        },
     });
 });
 

lint_blacklist.txt

@@ -4,6 +4,3 @@
 build/**
 node_modules/**
 dist/**
-
-# Third party code
-test/jasmine/**

package.json

@@ -16,6 +16,7 @@
   "license": "MIT",
   "devDependencies": {
     "babel-eslint": "^7.2.0",
+    "babel-jest": "^20.0.3",
     "babel-plugin-transform-class-properties": "^6.23.0",
     "babel-plugin-transform-runtime": "^6.15.0",
     "babel-preset-es2015": "^6.18.0",
@@ -26,8 +27,7 @@
     "eslint": "^3.13.0",
     "express": "^4.14.0",
     "glob": "^7.1.1",
-    "jasmine": "^2.3.2",
-    "jasmine-core": "^2.3.4",
+    "jest": "^20.0.4",
     "js-yaml": "^3.3.1",
     "jspngopt": "^0.2.0",
     "less": "~2.7.1",
@@ -46,5 +46,13 @@
   },
   "dependencies": {
     "match-at": "^0.1.0"
+  },
+  "jest": {
+    "testMatch": [
+      "**/test/*-spec.js"
+    ],
+    "transform": {
+      "^.+\\.js$": "babel-jest"
+    }
   }
 }

server.js

@@ -54,8 +54,6 @@ function getStatic(url, file) {
 }
 
 browserified("/katex.js", "katex", "katex");
-app.use("/test/jasmine", express.static(path.dirname(
-    require.resolve("jasmine-core/lib/jasmine-core/jasmine.js"))));
 browserified("/test/katex-spec.js", "test/*[Ss]pec.js");
 browserified(
     "/contrib/auto-render/auto-render.js",

test/errors-spec.js

@@ -1,5 +1,4 @@
 /* global beforeEach: false */
-/* global jasmine: false */
 /* global expect: false */
 /* global it: false */
 /* global describe: false */
@@ -10,11 +9,10 @@ import Settings from "../src/Settings";
 const defaultSettings = new Settings({});
 
 beforeEach(function() {
-    jasmine.addMatchers({
-        toFailWithParseError: function(util, customEqualityTesters) {
     const prefix = "KaTeX parse error: ";
-            return {
-                compare: function(actual, expected) {
+
+    expect.extend({
+        toFailWithParseError: function(actual, expected) {
             try {
                 parseTree(actual, defaultSettings);
                 return {
@@ -53,8 +51,6 @@ beforeEach(function() {
                 }
             }
         },
-            };
-        },
     });
 });
 

test/jasmine.json

@@ -1,11 +0,0 @@
-{
-  "spec_dir": ".",
-  "spec_files": [
-    "test/**/*[sS]pec.js",
-    "contrib/**/*[sS]pec.js"
-  ],
-  "helpers": [
-    "helpers/**/*.js",
-    "node_modules/babel-core/register.js"
-  ]
-}

test/katex-spec.js

@@ -1,6 +1,5 @@
 /* eslint max-len:0 */
 /* global beforeEach: false */
-/* global jasmine: false */
 /* global expect: false */
 /* global it: false */
 /* global describe: false */
@@ -88,11 +87,8 @@ const parseAndSetResult = function(expr, result, settings) {
 };
 
 beforeEach(function() {
-    jasmine.addMatchers({
-
-        toParse: function() {
-            return {
-                compare: function(actual, settings) {
+    expect.extend({
+        toParse: function(actual, settings) {
             const usedSettings = settings ? settings : defaultSettings;
 
             const result = {
@@ -102,12 +98,8 @@ beforeEach(function() {
             parseAndSetResult(actual, result, usedSettings);
             return result;
         },
-            };
-        },
 
-        toNotParse: function() {
-            return {
-                compare: function(actual, settings) {
+        toNotParse: function(actual, settings) {
             const usedSettings = settings ? settings : defaultSettings;
 
             const result = {
@@ -131,12 +123,8 @@ beforeEach(function() {
 
             return result;
         },
-            };
-        },
 
-        toBuild: function() {
-            return {
-                compare: function(actual, settings) {
+        toBuild: function(actual, settings) {
             const usedSettings = settings ? settings : defaultSettings;
 
             const result = {
@@ -161,12 +149,8 @@ beforeEach(function() {
 
             return result;
         },
-            };
-        },
 
-        toParseLike: function(util, baton) {
-            return {
-                compare: function(actual, expected, settings) {
+        toParseLike: function(actual, expected, settings) {
             const usedSettings = settings ? settings : defaultSettings;
 
             const result = {
@@ -185,18 +169,17 @@ beforeEach(function() {
             if (!expectedTree) {
                 return result;
             }
+
             stripPositions(actualTree);
             stripPositions(expectedTree);
-                    if (!util.equals(actualTree, expectedTree, baton)) {
+
+            if (JSON.stringify(actualTree) !== JSON.stringify(expectedTree)) {
                 result.pass = false;
                 result.message = "Parse trees of '" + actual +
                     "' and '" + expected + "' are not equivalent";
             }
             return result;
         },
-            };
-        },
-
     });
 });
 

test/test.html

@@ -1,12 +0,0 @@
-<!DOCTYPE html>
-<html>
-    <head>
-        <script src="jasmine/jasmine.js"></script>
-        <script src="jasmine/jasmine-html.js"></script>
-        <script src="jasmine/boot.js"></script>
-        <link rel="stylesheet" href="jasmine/jasmine.css">
-        <script src="katex-spec.js"></script>
-    </head>
-    <body>
-    </body>
-</html>

test/unicode-spec.js

@@ -1,6 +1,5 @@
 /* eslint max-len:0 */
 /* global beforeEach: false */
-/* global jasmine: false */
 /* global expect: false */
 /* global it: false */
 /* global describe: false */
@@ -27,11 +26,9 @@ const parseAndSetResult = function(expr, result, settings) {
 
 describe("unicode", function() {
     beforeEach(function() {
-        jasmine.addMatchers({
+        expect.extend({
 
-            toParse: function() {
-                return {
-                    compare: function(actual, settings) {
+            toParse: function(actual, settings) {
                 const usedSettings = settings ? settings : defaultSettings;
 
                 const result = {
@@ -41,12 +38,8 @@ describe("unicode", function() {
                 parseAndSetResult(actual, result, usedSettings);
                 return result;
             },
-                };
-            },
 
-            toNotParse: function() {
-                return {
-                    compare: function(actual, settings) {
+            toNotParse: function(actual, settings) {
                 const usedSettings = settings ? settings : defaultSettings;
 
                 const result = {
@@ -70,8 +63,6 @@ describe("unicode", function() {
 
                 return result;
             },
-                };
-            },
         });
     });