PromucFlow_constructor/app/client/cypress/support/ApiCommands.js
albinAppsmith 46786ae003
feat: Enable new toolbar for cypress (#37148)
## Description

This PR enabled IDE toolbar for cypress.

Fixes #37217

## Automation

/ok-to-test tags="@tag.All"

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/12115693818>
> Commit: f2af8705e91af400b3a80f6684cce7fb487f1ca3
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=12115693818&attempt=2"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.All`
> Spec:
> <hr>Mon, 02 Dec 2024 12:19:38 UTC
<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [x] No


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

- **New Features**
- Introduced a new feature flag `release_actions_redesign_enabled` to
enhance user experience.
- **Bug Fixes**
- Updated method calls in various test cases to improve consistency and
reliability in interactions, specifically renaming methods related to
data sources and queries.
- Improved error handling and validation in tests for MongoDB query
functionalities.
- **Documentation**
- Enhanced test coverage and assertions for various functionalities,
including API actions, Google Sheets queries, and JavaScript function
execution.
- **Style**
- Updated CSS selectors for improved consistency and maintainability
across components and test cases.
- **Tests**
- Refactored multiple test cases to utilize new helper methods,
improving code clarity and reducing direct DOM manipulation.
- Enhanced visual tests for JSEditor and improved interaction with the
run button.
- Added new assertions and enhanced the structure of tests for various
components, including API response handling and widget interactions.
- Streamlined interaction with the settings toolbar in various test
cases by encapsulating functionality within the `PluginActionForm`
class.
- Introduced new `data-testid` attributes across various components to
enhance testability.
- **Chores**
- Removed unused imports and streamlined method calls for better
performance and readability.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2024-12-03 09:21:43 +05:30

212 lines
6.5 KiB
JavaScript

/* eslint-disable cypress/no-unnecessary-waiting */
/* eslint-disable cypress/no-assigning-return-values */
require("cy-verify-downloads").addCustomCommand();
require("cypress-file-upload");
import ApiEditor from "../locators/ApiEditor";
const apiwidget = require("../locators/apiWidgetslocator.json");
const explorer = require("../locators/explorerlocators.json");
import { ObjectsRegistry } from "./Objects/Registry";
import { PluginActionForm } from "./Pages/PluginActionForm";
let agHelper = ObjectsRegistry.AggregateHelper;
let dataSources = ObjectsRegistry.DataSources;
let apiPage = ObjectsRegistry.ApiPage;
let locator = ObjectsRegistry.CommonLocators;
let pluginActionForm = new PluginActionForm();
export const initLocalstorage = () => {
cy.window().then((window) => {
window.localStorage.setItem("ShowCommentsButtonToolTip", "");
window.localStorage.setItem("updateDismissed", "true");
});
};
Cypress.Commands.add("enterDatasourceAndPath", (datasource, path) => {
cy.enterDatasource(datasource + path);
});
Cypress.Commands.add("enterDatasource", (datasource) => {
cy.get(apiwidget.resourceUrl)
.first()
.click({ force: true })
.type(datasource, { parseSpecialCharSequences: false });
//.type("{esc}}");
cy.wait(2000);
agHelper.AssertAutoSave();
});
Cypress.Commands.add("ResponseStatusCheck", (statusCode) => {
cy.xpath(apiwidget.responseStatus).should("be.visible");
cy.xpath(apiwidget.responseStatus).contains(statusCode);
});
Cypress.Commands.add("ResponseCheck", () => {
//Explicit assert
cy.get(apiwidget.responseText).should("be.visible");
});
Cypress.Commands.add("ResponseTextCheck", (textTocheck) => {
cy.ResponseCheck();
cy.get(apiwidget.responseText).contains(textTocheck);
});
Cypress.Commands.add("NavigateToAPI_Panel", () => {
dataSources.NavigateToDSCreateNew();
cy.get("#loading").should("not.exist");
});
Cypress.Commands.add("CreateAPI", (apiname) => {
apiPage.CreateApi(apiname);
});
Cypress.Commands.add("EditApiNameFromExplorer", (apiname) => {
/*
cy.xpath(apiwidget.popover)
.last()
.click({ force: true });
cy.get(apiwidget.editName).click({ force: true });
*/
cy.get(explorer.editNameField)
.clear()
.type(apiname, { force: true })
.should("have.value", apiname)
.blur({ force: true });
// eslint-disable-next-line cypress/no-unnecessary-waiting
cy.wait(3000);
});
Cypress.Commands.add("RunAPI", () => {
cy.get(ApiEditor.ApiRunBtn).click({ force: true });
cy.wait("@postExecute");
});
Cypress.Commands.add("SaveAndRunAPI", () => {
cy.WaitAutoSave();
cy.RunAPI();
});
Cypress.Commands.add(
"validateRequest",
(apiName, baseurl, path, verb, error = false) => {
cy.get(".ads-v2-tabs__list").contains("Logs").click();
cy.get("[data-testid=t--debugger-search]").clear().type(apiName);
agHelper.PressEnter(2000);
if (!error) {
cy.get(ApiEditor.apiResponseObject).last().contains("request").click();
}
cy.get(".string-value").contains(baseurl.concat(path));
cy.get(".string-value").contains(verb);
cy.get("[data-testid=t--tab-RESPONSE_TAB]").first().click({ force: true });
},
);
Cypress.Commands.add("enterUrl", (baseUrl, url, value) => {
cy.get(url).first().type(baseUrl.concat(value), {
force: true,
parseSpecialCharSequences: false,
});
});
Cypress.Commands.add("CreationOfUniqueAPIcheck", (apiname) => {
dataSources.NavigateToDSCreateNew();
agHelper.GetNClick(apiwidget.createapi);
cy.wait("@createNewApi");
// cy.wait("@getUser");
cy.get(apiwidget.resourceUrl).should("be.visible");
agHelper.RenameQuery(apiname);
cy.get(".ads-v2-tooltip .ads-v2-text").should(($x) => {
expect($x).contain(
apiname.concat(" is already being used or is a restricted keyword."),
);
});
});
Cypress.Commands.add("RenameEntity", (value, selectFirst) => {
if (selectFirst) {
cy.xpath(apiwidget.popover).first().click({ force: true });
} else {
cy.xpath(apiwidget.popover).last().click({ force: true });
}
cy.get(apiwidget.renameEntity).click({ force: true });
cy.get(explorer.editEntity).last().type(value, { force: true });
});
Cypress.Commands.add("CreateApiAndValidateUniqueEntityName", (apiname) => {
dataSources.NavigateToDSCreateNew();
agHelper.GetNClick(apiwidget.createapi);
cy.wait("@createNewApi");
cy.get(apiwidget.resourceUrl).should("be.visible");
agHelper.RenameQuery(apiname);
cy.get(".ads-v2-tooltip .ads-v2-text").should(($x) => {
expect($x).contain(
apiname.concat(" is already being used or is a restricted keyword."),
);
});
});
Cypress.Commands.add("validateMessage", (value) => {
cy.get(".rc-tooltip-inner").should(($x) => {
expect($x).contain(value.concat(" is already being used."));
});
});
Cypress.Commands.add("DeleteWidgetFromSideBar", () => {
cy.xpath(apiwidget.popover).last().click({ force: true });
cy.get(apiwidget.delete).click({ force: true });
cy.wait("@updateLayout").should(
"have.nested.property",
"response.body.responseMeta.status",
200,
);
});
Cypress.Commands.add("DeleteAPI", () => {
cy.get(ApiEditor.ApiActionMenu).click({ multiple: true });
cy.get(apiwidget.deleteAPI).first().click({ force: true });
cy.get(apiwidget.deleteAPI).first().click({ force: true });
cy.wait("@deleteAction")
.its("response.body.responseMeta.status")
.should("eq", 200);
});
Cypress.Commands.add("testCreateApiButton", () => {
agHelper.GetNClick(ApiEditor.createBlankApiCard);
cy.wait("@createNewApi");
cy.get("@createNewApi")
.its("response.body.responseMeta.status")
.should("eq", 201);
});
Cypress.Commands.add("createAndFillApi", (url, parameters) => {
dataSources.NavigateToDSCreateNew();
cy.testCreateApiButton();
cy.get("@createNewApi").then((response) => {
cy.get(locator._queryName).should("be.visible");
expect(response.response.body.responseMeta.success).to.eq(true);
cy.get(locator._queryName)
.invoke("text")
.then((text) => {
const someText = text;
expect(someText).to.equal(response.response.body.data.name);
});
});
cy.EnableAllCodeEditors();
cy.updateCodeInput(ApiEditor.dataSourceField, url + parameters);
cy.WaitAutoSave();
cy.get(pluginActionForm.locators.actionRunButton).should("not.be.disabled");
});
// Cypress.Commands.add("callApi", (apiname) => {
// cy.get(commonlocators.callApi).first().click({ force: true });
// cy.get(commonlocators.singleSelectMenuItem)
// .contains("Execute a query")
// .click({ force: true });
// cy.get(commonlocators.selectMenuItem)
// .contains(apiname)
// .click({ force: true });
// });