api-tuner 0.3.0 → 0.3.3

package/bin/index.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import '../index.js'

package/bin/merge-curl-output.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import '../lib/merge-curl-output.js'

package/bin/merge-curl-output.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
+
+# find JS entrypoint
+script="$SCRIPT_DIR/merge-curl-output.js"
+
+# if tsx exists in path
+if command -v tsx > /dev/null 2>&1
+then
+  # use tsx
+  node --import tsx --no-warnings "$script" "$@"
+else
+  # use plain node
+  node "$script" "$@"
+fi

package/bin/tuner.sh

@@ -1,9 +1,14 @@
 #!/usr/bin/env bash
 
+WORKING_DIR=$(pwd)
+
 SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
+cd "$SCRIPT_DIR" || exit
 
 # find JS entrypoint
-tuner="$SCRIPT_DIR/index.js"
+tuner=$(node -e "console.log(require.resolve('api-tuner/bin/index.js'))" 2> /dev/null)
+
+cd "$WORKING_DIR" || exit
 
 # if tsx exists in path
 if command -v tsx > /dev/null 2>&1

package/index.js

@@ -10,7 +10,7 @@ import summariseResults from './lib/summarise-results.js';
 const eyePvmPath = url.fileURLToPath(new URL('eye/lib/eye.pvm', import.meta.url));
 program
     .name('api-tuner')
-    .option('--lib <lib>', 'Specify rules to include in all tests. Can be used multiple times. Make sure to surround globs in quotes to prevent expansion.')
+    .option('--lib <lib>', 'Specify rules to include in all tests. Can be used multiple times. Make sure to surround globs in quotes to prevent expansion.', (lib, arr) => [...arr, lib], [])
     .option('--silent', 'Less output', false)
     .option('--debug', 'Enable debug output', false)
     .option('--raw', 'Output raw results from eyes')
