@mojaloop/ml-testing-toolkit-client-lib 0.0.2

package/test/unit/report.test.js

@@ -0,0 +1,258 @@
+/*****
+ 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
+
+ * ModusBox
+ * Georgi Logodazhki <georgi.logodazhki@modusbox.com> (Original Author)
+ --------------
+ ******/
+'use strict'
+
+const util = require('util')
+const spyPromisify = jest.spyOn(util, 'promisify')
+const axios = require('axios')
+jest.mock('axios')
+const objectStore = require('../../src/objectStore')
+const spyObjectStoreGet = jest.spyOn(objectStore, 'get')
+const s3Upload = require('../../src/extras/s3-upload')
+jest.mock('../../src/extras/s3-upload')
+const report = require('../../src/utils/report')
+const Utils = require('../../src/utils/file-utils')
+const SpyWriteFileAsync = jest.spyOn(Utils, 'writeFileAsync')
+
+
+
+const data = { 
+  runtimeInformation: {
+    completedTimeISO: "2020-05-07T10:44:01.687Z"
+  }
+}
+
+describe('Cli client', () => {
+  describe('run testcaseDefinitionReport functionality', () => {
+    it('when the report format is json should not throw an error', async () => {
+      spyPromisify.mockReturnValueOnce(jest.fn())
+      const config = {
+        reportFormat: 'json'
+      }
+      objectStore.set('config', config)
+      await expect(report.testcaseDefinition(data)).resolves.not.toBeNull
+    })
+  })
+  describe('run outbound functionality', () => {
+    it('when the report format is json should not throw an error', async () => {
+      spyPromisify.mockReturnValueOnce(jest.fn())
+      const config = {
+        reportFormat: 'json'
+      }
+      objectStore.set('config', config)
+      await expect(report.outbound(data)).resolves.not.toBeNull
+    })
+    it('when the report format is html and reportAutoFilenameEnable present should not throw an error', async () => {
+      const response = {
+        'headers': {
+          'content-disposition': 'attachment; filename=TTK-Assertion-Report-Test1-2020-05-08T13:53:51.887Z.html'
+        }
+      }
+      axios.post.mockReturnValueOnce(response)
+      spyPromisify.mockReturnValueOnce(jest.fn())
+      const config = {
+        reportFormat: 'html',
+        reportAutoFilenameEnable: true
+      }
+      objectStore.set('config', config)
+      await expect(report.outbound(data)).resolves.not.toBeNull
+    })
+    it('when the report format is html and reportFilename not present should not throw an error', async () => {
+      const response = {
+        'headers': {
+          'content-disposition': 'attachment; filename=TTK-Assertion-Report-Test1-2020-05-08T13:53:51.887Z.html'
+        }
+      }
+      axios.post.mockReturnValueOnce(response)
+      spyPromisify.mockReturnValueOnce(jest.fn())
+      const config = {
+        reportFormat: 'html'
+      }
+      objectStore.set('config', config)
+      await expect(report.outbound(data)).resolves.not.toBeNull
+    })
+    it('when the report format is html and content-disposition not present should not throw an error', async () => {
+      const response = {
+        'headers': {}
+      }
+      axios.post.mockReturnValueOnce(response)
+      spyPromisify.mockReturnValueOnce(jest.fn())
+      const config = {
+        reportFormat: 'printhtml'
+      }
+      objectStore.set('config', config)
+      await expect(report.outbound(data)).resolves.not.toBeNull
+    })
+    it('when the report format is html and wrong data not present should not throw an error', async () => {
+      const response = {
+        'headers': {
+          'content-disposition': 'attachment; filname=TTK-Assertion-Report-Test1-2020-05-08T13:53:51.887Z.html'
+        }
+      }
+      axios.post.mockReturnValueOnce(response)
+      spyPromisify.mockReturnValueOnce(jest.fn())
+      const config = {
+        reportFormat: 'printhtml'
+      }
+      objectStore.set('config', config)
+      await expect(report.outbound(data)).resolves.not.toBeNull
+    })
+    it('when the report format is printhtml and reportFilename not present should not throw an error', async () => {
+      const response = {
+        'headers': {
+          'content-disposition': 'attachment; filename=TTK-Assertion-Report-Test1-2020-05-08T13:53:51.887Z.html'
+        }
+      }
+      axios.post.mockReturnValueOnce(response)
+      spyPromisify.mockReturnValueOnce(jest.fn())
+      const config = {
+        reportFormat: 'printhtml'
+      }
+      objectStore.set('config', config)
+      await expect(report.outbound(data)).resolves.not.toBeNull
+    })
+    it('when the report format is printhtml and reportFilename not present should not throw an error', async () => {
+      const response = {
+        'headers': {
+          'content-disposition': 'attachment; filename=TTK-Assertion-Report-Test1-2020-05-08T13:53:51.887Z.html'
+        }
+      }
+      axios.post.mockReturnValueOnce(response)
+      spyPromisify.mockReturnValueOnce(jest.fn())
+      const config = {
+        reportFormat: 'printhtml'
+      }
+      objectStore.set('config', config)
+      await expect(report.outbound(data)).resolves.not.toBeNull
+    })
+
+
+    it('when the report format is printhtml and extraSummaryInformation is supplied', async () => {
+      const response = {
+        'headers': {
+          'content-disposition': 'attachment; filename=TTK-Assertion-Report-Test1-2020-05-08T13:53:51.887Z.html'
+        }
+      }
+      axios.post.mockReturnValueOnce(response)
+      spyPromisify.mockReturnValueOnce(jest.fn())
+      const config = {
+        reportFormat: 'printhtml',
+        extraSummaryInformation:  'Title:Mocktitle,Summary:MockSummary'
+      }
+      objectStore.set('config', config)
+      await expect(report.outbound(data)).resolves.not.toBeNull
+    })
+
+
+    it('when the report format is not supported should not throw an error', async () => {
+      const config = {
+        reportFormat: 'default'
+      }
+      objectStore.set('config', config)
+      await expect(report.outbound(data)).resolves.not.toBeNull
+    })
+    it('when the reportTarget is file should not throw an error', async () => {
+      const response = {
+        'headers': {
+          'content-disposition': 'attachment; filename=TTK-Assertion-Report-Test1-2020-05-08T13:53:51.887Z.html'
+        }
+      }
+      axios.post.mockReturnValueOnce(response)
+      SpyWriteFileAsync.mockResolvedValueOnce()
+      spyPromisify.mockReturnValueOnce(jest.fn())
+      const config = {
+        reportFormat: 'html',
+        reportTarget: 'file://asdf'
+      }
+      objectStore.set('config', config)
+      await expect(report.outbound(data)).resolves.not.toBeNull
+    })
+    it('when the reportTarget is of type file with path adn auto filename enabled should not throw an error', async () => {
+      const response = {
+        'headers': {
+          'content-disposition': 'attachment; filename=TTK-Assertion-Report-Test1-2020-05-08T13:53:51.887Z.html'
+        }
+      }
+      axios.post.mockReturnValueOnce(response)
+      SpyWriteFileAsync.mockResolvedValueOnce()
+      spyPromisify.mockReturnValueOnce(jest.fn())
+      const config = {
+        reportFormat: 'html',
+        reportAutoFilenameEnable: true,
+        reportTarget: 'file://asdf/dasfe.html'
+      }
+      objectStore.set('config', config)
+      await expect(report.outbound(data)).resolves.not.toBeNull
+    })
+    it('when the reportTarget is of type file with filename and auto filename enabled should not throw an error', async () => {
+      const response = {
+        'headers': {
+          'content-disposition': 'attachment; filename=TTK-Assertion-Report-Test1-2020-05-08T13:53:51.887Z.html'
+        }
+      }
+      axios.post.mockReturnValueOnce(response)
+      SpyWriteFileAsync.mockResolvedValueOnce()
+      spyPromisify.mockReturnValueOnce(jest.fn())
+      const config = {
+        reportFormat: 'html',
+        reportAutoFilenameEnable: true,
+        reportTarget: 'file://dasfe.html'
+      }
+      objectStore.set('config', config)
+      await expect(report.outbound(data)).resolves.not.toBeNull
+    })
+    it('when the reportTarget is s3 should not throw an error', async () => {
+      const response = {
+        'headers': {
+          'content-disposition': 'attachment; filename=TTK-Assertion-Report-Test1-2020-05-08T13:53:51.887Z.html'
+        }
+      }
+      axios.post.mockReturnValueOnce(response)
+      s3Upload.uploadFileDataToS3.mockReturnValueOnce('http://some_upload_url')
+      spyPromisify.mockReturnValueOnce(jest.fn())
+      const config = {
+        reportFormat: 'html',
+        reportTarget: 's3://asdf'
+      }
+      objectStore.set('config', config)
+      await expect(report.outbound(data)).resolves.toHaveProperty('uploadedReportURL')
+
+    })
+    it('when the reportTarget is unknown should return undefined', async () => {
+      const response = {
+        'headers': {
+          'content-disposition': 'attachment; filename=TTK-Assertion-Report-Test1-2020-05-08T13:53:51.887Z.html'
+        }
+      }
+      axios.post.mockReturnValueOnce(response)
+      spyPromisify.mockReturnValueOnce(jest.fn())
+      const config = {
+        reportFormat: 'html',
+        reportTarget: 'asdf://asdf'
+      }
+      objectStore.set('config', config)
+      await expect(report.outbound(data)).resolves.toBe(undefined)
+    })
+  })
+})

