## Description
- Removed hard waits from below specs:
- Apps/CurrencyInputIssue_Spec.js
- ClientSide/Widgets/Modal/Modal_spec.ts (Fix & unskip)
- /Binding/TableV2_Widget_API_Pagination_spec.js
- Unskip - ApiTests/API_Unique_name_spec.js
- Flaky fix - TableV2_Widget_API_Pagination_spec.js
- Flaky fix - /ServerSide/QueryPane/S3_1_spec.js
- Removed empty ReusableHelper.ts
- Improved agHelper.GetElement() to include the assertion for element
presence/absence
- Modified helpers/function calls to fit the above syntax of
GetElement()
- Improved WaitUntilEleAppear(), WaitUntilEleDisappear() to use timeout
from cypress config
#### 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 Cypress tests were reviewed
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
## Summary by CodeRabbit
- **Tests**
- Enhanced end-to-end test stability by replacing static waits with
dynamic element-based synchronization.
- Skipped certain test suites to streamline the testing process.
- Improved test assertions and control flow for more reliable
verification of UI components.
- **Chores**
- Updated test helper methods to support new verification strategies.
- Cleaned up unnecessary imports and inheritance in test support
classes.
- **Documentation**
- Adjusted test case descriptions to reflect the new synchronization
methods used.
- **Bug Fixes**
- Fixed issues with test synchronization that could lead to flaky test
results.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
158 lines
4.4 KiB
TypeScript
158 lines
4.4 KiB
TypeScript
import "cypress-wait-until";
|
|
|
|
export const EntityItems = {
|
|
Page: 0,
|
|
Query: 1,
|
|
Api: 2,
|
|
JSObject: 3,
|
|
Widget: 4,
|
|
Datasource: 5,
|
|
} as const;
|
|
|
|
export type EntityItemsType = (typeof EntityItems)[keyof typeof EntityItems];
|
|
|
|
export class AssertHelper {
|
|
public _modifierKey = Cypress.platform === "darwin" ? "meta" : "ctrl";
|
|
|
|
public isMac = Cypress.platform === "darwin";
|
|
|
|
public Sleep(timeout = 1000) {
|
|
cy.wait(timeout);
|
|
}
|
|
|
|
public AssertDocumentReady() {
|
|
cy.waitUntil(() =>
|
|
//cy.document().then((doc) => doc.readyState === "complete"),
|
|
cy.document().should((doc) => {
|
|
expect(doc.readyState).to.equal("complete");
|
|
}),
|
|
);
|
|
//cy.window({ timeout: 60000 }).should("have.property", "onload");//commenting to reduce time
|
|
}
|
|
|
|
public AssertDelete(entityType: EntityItemsType) {
|
|
let networkCall = "";
|
|
switch (entityType) {
|
|
case EntityItems.Api:
|
|
case EntityItems.Query:
|
|
networkCall = "deleteAction";
|
|
break;
|
|
case EntityItems.Widget:
|
|
networkCall = "updateLayout";
|
|
break;
|
|
case EntityItems.JSObject:
|
|
networkCall = "deleteJSCollection";
|
|
this.AssertContains("deleted successfully");
|
|
break;
|
|
case EntityItems.Datasource:
|
|
networkCall = "deleteDatasource";
|
|
break;
|
|
case EntityItems.Page:
|
|
networkCall = "deletePage";
|
|
break;
|
|
|
|
default:
|
|
networkCall && this.AssertNetworkStatus(networkCall);
|
|
}
|
|
}
|
|
|
|
public GetAliasName(aliasName: string) {
|
|
aliasName = aliasName.startsWith("@") ? aliasName : "@" + aliasName;
|
|
return aliasName;
|
|
}
|
|
|
|
public WaitForNetworkCall(aliasName: string, responseTimeout = 150000) {
|
|
// cy.wait(aliasName).then(($apiCall: any) => {
|
|
// expect($apiCall.response.body.responseMeta.status).to.eq(expectedStatus);
|
|
// });
|
|
|
|
this.Sleep(); //wait a bit to avoid flaky tests
|
|
return cy
|
|
.wait(this.GetAliasName(aliasName), { timeout: responseTimeout })
|
|
.then((interceptions) => {
|
|
return cy
|
|
.get(this.GetAliasName(aliasName), { timeout: responseTimeout })
|
|
.its("response");
|
|
});
|
|
}
|
|
|
|
public AssertNetworkStatus(
|
|
aliasName: string,
|
|
expectedStatus: number | number[] = 200,
|
|
waitForNetworkCall = true,
|
|
) {
|
|
if (waitForNetworkCall) {
|
|
// If waitForNetworkCall is true, then use the response from WaitForNetworkCall call
|
|
return this.WaitForNetworkCall(aliasName).then((response: any) =>
|
|
this.processNetworkStatus(response, expectedStatus),
|
|
);
|
|
} else {
|
|
// If interception is not available, directly get the alias & use it
|
|
return cy
|
|
.get(this.GetAliasName(aliasName))
|
|
.its("response")
|
|
.then((interception: any) =>
|
|
this.processNetworkStatus(interception, expectedStatus),
|
|
);
|
|
}
|
|
}
|
|
|
|
private processNetworkStatus(
|
|
response: any,
|
|
expectedStatus: number | number[],
|
|
) {
|
|
const responseStatus = Number(response.body.responseMeta.status);
|
|
const expectedStatusArray = Array.isArray(expectedStatus)
|
|
? expectedStatus
|
|
: [expectedStatus];
|
|
|
|
expect(expectedStatusArray).to.include(responseStatus);
|
|
return responseStatus;
|
|
}
|
|
|
|
public AssertNetworkResponseData(
|
|
aliasName: string,
|
|
waitForNetworkCall = true,
|
|
) {
|
|
if (waitForNetworkCall) {
|
|
// If waitForNetworkCall is true, then use the interception from received call
|
|
this.WaitForNetworkCall(aliasName).then((interception: any) => {
|
|
this.processNetworkResponseData(interception);
|
|
});
|
|
} else {
|
|
// If interception is not available, directly get the alias & use it
|
|
cy.get(this.GetAliasName(aliasName))
|
|
.its("response")
|
|
.then((interception: any) => {
|
|
this.processNetworkResponseData(interception);
|
|
});
|
|
}
|
|
}
|
|
|
|
private processNetworkResponseData(response: any) {
|
|
expect(response.body.data).to.not.be.empty;
|
|
}
|
|
|
|
public AssertNetworkExecutionSuccess(
|
|
aliasName: string,
|
|
expectedRes = true,
|
|
waitForNetworkCall = true,
|
|
) {
|
|
waitForNetworkCall && this.WaitForNetworkCall(aliasName);
|
|
cy.get(aliasName)
|
|
.its("response.body.data.isExecutionSuccess")
|
|
.should("eq", expectedRes);
|
|
}
|
|
|
|
public AssertContains(
|
|
text: string | RegExp,
|
|
exists: "exist" | "not.exist" | "be.visible" = "exist",
|
|
selector?: string,
|
|
) {
|
|
if (selector) {
|
|
return cy.contains(selector, text).should(exists);
|
|
}
|
|
return cy.contains(text).should(exists);
|
|
}
|
|
}
|