@toa.io/extensions.exposition 1.0.0-alpha.28 → 1.0.0-alpha.282

package/features/octets.download.feature

@@ -0,0 +1,192 @@
+Feature: Download external resources
+
+  Scenario Outline: Download from trusted location defined as <type>
+    Given the annotation:
+      """yaml
+      /:
+        io:output: true
+        auth:anonymous: true
+        octets:context: octets
+        POST:
+          octets:put:
+            trust:
+              - <location> # <type>
+              - https://github.com
+        /*:
+          GET:
+            octets:get:
+              meta: true
+      """
+
+    Given the length of `https://avatars.githubusercontent.com/u/92763022?s=48&v=4` is captured as `length`
+
+    When the following request is received:
+      """
+      POST / HTTP/1.1
+      host: nex.toa.io
+      content-location: https://avatars.githubusercontent.com/u/92763022?s=48&v=4
+      content-length: 0
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+
+      id: ${{ id }}
+      type: image/png
+      checksum: ${{ checksum }}
+      """
+
+    When the following request is received:
+      """
+      GET /${{ id }} HTTP/1.1
+      host: nex.toa.io
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-length: ${{ length }}
+      content-type: image/png
+      etag: "${{ checksum }}"
+      """
+
+    # origin is stored in the entry
+    When the following request is received:
+      """
+      GET /${{ id }} HTTP/1.1
+      host: nex.toa.io
+      accept: application/vnd.toa.octets.entry+yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/yaml
+
+      id: ${{ id }}
+      type: image/png
+      origin: https://avatars.githubusercontent.com/u/92763022?s=48&v=4
+      """
+
+    # untrusted location
+    When the following request is received:
+      """
+      POST / HTTP/1.1
+      host: nex.toa.io
+      content-location: https://github.githubassets.com/assets/yolo-default-be0bbff04951.png
+      content-length: 0
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      403 Forbidden
+
+      Location is not trusted
+      """
+
+    # content-length must be 0
+    When the following request is received:
+      """
+      POST / HTTP/1.1
+      host: nex.toa.io
+      content-location: https://avatars.githubusercontent.com/u/92763022?s=48&v=4
+      content-length: 1
+      accept: application/yaml
+
+      1
+      """
+    Then the following reply is sent:
+      """
+      400 Bad Request
+
+      Content-Length must be 0 when Content-Location is used
+      """
+
+    # invalid content-location
+    When the following request is received:
+      """
+      POST / HTTP/1.1
+      host: nex.toa.io
+      content-location: Hello there!
+      content-length: 0
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      403 Forbidden
+
+      Location is not trusted
+      """
+
+    # unavailable location
+    When the following request is received:
+      """
+      POST / HTTP/1.1
+      host: nex.toa.io
+      content-location: https://github.com/toa-io/no
+      content-length: 0
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      404 Not Found
+
+      Location is not available
+      """
+
+    Examples:
+      | type       | location                                   |
+      | origin     | https://avatars.githubusercontent.com      |
+      | expression | /^https://avatars\.githubusercontent\.com/ |
+
+  Scenario: Download size limit
+    Given the annotation:
+      """yaml
+      /:
+        io:output: true
+        auth:anonymous: true
+        octets:context: octets
+        POST:
+          octets:put:
+            limit: 1kb
+            trust:
+              - https://avatars.githubusercontent.com
+      """
+    When the following request is received:
+      """
+      POST / HTTP/1.1
+      host: nex.toa.io
+      content-location: https://avatars.githubusercontent.com/u/92763022?s=48&v=4
+      content-length: 0
+      accept: text/plain
+      """
+    Then the following reply is sent:
+      """
+      413 Request Entity Too Large
+
+      Size limit is 1kb
+      """
+
+  Scenario: Allow `content-location` request header
+    Given the annotation:
+      """yaml
+      /:
+        io:output: true
+        auth:anonymous: true
+        octets:context: octets
+        POST:
+          octets:put:
+            limit: 1kb
+            trust:
+              - https://avatars.githubusercontent.com
+      """
+    When the following request is received:
+      """
+      OPTIONS / HTTP/1.1
+      host: nex.toa.io
+      origin: https://hello.world
+      """
+    Then the following reply is sent:
+      """
+      204 No Content
+      access-control-allow-headers: accept, authorization, content-attributes, content-location, content-type, if-match, if-none-match
+      """

package/features/octets.entries.feature

@@ -1,6 +1,6 @@
-Feature: Accessing entries
+Feature: Accessing metadata
 
