@toa.io/extensions.exposition 1.0.0-alpha.16 → 1.0.0-alpha.160

package/features/interruptions.feature

@@ -0,0 +1,19 @@
+Feature: Request interruptions
+
+  Scenario: Connection reset while processing a request
+    Given the annotation:
+      """yaml
+      /:
+        io:output: true
+        anonymous: true
+        dev:sleep: 3000
+        GET:
+          dev:stub: hello
+      """
+    When the following request is interrupted after 1 second:
+      """
+      GET / HTTP/1.1
+      sleep: 2000
+      """
+    Then after 2 seconds
+    And the process is running

package/features/introspection.feature

@@ -0,0 +1,153 @@
+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:
+        type: array
+        items:
+          type: object
+          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
+          additionalProperties: false
+          required:
+            - id
+            - title
+            - volume
+      POST:
+        input:
+          type: object
+          properties:
+            title:
+              type: string
+              maxLength: 64
+            temperature:
+              type: number
+              exclusiveMinimum: 0
+              maximum: 300
+            volume:
+              type: number
+              exclusiveMinimum: 0
+              maximum: 1000
+          additionalProperties: false
+          required:
+            - title
+            - volume
+        output:
+          type: object
+          properties:
+            id:
+              type: string
+              pattern: ^[a-fA-F0-9]{32}$
+          additionalProperties: false
+        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/io.feature

@@ -19,6 +19,7 @@ Feature: IO restrictions
     When the following request is received:
       """
       GET /pots/4c4759e6f9c74da989d64511df42d6f4/ HTTP/1.1
+      host: nex.toa.io
       """
     Then the following reply is sent:
       """
@@ -28,6 +29,7 @@ Feature: IO restrictions
     When the following request is received:
       """
       GET /pots/ HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
@@ -47,7 +49,7 @@ Feature: IO restrictions
     When the following request is received:
       """
       GET /pots/4c4759e6f9c74da989d64511df42d6f4/ HTTP/1.1
-      accept: application/yaml
+      host: nex.toa.io
       """
     Then the following reply is sent:
       """
@@ -68,6 +70,7 @@ Feature: IO restrictions
     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:
@@ -85,6 +88,7 @@ Feature: IO restrictions
     When the following request is received:
       """
       GET /pots/ HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
@@ -114,6 +118,7 @@ Feature: IO restrictions
     When the following request is received:
       """
       POST /pots/ HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       content-type: application/yaml
 
@@ -142,6 +147,7 @@ Feature: IO restrictions
     When the following request is received:
       """
       POST /pots/ HTTP/1.1
+      host: nex.toa.io
       accept: text/plain
       content-type: application/yaml
 
@@ -158,6 +164,7 @@ Feature: IO restrictions
     When the following request is received:
       """
       POST /pots/ HTTP/1.1
+      host: nex.toa.io
       content-type: application/yaml
 
       title: Hello
@@ -180,6 +187,7 @@ Feature: IO restrictions
     When the following request is received:
       """
       POST /pots/ HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       content-type: application/yaml
 

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
+      """