package/test/unit/router.test.js

@@ -0,0 +1,110 @@
+/*****
+ 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
+
+ * ModusBox
+ * Georgi Logodazhki <georgi.logodazhki@modusbox.com> (Original Author)
+ --------------
+ ******/
+'use strict'
+
+const spyExit = jest.spyOn(process, 'exit')
+const { cli } = require('../../src/router')
+
+jest.mock('../../src/utils/listeners')
+jest.mock('../../src/modes/outbound')
+jest.mock('../../src/modes/testcaseDefinitionReport')
+
+describe('Cli client', () => {
+  describe('running router', () => {
+    it('when mode is monitoring should not throw an error', async () => {
+      const config = {
+        "mode": "monitoring"
+      }  
+      spyExit.mockImplementationOnce(jest.fn())
+      expect(() => {
+        cli(config)
+      }).not.toThrowError();
+    })
+    it('when mode is outbound and inputFiles is provided should not throw an error', async () => {
+      const config = {
+        "mode": "outbound",
+        "inputFiles": "test"
+      }
+      spyExit.mockImplementationOnce(jest.fn())
+      expect(() => {
+        cli(config)
+      }).not.toThrowError();
+    })
+    it('when mode is outbound, inputFiles and environmentFile is provided should not throw an error', async () => {
+      const config = {
+        "mode": "outbound",
+        "inputFiles": "test",
+        "environmentFile": "test"
+      }
+      spyExit.mockImplementationOnce(jest.fn())
+      expect(() => {
+        cli(config)
+      }).not.toThrowError();
+    })
+    it('when mode is outbound and inputFile was not provided should not throw an error', async () => {
+      const config = {
+        "mode": "outbound"
+      }
+      spyExit.mockImplementationOnce(jest.fn())
+      expect(() => {
+        cli(config)
+      }).not.toThrowError();
+    })
+    it('when mode is testcaseDefinitionReport and inputFile was provided should not throw an error', async () => {
+      const config = {
+        "mode": "testcaseDefinitionReport",
+        "inputFiles": "test"
+      }
+      spyExit.mockImplementationOnce(jest.fn())
+      expect(() => {
+        cli(config)
+      }).not.toThrowError();
+    })
+    it('when mode is testcaseDefinitionReport and inputFile was not provided should throw an error', async () => {
+      const config = {
+        "mode": "testcaseDefinitionReport"
+      }
+      spyExit.mockImplementationOnce(jest.fn())
+      expect(() => {
+        cli(config)
+      }).not.toThrowError();
+    })
+    it('when mode is not supported should not throw an error', async () => {
+      const config = {
+        "mode": "unsupported"
+      }
+      spyExit.mockImplementationOnce(jest.fn())
+      expect(() => {
+        cli(config)
+      }).not.toThrowError();
+    })
+    it('when mode is not provided should not throw an error', async () => {
+      const config = {}
+      spyExit.mockImplementationOnce(jest.fn())
+      expect(() => {
+        cli(config)
+      }).not.toThrowError();
+    })
+  })
+})

