README
¶
The Functional Conformance Suite is an Open Source test tool provided by Open Banking. The goal of the suite is to provide an easy and comprehensive tool that enables implementers to test interfaces and data endpoints against the Functional API standard.
The supporting documentation assumes technical understanding of the Open Banking ecosystem. An introduction to the concepts is available via the Open Banking Website.
To provide feedback, please use the public issue tracker or see the CONTRIBUTING.md.
Release Notes
v0.1.0-pre-alpha (30th November 2018)
This pre-alpha build introduces some of the concepts to implementers before the official release. The aim is to foster an open and collaborative tool and support feedback to help develop the best possible tool.
N.B. This release is not intended to be executable so bug reports about this version should NOT be posted.
Read the full release notes (v0.1.0-pre-alpha.md)
What's New:
- NEW: Test Case Design : The functional conformance suite provides a cross-platform, language agnostic representation of test cases. The primary purpose is to determine whether an implementer resource complies with requirements of specifications and conditions, regulations and standards.
- NEW: Discovery Design: Provides a configurable model that allows an implementer to describe information on endpoint availability and data structure.
v0.2.0-alpha (11th January 2019)
The contents of this release will be advised presently.
Quickstart
Clone:
> git clone git@bitbucket.org:openbankingteam/conformance-suite.git && cd conformance-suite
Run the Makefile:
> make run_image
You can also pull & run the latest Docker image:
> docker run openbanking/conformance-suite
Prerequisites
In order to run this container you'll need docker installed.
Support
For support on using the suite use the Open Banking Help Centre. To raise bugs or features please use the issue tracker.
Licensing
This repository is subject to this MIT Open Licence. Please read our LICENSE.md for more information
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.
Useful links
- Docker Hub Conformance Suite
- For more information see the Open Banking Developer Zone.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package appconfig - Package to read certs and parameters via the config/config.json file Typically this files looks like the following or simplar:- // config.json { "softwareStatementId": "1p8bGrHhJRrphjFk0qwNAU", "clientScopes": "AuthoritiesReadAccess ASPSPReadAccess TPPReadAccess", "keyId": "BFnipP2g4ZaaFySsIaigOUoCP2E", "tokenUrl": "https://matls-sso.openbanking.me.uk/as/token.oauth2", "tppTestUrl1":"https://matls-api.openbanking.me.uk/scim/v2/OBAccountPaymentServiceProviders", "tppTestUrl":"https://tls-api.openbanking.me.uk/scim/v2/OBAccountPaymentServiceProviders", "aud": "https://matls-sso.openbanking.me.uk/as/token.oauth2" } The following files will also be picked up from the config directory certSigning.pem - public signing cert certTransport.pem - public transport cert privateKeySigning.key - private signing key privateKeyTransport.key - private transport key
|
Package appconfig - Package to read certs and parameters via the config/config.json file Typically this files looks like the following or simplar:- // config.json { "softwareStatementId": "1p8bGrHhJRrphjFk0qwNAU", "clientScopes": "AuthoritiesReadAccess ASPSPReadAccess TPPReadAccess", "keyId": "BFnipP2g4ZaaFySsIaigOUoCP2E", "tokenUrl": "https://matls-sso.openbanking.me.uk/as/token.oauth2", "tppTestUrl1":"https://matls-api.openbanking.me.uk/scim/v2/OBAccountPaymentServiceProviders", "tppTestUrl":"https://tls-api.openbanking.me.uk/scim/v2/OBAccountPaymentServiceProviders", "aud": "https://matls-sso.openbanking.me.uk/as/token.oauth2" } The following files will also be picked up from the config directory certSigning.pem - public signing cert certTransport.pem - public transport cert privateKeySigning.key - private signing key privateKeyTransport.key - private transport key |
|
internal
|
|
|
pkg
|
|