account-lookup-service 15.5.0-iso.0

package/test/integration-runner.sh

@@ -0,0 +1,108 @@
+#!/usr/bin/env bash
+
+###
+# integration-runner.sh
+#
+# A basic integration test runner using docker-compose
+###
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+##
+# TEST_MODE
+# Options:
+# - default   runs the tests as usual
+# - wait      sets up the docker-compose environment, but don't do anything (this allows for repeat tests)
+# - rm        same as default, but stops and removes docker-compose containers afterwards
+###
+TEST_MODE="${TEST_MODE:-"default"}"
+
+
+# Controls where Jest places test outputs inside of `als_account-lookup-service-int` container
+JEST_JUNIT_OUTPUT_DIR="${JEST_JUNIT_OUTPUT_DIR:-"/tmp"}"
+JEST_JUNIT_OUTPUT_NAME="${JEST_JUNIT_OUTPUT_NAME:-"junit.xml"}"
+
+# Test output on host machine
+RESULTS_DIR="${RESULTS_DIR:-"/tmp"}"
+
+function startDocker() {
+  docker-compose \
+    -f ${DIR}/../docker-compose.yml \
+    -f ${DIR}/../docker-compose.integration.yml \
+    up -d
+}
+
+function waitForDocker() {
+  echo 'Waiting for docker services to be healthy'
+  HEALTHY_COUNT=$(docker ps | grep "healthy" | wc -l)
+  EXPECTED_HEALTHY_COUNT=5
+  EXPECTED_SERVICE_COUNT=6
+  while [ $(docker ps | grep "healthy" | wc -l) -lt $EXPECTED_HEALTHY_COUNT ]; do
+    TOTAL_SERVICES=$(docker ps | grep "als_*" | wc -l)
+    # exit early if we don't have the required services
+    if [ ${TOTAL_SERVICES} -lt ${EXPECTED_SERVICE_COUNT} ]; then
+      echo 'Not all docker-compose services are running. Check the logs and try again.'
+      exit 1
+    fi
+
+    echo "."
+    sleep 5
+  done
+}
+
+function runMigration() {
+  docker exec -it als_account-lookup-service sh -c "npm run migrate"
+}
+
+function runTests() {
+  docker exec -it als_account-lookup-service-int sh -c "JEST_JUNIT_OUTPUT_DIR=${JEST_JUNIT_OUTPUT_DIR} JEST_JUNIT_OUTPUT_NAME=${JEST_JUNIT_OUTPUT_NAME} npm run test:int"
+}
+
+function copyResults() {
+  echo "Copying results from: ${JEST_JUNIT_OUTPUT_DIR}/${JEST_JUNIT_OUTPUT_NAME} to: ${RESULTS_DIR}"
+  docker cp als_account-lookup-service-int:${JEST_JUNIT_OUTPUT_DIR}/${JEST_JUNIT_OUTPUT_NAME} ${RESULTS_DIR}
+}
+
+function tearDown() {
+  docker-compose \
+    -f ${DIR}/../docker-compose.yml \
+    -f ${DIR}/../docker-compose.integration.yml \
+    stop
+  docker-compose \
+    -f ${DIR}/../docker-compose.yml \
+    -f ${DIR}/../docker-compose.integration.yml \
+    down -v
+  docker-compose \
+    -f ${DIR}/../docker-compose.yml \
+    -f ${DIR}/../docker-compose.integration.yml \
+    rm -f
+}
+
+startDocker
+waitForDocker
+runMigration
+
+case ${TEST_MODE} in
+  default)
+    runTests
+    EXIT_RESULT=$?
+    copyResults
+    exit ${EXIT_RESULT}
+  ;;
+
+  wait)
+    echo 'Running tests in `wait` mode'
+  ;;
+
+  rm)
+    runTests
+    EXIT_RESULT=$?
+    copyResults
+    tearDown
+    exit ${EXIT_RESULT}
+  ;;
+
+  *)
+    echo "Unsupported TEST_MODE: ${TEST_MODE}"
+    exit 1
+esac

package/test/unit/api/health.test.js