package/test/unit/templateGenerator.test.js

@@ -0,0 +1,119 @@
+/*****
+ 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
+
+ * ModusBox
+ * Georgi Logodazhki <georgi.logodazhki@modusbox.com> (Original Author)
+ --------------
+ ******/
+'use strict'
+
+const SharedLib = require('@mojaloop/ml-testing-toolkit-shared-lib')
+const Utils = require('../../src/utils/file-utils')
+
+jest.mock('@mojaloop/ml-testing-toolkit-shared-lib')
+jest.mock('../../src/utils/file-utils')
+
+const TemplateGenerator = require('../../src/utils/templateGenerator')
+
+describe('Cli client', () => {
+  describe('run template generator', () => {
+    it('when passing a file, template should be generated', async () => {
+      const fileList = ['test.json']
+      
+      Utils.fileStatAsync.mockResolvedValueOnce({
+        isFile: () => true
+      })
+      Utils.readFileAsync.mockResolvedValueOnce(JSON.stringify({}))
+      SharedLib.FolderParser.getFolderData.mockReturnValueOnce({})
+      SharedLib.FolderParser.getTestCases.mockReturnValueOnce([])
+
+      await expect(TemplateGenerator.generateTemplate(fileList)).resolves.toBeDefined()
+    })
+    it('when passing a folder without master file and no selected labels, template should be generated', async () => {
+      const fileList = ['test-folder']
+
+      // fileList['test-folder']
+      Utils.fileStatAsync.mockResolvedValueOnce({
+        isFile: () => false,
+        isDirectory: () => true
+      }) 
+      Utils.readRecursiveAsync.mockResolvedValueOnce(["test.json"])
+
+      // fileList['test-folder']['test.json']
+      Utils.readFileAsync.mockResolvedValueOnce(JSON.stringify({}))
+      SharedLib.FolderParser.getFolderData.mockReturnValueOnce({})
+      SharedLib.FolderParser.getTestCases.mockReturnValueOnce([])
+      
+      await expect(TemplateGenerator.generateTemplate(fileList)).resolves.toBeDefined()
+    })
+    it('when passing a folder with master file and selected labels, template should be generated', async () => {
+      const fileList = ['test-labels']
+      const selectedLabels = ["test"]
+      
+      // fileList['test-labels']
+      Utils.fileStatAsync.mockResolvedValueOnce({
+        isFile: () => false,
+        isDirectory: () => true
+      }) 
+      Utils.readRecursiveAsync.mockResolvedValueOnce(["test.json", "test2.json", "master.json"])
+      
+      // fileList['test-labels']['test.json']
+      Utils.readFileAsync.mockResolvedValueOnce(JSON.stringify({}))
+      SharedLib.FolderParser.getFolderData.mockReturnValueOnce({})
+      SharedLib.FolderParser.getTestCases.mockReturnValueOnce([])
+
+      // fileList['test-labels']['test2.json']
+      Utils.readFileAsync.mockResolvedValueOnce(JSON.stringify({}))
+      SharedLib.FolderParser.getFolderData.mockReturnValueOnce({})
+      SharedLib.FolderParser.getTestCases.mockReturnValueOnce()
+
+      // fileList['test-labels']['master.json']
+      Utils.readFileAsync.mockResolvedValueOnce(JSON.stringify({
+        order: [
+          {
+            name: "test.json",
+            type: "file",
+            labels: ["test"]
+          },
+          {
+            name: "test2.json",
+            type: "file"
+          }
+        ]
+      }))
+      
+      await expect(TemplateGenerator.generateTemplate(fileList, selectedLabels)).resolves.toBeDefined()
+    })
+    it('when a file can not be read, template should not be generated', async () => {
+      Utils.fileStatAsync
+        .mockResolvedValueOnce({
+          isFile: () => true
+        })
+      Utils.readFileAsync
+        .mockRejectedValueOnce({})
+      SharedLib.FolderParser.sequenceTestCases
+        .mockImplementationOnce(() => {
+          throw new Error("expected error")
+        })
+      
+      const fileList = ["test.json"]
+      await expect(TemplateGenerator.generateTemplate(fileList)).resolves.toBeDefined()
+    })
+  })
+})

