https://github.com/openservicebrokerapi/osb-checker

An automatic checker to verify an Open Service Broker API implementation against the specification
https://github.com/openservicebrokerapi/osb-checker

cff-wg-service-management osbapi service-broker

Last synced: 3 months ago
JSON representation

An automatic checker to verify an Open Service Broker API implementation against the specification

• Host: GitHub
• URL: https://github.com/openservicebrokerapi/osb-checker
• Owner: openservicebrokerapi
• License: apache-2.0
• Created: 2017-10-04T01:49:34.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-10-30T08:59:38.000Z (about 5 years ago)
• Last Synced: 2024-06-24T12:03:59.753Z (7 months ago)
• Topics: cff-wg-service-management, osbapi, service-broker
• Language: Go
• Homepage: https://github.com/openservicebrokerapi/servicebroker/
• Size: 2.6 MB
• Stars: 48
• Watchers: 14
• Forks: 40
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/openservicebrokerapi/osb-checker.svg?branch=master)](https://travis-ci.org/openservicebrokerapi/osb-checker "Travis")

# osb-checker

An automatic checker to verify an Open Service Broker API implementation against the [specification](https://github.com/openservicebrokerapi/servicebroker).

# Project Status

This project should be considered **experimental**. You should validate the results against the released [specification](https://github.com/openservicebrokerapi/servicebroker). In the case of any discrepancy, the specification should be considered correct.

# Usage

## Test

* Firstly, u need to deploy your own service broker to be tested.

* Modify the `config_mock.yaml` under test/configs folder.

* Just run `go test -v ./test/ -f configs/config_mock.yaml` to start the test job.

## Mock broker

This project provides a mock broker as reference implementation for enforcing conformance test, and validated results of this mock broker should be considered more reliable compared with other 3rd party brokers.

For deploying and using this mock broker, you should execute these commands below:

```shell

make

./build/bin/osbchecker.mockbroker

```

## Generate model and mock broker

All the model and mock broker framework will be generated from [swagger.yaml](https://raw.githubusercontent.com/openservicebrokerapi/servicebroker/master/swagger.yaml) automatically. Here are some steps for developers to generate them:

* First developers should make sure your machine has `docker` installed.

* Then run one command below:

	```shell

	make autogenerated

	```