@@ -0,0 +1,142 @@
+/*****
+ 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>
+ - Steven Oderayi <steven.oderayi@modusbox.com>
+
+ * Crosslake
+ - Lewis Daly <lewisd@crosslaketech.com>
+
+ --------------
+ ******/
+
+'use strict'
+
+const Helper = require('../../util/helper')
+const Db = require('../../../src/lib/db')
+const initServer = require('../../../src/server').initializeApi
+const getPort = require('get-port')
+const Sinon = require('sinon')
+const MigrationLockModel = require('../../../src/models/misc/migrationLock')
+const Logger = require('@mojaloop/central-services-logger')
+const Config = require('../../../src/lib/config')
+
+Logger.isDebugEnabled = jest.fn(() => true)
+Logger.isErrorEnabled = jest.fn(() => true)
+Logger.isInfoEnabled = jest.fn(() => true)
+let sandbox
+let server
+
+describe('/health', () => {
+  beforeEach(async () => {
+    Config.PROXY_CACHE_CONFIG.enabled = false
+    sandbox = Sinon.createSandbox()
+    sandbox.stub(Db, 'connect').returns(Promise.resolve({}))
+    Config.API_PORT = await getPort()
+    server = await initServer(Config)
+  })
+
+  afterEach(async () => {
+    await server.stop()
+    sandbox.restore()
+  })
+
+  /**
+   * summary: Get Health
+   * description: The HTTP request GET /health is used to get the status of the server
+   * parameters: type, currency, accept, content-type, date
+   * produces: application/json
+   * responses: 200, 400, 401, 403, 404, 405, 406, 501, 503
+   */
+  it('GET /health', async () => {
+    // Arrange
+    sandbox.stub(MigrationLockModel, 'getIsMigrationLocked').returns(false)
+    const mock = await Helper.generateMockRequest('/health', 'get')
+
+    const options = {
+      method: 'get',
+      url: mock.request.path,
+      headers: Helper.defaultAdminHeaders()
+    }
+
+    // Act
+    const response = await server.inject(options)
+
+    // Assert
+    expect(response.statusCode).toBe(200)
+    const payload = JSON.parse(response.payload)
+    expect(payload.status).toBe('OK')
+    expect(payload.services.length).toBe(1)
+    expect(payload.services[0].name).toBe('datastore')
+  })
+
+  it('GET /health service unavailable', async () => {
+    // Arrange
+    sandbox.stub(MigrationLockModel, 'getIsMigrationLocked').returns(true)
+    const mock = await Helper.generateMockRequest('/health', 'get')
+
+    const options = {
+      method: 'get',
+      url: mock.request.path,
+      headers: Helper.defaultAdminHeaders()
+    }
+
+    // Act
+    const response = await server.inject(options)
+
+    // Assert
+    expect(response.statusCode).toBe(503)
+    const payload = JSON.parse(response.payload)
+    expect(payload.status).toBe('DOWN')
+    expect(payload.services.length).toBe(1)
+    expect(payload.services[0].name).toBe('datastore')
+  })
+
+  it('GET /health should include proxy health', async () => {
+    // Arrange
+    Config.PROXY_CACHE_CONFIG.enabled = true
+    Config.API_PORT = await getPort()
+    Config.proxyMap = { proxied: 'proxy' }
+    let serverWithProxy
+    try {
+      serverWithProxy = await initServer(Config)
+      sandbox.stub(MigrationLockModel, 'getIsMigrationLocked').resolves(false)
+      const mock = await Helper.generateMockRequest('/health', 'get')
+
+      const options = {
+        method: 'get',
+        url: mock.request.path,
+        headers: Helper.defaultAdminHeaders()
+      }
+
+      // Act
+      const response = await serverWithProxy.inject(options)
+
+      // Assert
+      const payload = JSON.parse(response.payload)
+      expect(response.statusCode).toBe(200)
+      expect(payload.services.length).toBe(2)
+      expect(payload.services[1].name).toBe('proxyCache')
+    } finally {
+      serverWithProxy && await serverWithProxy.stop()
+    }
+  })
+})

package/test/unit/api/oracles/{ID}.test.js

@@ -0,0 +1,264 @@
+/*****
+ 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 Mockgen = require('../../../util/mockgen.js')
+const helper = require('../../../util/helper.js')
+const Sinon = require('sinon')
+const oracle = require('../../../../src/domain/oracle/index.js')
+const initServer = require('../../../../src/server.js').initializeAdmin
+const getPort = require('get-port')
+const Db = require('../../../../src/lib/db.js')
+const Migrator = require('../../../../src/lib/migrator.js')
+const Logger = require('@mojaloop/central-services-logger')
+const Config = require('../../../../src/lib/config.js')
+
+Logger.isDebugEnabled = jest.fn(() => true)
+Logger.isErrorEnabled = jest.fn(() => true)
+Logger.isInfoEnabled = jest.fn(() => true)
+let sandbox
+let server
+
+describe('/oracles/{ID} handler', () => {
+  beforeAll(async () => {
+    sandbox = Sinon.createSandbox()
+    sandbox.stub(Db, 'connect').returns(Promise.resolve({}))
+    sandbox.stub(Migrator, 'migrate').returns(Promise.resolve({}))
+    Config.ADMIN_PORT = await getPort()
+    server = await initServer(Config)
+  })
+
+  afterAll(async () => {
+    await server.stop()
+    sandbox.restore()
+  })
+
+  /**
+   * summary: Update Oracle
+   * description: The HTTP request PUT /oracles/{ID} is used to update information in the server regarding the provided oracle. This request should be used for individual update of Oracle information.
+   * parameters: body, ID, content-length, content-type, date
+   * produces: application/json
+   * responses: 204, 400, 401, 403, 404, 405, 406, 501, 503
+   */
+  it('PUT /oracles/{ID}', async () => {
+    expect.hasAssertions()
+    // Arrange
+    const requests = new Promise((resolve, reject) => {
+      Mockgen(false).requests({
+        path: '/oracles/{ID}',
+        operation: 'put'
+      }, function (error, mock) {
+        return error ? reject(error) : resolve(mock)
+      })
+    })
+
+    const mock = await requests
+
+    /*
+      Get the resolved path from mock request
+      Mock request Path templates({}) are resolved using path parameters
+    */
+    const options = {
+      method: 'put',
+      url: mock.request.path,
+      headers: helper.defaultAdminHeaders()
+    }
+    if (mock.request.body) {
+      // Send the request body
+      options.payload = mock.request.body
+    } else if (mock.request.formData) {
+      // Send the request form data
+      options.payload = mock.request.formData
+      // Set the Content-Type as application/x-www-form-urlencoded
+      options.headers = options.headers || {}
+      options.headers = helper.defaultAdminHeaders()
+    }
+    // If headers are present, set the headers.
+    if (mock.request.headers && mock.request.headers.length > 0) {
+      options.headers = mock.request.headers
+    }
+    sandbox.stub(oracle, 'updateOracle').returns(Promise.resolve({}))
+
+    // Act
+    const response = await server.inject(options)
+
+    // Assert
+    expect(response.statusCode).toBe(204)
+    oracle.updateOracle.restore()
+  })
+
+  it('PUT /oracles/{ID} error', async () => {
+    expect.hasAssertions()
+    // Arrange
+    const requests = new Promise((resolve, reject) => {
+      Mockgen(false).requests({
+        path: '/oracles/{ID}',
+        operation: 'put'
+      }, function (error, mock) {
+        return error ? reject(error) : resolve(mock)
+      })
+    })
+
+    const mock = await requests
+
+    /*
+      Get the resolved path from mock request
+      Mock request Path templates({}) are resolved using path parameters
+    */
+    const options = {
+      method: 'put',
+      url: mock.request.path,
+      headers: helper.defaultAdminHeaders()
+    }
+    if (mock.request.body) {
+      // Send the request body
+      options.payload = mock.request.body
+    } else if (mock.request.formData) {
+      // Send the request form data
+      options.payload = mock.request.formData
+      // Set the Content-Type as application/x-www-form-urlencoded
+      options.headers = options.headers || {}
+      options.headers = helper.defaultAdminHeaders()
+    }
+    // If headers are present, set the headers.
+    if (mock.request.headers && mock.request.headers.length > 0) {
+      options.headers = mock.request.headers
+    }
+    sandbox.stub(oracle, 'updateOracle').throws()
+
+    // Act
+    const response = await server.inject(options)
+
+    // Assert
+    expect(response.statusCode).toBe(500)
+    oracle.updateOracle.restore()
+  })
+
+  /**
+   * summary: Delete Oracle
+   * description: The HTTP request DELETE /oracles/{ID} is used to delete information in the server regarding the provided oracle.
+   * parameters: accept, ID, content-type, date
+   * produces: application/json
+   * responses: 204, 400, 401, 403, 404, 405, 406, 501, 503
+   */
+  it('delete /oracles/{ID}', async () => {
+    expect.hasAssertions()
+    // Arrange
+    const requests = new Promise((resolve, reject) => {
+      Mockgen(false).requests({
+        path: '/oracles/{ID}',
+        operation: 'delete'
+      }, function (error, mock) {
+        return error ? reject(error) : resolve(mock)
+      })
+    })
+
+    const mock = await requests
+
+    /*
+      Get the resolved path from mock request
+      Mock request Path templates({}) are resolved using path parameters
+    */
+    const options = {
+      method: 'delete',
+      url: '' + mock.request.path,
+      headers: helper.defaultAdminHeaders()
+    }
+    if (mock.request.body) {
+      // Send the request body
+      options.payload = mock.request.body
+    } else if (mock.request.formData) {
+      // Send the request form data
+      options.payload = mock.request.formData
+      // Set the Content-Type as application/x-www-form-urlencoded
+      options.headers = options.headers || {}
+      options.headers = helper.defaultAdminHeaders()
+    }
+    // If headers are present, set the headers.
+    if (mock.request.headers && mock.request.headers.length > 0) {
+      options.headers = mock.request.headers
+    }
+    sandbox.stub(oracle, 'deleteOracle').returns(Promise.resolve({}))
+
+    // Act
+    const response = await server.inject(options)
+
+    // Assert
+    expect(response.statusCode).toBe(204)
+    oracle.deleteOracle.restore()
+  })
+
+  it('delete /oracles/{ID} error', async () => {
+    expect.hasAssertions()
+    // Arrange
+    const requests = new Promise((resolve, reject) => {
+      Mockgen(false).requests({
+        path: '/oracles/{ID}',
+        operation: 'delete'
+      }, function (error, mock) {
+        return error ? reject(error) : resolve(mock)
+      })
+    })
+
+    const mock = await requests
+
+    /*
+      Get the resolved path from mock request
+      Mock request Path templates({}) are resolved using path parameters
+    */
+    const options = {
+      method: 'delete',
+      url: '' + mock.request.path,
+      headers: helper.defaultAdminHeaders()
+    }
+    if (mock.request.body) {
+      // Send the request body
+      options.payload = mock.request.body
+    } else if (mock.request.formData) {
+      // Send the request form data
+      options.payload = mock.request.formData
+      // Set the Content-Type as application/x-www-form-urlencoded
+      options.headers = options.headers || {}
+      options.headers = helper.defaultAdminHeaders()
+    }
+    // If headers are present, set the headers.
+    if (mock.request.headers && mock.request.headers.length > 0) {
+      options.headers = mock.request.headers
+    }
+    sandbox.stub(oracle, 'deleteOracle').throws()
+
+    // Act
+    const response = await server.inject(options)
+
+    // Assert
+    expect(response.statusCode).toBe(500)
+    oracle.deleteOracle.restore()
+  })
+})

package/test/unit/api/oracles.test.js

@@ -0,0 +1,173 @@
+/*****
+ 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 getPort = require('get-port')
+const Logger = require('@mojaloop/central-services-logger')
+const oracle = require('../../../src/domain/oracle')
+const Helper = require('../../util/helper')
+const initServer = require('../../../src/server').initializeAdmin
+const Db = require('../../../src/lib/db')
+const Migrator = require('../../../src/lib/migrator')
+const Config = require('../../../src/lib/config')
+
+Logger.isDebugEnabled = jest.fn(() => true)
+Logger.isErrorEnabled = jest.fn(() => true)
+Logger.isInfoEnabled = jest.fn(() => true)
+
+const getResponse = [{
+  oracleId: '1',
+  oracleIdType: 'MSISDN',
+  endpoint: {
+    value: 'http://localhost:8444',
+    endpointType: 'URL'
+  },
+  isDefault: true
+}]
+
+let sandbox
+let server
+
+describe('/oracles', () => {
+  beforeAll(async () => {
+    sandbox = Sinon.createSandbox()
+    sandbox.stub(Db, 'connect').returns(Promise.resolve({}))
+    sandbox.stub(Migrator, 'migrate').returns(Promise.resolve({}))
+    Config.ADMIN_PORT = await getPort()
+    server = await initServer(Config)
+  })
+
+  afterAll(async () => {
+    await server.stop()
+    sandbox.restore()
+  })
+
+  /**
+   * summary: Get Oracles
+   * description: The HTTP request GET /oracles is used to return the list of all oracle endpoints. There are optional fields for type and currency i.e. /admin/oracles?type=MSISDN&amp;currency=USD which can be used to get more filtered results or a specific entry
+   * parameters: type, currency, accept, content-type, date
+   * produces: application/json
+   * responses: 200, 400, 401, 403, 404, 405, 406, 501, 503
+   */
+  it('GET /oracle', async () => {
+    // Arrange
+    const mock = await Helper.generateMockRequest('/oracles', 'get', false)
+
+    // Get the resolved path from mock request
+    // Mock request Path templates({}) are resolved using path parameters
+    const options = {
+      method: 'get',
+      url: mock.request.path,
+      headers: Helper.defaultAdminHeaders()
+    }
+    sandbox.stub(oracle, 'getOracle').returns(Promise.resolve(getResponse))
+
+    // Act
+    const response = await server.inject(options)
+
+    // Assert
+    expect(response.statusCode).toBe(200)
+    oracle.getOracle.restore()
+  })
+
+  it('GET /oracle throws on error', async () => {
+    // Arrange
+    const mock = await Helper.generateMockRequest('/oracles', 'get', false)
+
+    // Get the resolved path from mock request
+    // Mock request Path templates({}) are resolved using path parameters
+    const options = {
+      method: 'get',
+      url: mock.request.path,
+      headers: Helper.defaultAdminHeaders()
+    }
+    sandbox.stub(oracle, 'getOracle').throws(new Error('Error Thrown'))
+
+    // Act
+    const response = await server.inject(options)
+
+    // Assert
+    expect(response.statusCode).toBe(500)
+    oracle.getOracle.restore()
+  })
+
+  /**
+   * summary: Create Oracles
+   * description: The HTTP request POST /oracles is used to create information in the server regarding the provided oracles. This request should be used for creation of Oracle information.
+   * parameters: body, accept, content-length, content-type, date
+   * produces: application/json
+   * responses: 201, 400, 401, 403, 404, 405, 406, 501, 503
+   */
+  it('POST /oracle', async () => {
+    // Arrange
+    const mock = await Helper.generateMockRequest('/oracles', 'post', false)
+
+    // Get the resolved path from mock request
+    // Mock request Path templates({}) are resolved using path parameters
+    const options = {
+      method: 'post',
+      url: mock.request.path,
+      headers: Helper.defaultAdminHeaders(),
+      payload: mock.request.body
+    }
+
+    sandbox.stub(oracle, 'createOracle').returns(Promise.resolve({}))
+
+    // Act
+    const response = await server.inject(options)
+
+    // Assert
+    expect(response.statusCode).toBe(201)
+    oracle.createOracle.restore()
+  })
+
+  it('POST /oracle throws error', async () => {
+    // Arrange
+    const mock = await Helper.generateMockRequest('/oracles', 'post', false)
+
+    // Get the resolved path from mock request
+    // Mock request Path templates({}) are resolved using path parameters
+    const options = {
+      method: 'post',
+      url: mock.request.path,
+      headers: Helper.defaultAdminHeaders(),
+      payload: mock.request.body
+    }
+    sandbox.stub(oracle, 'createOracle').throws(new Error('Error Thrown'))
+
+    // Act
+    const response = await server.inject(options)
+
+    // Assert
+    expect(response.statusCode).toBe(500)
+    oracle.createOracle.restore()
+  })
+})