@toa.io/extensions.exposition 1.0.0-alpha.2 → 1.0.0-alpha.200

package/features/cache.feature

@@ -1,19 +1,55 @@
+@security
 Feature: Caching
 
   Background:
     Given the `identity.basic` database contains:
       # developer:secret
       # user:12345
-      | _id                              | username  | password                                                     |
-      | b70a7dbca6b14a2eaac8a9eb4b2ff4db | developer | $2b$10$ZRSKkgZoGnrcTNA5w5eCcu3pxDzdTduhteVYXcp56AaNcilNkwJ.O |
+      | _id                              | authority | username  | password                                                     |
+      | b70a7dbca6b14a2eaac8a9eb4b2ff4db | nex       | developer | $2b$10$ZRSKkgZoGnrcTNA5w5eCcu3pxDzdTduhteVYXcp56AaNcilNkwJ.O |
     Given the `identity.roles` database contains:
       | _id                              | identity                         | role      |
       | 775a648d054e4ce1a65f8f17e5b51803 | b70a7dbca6b14a2eaac8a9eb4b2ff4db | developer |
 
+  Scenario: Default caching
+    Given the annotation:
+      """yaml
+      /:
+        anonymous: true
+        GET:
+          dev:stub: foo
+        /private:
+          auth:role: developer
+          GET:
+            dev:stub: bar
+      """
+    When the following request is received:
+      """
+      GET / HTTP/1.1
+      host: nex.toa.io
+      """
+    Then the reply does not contain:
+      """
+      cache-control:
+      """
+    When the following request is received:
+      """
+      GET /private/ HTTP/1.1
+      host: nex.toa.io
+      authorization: Basic ZGV2ZWxvcGVyOnNlY3JldA==
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      cache-control: no-store
+      """
+
   Scenario: Caching successful response
     Given the annotation:
       """yaml
       /:
+        io:output: true
         anonymous: true
         GET:
           cache:control: max-age=60000
@@ -22,6 +58,7 @@ Feature: Caching
     When the following request is received:
       """
       GET / HTTP/1.1
+      host: nex.toa.io
       accept: text/plain
       """
     Then the following reply is sent:
@@ -37,6 +74,7 @@ Feature: Caching
     Given the annotation:
       """yaml
       /:
+        io:output: true
         cache:control: max-age=30000
         GET:
           anonymous: true
@@ -51,9 +89,22 @@ Feature: Caching
           GET:
             dev:stub: hello
       """
+    When the following request is received:
+      """
+      GET /identity/ HTTP/1.1
+      host: nex.toa.io
+      authorization: Basic ZGV2ZWxvcGVyOnNlY3JldA==
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      authorization: Token ${{ token }}
+      cache-control: no-store
+      """
     When the following request is received:
       """
       GET / HTTP/1.1
+      host: nex.toa.io
       accept: text/plain
       """
     Then the following reply is sent:
@@ -67,8 +118,9 @@ Feature: Caching
     When the following request is received:
       """
       GET /foo/ HTTP/1.1
+      host: nex.toa.io
       accept: text/plain
-      authorization: Basic ZGV2ZWxvcGVyOnNlY3JldA==
+      authorization: Token ${{ token }}
       """
     Then the following reply is sent:
       """
@@ -81,8 +133,9 @@ Feature: Caching
     When the following request is received:
       """
       GET /bar/ HTTP/1.1
+      host: nex.toa.io
       accept: text/plain
-      authorization: Basic ZGV2ZWxvcGVyOnNlY3JldA==
+      authorization: Token ${{ token }}
       """
     Then the following reply is sent:
       """
@@ -109,6 +162,7 @@ Feature: Caching
     When the following request is received:
       """
       POST / HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the reply does not contain:
@@ -120,6 +174,7 @@ Feature: Caching
     Given the annotation:
       """yaml
       /:
+        io:output: true
         auth:role: developer
         cache:exact: max-age=60000, public
         GET:
@@ -127,8 +182,21 @@ Feature: Caching
       """
     When the following request is received:
       """
-      GET / HTTP/1.1
+      GET /identity/ HTTP/1.1
+      host: nex.toa.io
       authorization: Basic ZGV2ZWxvcGVyOnNlY3JldA==
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      authorization: Token ${{ token }}
+      cache-control: no-store
+      """
+    When the following request is received:
+      """
+      GET / HTTP/1.1
+      host: nex.toa.io
+      authorization: Token ${{ token }}
       accept: text/plain
 
       """
