ensure-index unit testing

supports one index (jobId_1_accountId_1_time_1)

Author: rotem-codefresh

2021-08-17-2021-08-17-logs.json

@@ -7,14 +7,14 @@ const command = new Command({
   command: "ensure-index",
   parent: cmd,
   description:
-    "Checks whether a collection has an index and gives the user an option to add one. Adding an index may improve performance in some of the app operations.",
+    "Checks whether a collection has indexes and gives the user an option to add them. Adding an index may improve performance of some of the read operations.",
   webDocs: {
     category: "Logs",
-    title: "Ensures one or more offline-logs collections has an index",
+    title: "Ensures one or more offline-logs collections has indexes",
   },
   builder: (yargs) =>
     yargs.example(
-      'codefresh offline-logs ensure-index --uri "mongodb://192.168.99.100:27017" --db logs -c logs'
+      'codefresh offline-logs ensure-index --uri "mongodb://192.168.99.100:27017" --db logs'
     ),
   handler: async (argv) => {
     const { uri, db } = argv;

2021-08-17-2021-08-17-metadata.json

@@ -1,16 +1,77 @@
-const {Db, Collection} = require('mongodb');
+// const {Db, Collection} = require('mongodb');
 const { Collection } = require('yaml/types');
-const { ensureIndex } = require('./utils')
+const utils = require('./utils')
 
 describe("ensure-index", () => {
   describe("ensureIndex", () => {
-    it("gets user input from prompt and returns true/false", () => {
-      Db.collection() = jest.fn();
-      Collection.createIndexes() = jest.fn()
+    utils.getUserInput = jest.fn()
+    const mockCollection = {
+      indexExists: jest.fn(),
+      estimatedDocumentCount: jest.fn().mockReturnValue(700),
+      createIndex: jest.fn(),
+    };
+    const mockDatabase = {
+      collection() {
+        return mockCollection;
+      },
+    };
 
-      const database = new Db('db');
+    beforeEach(() => {
+      mockCollection.indexExists.mockClear();
+      mockCollection.estimatedDocumentCount.mockClear();
+      mockCollection.createIndex.mockClear();
+      utils.getUserInput.mockClear();
+    });
+
+    it("index does not exists and user says yes on prompt", async () => {
+      //setup
+      mockCollection.indexExists.mockReturnValue(false);
+      utils.getUserInput.mockReturnValue(true);
+      const collection = 'whatever';
+      const expectedIndexObj = { jobId: 1, accountId: 1, time: 1 }
+
+      //execute
+      await utils.ensureIndex(mockDatabase, collection);
+
+      //check
+      expect(mockCollection.indexExists).toBeCalledTimes(1);
+      expect(mockCollection.indexExists).toBeCalledWith("jobId_1_accountId_1_time_1");
+      expect(mockCollection.estimatedDocumentCount).toBeCalledTimes(1);
+      expect(utils.getUserInput).toBeCalledTimes(1);
+      expect(mockCollection.createIndex).toBeCalledTimes(1);
+      expect(mockCollection.createIndex).toBeCalledWith(expectedIndexObj)
+      });
+    it("index does not exists and user says no on prompt", async () => {
+      //setup
+      mockCollection.indexExists.mockReturnValue(false);
+      utils.getUserInput.mockReturnValue(false);
       const collection = 'whatever';
-      ensureIndex(database, collection);
+
+      //execute
+      await utils.ensureIndex(mockDatabase, collection);
+
+      //check
+      expect(mockCollection.indexExists).toBeCalledTimes(1);
+      expect(mockCollection.indexExists).toBeCalledWith("jobId_1_accountId_1_time_1");
+      expect(mockCollection.estimatedDocumentCount).toBeCalledTimes(1);
+      expect(utils.getUserInput).toBeCalledTimes(1);
+      expect(mockCollection.createIndex).toBeCalledTimes(0);
+      });
+    it("index exists", async () => {
+      //setup
+      mockCollection.indexExists.mockReturnValue(true);
+      const collection = 'whatever';
+
+      //execute
+      await utils.ensureIndex(mockDatabase, collection);
+
+      //check
+      expect(mockCollection.indexExists).toBeCalledTimes(1);
+      expect(mockCollection.indexExists).toBeCalledWith("jobId_1_accountId_1_time_1");
+      expect(mockCollection.estimatedDocumentCount).toBeCalledTimes(0);
+      expect(utils.getUserInput).toBeCalledTimes(0);
+      expect(mockCollection.createIndex).toBeCalledTimes(0);
       });
+      
     });
   });

lib/interface/cli/commands/offline-logs/ensure-index.cmd.js

@@ -32,20 +32,16 @@ const writeLogsToFile = function (
 const checkRemnant = function (lowerBound, cutoffDateObj) {
   return Math.ceil(cutoffDateObj.diff(lowerBound, "days"));
 };
-
+///////////////////////////////////////////////////////////////
 const ensureIndex = async function (database, collection) {
   const collectionObj = database.collection(collection);
-  const indexName1 = "jobId_1_accountId_1";
-  const indexName2 = "jobId_1_accountId_1_time_1";
+  const indexName = "jobId_1_accountId_1_time_1";
 
-  const indexesExists = await Promise.all([
-    collectionObj.indexExists(indexName1),
-    collectionObj.indexExists(indexName2),
-  ]);
+  const indexExist = await collectionObj.indexExists(indexName)
 
-  if (indexesExists[0] === true && indexesExists[1] === true) {
+  if (indexExist) {
     console.info(
-      `indexes '${indexName1}', '${indexName2}' already exists in collection ${collection}`
+      `index '${indexName}' already exists in collection '${collection}'`
     );
     return;
   }
@@ -56,19 +52,18 @@ const ensureIndex = async function (database, collection) {
     do you want to create an index for it? (creating an index for a large collection may take a while, 
     but can improve performance on future read operations) [yes/no] `;
 
-  const userInput = await getUserInput(queryStr);
+  const userInput = await this.getUserInput(queryStr);
 
   if (!userInput) {
     console.info(`skipping collection '${collection}'`);
     return;
   }
 
-  await collectionObj.createIndexes([
-    { key: { jobId: 1, accountId: 1 } },
-    { key: { jobId: 1, accountId: 1, time: 1 } },
-  ]);
+  await collectionObj.createIndex(
+    { jobId: 1, accountId: 1, time: 1 },
+  );
   console.info(
-    `indexes were created for collection '${collection}'`
+    `index was created for collection '${collection}'`
   );
 };