account-lookup-service 15.5.0-iso.0

package/test/unit/models/participantEndpoint/facade.test.js

@@ -0,0 +1,295 @@
+/*****
+ License
+ --------------
+ Copyright © 2017 Bill & Melinda Gates Foundation
+ The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ Contributors
+ --------------
+ This is the official list of the Mojaloop project contributors for this file.
+ Names of the original copyright holders (individuals or organizations)
+ should be listed with a '*' in the first column. People who have
+ contributed from an organization can be listed under the organization
+ that actually holds the copyright for their contributions (see the
+ Gates Foundation organization for an example). Those individuals should have
+ their names indented and be marked with a '-'. Email address can be added
+ optionally within square brackets <email>.
+ * Gates Foundation
+ - Name Surname <name.surname@gatesfoundation.com>
+ - Shashikant Hirugade <shashikant.hirugade@modusbox.com>
+
+ * Crosslake
+ - Lewis Daly <lewisd@crosslaketech.com>
+
+ --------------
+ ******/
+
+'use strict'
+
+const mockHubName = require('../../../util/testConfig').HUB_NAME
+
+const mockGetEndpoint = jest.fn()
+const mockGetParticipant = jest.fn()
+const mockSendRequest = jest.fn()
+const mockEnums = {
+  Http: {
+    Headers: { FSPIOP: { DESTINATION: 'fsp1', SOURCE: 'fsp2', SWITCH: { value: mockHubName } } },
+    RestMethods: { PUT: 'PUT' },
+    ResponseTypes: { JSON: 'json' },
+    HeaderResources: { PARTICIPANTS: 'value' }
+  },
+  EndPoints: { FspEndpointTemplates: { PARTICIPANTS_GET: '/{{fsp}}/' } }
+}
+
+const src = '../../../../src'
+
+jest.mock('@mojaloop/central-services-shared', () => ({
+  Util: {
+    Endpoints: { getEndpoint: mockGetEndpoint },
+    Participants: { getParticipant: mockGetParticipant },
+    Request: { sendRequest: mockSendRequest },
+    Http: { SwitchDefaultHeaders: jest.fn() },
+    HeaderValidation: { getHubNameRegex: jest.fn().mockReturnValue(new RegExp(mockHubName)) }
+  },
+  Enum: mockEnums
+}))
+
+const Logger = require('@mojaloop/central-services-logger')
+const fixtures = require('../../../fixtures')
+
+Logger.isDebugEnabled = jest.fn(() => true)
+Logger.isErrorEnabled = jest.fn(() => true)
+Logger.isInfoEnabled = jest.fn(() => true)
+
+describe('participantEndpoint Facade', () => {
+  afterEach(() => {
+    jest.resetModules()
+    jest.clearAllMocks()
+    jest.unmock('@mojaloop/sdk-standard-components')
+  })
+
+  describe('sendRequest', () => {
+    it('sends the most basic request', async () => {
+      // Arrange
+      const mockedConfig = {
+        JWS_SIGN: false,
+        FSPIOP_SOURCE_TO_SIGN: mockHubName,
+        PROTOCOL_VERSIONS: fixtures.protocolVersionsDto()
+      }
+
+      jest.mock('../../../../src/lib/config', () => (mockedConfig))
+
+      mockGetEndpoint.mockImplementation(() => 'https://example.com/12345')
+      mockSendRequest.mockImplementation(() => Promise.resolve(true))
+      const ParticipantFacade = require(`${src}/models/participantEndpoint/facade`)
+
+      const headers = {}
+      const requestedParticipant = {}
+      const endpointType = 'URL'
+
+      // Act
+      const result = await ParticipantFacade.sendRequest(headers, requestedParticipant, endpointType)
+
+      // Assert
+      expect(result).toBe(true)
+      expect(mockSendRequest.mock.calls[0][0].protocolVersions).toMatchObject({
+        accept: mockedConfig.PROTOCOL_VERSIONS.ACCEPT.DEFAULT,
+        content: mockedConfig.PROTOCOL_VERSIONS.CONTENT.DEFAULT
+      })
+    })
+
+    it('fails to send the request', async () => {
+      // Arrange
+      const mockedConfig = {
+        JWS_SIGN: false,
+        FSPIOP_SOURCE_TO_SIGN: mockHubName,
+        PROTOCOL_VERSIONS: {
+          CONTENT: {
+            DEFAULT: '2.1',
+            VALIDATELIST: [
+              '2.1'
+            ]
+          },
+          ACCEPT: {
+            DEFAULT: '2',
+            VALIDATELIST: [
+              '2',
+              '2.1'
+            ]
+          }
+        }
+      }
+
+      jest.mock('../../../../src/lib/config', () => (mockedConfig))
+
+      mockGetEndpoint.mockImplementation(() => 'https://example.com/12345')
+      mockSendRequest.mockImplementation(() => { throw new Error('Request failed') })
+      const ParticipantFacade = require(`${src}/models/participantEndpoint/facade`)
+
+      const headers = {}
+      const requestedParticipant = {}
+      const endpointType = 'URL'
+
+      // Act
+      const action = async () => ParticipantFacade.sendRequest(headers, requestedParticipant, endpointType)
+
+      // Assert
+      await expect(action()).rejects.toThrow('Request failed')
+      expect(mockSendRequest.mock.calls[0][0].protocolVersions).toMatchObject({
+        accept: mockedConfig.PROTOCOL_VERSIONS.ACCEPT.DEFAULT,
+        content: mockedConfig.PROTOCOL_VERSIONS.CONTENT.DEFAULT
+      })
+    })
+
+    it('should define jwsSigner and add fspiop-signature header', async () => {
+      jest.mock('../../../../src/lib/config', () => ({
+        JWS_SIGN: true,
+        FSPIOP_SOURCE_TO_SIGN: mockHubName,
+        JWS_SIGNING_KEY_PATH: 'secrets/jwsSigningKey.key',
+        JWS_SIGNING_KEY: 'somekey',
+        PROTOCOL_VERSIONS: {
+          CONTENT: { DEFAULT: '2' },
+          ACCEPT: { DEFAULT: '2' }
+        }
+      }))
+      jest.mock('@mojaloop/sdk-standard-components') // to mock JwsSigner.getSignature()
+
+      mockSendRequest.mockImplementation(async (args) =>/* Util.Request.sendRequest */(args))
+      mockGetEndpoint.mockImplementation(() => 'https://example.com/parties/MSISDN12345')
+      const participantFacade = require(`${src}/models/participantEndpoint/facade`)
+
+      const participantName = 'fsp1'
+      const headers = {
+        [mockEnums.Http.Headers.FSPIOP.DESTINATION]: participantName,
+        [mockEnums.Http.Headers.FSPIOP.SOURCE]: mockHubName,
+        'fspiop-source': mockHubName
+      }
+      const endpointType = 'URL'
+      const method = 'PUT'
+      const payload = {}
+      await participantFacade.sendRequest(headers, participantName, endpointType, method, payload)
+
+      expect(mockSendRequest.mock.lastCall[0].jwsSigner).toBeTruthy()
+    })
+  })
+
+  describe('validateParticipant', () => {
+    it('fails to validate the participant', async () => {
+      // Arrange
+      mockGetParticipant.mockImplementation(() => { throw new Error('Validate Request failed') })
+      const fspId = 'fsp1'
+      const ParticipantFacade = require(`${src}/models/participantEndpoint/facade`)
+
+      // Act
+      const action = async () => ParticipantFacade.validateParticipant(fspId)
+
+      // Assert
+      await expect(action()).rejects.toThrow('Validate Request failed')
+    })
+  })
+
+  describe('sendErrorToParticipant', () => {
+    const mockConfigDto = ({ jwsSign = false } = {}) => ({
+      JWS_SIGN: jwsSign,
+      FSPIOP_SOURCE_TO_SIGN: mockHubName,
+      JWS_SIGNING_KEY_PATH: 'secrets/jwsSigningKey.key',
+      JWS_SIGNING_KEY: 'somekey',
+      PROTOCOL_VERSIONS: fixtures.protocolVersionsDto()
+    })
+
+    it('throws an error when the request fails', async () => {
+      // Arrange
+      jest.mock('../../../../src/lib/config', () => mockConfigDto())
+
+      mockGetEndpoint.mockImplementation(() => 'https://example.com/12345')
+      mockSendRequest.mockImplementation(() => { throw new Error('Request failed') })
+
+      const ParticipantFacade = require(`${src}/models/participantEndpoint/facade`)
+
+      const participantName = 'fsp1'
+      const endpointType = 'URL'
+      const errorInformation = {
+        message: 'Test error message'
+      }
+      const headers = {}
+      const params = {}
+      const payload = { requestId: '1234-5678' }
+
+      // Act
+      const action = async () => ParticipantFacade.sendErrorToParticipant(participantName, endpointType, errorInformation, headers, params, payload)
+      // Assert
+      await expect(action()).rejects.toThrow('Request failed')
+    })
+
+    it('Success without JWS', async () => {
+      // Arrange
+      const mockedConfig = mockConfigDto()
+      jest.mock('../../../../src/lib/config', () => mockedConfig)
+
+      mockGetEndpoint.mockImplementation(() => 'https://example.com/12345')
+      mockSendRequest.mockImplementation(() => Promise.resolve(true))
+
+      const ParticipantFacade = require(`${src}/models/participantEndpoint/facade`)
+      const spy = jest.spyOn(ParticipantFacade, 'sendErrorToParticipant')
+
+      const participantName = 'fsp1'
+      const endpointType = 'URL'
+      const errorInformation = {
+        message: 'Test error message'
+      }
+      const headers = {}
+      const params = {}
+      const payload = { requestId: '1234-5678' }
+
+      // Act
+      const action = async () => ParticipantFacade.sendErrorToParticipant(participantName, endpointType, errorInformation, headers, params, payload)
+      await action()
+
+      // Assert
+      expect(spy).toHaveBeenCalled()
+      const { jwsSigner, protocolVersions } = mockSendRequest.mock.calls[0][0]
+      expect(jwsSigner).toBe(null)
+      expect(protocolVersions).toMatchObject({
+        accept: mockedConfig.PROTOCOL_VERSIONS.ACCEPT.DEFAULT,
+        content: mockedConfig.PROTOCOL_VERSIONS.CONTENT.DEFAULT
+      })
+      spy.mockRestore()
+    })
+
+    it('adds jws signature when enabled', async () => {
+      // Arrange
+      const mockedConfig = mockConfigDto({ jwsSign: true })
+      jest.mock('../../../../src/lib/config', () => mockedConfig)
+
+      mockGetEndpoint.mockImplementation(() => 'https://example.com/parties/MSISDN12345')
+      mockSendRequest.mockImplementation(() => Promise.resolve(true))
+
+      const ParticipantFacade = require(`${src}/models/participantEndpoint/facade`)
+      const spy = jest.spyOn(ParticipantFacade, 'sendErrorToParticipant')
+
+      const participantName = 'fsp1'
+      const endpointType = 'URL'
+      const errorInformation = {
+        message: 'Test error message'
+      }
+      const headers = {}
+      headers[mockEnums.Http.Headers.FSPIOP.DESTINATION] = 'fsp1'
+      headers[mockEnums.Http.Headers.FSPIOP.SOURCE] = mockHubName
+
+      // Act
+      const action = async () => ParticipantFacade.sendErrorToParticipant(participantName, endpointType, errorInformation, headers)
+      await action()
+
+      // Assert
+      expect(spy).toHaveBeenCalled()
+      const { jwsSigner, protocolVersions } = mockSendRequest.mock.calls[0][0]
+      expect(jwsSigner).toBeTruthy()
+      expect(protocolVersions).toMatchObject({
+        accept: mockedConfig.PROTOCOL_VERSIONS.ACCEPT.DEFAULT,
+        content: mockedConfig.PROTOCOL_VERSIONS.CONTENT.DEFAULT
+      })
+      spy.mockRestore()
+    })
+  })
+})

