api-tuner 0.5.5 → 0.6.1

package/README.md

@@ -188,6 +188,19 @@ Query parameters can be added to a request using `tuner:query`.
 ?req tuner:query ( "name" "value" ) .
 ```
 
+#### Shell Variables
+
+Values used in request URL, headers and query params are resolved from the shell environment.
+
+```turtle
+<#test> tuner:request [
+  a tuner:Request ;
+  tuner:url <http://example.com/api/$PATH> ;
+  tuner:header ( "X-Api-Key" "$API_KEY" ) ;
+  tuner:query ( "q" "$QUERY" ) ;
+] .
+```
+
 ### Assertions
 
 Assertions are performed on the `tuner:Response` object (usually captured in a variable like `?res`).
@@ -226,18 +239,15 @@ Assert the presence and value of an HTTP header. Header names are case-insensiti
   ```
   ⚠️ Be careful when using `?res!log:includes` resource path shorthand which will not work inside `tuner:formula`. Please refer to [this discussion](https://github.com/eyereasoner/eye/issues/148#issuecomment-2810940959).
 
-<<<<<<< json-assertions
 - **JSON Path**: If the response is JSON, you can use `tuner:jsonPath` to assert values within the body.
   ```turtle
-  ?res tuner:body ?body .
   # Exact match
-  ?body tuner:jsonPath ( "$.foo" "bar" ) .
+  ?res tuner:jsonPath ( "$.foo" "bar" ) .
   # Custom assertion (e.g. regex, contains, math)
-  ?body tuner:jsonPath ( "$.baz" "42" string:contains ) .
+  ?res tuner:jsonPath ( "$.baz" "42" string:contains ) .
   ```
+  ⚠️ Note that unlike RDF assersion, JSON Path assertions are used on the response itself, without using `tuner:body`.
 
-=======
->>>>>>> master
 #### Generic Assertions
 
 Use `tuner:assertThat` to fail a test with a custom message if a condition is not met.

package/lib/download-eye.js

@@ -1,11 +1,26 @@
 #! /usr/bin/env node
 /* eslint-disable no-console */
 import fs from 'node:fs'
+import { spawnSync } from 'node:child_process'
 import { Readable } from 'node:stream'
 import * as tar from 'tar'
 
 async function main() {
   const EYE_VERSION = process.env.EYE_VERSION
+
+  if (fs.existsSync('eye')) {
+    try {
+      const versionOutput = spawnSync('eye/bin/eye', ['--version'], { encoding: 'utf-8' })
+      if (versionOutput.stderr.includes(EYE_VERSION)) {
+        console.log(`EYE v${EYE_VERSION} already installed`)
+        return
+      }
+    } catch (e) {
+      console.warn(`Failed to check EYE version: ${e.message}`)
+      console.warn('Re-downloading...')
+    }
+  }
+
   const url = `https://github.com/eyereasoner/eye/archive/refs/tags/v${EYE_VERSION}.tar.gz`
 
   // Download and extract tarball directly from stream

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-tuner",
-  "version": "0.5.5",
+  "version": "0.6.1",
   "main": "index.js",
   "type": "module",
   "license": "MIT",
@@ -8,12 +8,12 @@
     "api-tuner": "bin/tuner.sh"
   },
   "scripts": {
-    "download-eye": "EYE_VERSION=11.16.4 ./lib/download-eye.js",
-    "postinstall": "([ -d eye ] || npm run download-eye) && eye/install.sh --prefix=eye",
+    "download-eye": "EYE_VERSION=11.24.3 ./lib/download-eye.js",
+    "postinstall": "npm run download-eye && eye/install.sh --prefix=eye",
     "prepare": "husky",
     "lint": "eslint . --quiet --ignore-path .gitignore",
-    "pre_test": "docker compose up -d && docker compose restart && npx wait-on http-get://localhost:1080/ping -t 10s",
-    "_test": "./bin/tuner.sh --base-iri http://localhost:1080/",
+    "pre_test": "docker compose up -d && docker compose restart && npx wait-on http-get://localhost:1080/ping -t 20s",
+    "_test": "export FOO=BAR; ./bin/tuner.sh --base-iri http://localhost:1080/",
     "test": "npm run _test -- tests/*.n3 tests/**/*.n3",
     "prepack": "tsc",
     "release": "changeset publish"

package/rules/assertions.n3

@@ -1,8 +1,10 @@
+PREFIX math: <http://www.w3.org/2000/10/swap/math#>
 PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
 PREFIX list: <http://www.w3.org/2000/10/swap/list#>
 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#>
+prefix file: <http://www.w3.org/2000/10/swap/file#>
 
 {
   ?expr tuner:assertThat ?msg .
@@ -74,22 +76,27 @@ prefix log: <http://www.w3.org/2000/10/swap/log#>
 } .
 
 {
-  ?body tuner:jsonPath ( ?path ?expected ) .
+  ?res tuner:jsonPath ( ?path ?expected ) .
 } <= {
-  ?body tuner:jsonPath ( ?path ?expected log:equalTo ) .
+  ?res tuner:jsonPath ( ?path ?expected log:equalTo ) .
 } .
 
 {
-  ?body tuner:jsonPath ( ?path ?expected ?builtIn ) .
+  ?res tuner:jsonPath ( ?path ?expected ?builtIn ) .
 } <= {
-  ?body log:rawType log:Literal .
-  ( "echo " ?body " | bin/jsonpath.sh '" ?path "' " )!string:concatenation log:shell ?actualRaw .
+  ?res log:includes {
+    [] a tuner:Response ; tuner:body ?bodyPath .
+  } .
+  ( "cat " ?bodyPath " | " "bin/jsonpath.sh"!file:libPath " '" ?path "' " )!string:concatenation log:shell ?actualRaw .
 
   # remove surrounding quotes added by the shell
   ( ( ?actualRaw '^\"' "")!string:replace '\"$' "") string:replace ?actual .
 
+  ( ?actual ?builtIn ) math:normaliseLiteral ?actualNormalised .
+  ( ?expected ?builtIn ) math:normaliseLiteral ?expectedNormalised .
+
   (
-    { ?actual ?builtIn ?expected }
+    { ?actualNormalised ?builtIn ?expectedNormalised }
     true
     {
       ("Expected JSON path '" ?path "' to satisfy '" ?builtIn " " ?expected "' but got '" ?actual "'")!string:concatenation^tuner:info .
@@ -117,8 +124,11 @@ prefix log: <http://www.w3.org/2000/10/swap/log#>
     ] .
   } .
 
+  ( ?actualValue ?builtIn ) math:normaliseLiteral ?actualNormalised .
+  ( ?value ?builtIn ) math:normaliseLiteral ?expectedNormalised .
+
   (
-    { ?actualValue ?builtIn ?value }
+    { ?actualNormalised ?builtIn ?expectedNormalised }
     true
     {
       ("Expected header '" ?name "' '" ?value "' to satisfy '" ?builtIn "' but got '" ?actualValue "'")!string:concatenation^tuner:info .

package/rules/curl-body.n3

@@ -34,8 +34,14 @@ prefix math: <http://www.w3.org/2000/10/swap/math#>
   ?literalBody </#body> ( ?curlArgs [] ) .
 } <= {
   ?literalBody log:rawType log:Literal .
+  () file:temp ?requestBodyFile .
+
+  # Save body to file so that it can be used in the curl command reliably
+  (
+    "echo '" ?literalBody "' > " ?requestBodyFile
+  )!string:concatenation!e:exec .
 
-  ( " -d '" ?literalBody "'" ) string:concatenation ?curlArgs .
+  ( " --data-binary @" ?requestBodyFile ) string:concatenation ?curlArgs .
 } .
 
 {

package/rules/files.n3

@@ -15,7 +15,7 @@ prefix file: <http://www.w3.org/2000/10/swap/file#>
 } <= {
   ?uri log:uri ( "urn:rand:" ( 1000 )!e:random )!string:concatenation .
   # log:shell captures the traling newline
-  ( "mktemp -t api-tuner -d 2>/dev/null || mktemp -d -t api-tuner.XXXXXXXX"!log:shell "\n" "" ) string:replace ?tempDir .
+  ( "mktemp -t api-tuner -d 2>/dev/null || mktemp -d -t api-tuner.XXXXXXXX"!log:shell ("\n") ("") ) string:replaceAll ?tempDir .
 
   (
     ?tempDir

package/rules/headers.n3

@@ -4,5 +4,5 @@ prefix string: <http://www.w3.org/2000/10/swap/string#>
 {
   (?fieldName ?fieldValue) tuner:headerArg ?curlArg .
 } <= {
-  ( " -H '" ?fieldName ":" ?fieldValue "'" ) string:concatenation ?curlArg .
+  ( ' -H "' ?fieldName ":" ?fieldValue '"' ) string:concatenation ?curlArg .
 } .

package/rules/math.n3

@@ -0,0 +1,19 @@
+PREFIX xsd: <http://www.w3.org/2001/XMLSchema#>
+PREFIX log: <http://www.w3.org/2000/10/swap/log#>
+prefix math: <http://www.w3.org/2000/10/swap/math#>
+prefix string: <http://www.w3.org/2000/10/swap/string#>
+
+# See https://github.com/eyereasoner/eye/issues/174#issuecomment-4405018796
+{
+  ( ?value ?builtIn ) math:normaliseLiteral ?normalised
+} <= {
+  (
+    {
+      ?builtIn!log:uri string:startsWith math:!log:uri
+    }
+    {
+      ( ?value xsd:decimal ) log:dtlit ?normalised
+    }
+    { ?value log:equalTo ?normalised }
+  ) log:ifThenElseIn ?SCOPE
+} .

package/rules/queryParams.n3

@@ -4,5 +4,5 @@ prefix string: <http://www.w3.org/2000/10/swap/string#>
 {
   (?name ?value) tuner:queryParamArg ?curlArg .
 } <= {
-  ( " --url-query '" ?name "=" ?value "'" ) string:concatenation ?curlArg .
+  ( ' --url-query "' ?name "=" ?value '"' ) string:concatenation ?curlArg .
 } .

package/rules/requests.n3

@@ -55,7 +55,7 @@ prefix earl: <http://www.w3.org/ns/earl#>
     ) log:ifThenElseIn [] .
 
     (
-      "curl -s -X " ?method " '" ?endpoint "'"
+      "curl -s -X " ?method ' "' ?endpoint '"'
       ?headersArgs
       ?bodyArgs
       ?queryParamArgs