github.com/hellofresh/janus@v0.0.0-20230925145208-ce8de8183c67/features/API.feature

Feature: Manage proxies wit API.
    As an authenticated admin user, I need to be able to manage proxies list.

    Scenario: API list must not be available w/out valid JWT token
        Given request JWT token is not set
        When I request "/apis" API path with "GET" method
        Then I should receive 401 response code

        Given request header "Authorization" is set to "Basic YWRtaW46YWRtaW4="
        When I request "/apis" API path with "GET" method
        Then I should receive 401 response code

        Given request header "Authorization" is set to "Bearer InvalidJWT"
        When I request "/apis" API path with "GET" method
        Then I should receive 401 response code

    Scenario: API list must return empty list when no endpoints set
        Given request JWT token is valid admin token
        When I request "/apis" API path with "GET" method
        Then I should receive 200 response code
        And response JSON body is an array of length 0

    Scenario: API should be created with defaults
        Given request JWT token is valid admin token
        And request JSON payload:
            """
            {
              "name":"example",
              "proxy":{
                "listen_path":"/example/*",
                "upstreams":{
                  "balancing":"roundrobin",
                  "targets":[
                    {
                      "target":"http://localhost:9089/hello-world"
                    }
                  ]
                }
              }
            }
            """
        When I request "/apis" API path with "POST" method
        Then I should receive 201 response code
        And header "Location" should be "/apis/example"

        When I request "/apis" API path with "GET" method
        Then I should receive 200 response code
        And response JSON body is an array of length 1
        And response JSON body has "0.active" path with value 'true'
        And response JSON body has "0.proxy.methods" path and is an array of length 1

    Scenario: APIs list and create must be available for user with correct admin token
        Given request JWT token is valid admin token
        When I request "/apis" API path with "GET" method
        Then I should receive 200 response code
        And response JSON body is an array of length 0

        Given request JSON payload:
            """
            {
              "name":"example",
              "active":true,
              "proxy":{
                "preserve_host":false,
                "listen_path":"/example/*",
                "upstreams":{
                  "balancing":"roundrobin",
                  "targets":[
                    {
                      "target":"http://localhost:9089/hello-world"
                    }
                  ]
                },
                "strip_path":false,
                "append_path":false,
                "methods":[
                  "GET"
                ]
              },
              "health_check":{
                "url":"https://example.com/status"
              }
            }
            """
        When I request "/apis" API path with "POST" method
        Then I should receive 201 response code
        And header "Location" should be "/apis/example"

        When I request "/apis" API path with "GET" method
        Then I should receive 200 response code
        And response JSON body is an array of length 1
        And response JSON body has "0.name" path with value 'example'
        And response JSON body has "0.active" path with value 'true'

        Given request JSON payload:
            """
            {
                "name":"posts",
                "active":true,
                "proxy":{
                    "preserve_host":false,
                    "listen_path":"/posts/*",
                    "upstreams":{
                        "balancing":"roundrobin",
                        "targets":[
                            {
                                "target":"http://localhost:9089/posts"
                            }
                        ]
                    },
                    "strip_path":true,
                    "append_path":false,
                    "methods":[
                        "ALL"
                    ],
                    "hosts":[
                        "hellofresh.*"
                    ]
                },
                "plugins":[
                    {
                        "name":"cors",
                        "enabled":true,
                        "config":{
                            "domains":[
                                "*"
                            ],
                            "methods":[
                                "GET",
                                "POST",
                                "PUT",
                                "PATCH",
                                "DELETE"
                            ],
                            "request_headers":[
                                "Origin",
                                "Authorization",
                                "Content-Type"
                            ],
                            "exposed_headers":[
                                "X-Debug-Token",
                                "X-Debug-Token-Link"
                            ]
                        }
                    },
                    {
                        "name":"rate_limit",
                        "enabled":true,
                        "config":{
                            "limit":"10-S",
                            "policy":"local"
                        }
                    },
                    {
                        "name":"oauth2",
                        "enabled":true,
                        "config":{
                            "server_name":"local"
                        }
                    },
                    {
                        "name":"compression",
                        "enabled":true
                    }
                ]
            }
            """
        When I request "/apis" API path with "POST" method
        Then I should receive 201 response code
        And header "Location" should be "/apis/posts"

        When I request "/apis" API path with "GET" method
        Then I should receive 200 response code
        And response JSON body is an array of length 2

    Scenario: API fails to create routes with invalid fields
        Given request JWT token is valid admin token
        And request JSON payload:
            """
            {
                "active":true,
                "proxy":{
                    "listen_path":"/example/*",
                    "upstreams":{
                        "balancing":"roundrobin",
                        "targets":[
                            {
                                "target":"http://localhost:9089/hello-world"
                            }
                        ]
                    }
                }
            }
            """
        When I request "/apis" API path with "POST" method
        Then I should receive 400 response code
        And the response should contain "name is required"

        Given request JWT token is valid admin token
        And request JSON payload:
            """
            {
                "name": "example",
                "active":true,
                "proxy":{
                    "upstreams":{
                        "balancing":"roundrobin",
                        "targets":[
                            {
                                "target":"http://localhost:9089/hello-world"
                            }
                        ]
                    }
                }
            }
            """
        When I request "/apis" API path with "POST" method
        Then I should receive 400 response code
        And the response should contain "proxy.listen_path is required"

    Scenario: API fails to create routes with the same name
        Given request JWT token is valid admin token
        And request JSON payload:
            """
            {
                "name":"example",
                "active":true,
                "proxy":{
                    "preserve_host":false,
                    "listen_path":"/example/*",
                    "upstreams":{
                        "balancing":"roundrobin",
                        "targets":[
                            {
                                "target":"http://localhost:9089/hello-world"
                            }
                        ]
                    },
                    "strip_path":false,
                    "append_path":false,
                    "methods":[
                        "GET"
                    ]
                },
                "health_check":{
                    "url":"https://example.com/status"
                }
            }
            """
        When I request "/apis" API path with "POST" method
        Then I should receive 201 response code
        And header "Location" should be "/apis/example"

        Given request JSON payload:
            """
            {
                "name":"example",
                "active":true,
                "proxy":{
                    "preserve_host":false,
                    "listen_path":"/example/*",
                    "upstreams":{
                        "balancing":"roundrobin",
                        "targets":[
                            {
                                "target":"http://localhost:9089/hello-world"
                            }
                        ]
                    },
                    "strip_path":false,
                    "append_path":false,
                    "methods":[
                        "GET"
                    ]
                },
                "health_check":{
                    "url":"https://example.com/status"
                }
            }
            """
        When I request "/apis" API path with "POST" method
        Then I should receive 409 response code
        And the response should contain "api name is already registered"

        Given request JSON payload:
            """
            {
                "name":"example1",
                "active":true,
                "proxy":{
                    "preserve_host":false,
                    "listen_path":"/example/*",
                    "upstreams":{
                        "balancing":"roundrobin",
                        "targets":[
                            {
                                "target":"http://localhost:9089/hello-world"
                            }
                        ]
                    },
                    "strip_path":false,
                    "append_path":false,
                    "methods":[
                        "GET"
                    ]
                },
                "health_check":{
                    "url":"https://example.com/status"
                }
            }
            """
        When I request "/apis" API path with "POST" method
        Then I should receive 409 response code
        And the response should contain "api listen path is already registered"

    Scenario: API must return existing routes and response with error for non-existent
        Given request JWT token is valid admin token
        When I request "/apis/example" API path with "GET" method
        Then I should receive 404 response code

        Given request JSON payload:
            """
            {
                "name":"example",
                "active":true,
                "proxy":{
                    "preserve_host":false,
                    "listen_path":"/example/*",
                    "upstreams":{
                        "balancing":"roundrobin",
                        "targets":[
                            {
                                "target":"http://localhost:9089/hello-world"
                            }
                        ]
                    },
                    "strip_path":false,
                    "append_path":false,
                    "methods":[
                        "GET"
                    ]
                },
                "health_check":{
                    "url":"https://example.com/status"
                }
            }
            """
        When I request "/apis" API path with "POST" method
        Then I should receive 201 response code

        When I request "/apis/example" API path with "GET" method
        Then I should receive 200 response code
        And response JSON body has "name" path with value 'example'

        When I request "/apis/example" API path with "DELETE" method
        Then I should receive 204 response code

    Scenario: API must update existing routes with new path value
        Given request JWT token is valid admin token
        And request JSON payload:
            """
            {
                "name":"example",
                "active":true,
                "proxy":{
                    "preserve_host":false,
                    "listen_path":"/example/*",
                    "upstreams":{
                        "balancing":"roundrobin",
                        "targets":[
                            {
                                "target":"http://localhost:9089/hello-world"
                            }
                        ]
                    },
                    "strip_path":false,
                    "append_path":false,
                    "methods":[
                        "GET"
                    ]
                },
                "health_check":{
                    "url":"https://example.com/status"
                }
            }
            """
        When I request "/apis" API path with "POST" method
        Then I should receive 201 response code
        And header "Location" should be "/apis/example"

        When I request "/apis/example" API path with "GET" method
        Then I should receive 200 response code
        And response JSON body has "name" path with value 'example'
        And response JSON body has "proxy.listen_path" path with value '/example/*'

        Given request JSON payload:
            """
            {
                "name":"example",
                "active":true,
                "proxy":{
                    "preserve_host":false,
                    "listen_path":"/example1/*",
                    "upstreams":{
                        "balancing":"roundrobin",
                        "targets":[
                            {
                                "target":"http://localhost:9089/hello-world"
                            }
                        ]
                    },
                    "strip_path":false,
                    "append_path":false,
                    "methods":[
                        "GET"
                    ]
                },
                "health_check":{
                    "url":"https://example.com/status"
                }
            }
            """
        When I request "/apis/example" API path with "PUT" method
        Then I should receive 200 response code

        When I request "/apis/example" API path with "GET" method
        Then I should receive 200 response code
        And response JSON body has "name" path with value 'example'
        And response JSON body has "proxy.listen_path" path with value '/example1/*'

        When I request "/apis/foo-bar" API path with "GET" method
        Then I should receive 404 response code

    Scenario: API must update existing routes with new forwarding timeouts
        Given request JWT token is valid admin token
        And request JSON payload:
            """
            {
                "name":"example",
                "active":true,
                "proxy":{
                    "preserve_host":false,
                    "listen_path":"/example/*",
                    "upstreams":{
                        "balancing":"roundrobin",
                        "targets":[
                            {
                                "target":"http://localhost:9089/hello-world"
                            }
                        ]
                    },
                    "strip_path":false,
                    "append_path":false,
                    "methods":[
                        "GET"
                    ],
                    "forwarding_timeouts": {
                        "dial_timeout": "5s",
                        "response_header_timeout": "7s"
                    }
                },
                "health_check":{
                    "url":"https://example.com/status"
                }
            }
            """
        When I request "/apis" API path with "POST" method
        Then I should receive 201 response code
        And header "Location" should be "/apis/example"

        When I request "/apis/example" API path with "GET" method
        Then I should receive 200 response code
        And response JSON body has "proxy.forwarding_timeouts.dial_timeout" path with value '5s'
        And response JSON body has "proxy.forwarding_timeouts.response_header_timeout" path with value '7s'

        Given request JSON payload:
            """
            {
                "name":"example",
                "active":true,
                "proxy":{
                    "preserve_host":false,
                    "listen_path":"/example/*",
                    "upstreams":{
                        "balancing":"roundrobin",
                        "targets":[
                            {
                                "target":"http://localhost:9089/hello-world"
                            }
                        ]
                    },
                    "strip_path":false,
                    "append_path":false,
                    "methods":[
                        "GET"
                    ],
                    "forwarding_timeouts": {
                        "dial_timeout": "15s",
                        "response_header_timeout": "17s"
                    }
                },
                "health_check":{
                    "url":"https://example.com/status"
                }
            }
            """
        When I request "/apis/example" API path with "PUT" method
        Then I should receive 200 response code

        When I request "/apis/example" API path with "GET" method
        Then I should receive 200 response code
        And response JSON body has "proxy.forwarding_timeouts.dial_timeout" path with value '15s'
        And response JSON body has "proxy.forwarding_timeouts.response_header_timeout" path with value '17s'

    Scenario: API must delete existing routes
        Given request JWT token is valid admin token
        And request JSON payload:
            """
            {
                "name":"example",
                "active":true,
                "proxy":{
                    "preserve_host":false,
                    "listen_path":"/example/*",
                    "upstreams":{
                        "balancing":"roundrobin",
                        "targets":[
                            {
                                "target":"http://localhost:9089/hello-world"
                            }
                        ]
                    },
                    "strip_path":false,
                    "append_path":false,
                    "methods":[
                        "GET"
                    ]
                },
                "health_check":{
                    "url":"https://example.com/status"
                }
            }
            """
        When I request "/apis" API path with "POST" method
        Then I should receive 201 response code
        And header "Location" should be "/apis/example"

        Given request JSON payload:
            """
            {
                  "name":"posts",
                  "active":true,
                  "proxy":{
                    "preserve_host":false,
                    "listen_path":"/posts/*",
                    "upstreams":{
                      "balancing":"roundrobin",
                      "targets":[
                        {
                          "target":"http://localhost:9089/posts"
                        }
                      ]
                    },
                    "strip_path":true,
                    "append_path":false,
                    "methods":[
                      "ALL"
                    ],
                    "hosts":[
                      "hellofresh.*"
                    ]
                  },
                  "plugins":[
                    {
                      "name":"cors",
                      "enabled":true,
                      "config":{
                        "domains":[
                          "*"
                        ],
                        "methods":[
                          "GET",
                          "POST",
                          "PUT",
                          "PATCH",
                          "DELETE"
                        ],
                        "request_headers":[
                          "Origin",
                          "Authorization",
                          "Content-Type"
                        ],
                        "exposed_headers":[
                          "X-Debug-Token",
                          "X-Debug-Token-Link"
                        ]
                      }
                    },
                    {
                      "name":"rate_limit",
                      "enabled":true,
                      "config":{
                        "limit":"10-S",
                        "policy":"local"
                      }
                    },
                    {
                      "name":"oauth2",
                      "enabled":true,
                      "config":{
                        "server_name":"local"
                      }
                    },
                    {
                      "name":"compression",
                      "enabled":true
                    }
                ]
            }
            """
        When I request "/apis" API path with "POST" method
        Then I should receive 201 response code
        And header "Location" should be "/apis/posts"

        When I request "/apis" API path with "GET" method
        Then I should receive 200 response code
        And response JSON body is an array of length 2

        When I request "/apis/example" API path with "DELETE" method
        Then I should receive 204 response code

        When I request "/apis" API path with "GET" method
        Then I should receive 200 response code
        And response JSON body is an array of length 1

        When I request "/apis/example" API path with "DELETE" method
        Then I should receive 404 response code

        When I request "/apis/posts" API path with "DELETE" method
        Then I should receive 204 response code

        When I request "/apis" API path with "GET" method
        Then I should receive 200 response code
        And response JSON body is an array of length 0

        When I request "/apis/posts" API path with "DELETE" method
        Then I should receive 404 response code

    Scenario: API fails to create oauth servers with the same name
        Given request JWT token is valid admin token
        And request JSON payload:
            """
            {
                "name" : "oauth-server-test",
                "oauth_endpoints" : {
                    "authorize" : {
                        "listen_path" : "/auth/github/authorize",
                        "methods" : [
                            "ALL"
                        ],
                        "preserve_host" : false,
                        "strip_path" : false,
                        "upstreams":{
                            "balancing":"roundrobin",
                            "targets":[
                                {
                                "target":"https://github.com/login/oauth/authorize"
                                }
                            ]
                        }
                    },
                    "token" : {
                        "listen_path" : "/auth/github/token",
                        "methods" : [
                            "GET",
                            "POST"
                        ],
                        "preserve_host" : false,
                        "strip_path" : false,
                        "upstreams":{
                            "balancing":"roundrobin",
                            "targets":[
                                {
                                "target":"https://github.com/login/oauth/access_token"
                                }
                            ]
                        }
                    },
                    "introspect" : {
                        "listen_path" : "/auth/github/introspect",
                        "methods" : [
                            "GET"
                        ],
                        "preserve_host" : false,
                        "strip_path" : false,
                        "upstreams":{
                            "balancing":"roundrobin",
                            "targets":[
                                {
                                "target":"https://api.github.com/user"
                                }
                            ]
                        }
                    }
                },
                "secrets" : {
                    "admin" : "admin"
                },
                "cors_meta" : {
                    "domains" : [
                        "*"
                    ],
                    "methods" : [
                        "GET",
                        "POST",
                        "PUT",
                        "PATCH",
                        "DELETE"
                    ],
                    "request_headers" : [
                        "Origin",
                        "Authorization",
                        "Content-Type"
                    ],
                    "exposed_headers" : [
                        "X-Debug-Token",
                        "X-Debug-Token-Link"
                    ],
                    "enabled" : true
                },
                "rate_limit" : {
                    "limit" : "200-S"
                },
                "token_strategy" : {
                    "name" : "introspection",
                    "settings" : {
                        "use_auth_header" : true,
                        "auth_header_type" : "token"
                    }
                }
            }
            """
        When I request "/oauth/servers" API path with "POST" method
        Then I should receive 201 response code

        Given request JSON payload:
            """
            {
                "name" : "oauth-server-test",
                "oauth_endpoints" : {
                    "authorize" : {
                        "listen_path" : "/auth/github/authorize",
                        "methods" : [
                            "ALL"
                        ],
                        "preserve_host" : false,
                        "strip_path" : false,
                        "upstreams":{
                            "balancing":"roundrobin",
                            "targets":[
                                {
                                "target":"https://github.com/login/oauth/authorize"
                                }
                            ]
                        }
                    },
                    "token" : {
                        "listen_path" : "/auth/github/token",
                        "methods" : [
                            "GET",
                            "POST"
                        ],
                        "preserve_host" : false,
                        "strip_path" : false,
                        "upstreams":{
                            "balancing":"roundrobin",
                            "targets":[
                                {
                                "target":"https://github.com/login/oauth/access_token"
                                }
                            ]
                        }
                    },
                    "introspect" : {
                        "listen_path" : "/auth/github/introspect",
                        "methods" : [
                            "GET"
                        ],
                        "preserve_host" : false,
                        "strip_path" : false,
                        "upstreams":{
                            "balancing":"roundrobin",
                            "targets":[
                                {
                                "target":"https://api.github.com/user"
                                }
                            ]
                        }
                    }
                },
                "secrets" : {
                    "admin" : "admin"
                },
                "cors_meta" : {
                    "domains" : [
                        "*"
                    ],
                    "methods" : [
                        "GET",
                        "POST",
                        "PUT",
                        "PATCH",
                        "DELETE"
                    ],
                    "request_headers" : [
                        "Origin",
                        "Authorization",
                        "Content-Type"
                    ],
                    "exposed_headers" : [
                        "X-Debug-Token",
                        "X-Debug-Token-Link"
                    ],
                    "enabled" : true
                },
                "rate_limit" : {
                    "limit" : "200-S"
                },
                "token_strategy" : {
                    "name" : "introspection",
                    "settings" : {
                        "use_auth_header" : true,
                        "auth_header_type" : "token"
                    }
                }
            }
            """
        When I request "/oauth/servers" API path with "POST" method
        Then I should receive 409 response code
        And the response should contain "oauth server name is already registered"