rdf-test-suite/bin/Runner.js

Executes the RDF and SPARQL test suites.

#!/usr/bin/env node
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const fs_1 = require("fs");
const minimist = require("minimist");
const n3_1 = require("n3");
const Path = require("path");
const TestSuiteRunner_1 = require("../lib/TestSuiteRunner");
// tslint:disable:no-console
// tslint:disable:no-var-requires
const args = minimist(process.argv.slice(2));
if (args._.length < 2) {
    console.error(`sparql-test executes SPARQL test suites

Usage:
  rdf-test-suite path/to/myengine.js http://w3c.github.io/rdf-tests/sparql11/data-sparql11/manifest-all.ttl
  rdf-test-suite path/to/myengine.js http://w3c.github.io/rdf-tests/sparql11/data-sparql11/manifest-all.ttl \
    -s http://www.w3.org/TR/sparql11-query/
  rdf-test-suite path/to/myengine.js http://w3c.github.io/rdf-tests/sparql11/data-sparql11/manifest-all.ttl \
    -o earl -p earl-meta.json > earl.ttl

Options:
  -o      output format (detailed, summary, eurl, ... defaults to detailed)
  -p      file with earl properties, autogenerated from package.json if not available (only needed for EARL reports)
  -s      a specification URI to filter by (e.g. http://www.w3.org/TR/sparql11-query/)
  -c      enable HTTP caching at the given directory (disabled by default)
  -e      always exit with status code 0 on test errors
  -t      regex for test IRIs to run
  --skip  regex for test IRIs to skip
  -i      JSON string with custom options that need to be passed to the engine
  -d      time out duration for test cases (in milliseconds, default 3000)
  -m      URL to local path mapping (e.g. 'https://w3c.github.io/json-ld-api/|/path/to/folder/')
  -a      Only run tests that have an explicit rdft:Accepted status [default: false]
  -r      Run tests that have an explicit rdft:Rejected status [default: false]
`);
    process.exit(1);
}
// Enable caching if needed
let cachePath = null;
if (args.c) {
    cachePath = Path.join(process.cwd(), (args.c === true ? '.rdf-test-suite-cache/' : args.c));
    if (!(0, fs_1.existsSync)(cachePath)) {
        (0, fs_1.mkdirSync)(cachePath);
    }
}
// Import the engine
const engine = require(process.cwd() + '/' + args._[0]);
const defaultConfig = {
    exitWithStatusCode0: false,
    outputFormat: 'detailed',
    timeOutDuration: 3000,
};
const config = {
    cachePath,
    customEngingeOptions: args.i ? JSON.parse(args.i) : {},
    exitWithStatusCode0: !!args.e || defaultConfig.exitWithStatusCode0,
    outputFormat: args.o || defaultConfig.outputFormat,
    specification: args.s,
    testRegex: new RegExp(args.t),
    skipRegex: args.skip ? new RegExp(args.skip) : undefined,
    timeOutDuration: args.d || defaultConfig.timeOutDuration,
    urlToFileMapping: args.m,
    runRejected: !!args.r,
    explicitApproval: !!args.a,
};
// Fetch the manifest, run the tests, and print them
const testSuiteRunner = new TestSuiteRunner_1.TestSuiteRunner();
testSuiteRunner.runManifest(args._[1], engine, config)
    .then((testResults) => {
    switch (config.outputFormat) {
        case 'earl':
            if (!args.p) {
                throw new Error(`EARL reporting requires the -p argument to point to an earl-meta.json file.`);
            }
            // Create properties file if it does not exist
            if (!(0, fs_1.existsSync)(Path.join(process.cwd(), args.p))) {
                (0, fs_1.writeFileSync)(Path.join(process.cwd(), args.p), JSON.stringify(testSuiteRunner.packageJsonToEarlProperties(require(Path.join(process.cwd(), 'package.json'))), null, '  '));
            }
            testSuiteRunner.resultsToEarl(testResults, require(Path.join(process.cwd(), args.p)), new Date())
                .pipe(new n3_1.StreamWriter({ format: 'text/turtle', prefixes: require('../lib/prefixes.json') }))
                .pipe(process.stdout)
                .on('end', () => onEnd(testResults));
            break;
        case 'summary':
            testSuiteRunner.resultsToText(process.stdout, testResults, true);
            onEnd(testResults);
            break;
        default:
            testSuiteRunner.resultsToText(process.stdout, testResults, false);
            onEnd(testResults);
            break;
    }
}).catch(e => {
    console.error(e);
    process.exit(1);
});
function onEnd(testResults) {
    // Exit with status code 1 if there was at least one failing test
    if (!config.exitWithStatusCode0) {
        for (const testResult of testResults) {
            if (!testResult.skipped && !testResult.ok) {
                process.exit(1);
            }
        }
    }
}
//# sourceMappingURL=Runner.js.map