@mojaloop/sdk-scheme-adapter 11.18.8

package/test/unit/api/transfers/data/putPartiesBody.json

@@ -0,0 +1,20 @@
+{
+  "party": {
+    "partyIdInfo": {
+      "partyIdType": "PERSONAL_ID",
+      "partyIdentifier": "987654321",
+      "partySubIdOrType": "PASSPORT",
+      "fspId": "sim"
+    },
+    "personalInfo": {
+      "complexName": {
+        "firstName": "John",
+        "middleName": "Someone",
+        "lastName": "Doe"
+      },
+      "dateOfBirth": "1980-01-01"
+    },
+    "name": "John Doe",
+    "merchantClassificationCode": "1234"
+  }
+}

package/test/unit/api/transfers/data/putQuotesBody.json

@@ -0,0 +1,37 @@
+{
+  "transferAmount": {
+    "amount": "500",
+    "currency": "USD"
+  },
+  "payeeReceiveAmount": {
+    "amount": "490",
+    "currency": "USD"
+  },
+  "payeeFspFee": {
+    "amount": "5",
+    "currency": "USD"
+  },
+  "payeeFspCommission": {
+    "amount": "5",
+    "currency": "USD"
+  },
+  "geoCode": {
+    "latitude": "53.295971",
+    "longitude": "-0.038500"
+  },
+  "expiration": "2017-11-15T14:17:09.663+01:00",
+  "ilpPacket": "AQAAAAAAACasIWcuc2UubW9iaWxlbW9uZXkubXNpc2RuLjEyMzQ1Njc4OYIEIXsNCiAgICAidHJhbnNhY3Rpb25JZCI6ICI4NWZlYWMyZi0zOWIyLTQ5MWItODE3ZS00YTAzMjAzZDRmMTQiLA0KICAgICJxdW90ZUlkIjogIjdjMjNlODBjLWQwNzgtNDA3Ny04MjYzLTJjMDQ3ODc2ZmNmNiIsDQogICAgInBheWVlIjogew0KICAgICAgICAicGFydHlJZEluZm8iOiB7DQogICAgICAgICAgICAicGFydHlJZFR5cGUiOiAiTVNJU0ROIiwNCiAgICAgICAgICAgICJwYXJ0eUlkZW50aWZpZXIiOiAiMTIzNDU2Nzg5IiwNCiAgICAgICAgICAgICJmc3BJZCI6ICJNb2JpbGVNb25leSINCiAgICAgICAgfSwNCiAgICAgICAgInBlcnNvbmFsSW5mbyI6IHsNCiAgICAgICAgICAgICJjb21wbGV4TmFtZSI6IHsNCiAgICAgICAgICAgICAgICAiZmlyc3ROYW1lIjogIkhlbnJpayIsDQogICAgICAgICAgICAgICAgImxhc3ROYW1lIjogIkthcmxzc29uIg0KICAgICAgICAgICAgfQ0KICAgICAgICB9DQogICAgfSwNCiAgICAicGF5ZXIiOiB7DQogICAgICAgICJwZXJzb25hbEluZm8iOiB7DQogICAgICAgICAgICAiY29tcGxleE5hbWUiOiB7DQogICAgICAgICAgICAgICAgImZpcnN0TmFtZSI6ICJNYXRzIiwNCiAgICAgICAgICAgICAgICAibGFzdE5hbWUiOiAiSGFnbWFuIg0KICAgICAgICAgICAgfQ0KICAgICAgICB9LA0KICAgICAgICAicGFydHlJZEluZm8iOiB7DQogICAgICAgICAgICAicGFydHlJZFR5cGUiOiAiSUJBTiIsDQogICAgICAgICAgICAicGFydHlJZGVudGlmaWVyIjogIlNFNDU1MDAwMDAwMDA1ODM5ODI1NzQ2NiIsDQogICAgICAgICAgICAiZnNwSWQiOiAiQmFua05yT25lIg0KICAgICAgICB9DQogICAgfSwNCiAgICAiYW1vdW50Ijogew0KICAgICAgICAiYW1vdW50IjogIjEwMCIsDQogICAgICAgICJjdXJyZW5jeSI6ICJVU0QiDQogICAgfSwNCiAgICAidHJhbnNhY3Rpb25UeXBlIjogew0KICAgICAgICAic2NlbmFyaW8iOiAiVFJBTlNGRVIiLA0KICAgICAgICAiaW5pdGlhdG9yIjogIlBBWUVSIiwNCiAgICAgICAgImluaXRpYXRvclR5cGUiOiAiQ09OU1VNRVIiDQogICAgfSwNCiAgICAibm90ZSI6ICJGcm9tIE1hdHMiDQp9DQo\u003d\u003d",
+  "condition": "fH9pAYDQbmoZLPbvv3CSW2RfjU4jvM4ApG_fqGnR7Xs",
+  "extensionList": {
+    "extension": [
+      {
+        "key": "qreskey1",
+        "value": "qresvalue1"
+      },
+      {
+        "key": "qreskey2",
+        "value": "qresvalue2"
+      }
+    ]
+  }
+}