@@ -152,9 +220,103 @@ Feature: Caching
     When the following request is received:
       """
       GET / HTTP/1.1
+      host: nex.toa.io
       accept: text/plain
       """
     Then the reply does not contain:
       """
       cache-control:
       """
+
+  Scenario: Private responses are sent with `vary: authorization`
+    Given the `identity.basic` database contains:
+      | _id                              | authority | username  | password                                                     |
+      | efe3a65ebbee47ed95a73edd911ea328 | nex       | developer | $2b$10$ZRSKkgZoGnrcTNA5w5eCcu3pxDzdTduhteVYXcp56AaNcilNkwJ.O |
+    And the annotation:
+      """yaml
+      /:
+        /:id:
+          auth:id: id
+          cache:control: max-age=10000
+          GET:
+            dev:stub: Keep it
+        /sessions/:id:
+          auth:id: id
+          GET:
+            dev:stub: Keep it
+      """
+    When the following request is received:
+      """
+      GET /efe3a65ebbee47ed95a73edd911ea328/ HTTP/1.1
+      host: nex.toa.io
+      authorization: Basic ZGV2ZWxvcGVyOnNlY3JldA==
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      authorization: Token ${{ token }}
+      cache-control: no-store
+      """
+    When the following request is received:
+      """
+      GET /efe3a65ebbee47ed95a73edd911ea328/ HTTP/1.1
+      host: nex.toa.io
+      authorization: Token ${{ token }}
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      cache-control: private, max-age=10000
+      vary: authorization
+      """
+    When the following request is received:
+      """
+      GET /sessions/efe3a65ebbee47ed95a73edd911ea328/ HTTP/1.1
+      host: nex.toa.io
+      authorization: Token ${{ token }}
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      cache-control: private
+      vary: authorization
+      """
+
+  Scenario: Authenticated `no-cache` responses
+    Given the `identity.basic` database contains:
+      | _id                              | authority | username  | password                                                     |
+      | efe3a65ebbee47ed95a73edd911ea328 | nex       | developer | $2b$10$ZRSKkgZoGnrcTNA5w5eCcu3pxDzdTduhteVYXcp56AaNcilNkwJ.O |
+    And the annotation:
+      """yaml
+      /:
+        /:id:
+          auth:id: id
+          cache:control: no-cache
+          GET:
+            dev:stub: Keep it
+      """
+    When the following request is received:
+      """
+      GET /efe3a65ebbee47ed95a73edd911ea328/ HTTP/1.1
+      host: nex.toa.io
+      authorization: Basic ZGV2ZWxvcGVyOnNlY3JldA==
+      """
+    # no-store since the response contains the token
+    Then the following reply is sent:
+      """
+      200 OK
+      authorization: Token ${{ token }}
+      cache-control: no-store
+      """
+    When the following request is received:
+      """
+      GET /efe3a65ebbee47ed95a73edd911ea328/ HTTP/1.1
+      host: nex.toa.io
+      authorization: Token ${{ token }}
+      """
+    # private is added since the response is authenticated
+    Then the following reply is sent:
+      """
+      200 OK
+      cache-control: private, no-cache
+      """

package/features/cors.feature

@@ -1,6 +1,7 @@
+@security
 Feature: CORS Support
 
