Skip to content

Commit

Permalink
fixed broken links and removed deprecated interfaces (#3)
Browse files Browse the repository at this point in the history
  • Loading branch information
Bill Hodghead authored Dec 15, 2017
1 parent 10b6316 commit d961f9d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 19 deletions.
20 changes: 3 additions & 17 deletions Interop Services and Mule/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Interop Services

The various interop service APIs act as proxies and/or provide features such as validation, authentication and data transformation where necessary. The services operate based on service specifications provided in both Open API and RAML. The services run on Mule community runtime. There are four interop micro-services (recently two of them: interop-spsp-clientproxy and interop-spsp-backend-services are merged into one interop-scheme-adapter, so total of three services) that are mentioned below and several supporting projects.
The various interop service APIs act as proxies and/or provide features such as validation, authentication and data transformation where necessary. The services operate based on service specifications provided in both Open API and RAML. The services run on Mule community runtime. There are three interop micro-services that are mentioned below and several supporting projects.

There are several repositories that support non-functional requitements such as Performance, Logging, Metrics and Deployment that are discussed below as well.

Expand Down Expand Up @@ -30,10 +30,6 @@ The diagram in this section (L1P Reference Implementation) show the positive or
### Interfaces
- **interop-dfsp-directory** - This project provides an API gateway to the IST Directory Naming Service and provides resources to - "get metadata about a directory", "get customer information by providing identifier, identifierType", "Register a DFSP" and "get identifierTypes supported by the central directory"
- [Spec](https://github.com/mojaloop/interop-dfsp-directory/blob/master/README.md) | [Code](https://github.com/mojaloop/interop-dfsp-directory)
- **interop-spsp-clientproxy** - This interop project fulfills the role of ilp-spsp-client proxy. This project provides an API gateway to the ilp-spsp-client Service. It supports methods to query, quoteSourceAmount, setup and payment request as specified. This is now **deprecated** and its functionality is covered by interop-scheme-adapter.
- [Spec](https://github.com/mojaloop/interop-spsp-clientproxy/blob/master/README.md) | [Code](https://github.com/mojaloop/interop-spsp-clientproxy)
- **interop-spsp-backend-services** - This project provides an interop API implementation that interacts with SPSP server and DFSP. Implementation of SPSP Backend server is based on ilp-spsp-server specified [here](https://github.com/mojaloop/ilp-spsp-server). This is now **deprecated** and its functionality is covered by interop-scheme-adapter.
- [Spec](https://github.com/mojaloop/interop-spsp-backend-services/blob/master/README.md) | [Code](https://github.com/mojaloop/interop-spsp-backend-services)
- **interop-ilp-ledger** - This project provides an interop API implementation of ILP Ledger Service.
- [Spec](https://github.com/mojaloop/interop-ilp-ledger/blob/master/README.md) | [Code](https://github.com/mojaloop/interop-ilp-ledger)
- **interop-scheme-adapter** - This project provides an API gateway to the ilp-service microservice. It supports methods to query, quote,payment request as specified in the [ilp-service](https://github.com/mojaloop/ilp-service).
Expand All @@ -45,22 +41,12 @@ The diagram in this section (L1P Reference Implementation) show the positive or
* [interop-domain](https://github.com/mojaloop/interop-domain)

#### Projects for non-functional requirements
* [interop-docker](https://github.com/mojaloop/interop-docker)
* [interop-devops](https://github.com/mojaloop/interop-devops)
* [interop-metrics-ui](https://github.com/mojaloop/interop-metrics-ui)
* [interop-mule-connector-metrics](https://github.com/mojaloop/interop-mule-connector-metrics)
* [interop-functional-tests](https://github.com/mojaloop/interop-functional-tests)
* [interop-performance](https://github.com/mojaloop/interop-performance)
* [interop-elk](https://github.com/mojaloop/interop-elk)
* [interop-metrics-server](https://github.com/mojaloop/interop-metrics-server)

## Testing
Test Strategy

Java Unit Tests exist for each of the projects for unit testing, some of which use WireMock framework. Tests are run as part of executing the Maven pom.xml as mvn clean package.

Along with these unit tests, additional tests can be run by using the tests present in [interop-performance](https://github.com/mojaloop/interop-performance/tree/master/JMeter) which include several functional and scenario tests. These include USSD tests as well as JMeter scripts that can be used for performance/load testing and cover end-to-end scenarios.

## Security

Security/Threat Model for L1P Reference Implementation is [here](https://www.dropbox.com/home/Level%20One%20OSS%20Team%20Share/Discussion%20Docs?preview=ThreatModel_mojaloop.docx)
Expand All @@ -71,12 +57,12 @@ Resilience model for L1P Reference Implementation is [here](https://github.com/m

## Performance

Performance approach for Interop services and for L1P project as a whole is described [here](./L1P%20Performance%20Test.md). Tools used and ways to perform analysis are also described. This can be used for use case or scenario tests as well as isolated testing of services using mocks. The same approach and scripts can be used for Load Testing as well.
Performance approach for Interop services and for L1P project as a whole is described [here](https://github.com/mojaloop/docs/tree/master/test/performance). Tools used and ways to perform analysis are also described. This can be used for use case or scenario tests as well as isolated testing of services using mocks. The same approach and scripts can be used for Load Testing as well.

## Logging

Logging guidelines for L1P project were drafed and after review by partner teams, documented [here](./logging-guidelines.md). Aspects of end-to-end Tracing and support for Metrics are discussed and requirements described in the guidlines document. The configuration used and other customizations such as adding indexes can be found in the [interop-elk](https://github.com/mojaloop/interop-elk) project.

## Deployment

The L1P system can be deployed using Vagrant and Ansible playbooks to create two DFSPs and one CST VMs with support for MGMT VMs to allow execution on all supported platforms, including windows. The user guide for this is [here](https://github.com/mojaloop/interop-devops/blob/master/USERGUIDE.md)
The L1P system can be deployed using Vagrant and Ansible playbooks to create two DFSPs and one CST VMs with support for MGMT VMs to allow execution on all supported platforms, including windows. The user guide for this is [here](https://github.com/mojaloop/interop-devops/blob/master/README.md)
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@ The central services are a collection of separate services that help the DFSPs p
## End-to-End Scenarios
The aforementioned individual services can't alone describe how key scenarios work across the system. Therefore, for each of the [Mojaloop Scenarios](https://github.com/mojaloop/docs/blob/master/scenarios.md), we provide a technical walk through.

1. Send Money to Anyone: [scenario](https://github.com/mojaloop/Docs/blob/master/scenarios.md#send-money-to-anyone), [walkthrough](./LevelOneClient/scenarios/Send%20Payment.md)
1. Send Money to Anyone: [scenario](https://github.com/mojaloop/Docs/blob/master/scenarios.md#send-money-to-anyone), [walkthrough](https://github.com/mojaloop/docs/tree/master/DFSP#push-transfer-sequence-diagram)
2. Buy Goods [scenario](https://github.com/mojaloop/Docs/blob/master/scenarios.md#buy-goods---pending-transactions), [message flow](./DFSP/PendingTransactions/README.md)
3. Bulk Payment [scenario](https://github.com/mojaloop/Docs/blob/master/scenarios.md#bulk-payments), [message flow](./DFSP/BulkPayment/README.md)

## System-wide Testing
Individual services have their own tests, but the [testing strategy](https://github.com/mojaloop/mojaloop/blob/master/contribute/Testing-strategy.md) also includes the following system-wide tests:

- [Scenario testing](https://github.com/mojaloop/Docs/blob/master/test/end-to-end/readme.md)
- [End-to-end functional testing](https://github.com/mojaloop/interop-functional-tests/blob/master/README.md)
- [End-to-end functional testing](https://github.com/mojaloop/docs/blob/master/test/ilp-integration/README.md)
- [Performance testing](https://github.com/mojaloop/Docs/blob/master/test/performance/Performance%20Testing%20Summary.pdf)
- [Resilience Modeling and Analysis (RMA)](https://github.com/mojaloop/Docs/blob/master/test/RMA.md)
- Threat Modeling
Expand Down

0 comments on commit d961f9d

Please sign in to comment.