test automated testing with the library

Author: ThomasKranitsas

ReadMe.md

@@ -71,6 +71,7 @@ The following parameters can be set in config files or in env variables:
 - RESOURCE_DELETE_TOPIC: the resource delete Kafka topic, default value is 'challenge.action.resource.delete',
 - RESOURCE_ROLE_CREATE_TOPIC: the resource role create topic, default value is 'challenge.action.resource.role.create',
 - RESOURCE_ROLE_UPDATE_TOPIC: the resource role update topic, default value is 'challenge.action.resource.role.update'
+- AUTOMATED_TESTING_NAME_PREFIX: the role name prefix for every `ResourceRole` record
 
 Configuration for testing is at `config/test.js`, only add such new configurations different from `config/default.js`
 - WAIT_TIME: wait time used in test, default is 6000 or 6 seconds
@@ -84,8 +85,8 @@ Configuration for testing is at `config/test.js`, only add such new configuratio
 - COPILOT_CREDENTIALS_PASSWORD: The user's password with copilot role
 - USER_CREDENTIALS_USERNAME: The user's username with user role
 - USER_CREDENTIALS_PASSWORD: The user's password with user role
-- AUTOMATED_TESTING_NAME_PREFIX: the role name prefix for every `ResourceRole` record
-- MOCK_BUS_API_BY_NOCK: indicates whether Nock is used for mocking Bus API.
+- AUTOMATED_TESTING_REPORTERS_FORMAT: indicates reporters format. It is an array of the formats. e.g. `['html']` produces html format. `['cli', 'json', 'junit', 'html']` is the full format.   
+*For the details of the supported format, please refer to https://www.npmjs.com/package/newman#reporters*.
 
 ## Available commands
 - Install dependencies `npm install`

config/test.js

@@ -17,6 +17,5 @@ module.exports = {
   COPILOT_CREDENTIALS_PASSWORD: process.env.COPILOT_CREDENTIALS_PASSWORD || '',
   USER_CREDENTIALS_USERNAME: process.env.USER_CREDENTIALS_USERNAME || '',
   USER_CREDENTIALS_PASSWORD: process.env.USER_CREDENTIALS_PASSWORD || '',
-  AUTOMATED_TESTING_NAME_PREFIX: process.env.AUTOMATED_TESTING_NAME_PREFIX || 'POSTMANE2E-',
-  MOCK_BUS_API_BY_NOCK: process.env.MOCK_BUS_API_BY_NOCK ? process.env.MOCK_BUS_API_BY_NOCK === 'true' : true
+  AUTOMATED_TESTING_REPORTERS_FORMAT: process.env.AUTOMATED_TESTING_REPORTERS_FORMAT || ['cli', 'html']
 }

package.json

@@ -26,10 +26,10 @@
     "should": "^13.2.3",
     "mocha": "^5.2.0",
     "mocha-prepare": "^0.1.0",
-    "newman": "^5.2.2",
     "nyc": "^14.0.0",
     "standard": "^12.0.1",
-    "nock": "^10.0.6"
+    "nock": "^10.0.6",
+    "tc-api-testing-lib": "topcoder-platform/api-automated-testing.git"
   },
   "dependencies": {
     "aws-sdk": "^2.466.0",

test/postman/ClearPostmanData.md

@@ -37,11 +37,7 @@ info: Done!
 1. Setup the `AUTOMATED_TESTING_NAME_PREFIX` from the test environment. This prefix should be a name that will never be used 
 set as part of the role name. e.g. 'POSTMANE2E-'. In this case, the created `ResourceRole` will have a name like 'POSTMANE2E-submitter'.
 
-2. Choose either one solution for mocking the Bus API. We can not ignore this, becuase in production environment, it is 
-not allowed to send the Kafka messge to the Bus API.
-a. Set `MOCK_BUS_API_BY_NOCK` to `true` from the test environment. In this way, Nock will return the response if any events
-    is posted to the Bus API.
-b. You can use use Postman's mock server. You can refer to https://drive.google.com/file/d/1GXMzyqpzwix-LDBwieiRFfpJlJxrTIgI/view?usp=sharing
+2. You can use use Postman's mock server for the bus api. You can refer to https://drive.google.com/file/d/1GXMzyqpzwix-LDBwieiRFfpJlJxrTIgI/view?usp=sharing
    for details. You need to update the environment variable `BUSAPI_URL` to your Postman mock server.
 
 3. Steps of clearing the test data from Postman tests.

test/postman/envHelper.js

@@ -1,8 +1,7 @@
-const newman = require('newman')
-const _ = require('lodash')
-const envHelper = require('./envHelper')
-const nock = require('nock')
 const config = require('config')
+const apiTestLib = require('tc-api-testing-lib')
+const helper = require('../../src/common/helper')
+const logger = require('../../src/common/logger')
 
 const requests = [
   {
@@ -171,82 +170,27 @@ const requests = [
   }
 ]
 
-const options = {
-  collection: require('./resource-api.postman_collection.json'),
-  exportEnvironment: 'test/postman/resource-api.postman_environment.json',
-  reporters: 'cli'
-}
-const runner = (options) => new Promise((resolve, reject) => {
-  newman.run(options, function (err, results) {
-    if (err) {
-      reject(err)
-      return
-    }
-    resolve(results)
-  })
-})
-
 /**
- * Sleep for the given time
- * @param ms the miliseconds
- * @returns {Promise<unknown>}
+ * Clear the test data.
+ * @return {Promise<void>}
  */
-function sleep (ms) {
-  return new Promise(resolve => setTimeout(resolve, ms))
+async function clearTestData () {
+  logger.info('Clear the Postman test data.')
+  await helper.postRequest(`${config.API_BASE_URL}/${config.API_VERSION}/resources/internal/jobs/clean`)
+  logger.info('Finished clear the Postman test data.')
 }
 
 /**
- * Clean the Nock.
+ * Run the postman tests.
  */
-function cleanNock () {
-  if (config.MOCK_BUS_API_BY_NOCK) {
-    nock.cleanAll()
-  }
-}
-
-;(async () => {
-  const m2mToken = await envHelper.getM2MToken()
-  const adminToken = await envHelper.getAdminToken()
-  const copilotToken = await envHelper.getCopilotToken()
-  const userToken = await envHelper.getUserToken()
-  const originalEnvVars = [
-    { key: 'M2M_TOKEN', value: `${m2mToken}` },
-    { key: 'admin_token', value: `${adminToken}` },
-    { key: 'copilot_token', value: `${copilotToken}` },
-    { key: 'user_token', value: `${userToken}` }
-  ]
-  if (config.MOCK_BUS_API_BY_NOCK) {
-    nock(config.BUSAPI_URL)
-      .persist()
-      .post('/bus/events')
-      .reply(204)
-  }
-  for (const request of requests) {
-    options.envVar = [
-      ...originalEnvVars,
-      ..._.map(_.keys(request.iterationData || {}), key => ({ key, value: request.iterationData[key] }))
-    ]
-    delete require.cache[require.resolve('./resource-api.postman_environment.json')]
-    options.environment = require('./resource-api.postman_environment.json')
-    options.folder = request.folder
-    options.iterationData = request.iterationData
-    try {
-      const results = await runner(options)
-      if (_.get(results, 'run.failures.length', 0) > 0) {
-        cleanNock()
-        process.exit(-1)
-      }
-    } catch (err) {
-      console.log(err)
-    }
-    await sleep(config.WAIT_TIME)
-  }
-})().then(async () => {
-  cleanNock()
-  console.log('newman test completed!')
-  process.exit(0)
+apiTestLib.runTests(requests, require.resolve('./resource-api.postman_collection.json'),
+  require.resolve('./resource-api.postman_environment.json')).then(async () => {
+  logger.info('newman test completed!')
+  await clearTestData()
 }).catch(async (err) => {
-  cleanNock()
-  console.log(err)
-  process.exit(1)
+  logger.logFullError(err)
+  // Only calling the clean up function when it is not validation error.
+  if (err.name !== 'ValidationError') {
+    await clearTestData()
+  }
 })