api-tuner 0.3.3 → 0.4.0

package/README.md

@@ -43,40 +43,30 @@ Create a test case file `test.n3`:
 
 ```turtle
 # test.n3
-PREFIX : <http://example.com/>
 PREFIX earl: <http://www.w3.org/ns/earl#>
 PREFIX tuner: <https://api-tuner.described.at/>
+prefix resource: <https://api-tuner.described.at/resource#>
 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>
   a earl:TestCase ;
   rdfs:label "Simple GET test" ;
+  tuner:formula {
+    # Execute the request and capture its response
+    ( <http://localhost:1080/example.com> ?res ) resource:getIn [] .
+
+    # Check the response status code and content type
+    ?res tuner:http_code 200 ;
+      tuner:header ( "content-type" "text/html" ) ;
+    .
+
+    # Check the body contains the work "Example"
+    ?res tuner:body ?body .
+    ?body string:contains "Example Domain" .
+  } ;
 .
 
-# Configure a request
-_:req
-  a tuner:Request ;
-  tuner:url <http://localhost:1080/example.com> ;
-  tuner:method "GET" ;
-.
-
-{
-  # Execute the request and capture its response
-  _:req tuner:response ?res .
-
-  # Check the response status code and content type
-  ?res tuner:http_code 200 ;
-    tuner:header ( "content-type" "text/html" ) ;
-  .
-
-  # Check the body contains the work "Example"
-  ?res!tuner:body string:contains "Example Domain" .
-} => {
-  # Use te EARL vocabulary to assert the test passed
-  <#getExampleDotCom> earl:outcome earl:passed .
-} .
 ```
 
 Execute the test case:

package/bin/tuner.sh

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

package/index.js

@@ -37,10 +37,8 @@ if (options.debug) {
     const debugN3Path = url.fileURLToPath(new URL('logging/debug.n3', import.meta.url));
     eyeArgs.push(debugN3Path);
 }
