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

package/features/introspection.feature

@@ -0,0 +1,146 @@
+Feature: Introspection
+
+  Scenario: Resource introspection
+    Given the `pots` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          GET: enumerate
+          POST: create
+      """
+    When the following request is received:
+      """
+      OPTIONS /pots/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      Allow: GET, POST
+
+      GET:
+        output:
+          type: array
+          items:
+            properties:
+              id:
+                type: string
+                pattern: ^[a-fA-F0-9]{32}$
+              title:
+                type: string
+                maxLength: 64
+              volume:
+                type: number
+                exclusiveMinimum: 0
+                maximum: 1000
+              temperature:
+                type: number
+                exclusiveMinimum: 0
+                maximum: 300
+            type: object
+            required:
+              - id
+              - title
+              - volume
+      POST:
+        input:
+          properties:
+            temperature:
+              type: number
+              exclusiveMinimum: 0
+              maximum: 300
+            title:
+              type: string
+              maxLength: 64
+            volume:
+              type: number
+              exclusiveMinimum: 0
+              maximum: 1000
+          type: object
+          required:
+            - title
+            - volume
+        output: {}
+        errors:
+          - NO_WAY
+          - WONT_CREATE
+      """
+
+  Scenario: Introspection with route parameters
+    Given the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /:a:
+          io:output: true
+          PATCH: parameters
+      """
+    When the following request is received:
+      """
+      OPTIONS /echo/:a/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      Allow: PATCH
+
+      PATCH:
+        route:
+          a:
+            type: string
+        input:
+          type: object
+          properties:
+            b:
+              type: string
+        output:
+          type: object
+          properties:
+            a:
+              type: string
+            b:
+              type: string
+      """
+
+  Scenario: Introspection with query parameters
+    Given the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          PATCH:
+            query:
+              parameters: [a]
+            endpoint: parameters
+      """
+    When the following request is received:
+      """
+      OPTIONS /echo/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      Allow: PATCH
+
+      PATCH:
+        query:
+          a:
+            type: string
+        input:
+          type: object
+          properties:
+            b:
+              type: string
+        output:
+          type: object
+          properties:
+            a:
+              type: string
+            b:
+              type: string
+      """

package/features/introspection.map.feature

@@ -0,0 +1,108 @@
+@security
+Feature: Reading the introspection map
+
+  The map declares how it is exposed in its own manifests, and those manifests are what
+  this mounts — not a copy of them. A route the gateway cannot answer, or an answer it
+  drops for want of a directive, is caught here rather than in a running application.
+
+  Background:
+    # developer:secret, user:12345
+    Given the `identity.basic` database contains:
+      | _id                              | authority | username  | password                                                     |
+      | efe3a65ebbee47ed95a73edd911ea328 | nex       | developer | $2b$10$ZRSKkgZoGnrcTNA5w5eCcu3pxDzdTduhteVYXcp56AaNcilNkwJ.O |
+      | e8e4f9c2a68d419b861403d71fabc915 | nex       | user      | $2b$10$Frszmrmsz9iwSXzBbRRMKeDVKsNxozkrLNSsN.SnVC.KPxLtQr/bK |
+    And the `identity.roles` database contains:
+      | _id                              | identity                         | role                 |
+      | 3e2b0c8a1f7d4e9ab0c6d5e4f3a2b1c0 | efe3a65ebbee47ed95a73edd911ea328 | system:introspection |
+    And the `identity.bans` database is empty
+    And the annotation of the introspection map
+    And the introspection components are running
+
+  Scenario: Reading the nodes
+    Given the `introspection.nodes` database contains:
+      | _id                              | namespace | component | version  | _version | _deleted |
+      | 70e1a6551346c6932657cdb2526df0fa | pots      | tea       | 7bb04bba | 1        | null     |
+    When the following request is received:
+      """
+      GET /introspection/nodes/ HTTP/1.1
+      host: nex.toa.io
+      authorization: Basic ZGV2ZWxvcGVyOnNlY3JldA==
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/yaml
+
+      - id: 70e1a6551346c6932657cdb2526df0fa
+        namespace: pots
+        component: tea
+        version: 7bb04bba
+      """
+
+  Scenario: Reading one node
+    Given the `introspection.nodes` database contains:
+      | _id                              | namespace | component | version  | _version | _deleted |
+      | 70e1a6551346c6932657cdb2526df0fa | pots      | tea       | 7bb04bba | 1        | null     |
+    When the following request is received:
+      """
+      GET /introspection/nodes/70e1a6551346c6932657cdb2526df0fa/ HTTP/1.1
+      host: nex.toa.io
+      authorization: Basic ZGV2ZWxvcGVyOnNlY3JldA==
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/yaml
+
+      namespace: pots
+      component: tea
+      """
+
+  Scenario: Reading the edges
+    An empty map is still a body — the directive that would drop it is the point.
+
+    Given the `introspection.edges` database is empty
+    When the following request is received:
+      """
+      GET /introspection/edges/ HTTP/1.1
+      host: nex.toa.io
+      authorization: Basic ZGV2ZWxvcGVyOnNlY3JldA==
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/yaml
+
+      []
+      """
+
+  Scenario: The map is not readable without the role
+    When the following request is received:
+      """
+      GET /introspection/nodes/ HTTP/1.1
+      host: nex.toa.io
+      authorization: Basic dXNlcjoxMjM0NQ==
+      """
+    Then the following reply is sent:
+      """
+      403 Forbidden
+      """
+
+  Scenario: The map does not take the application's root directives
+    Given the annotation of the introspection map under:
+      """yaml
+      /:
+        auth:anonymous: true
+      """
+    When the following request is received:
+      """
+      GET /introspection/nodes/ HTTP/1.1
+      host: nex.toa.io
+      """
+    Then the following reply is sent:
+      """
+      401 Unauthorized
+      """

package/features/io.feature

@@ -50,7 +50,6 @@ Feature: IO restrictions
       """
       GET /pots/4c4759e6f9c74da989d64511df42d6f4/ HTTP/1.1
       host: nex.toa.io
-      accept: application/yaml
       """
     Then the following reply is sent:
       """

package/features/io.throttle.feature

@@ -0,0 +1,165 @@
+Feature: Request throttling
+
+  Scenario: Throttle requests to a path
+    Given the `echo.beacon` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:throttle:
+            key: [path]
+            requests: 1
+            interval: 1
+          GET:
+            endpoint: hello
+      """
+    When the following request is received:
+      """
+      GET /echo/beacon/ HTTP/1.1
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      """
+    When the following request is received:
+      """
+      GET /echo/beacon/ HTTP/1.1
+      """
+    # an emission is a second, which is what the budget takes to earn one back
+    Then the following reply is sent:
+      """
+      429 Too Many Requests
+      retry-after: 1
+      """
+    Then after 2 seconds
+    When the following request is received:
+      """
+      GET /echo/beacon/ HTTP/1.1
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      """
+
+  Scenario: Throttle requests to a route, whichever path they came in on
+    Given the `echo.beacon` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          /:id:
+            io:throttle:
+              key: [route]
+              requests: 1
+              interval: 5
+            GET:
+              dev:stub:
+                hello: true
+      """
+    When the following request is received:
+      """
+      GET /echo/beacon/1/ HTTP/1.1
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      """
+    # a different path of the same route, and the budget is already spent —
+    # keyed on `path` this would be 200
+    When the following request is received:
+      """
+      GET /echo/beacon/2/ HTTP/1.1
+      """
+    Then the following reply is sent:
+      """
+      429 Too Many Requests
+      """
+
+  Scenario: Throttle requests per route segment
+    Given the `echo.beacon` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          /:id:
+            io:throttle:
+              key:
+                - segment: id
+              requests: 1
+              interval: 5
+            GET:
+              dev:stub:
+                hello: true
+      """
+    When the following request is received:
+      """
+      GET /echo/beacon/1/ HTTP/1.1
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      """
+    When the following request is received:
+      """
+      GET /echo/beacon/1/ HTTP/1.1
+      """
+    Then the following reply is sent:
+      """
+      429 Too Many Requests
+      """
+    # another segment value, another budget
+    When the following request is received:
+      """
+      GET /echo/beacon/2/ HTTP/1.1
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      """
+
+  Scenario: Throttle requests per identity
+    Given the `echo.beacon` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          auth:anyone: true
+          GET:
+            # declared after `auth:` on the node, and mandatory families run in
+            # their own order regardless: `auth` has to resolve the identity
+            # before `io` can key a quota on it
+            io:throttle:
+              key: [identity]
+              requests: 1
+              interval: 5
+            endpoint: hello
+      """
+    And transient identity alice
+    And transient identity bob
+    When the following request is received:
+      """
+      GET /echo/beacon/ HTTP/1.1
+      host: nex.toa.io
+      authorization: Token ${{ alice.token }}
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      """
+    When the following request is received:
+      """
+      GET /echo/beacon/ HTTP/1.1
+      host: nex.toa.io
+      authorization: Token ${{ alice.token }}
+      """
+    Then the following reply is sent:
+      """
+      429 Too Many Requests
+      """
+    # bob's own budget, which requires auth to have resolved him before io keyed on him
+    When the following request is received:
+      """
+      GET /echo/beacon/ HTTP/1.1
+      host: nex.toa.io
+      authorization: Token ${{ bob.token }}
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      """