Integrate with the automated API testing framework

.gitignore

@@ -9,6 +9,7 @@ logs
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+newman/
 
 # Runtime data
 pids

README.md

@@ -49,6 +49,37 @@ The following parameters can be set in config files or in env variables:
 - App will be running at `http://localhost:3000`
 - Application can be run in development mode using the command `npm run dev`
 
+## Running tests
+
+### Configuration
+
+Test configuration is at `config/test.js`. You don't need to change them.
+
+The following test parameters can be set in config file or in env variables:
+
+- AUTH_V2_URL: The auth v2 url
+- AUTH_V2_CLIENT_ID: The auth v2 client id
+- AUTH_V3_URL: The auth v3 url
+- ADMIN_CREDENTIALS_USERNAME: The user's username with admin role
+- ADMIN_CREDENTIALS_PASSWORD: The user's password with admin role
+- USER_CREDENTIALS_USERNAME: The user's username with user role
+- USER_CREDENTIALS_PASSWORD: The user's password with user role
+
+### Prepare
+
+- Start Local Neo4j.
+- Various config parameters should be properly set.
+
+### Running E2E tests with Postman
+
+`Start` the app server before running e2e tests. You may need to set the env variables by calling `source env.sh` before calling `NODE_ENV=test npm start`.
+
+To run postman e2e tests run:
+
+```bash
+npm run test:newman
+```
+
 ## Heroku deployment
 - git init
 - git add .

config/default.js

@@ -1,15 +1,15 @@
 /**
  * The configuration file.
  */
-
+require('dotenv').config()
 module.exports = {
   LOG_LEVEL: process.env.LOG_LEVEL || 'debug',
   PORT: process.env.PORT || 3000,
   // it is configured to be empty at present, but may add prefix like '/api/v5'
   API_PREFIX: process.env.API_PREFIX || '',
   GRAPH_DB_URI: process.env.GRAPH_DB_URI || process.env.GRAPHENEDB_BOLT_URL || 'bolt://localhost:7687',
   GRAPH_DB_USER: process.env.GRAPH_DB_USER || process.env.GRAPHENEDB_BOLT_USER || 'neo4j',
-  GRAPH_DB_PASSWORD: process.env.GRAPH_DB_PASSWORD || process.env.GRAPHENEDB_BOLT_PASSWORD || '123456',
+  GRAPH_DB_PASSWORD: process.env.GRAPH_DB_PASSWORD || process.env.GRAPHENEDB_BOLT_PASSWORD || 'password',
   AUTH_SECRET: process.env.AUTH_SECRET || 'mysecret',
   VALID_ISSUERS: process.env.VALID_ISSUERS
     ? process.env.VALID_ISSUERS.replace(/\\"/g, '')
@@ -52,5 +52,7 @@ module.exports = {
   MEMBERSHIP_TYPES: {
     Group: 'group',
     User: 'user'
-  }
+  },
+
+  AUTOMATED_TESTING_NAME_PREFIX: process.env.AUTOMATED_TESTING_NAME_PREFIX || 'POSTMANE2E-'
 }

config/test.js

@@ -0,0 +1,17 @@
+/**
+ * The configuration file.
+ */
+
+module.exports = {
+  WAIT_TIME: 10,
+  AUTH_V2_URL: process.env.AUTH_V2_URL || 'https://topcoder-dev.auth0.com/oauth/ro',
+  AUTH_V2_CLIENT_ID: process.env.AUTH_V2_CLIENT_ID || '',
+  AUTH_V3_URL: process.env.AUTH_V3_URL || 'https://api.topcoder-dev.com/v3/authorizations',
+  ADMIN_CREDENTIALS_USERNAME: process.env.ADMIN_CREDENTIALS_USERNAME || '',
+  ADMIN_CREDENTIALS_PASSWORD: process.env.ADMIN_CREDENTIALS_PASSWORD || '',
+  USER_CREDENTIALS_USERNAME: process.env.USER_CREDENTIALS_USERNAME || '',
+  USER_CREDENTIALS_PASSWORD: process.env.USER_CREDENTIALS_PASSWORD || '',
+  COPILOT_CREDENTIALS_USERNAME: process.env.COPILOT_CREDENTIALS_USERNAME || '',
+  COPILOT_CREDENTIALS_PASSWORD: process.env.COPILOT_CREDENTIALS_PASSWORD || '',
+  AUTOMATED_TESTING_REPORTERS_FORMAT: process.env.AUTOMATED_TESTING_REPORTERS_FORMAT || ['cli', 'html']
+}

env.sh

@@ -0,0 +1,21 @@
+#!/bin/sh
+
+export AUTH0_CLIENT_ID=
+
+export AUTH0_CLIENT_SECRET=
+
+export AUTH0_AUDIENCE=
+
+export AUTH_V2_URL=
+
+export AUTH_V2_CLIENT_ID=
+
+export AUTH_V3_URL=
+
+export ADMIN_CREDENTIALS_USERNAME=
+
+export ADMIN_CREDENTIALS_PASSWORD=
+
+export USER_CREDENTIALS_USERNAME=
+
+export USER_CREDENTIALS_PASSWORD=