api-tuner 0.1.3 → 0.2.0

package/README.md

@@ -46,13 +46,13 @@ PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>
 PREFIX log: <http://www.w3.org/2000/10/swap/log#>
 PREFIX string: <http://www.w3.org/2000/10/swap/string#>
 
-:getExampleDotCom
+<#getExampleDotCom>
   a earl:TestCase ;
   rdfs:label "Simple GET test" ;
 .
 
 # Configure a request
-:req
+_:req
   a tuner:Request ;
   tuner:url <http://localhost:1080/example.com> ;
   tuner:method "GET" ;
@@ -60,7 +60,7 @@ PREFIX string: <http://www.w3.org/2000/10/swap/string#>
 
 {
   # Execute the request and capture its response
-  :req tuner:response ?res .
+  _:req tuner:response ?res .
 
   # Check the response status code and content type
   ?res tuner:http_code 200 ;
@@ -71,7 +71,7 @@ PREFIX string: <http://www.w3.org/2000/10/swap/string#>
   ?res!tuner:body string:contains "Example Domain" .
 } => {
   # Use te EARL vocabulary to assert the test passed
-  :getExampleDotCom earl:outcome earl:passed .
+  <#getExampleDotCom> earl:outcome earl:passed .
 } .
 ```
 

package/bin/tuner.sh

@@ -79,14 +79,10 @@ if [ "$SILENT" != true ]; then
   ARGS="$ARGS ${SCRIPT_PATH}/../logging/info.n3"
 fi
 
-MERGED="$(mktemp)"
-if [ -n "$BASE_IRI" ]; then
-  echo "base <$BASE_IRI>" > "$MERGED"
-fi
-
-for path in "${PATHS[@]}"; do
-  cat "$path" >> "$MERGED"
-done
-
 set -o pipefail
-$eye $ARGS "${SCRIPT_PATH}"/../rules/*.n3 "${MERGED}" | $SUMMARY
+for path in "${PATHS[@]}"; do
+  (
+    node "${SCRIPT_PATH}/../lib/parse-test-case.js" --base-iri "$BASE_IRI" -- "${path}" \
+      | $eye $ARGS "${SCRIPT_PATH}"/../rules/*.n3 -
+  ) &
+done | $SUMMARY

package/lib/parse-test-case.js

@@ -0,0 +1,39 @@
+import * as url from 'node:url'
+import { createReadStream } from 'node:fs'
+import yargs from 'yargs'
+import { hideBin } from 'yargs/helpers'
+import replaceStream from 'replacestream'
+import isAbsoluteUrl from 'is-absolute-url'
+import StreamConcat from 'stream-concat'
+
+const argv = yargs(hideBin(process.argv)).argv
+
+const baseIri = argv['base-iri'] || 'http://example.org/'
+const testCases = argv._
+
+function replacer(fileUrl) {
+  return (_, match) => {
+    if (match.startsWith('#')) {
+      return `<${fileUrl}${match}>`
+    }
+
+    if (isAbsoluteUrl(match)) {
+      return `<${match}>`
+    }
+
+    return `<${baseIri}${match}>`
+  }
+}
+
+let fileIndex = 0
+function nextStream() {
+  if (fileIndex === testCases.length) {
+    return null
+  }
+  const testCase = testCases[fileIndex++]
+  const testCaseUrl = url.pathToFileURL(testCase).toString()
+  return createReadStream(testCase)
+    .pipe(replaceStream(/<([^>]*)>(?=([^"\\]*(\\.|"([^"\\]*\\.)*[^"\\]*"))*[^"]*$)/g, replacer(testCaseUrl)))
+}
+
+new StreamConcat(nextStream).pipe(process.stdout)

package/lib/summarise-results.js

@@ -28,15 +28,36 @@ const shapesTtl = new URL('./shapes.ttl', import.meta.url)
   const validationReport = validator.validate(data)
 
   if (argv.summary) {
-    const testCases = rdf.clownface({ dataset: data }).has(rdf.ns.rdf.type, rdf.ns.earl.TestCase)
-
-    for (const testCase of testCases.toArray()) {
-      const result = validationReport.results.find(result => result.focusNode.equals(testCase.term))
-      if (result?.severity.equals(rdf.ns.sh.Violation)) {
-        process.stdout.write(`❌  FAIL <${testCase.value}>\n`)
-      } else {
-        process.stdout.write(`✅  PASS <${testCase.value}>\n`)
+    const resultMap = rdf.clownface({ dataset: data })
+      .has(rdf.ns.rdf.type, rdf.ns.earl.TestCase)
+      .toArray()
+      .reduce((map, testCase) => {
+        const { pathname } = new URL(testCase)
+
+        const testCases = map.get(pathname) || []
+        testCases.push(testCase)
+
+        return map.set(pathname, testCases)
+      }, new Map())
+
+    for (const [pathname, testCases] of resultMap.entries()) {
+      const summary = ['']
+      summary.push(`🔎 SUITE  <file://${pathname}>`)
+
+      for (const testCase of testCases) {
+        const { hash } = new URL(testCase.value)
+        const result = validationReport.results.find(result => result.focusNode.equals(testCase.term))
+        const label = testCase.out(rdf.ns.rdfs.label).value
+        const resultLine = label ? `${label} (<${hash}>)` : `<${hash}>`
+
+        if (result?.severity.equals(rdf.ns.sh.Violation)) {
+          summary.push(`❌  FAIL   ${resultLine}`)
+        } else {
+          summary.push(`✅  PASS   ${resultLine}`)
+        }
       }
