osb-checker-kotlin

Description
Usage
Test

Description

This application is a generalized test program for service brokers. It runs rest calls against the defined service broker and checks if it behaves as expected to the service broker API specification
Tests are created dynamically based upon the service broker catalog or custom input by the operator.

Build Application

to build the application run {path}/osb-checker-kotlin/gradlew build on linux and MacOS or {path}/osb-checker-kotlin/gradlew.bat build on windows. Afterwards you can find osb-checker-kotlin-1.0.jar in osb-checker-kotlin/build/libs.

Usage

Configuration

To run the application put a file with the name application.yml into the same location as the osb-checker-kotlin-1.0.jar file. For more information on how to configurate a spring boot application see here. The .yml file needs the following schema.

##Define the service broker connection here
config:
  url: http://localhost
  port : 80
  apiVersion: 2.13
  user: user
  password: password
##The following configuration are Optional
  usingAppGuid: true

  provisionParameters:
     plan-id-1-here:
        parameter1 : 1
        parameter2 : foo
      plan-id-2-here:
        parameter1 : 2
        parameter2 : bar

  bindingParameters:
      plan-id-here:
        key : value
        
  services:
    - id: service-id-here
      bindable: true
      plans:
        - id: plan-id-here

url, port, apiVersion, user and password are mandatory and MUST be set. usingAppGuid, parameters and services are optional.

usingAppGuid sets the osb-checker to set a appGuid during provisioning. If no value it set it falls back to default true.

Parameters

To set parameters for the provision, define them in parameters (Default is null). specify the plan id as key for the parameters example: a configuration with ...

provisionParameters:
    plan-id-here:
      DB-name: db-name
      parameter1 : 1
      parameter2 : foo
      key : value
      schemaName: a_name

would run a provisions like this:

curl http://username:password@broker-url/v2/service_instances/:instance_id?accepts_incomplete=true -d

{
  "service_id": "service-id-here",
  "plan_id": "plan-id-here",
  "organization_guid": "org-guid-here",
  "space_guid": "space-guid-here",
  "parameters": {
    "DB-name": "db-name",
    "parameter1" : 1,
    "parameter2" : "foo",
    "key" : "value",
    "schemaName": "a_name"
    
    }
}

-X PUT -H "X-Broker-API-Version: api-version-here" -H "Content-Type: application/json"

to declare parameters for a binding set them like this:

bindingParameters:
    plan-id-here:
      key : value
      schemaName: a_name

Declaring Services

To define a specific set of services and plans for testing define them under services like this:

     services:
       - id: service-id-here
         plans:
           - id: plan-id-here
           - id: plan-id2-here
             bindable: false
         bindable: true     
       - id: service-id2-here
         plans:
          - id: plan-id3-here
         bindable: false

this config would run the following provisions and bindings when running the binding test:

curl http://username:password@broker-url/v2/service_instances/:instance_id?accepts_incomplete=true -d

{
  "service_id": "service-id-here",
  "plan_id": "plan-id-here",
  "organization_guid": "org-guid-here",
  "space_guid": "space-guid-here"
}

-X PUT -H "X-Broker-API-Version: api-version-here" -H "Content-Type: application/json"

curl http://username:password@broker-url/v2/service_instances/:instance_id/service_bindings/:binding_id?accepts_incomplete=true -d

{
  "service_id": "service-id-here",
  "plan_id": "plan-id-here",
  "organization_guid": "org-guid-here",
  "space_guid": "space-guid-here"
}

-X PUT -H "X-Broker-API-Version: api-version-here" -H "Content-Type: application/json"

curl http://username:password@broker-url/v2/service_instances/:instance_id?accepts_incomplete=true -d

{
  "service_id": "service-id2-here",
  "plan_id": "plan-id-here",
  "organization_guid": "org-guid-here",
  "space_guid": "space-guid-here"
}

-X PUT -H "X-Broker-API-Version: api-version-here" -H "Content-Type: application/json"

curl http://username:password@broker-url/v2/service_instances/:instance_id?accepts_incomplete=true -d

{
  "service_id": "service-id2-here",
  "plan_id": "plan-id3-here",
  "organization_guid": "org-guid-here",
  "space_guid": "space-guid-here"
}

-X PUT -H "X-Broker-API-Version: api-version-here" -H "Content-Type: application/json"

If no catalog is set the checker will use the catalog the service broker provides by itself.

Declaring Test Runs

There are five different options to run tests. Possibles commands are:

catalog: -cat/-catalog
provision: -prov/-provision
binding: -bind/-binding
authentication: -auth/-authentication
contract: -con/-contract

In case you want to run all tests call for example java -jar osb-checker-kotlin-1.0.jar -cat -provision -bind -auth -con

Test

All Tests make a series of rest calls on the defined service and validate their behaviour afterwards. Some Tests need certain endpoints to work as defined in the osb specification. For example: The binding test can only run if the provisioning and catalog endpoint work. It is recommended to use the checker accordingly, to ease up debugging of the service broker.

Catalog

when starting the application with the parameter -cat/-catalog, it will:

call curl http://username:password@broker-url/v2/catalog -X PUT -H "X-Broker-API-Version: api-version-here" -H "Content-Type: application/json"
check if the service broker returns 200 and validate if the catalog from the response follows schema.

Look here, for more information about service broker catalogs.

Provision

Calls the catalog to set up a valid provision requests or uses a custom catalog, from the yml provided by the operator.
For each plan_id defined in the catalog the application will call: curl http://username:password@broker-url/v2/service_instances/:instance_id -d

{
  "service_id": "service-id-here",
  "plan_id": "plan-id-here",
  "organization_guid": "org-guid-here",
  "space_guid": "space-guid-here"
}

