PromucFlow_constructor/app/client/cypress/support/queryCommands.js
Aishwarya-U-R 7a18d4ac4c
test: Cypress | Flaky fixes + Replacing static waits (#30067)
## Description
- This PR includes the flaky fixes of the below specs:
- jsEditor.NavigateToNewJSEditor() using TS helpers (Addressing
flakyness in specs /BugTests/JS_Bug29131_spec.ts,
BugTests/invalidLintError_Spec.ts,
ClientSide/BugTests/JS_Bug28764_Spec.ts,
/ClientSide/BugTests/Bug29566_Spec.ts,
ServerSide/JsFunctionExecution/JSFunctionExecution_spec.ts)
- /Widgets/ListV2/Listv2_onItemClick_spec.js (toast validation updated
to ts helper)
           - /Apps/MongoDBShoppingCart_spec.ts (Flaky fix 2nd case)
           - /Regression/Apps/PromisesApp_spec.js (1st test)
- /ClientSide/OtherUIFeatures/ApplicationURL_spec.js (whole spec for
static wait removal + flaky fixes)
- /ClientSide/Templates/Fork_Template_spec.js (complete spec fixes,
cypress exception fix)
           - /Sanity/Datasources/Arango_Basic_Spec.ts (3rd test)
- /ServerSide/OnLoadTests/JSOnLoad2_Spec.ts (8th case flaky fix)
- /ClientSide/MobileResponsiveTests/AutoFillWidgets_Reflow_spec.ts (2nd
testcase, flow update)
           - /ClientSide/OtherUIFeatures/Resize_spec.js (import update)
- /ClientSide/Templates/Fork_Template_spec.js (1st & 3rd for flaky fix,
removed 2nd - redundant check)
- /Git/GitSync/RepoLimitExceededErrorModal_spec.js flaky fix for EE repo
failure
- /ServerSide/ApiTests/API_Bugs_Spec.js (3rd case, removed waits, moved
to TED Api)
           - /Apps/EchoApiCMS_spec.js (removed redundant action)
- /AppNavigation/Sidebar_spec.ts, /AppNavigation/TopInline_spec.ts,
/AppNavigation/TopStacked_spec.ts - added refresh calls for CI flakyness
- homePage.RenameWorkspace() & homePage.NavigateToHome() &
homePage.Signout() - removed static wait, added dynamic check
- homePage.CreateNewApplication() - removed static wait
- homePage.CreateAppInWorkspace() - removed commented code
- homePage.CreateNewWorkspace() - logic improved
- agHelper.AssertURL() - added timeout, removed static wait, calling
assertHelper.AssertDocumentReady()
- Few of agHelper methods timeout & error mesg text update
- cy.Signup() - updated validations
- agHelper.CheckForErrorToast() to agHelper.FailIfErrorToast() - method
name
- /ClientSide/BugTests/DSDiscardBugs_spec.ts - removed unnecessary
method call

#### Type of change
- Script fix (non-breaking change which fixes an issue)

## Testing
#### How Has This Been Tested?
- [X] Cypress CI runs

## Checklist:
#### QA activity:
- [X] Added `Test Plan Approved` label after all changes were reviewed

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Refactor**
- Enhanced timeout handling across various helper methods for improved
stability.
- Streamlined interactions with UI elements using updated helper
methods.
- Adjusted test suites to utilize configuration values for consistency.

- **Tests**
  - Temporarily disabled specific test suites to address current issues.
- Updated test assertions and interaction patterns for clarity and
reliability.
- Added new test cases and assertions to cover additional
functionalities.

- **Chores**
  - Updated workflow variables for more efficient CI processes.
- Curated the list of limited tests to focus on critical test scenarios.

- **Documentation**
  - Clarified test descriptions and intentions for better understanding.

- **Bug Fixes**
- Fixed UI element interactions to prevent test flakiness and improve
user experience.
- Implemented page refresh before application imports to ensure clean
state for tests.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2024-01-12 12:00:12 +05:30

243 lines
7.3 KiB
JavaScript

/* eslint-disable cypress/no-unnecessary-waiting */
/* eslint-disable cypress/no-assigning-return-values */
import { ObjectsRegistry } from "../support/Objects/Registry";
import EditorNavigation, { EntityType } from "./Pages/EditorNavigation";
require("cy-verify-downloads").addCustomCommand();
require("cypress-file-upload");
const jsEditorLocators = require("../locators/JSEditor.json");
const datasourceEditor = require("../locators/DatasourcesEditor.json");
const datasourceFormData = require("../fixtures/datasources.json");
const queryEditor = require("../locators/QueryEditor.json");
const apiwidget = require("../locators/apiWidgetslocator.json");
const datasource = require("../locators/DatasourcesEditor.json");
const formControls = require("../locators/FormControl.json");
const { AggregateHelper, PropertyPane } = ObjectsRegistry;
export const initLocalstorage = () => {
cy.window().then((window) => {
window.localStorage.setItem("ShowCommentsButtonToolTip", "");
window.localStorage.setItem("updateDismissed", "true");
});
};
Cypress.Commands.add("NavigateToDSGeneratePage", (datasourceName) => {
EditorNavigation.SelectEntityByName(datasourceName, EntityType.Datasource);
cy.get(datasource.datasourceCardGeneratePageBtn).click();
cy.wait(2000); //for the specified page to load
});
Cypress.Commands.add("ClickGotIt", () => {
cy.get("span:contains('Got it')").click();
});
Cypress.Commands.add("fillGoogleSheetsDatasourceForm", () => {
cy.get(datasourceEditor["scope"]).click();
});
Cypress.Commands.add("fillAuthenticatedAPIForm", () => {
const URL = datasourceFormData["authenticatedApiUrl"];
cy.get(datasourceEditor.url).type(URL);
});
Cypress.Commands.add("runQuery", (expectedRes = true) => {
cy.onlyQueryRun();
AggregateHelper.FailIfErrorToast("Failed to initialize pool");
cy.wait(2000); //for postexecute to go thru
cy.wait("@postExecute").should(
"have.nested.property",
"response.body.data.isExecutionSuccess",
expectedRes,
);
// cy.wait("@postExecute").should(
// "have.nested.property",
// "response.body.responseMeta.status",
// 200,
// );
});
Cypress.Commands.add("onlyQueryRun", () => {
cy.xpath(queryEditor.runQuery).last().click({ force: true }).wait(1000);
cy.get(".ads-v2-spinner").should("not.exist");
});
Cypress.Commands.add("RunQueryWithoutWaitingForResolution", () => {
cy.xpath(queryEditor.runQuery).last().click({ force: true });
});
Cypress.Commands.add("hoverAndClick", (entity) => {
cy.xpath(
"//div[text()='" +
entity +
"']/ancestor::div[1]/following-sibling::div//button[contains(@class, 'entity-context-menu')]",
).click({ force: true });
});
Cypress.Commands.add("hoverAndClickParticularIndex", (index) => {
cy.xpath(apiwidget.popover)
.eq(index)
.should("be.hidden")
.invoke("show")
.click({ force: true });
});
Cypress.Commands.add("deleteQuery", () => {
cy.hoverAndClick();
cy.get(apiwidget.delete).click({ force: true });
cy.get(apiwidget.deleteConfirm).click({ force: true });
cy.wait("@deleteAction").should(
"have.nested.property",
"response.body.responseMeta.status",
200,
);
});
Cypress.Commands.add("deleteQueryUsingContext", () => {
cy.get(queryEditor.queryMoreAction).first().click();
cy.get(queryEditor.deleteUsingContext).click();
cy.get(queryEditor.deleteUsingContext).contains("Are you sure?").click();
cy.wait("@deleteAction").should(
"have.nested.property",
"response.body.responseMeta.status",
200,
);
});
Cypress.Commands.add("runAndDeleteQuery", () => {
cy.runQuery();
cy.deleteQueryUsingContext();
});
Cypress.Commands.add("executeDbQuery", (queryName, eventName) => {
PropertyPane.SelectPlatformFunction(eventName, "Execute a query");
cy.get(`.single-select:contains(${queryName})`).click({ force: true });
// cy.get(widgetsPage.buttonOnClick)
// .get(commonlocators.dropdownSelectButton)
// .eq(0)
// .click({ force: true })
// .get("ul.bp3-menu")
// .children()
// .contains("Execute a query")
// .click({ force: true })
// .get("ul.bp3-menu")
// .children()
// .contains(queryName)
// .click({ force: true });
});
Cypress.Commands.add("CreateMockQuery", (queryName) => {
// cy.get(queryEditor.addNewQueryBtn).click({ force: true });
// cy.get(queryEditor.createQuery)
// .first()
// .click({ force: true });
cy.get(queryEditor.queryNameField).type(queryName + "{enter}", {
force: true,
});
cy.assertPageSave();
cy.runQuery();
// cy.wait(3000);
// cy.get(queryEditor.runQuery)
// .click({force: true});
});
Cypress.Commands.add("ValidateQueryParams", (param) => {
cy.xpath(apiwidget.paramsTab).should("be.visible").click({ force: true });
cy.validateCodeEditorContent(apiwidget.paramKey, param.key);
cy.validateCodeEditorContent(apiwidget.paramValue, param.value);
});
// from hereeee
// targeting normal dropdowns, we can simply use the label names
Cypress.Commands.add(
"TargetDropdownAndSelectOption",
(dropdownIdentifier, option, isDynamic = false) => {
if (isDynamic) {
cy.wait(5000);
}
cy.get(dropdownIdentifier)
.scrollIntoView()
.should("be.visible")
.click({ multiple: true });
cy.get(formControls.dropdownWrapper)
.should("be.visible")
.contains(option)
.first()
.click({ force: true });
cy.wait(2000);
},
);
// targeting multiselect dropdowns, we target the data-testid value of the options
Cypress.Commands.add(
"TargetMultiSelectDropdownAndSelectOptions",
(dropdownIdentifier, options, isDynamic = false) => {
if (isDynamic) {
cy.wait(5000);
}
cy.get(dropdownIdentifier)
.scrollIntoView()
.should("be.visible")
.click({ multiple: true });
options &&
options.map((option) => {
cy.get(formControls.dropdownWrapper)
.should("be.visible")
.get(option) // we use a get instead of contains.
.first()
.click({ force: true });
});
},
);
Cypress.Commands.add(
"TargetFormControlAndSwitchViewType",
(formControlIdentifier, newViewType) => {
cy.get(formControlIdentifier).scrollIntoView().should("be.visible").click();
if (newViewType === "json") {
cy.get(formControlIdentifier)
.should("be.visible")
.should("have.class", "is-active");
} else if (newViewType === "component") {
cy.get(formControlIdentifier)
.should("be.visible")
.should("not.have.class", "is-active");
}
},
);
Cypress.Commands.add(
"VerifyCurrentDropdownOption",
(dropdownIdentifier, option) => {
cy.get(dropdownIdentifier)
.scrollIntoView()
.should("be.visible")
.contains(option)
.should("be.visible");
},
);
Cypress.Commands.add(
"ValidateAndSelectDropdownOption",
(dropdownIdentifier, currentOption, newOption, isDynamic = false) => {
cy.VerifyCurrentDropdownOption(dropdownIdentifier, currentOption);
if (newOption) {
cy.TargetDropdownAndSelectOption(
dropdownIdentifier,
newOption,
isDynamic,
);
cy.wait(2000);
}
},
);
Cypress.Commands.add("SelecJSFunctionAndRun", (functionName) => {
cy.xpath("//span[@name='expand-more']").first().click();
cy.get(`[data-testid='t--dropdown-option-${functionName}']`).click();
cy.get(jsEditorLocators.runButton).first().click();
});