+
+      process.stderr.write(summary.join('\n') + '\n')
     }
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-tuner",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "main": "index.js",
   "type": "module",
   "license": "MIT",
@@ -8,11 +8,11 @@
     "api-tuner": "./bin/tuner.sh"
   },
   "scripts": {
-    "download-eye": "EYE_VERSION=11.5.2 ./lib/download-eye.sh",
+    "download-eye": "EYE_VERSION=11.10.0 ./lib/download-eye.sh",
     "postinstall": "([ -d eye ] || npm run download-eye) && eye/install.sh --prefix=eye",
     "prepare": "husky",
     "lint": "eslint . --quiet --ignore-path .gitignore",
-    "test": "./bin/tuner.sh tests/*.n3 tests/**/*.n3",
+    "test": "./bin/tuner.sh tests/*.n3 tests/**/*.n3 --base-iri http://localhost:1080/",
     "release": "changeset publish"
   },
   "files": [
@@ -25,8 +25,11 @@
     "@changesets/cli": "^2.27.12",
     "@jeswr/pretty-turtle": "^1.5.0",
     "@zazuko/env-node": "^2.1.4",
+    "is-absolute-url": "^4.0.1",
     "jsonld": "^8.3.3",
     "rdf-validate-shacl": "^0.5.6",
+    "replacestream": "^4.0.3",
+    "stream-concat": "^2.0.0",
     "yargs": "^17.7.2"
   },
   "devDependencies": {

package/rules/assertions.n3

@@ -2,19 +2,50 @@ PREFIX tuner: <https://api-tuner.described.at/>
 prefix string: <http://www.w3.org/2000/10/swap/string#>
 prefix log: <http://www.w3.org/2000/10/swap/log#>
 
+{
+  ?expr tuner:assertThat ?msg .
+} <= {
+  (
+    ?expr
+    true
+    {
+      (
+        { ?msg log:rawType log:ForAll }
+        { ?expr^tuner:logFailedAssertion }
+        { ?msg^tuner:logFailedAssertion }
+      ) log:ifThenElseIn [].
+      true log:equalTo false .
+    }
+  ) log:ifThenElseIn [] .
+} .
+
 {
   ?res tuner:http_code ?value .
+} <= {
+ ( ?res tuner:http_code ?value ) <#curl-field> [] .
+} .
+
+{
+  ?res tuner:url.host ?value .
+} <= {
+  ( ?res tuner:url.host ?value ) <#curl-field> [] .
+} .
+
+{
+  ( ?res ?prop ?value ) <#curl-field> [] .
 } <= {
   ?res log:includes {
     [] a tuner:Response ;
-    tuner:http_code ?actualValue .
+    ?prop ?actualValue .
   } .
 
+  ?prop log:localName ?localName .
+
   (
     { ?actualValue log:equalTo ?value }
     true
     {
-      ("Expected status code " ?value " but got " ?actualValue)!string:concatenation^tuner:info .
+      ("Expected " ?localName " " ?value " but got " ?actualValue)!string:concatenation^tuner:info .
       true log:equalTo false .
     }
   ) log:ifThenElseIn ?SCOPE .

package/rules/logging.n3

@@ -22,3 +22,13 @@ prefix string: <http://www.w3.org/2000/10/swap/string#>
     true
   ) log:ifThenElseIn ?SCOPE .
 } .
+
+{
+  ?left tuner:logFailedAssertion ?right .
+} <= {
+  (
+    { [] tuner:logLevel 'info' }
+    { 'Failed assertion' log:trace ?right . }
+    true
+  ) log:ifThenElseIn ?SCOPE .
+} .