-if (!options.silent) {
-    const infoN3Path = url.fileURLToPath(new URL('logging/info.n3', import.meta.url));
-    eyeArgs.push(infoN3Path);
-}
+const infoN3Path = url.fileURLToPath(new URL('logging/info.n3', import.meta.url));
+eyeArgs.push(infoN3Path);
 const rulesPath = url.fileURLToPath(new URL('rules/*.n3', import.meta.url));
 const levelIcon = {
     INFO: 'ℹ️',
@@ -94,7 +92,7 @@ const testSuites = program.args.map(async (path) => {
         };
     }
     let summary = `\n🔎 SUITE   <file://${absolutePath}>\n`;
-    if (!validationResult.success) {
+    if (!validationResult.success || !options.silent) {
         const stderr = await getStream(result.stderr);
         summary += stderr.replace(/"([^"]*)" TRACE ("([^"]*)")?/gm, (_, level, quoted, text) => {
             return `${levelIcon[level]} ${text || ''}`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-tuner",
-  "version": "0.3.3",
+  "version": "0.4.0",
   "main": "index.js",
   "type": "module",
   "license": "MIT",
@@ -8,12 +8,13 @@
     "api-tuner": "./bin/tuner.sh"
   },
   "scripts": {
-    "download-eye": "EYE_VERSION=11.10.0 ./lib/download-eye.sh",
+    "download-eye": "EYE_VERSION=11.16.4 ./lib/download-eye.sh",
     "postinstall": "([ -d eye ] || npm run download-eye) && eye/install.sh --prefix=eye",
     "prepare": "husky",
     "lint": "eslint . --quiet --ignore-path .gitignore",
-    "pretest": "docker compose up -d",
-    "test": "./bin/tuner.sh tests/*.n3 tests/**/*.n3 --base-iri http://localhost:1080/",
+    "pre_test": "docker compose up -d",
+    "_test": "./bin/tuner.sh --base-iri http://localhost:1080/",
+    "test": "npm run _test -- tests/*.n3 tests/**/*.n3",
     "prepack": "tsc",
     "release": "changeset publish"
   },
@@ -27,7 +28,7 @@
     "rules"
   ],
   "dependencies": {
-    "@changesets/cli": "^2.27.12",
+    "@changesets/cli": "^2.29.7",
     "@jeswr/pretty-turtle": "^1.5.0",
     "@zazuko/env-node": "^2.1.4",
     "commander": "^13.1.0",

package/rules/curl-body.n3

@@ -54,7 +54,7 @@ prefix math: <http://www.w3.org/2000/10/swap/math#>
 } <= {
   {
     ?value log:rawType log:Literal .
-    ( " -F " ?name "=" ?value ) string:concatenation ?formField .
+    ( " -F " ?name "='" ?value "'" ) string:concatenation ?formField .
   } log:callWithCut true .
 } .
 

package/rules/formula.n3

@@ -0,0 +1,11 @@
+prefix earl: <http://www.w3.org/ns/earl#>
+prefix log: <http://www.w3.org/2000/10/swap/log#>
+prefix tuner: <https://api-tuner.described.at/>
+prefix graph: <http://www.w3.org/2000/10/swap/graph#>
+
+{
+  ?test a earl:TestCase ; tuner:formula ?formula .
+  ?formula log:call true .
+} => {
+   ?test earl:outcome earl:passed .
+} .

package/rules/headers.n3

@@ -0,0 +1,8 @@
+prefix tuner: <https://api-tuner.described.at/>
+prefix string: <http://www.w3.org/2000/10/swap/string#>
+
+{
+  (?fieldName ?fieldValue) tuner:headerArg ?curlArg .
+} <= {
+  ( " -H '" ?fieldName ":" ?fieldValue "'" ) string:concatenation ?curlArg .
+} .

package/rules/http-helpers.n3

@@ -0,0 +1,85 @@
+PREFIX string: <http://www.w3.org/2000/10/swap/string#>
+prefix resource: <https://api-tuner.described.at/resource#>
+prefix tuner: <https://api-tuner.described.at/>
+prefix log: <http://www.w3.org/2000/10/swap/log#>
+prefix graph: <http://www.w3.org/2000/10/swap/graph#>
+
+{
+  (?resource ?res) resource:getIn ?scope
+} <= {
+  ("GET" ?resource ?res) resource:requestIn ?scope .
+
+  ?res tuner:http_code 200 .
+} .
+
+{
+  (?resource ?body) resource:putIn ?scope
+} <= {
+  (?resource ?body ?res) resource:putIn ?scope .
+
+  ?res tuner:http_code 200 .
+} .
+
+{
+  (?resource ?body ?res) resource:putIn ?scope
+} <= {
+  ("PUT" ?resource ?body ?res) resource:requestIn ?scope
+} .
+
+{
+  (?resource ?res) resource:postIn ?scope
+} <= {
+  ("POST" ?resource ?res) resource:requestIn ?scope
+} .
+
+{
+  (?resource ?body ?res) resource:postIn ?scope
+} <= {
+  ("POST" ?resource ?body ?res) resource:requestIn ?scope
+} .
+
+{
+  (?method ?resource ?res) resource:requestIn ?scope
+} <= {
+  ({[
+      a tuner:Request ;
+        tuner:method ?method ;
+        tuner:url ?resource ;
+   ]} ?res) <#requestIn> ( ?scope ?id )
+} .
+
+{
+  (?method ?resource ?body ?res) resource:requestIn ?scope
+} <= {
+  ({[
+      a tuner:Request ;
+        tuner:method ?method ;
+        tuner:url ?resource ;
+        tuner:body ?body ;
+   ]} ?res) <#requestIn> ?scope
+} .
+
+{
+  (?g ?res) <#requestIn> ?scope
+} <= {
+  ?g log:includes {
+    ?req a tuner:Request ;
+         tuner:method ?method ;
+         tuner:url ?resource .
+  } .
+
+  ( <#request>!log:uri "?method=" ?method "?resource=" ?resource!log:uri ) string:concatenation ?idStr .
+  ?id log:uri ?idStr .
+  ({ ?scope ?id [] } false true) log:ifThenElseIn [].
+
+  ( ?g { ?scope ?id ?req } ) graph:union ?union .
+  true log:becomes ?union .
+
+  (
+    { ?scope!?id tuner:response ?res }
+    true
+    {
+      "Request failed"^tuner:info .
+    }
+  ) log:ifThenElseIn [] .
+} .

package/rules/queryParams.n3

@@ -0,0 +1,8 @@
+prefix tuner: <https://api-tuner.described.at/>
+prefix string: <http://www.w3.org/2000/10/swap/string#>
+
+{
+  (?name ?value) tuner:queryParamArg ?curlArg .
+} <= {
+  ( " --url-query '" ?name "=" ?value "'" ) string:concatenation ?curlArg .
+} .

package/rules/requests.n3

@@ -6,11 +6,7 @@ PREFIX tuner: <https://api-tuner.described.at/>
 prefix file: <http://www.w3.org/2000/10/swap/file#>
 prefix earl: <http://www.w3.org/ns/earl#>
 
-{
-  (?fieldName ?fieldValue) tuner:headerArg ?curlArg .
-} <= {
-  ( " -H '" ?fieldName ":" ?fieldValue "'" ) string:concatenation ?curlArg .
-} .
+
 
 {
   ?req tuner:response ?res .
@@ -34,6 +30,15 @@ prefix earl: <http://www.w3.org/ns/earl#>
     { ?headersArgs log:equalTo "" }
   ) log:ifThenElseIn [] .
 
+  (
+    { ?req tuner:query [] . }
+    {
+      ( ?queryParam { ?req tuner:query ?queryParam } ?queryParams ) log:collectAllIn [] .
+      ( ?queryParams tuner:queryParamArg )!list:map string:concatenation ?queryParamArgs .
+    }
+    { ?queryParamArgs log:equalTo "" }
+  ) log:ifThenElseIn [] .
+
   ?endpointUri log:uri ?endpoint .
 
   ( ?method " " ?endpoint )!string:concatenation^tuner:trace .
@@ -55,6 +60,7 @@ prefix earl: <http://www.w3.org/ns/earl#>
       "curl -s -X " ?method " '" ?endpoint "'"
       ?headersArgs
       ?bodyArgs
+      ?queryParamArgs
       " -w @" ( "lib/curl-format.txt"!file:libPath )!string:concatenation
       " -o " ?responseBodyFile
       " > " ?responseHeadersFile