@natlibfi/melinda-rest-api-commons 4.2.3 → 4.2.4-alpha.12

package/tests/mongo-set-operation.spec.js

@@ -0,0 +1,92 @@
+//import {expect} from 'chai';
+import {READERS} from '@natlibfi/fixura';
+import mongoFixturesFactory from '@natlibfi/fixura-mongo';
+import generateTests from '@natlibfi/fixugen';
+import createDebugLogger from 'debug';
+//import {handleError, compareToFirstDbEntry, compareToDbEntry, formatQueueItem, streamToString} from './testUtils';
+import {getMongoOperator, handleError, compareToFirstDbEntry} from './testUtils';
+
+let mongoFixtures; // eslint-disable-line functional/no-let
+const debug = createDebugLogger('@natlibfi/melinda-rest-api-commons/mongo:set-operation:test');
+
+generateTests({
+  callback,
+  path: [__dirname, '..', 'test-fixtures', 'mongo', 'set-operation'],
+  recurse: false,
+  useMetadataFile: true,
+  fixura: {
+    failWhenNotFound: true,
+    reader: READERS.JSON
+  },
+  mocha: {
+    before: async () => {
+      //debug(`<< Before`);
+      await initMongofixtures();
+    },
+    beforeEach: async () => {
+      //debug(`<< BeforeEach`);
+      await mongoFixtures.clear();
+    },
+    afterEach: async () => {
+      //debug(`<< AfterEach`);
+      await mongoFixtures.clear();
+    },
+    after: async () => {
+      //debug(`<< After`);
+      await mongoFixtures.close();
+    }
+  }
+});
+
+async function initMongofixtures() {
+  mongoFixtures = await mongoFixturesFactory({
+    recurse: false,
+    rootPath: [__dirname, '..', 'test-fixtures', 'mongo', 'set-operation'],
+    gridFS: {bucketName: 'foobar'},
+    useObjectId: true
+  });
+}
+
+async function callback({
+  getFixture,
+  functionName,
+  params,
+  expectModificationTime = false,
+  preFillDb = false,
+  expectedToThrow = false,
+  expectedErrorMessage = '',
+  expectedErrorStatus = ''
+}) {
+
+  const mongoOperator = await getMongoOperator(mongoFixtures);
+  const expectedResult = await getFixture('expectedResult.json');
+
+  await doPreFillDb(preFillDb);
+
+  async function doPreFillDb(preFillDb) {
+    if (preFillDb) {
+      await mongoFixtures.populate(getFixture('dbContents.json'));
+      return;
+    }
+    return;
+  }
+
+  if (functionName === 'setOperation') {
+    try {
+      debug(`setOperation`);
+      debug(JSON.stringify(params));
+      //{correlationId, operation}
+      const opResult = await mongoOperator.setOperation(params);
+      debug(`setOperation result: ${JSON.stringify(opResult)}`);
+      await compareToFirstDbEntry({mongoFixtures, expectedResult, expectModificationTime, formatDates: true});
+
+    } catch (error) {
+      handleError({error, expectedToThrow, expectedErrorMessage, expectedErrorStatus});
+      return;
+    }
+    return;
+  }
+
+  throw new Error(`Unknown functionName: ${functionName}`);
+}
+

package/tests/mongo-set-operations.spec.js

@@ -0,0 +1,91 @@
+//import {expect} from 'chai';
+import {READERS} from '@natlibfi/fixura';
+import mongoFixturesFactory from '@natlibfi/fixura-mongo';
+import generateTests from '@natlibfi/fixugen';
+import createDebugLogger from 'debug';
+//import {handleError, compareToFirstDbEntry, compareToDbEntry, formatQueueItem, streamToString} from './testUtils';
+import {getMongoOperator, handleError, compareToFirstDbEntry} from './testUtils';
+
+let mongoFixtures; // eslint-disable-line functional/no-let
+const debug = createDebugLogger('@natlibfi/melinda-rest-api-commons/mongo:set-operations:test');
+
+generateTests({
+  callback,
+  path: [__dirname, '..', 'test-fixtures', 'mongo', 'set-operations'],
+  recurse: false,
+  useMetadataFile: true,
+  fixura: {
+    failWhenNotFound: true,
+    reader: READERS.JSON
+  },
+  mocha: {
+    before: async () => {
+      //debug(`<< Before`);
+      await initMongofixtures();
+    },
+    beforeEach: async () => {
+      //debug(`<< BeforeEach`);
+      await mongoFixtures.clear();
+    },
+    afterEach: async () => {
+      //debug(`<< AfterEach`);
+      await mongoFixtures.clear();
+    },
+    after: async () => {
+      //debug(`<< After`);
+      await mongoFixtures.close();
+    }
+  }
+});
+
+async function initMongofixtures() {
+  mongoFixtures = await mongoFixturesFactory({
+    recurse: false,
+    rootPath: [__dirname, '..', 'test-fixtures', 'mongo', 'set-operations'],
+    gridFS: {bucketName: 'foobar'},
+    useObjectId: true
+  });
+}
+
+async function callback({
+  getFixture,
+  functionName,
+  params,
+  expectModificationTime = false,
+  preFillDb = false,
+  expectedToThrow = false,
+  expectedErrorMessage = '',
+  expectedErrorStatus = ''
+}) {
+
+  const mongoOperator = await getMongoOperator(mongoFixtures);
+  const expectedResult = await getFixture('expectedResult.json');
+
+  await doPreFillDb(preFillDb);
+
+  async function doPreFillDb(preFillDb) {
+    if (preFillDb) {
+      await mongoFixtures.populate(getFixture('dbContents.json'));
+      return;
+    }
+    return;
+  }
+
+
+  if (functionName === 'setOperations') {
+    try {
+      debug(`setOperations`);
+      debug(JSON.stringify(params));
+      //{correlationId, addOperation, removeOperation = undefined}
+      const opResult = await mongoOperator.setOperations(params);
+      debug(`setOperations result: ${JSON.stringify(opResult)}`);
+      await compareToFirstDbEntry({mongoFixtures, expectedResult, expectModificationTime, formatDates: true});
+    } catch (error) {
+      handleError({error, expectedToThrow, expectedErrorMessage, expectedErrorStatus});
+      return;
+    }
+    return;
+  }
+  throw new Error(`Unknown functionName: ${functionName}`);
+}
+

package/tests/mongo-set-state.spec.js

@@ -0,0 +1,92 @@
+//import {expect} from 'chai';
+import {READERS} from '@natlibfi/fixura';
+import mongoFixturesFactory from '@natlibfi/fixura-mongo';
+import generateTests from '@natlibfi/fixugen';
+import createDebugLogger from 'debug';
+//import {handleError, compareToFirstDbEntry, compareToDbEntry, formatQueueItem, streamToString} from './testUtils';
+import {getMongoOperator, handleError, compareToFirstDbEntry} from './testUtils';
+
+
+let mongoFixtures; // eslint-disable-line functional/no-let
+const debug = createDebugLogger('@natlibfi/melinda-rest-api-commons/mongo:set-state:test');
+
+generateTests({
+  callback,
+  path: [__dirname, '..', 'test-fixtures', 'mongo', 'set-state'],
+  recurse: false,
+  useMetadataFile: true,
+  fixura: {
+    failWhenNotFound: true,
+    reader: READERS.JSON
+  },
+  mocha: {
+    before: async () => {
+      //debug(`<< Before`);
+      await initMongofixtures();
+    },
+    beforeEach: async () => {
+      //debug(`<< BeforeEach`);
+      await mongoFixtures.clear();
+    },
+    afterEach: async () => {
+      //debug(`<< AfterEach`);
+      await mongoFixtures.clear();
+    },
+    after: async () => {
+      //debug(`<< After`);
+      await mongoFixtures.close();
+    }
+  }
+});
+
+async function initMongofixtures() {
+  mongoFixtures = await mongoFixturesFactory({
+    recurse: false,
+    rootPath: [__dirname, '..', 'test-fixtures', 'mongo', 'set-state'],
+    gridFS: {bucketName: 'foobar'},
+    useObjectId: true
+  });
+}
+
+async function callback({
+  getFixture,
+  functionName,
+  params,
+  expectModificationTime = false,
+  preFillDb = false,
+  expectedToThrow = false,
+  expectedErrorMessage = '',
+  expectedErrorStatus = ''
+}) {
+
+  const mongoOperator = await getMongoOperator(mongoFixtures);
+  const expectedResult = await getFixture('expectedResult.json');
+
+  await doPreFillDb(preFillDb);
+
+  async function doPreFillDb(preFillDb) {
+    if (preFillDb) {
+      await mongoFixtures.populate(getFixture('dbContents.json'));
+      return;
+    }
+    return;
+  }
+
+
+  if (functionName === 'setState') {
+    try {
+      debug(`setState`);
+      debug(JSON.stringify(params));
+      //{correlationId, state, errorMessage = undefined, errorStatus = undefined}
+      const opResult = await mongoOperator.setState(params);
+      debug(`setState result: ${JSON.stringify(opResult)}`);
+      await compareToFirstDbEntry({mongoFixtures, expectedResult, expectModificationTime, formatDates: true});
+
+    } catch (error) {
+      handleError({error, expectedToThrow, expectedErrorMessage, expectedErrorStatus});
+      return;
+    }
+    return;
+  }
+  throw new Error(`Unknown functionName: ${functionName}`);
+}

package/{dist → tests}/mongoLog.spec.js

@@ -1,23 +1,20 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-var _fixura = require("@natlibfi/fixura");
-var _fixugen = _interopRequireDefault(require("@natlibfi/fixugen"));
-var _fixuraMongo = _interopRequireDefault(require("@natlibfi/fixura-mongo"));
-var _chai = require("chai");
-var _mongoLog = _interopRequireDefault(require("./mongoLog"));
 // import {expect} from 'chai';
+import {READERS} from '@natlibfi/fixura';
+import generateTests from '@natlibfi/fixugen';
+import mongoFixturesFactory from '@natlibfi/fixura-mongo';
+import {expect} from 'chai';
+import createMongoLogOperator from '../src/mongoLog';
 
 let mongoFixtures; // eslint-disable-line functional/no-let
 
-(0, _fixugen.default)({
+generateTests({
   callback,
   path: [__dirname, '..', 'test-fixtures', 'mongoLog'],
   recurse: false,
   useMetadataFile: true,
   fixura: {
     failWhenNotFound: true,
-    reader: _fixura.READERS.JSON
+    reader: READERS.JSON
   },
   mocha: {
     before: async () => {
@@ -30,12 +27,11 @@ let mongoFixtures; // eslint-disable-line functional/no-let
     }
   }
 });
+
 async function initMongofixtures() {
-  mongoFixtures = await (0, _fixuraMongo.default)({
+  mongoFixtures = await mongoFixturesFactory({
     rootPath: [__dirname, '..', 'test-fixtures', 'mongoLog'],
-    gridFS: {
-      bucketName: 'blobs'
-    },
+    gridFS: {bucketName: 'blobs'},
     useObjectId: true,
     format: {
       creationTime: v => new Date(v),
@@ -43,6 +39,7 @@ async function initMongofixtures() {
     }
   });
 }
+
 async function callback({
   getFixture,
   functionName,
@@ -50,36 +47,39 @@ async function callback({
   preFillDb = false
 }) {
   const mongoUri = await mongoFixtures.getUri();
-  const mongoLogOperator = await (0, _mongoLog.default)(mongoUri, '');
+  const mongoLogOperator = await createMongoLogOperator(mongoUri, '');
   const expectedResult = await getFixture('expectedResult.json');
   // console.log(typeof mongoUri); // eslint-disable-line
 
-  if (preFillDb) {
-    // eslint-disable-line functional/no-conditional-statements
+  if (preFillDb) { // eslint-disable-line functional/no-conditional-statements
     await mongoFixtures.populate(getFixture('dbContents.json'));
   }
+
   if (functionName === 'addLogItem') {
     await mongoLogOperator.addLogItem(params);
     const dump = await mongoFixtures.dump();
-    return (0, _chai.expect)(dump.logs[0]['0']).to.eql(expectedResult);
+    return expect(dump.logs[0]['0']).to.eql(expectedResult);
   }
+
   if (functionName === 'getListOfCatalogers') {
     const result = await mongoLogOperator.getListOfCatalogers();
     // console.log(result); // eslint-disable-line
 
-    return (0, _chai.expect)(result).to.eql(expectedResult);
+    return expect(result).to.eql(expectedResult);
   }
+
   if (functionName === 'getExpandedListOfLogs') {
     const result = await mongoLogOperator.getExpandedListOfLogs(params);
     // console.log(result); // eslint-disable-line
 
-    return (0, _chai.expect)(result).to.eql(expectedResult);
+    return expect(result).to.eql(expectedResult);
   }
+
   if (functionName === 'getListOfLogs') {
     const result = await mongoLogOperator.getListOfLogs(params);
     // console.log(result); // eslint-disable-line
-    return (0, _chai.expect)(result).to.eql(expectedResult);
+    return expect(result).to.eql(expectedResult);
   }
   throw new Error(`Unknown functionName: ${functionName}`);
 }
-//# sourceMappingURL=mongoLog.spec.js.map
+

package/tests/testUtils.js

@@ -0,0 +1,102 @@
+
+import {expect} from 'chai';
+import createDebugLogger from 'debug';
+import createMongoOperator from '../src/mongo';
+
+
+const debug = createDebugLogger('@natlibfi/melinda-rest-api-commons/mongo:test');
+
+export async function getMongoOperator(mongoFixtures) {
+  const mongoUri = await mongoFixtures.getUri();
+  const mongoOperator = await createMongoOperator(mongoUri, 'foobar', '');
+  return mongoOperator;
+}
+
+export async function compareToFirstDbEntry({mongoFixtures, expectedResult, expectModificationTime = false, formatDates = true, expectedFileCount = undefined}) {
+  const result = await compareToDbEntry({mongoFixtures, expectedResult, resultIndex: 0, expectModificationTime, formatDates, expectedFileCount});
+  return result;
+}
+
+export async function compareToDbEntry({mongoFixtures, expectedResult, resultIndex = 0, expectModificationTime = false, formatDates = true, expectedFileCount = undefined}) {
+  const dump = await mongoFixtures.dump();
+  debug(`--- We have ${dump.foobar.length} documents in db`);
+  debug(dump.foobar);
+  const result = await dump.foobar[resultIndex];
+  debug(`db result (document ${resultIndex}): ${JSON.stringify(result)}`);
+  const dump2 = await mongoFixtures.dump();
+  debug(`--- We have ${dump2.foobar.length} documents in db now`);
+
+  checkFileCount({dump, expectedFileCount});
+
+  checkModificationTime({result, expectModificationTime});
+
+  if (formatDates && expectedResult !== undefined) {
+    const formattedResult = formatQueueItem(result);
+    expect(formattedResult).to.eql(expectedResult);
+    return;
+  }
+  expect(result).to.eql(expectedResult);
+  return;
+}
+
+function checkFileCount({dump, expectedFileCount}) {
+  if (expectedFileCount !== undefined) {
+    const fileCount = dump['foobar.files']?.length;
+    debug(`--- We have ${fileCount} files in db`);
+    expect(fileCount).to.eql(expectedFileCount);
+    return;
+  }
+  return;
+
+}
+
+function checkModificationTime({result, expectModificationTime}) {
+  if (expectModificationTime) {
+    debug('Check if modificationTime was edited');
+    expect(result.modificationTime).to.not.eql('');
+    debug(`OK. We have modified modificationTime`);
+    return;
+  }
+  return;
+}
+
+
+export function formatQueueItem(queueItem) {
+  const filteredQueueItem = {
+    ...queueItem,
+    creationTime: '',
+    modificationTime: ''
+  };
+  debug(`Formatted result: ${JSON.stringify(filteredQueueItem)}`);
+  return filteredQueueItem;
+}
+
+export function handleError({error, expectedToThrow, expectedErrorMessage, expectedErrorStatus}) {
+  debug(error);
+  if (expectedToThrow) {
+    debug('OK. Expected to throw');
+    debug(JSON.stringify(error));
+    // eslint-disable-next-line max-lines
+    if (expectedErrorMessage !== '' || expectedErrorStatus !== '') {
+      const errorMessage = error.message || error.payload.message || error.payload || '';
+      debug(errorMessage);
+      expect(errorMessage).to.eql(expectedErrorMessage);
+      const errorStatus = error.status || '';
+      expect(errorStatus).to.eql(expectedErrorStatus);
+      return;
+    }
+    return;
+  }
+  debug('NOT OK. Not expexted to throw');
+  throw error;
+}
+
+export function streamToString(stream) {
+  const chunks = [];
+  return new Promise((resolve, reject) => {
+    // eslint-disable-next-line functional/immutable-data
+    stream.on('data', (chunk) => chunks.push(Buffer.from(chunk)));
+    stream.on('error', (err) => reject(err));
+    stream.on('end', () => resolve(Buffer.concat(chunks).toString('utf8')));
+  });
+}

package/dist/amqp.health.spec.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"amqp.health.spec.js","names":["_debug","_interopRequireDefault","require","_index","_util","debug","createDebugLogger","setTimeoutPromise","promisify","setTimeout","describe","it","amqpUrl","amqpOperator","amqpFactory","awaitTime","closeConnection","close","closeChannel"],"sources":["../src/amqp.health.spec.js"],"sourcesContent":["//import {expect} from 'chai';\nimport createDebugLogger from 'debug';\nimport {amqpFactory} from './index';\n\n\nconst debug = createDebugLogger('@natlibfi/melinda-rest-api-commons:amqp:test');\n//const debugData = debug.extend('data');\n\nimport {promisify} from 'util';\nconst setTimeoutPromise = promisify(setTimeout);\n\ndescribe('HealthCheck: amqpOperator should error if channel or connection fails', () => {\n\n  it('FIX: test healthCheck - this test does not really test anything, but error can be seen in debug!', async () => {\n    debug(`Testing amqp against a local AMQP instance - we'll need some kind of mockup for this`);\n    const amqpUrl = 'amqp://127.0.0.1:5672/';\n\n    const amqpOperator = await amqpFactory(amqpUrl, true);\n    debug(`Connecting to ${amqpUrl}, with healthCheck running`);\n    await awaitTime(amqpOperator, false);\n\n    debug(`Testing healthCheckLoop for ${amqpOperator}`);\n    debug(`Waiting 0.5s and expecting healthCheckLoop to work`);\n    await awaitTime(amqpOperator, false);\n    debug(`Amqp Operator should have been alive.`);\n\n    debug(`Testing healthCheckLoop with closed channel`);\n    debug(`Waiting 0.5s and expecting healthCheckLoop to throw error`);\n    await awaitTime(amqpOperator, true);\n    debug(`Amqp Operator should have been errored.`);\n\n    debug(`Closing connection`);\n    await amqpOperator.closeConnection();\n\n    async function awaitTime(amqpOperator, close) {\n      if (close) {\n        await amqpOperator.closeChannel();\n        await setTimeoutPromise(500);\n        return;\n      }\n\n      await setTimeoutPromise(500);\n      return;\n    }\n\n  });\n});\n\n"],"mappings":";;;AACA,IAAAA,MAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,MAAA,GAAAD,OAAA;AAMA,IAAAE,KAAA,GAAAF,OAAA;AARA;;AAKA,MAAMG,KAAK,GAAG,IAAAC,cAAiB,EAAC,8CAA8C,CAAC;AAC/E;;AAGA,MAAMC,iBAAiB,GAAG,IAAAC,eAAS,EAACC,UAAU,CAAC;AAE/CC,QAAQ,CAAC,uEAAuE,EAAE,MAAM;EAEtFC,EAAE,CAAC,kGAAkG,EAAE,YAAY;IACjHN,KAAK,CAAC,sFAAsF,CAAC;IAC7F,MAAMO,OAAO,GAAG,wBAAwB;IAExC,MAAMC,YAAY,GAAG,MAAM,IAAAC,kBAAW,EAACF,OAAO,EAAE,IAAI,CAAC;IACrDP,KAAK,CAAC,iBAAiBO,OAAO,4BAA4B,CAAC;IAC3D,MAAMG,SAAS,CAACF,YAAY,EAAE,KAAK,CAAC;IAEpCR,KAAK,CAAC,+BAA+BQ,YAAY,EAAE,CAAC;IACpDR,KAAK,CAAC,oDAAoD,CAAC;IAC3D,MAAMU,SAAS,CAACF,YAAY,EAAE,KAAK,CAAC;IACpCR,KAAK,CAAC,uCAAuC,CAAC;IAE9CA,KAAK,CAAC,6CAA6C,CAAC;IACpDA,KAAK,CAAC,2DAA2D,CAAC;IAClE,MAAMU,SAAS,CAACF,YAAY,EAAE,IAAI,CAAC;IACnCR,KAAK,CAAC,yCAAyC,CAAC;IAEhDA,KAAK,CAAC,oBAAoB,CAAC;IAC3B,MAAMQ,YAAY,CAACG,eAAe,CAAC,CAAC;IAEpC,eAAeD,SAASA,CAACF,YAAY,EAAEI,KAAK,EAAE;MAC5C,IAAIA,KAAK,EAAE;QACT,MAAMJ,YAAY,CAACK,YAAY,CAAC,CAAC;QACjC,MAAMX,iBAAiB,CAAC,GAAG,CAAC;QAC5B;MACF;MAEA,MAAMA,iBAAiB,CAAC,GAAG,CAAC;MAC5B;IACF;EAEF,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}