package/test/unit/testcaseDefinitionReport-mode.test.js

@@ -0,0 +1,72 @@
+/*****
+ 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
+
+ * ModusBox
+ * Georgi Logodazhki <georgi.logodazhki@modusbox.com> (Original Author)
+ --------------
+ ******/
+'use strict'
+
+const spyReport = jest.spyOn(require('../../src/utils/report'), 'testcaseDefinition')
+const spyExit = jest.spyOn(process, 'exit')
+const spyReadFileAsync = jest.spyOn(require('../../src/utils/file-utils'), 'readFileAsync')
+const objectStore = require('../../src/objectStore')
+
+const testcaseDefinitionReport = require('../../src/modes/testcaseDefinitionReport')
+const spyGenerateTemplate = jest.spyOn(require('../../src/utils/templateGenerator'), 'generateTemplate')
+
+describe('Cli client', () => {
+  
+  describe('run testcaseDefinitionReport', () => {
+    it('when download is successful should not throw an error', async () => {
+      const config = {
+        inputFiles: "sample-cli.json",
+        labels: "p2p"
+      }
+      spyGenerateTemplate.mockResolvedValueOnce({
+        "test_cases": [
+          {
+            "requests": []
+          }
+        ]
+      })
+      objectStore.set('config', config)
+
+      spyReport.mockResolvedValueOnce({})
+      spyExit.mockReturnValueOnce({})
+      await expect(testcaseDefinitionReport.download()).resolves.toBe(undefined)
+    })
+    it('when download is not successful should throw an error', async () => {
+      spyReadFileAsync.mockResolvedValueOnce(JSON.stringify({
+        "inputValues": {}
+      }))
+      const config = {
+        inputFiles: "sample-cli.json",
+        environmentFile: "sample-environement.json"
+      }
+      spyGenerateTemplate.mockResolvedValueOnce({})
+
+      objectStore.set('config', config)
+
+      spyReport.mockRejectedValueOnce({})
+      spyExit.mockReturnValueOnce({})
+      await expect(testcaseDefinitionReport.download()).resolves.toBe(undefined)
+    })
+  })
+})

package/test/util/testConfig.js

@@ -0,0 +1,38 @@
+/*****
+ 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
+
+ * ModusBox
+ * Vijaya Kumar Guthi <vijaya.guthi@modusbox.com> (Original Author)
+ --------------
+ ******/
+
+const RC = require('parse-strings-in-object')(require('rc')('TOOLKIT', require('../../config/default.json')))
+const defaultConfig = require('../src/lib/config')
+
+/**
+ * testConfig extends ./src/lib/config.js with test-specific
+ * environment variable config
+ */
+
+module.exports = {
+  /* Test Config */
+  TEST_TOOLKIT_HOST: RC.TEST_TOOLKIT_HOST,
+
+  ...defaultConfig
+}