@toa.io/extensions.exposition 0.24.0-alpha.9 → 1.0.0-alpha.10

package/features/io.feature

@@ -0,0 +1,167 @@
+Feature: IO restrictions
+
+  Background:
+    Given the `pots` database contains:
+      | _id                              | title      | volume | temperature |
+      | 4c4759e6f9c74da989d64511df42d6f4 | First pot  | 100    | 80          |
+      | 99988d785d7d445cad45dbf8531f560b | Second pot | 200    | 30          |
+
+  Scenario: Output is omitted by default
+    Given the `pots` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          GET: enumerate
+          /:id:
+            GET: observe
+      """
+    When the following request is received:
+      """
+      GET /pots/4c4759e6f9c74da989d64511df42d6f4/ HTTP/1.1
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-length: 0
+      """
+    When the following request is received:
+      """
+      GET /pots/ HTTP/1.1
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-length: 0
+      """
+
+  Scenario: Output is omitted by intention
+    Given the `pots` is running with the following manifest:
+      """yaml
+      exposition:
+        /:id:
+          io:output: false
+          GET: observe
+      """
+    When the following request is received:
+      """
+      GET /pots/4c4759e6f9c74da989d64511df42d6f4/ HTTP/1.1
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-length: 0
+      """
+
+  Scenario: Output permissions
+    Given the `pots` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: [id, volume]
+          GET: enumerate
+          /:id:
+            GET: observe
+      """
+    When the following request is received:
+      """
+      GET /pots/4c4759e6f9c74da989d64511df42d6f4/ HTTP/1.1
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      id: 4c4759e6f9c74da989d64511df42d6f4
+      volume: 100
+      """
+    And the reply does not contain:
+      """
+      title:
+      temperature:
+      """
+    When the following request is received:
+      """
+      GET /pots/ HTTP/1.1
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/yaml
+
+      - id: 4c4759e6f9c74da989d64511df42d6f4
+        volume: 100
+      - id: 99988d785d7d445cad45dbf8531f560b
+        volume: 200
+      """
+    And the reply does not contain:
+      """
+      title:
+      temperature:
+      """
+
+  Scenario: Input is unrestricted by default
+    Given the `pots` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          POST: create
+      """
+    When the following request is received:
+      """
+      POST /pots/ HTTP/1.1
+      accept: application/yaml
+      content-type: application/yaml
+
+      title: Hello
+      volume: 1.5
+      temperature: 80
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+
+      title: Hello
+      volume: 1.5
+      temperature: 80
+      """
+
+  Scenario: Input permissions
+    Given the `pots` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:input: [title, volume]
+          POST: create
+      """
+    When the following request is received:
+      """
+      POST /pots/ HTTP/1.1
+      accept: text/plain
+      content-type: application/yaml
+
+      title: Hello
+      volume: 1.5
+      temperature: 80
+      """
+    Then the following reply is sent:
+      """
+      400 Bad Request
+
+      Unexpected input: temperature
+      """
+    When the following request is received:
+      """
+      POST /pots/ HTTP/1.1
+      content-type: application/yaml
+
+      title: Hello
+      volume: 1.5
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      """

package/features/octets.entries.feature

@@ -0,0 +1,123 @@
+Feature: Accessing entries
+
+  Scenario: Entries are not accessible by default
+    Given the annotation:
+      """yaml
+      /:
+        io:output: true
+        auth:anonymous: true
+        octets:context: octets
+        POST:
+          octets:store: ~
+        GET:
+          octets:list: ~
+        /*:
+          GET:
+            octets:fetch: ~
+      """
+    When the stream of `lenna.ascii` is received with the following headers:
+      """
+      POST / HTTP/1.1
+      content-type: application/octet-stream
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      """
+    When the following request is received:
+      """
+      GET / HTTP/1.1
+      accept: application/vnd.toa.octets.entries+yaml
+      """
+    Then the following reply is sent:
+      """
+      403 Forbidden
+
+      Metadata is not accessible.
+      """
+    When the following request is received:
+      """
+      GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      accept: text/vnd.toa.octets.entry+plain
+      """
+    Then the following reply is sent:
+      """
+      403 Forbidden
+
+      Metadata is not accessible.
+      """
+
+  Scenario: Accessing entries
+    Given the annotation:
+      """yaml
+      /:
+        io:output: true
+        auth:anonymous: true
+        octets:context: octets
+        POST:
+          octets:store: ~
+        GET:
+          octets:list:
+            meta: true
+        /*:
+          GET:
+            octets:fetch:
+              meta: true
+      """
+    When the stream of `lenna.ascii` is received with the following headers:
+      """
+      POST / HTTP/1.1
+      accept: application/yaml
+      content-type: application/octet-stream
+      """
+    And the stream of `lenna.png` is received with the following headers:
+      """
+      POST / HTTP/1.1
+      accept: application/yaml
+      content-type: application/octet-stream
+      """
+    When the following request is received:
+      """
+      GET / HTTP/1.1
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/yaml
+
+      - 10cf16b458f759e0d617f2f3d83599ff
+      - 814a0034f5549e957ee61360d87457e5
+      """
+    When the following request is received:
+      """
+      GET / HTTP/1.1
+      accept: application/vnd.toa.octets.entries+yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/yaml
+
+      - id: 10cf16b458f759e0d617f2f3d83599ff
+        size: 8169
+        type: application/octet-stream
+      - id: 814a0034f5549e957ee61360d87457e5
+        size: 473831
+        type: image/png
+      """
+    When the following request is received:
+      """
+      GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      accept: application/vnd.toa.octets.entry+yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/yaml
+      content-length: 124
+
+      id: 10cf16b458f759e0d617f2f3d83599ff
+      type: application/octet-stream
+      size: 8169
+      """

