move individual feature importance tests for text dashboard to common…

… e2e package folder to re-use for unit and notebook tests (microsoft#2299)
imatiach-msft · Aug 31, 2023 · efbc451 · efbc451
1 parent ffa1acb
commit efbc451
Show file tree

Hide file tree

Showing 15 changed files with 59 additions and 21 deletions.
diff --git a/apps/dashboard-e2e/src/describer/interpretText/interpretTextDatasets.ts b/apps/dashboard-e2e/src/describer/interpretText/interpretTextDatasets.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { IInterpretTextData } from "./IInterpretTextData";
+import { IInterpretTextData } from "@responsible-ai/e2e";
 
 const interpretTextDatasets = {
   newsgroupBinaryData: {

diff --git a/...e/src/integration/interpret-text/newsgroupsBinaryData/individualFeatureImportance.spec.ts b/...e/src/integration/interpret-text/newsgroupsBinaryData/individualFeatureImportance.spec.ts
@@ -1,6 +1,11 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { describeIndividualFeatureImportance } from "../../../describer/interpretText/individualFeatureImportance/describeIndividualFeatureImportance";
+import { describeTextIndividualFeatureImportance } from "@responsible-ai/e2e";
 
-describeIndividualFeatureImportance("newsgroupBinaryData");
+import { interpretTextDatasets } from "../../../../src/describer/interpretText/interpretTextDatasets";
+
+describeTextIndividualFeatureImportance(
+  "newsgroupBinaryData",
+  interpretTextDatasets.newsgroupBinaryData
+);
diff --git a/libs/e2e/src/index.ts b/libs/e2e/src/index.ts
@@ -1,6 +1,8 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+export * from "./lib/describer/interpretText/IInterpretTextData";
+export * from "./lib/describer/interpretText/individualFeatureImportance/describeTextIndividualFeatureImportance";
 export * from "./lib/describer/modelAssessment/featureImportances/aggregateFeatureImportance/describeAggregateFeatureImportance";
 export * from "./lib/describer/modelAssessment/causalAnalysis/describeCausalAnalysis";
 export * from "./lib/describer/modelAssessment/dataBalance/describeDataBalance";

diff --git a/libs/e2e/src/lib/describer/interpretText/Constants.ts b/libs/e2e/src/lib/describer/interpretText/Constants.ts
@@ -0,0 +1,12 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+export enum Locators {
+  ClassImportanceWeights = "#ClassImportanceWeights",
+  TextChoiceGroup = "#TextChoiceGroup",
+  TextFeatureLegend = "#TextFeatureLegend",
+  TextHighlighting = "#TextHighlighting",
+  TextExplanationChart = "#TextExplanationChart",
+  TextTopKSlider = "#TextTopKSlider",
+  TextWordsDropdown = "#ClassImportanceWeights div.ms-Dropdown-container"
+}
diff --git a/...riber/interpretText/IInterpretTextData.ts → ...riber/interpretText/IInterpretTextData.ts b/...riber/interpretText/IInterpretTextData.ts → ...riber/interpretText/IInterpretTextData.ts
diff --git a/libs/e2e/src/lib/describer/interpretText/dropdown.ts b/libs/e2e/src/lib/describer/interpretText/dropdown.ts
@@ -0,0 +1,19 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+export function selectDropdown(
+  selector: string,
+  item: string | number
+): Cypress.Chainable<JQuery<HTMLElement>> {
+  cy.get(selector).eq(0).click();
+  return cy
+    .get(".ms-Callout")
+    .should("be.visible")
+    .get(".ms-Dropdown-optionText")
+    .contains(item)
+    .click();
+}
+
+export function getDropdownValue(selector: string): string | undefined {
+  return cy.$$(`${selector} .ms-Dropdown-title`).text();
+}
diff --git a/...board-e2e/src/util/getDefaultTopKWords.ts → ...iber/interpretText/getDefaultTopKWords.ts b/...board-e2e/src/util/getDefaultTopKWords.ts → ...iber/interpretText/getDefaultTopKWords.ts
diff --git a/...dualFeatureImportance/describeBarChart.ts → ...dualFeatureImportance/describeBarChart.ts b/...dualFeatureImportance/describeBarChart.ts → ...dualFeatureImportance/describeBarChart.ts
@@ -1,12 +1,12 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { Locators } from "../../../util/Constants";
+import { Locators } from "../Constants";
 import {
   checkNumBars,
   checkYAxisLabel,
   checkNumLabels
-} from "../../../util/validateBarChart";
+} from "../validateBarChart";
 
 export function describeBarChart(expectedNumValues: number): void {
   describe("Sub bar chart", () => {

diff --git a/...describeClassImportanceWeightsDropdown.ts → ...describeClassImportanceWeightsDropdown.ts b/...describeClassImportanceWeightsDropdown.ts → ...describeClassImportanceWeightsDropdown.ts
@@ -1,11 +1,11 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { Locators } from "../../../util/Constants";
-import { selectDropdown, getDropdownValue } from "../../../util/dropdown";
-import { getDefaultTopKWords } from "../../../util/getDefaultTopKWords";
-import { validateBarChart } from "../../../util/validateBarChart";
+import { Locators } from "../Constants";
+import { selectDropdown, getDropdownValue } from "../dropdown";
+import { getDefaultTopKWords } from "../getDefaultTopKWords";
 import { IInterpretTextData } from "../IInterpretTextData";
+import { validateBarChart } from "../validateBarChart";
 
 function validateTextBarChart(expectedNumValues: number): void {
   validateBarChart(Locators.TextExplanationChart, expectedNumValues);

diff --git a/...vidualFeatureImportance/describeLegend.ts → ...vidualFeatureImportance/describeLegend.ts b/...vidualFeatureImportance/describeLegend.ts → ...vidualFeatureImportance/describeLegend.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { Locators } from "../../../util/Constants";
+import { Locators } from "../Constants";
 
 export function describeLegend(): void {
   describe("Legend", () => {

diff --git a/...cribeRadioButtonFeatureWeightsSelector.ts → ...cribeRadioButtonFeatureWeightsSelector.ts b/...cribeRadioButtonFeatureWeightsSelector.ts → ...cribeRadioButtonFeatureWeightsSelector.ts
@@ -1,8 +1,8 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { Locators } from "../../../util/Constants";
-import { validateBarChart } from "../../../util/validateBarChart";
+import { Locators } from "../Constants";
+import { validateBarChart } from "../validateBarChart";
 
 function validateTextBarChart(expectedNumValues: number): void {
   validateBarChart(Locators.TextExplanationChart, expectedNumValues);

diff --git a/...vidualFeatureImportance/describeSlider.ts → ...vidualFeatureImportance/describeSlider.ts b/...vidualFeatureImportance/describeSlider.ts → ...vidualFeatureImportance/describeSlider.ts
@@ -1,10 +1,10 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { Locators } from "../../../util/Constants";
-import { getDefaultTopKWords } from "../../../util/getDefaultTopKWords";
-import { validateBarChart } from "../../../util/validateBarChart";
+import { Locators } from "../Constants";
+import { getDefaultTopKWords } from "../getDefaultTopKWords";
 import { IInterpretTextData } from "../IInterpretTextData";
+import { validateBarChart } from "../validateBarChart";
 
 function getSlider(): Cypress.Chainable<JQuery<HTMLElement>> {
   return cy.get(`${Locators.TextTopKSlider} .ms-Slider-slideBox`);

diff --git a/...ureImportance/describeTextHighlighting.ts → ...ureImportance/describeTextHighlighting.ts b/...ureImportance/describeTextHighlighting.ts → ...ureImportance/describeTextHighlighting.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { Locators } from "../../../util/Constants";
+import { Locators } from "../Constants";
 import { IInterpretTextData } from "../IInterpretTextData";
 
 export function describeTextHighlighting(dataShape: IInterpretTextData): void {

diff --git a/...ce/describeIndividualFeatureImportance.ts → ...escribeTextIndividualFeatureImportance.ts b/...ce/describeIndividualFeatureImportance.ts → ...escribeTextIndividualFeatureImportance.ts
@@ -1,8 +1,8 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { getDefaultTopKWords } from "../../../util/getDefaultTopKWords";
-import { interpretTextDatasets } from "../interpretTextDatasets";
+import { getDefaultTopKWords } from "../getDefaultTopKWords";
+import { IInterpretTextData } from "../IInterpretTextData";
 
 import { describeBarChart } from "./describeBarChart";
 import { describeClassImportanceWeightsDropdown } from "./describeClassImportanceWeightsDropdown";
@@ -13,10 +13,10 @@ import { describeTextHighlighting } from "./describeTextHighlighting";
 
 const testName = "Individual feature importance";
 
-export function describeIndividualFeatureImportance(
-  name: keyof typeof interpretTextDatasets
+export function describeTextIndividualFeatureImportance(
+  name: string,
+  datasetShape: IInterpretTextData
 ): void {
-  const datasetShape = interpretTextDatasets[name];
   describe(testName, () => {
     before(() => {
       cy.visit(`#/interpretText/${name}/light/english/Version-1`);

diff --git a/...ashboard-e2e/src/util/validateBarChart.ts → ...scriber/interpretText/validateBarChart.ts b/...ashboard-e2e/src/util/validateBarChart.ts → ...scriber/interpretText/validateBarChart.ts