Add tests

kazk · kazk · commit 15d261c9b15b · 2020-07-11T21:32:09.000-07:00
Also changed empty test duration to output `0` for consistency.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,20 @@
+name: Test
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: "12.x"
+          registry-url: https://registry.npmjs.org/
+      - uses: actions/cache@v1
+        with:
+          path: node_modules
+          key: yarn-${{ hashFiles('yarn.lock') }}
+          restore-keys: |
+            yarn-
+      - run: yarn install --frozen-lockfile
+      - run: yarn test
diff --git a/fixtures/group-passing-failing.expected.txt b/fixtures/group-passing-failing.expected.txt
@@ -0,0 +1,16 @@
+
+<DESCRIBE::>group 1
+
+<IT::>test 1
+
+<PASSED::>Test Passed
+
+<COMPLETEDIN::>1
+
+<IT::>test 2
+
+<PASSED::>Test Passed
+
+<COMPLETEDIN::>0
+
+<COMPLETEDIN::>
diff --git a/fixtures/group-passing-failing.js b/fixtures/group-passing-failing.js
@@ -0,0 +1,8 @@
+describe("group 1", () => {
+  test("test 1", () => {
+    expect(1).toBe(1);
+  });
+  test("test 2", () => {
+    expect(1).toBe(1);
+  });
+});
diff --git a/fixtures/multiple-groups.expected.txt b/fixtures/multiple-groups.expected.txt
@@ -0,0 +1,20 @@
+
+<DESCRIBE::>group 1
+
+<IT::>test 1
+
+<PASSED::>Test Passed
+
+<COMPLETEDIN::>1
+
+<COMPLETEDIN::>
+
+<DESCRIBE::>group 2
+
+<IT::>test 1
+
+<PASSED::>Test Passed
+
+<COMPLETEDIN::>1
+
+<COMPLETEDIN::>
diff --git a/fixtures/multiple-groups.js b/fixtures/multiple-groups.js
@@ -0,0 +1,11 @@
+describe("group 1", () => {
+  test("test 1", () => {
+    expect(1).toBe(1);
+  });
+});
+
+describe("group 2", () => {
+  test("test 1", () => {
+    expect(1).toBe(1);
+  });
+});
diff --git a/fixtures/nested-groups.expected.txt b/fixtures/nested-groups.expected.txt
@@ -0,0 +1,14 @@
+
+<DESCRIBE::>group 1
+
+<DESCRIBE::>group 1 1
+
+<IT::>test 1
+
+<PASSED::>Test Passed
+
+<COMPLETEDIN::>1
+
+<COMPLETEDIN::>
+
+<COMPLETEDIN::>
diff --git a/fixtures/nested-groups.js b/fixtures/nested-groups.js
@@ -0,0 +1,7 @@
+describe("group 1", () => {
+  describe("group 1 1", () => {
+    test("test 1", () => {
+      expect(1).toBe(1);
+    });
+  });
+});
diff --git a/fixtures/single-group-failing.expected.txt b/fixtures/single-group-failing.expected.txt
@@ -0,0 +1,14 @@
+
+<DESCRIBE::>group 1
+
+<IT::>test 1
+
+<FAILED::>Test Failed
+
+<LOG:HTML:Failure><pre class="ansi"><code>Error: expect(received).toBe(expected) // Object.is equality<:LF:><:LF:>Expected: 2<:LF:>Received: 1</code></pre>
+
+<COMPLETEDIN::>3
+
+<COMPLETEDIN::>
+
+<LOG:HTML:Failures><pre class="ansi"><code>● group 1 › test 1<:LF:><:LF:>    expect(received).toBe(expected) // Object.is equality<:LF:><:LF:>    Expected: 2<:LF:>    Received: 1<:LF:><:LF:>      1 | describe("group 1", () =&gt; {<:LF:>      2 |   test("test 1", () =&gt; {<:LF:>    &gt; 3 |     expect(1).toBe(2);<:LF:>        |               ^<:LF:>      4 |   });<:LF:>      5 | });<:LF:>      6 | <:LF:><:LF:>      at Object.&lt;anonymous&gt; (fixtures/single-group-failing.js:3:15)</code></pre>
diff --git a/fixtures/single-group-failing.js b/fixtures/single-group-failing.js
@@ -0,0 +1,5 @@
+describe("group 1", () => {
+  test("test 1", () => {
+    expect(1).toBe(2);
+  });
+});
diff --git a/fixtures/single-group-passing.expected.txt b/fixtures/single-group-passing.expected.txt
@@ -0,0 +1,10 @@
+
+<DESCRIBE::>group 1
+
+<IT::>test 1
+
+<PASSED::>Test Passed
+
+<COMPLETEDIN::>2
+
+<COMPLETEDIN::>
diff --git a/fixtures/single-group-passing.js b/fixtures/single-group-passing.js
@@ -0,0 +1,5 @@
+describe("group 1", () => {
+  test("test 1", () => {
+    expect(1).toBe(1);
+  });
+});
diff --git a/fixtures/toplevel-test-failing.expected.txt b/fixtures/toplevel-test-failing.expected.txt
@@ -0,0 +1,10 @@
+
+<IT::>test 1
+
+<FAILED::>Test Failed
+
+<LOG:HTML:Failure><pre class="ansi"><code>Error: expect(received).toBe(expected) // Object.is equality<:LF:><:LF:>Expected: 2<:LF:>Received: 1</code></pre>
+
+<COMPLETEDIN::>3
+
+<LOG:HTML:Failures><pre class="ansi"><code>● test 1<:LF:><:LF:>    expect(received).toBe(expected) // Object.is equality<:LF:><:LF:>    Expected: 2<:LF:>    Received: 1<:LF:><:LF:>      1 | test("test 1", () =&gt; {<:LF:>    &gt; 2 |   expect(1).toBe(2);<:LF:>        |             ^<:LF:>      3 | });<:LF:>      4 | <:LF:><:LF:>      at Object.&lt;anonymous&gt; (fixtures/toplevel-test-failing.js:2:13)</code></pre>
diff --git a/fixtures/toplevel-test-failing.js b/fixtures/toplevel-test-failing.js
@@ -0,0 +1,3 @@
+test("test 1", () => {
+  expect(1).toBe(2);
+});
diff --git a/fixtures/toplevel-test-passing.expected.txt b/fixtures/toplevel-test-passing.expected.txt
@@ -0,0 +1,6 @@
+
+<IT::>test 1
+
+<PASSED::>Test Passed
+
+<COMPLETEDIN::>2
diff --git a/fixtures/toplevel-test-passing.js b/fixtures/toplevel-test-passing.js
@@ -0,0 +1,3 @@
+test("test 1", () => {
+  expect(1).toBe(1);
+});
diff --git a/gen-fixture.sh b/gen-fixture.sh
@@ -0,0 +1,7 @@
+#!/bin/bash
+# ./gen-fixture.sh fixtures/example.js
+# ./gen-fixture.sh fixtures/example.js expected
+# ./gen-fixture.sh fixtures/example.js sample
+# for f in $(ls fixtures/*.js); do ./gen-fixture.sh "$f"; done
+
+./node_modules/.bin/jest $1 --reporters=./lib/codewars-reporter.js --testMatch='**/fixtures/*.js' > "${1%.js}.${2:-expected}.txt"
diff --git a/jest.config.js b/jest.config.js
@@ -0,0 +1,4 @@
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+};
diff --git a/package.json b/package.json
@@ -1,35 +1,43 @@
 {
   "name": "@codewars/jest-reporter",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Codewars reporter for Jest",
   "homepage": "https://github.com/codewars/jest-reporter#readme",
   "repository": "github:codewars/jest-reporter",
   "bugs": {
     "url": "https://github.com/codewars/jest-reporter/issues"
   },
   "files": [
-    "lib/",
-    "src/"
+    "lib/codewars-reporter.js",
+    "src/codewars-reporter.ts"
   ],
   "main": "lib/codewars-reporter.js",
   "scripts": {
-    "prepare": "tsc"
+    "prepare": "tsc",
+    "watch": "tsc --watch",
+    "test": "jest"
   },
   "license": "MIT",
   "dependencies": {
     "anser": "^1.4.9"
   },
   "devDependencies": {
-    "@jest/console": "^25.5.0",
-    "@jest/reporters": "^25.5.1",
-    "@jest/test-result": "^25.5.0",
+    "@jest/console": "^26.1.0",
+    "@jest/reporters": "^26.1.0",
+    "@jest/test-result": "^26.1.0",
+    "@types/jest": "^26.0.4",
+    "escape-string-regexp": "^4.0.0",
+    "execa": "^4.0.3",
     "husky": "^4.2.5",
+    "jest": "^26.1.0",
+    "jest-cli": "^26.1.0",
     "prettier": "^2.0.5",
     "pretty-quick": "^2.0.1",
+    "ts-jest": "^26.1.1",
     "typescript": "^3.8.3"
   },
   "peerDependencies": {
-    "jest": "25.x"
+    "jest": ">=25.x"
   },
   "husky": {
     "hooks": {
diff --git a/src/codewars-reporter.spec.ts b/src/codewars-reporter.spec.ts
@@ -0,0 +1,72 @@
+import fs from "fs";
+import path from "path";
+import { promisify } from "util";
+
+import execa from "execa";
+import escapeRegExp from "escape-string-regexp";
+
+const readFile = promisify(fs.readFile);
+const access = promisify(fs.access);
+const exists = async (path: string) => {
+  try {
+    await access(path);
+    return true;
+  } catch {
+    return false;
+  }
+};
+
+const structureMatches = (a: string, b: string) =>
+  expect(
+    a.match(/<(?:DESCRIBE|IT|PASSED|FAILED|ERROR|COMPLETEDIN)::>/g)!.join("")
+  ).toStrictEqual(
+    b.match(/<(?:DESCRIBE|IT|PASSED|FAILED|ERROR|COMPLETEDIN)::>/g)!.join("")
+  );
+
+describe("CodewarsReporter", () => {
+  const cwd = path.join(__dirname, "..");
+  const fixturesDir = path.join(__dirname, "..", "fixtures");
+  const files = fs.readdirSync(fixturesDir).filter((f) => f.endsWith(".js"));
+  for (const file of files) {
+    it(file.replace(/\.js$/, ""), async () => {
+      const { stdout } = await execa(
+        "jest",
+        [
+          path.join(fixturesDir, file),
+          "--reporters=./lib/codewars-reporter.js",
+          "--testMatch='**/fixtures/*.js'",
+        ],
+        {
+          cwd,
+          preferLocal: true,
+          stripFinalNewline: false,
+          reject: false,
+        }
+      );
+      const expectedFile = path.join(
+        fixturesDir,
+        file.replace(/\.js$/, ".expected.txt")
+      );
+
+      if (await exists(expectedFile)) {
+        const expected = await readFile(expectedFile, {
+          encoding: "utf-8",
+        });
+        // Allow duration to change.
+        const expectedPattern = new RegExp(
+          escapeRegExp(expected).replace(/(?<=<COMPLETEDIN::>)\d+/g, "\\d+")
+        );
+        expect(stdout).toMatch(expectedPattern);
+      } else {
+        const samplePath = path.join(
+          fixturesDir,
+          file.replace(/\.js$/, ".sample.txt")
+        );
+        const sample = await readFile(samplePath, {
+          encoding: "utf-8",
+        });
+        structureMatches(stdout, sample);
+      }
+    });
+  }
+});
diff --git a/src/codewars-reporter.ts b/src/codewars-reporter.ts
@@ -146,7 +146,7 @@ function _logTest(test: AssertionResult) {
       console.log(`\n<LOG::>Test TODO`);
       break;
   }
-  const time = test.duration ? test.duration.toFixed(0) : "";
+  const time = test.duration ? test.duration.toFixed(0) : "0";
   console.log(`\n<COMPLETEDIN::>${time}`);
 }
 
diff --git a/tsconfig.json b/tsconfig.json
@@ -9,5 +9,6 @@
     "declaration": false,
     "sourceMap": true,
     "removeComments": true
-  }
+  },
+  "exclude": ["node_modules", "**/*.spec.ts"]
 }
diff --git a/yarn.lock b/yarn.lock