-  Scenario: Entries are not accessible by default
+  Scenario: Metadata is not accessible by default
     Given the annotation:
       """yaml
       /:
@@ -8,12 +8,10 @@ Feature: Accessing entries
         auth:anonymous: true
         octets:context: octets
         POST:
-          octets:store: ~
-        GET:
-          octets:list: ~
+          octets:put: ~
         /*:
           GET:
-            octets:fetch: ~
+            octets:get: ~
       """
     When the stream of `lenna.ascii` is received with the following headers:
       """
@@ -25,18 +23,6 @@ Feature: Accessing entries
       """
       201 Created
       """
-    When the following request is received:
-      """
-      GET / HTTP/1.1
-      host: nex.toa.io
-      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
@@ -47,10 +33,10 @@ Feature: Accessing entries
       """
       403 Forbidden
 
-      Metadata is not accessible.
+      Metadata is not accessible
       """
 
-  Scenario: Accessing entries
+  Scenario: Accessing metadata
     Given the annotation:
       """yaml
       /:
@@ -58,13 +44,10 @@ Feature: Accessing entries
         auth:anonymous: true
         octets:context: octets
         POST:
-          octets:store: ~
-        GET:
-          octets:list:
-            meta: true
+          octets:put: ~
         /*:
           GET:
-            octets:fetch:
+            octets:get:
               meta: true
       """
     When the stream of `lenna.ascii` is received with the following headers:
@@ -73,6 +56,7 @@ Feature: Accessing entries
       host: nex.toa.io
       accept: application/yaml
       content-type: application/octet-stream
+      content-id: lenna-ascii
       """
     And the stream of `lenna.png` is received with the following headers:
       """
@@ -80,42 +64,11 @@ Feature: Accessing entries
       host: nex.toa.io
       accept: application/yaml
       content-type: application/octet-stream
+      content-id: lenna-png
       """
     When the following request is received:
       """
-      GET / HTTP/1.1
-      host: nex.toa.io
-      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
-      host: nex.toa.io
-      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
+      GET /lenna-ascii HTTP/1.1
       host: nex.toa.io
       accept: application/vnd.toa.octets.entry+yaml
       """
@@ -123,9 +76,8 @@ Feature: Accessing entries
       """
       200 OK
       content-type: application/yaml
-      content-length: 124
 
-      id: 10cf16b458f759e0d617f2f3d83599ff
-      type: application/octet-stream
+      id: lenna-ascii
       size: 8169
+      type: application/octet-stream
       """

package/features/octets.feature

@@ -8,32 +8,38 @@ Feature: Octets directive family
         auth:anonymous: true
         octets:context: octets
         POST:
-          octets:store: ~
-        GET:
-          octets:list: ~
+          octets:put: ~
         /*:
           GET:
-            octets:fetch: ~
+            octets:get: ~
           DELETE:
             octets:delete: ~
         /media:
           /jpeg:
             POST:
-              octets:store:
+              octets:put:
                 accept: image/jpeg
           /jpeg-or-png:
             POST:
-              octets:store:
+              octets:put:
                 accept:
                   - image/jpeg
                   - image/png
           /images:
             POST:
-              octets:store:
+              octets:put:
                 accept: image/*
             /*:
               GET:
-                octets:fetch: ~
+                octets:get: ~
+        /limit-1kb:
+          POST:
+            octets:put:
+              limit: 1kb
+        /limit-100kb:
+          POST:
+            octets:put:
+              limit: 100kb
       """
 
   Scenario: Basic storage operations
@@ -49,27 +55,27 @@ Feature: Octets directive family
       201 Created
       content-type: application/yaml
 
-      id: 10cf16b458f759e0d617f2f3d83599ff
-      type: application/octet-stream
+      id: ${{ id }}
       size: 8169
+      type: application/octet-stream
       """
     When the following request is received:
       """
-      GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      GET /${{ id }} HTTP/1.1
       host: nex.toa.io
       """
     Then the stream equals to `lenna.ascii` is sent with the following headers:
       """
       200 OK
-      content-type: application/octet-stream
       content-length: 8169
-      etag: ${{ ETAG }}
+      content-type: application/octet-stream
+      etag: "${{ ETAG }}"
       """
     When the following request is received:
       """
-      GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      GET /${{ id }} HTTP/1.1
       host: nex.toa.io
-      if-none-match: ${{ ETAG }}
+      if-none-match: "${{ ETAG }}"
       """
     Then the following reply is sent:
       """
@@ -77,20 +83,7 @@ Feature: Octets directive family
       """
     When the following request is received:
       """
-      GET / HTTP/1.1
-      host: nex.toa.io
-      accept: application/yaml
-      """
-    Then the following reply is sent:
-      """
-      200 OK
-      content-type: application/yaml
-
-      - 10cf16b458f759e0d617f2f3d83599ff
-      """
-    When the following request is received:
-      """
-      GET /10cf16b458f759e0d617f2f3d83599ff?foo=bar HTTP/1.1
+      GET /${{ id }}?foo=bar HTTP/1.1
       host: nex.toa.io
       """
     Then the following reply is sent:
@@ -99,7 +92,7 @@ Feature: Octets directive family
       """
     When the following request is received:
       """
-      DELETE /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      DELETE /${{ id }} HTTP/1.1
       host: nex.toa.io
       """
     Then the following reply is sent:
@@ -108,7 +101,7 @@ Feature: Octets directive family
       """
     When the following request is received:
       """
-      GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      GET /${{ id }} HTTP/1.1
       host: nex.toa.io
       """
     Then the following reply is sent:
@@ -146,6 +139,32 @@ Feature: Octets directive family
       201 Created
       """
 
+  Scenario: Size limit
+    When the stream of `albert.jpg` is received with the following headers:
+      """
+      POST /limit-1kb/ HTTP/1.1
+      host: nex.toa.io
+      content-type: image/jpeg
+      accept: text/plain
+      """
+    Then the following reply is sent:
+      """
+      413 Request Entity Too Large
+
+      Size limit is 1kb
+      """
+
+    When the stream of `albert.jpg` is received with the following headers:
+      """
+      POST /limit-100kb/ HTTP/1.1
+      host: nex.toa.io
+      content-type: image/jpeg
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      """
+
   Scenario Outline: Detecting `<type>`
     When the stream of `sample.<ext>` is received with the following headers:
       """
@@ -183,7 +202,7 @@ Feature: Octets directive family
       type: image/svg+xml
       """
 
-    Scenario: Rejection video/avi
+  Scenario: Rejection video/avi
     When the stream of `sample.avi` is received with the following headers:
       """
       POST /media/images/ HTTP/1.1
@@ -224,42 +243,5 @@ Feature: Octets directive family
       404 Not Found
       content-type: text/plain
 
-      Trailing slash is redundant.
-      """
-
-  Scenario: Original BLOB is not accessible
-    Given the annotation:
-      """yaml
-      /:
-        io:output: true
-        auth:anonymous: true
-        octets:context: octets
-        POST:
-          octets:store: ~
-        /*:
-          GET:
-            octets:fetch:
-              meta: true
-              blob: false
-      """
-    When the stream of `lenna.ascii` is received with the following headers:
-      """
-      POST / HTTP/1.1
-      host: nex.toa.io
-      """
-    Then the following reply is sent:
-      """
-      201 Created
-      """
-    When the following request is received:
-      """
-      GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
-      host: nex.toa.io
-      accept: text/plain
-      """
-    Then the following reply is sent:
-      """
-      403 Forbidden
-
-      BLOB variant must be specified.
+      Trailing slash is redundant
       """

package/features/octets.head.feature

@@ -0,0 +1,40 @@
+Feature: Octets headers
+
+  Scenario: Accessing headers
+    Given the annotation:
+      """yaml
+      /:
+        io:output: true
+        auth:anonymous: true
+        octets:context: octets
+        /*:
+          POST:
+            octets:put: ~
+          /*:
+            HEAD:
+              octets:head: ~
+      """
+    When the stream of `lenna.ascii` is received with the following headers:
+      """
+      POST /assets/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      content-type: application/octet-stream
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+
+      id: ${{ id }}
+      """
+    When the following request is received:
+      """
+      HEAD /assets/${{ id }} HTTP/1.1
+      host: nex.toa.io
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-length: 8169
+      content-type: application/octet-stream
+      """

package/features/octets.location.feature

@@ -0,0 +1,83 @@
+Feature: Octets location
+
+  Scenario Outline: Store octets in a specified location
+    Given the annotation:
+      """yaml
+      /:
+        /foo:
+          octets:context: octets
+          auth:anonymous: true
+          io:output: true
+          POST:
+            octets:put:
+              location: <location>
+          /bar:
+            /*:
+              GET:
+                octets:get: ~
+      """
+    When the stream of `lenna.ascii` is received with the following headers:
+      """
+      POST /foo/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      content-type: application/octet-stream
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+
+      id: ${{ id }}
+      """
+    When the following request is received:
+      """
+      HEAD /foo/bar/${{ id }} HTTP/1.1
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      """
+    Examples:
+      | location  |
+      | ./bar     |
+      | /foo/bar/ |
+
+  Scenario: Executing a workflow with specified location
+    Given the `octets.tester` is running
+    And the annotation:
+      """yaml
+      /:
+        auth:anonymous: true
+        octets:context: octets
+        POST:
+          octets:put:
+            location: /hello/world/
+            workflow:
+              echo: octets.tester.echo
+          io:output: true
+      """
+    When the stream of `lenna.ascii` is received with the following headers:
+      """
+      POST / HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml, multipart/yaml
+      content-type: application/octet-stream
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      content-type: multipart/yaml; boundary=cut
+
+      --cut
+
+      id: ${{ id }}
+      size: 8169
+      type: application/octet-stream
+      --cut
+
+      step: echo
+      status: completed
+      output:
+        path: /hello/world/${{ id }}
+      --cut--
+      """