-  Scenario: Using CORS
+  Scenario: Basic CORS permissions
     Given the annotation:
       """yaml
       /:
@@ -12,33 +13,55 @@ Feature: CORS Support
     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-origin: https://hello.world
-      access-control-allow-methods: GET, POST, PUT, PATCH, DELETE
-      access-control-allow-headers: accept, authorization, content-type
+      access-control-allow-methods: GET, POST, PUT, PATCH, DELETE, LOCK, UNLOCK
+      access-control-allow-headers: accept, authorization, content-type, if-match, if-none-match
       access-control-allow-credentials: true
       access-control-max-age: 3600
-      cache-control: public, max-age=3600
+      cache-control: max-age=3600
       vary: origin
       """
     When the following request is received:
       """
       GET /foo/ HTTP/1.1
+      host: nex.toa.io
       origin: https://hello.world
       """
     Then the following reply is sent:
       """
       200 OK
       access-control-allow-origin: https://hello.world
-      access-control-expose-headers: authorization, content-type, content-length, etag
+      access-control-allow-credentials: true
+      access-control-expose-headers: authorization, content-type, content-length, date, etag, last-modified
+      vary: origin
+      """
+
+  Scenario: Always vary CORS
+    Given the annotation:
+      """yaml
+      /:
+        anonymous: true
+        GET:
+          dev:stub: hello
+      """
+    When the following request is received:
+      """
+      GET / HTTP/1.1
+      host: nex.toa.io
+      """
+    Then the following reply is sent:
+      """
+      200 OK
       vary: origin
       """
 
-  Scenario: Errors contain CORS headers
+  Scenario: Errors have CORS headers
     Given the annotation:
       """yaml
       /:
@@ -49,24 +72,26 @@ Feature: CORS Support
     When the following request is received:
       """
       GET /bar/ HTTP/1.1
+      host: nex.toa.io
       origin: https://hello.world
       """
     Then the following reply is sent:
       """
       404 Not Found
       access-control-allow-origin: https://hello.world
-      access-control-expose-headers: authorization, content-type, content-length, etag
+      access-control-expose-headers: authorization, content-type, content-length, date, etag, last-modified
       vary: origin
       """
     When the following request is received:
       """
       GET /foo/ HTTP/1.1
+      host: nex.toa.io
       origin: https://hello.world
       """
     Then the following reply is sent:
       """
       401 Unauthorized
       access-control-allow-origin: https://hello.world
-      access-control-expose-headers: authorization, content-type, content-length, etag
+      access-control-expose-headers: authorization, content-type, content-length, date, etag, last-modified
       vary: origin
       """

package/features/debug.feature

@@ -0,0 +1,34 @@
+Feature: Debugging
+
+  Scenario: Operation call
+    Given the `identity.basic` database contains:
+      | _id                              | authority | username  | password                                                     |
+      | efe3a65ebbee47ed95a73edd911ea328 | nex       | developer | $2b$10$ZRSKkgZoGnrcTNA5w5eCcu3pxDzdTduhteVYXcp56AaNcilNkwJ.O |
+    And the `identity.roles` database contains:
+      | _id                              | identity                         | role      |
+      | 775a648d054e4ce1a65f8f17e5b51803 | efe3a65ebbee47ed95a73edd911ea328 | developer |
+    And the annotation:
+      """yaml
+      debug: true
+      """
+    And the `greeter` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          auth:role: developer
+          io:output: true
+          GET: greet
+      """
+    When the following request is received:
+      """
+      GET /greeter/ HTTP/1.1
+      host: nex.toa.io
+      authorization: Basic ZGV2ZWxvcGVyOnNlY3JldA==
+      accept: text/plain
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      Hello
+      """

package/features/dev.feature

@@ -0,0 +1,87 @@
+Feature: Dev
+
+  Scenario: Delays
+    Given the annotation:
+      """yaml
+      /:
+        io:output: true
+        anonymous: true
+        dev:sleep: 3000
+        GET:
+          dev:stub: hello
+        /nested:
+          GET:
+            dev:stub: world
+      """
+    # CORS permission
+    When the following request is received:
+      """
+      OPTIONS / HTTP/1.1
+      origin: http://example.com
+      """
+    Then the following reply is sent:
+      """
+      204 No Content
+      access-control-allow-headers: accept, authorization, content-type, if-match, if-none-match, sleep
+      """
+    When the following request is received:
+      """
+      GET / HTTP/1.1
+      sleep: [1000, 2000]
+      """
+    # check the response time
+    Then the following reply is sent:
+      """
+      200 OK
+      """
+    When the following request is received:
+      """
+      GET /nested/ HTTP/1.1
+      sleep: [100, 300]
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      """
+    When the following request is received:
+      """
+      GET / HTTP/1.1
+      sleep: [1000, 3500]
+      """
+    Then the following reply is sent:
+      """
+      400 Bad Request
+
+      "Invalid sleep duration"
+      """
+
+  Scenario: Faulty mode
+    Given the annotation:
+      """yaml
+      /:
+        io:output: true
+        anonymous: true
+        dev:faulty: 1
+        GET:
+          dev:stub: hello
+      """
+    # CORS permission
+    When the following request is received:
+      """
+      OPTIONS / HTTP/1.1
+      origin: http://example.com
+      """
+    Then the following reply is sent:
+      """
+      204 No Content
+      access-control-allow-headers: accept, authorization, content-type, if-match, if-none-match, faulty
+      """
+    When the following request is received:
+      """
+      GET / HTTP/1.1
+      faulty: 1
+      """
+    Then the following reply is sent:
+      """
+      503 Service Unavailable
+      """

