Add EARL_OFFICIAL env var.

When set to truthy string will setup tests that are run for official test result reports.
digitalbazaar · Oct 5, 2023 · a01c5ae · a01c5ae
1 parent 758d29c
commit a01c5ae
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -22,6 +22,7 @@
 - **BREAKING**: Check output `format` parameter. Must be omitted, falsy, or
   "application/n-quads".
 - Add EARL Turtle test result mode.
+- Add `EARL_OFFICIAL` env flag to setep official test report mode.
 - Add `"react-native"` section to `package.json` (same as `"browser"`), and
   instructions for how to use this library with React Native.
 

diff --git a/README.md b/README.md
@@ -224,9 +224,12 @@ To generate EARL reports:
     EARL=earl-node.jsonld npm test
 
     # generate a Turtle EARL report with Node.js
-    # used for official reports
     EARL=js-rdf-canonize-earl.ttl npm test
 
+    # generate official Turtle EARL report with Node.js
+    # turns ASYNC on and SYNC and WEBCRYPTO off
+    EARL_OFFICIAL=true EARL=js-rdf-canonize-earl.ttl npm test
+
 Benchmark
 ---------
 

diff --git a/karma.conf.js b/karma.conf.js
@@ -65,6 +65,8 @@ module.exports = function(config) {
           'process.env.BAIL': JSON.stringify(process.env.BAIL),
           'process.env.BENCHMARK': JSON.stringify(process.env.BENCHMARK),
           'process.env.EARL': JSON.stringify(process.env.EARL),
+          'process.env.EARL_OFFICIAL':
+            JSON.stringify(process.env.EARL_OFFICIAL),
           'process.env.SYNC': JSON.stringify(process.env.SYNC),
           'process.env.TESTS': JSON.stringify(process.env.TESTS),
           'process.env.TEST_ENV': JSON.stringify(process.env.TEST_ENV),
@@ -97,6 +99,7 @@ module.exports = function(config) {
             BAIL: process.env.BAIL,
             BENCHMARK: process.env.BENCHMARK,
             EARL: process.env.EARL,
+            EARL_OFFICIAL: process.env.EARL_OFFICIAL,
             SYNC: process.env.SYNC,
             TESTS: process.env.TESTS,
             TEST_ENV: process.env.TEST_ENV,

diff --git a/test/test-karma.js b/test/test-karma.js
@@ -62,6 +62,7 @@ const env = {
   ASYNC: process.env.ASYNC,
   BAIL: process.env.BAIL,
   BENCHMARK: process.env.BENCHMARK,
+  EARL_OFFICIAL: process.env.EARL_OFFICIAL,
   SYNC: process.env.SYNC,
   TEST_ENV: process.env.TEST_ENV,
   VERBOSE_SKIP: process.env.VERBOSE_SKIP,

diff --git a/test/test-node.js b/test/test-node.js
@@ -71,6 +71,7 @@ const env = {
   ASYNC: process.env.ASYNC,
   BAIL: process.env.BAIL,
   BENCHMARK: process.env.BENCHMARK,
+  EARL_OFFICIAL: process.env.EARL_OFFICIAL,
   SYNC: process.env.SYNC,
   TEST_ENV: process.env.TEST_ENV,
   VERBOSE_SKIP: process.env.VERBOSE_SKIP,

diff --git a/test/test.js b/test/test.js
@@ -96,8 +96,11 @@ const bailOnError = isTrue(options.env.BAIL || 'false');
 const verboseSkip = isTrue(options.env.VERBOSE_SKIP || 'false');
 
 const doAsync = isTrue(options.env.ASYNC || 'true');
-const doSync = isTrue(options.env.SYNC || 'true');
-const doWebCrypto = isTrue(options.env.WEBCRYPTO || 'true') && options.nodejs;
+const doSync = isTrue(options.env.SYNC || 'true') &&
+  !isTrue(options.env.EARL_OFFICIAL || 'false');
+const doWebCrypto = isTrue(options.env.WEBCRYPTO || 'true') &&
+  !isTrue(options.env.EARL_OFFICIAL || 'false') &&
+  options.nodejs;
 
 const benchmarkOptions = {
   enabled: false,