package/test/unit/models/partyIdType/partyIdType.test.js

@@ -0,0 +1,88 @@
+/*****
+ License
+ --------------
+ Copyright © 2017 Bill & Melinda Gates Foundation
+ The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ Contributors
+ --------------
+ This is the official list of the Mojaloop project contributors for this file.
+ Names of the original copyright holders (individuals or organizations)
+ should be listed with a '*' in the first column. People who have
+ contributed from an organization can be listed under the organization
+ that actually holds the copyright for their contributions (see the
+ Gates Foundation organization for an example). Those individuals should have
+ their names indented and be marked with a '-'. Email address can be added
+ optionally within square brackets <email>.
+ * Gates Foundation
+ - Name Surname <name.surname@gatesfoundation.com>
+
+ * ModusBox
+ - Rajiv Mothilal <rajiv.mothilal@modusbox.com>
+
+ * Crosslake
+ - Lewis Daly <lewisd@crosslaketech.com>
+
+ --------------
+ ******/
+
+'use strict'
+
+const Sinon = require('sinon')
+
+const { getPartyIdTypeByName } = require('../../../../src/models/partyIdType/partyIdType')
+const Db = require('../../../../src/lib/db')
+const Logger = require('@mojaloop/central-services-logger')
+
+Logger.isDebugEnabled = jest.fn(() => true)
+Logger.isErrorEnabled = jest.fn(() => true)
+Logger.isInfoEnabled = jest.fn(() => true)
+
+describe('partyIdType Model', () => {
+  let sandbox
+
+  beforeEach(() => {
+    sandbox = Sinon.createSandbox()
+    Db.from = (table) => {
+      return Db[table]
+    }
+  })
+
+  afterEach(() => {
+    sandbox.restore()
+  })
+
+  it('Gets the partyIdType by name', async () => {
+    // Arrange
+    const partyIdType = {
+      partyIdTypeId: 1,
+      name: 'MSISDN',
+      description: 'A MSISDN (Mobile Station International Subscriber Directory Number, that is, the phone number)',
+      isActive: true,
+      createdDate: '2019-05-24 08:52:19'
+    }
+    Db.partyIdType = {
+      findOne: sandbox.stub().resolves(partyIdType)
+    }
+
+    // Act
+    const response = await getPartyIdTypeByName('MSISDN')
+
+    // Assert
+    expect(response).toEqual(partyIdType)
+  })
+
+  it('throws an error if Db call fails', async () => {
+    // Arrange
+    Db.partyIdType = {
+      findOne: sandbox.stub().throws(new Error('Error finding partyIdType'))
+    }
+
+    // Act
+    const action = async () => getPartyIdTypeByName('MSISDN')
+
+    // Assert
+    await expect(action()).rejects.toThrowError(/Error finding partyIdType/)
+  })
+})

package/test/unit/plugins.test.js

@@ -0,0 +1,89 @@
+/*****
+ License
+ --------------
+ Copyright © 2017 Bill & Melinda Gates Foundation
+ The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ Contributors
+ --------------
+ This is the official list of the Mojaloop project contributors for this file.
+ Names of the original copyright holders (individuals or organizations)
+ should be listed with a '*' in the first column. People who have
+ contributed from an organization can be listed under the organization
+ that actually holds the copyright for their contributions (see the
+ Gates Foundation organization for an example). Those individuals should have
+ their names indented and be marked with a '-'. Email address can be added
+ optionally within square brackets <email>.
+ * Gates Foundation
+ - Name Surname <name.surname@gatesfoundation.com>
+
+ * ModusBox
+ - Rajiv Mothilal <rajiv.mothilal@modusbox.com>
+
+ * Crosslake
+ - Lewis Daly <lewisd@crosslaketech.com>
+
+ --------------
+ ******/
+
+const Path = require('path')
+const Sinon = require('sinon')
+const OpenapiBackend = require('@mojaloop/central-services-shared').Util.OpenapiBackend
+
+const { registerPlugins } = require('../../src/plugins')
+const Config = require('../../src/lib/config')
+const Handlers = require('../../src/api')
+
+let sandbox
+
+describe('Plugin Tests', () => {
+  beforeEach(() => {
+    sandbox = Sinon.createSandbox()
+  })
+
+  afterEach(() => {
+    sandbox.restore()
+  })
+
+  it('should change the title based on the API_PORT', async () => {
+    // Arrange
+    const server = {
+      register: sandbox.spy(),
+      info: {
+        port: '8000'
+      }
+    }
+    const api = await OpenapiBackend.initialise(Path.resolve(__dirname, '../../src/interface/api-swagger.yaml'), Handlers.ApiHandlers)
+
+    sandbox.mock(Config)
+    Config.API_PORT = '8000'
+
+    // Act
+    await registerPlugins(server, api)
+
+    // Assert
+    expect(server.register.callCount).toBe(10)
+    const firstCallArgs = server.register.getCall(1).args
+    expect(firstCallArgs[0].options.document.info.title.includes('Open API for FSP Interoperability (FSPIOP) (Implementation Friendly Version)')).toBe(true)
+  })
+
+  it('should not register Blipp if DISPLAY_ROUTES is false', async () => {
+    // Arrange
+    const server = {
+      register: sandbox.spy(),
+      info: {
+        port: '8000'
+      }
+    }
+    const api = await OpenapiBackend.initialise(Path.resolve(__dirname, '../../src/interface/api-swagger.yaml'), Handlers.ApiHandlers)
+    sandbox.mock(Config)
+    Config.DISPLAY_ROUTES = false
+
+    // Act
+    await registerPlugins(server, api)
+
+    // Assert
+    expect(server.register.callCount).toBe(9)
+  })
+})

package/test/unit/setup.js

@@ -0,0 +1,7 @@
+const { MockIoRedis } = require('./mocks')
+jest.mock('ioredis', () => MockIoRedis)
+
+Object.assign(process.env, {
+  LOG_LEVEL: 'debug'
+  // override any other env vars needed for unit-tests
+})

package/test/util/apiClients/AlsApiClient.js

@@ -0,0 +1,44 @@
+const config = require('../../../src/lib/config')
+const BasicApiClient = require('./BasicApiClient')
+
+const baseURL = `http://localhost:${config.API_PORT}`
+
+class AlsProxyApiClient extends BasicApiClient {
+  constructor (deps) {
+    super({ ...deps, baseURL })
+  }
+
+  async getPartyByIdAndType ({ partyId, partyIdType, source, destination, proxy = '' }) {
+    return this.sendPartyRequest({
+      partyId, partyIdType, source, destination, proxy
+    })
+  }
+
+  async putPartiesSuccess ({ partyId, partyIdType, source, destination, proxy = '', body = {} }) {
+    return this.sendPartyRequest({
+      partyId, partyIdType, source, destination, proxy, body
+    })
+  }
+
+  async putPartiesError ({ partyId, partyIdType, source, destination, proxy = '', body = {} }) {
+    const isError = true
+    return this.sendPartyRequest({
+      partyId, partyIdType, source, destination, proxy, body, isError
+    })
+  }
+
+  async sendPartyRequest ({ partyId, partyIdType, source, destination, proxy = '', body = null, isError = false }) {
+    const method = body ? 'PUT' : 'GET'
+    const url = `/parties/${partyIdType}/${partyId}${isError ? '/error' : ''}`
+    const headers = this.fixtures.partiesCallHeadersDto({ source, destination, proxy })
+
+    return this.sendRequest({
+      method,
+      url,
+      headers,
+      body
+    })
+  }
+}
+
+module.exports = AlsProxyApiClient

package/test/util/apiClients/BasicApiClient.js

@@ -0,0 +1,34 @@
+const axiosLib = require('axios')
+const { loggerFactory } = require('../../../src/lib')
+const fixtures = require('../../fixtures')
+
+class BasicApiClient {
+  constructor ({
+    baseURL,
+    axios = axiosLib.create({ baseURL }),
+    logger = loggerFactory(this.constructor.name)
+  } = {}) {
+    this.baseURL = baseURL
+    this.axios = axios
+    this.logger = logger
+    this.fixtures = fixtures
+  }
+
+  async sendRequest ({ url, method = 'GET', headers = {}, body = null }) {
+    try {
+      const { data, status } = await this.axios.request({
+        method,
+        url,
+        headers,
+        data: body
+      })
+      this.logger.info('sendRequest is done:', { method, url, body, headers, response: { status, data } })
+      return { data, status }
+    } catch (err) {
+      this.logger.error('error in sendRequest: ', err)
+      throw err
+    }
+  }
+}
+
+module.exports = BasicApiClient

package/test/util/apiClients/ProxyApiClient.js

@@ -0,0 +1,25 @@
+const { PROXY_PORT } = require('../../integration/constants')
+const BasicApiClient = require('./BasicApiClient')
+
+const baseURL = `http://localhost:${PROXY_PORT}`
+
+class ProxyApiClient extends BasicApiClient {
+  constructor (deps) {
+    super({ ...deps, baseURL })
+  }
+
+  async getHistory () {
+    const { data } = await this.sendRequest({ url: '/history' })
+    return data.history
+  }
+
+  async deleteHistory () {
+    const { data } = await this.sendRequest({
+      url: '/history',
+      method: 'DELETE'
+    })
+    return data.history
+  }
+}
+
+module.exports = ProxyApiClient

package/test/util/apiClients/index.js

@@ -0,0 +1,7 @@
+const AlsApiClient = require('./AlsApiClient')
+const ProxyApiClient = require('./ProxyApiClient')
+
+module.exports = {
+  AlsApiClient,
+  ProxyApiClient
+}