End to end testcase for mongoDb index policy (#426)

* 'update for index policy'

* input

* 'refactor for ci/cd'

* 'refactor for ci/cd'

* no message

* 'refractor'

* 'format change'

* added changes

* "refactor"

* ‘test lint’

* "format"

* “push setting back”

* ‘refractor’

* Update test/utils/shared.ts

Co-authored-by: Steve Faulkner <southpolesteve@gmail.com>

Co-authored-by: Srinath Narayanan <srnara@microsoft.com>
Co-authored-by: Steve Faulkner <southpolesteve@gmail.com>

.env.example

@@ -4,6 +4,8 @@ PORTAL_RUNNER_SUBSCRIPTION=
 PORTAL_RUNNER_RESOURCE_GROUP=
 PORTAL_RUNNER_DATABASE_ACCOUNT=
 PORTAL_RUNNER_DATABASE_ACCOUNT_KEY=
+PORTAL_RUNNER_MONGO_DATABASE_ACCOUNT=
+PORTAL_RUNNER_MONGO_DATABASE_ACCOUNT_KEY=
 PORTAL_RUNNER_CONNECTION_STRING=
 NOTEBOOKS_TEST_RUNNER_TENANT_ID=
 NOTEBOOKS_TEST_RUNNER_CLIENT_ID=

test/mongo/mongoIndexPolicy.spec.ts

@@ -0,0 +1,121 @@
+import "expect-puppeteer";
+import { getTestExplorerFrame } from "../testExplorer/TestExplorerUtils";
+import { createDatabase, onClickSaveButton } from "../utils/shared";
+import { generateUniqueName } from "../utils/shared";
+import { ApiKind } from "../../src/Contracts/DataModels";
+
+const LOADING_STATE_DELAY = 3000;
+const CREATE_DELAY = 5000;
+jest.setTimeout(300000);
+
+describe("MongoDB Index policy tests", () => {
+  it("Open, Create and Save Index", async () => {
+    try {
+      const singleFieldId = generateUniqueName("key");
+      const wildCardId = generateUniqueName("key") + "$**";
+      const frame = await getTestExplorerFrame(ApiKind.MongoDB);
+      const dropDown = "Index Type ";
+      let index = 0;
+
+      //open dataBaseMenu
+      await frame.waitForSelector('div[class="splashScreen"] > div[class="title"]', { visible: true });
+      await frame.waitFor(LOADING_STATE_DELAY);
+      await frame.waitForSelector('div[class="splashScreen"] > div[class="title"]', { visible: true });
+      let databases = await frame.$$(`div[class="databaseHeader main1 nodeItem "] > div[class="treeNodeHeader "]`);
+      if (databases.length === 0) {
+        await createDatabase(frame);
+        databases = await frame.$$(`div[class="databaseHeader main1 nodeItem "] > div[class="treeNodeHeader "]`);
+      }
+
+      const selectedDbId = await frame.evaluate((element) => {
+        return element.attributes["data-test"].textContent;
+      }, databases[0]);
+
+      // click on database
+      await frame.waitFor(`div[data-test="${selectedDbId}"]`);
+      await frame.waitFor(LOADING_STATE_DELAY);
+      await frame.click(`div[data-test="${selectedDbId}"]`);
+      await frame.waitFor(LOADING_STATE_DELAY);
+
+      // click on scale & setting
+      const containers = await frame.$$(
+        `div[class="nodeChildren"] > div[class="collectionHeader main2 nodeItem "]> div[class="treeNodeHeader "]`
+      );
+      const selectedContainer = await frame.evaluate((element) => {
+        return element.attributes["data-test"].textContent;
+      }, containers[0]);
+      await frame.waitFor(`div[data-test="${selectedContainer}"]`), { visible: true };
+      await frame.waitFor(LOADING_STATE_DELAY);
+      await frame.click(`div[data-test="${selectedContainer}"]`);
+
+      await frame.waitFor(`div[data-test="Scale & Settings"]`), { visible: true };
+      await frame.waitFor(LOADING_STATE_DELAY);
+      await frame.click(`div[data-test="Scale & Settings"]`);
+
+      await frame.waitFor(`button[data-content="Indexing Policy"]`), { visible: true };
+      await frame.waitFor(LOADING_STATE_DELAY);
+      await frame.click(`button[data-content="Indexing Policy"]`);
+
+      // Type to single Field
+      let throughput = await frame.$$(".ms-TextField-field");
+      const selectedDropDownSingleField = dropDown + index;
+      await frame.waitFor(`div[aria-label="${selectedDropDownSingleField}"]`), { visible: true };
+      await throughput[index].type(singleFieldId);
+      await frame.click(`div[aria-label="${selectedDropDownSingleField}"]`);
+      await frame.waitFor(LOADING_STATE_DELAY);
+      await frame.click(`button[title="Single Field"]`);
+      index++;
+
+      // Type to wild card
+      throughput = await frame.$$(".ms-TextField-field");
+      await throughput[index].type(wildCardId);
+      const selectedDropDownWildCard = dropDown + index;
+      await frame.waitFor(`div[aria-label="${selectedDropDownWildCard}"]`), { visible: true };
+      await frame.click(`div[aria-label="${selectedDropDownWildCard}"]`);
+      await frame.waitFor(LOADING_STATE_DELAY);
+      await frame.click(`button[title="Wildcard"]`);
+      index++;
+
+      // click save Button
+      await onClickSaveButton(frame);
+
+      // check the array
+      let singleFieldIndexInserted = false,
+        wildCardIndexInserted = false;
+      await frame.waitFor("div[data-automationid='DetailsRowCell'] > span"), { visible: true };
+
+      const elements = await frame.$$("div[data-automationid='DetailsRowCell'] > span");
+      for (let i = 0; i < elements.length; i++) {
+        const element = elements[i];
+        const text = await frame.evaluate((element) => element.textContent, element);
+        if (text.includes(wildCardId)) {
+          wildCardIndexInserted = true;
+        } else if (text.includes(singleFieldId)) {
+          singleFieldIndexInserted = true;
+        }
+      }
+      await frame.waitFor(LOADING_STATE_DELAY);
+      expect(wildCardIndexInserted).toBe(true);
+      expect(singleFieldIndexInserted).toBe(true);
+
+      //delete all index policy
+      await frame.waitFor("button[aria-label='Delete index Button']"), { visible: true };
+      const deleteButton = await frame.$$("button[aria-label='Delete index Button']");
+      for (let i = 0; i < deleteButton.length; i++) {
+        await frame.click(`button[aria-label="Delete index Button"]`);
+      }
+      await onClickSaveButton(frame);
+
+      //check for cleaning
+      await frame.waitFor(CREATE_DELAY);
+      await frame.waitFor("div[data-automationid='DetailsRowCell'] > span"), { visible: true };
+      const isDeletionComplete = await frame.$$("div[data-automationid='DetailsRowCell'] > span");
+      expect(isDeletionComplete).toHaveLength(2);
+    } catch (error) {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      const testName = (expect as any).getState().currentTestName;
+      await page.screenshot({ path: `Test Failed ${testName}.jpg` });
+      throw error;
+    }
+  });
+});

test/utils/shared.ts

@@ -1,6 +1,9 @@
 import crypto from "crypto";
 import { Frame } from "puppeteer";
 
+const LOADING_STATE_DELAY = 3000;
+const CREATE_DELAY = 10000;
+
 export async function login(connectionString: string): Promise<Frame> {
   const prodUrl = process.env.DATA_EXPLORER_ENDPOINT;
   await page.goto(prodUrl);
@@ -22,3 +25,49 @@ export async function login(connectionString: string): Promise<Frame> {
 export function generateUniqueName(baseName = "", length = 4): string {
   return `${baseName}${crypto.randomBytes(length).toString("hex")}`;
 }
+
+export async function createDatabase(frame: Frame) {
+  const dbId = generateUniqueName("db");
+  const collectionId = generateUniqueName("col");
+  const shardKey = generateUniqueName();
+  // create new collection
+  await frame.waitFor('button[data-test="New Collection"]', { visible: true });
+  await frame.click('button[data-test="New Collection"]');
+
+  // check new database
+  await frame.waitFor('input[data-test="addCollection-createNewDatabase"]');
+  await frame.click('input[data-test="addCollection-createNewDatabase"]');
+
+  // check shared throughput
+  await frame.waitFor('input[data-test="addCollectionPane-databaseSharedThroughput"]');
+  await frame.click('input[data-test="addCollectionPane-databaseSharedThroughput"]');
+
+  // type database id
+  await frame.waitFor('input[data-test="addCollection-newDatabaseId"]');
+  const dbInput = await frame.$('input[data-test="addCollection-newDatabaseId"]');
+  await dbInput.press("Backspace");
+  await dbInput.type(dbId);
+
+  // type collection id
+  await frame.waitFor('input[data-test="addCollection-collectionId"]');
+  const input = await frame.$('input[data-test="addCollection-collectionId"]');
+  await input.press("Backspace");
+  await input.type(collectionId);
+
+  // type partition key value
+  await frame.waitFor('input[data-test="addCollection-partitionKeyValue"]');
+  const keyInput = await frame.$('input[data-test="addCollection-partitionKeyValue"]');
+  await keyInput.press("Backspace");
+  await keyInput.type(shardKey);
+
+  // click submit
+  await frame.waitFor("#submitBtnAddCollection");
+  await frame.click("#submitBtnAddCollection");
+}
+
+export async function onClickSaveButton(frame: Frame) {
+  await frame.waitFor(`button[data-test="Save"]`), { visible: true };
+  await frame.waitFor(LOADING_STATE_DELAY);
+  await frame.click(`button[data-test="Save"]`);
+  await frame.waitFor(CREATE_DELAY);
+}