@@ -45,7 +45,7 @@ const rulesPath = url.fileURLToPath(new URL('rules/*.n3', import.meta.url));
 const levelIcon = {
     INFO: 'ℹ️',
     DEBUG: '🐞',
-    'Failed assertion': '❌',
+    'Failed assertion': '❌ Failed assertion',
 };
 async function processPath(path) {
     return new Promise(resolve => {
@@ -56,6 +56,7 @@ async function processPath(path) {
             '--',
             ...eyeArgs,
             rulesPath,
+            ...options.lib,
             '-',
         ], {
             shell: true,
@@ -77,24 +78,32 @@ async function processPath(path) {
 const testSuites = program.args.map(async (path) => {
     const absolutePath = resolve(process.cwd(), path);
     const result = await processPath(path);
-    const suiteHeader = options.silent ? '' : `\n⚡️ SUITE   <file://${absolutePath}>\n`;
     const summaryPassThrough = new PassThrough();
     const rawPassThrough = new PassThrough();
     result.stdout.pipe(summaryPassThrough);
     result.stdout.pipe(rawPassThrough);
     const validationResult = await summariseResults(summaryPassThrough);
     if (options.raw) {
-        process.stdout.write(suiteHeader + await getStream(rawPassThrough));
+        const header = options.silent ? '' : `\n⚡️ SUITE   <file://${absolutePath}>\n`;
+        process.stdout.write(header + await getStream(rawPassThrough));
     }
-    else {
+    if (!result.success) {
+        return {
+            summary: `\n🔎 SUITE   <file://${absolutePath}>\n❌  FAIL   Test script failed`,
+            success: false,
+        };
+    }
+    let summary = `\n🔎 SUITE   <file://${absolutePath}>\n`;
+    if (!validationResult.success) {
         const stderr = await getStream(result.stderr);
-        process.stderr.write(suiteHeader + stderr.replace(/"(\w+)" TRACE "(.*)"/g, (_, level, text) => {
-            return `${levelIcon[level]} ${text}`;
-        }));
+        summary += stderr.replace(/"([^"]*)" TRACE ("([^"]*)")?/gm, (_, level, quoted, text) => {
+            return `${levelIcon[level]} ${text || ''}`;
+        });
     }
+    summary += validationResult.summary;
     return {
-        summary: `\n🔎 SUITE   <file://${absolutePath}>\n${validationResult.summary}`,
-        success: result.success && validationResult.success,
+        summary,
+        success: validationResult.success,
     };
 });
 Promise.all(testSuites).then((results) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-tuner",
-  "version": "0.3.0",
+  "version": "0.3.3",
   "main": "index.js",
   "type": "module",
   "license": "MIT",
@@ -18,9 +18,12 @@
     "release": "changeset publish"
   },
   "files": [
-    "bin/tuner.sh",
+    "bin",
     "logging",
-    "lib",
+    "lib/*.js",
+    "lib/*.txt",
+    "lib/*.ttl",
+    "lib/*.sh",
     "rules"
   ],
   "dependencies": {

package/rules/files.n3

@@ -13,9 +13,12 @@ prefix file: <http://www.w3.org/2000/10/swap/file#>
   ( ?suffix ) file:temp ?path .
 } <= {
   ?uri log:uri ( "urn:rand:" ( 1000 )!e:random )!string:concatenation .
+  # log:shell captures the traling newline
+  ( "mktemp -d"!log:shell "\n" "" ) string:replace ?tempDir .
 
   (
-    #"/tmp/"
+    ?tempDir
+    "/"
     ?uri!log:uuid
     ?suffix
   ) string:concatenation ?path .

package/lib/merge-curl-output.ts

@@ -1,72 +0,0 @@
-import * as fs from 'node:fs/promises'
-import { createReadStream } from 'node:fs'
-// eslint-disable-next-line import/default
-import jsonld from 'jsonld'
-import rdf from '@zazuko/env-node'
-import { write } from '@jeswr/pretty-turtle'
-import type { DatasetCore, Quad } from '@rdfjs/types'
-
-declare module '@rdfjs/types' {
-  interface Stream extends AsyncIterable<Quad>{
-  }
-}
-
-interface CurlFile {
-  response: Record<string, string | number | null>
-  headers: Record<string, string[]>
-}
-
-const ns = rdf.namespace('https://api-tuner.described.at/');
-
-(async () => {
-  const bodyPath = process.argv[2]
-
-  const curlJsonPath = `${bodyPath}.curl.json`
-  const { response: responseJson, headers: headersJson } = JSON.parse((await fs.readFile(curlJsonPath)).toString()) as CurlFile
-  /**
-   * @type {Record<string, string | number | null>}
-   */
-  const curlJsonLd = Object.assign({
-    '@context': {
-      '@vocab': ns().value,
-    },
-  }, responseJson)
-
-  /**
-   * @type {import('@rdfjs/types').Quad[]}
-   */
-  const responseQuads = await jsonld.toRDF(curlJsonLd) as DatasetCore
-  const response = rdf.clownface({
-    dataset: rdf.dataset(responseQuads),
-  }).has(ns.exitcode).addOut(rdf.ns.rdf.type, ns.Response)
-
-  let contentType
-  if (typeof responseJson.content_type === 'string') {
-    contentType = responseJson.content_type.substring(0, responseJson.content_type.indexOf(';')) || responseJson.content_type
-  }
-  let parser
-  if (contentType) {
-    parser = rdf.formats.parsers.get(contentType)
-  }
-  if (parser) {
-    const bodyGraph = rdf.blankNode()
-    const bodyStream = parser.import(createReadStream(bodyPath))
-    for await (const quad of bodyStream) {
-      response.dataset.add(rdf.quad(quad.subject, quad.predicate, quad.object, bodyGraph))
-    }
-    response.addOut(ns.body, bodyGraph)
-  } else {
-    const body = await fs.readFile(bodyPath, 'utf-8')
-    if (body) {
-      response.addOut(ns.body, body)
-    }
-  }
-
-  const headers = Object.entries(headersJson).flatMap(([header, values]) =>
-    values.map(value => response.blankNode().addOut(ns('name'), header).addOut(ns.value, value)))
-  response.addOut(ns.headers, headers)
-
-  process.stdout.write(await write([...response.dataset], {
-    format: 'text/n3',
-  }))
-})()

package/lib/parse-test-case.ts

@@ -1,25 +0,0 @@
-import * as url from 'node:url'
-import { createReadStream } from 'node:fs'
-import type { Readable } from 'node:stream'
-import replaceStream from 'replacestream'
-import isAbsoluteUrl from 'is-absolute-url'
-
-export default function (testCase: string, baseIri: string): Readable {
-  function replacer(fileUrl: string) {
-    return (_: unknown, match: string) => {
-      if (match.startsWith('#')) {
-        return `<${fileUrl}${match}>`
-      }
-
-      if (isAbsoluteUrl(match)) {
-        return `<${match}>`
-      }
-
-      return `<${baseIri}${match}>`
-    }
-  }
-
-  const testCaseUrl = url.pathToFileURL(testCase).toString()
-  return createReadStream(testCase)
-    .pipe(replaceStream(/<([^>]*)>(?=([^"\\]*(\\.|"([^"\\]*\\.)*[^"\\]*"))*[^"]*$)/g, replacer(testCaseUrl)))
-}

package/lib/summarise-results.ts

@@ -1,46 +0,0 @@
-import type { Readable } from 'node:stream'
-import SHACLValidator from 'rdf-validate-shacl'
-import rdf from '@zazuko/env-node'
-
-const shapesTtl = new URL('./shapes.ttl', import.meta.url)
-
-interface Result {
-  summary: string
-  success: boolean
-}
-
-export default async (resultStream: Readable): Promise<Result> => {
-  const shapes = await rdf.dataset().import(rdf.fromFile(shapesTtl))
-  const validator = new SHACLValidator(shapes, {
-    factory: rdf,
-  })
-
-  const data = await rdf.dataset().import(rdf.formats.parsers.import('text/n3', resultStream, {
-    format: 'n3',
-  })!)
-
-  const validationReport = validator.validate(data)
-
-  const testCases = rdf.clownface({ dataset: data })
-    .has(rdf.ns.rdf.type, rdf.ns.earl.TestCase)
-    .toArray()
-
-  const summary = []
-  for (const testCase of testCases) {
-    const { hash } = new URL(testCase.value)
-    const result = validationReport.results.find(result => testCase.term.equals(result.focusNode))
-    const label = testCase.out(rdf.ns.rdfs.label).value
-    const resultLine = label ? `${label} (<${hash}>)` : `<${hash}>`
-
-    if (rdf.ns.sh.Violation.equals(result?.severity)) {
-      summary.push(`❌  FAIL   ${resultLine}`)
-    } else {
-      summary.push(`✅  PASS   ${resultLine}`)
-    }
-  }
-
-  return {
-    success: validationReport.conforms,
-    summary: summary.join('\n'),
-  }
-}