README
¶
The Functional Conformance Tool 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
v1.1.0 (4th April 2019)
Release v1.1.0 addresses known issues following feedback from users at the OBIE Functional Workshop. (recommended).
Full Release Notes (v1.1.0.md)
v1.0.0-rc1 (29th March 2019)
This v1.0.0-rc1 release introduces manual PSU consent (hybrid flow) for for v3.1 of the OBIE Accounts and Transactions specifications and Payments.
Full Release Notes (v1.0.0-rc1.md)
v1.0.0-beta (19th February 2019)
This v1.0.0-beta release introduces manual PSU consent (hybrid flow) and a example Discovery Template to demonstrate the hybrid flow for Ozone Model Bank for v3.1 of the OBIE Accounts and Transactions specifications.
N.B. This release is not intended to be run in production.
Full Release Notes (v1.0.0-beta.md)
Quickstart
Pull and run the latest (stable) tagged Docker image:
> docker run --rm -it -p 8443:8443 "openbanking/conformance-suite:[tag]"
Prerequisites
In order to run a 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
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 simpler:- // 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 simpler:- // 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 |
|
cmd
|
|
|
internal
|
|
|
pkg/version
Package version contains version information for Functional Conformance Suite.
|
Package version contains version information for Functional Conformance Suite. |
|
pkg
|
|
|
report
Enum to json.UnmarshalJson and json.MarshalJSON taken from: https://gist.github.com/lummie/7f5c237a17853c031a57277371528e87 We might be able to use https://github.com/campoy/jsonenums - might do this after the package is tested.
|
Enum to json.UnmarshalJson and json.MarshalJSON taken from: https://gist.github.com/lummie/7f5c237a17853c031a57277371528e87 We might be able to use https://github.com/campoy/jsonenums - might do this after the package is tested. |