package/features/octets.feature

@@ -4,6 +4,7 @@ Feature: Octets directive family
     Given the annotation:
       """yaml
       /:
+        io:output: true
         auth:anonymous: true
         octets:context: octets
         POST:
@@ -70,17 +71,6 @@ Feature: Octets directive family
       """
       304 Not Modified
       """
-    When the following request is received:
-      """
-      GET /10cf16b458f759e0d617f2f3d83599ff:meta HTTP/1.1
-      accept: text/plain
-      """
-    Then the following reply is sent:
-      """
-      403 Forbidden
-
-      Metadata is not accessible.
-      """
     When the following request is received:
       """
       GET / HTTP/1.1
@@ -245,11 +235,11 @@ Feature: Octets directive family
       Trailing slash is redundant.
       """
 
-  Scenario: Accessing an Entry and the original BLOLB
+  Scenario: Original BLOLB is not accessible
     Given the annotation:
       """yaml
-      debug: true
       /:
+        io:output: true
         auth:anonymous: true
         octets:context: octets
         POST:
@@ -268,24 +258,10 @@ Feature: Octets directive family
       """
       201 Created
       """
-    When the following request is received:
-      """
-      GET /10cf16b458f759e0d617f2f3d83599ff:meta HTTP/1.1
-      accept: application/yaml
-      """
-    Then the following reply is sent:
-      """
-      200 OK
-      content-type: application/yaml
-      content-length: 124
-
-      id: 10cf16b458f759e0d617f2f3d83599ff
-      type: application/octet-stream
-      size: 8169
-      """
     When the following request is received:
       """
       GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      accept: text/plain
       """
     Then the following reply is sent:
       """

package/features/octets.meta.feature

@@ -0,0 +1,66 @@
+Feature: Octets `content-meta` header
+
+  Scenario: Sending `content-meta` header
+    Given the `octets.tester` is running
+    And the annotation:
+      """yaml
+      /:
+        io:output: true
+        auth:anonymous: true
+        octets:context: octets
+        /*:
+          POST:
+            octets:store: ~
+          /*:
+            GET:
+              octets:fetch:
+                meta: true
+      """
+    When the stream of `lenna.ascii` is received with the following headers:
+      """
+      POST /meta-header/ HTTP/1.1
+      content-type: application/octet-stream
+      content-meta: foo, bar=baz=1
+      content-meta: baz=1
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      """
+    When the following request is received:
+      """
+      GET /meta-header/10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      accept: application/vnd.toa.octets.entry+yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      id: 10cf16b458f759e0d617f2f3d83599ff
+      type: application/octet-stream
+      size: 8169
+      meta:
+        foo: 'true'
+        bar: baz=1
+        baz: '1'
+      """
+
+  Scenario: CORS allows `content-meta` header
+    Given the annotation:
+      """yaml
+      /:
+        octets:context: octets
+        POST:
+          octets:store: ~
+      """
+    When the following request is received:
+      """
+      OPTIONS / HTTP/1.1
+      origin: https://example.com
+      """
+    Then the following reply is sent:
+      """
+      204 No Content
+      access-control-allow-origin: https://example.com
+      access-control-allow-headers: accept, authorization, content-type, etag, if-match, if-none-match, content-meta
+      """

package/features/octets.workflows.feature

@@ -2,7 +2,7 @@ Feature: Octets storage workflows
 
   Scenario: Running a workflow
     Given the `octets.tester` is running
-    Given the annotation:
+    And the annotation:
       """yaml
       /:
         auth:anonymous: true
@@ -15,6 +15,7 @@ Feature: Octets storage workflows
               - add-baz: octets.tester.baz
               - diversify: octets.tester.diversify
         /*:
+          io:output: true
           GET:
             octets:fetch:
               meta: true
@@ -47,8 +48,8 @@ Feature: Octets storage workflows
       """
     When the following request is received:
       """
-      GET /10cf16b458f759e0d617f2f3d83599ff:meta HTTP/1.1
-      accept: application/yaml
+      GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      accept: application/vnd.toa.octets.entry+yaml
       """
     Then the following reply is sent:
       """
@@ -74,7 +75,7 @@ Feature: Octets storage workflows
       content-length: 473831
       """
 
-  Scenario: Getting error when adding metadata to a file
+  Scenario: Getting error when running workflow on `store`
     Given the `octets.tester` is running
     Given the annotation:
       """yaml
@@ -112,3 +113,175 @@ Feature: Octets storage workflows
         message: Something went wrong
       --cut--
       """
+
+  Scenario: Running a workflow on `delete`
+    Given the `octets.tester` is running
+    And the annotation:
+      """yaml
+      /:
+        auth:anonymous: true
+        octets:context: octets
+        POST:
+          octets:store: ~
+        /*:
+          GET:
+            octets:fetch: ~
+          DELETE:
+            octets:delete:
+              workflow:
+                echo: octets.tester.echo
+      """
+    When the stream of `lenna.ascii` is received with the following headers:
+      """
+      POST / HTTP/1.1
+      content-type: application/octet-stream
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      """
+    When the following request is received:
+      """
+      DELETE /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      202 Accepted
+      content-type: multipart/yaml; boundary=cut
+
+      --cut
+      echo: 10cf16b458f759e0d617f2f3d83599ff
+      --cut--
+      """
+    When the following request is received:
+      """
+      GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      """
+    Then the following reply is sent:
+      """
+      404 Not Found
+      """
+
+  Scenario: Error in the workflow on `delete`
+    Given the `octets.tester` is running
+    And the annotation:
+      """yaml
+      /:
+        auth:anonymous: true
+        octets:context: octets
+        POST:
+          octets:store: ~
+        /*:
+          GET:
+            octets:fetch: ~
+          DELETE:
+            octets:delete:
+              workflow:
+                err: octets.tester.err
+      """
+    When the stream of `lenna.ascii` is received with the following headers:
+      """
+      POST / HTTP/1.1
+      content-type: application/octet-stream
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      """
+    When the following request is received:
+      """
+      DELETE /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      202 Accepted
+      content-type: multipart/yaml; boundary=cut
+
+      --cut
+      error:
+        step: err
+        code: ERROR
+        message: Something went wrong
+      --cut--
+      """
+    When the following request is received:
+      """
+      GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      """
+
+  Scenario: Passing parameters to the workflow
+    Given the `octets.tester` is running
+    And the annotation:
+      """yaml
+      /:
+        /:a/:b:
+          auth:anonymous: true
+          octets:context: octets
+          POST:
+            octets:store:
+              workflow:
+                concat: octets.tester.concat
+      """
+    When the stream of `lenna.ascii` is received with the following headers:
+      """
+      POST /hello/world/ HTTP/1.1
+      accept: application/yaml
+      content-type: application/octet-stream
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      content-type: multipart/yaml; boundary=cut
+
+      --cut
+      id: 10cf16b458f759e0d617f2f3d83599ff
+      type: application/octet-stream
+      size: 8169
+      --cut
+      concat: hello world
+      --cut--
+      """
+
+  Scenario: Executing a workflow with `octets:workflow`
+    Given the `octets.tester` is running
+    And the annotation:
+      """yaml
+      /:
+        auth:anonymous: true
+        octets:context: octets
+        POST:
+          octets:store: ~
+        /*:
+          DELETE:
+            octets:workflow:
+              echo: octets.tester.echo
+      """
+    When the stream of `lenna.ascii` is received with the following headers:
+      """
+      POST / HTTP/1.1
+      content-type: application/octet-stream
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      """
+    When the following request is received:
+      """
+      DELETE /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      202 Accepted
+      content-type: multipart/yaml; boundary=cut
+
+      --cut
+      echo: 10cf16b458f759e0d617f2f3d83599ff
+      --cut--
+      """

package/features/queries.feature

@@ -13,6 +13,7 @@ Feature: Queries
       """yaml
       exposition:
         /pot:
+          io:output: true
           GET: observe
       """
     When the following request is received:
@@ -35,6 +36,7 @@ Feature: Queries
       """yaml
       exposition:
         /:
+          io:output: true
           GET: enumerate
       """
     When the following request is received:
@@ -60,6 +62,7 @@ Feature: Queries
       """yaml
       exposition:
         /:
+          io:output: true
           GET: enumerate
       """
     When the following request is received:
@@ -85,6 +88,7 @@ Feature: Queries
       """yaml
       exposition:
         /:
+          io:output: true
           GET: enumerate
       """
     When the following request is received:
@@ -110,6 +114,7 @@ Feature: Queries
       """yaml
       exposition:
         /:id:
+          io:output: true
           GET: observe
       """
     When the following request is received:
@@ -127,11 +132,12 @@ Feature: Queries
       volume: 200
       """
 
-  Scenario: Request to a route with predefined criretia
+  Scenario: Request to a route with predefined criteria
     Given the `pots` is running with the following manifest:
       """yaml
       exposition:
         /big:
+          io:output: true
           GET:
             endpoint: enumerate
             query:
@@ -160,6 +166,7 @@ Feature: Queries
       """yaml
       exposition:
         /big:
+          io:output: true
           GET:
             endpoint: enumerate
             query:
@@ -186,6 +193,7 @@ Feature: Queries
       """yaml
       exposition:
         /hottest2:
+          io:output: true
           GET:
             endpoint: enumerate
             query: