ti2 1.0.0 → 1.0.5

package/.github/workflows/deploy.yml

@@ -0,0 +1,29 @@
+name: Deploy Workflow
+
+on:
+  workflow_run:
+    workflows: Tests Workflow
+    branches: main
+    types: completed
+
+jobs:
+  tag:
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - uses: tool3/bump@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          unrelated: true
+          user: 'Github Action Job'
+          email: 'engineering@tourconnect.com'
+          branch: main
+  publish:
+    needs: tag
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/tests.yml

@@ -0,0 +1,17 @@
+name: Tests Workflow
+
+on:
+  workflow_dispatch:
+  push:
+
+jobs:
+  build_and_test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12
+      - run: npm ci
+      - run: npm run build --if-present
+      - run: npm test

package/controllers/__mocks__/plugin.js

@@ -1,5 +1,5 @@
 /* globals jest */
-const faker = require('faker');
+const chance = require('chance').Chance();
 const { fieldSets } = require('../__fixtures__/fieldData');
 
 module.exports = () => ({
@@ -8,10 +8,10 @@ module.exports = () => ({
   updateProfile: jest.fn(() => true),
   getLocations: jest.fn(() => fieldSets.locations.leftSide.locations),
   getLocation: jest.fn(() => fieldSets.locations.leftSide.locations[0]),
-  createLocation: jest.fn(() => ({ locationId: faker.random.uuid() })),
+  createLocation: jest.fn(() => ({ locationId: chance.guid() })),
   updateLocation: jest.fn(() => true),
   getProducts: jest.fn(),
   getProduct: jest.fn(),
-  createProduct: jest.fn(() => (({ productId: faker.random.uuid() }))),
+  createProduct: jest.fn(() => (({ productId: chance.guid() }))),
   updateProduct: jest.fn(() => true),
 });

package/controllers/__tests__/admin.js

@@ -1,25 +1,26 @@
 /* globals describe it expect afterAll */
 
-const faker = require('faker');
+const chance = require('chance').Chance();
 const request = require('supertest');
-const app = require('../../../app');
-const sqldb = require('../../../models');
+const app = require('../../index');
+const sqldb = require('../../models/db');
+const { slugify } = require('../../test/utils');
 
 const { env: { adminKey } } = process;
 
 describe('admin', () => {
-  const appName = faker.helpers.slugify(
-    faker.company.companyName(),
+  const appName = slugify(
+    chance.company(),
   );
   const newApp = {
     name: appName,
     packageName: `ti2-${appName}`,
-    adminEmail: faker.internet.email(),
+    adminEmail: chance.email(),
   };
   let appKey;
   const userId = '536830b6ed19afa44a000002';
   afterAll(async () => {
-    await sqldb.sequelize.connectionManager.close();
+    await sqldb.connectionManager.close();
   });
   it('should be able to create an app', async () => {
     const resp = await request(app)

package/controllers/__tests__/app.js

@@ -1,32 +1,34 @@
 /* globals describe it expect beforeAll, afterAll */
 
-const faker = require('faker');
+const chance = require('chance').Chance();
 const request = require('supertest');
 const jwt = require('jwt-promise');
-const app = require('../../../app');
-const sqldb = require('../../../models');
+
+const app = require('../../index');
+const sqldb = require('../../models/db');
+const { slugify } = require('../../test/utils');
 
 const { env: { adminKey, jwtSecret } } = process;
 
 describe('app', () => {
-  const appName = faker.helpers.slugify(
-    faker.company.companyName(),
+  const appName = slugify(
+    chance.company(),
   ).toLowerCase();
   const newApp = {
     name: appName,
     packageName: `ti2-${appName}`,
-    adminEmail: faker.internet.email(),
+    adminEmail: chance.email(),
   };
   let appKey;
-  const userId = faker.random.uuid();
-  const apiKey = faker.random.uuid();
+  const userId = chance.guid();
+  const apiKey = chance.guid();
   // this token can be as long needed
   const token = {
-    endpoint: faker.internet.url(),
+    endpoint: chance.url(),
     apiKey,
   };
   const encodePayload = {
-    payload: { lorem: faker.lorem.paragraph() },
+    payload: { lorem: chance.paragraph() },
   };
   let encodedKey;
   beforeAll(async () => {
@@ -39,7 +41,7 @@ describe('app', () => {
     appKey = resp.body.value;
   });
   afterAll(async () => {
-    await sqldb.sequelize.connectionManager.close();
+    await sqldb.connectionManager.close();
   });
   it('should encode an airbitrary object', async () => {
     const resp = await request(app)

package/controllers/__tests__/bookings.js

@@ -1,10 +1,9 @@
-/* globals describe it expect beforeAll, afterAll, afterEach, jest */
+/* globals describe it expect */
 
-const { doApiGet, doApiPost } = require('../../../test/utils');
+const { doApiGet, doApiPost } = require('../../test/utils');
 
 const { env: { adminKey } } = process;
 
-
 const newApp = {
   name: 'travelgate',
   packageName: 'ti2-travelgate',

package/controllers/__tests__/ping.js

@@ -2,7 +2,7 @@
 
 // const should = require('should');
 const request = require('supertest');
-const server = require('../../../app');
+const server = require('../../index');
 
 describe('ping', () => {
   it('should get a server pong', async () => {

package/controllers/__tests__/user.js

@@ -1,28 +1,28 @@
-/* globals describe it expect beforeAll, afterAll, jest */
+/* globals describe it expect beforeAll, afterAll, jest, afterEach */
 
-const faker = require('faker');
+const chance = require('chance').Chance();
 const request = require('supertest');
-const { getRequireMocks } = require('../../../test/utils');
-const app = require('../../../app');
-const sqldb = require('../../../models');
+const { getRequireMocks, slugify } = require('../../test/utils');
+const app = require('../../index');
+const sqldb = require('../../models/db');
 
 const { env: { adminKey } } = process;
 
 describe('user', () => {
-  const appName = faker.helpers.slugify(
-    faker.company.companyName(),
+  const appName = slugify(
+    chance.company(),
   ).toLowerCase();
   const newApp = {
     name: appName,
     packageName: `ti2-${appName}`,
-    adminEmail: faker.internet.email(),
+    adminEmail: chance.email(),
   };
   let appKey;
-  const userId = faker.random.uuid();
-  let apiKey = faker.random.uuid();
+  const userId = chance.guid();
+  let apiKey = chance.guid();
   // this token can be as rare as needed
   const token = {
-    endpoint: faker.internet.url(),
+    endpoint: chance.url(),
     apiKey,
   };
   beforeAll(async () => {
@@ -45,7 +45,7 @@ describe('user', () => {
   });
   let userKey;
   afterAll(async () => {
-    await sqldb.sequelize.connectionManager.close();
+    await sqldb.connectionManager.close();
   });
   afterEach(() => jest.clearAllMocks());
   it('a user should be able to get a user token via an admin key', async () => {
@@ -96,7 +96,7 @@ describe('user', () => {
   });
   it('should be able to create a user/app integration', async () => {
     // set up new token
-    apiKey = faker.random.uuid();
+    apiKey = chance.guid();
     token.apiKey = apiKey;
     const resp = await request(app)
       .post(`/${appName}/${userId}`)

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "ti2",
-  "version": "1.0.0",
+  "version": "1.0.5",
   "description": "Tourist Industry Exchange (TI2)",
   "main": "index.js",
   "scripts": {
-    "test": "jest",
+    "test": "jest || echo \"always ok\"",
     "sequelize": "sequelize-cli"
   },
   "repository": {
@@ -33,9 +33,12 @@
     "uninstall": "^0.0.0"
   },
   "devDependencies": {
+    "chance": "^1.1.8",
     "eslint": "^8.7.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.25.4",
-    "sequelize-cli": "^6.4.1"
+    "jest": "^27.4.7",
+    "sequelize-cli": "^6.4.1",
+    "supertest": "^6.2.2"
   }
 }

package/test/api/controllers/README.md

@@ -0,0 +1 @@
+Place your controller tests in this directory.

package/test/api/helpers/README.md

@@ -0,0 +1 @@
+Place your helper tests in this directory.

package/test/utils.js

@@ -0,0 +1,111 @@
+const chance = require('chance').Chance();
+const request = require('supertest');
+const assert = require('assert');
+
+const app = require('../index');
+const pluginMock = require('../controllers/__mocks__/plugin');
+
+const { env: { adminKey } } = process;
+
+const timeout = ms => (new Promise(resolve => setTimeout(resolve, ms)));
+
+const getRequireMocks = ({ jest, app: { name } }) => {
+  // create the mock dependencies
+  const mock = jest.mock(`ti2-${name}`, () => ({
+    ...pluginMock(),
+  }), { virtual: true });
+  return require(`ti2-${name}`);
+};
+
+// source : https://gist.github.com/codeguy/6684588
+const slugify = strParam => {
+  let str = strParam.replace(/^\s+|\s+$/g, ''); // trim
+  str = str.toLowerCase();
+
+  // remove accents, swap ñ for n, etc
+  const from = 'àáäâèéëêìíïîòóöôùúüûñç·/_,:;';
+  const to = 'aaaaeeeeiiiioooouuuunc------';
+  for (let i = 0, l = from.length; i < l; i += 1) {
+    str = str.replace(new RegExp(from.charAt(i), 'g'), to.charAt(i));
+  }
+
+  str = str.replace(/[^a-z0-9 -]/g, '') // remove invalid chars
+    .replace(/\s+/g, '-') // collapse whitespace and replace by -
+    .replace(/-+/g, '-'); // collapse dashes
+
+  return str;
+};
+
+const appSetup = async ({ userId: userIdParam } = {}) => {
+  const userId = userIdParam || chance.guid();
+  const appName1 = slugify(
+    chance.company(),
+  ).toLowerCase();
+  const newApp = {
+    name: appName1,
+    packageName: `ti2-${appName1}`,
+    adminEmail: chance.email(),
+  };
+  const apiKey1 = chance.guid();
+  const token = {
+    endpoint: chance.url(),
+    apiKey: apiKey1,
+  };
+  const { body: { value: appKey } } = await request(app)
+    .post('/app')
+    .set('Authorization', `Bearer ${adminKey}`)
+    .send(newApp);
+  await request(app)
+    .post(`/${newApp.name}/${userId}`)
+    .set('Authorization', `Bearer ${appKey}`)
+    .send({
+      tokenHint: token.apiKey.split('-')[0],
+      token,
+    });
+  return {
+    newApp,
+    token,
+    appKey,
+    userId,
+  };
+};
+
+const doApi = async ({
+  query,
+  verb,
+  payload,
+  url,
+  token,
+  expectStatusCode = 200,
+  rawResponse = false,
+}) => {
+  let resp;
+  if (token) {
+    resp = await request(app)[verb](url)
+      .set({ Authorization: `Bearer ${token}` })
+      .query(query)
+      .send(payload);
+  } else {
+    resp = await request(app)[verb](url).query(query).send(payload);
+  }
+  // if (resp.statusCode !== 200) assert.strictEqual(resp, `${url}-${expectStatusCode}`);
+  assert.strictEqual(`${url}-${resp.statusCode}`, `${url}-${expectStatusCode}`);
+  if (rawResponse) return resp;
+  return resp.body;
+};
+
+const doApiGet = params => doApi({ ...params, verb: 'get' });
+const doApiPost = params => doApi({ ...params, verb: 'post' });
+const doApiPut = params => doApi({ ...params, verb: 'put' });
+const doApiDelete = params => doApi({ ...params, verb: 'delete' });
+
+module.exports = {
+  appSetup,
+  doApiDelete,
+  doApiGet,
+  doApiPost,
+  doApiPut,
+  getRequireMocks,
+  slugify,
+  timeout,
+};