refactor: large refactor of testing framework and related aspects

fix #221

Author: spiltcoffee

.circleci/config.yml

@@ -27,7 +27,7 @@ jobs:
       - save_cache:
           paths:
             - node_modules
-            - packages/postdfm/node_modules
+            # for nearleyc
             - packages/@postdfm/dfm2ast/node_modules
           key: node-{{ .Environment.CACHE_VERSION }}-dependencies-{{ checksum "yarn.lock" }}
 
@@ -89,10 +89,46 @@ jobs:
       - run: yarn test
 
       - store_test_results:
-          path: test-results
+          path: ~/repo/packages/postdfm/results
 
       - codecov/upload:
-          file: coverage/lcov.info
+          flags: "postdfm"
+          file: ~/repo/packages/postdfm/results/lcov/coverage.info
+
+      - store_test_results:
+          path: ~/repo/packages/@postdfm/ast/results
+
+      - codecov/upload:
+          flags: "@postdfm/ast"
+          file: ~/repo/packages/@postdfm/ast/results/lcov/coverage.info
+
+      - store_test_results:
+          path: ~/repo/packages/@postdfm/ast2dfm/results
+
+      - codecov/upload:
+          flags: "@postdfm/ast2dfm"
+          file: ~/repo/packages/@postdfm/ast2dfm/results/lcov/coverage.info
+
+      - store_test_results:
+          path: ~/repo/packages/@postdfm/dfm2ast/results
+
+      - codecov/upload:
+          flags: "@postdfm/dfm2ast"
+          file: ~/repo/packages/@postdfm/dfm2ast/results/lcov/coverage.info
+
+      - store_test_results:
+          path: ~/repo/packages/@postdfm/plugin/results
+
+      - codecov/upload:
+          flags: "@postdfm/plugin"
+          file: ~/repo/packages/@postdfm/plugin/results/lcov/coverage.info
+
+      - store_test_results:
+          path: ~/repo/packages/@postdfm/transform/results
+
+      - codecov/upload:
+          flags: "@postdfm/transform"
+          file: ~/repo/packages/@postdfm/transform/results/lcov/coverage.info
 
   docs:
     executor: node-executor
@@ -107,10 +143,11 @@ jobs:
 
       - run: yarn docs
 
-      - persist_to_workspace:
-          root: docs
-          paths:
-            - ./*
+      # currently not used for anything
+      # - persist_to_workspace:
+      #     root: docs
+      #     paths:
+      #       - ./*
 
   release:
     executor: node-executor
@@ -123,8 +160,9 @@ jobs:
       - attach_workspace:
           at: ~/repo/packages
 
-      - attach_workspace:
-          at: ~/repo/docs
+      # currently not used for anything
+      # - attach_workspace:
+      #     at: ~/repo/docs
 
       - run: yarn release
 

.gitignore

@@ -82,8 +82,7 @@ typings/
 # js
 dist
 
-# jest-junit
-test-results
+results/
 
 # nearley.js
 packages/@postdfm/dfm2ast/src/grammar.ts

jest.config.json

@@ -16,7 +16,7 @@
     "format:fix": "yarn format --write --list-different",
     "format:check": "yarn format --check",
     "compile": "yarn workspaces run compile",
-    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --coverage --verbose --maxWorkers=16",
+    "test": "yarn workspaces run test",
     "docs": "yarn workspaces run docs",
     "release": "semantic-release",
     "snyk-protect": "snyk protect",

package.json

@@ -0,0 +1 @@
+module.exports = require("../../../test/jest-preset.cjs")("@postdfm/ast");

packages/@postdfm/ast/jest.config.cjs

@@ -16,6 +16,7 @@
   },
   "scripts": {
     "compile": "tsc --listEmittedFiles",
+    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --coverage --verbose",
     "docs": "typedoc --options typedoc.config.cjs"
   },
   "author": "SpiltCoffee",

packages/@postdfm/ast/package.json

@@ -1,4 +1 @@
-module.exports = require("../../../typedoc.config.cjs")({
-  entryPoints: ["src/index.ts"],
-  out: "@postdfm/ast"
-});
+module.exports = require("../../../typedoc.config.cjs")("@postdfm/ast");

packages/@postdfm/ast/__test__/item.test.ts packages/@postdfm/ast/test/item.test.ts

@@ -0,0 +1 @@
+module.exports = require("../../../test/jest-preset.cjs")("@postdfm/ast2dfm");

packages/@postdfm/ast/__test__/list.test.ts packages/@postdfm/ast/test/list.test.ts

@@ -16,6 +16,7 @@
   },
   "scripts": {
     "compile": "tsc --listEmittedFiles",
+    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --coverage --verbose",
     "docs": "typedoc --options typedoc.config.cjs"
   },
   "author": "SpiltCoffee",

packages/@postdfm/ast/__test__/object.test.ts packages/@postdfm/ast/test/object.test.ts

@@ -0,0 +1,28 @@
+import { readdirSync, readFileSync } from "fs";
+
+import { Root } from "@postdfm/ast";
+import { stringify } from "@postdfm/ast2dfm";
+
+const parseFixturesPath = new URL(
+  "../../../../../test/fixtures/parse/",
+  import.meta.url
+);
+
+describe("dfm2ast", () => {
+  describe("parse fixtures", () => {
+    const fixtures = readdirSync(parseFixturesPath);
+    fixtures.forEach((fixture) => {
+      const fixturePath = new URL(`./${fixture}/`, parseFixturesPath);
+
+      test(`${fixture}`, () => {
+        expect(
+          stringify(
+            JSON.parse(
+              readFileSync(new URL("./ast.json", fixturePath), "utf8")
+            ) as Root
+          )
+        ).toEqual(readFileSync(new URL("./form.dfm", fixturePath), "ascii"));
+      });
+    });
+  });
+});

packages/@postdfm/ast/__test__/property.test.ts packages/@postdfm/ast/test/property.test.ts

@@ -1,4 +1 @@
-module.exports = require("../../../typedoc.config.cjs")({
-  entryPoints: ["src/index.ts"],
-  out: "@postdfm/ast2dfm"
-});
+module.exports = require("../../../typedoc.config.cjs")("@postdfm/ast2dfm");

packages/@postdfm/ast/__test__/root.test.ts packages/@postdfm/ast/test/root.test.ts

@@ -0,0 +1 @@
+module.exports = require("../../../test/jest-preset.cjs")("@postdfm/dfm2ast");

packages/@postdfm/ast/__test__/value.test.ts packages/@postdfm/ast/test/value.test.ts

@@ -17,6 +17,7 @@
   "scripts": {
     "precompile": "nearleyc ne/grammar.ne -o src/grammar.ts",
     "compile": "tsc --listEmittedFiles",
+    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --coverage --verbose",
     "docs": "typedoc --options typedoc.config.cjs"
   },
   "author": "SpiltCoffee",

packages/@postdfm/ast/typedoc.config.cjs

@@ -4,7 +4,7 @@ import { ASTNode } from "@postdfm/ast";
 import { parse } from "@postdfm/dfm2ast";
 
 const parseFixturesPath = new URL(
-  "../../../../../__test__/__fixtures__/parse/",
+  "../../../../../test/fixtures/parse/",
   import.meta.url
 );
 

packages/@postdfm/ast2dfm/__test__/fixtures/index.test.ts

@@ -1,4 +1 @@
-module.exports = require("../../../typedoc.config.cjs")({
-  entryPoints: ["src/index.ts"],
-  out: "@postdfm/dfm2ast"
-});
+module.exports = require("../../../typedoc.config.cjs")("@postdfm/dfm2ast");

packages/@postdfm/ast2dfm/jest.config.cjs

@@ -0,0 +1 @@
+module.exports = require("../../../test/jest-preset.cjs")("@postdfm/plugin");

packages/@postdfm/ast2dfm/package.json

@@ -16,6 +16,7 @@
   },
   "scripts": {
     "compile": "tsc --listEmittedFiles",
+    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --coverage --verbose",
     "docs": "typedoc --options typedoc.config.cjs"
   },
   "author": "SpiltCoffee",

packages/@postdfm/ast2dfm/__test__/broken/ast.json packages/@postdfm/ast2dfm/test/broken/ast.json

@@ -1,4 +1 @@
-module.exports = require("../../../typedoc.config.cjs")({
-  entryPoints: ["src/index.ts"],
-  out: "@postdfm/plugin",
-});
+module.exports = require("../../../typedoc.config.cjs")("@postdfm/plugin");

packages/@postdfm/ast2dfm/__test__/broken/index.test.ts packages/@postdfm/ast2dfm/test/broken/index.test.ts

@@ -0,0 +1 @@
+module.exports = require("../../../test/jest-preset.cjs")("@postdfm/transform");

packages/@postdfm/ast2dfm/test/fixtures/index.test.ts

@@ -16,6 +16,7 @@
   },
   "scripts": {
     "compile": "tsc --listEmittedFiles",
+    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --coverage --verbose",
     "docs": "typedoc --options typedoc.config.cjs"
   },
   "author": "SpiltCoffee",

packages/@postdfm/ast2dfm/typedoc.config.cjs

@@ -6,7 +6,7 @@ import { Plugin } from "@postdfm/plugin";
 import { Transformer } from "@postdfm/transform";
 
 const transformFixturesPath = new URL(
-  "../../../../../__test__/__fixtures__/transform/",
+  "../../../../../test/fixtures/transform/",
   import.meta.url
 );
 

packages/@postdfm/dfm2ast/jest.config.cjs

@@ -1,4 +1 @@
-module.exports = require("../../../typedoc.config.cjs")({
-  entryPoints: ["src/index.ts"],
-  out: "@postdfm/transform",
-});
+module.exports = require("../../../typedoc.config.cjs")("@postdfm/transform");

packages/@postdfm/dfm2ast/package.json

@@ -0,0 +1 @@
+module.exports = require("../../test/jest-preset.cjs")("postdfm");

packages/@postdfm/dfm2ast/__test__/broken/form.dfm packages/@postdfm/dfm2ast/test/broken/form.dfm

@@ -15,6 +15,7 @@
   },
   "scripts": {
     "compile": "tsc --listEmittedFiles",
+    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --coverage --verbose",
     "docs": "typedoc --options typedoc.config.cjs"
   },
   "keywords": [

packages/@postdfm/dfm2ast/__test__/broken/index.test.ts packages/@postdfm/dfm2ast/test/broken/index.test.ts

@@ -5,12 +5,12 @@ import { Plugin } from "@postdfm/plugin";
 import { postdfm, postdfmSync } from "postdfm";
 
 const parseFixturesPath = new URL(
-  "../../../../__test__/__fixtures__/parse/",
+  "../../../../test/fixtures/parse/",
   import.meta.url
 );
 
 const transformFixturesPath = new URL(
-  "../../../../__test__/__fixtures__/transform/",
+  "../../../../test/fixtures/transform/",
   import.meta.url
 );
 

packages/@postdfm/dfm2ast/__test__/fixtures/index.test.ts packages/@postdfm/dfm2ast/test/fixtures/index.test.ts

@@ -1,4 +1 @@
-module.exports = require("../../typedoc.config.cjs")({
-  entryPoints: ["src/index.ts"],
-  out: "postdfm"
-});
+module.exports = require("../../typedoc.config.cjs")("postdfm");

packages/@postdfm/dfm2ast/typedoc.config.cjs

@@ -0,0 +1,37 @@
+const path = require("path");
+
+module.exports = (projectName) => ({
+  extensionsToTreatAsEsm: [".ts"],
+  globals: {
+    "ts-jest": {
+      useESM: true
+    }
+  },
+  transform: {
+    "^.+\\.tsx?$": "ts-jest"
+  },
+  resolver: path.resolve(__dirname, "resolver.cjs"),
+  collectCoverage: true,
+  collectCoverageFrom: ["**/dist/**/*.js", "!**/node_modules/**"],
+  coverageReporters: [
+    [
+      "lcovonly",
+      { file: "coverage.info", projectRoot: path.resolve(__dirname, "..") }
+    ],
+    "text"
+  ],
+  coverageDirectory: "results/lcov",
+  reporters: [
+    "default",
+    [
+      "jest-junit",
+      {
+        usePathForSuiteName: "true",
+        classNameTemplate: "[{classname}]",
+        titleTemplate: "{title}",
+        outputName: "./report.xml",
+        outputDirectory: "results/jest"
+      }
+    ]
+  ]
+});

packages/@postdfm/plugin/jest.config.cjs

@@ -1,13 +1,9 @@
 const path = require("path");
 
-module.exports = (options) =>
-  Object.assign(
-    {
-      excludePrivate: true,
-      theme: "minimal",
-    },
-    options,
-    {
-      out: path.resolve(__dirname, "docs", options.out),
-    }
-  );
+module.exports = (projectName) =>
+  Object.assign({
+    excludePrivate: true,
+    theme: "minimal",
+    entryPoints: ["src/index.ts"],
+    out: path.resolve(__dirname, "docs", projectName)
+  });