Output benchmark Hz in EARL report.

- Output Hz in EARL report.
- Add extra env data in EARL fields.

Author: davidlehn

tests/earl-report.js

@@ -11,6 +11,7 @@
  *
  * @param options {Object} reporter options
  *          id: {String} report id
+ *          env: {String} environment description
  */
 function EarlReport(options) {
   let today = new Date();
@@ -22,6 +23,7 @@ function EarlReport(options) {
   this.now = new Date();
   this.now.setMilliseconds(0);
   this.id = options.id;
+  this.env = options.env;
   /* eslint-disable quote-props */
   this._report = {
     '@context': {
@@ -30,6 +32,7 @@ function EarlReport(options) {
       'dc': 'http://purl.org/dc/terms/',
       'earl': 'http://www.w3.org/ns/earl#',
       'xsd': 'http://www.w3.org/2001/XMLSchema#',
+      'jsonld': 'http://www.w3.org/ns/json-ld#',
       'doap:homepage': {'@type': '@id'},
       'doap:license': {'@type': '@id'},
       'dc:creator': {'@type': '@id'},
@@ -73,17 +76,16 @@ function EarlReport(options) {
     'subjectOf': []
   };
   /* eslint-enable quote-props */
-  const version = require('../package.json').version;
-  // FIXME: Improve "Node.js" vs "browser" id reporting
-  // this._report['@id'] += '#' + this.id;
-  // this._report['doap:name'] += ' ' + this.id;
-  // this._report['dc:title'] += ' ' + this.id;
-  this._report['doap:release']['doap:name'] =
-    this._report['doap:name'] + ' ' + version;
-  this._report['doap:release']['doap:revision'] = version;
+  this._report['@id'] +=
+    '#' + this.id;
+  this._report['doap:name'] +=
+    ' ' + this.id + (this.env ? ' ' + this.env : '');
+  this._report['dc:title'] +=
+    ' ' + this.id + (this.env ? ' ' + this.env : '');
 }
 
-EarlReport.prototype.addAssertion = function(test, pass) {
+EarlReport.prototype.addAssertion = function(test, pass, options) {
+  options = options || {};
   this._report.subjectOf.push({
     '@type': 'earl:Assertion',
     'earl:assertedBy': this._report['doap:developer']['@id'],
@@ -93,6 +95,7 @@ EarlReport.prototype.addAssertion = function(test, pass) {
       '@type': 'earl:TestResult',
       'dc:date': this.now.toISOString(),
       'earl:outcome': pass ? 'earl:passed' : 'earl:failed'
+      ...options.extra
     }
   });
   return this;

tests/test-common.js

@@ -264,7 +264,10 @@ const SKIP_TESTS = [];
 
 // create earl report
 if(options.earl && options.earl.filename) {
-  options.earl.report = new EarlReport({id: options.earl.id});
+  options.earl.report = new EarlReport({
+    id: options.earl.id,
+    env: options.earl.env
+  });
 }
 
 return new Promise(resolve => {
@@ -570,9 +573,9 @@ function addTest(manifest, test, tests) {
           throw Error('Unknown test type: ' + test.type);
         }
 
-        let benchResults = null;
+        let benchResult = null
         if(options.benchmark) {
-          benchResults = await runBenchmark({
+          const result = await runBenchmark({
             test,
             fn,
             params: testInfo.params.map(param => param(test, {
@@ -581,11 +584,17 @@ function addTest(manifest, test, tests) {
             })),
             mochaTest: self
           });
+          benchResult = {
+            'jsonld:benchmarkHz': result.target.hz
+          };
         }
 
         if(options.earl.report) {
-          // TODO: add benchmark info
-          options.earl.report.addAssertion(test, true);
+          options.earl.report.addAssertion(test, true, {
+            extra: {
+              ...benchResult
+            }
+          });
         }
       } catch(err) {
         if(options.bailOnError) {
@@ -630,7 +639,7 @@ async function runBenchmark({test, fn, params, mochaTest}) {
         reject(new Error(err));
       })
       .on('complete', e => {
-        resolve();
+        resolve(e);
       })
       .run({async: true});
   });

tests/test-karma.js

@@ -7,6 +7,8 @@
  *   JSONLD_TESTS="r1 r2 ..."
  * Output an EARL report:
  *   EARL=filename
+ * Output EARL environment description (any appropraite string):
+ *   EARL_ENV='CPU=Intel-i7-4790K@4.00GHz,Node.js=v10.16.3,jsonld.js=v1.7.0'
  * Bail with tests fail:
  *   BAIL=true
  * Verbose skip reasons:
@@ -95,6 +97,7 @@ const options = {
   },
   earl: {
     id: 'browser',
+    env: process.env.EARL_ENV,
     filename: process.env.EARL
   },
   verboseSkip: process.env.VERBOSE_SKIP === 'true',

tests/test.js

@@ -7,6 +7,8 @@
  *   JSONLD_TESTS="r1 r2 ..."
  * Output an EARL report:
  *   EARL=filename
+ * Output EARL environment description (any appropraite string):
+ *   EARL_ENV='CPU=Intel-i7-4790K@4.00GHz,Node.js=v10.16.3,jsonld.js=v1.7.0'
  * Bail with tests fail:
  *   BAIL=true
  * Verbose skip reasons:
@@ -102,6 +104,7 @@ const options = {
   exit: code => process.exit(code),
   earl: {
     id: 'Node.js',
+    env: process.env.EARL_ENV,
     filename: process.env.EARL
   },
   verboseSkip: process.env.VERBOSE_SKIP === 'true',