-X PUT -H "X-Broker-API-Version: api-version-here" -H "Content-Type: application/json"

validate that the service broker returns 201 in case of a sync service broker or 422 in case of a async service broker.
Now it calls curl http://username:password@broker-url/v2/service_instances/:instance_id?service_id=service-id-here&plan_id=plan-id-here -d DELETE -H "X-Broker-API-Version: api-version-here" -H "Content-Type: application/json" and validate if the service broker returns 200 in case of a sync service broker or 422 in case of a async service broker.
validates the broker returns 400 when being given faulty provision requests.
Note: This test can only run successfully if the Service Broker returns a valid catalog or a correct custom catalog has been set im the .yml file.

Look here (provisioning) and here (deprovisioning) for more information.

Binding

Valid binding attempts
- Calls the catalog to set up a valid provision requests or uses a custom catalog, from the yml provided by the operator.
- For each plan_id defined in the catalog the application will call: curl http://username:password@broker-url/v2/service_instances/:instance_id?accepts_incomplete=true -d
```
{
 "service_id": "service-id-here",
"plan_id": "plan-id-here",
"organization_guid": "org-guid-here",
"space_guid": "space-guid-here"
}
```
-X PUT -H "X-Broker-API-Version: api-version-here" -H "Content-Type: application/json" and validate if it returns 200 or 202 and that the response body matches the specification.
- in case of 202 the test continues polling by calling curl http://username:password@broker-url/v2/service_instances/:instance_id/last_operation" unit the service broker returns 200 and that the response body matches the specification. Note: Depending on the service broker this may take a while.
- If a provision has finished and the service is bindable the test continues with the 2 following calls:
  - curl http://username:password@broker-url/v2/service_instances/:instance_id/service_bindings/:binding_id -d '
```
{
"service_id": "service-id-here",
"plan_id": "plan-id-here",
"bind_resource": {
"app_guid": "app-guid-here"
   }
}
```
  ' -X PUT -H "X-Broker-API-Version: api-version-here" and validate if it returns 201 and that the response body matches the specification.
  - curl 'http://username:password@broker-url/v2/service_instances/:instance_id/service_bindings/:binding_id?service_id=service-id-here&plan_id=plan-id-here' -X DELETE -H "X-Broker-API-Version: api-version-here" and validate if the service broker returns 200.
- The provisioned service will now be deleted by calling curl 'http://username:password@broker-url/v2/service_instances/:instance_id?accepts_incomplete=true&service_id=service-id-here&plan_id=plan-id-here' -X DELETE -H "X-Broker-API-Version: api-version-here" The test checks if the response is 200 or 202.
- in case of 202 the test continues polling by calling curl http://username:password@broker-url/v2/service_instances/:instance_id/last_operation" unit the service broker returns 410. Note: Depending on the service broker this may take a while.
Invalid binding attempts
- This tests will only run if the service is bindable.
- calls the catalog and makes a runs a single provision
- runs invalid binding and unbinding attempts and validates of the service broker returns 400.

Look here for more information about binding and unbinding.

Authentication

runs a all requests without a user and password, a wrong username and a wrong password. It checks if service broker replies with HttpStatus 401 unauthorized.

Contract

runs all standard requests and checks if they fail with 412 Precondition Failed, if the X-Broker-API-Version header is missing or does not match the given one.

Example output

A Binding Test output with one deployed service.

╷
└─ JUnit Jupiter ✔
   └─ BindingJUnit5 ✔
      ├─ runInvalidBindingAttempts() ✔
      │  ├─ Provision and in case of a async service broker polling, for later binding ✔
      │  │  └─ Running Valid PUT provision with instanceId feaf198a-ec45-4c5b-a35b-77bd4b9c6f95 ✔
      │  ├─ Running invalid bindings ✔
      │  │  ├─ PUT should reject if missing service_id ✔
      │  │  ├─ DELETE should reject if missing service_id ✔
      │  │  ├─ PUT should reject if missing plan_id ✔
      │  │  └─ DELETE should reject if missing plan_id ✔
      │  └─ Deleting Provision ✔
      │     └─ DELETE provision and if the service broker is async polling afterwards ✔
      └─ runValidBindings() ✔
         └─ Running a valid provision if the service is bindable a valid binding. Deleting both afterwards. ✔
            ├─ Provision and in case of a async service broker polling, for later binding ✔
            │  └─ Running Valid PUT provision with instanceId b4206514-2915-4fea-b140-63d942aeb25e ✔
            ├─ Running PUT Binding and DELETE Binding afterwards ✔
            │  ├─ Running a valid binding with BindingId e882b7ba-47c6-40f2-89a0-0e08c6b342c5 60778 ms ✔
            │  └─ Deleting binding with bindingId e882b7ba-47c6-40f2-89a0-0e08c6b342c5 60197 ms ✔
            └─ Deleting Provision ✔
               └─ DELETE provision and if the service broker is async polling afterwards ✔

Test run finished after 129414 ms
[        11 containers found      ]
[         0 containers skipped    ]
[        11 containers started    ]
[         0 containers aborted    ]
[        11 containers successful ]
[         0 containers failed     ]
[        10 tests found           ]
[         0 tests skipped         ]
[        10 tests started         ]
[         0 tests aborted         ]
[        10 tests successful      ]
[         0 tests failed          ]

bulataleev/osb-checker-kotlin

osb-checker-kotlin

Table of Contents

Description

Build Application

Usage

Configuration

Parameters

Declaring Services

Declaring Test Runs

Test

Catalog

Provision

Binding

Authentication

Contract

Example output