package/features/directives.feature

@@ -4,6 +4,7 @@ Feature: Directives
     Given the annotation:
       """yaml
       /:
+        io:output: true
         anonymous: true
         GET:
           dev:stub:
@@ -12,6 +13,7 @@ Feature: Directives
     When the following request is received:
       """
       GET / HTTP/1.1
+      host: nex.toa.io
       accept: application/json
       """
     Then the following reply is sent:
@@ -26,6 +28,7 @@ Feature: Directives
     Given the annotation:
       """yaml
       /:
+        io:output: true
         anonymous: true
         dev:stub:
           hello: again
@@ -36,6 +39,7 @@ Feature: Directives
     When the following request is received:
       """
       GET /pots/ HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
@@ -48,6 +52,7 @@ Feature: Directives
     When the following request is received:
       """
       GET /pots/non-existent/ HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:

package/features/dynamic.feature

@@ -9,14 +9,17 @@ Feature: Dynamic tree updates
     Given the Gateway is running
     And the `pots` is running with the following manifest:
       """yaml
+      version: 1
       exposition:
         /:
+          io:output: true
           isolated: true
           GET: enumerate
       """
     When the following request is received:
       """
       GET /pots/ HTTP/1.1
+      host: nex.toa.io
       """
     Then the following reply is sent:
       """
@@ -25,13 +28,54 @@ Feature: Dynamic tree updates
     Then the `pots` is stopped
     Then the `pots` is running with the following manifest:
       """yaml
+      version: 2
       exposition:
         /:
+          io:output: true
           GET: enumerate
       """
     When the following request is received:
       """
       GET /pots/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      """
+
+  Scenario: Repeat routes
+    Given the Gateway is running
+    And the `pots` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          GET: enumerate
+      """
+    When the following request is received:
+      """
+      GET /pots/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      """
+    Then the `pots` is stopped
+    And the `pots` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          GET: enumerate
+      """
+    When the following request is received:
+      """
+      GET /pots/ HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
@@ -42,25 +86,31 @@ Feature: Dynamic tree updates
   Scenario: Updating routes with conflict
     And the `pots` is running with the following manifest:
       """yaml
+      version: 1.0.0
       exposition:
         /:id:
+          io:output: true
           GET: observe
       """
     Then the `pots` is stopped
     Then the `pots` is running with the following manifest:
       """yaml
+      version: 1.1.0
       exposition:
-        /:id:
-          GET: observe
-        /big:
-          GET:
-            endpoint: enumerate
-            query:
-              criteria: volume>200
+        /:
+          io:output: true
+          /:id:
+            GET: observe
+          /big:
+            GET:
+              endpoint: enumerate
+              query:
+                criteria: volume>200
       """
     When the following request is received:
       """
       GET /pots/big/ HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
@@ -71,8 +121,10 @@ Feature: Dynamic tree updates
   Scenario: Updating method mapping
     Given the `pots` is running with the following manifest:
       """yaml
+      version: a
       exposition:
         /big:
+          io:output: true
           GET:
             endpoint: enumerate
             query:
@@ -81,8 +133,10 @@ Feature: Dynamic tree updates
     Then the `pots` is stopped
     Then the `pots` is running with the following manifest:
       """yaml
+      version: b
       exposition:
         /big:
+          io:output: true
           GET:
             endpoint: enumerate
             query:
@@ -91,6 +145,7 @@ Feature: Dynamic tree updates
     When the following request is received:
       """
       GET /pots/big/?criteria=temperature>50 HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent: