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

package/features/io.feature

@@ -0,0 +1,204 @@
+@security
+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
+      host: nex.toa.io
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-length: 0
+      """
+    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
+      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
+      host: nex.toa.io
+      """
+    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
+      host: nex.toa.io
+      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
+      host: nex.toa.io
+      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
+      host: nex.toa.io
+      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]
+          io:output: [id]
+          POST: create
+      """
+    When the following request is received:
+      """
+      POST /pots/ HTTP/1.1
+      host: nex.toa.io
+      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
+      host: nex.toa.io
+      content-type: application/yaml
+
+      title: Hello
+      volume: 1.5
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      """
+
+  Scenario: IO shortcuts
+    Given the `pots` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          input: [title, volume]
+          output: [id, title, volume]
+          POST: create
+      """
+    When the following request is received:
+      """
+      POST /pots/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      content-type: application/yaml
+
+      title: Hello
+      volume: 1.5
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+
+      id:
+      title: Hello
+      volume: 1.5
+      """

package/features/io.throttle.feature

@@ -0,0 +1,40 @@
+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
+            cooldown: 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
+      """
+    Then the following reply is sent:
+      """
+      429 Too Many Requests
+      """
+    Then after 1 second
+    When the following request is received:
+      """
+      GET /echo/beacon/ HTTP/1.1
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      """

package/features/map.feature

@@ -0,0 +1,328 @@
+Feature: HTTP context mapping
+
+  Scenario Outline: Mapping `<result>` language code
+    Given the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          map:languages: [en, fr]
+          GET:
+            map:language: name # map resolved language code to the `name` property of the operation input
+            endpoint: compute
+      """
+    When the following request is received:
+      """
+      GET /echo/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      accept-language: <accept>
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/yaml
+      content-language: <result>
+      vary: accept-language, accept
+
+      Hello <result>
+      """
+    Examples:
+      | accept | result |
+      | en     | en     |
+      | en_US  | en     |
+      | fr     | fr     |
+      | sw     | en     |
+
+  Scenario: Listing languages on the root
+    Given the annotation:
+    """
+    /:
+      languages: [en, fr]
+    """
+    And the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          GET:
+            anonymous: true
+            map:language: name
+            endpoint: compute
+      """
+    When the following request is received:
+      """
+      GET /echo/ HTTP/1.1
+      host: nex.toa.io
+      accept-language: fr
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-language: fr
+      """
+
+  Scenario: Headers used by mappings are added to CORS permissions
+    Given the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          map:languages: [en, fr]
+          GET:
+            map:language: name
+            map:headers:
+              name: foo
+            endpoint: compute
+      """
+    When the following request is received:
+      """
+      OPTIONS / HTTP/1.1
+      host: nex.toa.io
+      origin: https://example.com
+      """
+    Then the following reply is sent:
+      """
+      204 No Content
+      access-control-allow-headers: accept, authorization, content-type, etag, if-match, if-none-match, accept-language, foo
+      """
+
+  Scenario: Mapping the value of an arbitrary header
+    Given the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          GET:
+            map:headers:
+              name: foo
+            endpoint: compute
+      """
+    When the following request is received:
+      """
+      GET /echo/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      foo: bar
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/yaml
+      vary: foo, accept
+
+      Hello bar
+      """
+
+  Scenario: Mapping the `host` header value
+    Given the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          GET:
+            map:headers:
+              name: host
+            endpoint: compute
+      """
+    When the following request is received:
+      """
+      GET /echo/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      foo: bar
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/yaml
+      vary: accept
+
+      Hello nex.toa.io
+      """
+
+  Scenario: Mapping a route parameter
+    Given the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /:friend:
+          io:output: true
+          GET:
+            map:segments:
+              name: ~friend
+            endpoint: compute
+      """
+    When the following request is received:
+      """
+      GET /echo/Ken/ HTTP/1.1
+      host: nex.toa.io
+      accept: text/plain
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      Hello Ken
+      """
+
+  Scenario: Mapping wildcard route parameter
+    Given the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /foo/**:
+          io:output: true
+          GET:
+            map:segments:
+              name: '**'
+            endpoint: compute
+      """
+    When the following request is received:
+      """
+      GET /echo/foo/bar/baz/ HTTP/1.1
+      host: nex.toa.io
+      accept: text/plain
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      Hello bar/baz
+      """
+
+  Scenario: Mapping the authority
+    Given the annotation:
+      """yaml
+      authorities:
+        one: the.one.com
+      """
+    Given the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          GET:
+            io:output: true
+            map:authority: name
+            endpoint: compute
+      """
+    When the following request is received:
+      """
+      GET /echo/ HTTP/1.1
+      host: the.one.com
+      accept: text/plain
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      Hello one
+      """
+    When the following request is received:
+      """
+      GET /echo/ HTTP/1.1
+      host: the.two.com
+      accept: text/plain
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      Hello the.two.com
+      """
+
+  Scenario: Mapping OIDC token claims
+    Given local IDP is running
+    And the `identity.federation` configuration:
+      """yaml
+      trust:
+        - iss: http://localhost:44444
+      """
+    And the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          GET:
+            anyone: true
+            io:output: true
+            map:claims:
+              name: email
+            endpoint: compute
+      """
+    And the IDP token for Alice is issued
+
+    When the following request is received:
+      """
+      GET /echo/ HTTP/1.1
+      authorization: Bearer ${{ Alice.id_token }}
+      host: the.two.com
+      accept: text/plain
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      Hello Alice@test.local
+      """
+
+  Scenario: Mapping Bearer token claims during inception
+    Given local IDP is running
+    And the `identity.federation` configuration:
+      """yaml
+      trust:
+        - iss: http://localhost:44444
+      """
+    And the `pots` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          POST:
+            auth:incept: id
+            io:input: [title, volume]
+            io:output: [id, title, volume]
+            map:claims:
+              title: email
+            endpoint: create
+      """
+    And the IDP random token is issued
+
+    When the following request is received:
+      """
+      POST /pots/ HTTP/1.1
+      host: the.two.com
+      authorization: Bearer ${{ random.id_token }}
+      accept: application/yaml
+      content-type: application/yaml
+
+      volume: 1.5
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+
+      id: ${{ id }}
+      title: ${{ random.email }}
+      volume: 1.5
+      """
+
+  Scenario: Mapping non-exposed properties
+    Given the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          GET:
+            io:output: true
+            io:input: [] # disallow input
+            map:authority: name
+            endpoint: compute
+      """
+    When the following request is received:
+      """
+      GET /echo/ HTTP/1.1
+      host: the.one.com
+      accept: text/plain
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      Hello the.one.com
+      """

package/features/methods.feature

@@ -0,0 +1,47 @@
+Feature: Supported methods
+
+  Scenario Outline: <method> is supported
+    Given the annotation:
+      """yaml
+      /:
+        <method>:
+          dev:stub:
+            hello: world
+      """
+    And the `greeter` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          <method>:
+            dev:stub:
+              hello: world
+      """
+    Examples:
+      | method |
+      | GET    |
+      | POST   |
+      | PUT    |
+      | DELETE |
+      | PATCH  |
+      | LOCK   |
+      | UNLOCK |
+
+  Scenario: CORS allowed methods
+    Given the annotation:
+      """yaml
+      /:
+        GET:
+          dev:stub:
+            hello: world
+      """
+    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-methods: GET, POST, PUT, PATCH, DELETE, LOCK, UNLOCK
+      """