feat(dev-tools) test command improvements (#464)

uber-web · Apr 27, 2024 · 31c2312 · 31c2312
1 parent dbe49e8
commit 31c2312
Show file tree

Hide file tree

Showing 5 changed files with 184 additions and 43 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -31,11 +31,10 @@ jobs:
       - name: Run tests
         run: |
           npm run lint
-          npm run test cover
           npm run cover
 
       - name: Coveralls
-        if: matrix.node-version == 12
+        if: matrix.node-version == 18
         uses: coverallsapp/github-action@master
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}

diff --git a/modules/dev-tools/package.json b/modules/dev-tools/package.json
@@ -99,6 +99,7 @@
     "prettier-check": "2.0.0",
     "tape": "^4.11.0",
     "tape-promise": "^4.0.0",
+    "tap-spec": "^5.0.0",
     "typescript": "^5.2.2",
     "ts-node": "~10.9.0",
     "ts-patch": "^3.1.2",

diff --git a/modules/dev-tools/scripts/test.sh b/modules/dev-tools/scripts/test.sh
@@ -7,8 +7,9 @@ BASEDIR=$(dirname "$0")
 
 MODE=$1
 
-MODULE_DIR=$(dirname $0)/..
-TEST_SCRIPT=$MODULE_DIR/dist/test.js
+DEV_TOOLS_DIR=$(dirname $0)/..
+TEST_SCRIPT=$DEV_TOOLS_DIR/dist/test.js
+COVERAGE_TEST=`node $DEV_TOOLS_DIR/dist/helpers/get-config.js ".coverage.test"`
 
 usage() {
   # TODO: Add more specific url
@@ -19,10 +20,18 @@ run_test_script() {
   (set -x; NODE_ENV=test node $TEST_SCRIPT $1)
 }
 
+run_test_script_pretty() {
+  run_test_script $1 | tap-spec
+}
+
+generate_coverage_report() {
+  (set -x; npx c8 report --reporter=text --reporter=lcov)
+}
+
 run_full_test() {
   npm run lint
-  run_test_script node
-  run_test_script browser-headless
+  run_test_script_pretty node
+  run_test_script_pretty browser-headless
   ocular-metrics
 }
 
@@ -39,11 +48,11 @@ case $MODE in
 
   "fast")
     ocular-lint pre-commit
-    run_test_script node
+    run_test_script_pretty node
     ;;
 
   "node")
-    run_test_script $MODE
+    run_test_script_pretty node
     ;;
 
   "node-debug")
@@ -52,43 +61,34 @@ case $MODE in
     ;;
 
   "dist")
-    run_test_script dist
+    run_test_script_pretty dist
     ;;
 
   "cover")
-    run_test_script cover
-    (set -x; npx c8 report --reporter=lcov)
+    run_test_script_pretty cover
+    generate_coverage_report
     ;;
 
   "ci")
-    # run by Travis CI
+    # run by CI
     npm run lint
-    run_test_script browser-headless
-    ocular-test cover
-    # node test/start.js bench
-    # ocular-metrics
-    ;;
-
-  "browser")
-    run_test_script $MODE
+    if [ "$COVERAGE_TEST" == "browser" ]; then
+      run_test_script_pretty node
+    else
+      run_test_script_pretty browser-headless
+    fi
+    run_test_script_pretty cover
+    generate_coverage_report
+    ocular-metrics
     ;;
 
   "browser-headless")
-    run_test_script $MODE
-    ;;
-
-  "bench")
-    run_test_script $MODE
-    ;;
-
-  "bench-browser")
-    run_test_script $MODE
+    run_test_script_pretty browser-headless
     ;;
 
   *)
     # default test
-    # echo "Error: unknown test mode $MODE"
-    # usage()
+    run_test_script $MODE
     ;;
 
   esac
diff --git a/modules/dev-tools/src/test.ts b/modules/dev-tools/src/test.ts
@@ -19,7 +19,7 @@ console.log(`Running ${mode} tests...`); // eslint-disable-line
 switch (mode) {
   case 'cover':
     if (ocularConfig.coverage.test === 'node') {
-      runNodeTest(resolveNodeEntry('test'), 'npx c8');
+      runNodeTest(resolveNodeEntry('test'), 'npx c8 --reporter=none');
     } else {
       await runBrowserTest({
         server: {
@@ -48,10 +48,6 @@ switch (mode) {
     runNodeTest(resolveNodeEntry('test')); // Run the tests
     break;
 
-  case 'bench':
-    runNodeTest(resolveNodeEntry('bench')); // Run the benchmarks
-    break;
-
   case 'browser':
   case 'browser-headless':
     await runBrowserTest({
@@ -190,9 +186,6 @@ function writeCoverage(coverage) {
       'utf8'
     );
   }
-
-  // Print coverage to console
-  execShellCommand('npx c8 report --reporter=text');
 }
 
 function sourcemapFromDataUrl(url: string): string | null {