package/test/unit/api/transfers/data/putTransfersBody.json

@@ -0,0 +1,17 @@
+{
+  "fulfilment": "87mm1reS3SAi8oIWXgBkLmgWc1MkZ_yLbFDX5XAdo5o",
+  "completedTimestamp": "2017-11-15T14:16:09.663+01:00",
+  "transferState": "COMMITTED",
+  "extensionList": {
+    "extension": [
+      {
+        "key": "treskey1",
+        "value": "tresvalue1"
+      },
+      {
+        "key": "treskey2",
+        "value": "tresvalue2"
+      }
+    ]
+  }
+}

package/test/unit/api/transfers/transfers.test.js

@@ -0,0 +1,191 @@
+/**************************************************************************
+ *  (C) Copyright ModusBox Inc. 2019 - All rights reserved.               *
+ *                                                                        *
+ *  This file is made available under the terms of the license agreement  *
+ *  specified in the corresponding source code repository.                *
+ *                                                                        *
+ *  ORIGINAL AUTHOR:                                                      *
+ *       Yevhen Kyriukha - yevhen.kyriukha@modusbox.com                   *
+ **************************************************************************/
+
+'use strict';
+
+jest.unmock('@mojaloop/sdk-standard-components');
+jest.mock('redis');
+
+const redis = require('redis');
+const uuidv4 = require('uuidv4');
+const {createValidators, createTestServers, destroyTestServers} = require('../utils');
+const {createPostTransfersTester, createGetTransfersTester} = require('./utils');
+
+const defaultConfig = require('../../data/defaultConfig');
+
+// Transfers
+const postQuotesBody = require('./data/postQuotesBody');
+const postTransfersBody = require('./data/postTransfersBody');
+const putPartiesBody = require('./data/putPartiesBody');
+const putQuotesBody = require('./data/putQuotesBody');
+const putTransfersBody = require('./data/putTransfersBody');
+const postTransfersBadBody = require('./data/postTransfersBadBody');
+const postTransfersSuccessResponse = require('./data/postTransfersSuccessResponse');
+const postTransfersErrorTimeoutResponse = require('./data/postTransfersErrorTimeoutResponse');
+const postTransfersErrorMojaloopResponse = require('./data/postTransfersErrorMojaloopResponse');
+const getTransfersCommittedResponse = require('./data/getTransfersCommittedResponse');
+const getTransfersErrorNotFound = require('./data/getTransfersErrorNotFound');
+
+describe('Outbound Transfers API', () => {
+    let testPostTransfers;
+    let testGetTransfers;
+    let validatorsInfo;
+    let serversInfo;
+    let redisClient;
+
+    beforeAll(async () => {
+        validatorsInfo = await createValidators();
+        redisClient = redis.createClient();
+    });
+
+    beforeEach(async () => {
+        serversInfo = await createTestServers({
+            ...defaultConfig,
+            alsEndpoint: null,
+        });
+        testPostTransfers = createPostTransfersTester({
+            reqInbound: serversInfo.reqInbound,
+            reqOutbound: serversInfo.reqOutbound,
+            requestValidatorInbound: validatorsInfo.requestValidatorInbound,
+            apiSpecsOutbound: validatorsInfo.apiSpecsOutbound,
+        });
+        testGetTransfers = createGetTransfersTester({
+            reqInbound: serversInfo.reqInbound,
+            reqOutbound: serversInfo.reqOutbound,
+            apiSpecsOutbound: validatorsInfo.apiSpecsOutbound,
+        });
+    });
+
+    afterEach(async () => {
+        await destroyTestServers(serversInfo);
+    });
+
+    afterAll(async () => {
+        redisClient.end();
+    });
+
+    describe('POST /transfers', () => {
+        beforeEach(() => {
+            uuidv4.__reset();
+            redisClient.flushdb();
+        });
+
+        test(
+            'fails validation on invalid request and gives detailed error message indicating source of failure',
+            (done) => {
+                serversInfo.reqOutbound.post('/transfers').
+                    send(postTransfersBadBody).
+                    expect(400, {
+                        message: 'must be equal to one of the allowed values',
+                        statusCode: 400,
+                    }).
+                    end((err) => {
+                        if (err) {
+                            return done(err);
+                        }
+                        return done();
+                    });
+            });
+
+        test('should return success response', () => {
+            const bodyFn = {
+                parties: {
+                    put: () => putPartiesBody,
+                },
+                quotes: {
+                    post: (body) => ({
+                        ...postQuotesBody,
+                        expiration: body.expiration,
+                    }),
+                    put: () => putQuotesBody,
+                },
+                transfers: {
+                    post: (body) => ({
+                        ...postTransfersBody,
+                        expiration: body.expiration,
+                    }),
+                    put: () => putTransfersBody,
+                },
+            };
+            return testPostTransfers(bodyFn, 200, postTransfersSuccessResponse);
+        });
+
+        test('should return timeout error response on party resolution', () => {
+            const putBodyFn = {
+                parties: {
+                    put: () => new Promise(
+                        resolve => setTimeout(() => resolve(putPartiesBody),
+                            2000)),
+                },
+            };
+            return testPostTransfers(putBodyFn, 504,
+                postTransfersErrorTimeoutResponse);
+        });
+
+        test('should return mojaloop error response on party resolution', () => {
+            const putBodyFn = {
+                parties: {
+                    put: () => ({
+                        errorInformation: {
+                            errorCode: '3204',
+                            errorDescription: 'Party not found',
+                        },
+                    }),
+                },
+            };
+            return testPostTransfers(putBodyFn, 500,
+                postTransfersErrorMojaloopResponse);
+        });
+    });
+
+
+    describe('GET /transfers', () => {
+        beforeEach(() => {
+            uuidv4.__reset();
+            redisClient.flushdb();
+        });
+
+        test('should return COMMITTED transaction state', async () => {
+            const bodyFn = {
+                parties: {
+                    put: () => putPartiesBody,
+                },
+                quotes: {
+                    post: (body) => ({
+                        ...postQuotesBody,
+                        expiration: body.expiration,
+                    }),
+                    put: () => putQuotesBody,
+                },
+                transfers: {
+                    post: (body) => ({
+                        ...postTransfersBody,
+                        expiration: body.expiration,
+                    }),
+                    put: () => putTransfersBody,
+                },
+            };
+            await testPostTransfers(bodyFn, 200, postTransfersSuccessResponse);
+
+            const putBodyFn = () => putTransfersBody;
+            return testGetTransfers(putBodyFn, 200, getTransfersCommittedResponse);
+        });
+
+        test('should return transfer not found error', () => {
+            const putBodyFn = () => ({
+                errorInformation: {
+                    errorCode: '3208',
+                    errorDescription: 'Transaction not found',
+                },
+            });
+            return testGetTransfers(putBodyFn, 500, getTransfersErrorNotFound);
+        });
+    });
+});

package/test/unit/api/transfers/utils.js

@@ -0,0 +1,183 @@
+const nock = require('nock');
+const OpenAPIResponseValidator = require('openapi-response-validator').default;
+
+const { Logger } = require('@mojaloop/sdk-standard-components');
+const defaultConfig = require('../../data/defaultConfig');
+const postTransfersSimpleBody = require('./data/postTransfersSimpleBody');
+
+/**
+ *
+ * @param reqInbound
+ * @param reqOutbound
+ * @param apiSpecsOutbound
+ * @returns Function(putBodyFn:function, responseCode:number, responseBody:object) => Promise
+ */
+function createGetTransfersTester({ reqInbound, reqOutbound, apiSpecsOutbound }) {
+    /**
+     *
+     * @param putBodyFn {function}
+     * @param responseCode {number}
+     * @param responseBody {object}
+
+     * @return {Promise<any>}
+     */
+    return async (putBodyFn, responseCode, responseBody) => {
+        const TRANSFER_ID = '00000000-0000-1000-8000-000000000001';
+        const endpoint = new URL(`http://${defaultConfig.peerEndpoint}`).host;
+        const switchEndpoint = `http://${endpoint}`;
+
+        const sendPutTransfers = async () => {
+            const putBody = await Promise.resolve(putBodyFn());
+            let putUrl = `/transfers/${TRANSFER_ID}`;
+            if (putBody.errorInformation) {
+                putUrl += '/error';
+            }
+
+            return reqInbound.put(putUrl)
+                .send(putBody)
+                .set('content-type', 'application/vnd.interoperability.transfers+json;version=1.0')
+                .set('Date', new Date().toISOString())
+                .set('fspiop-source', 'mojaloop-sdk')
+                .expect(200);
+        };
+
+        await nock(switchEndpoint)
+            .get(`/transfers/${TRANSFER_ID}`)
+            .reply(202, () => {
+                sendPutTransfers().then();
+            });
+
+        const res = await reqOutbound.get(`/transfers/${TRANSFER_ID}`);
+        const {body} = res;
+        expect(res.statusCode).toEqual(responseCode);
+        delete body.initiatedTimestamp;
+        if (body.transferState) {
+            delete body.transferState.initiatedTimestamp;
+        }
+        expect(body).toEqual(responseBody);
+        const responseValidator = new OpenAPIResponseValidator(apiSpecsOutbound.paths['/transfers/{transferId}'].get);
+        const err = responseValidator.validateResponse(responseCode, body);
+        if (err) {
+            throw err;
+        }
+    };
+}
+
+/**
+ *
+ * @param requestValidatorInbound
+ * @param reqInbound
+ * @param reqOutbound
+ * @param apiSpecsOutbound
+ * @returns Function(bodyFn:object, responseCode:number, responseBody:object) => Promise
+ */
+function createPostTransfersTester(
+    { requestValidatorInbound, reqInbound, reqOutbound, apiSpecsOutbound }) {
+
+    const logger = new Logger.Logger({ context: { app: 'outbound-model-unit-tests' }, stringify: () => '' });
+
+    /**
+     *
+     * @param bodyFn {Object}
+     * @param responseCode {number}
+     * @param bodyFn.parties {object}
+     * @param bodyFn.parties.put {function}
+     * @param bodyFn.quotes {object}
+     * @param bodyFn.quotes.put {function}
+     * @param bodyFn.quotes.post {function}
+     * @param bodyFn.transfers {object}
+     * @param bodyFn.transfers.put {function}
+     * @param bodyFn.transfers.post {function}
+     * @param responseBody {object}
+
+     * @return {Promise<any>}
+     */
+    return async (bodyFn, responseCode, responseBody) => {
+        let pendingRequest = Promise.resolve();
+        let currentRequest = Promise.resolve();
+        const handleRequest = async (req) => {
+            const urlPath = req.path;
+            const body = req.body && JSON.parse(req.body);
+            const headers = req.headers;
+            const method = req.method;
+            let putBody;
+            let putUrl;
+            let contentType;
+            requestValidatorInbound.validateRequest(
+                {method, path: urlPath, request: {headers, body}}, logger);
+            if (urlPath.startsWith('/parties/')) {
+                putBody = await Promise.resolve(bodyFn.parties.put());
+                putUrl = urlPath;
+                contentType = 'application/vnd.interoperability.parties+json;version=1.0';
+            } else if (urlPath === '/quotes') {
+                expect(body).toEqual(bodyFn.quotes.post(body));
+                putBody = await Promise.resolve(bodyFn.quotes.put(body));
+                putUrl = `/quotes/${body.quoteId}`;
+                contentType = 'application/vnd.interoperability.quotes+json;version=1.0';
+            } else if (urlPath === '/transfers') {
+                expect(body).toEqual(bodyFn.transfers.post(body));
+                putBody = await Promise.resolve(bodyFn.transfers.put(body));
+                putUrl = `/transfers/${body.transferId}`;
+                contentType = 'application/vnd.interoperability.transfers+json;version=1.0';
+            } else {
+                throw new Error(`Unexpected url ${urlPath}`);
+            }
+            if (putBody.errorInformation) {
+                putUrl += '/error';
+            }
+            // supertest experiencing issues handling simultaneous requests,
+            //  so just wait for the previous request to finish
+            await currentRequest;
+            currentRequest = reqInbound.put(putUrl)
+                .send(putBody)
+                .set('Date', new Date().toISOString())
+                .set('content-type', contentType)
+                .set('fspiop-source', 'mojaloop-sdk')
+                .expect(200);
+            return currentRequest;
+        };
+
+        function handleNockRequest(uri, body) {
+            pendingRequest = handleRequest({
+                method: this.method.toLowerCase(),
+                path: uri,
+                body,
+                headers: this.req.headers,
+            }).then();
+        }
+
+        const endpoint = new URL(`http://${defaultConfig.peerEndpoint}`).host;
+        const switchEndpoint = `http://${endpoint}`;
+
+        const nockMock = nock(switchEndpoint);
+        if (bodyFn.parties) {
+            nockMock.get(/^\/parties\//).reply(202, handleNockRequest);
+        }
+        if (bodyFn.quotes) {
+            nockMock.post('/quotes').reply(202, handleNockRequest);
+        }
+        if (bodyFn.transfers) {
+            nockMock.post('/transfers').reply(202, handleNockRequest);
+        }
+
+        const res = await reqOutbound.post('/transfers').send(postTransfersSimpleBody);
+        const {body} = res;
+        expect(res.statusCode).toEqual(responseCode);
+        delete body.initiatedTimestamp;
+        if (body.transferState) {
+            delete body.transferState.initiatedTimestamp;
+        }
+        expect(body).toEqual(responseBody);
+        const responseValidator = new OpenAPIResponseValidator(apiSpecsOutbound.paths['/transfers'].post);
+        const err = responseValidator.validateResponse(responseCode, body);
+        if (err) {
+            throw err;
+        }
+        await pendingRequest;
+    };
+}
+
+module.exports = {
+    createGetTransfersTester,
+    createPostTransfersTester,
+};