PromucFlow_constructor/app/client/cypress/support/Pages/AutoLayout.ts
rahulramesha c2edc8a37a
chore: Enable Auto layout git cypress tests and using more module methods in Autolayout tests (#24324)
## Description
This PR fixes the final review comments in this
[PR](https://github.com/appsmithorg/appsmith/pull/23702).
And Enables Git connected Auto layout tests

#### Type of change
- Chore (housekeeping or task changes that don't impact user perception)


## Checklist:
#### Dev activity
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] PR is being merged under a feature flag


#### QA activity:
- [ ] [Speedbreak
features](https://github.com/appsmithorg/TestSmith/wiki/Test-plan-implementation#speedbreaker-features-to-consider-for-every-change)
have been covered
- [ ] Test plan covers all impacted features and [areas of
interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans/_edit#areas-of-interest)
- [ ] Test plan has been peer reviewed by project stakeholders and other
QA members
- [ ] Manually tested functionality on DP
- [ ] We had an implementation alignment call with stakeholders post QA
Round 2
- [ ] Cypress test cases have been added and approved by SDET/manual QA
- [ ] Added `Test Plan Approved` label after Cypress tests were reviewed
- [ ] Added `Test Plan Approved` label after JUnit tests were reviewed

---------

Co-authored-by: Aishwarya UR <aishwarya@appsmith.com>
2023-06-10 12:31:39 +05:30

297 lines
10 KiB
TypeScript

import { ObjectsRegistry } from "../Objects/Registry";
import { getWidgetSelector, WIDGET } from "../../locators/WidgetLocators";
type FixedConversionOptions = "DESKTOP" | "MOBILE";
type Alignments = "START" | "CENTER" | "END";
const alignmentIndex = {
START: 0,
CENTER: 1,
END: 2,
};
export class AutoLayout {
private entityExplorer = ObjectsRegistry.EntityExplorer;
private propPane = ObjectsRegistry.PropertyPane;
private agHelper = ObjectsRegistry.AggregateHelper;
private locators = ObjectsRegistry.CommonLocators;
_buttonWidgetSelector = getWidgetSelector(WIDGET.BUTTON);
_buttonComponentSelector = `${getWidgetSelector(WIDGET.BUTTON)} button`;
_textWidgetSelector = getWidgetSelector(WIDGET.TEXT);
_textComponentSelector = `${getWidgetSelector(
WIDGET.TEXT,
)} .t--text-widget-container`;
_containerWidgetSelector = getWidgetSelector(WIDGET.CONTAINER);
_flexComponentClass = `*[class^="flex-container"]`;
private autoConvertButton = "#t--layout-conversion-cta";
private useSnapshotBannerButton = "span:contains('Use snapshot')";
private discardSnapshotBannerButton = "span:contains('Discard snapshot')";
private convertDialogButton = "button:contains('Convert layout')";
private refreshAppDialogButton = "button:contains('Refresh the app')";
private useSnapshotDialogButton = "button:contains('Use snapshot')";
private convertAnywaysDialogButton = "button:contains('Convert anyways')";
private discardDialogButton = "button:contains('Discard')";
private fixedModeConversionOptionButton = (option: FixedConversionOptions) =>
`//span[@data-value = '${option}']`;
private flexMainContainer = ".flex-container-0";
public ConvertToAutoLayoutAndVerify(isNotNewApp = true) {
this.VerifyIsFixedLayout();
this.agHelper.GetNClick(this.autoConvertButton, 0, true);
this.agHelper.GetNClick(this.convertDialogButton, 0, true);
this.agHelper.ValidateNetworkStatus("@updateApplication");
if (isNotNewApp) {
this.agHelper.ValidateNetworkStatus("@snapshotSuccess", 201);
}
this.agHelper.GetNClick(this.refreshAppDialogButton, 0, true);
this.agHelper.Sleep(2000);
this.VerifyIsAutoLayout();
}
public ConvertToFixedLayoutAndVerify(
fixedConversionOption: FixedConversionOptions,
) {
this.VerifyIsAutoLayout();
this.agHelper.GetNClick(this.autoConvertButton, 0, true);
this.agHelper.GetNClick(
this.fixedModeConversionOptionButton(fixedConversionOption),
0,
true,
);
this.agHelper.GetNClick(this.convertDialogButton, 0, true);
cy.get("body").then(($body) => {
if ($body.find(this.convertAnywaysDialogButton).length) {
this.agHelper.GetNClick(this.convertAnywaysDialogButton, 0, true);
}
});
this.agHelper.ValidateNetworkStatus("@updateApplication");
this.agHelper.ValidateNetworkStatus("@snapshotSuccess", 201);
this.agHelper.GetNClick(this.refreshAppDialogButton, 0, true);
cy.wait(2000);
this.VerifyIsFixedLayout();
}
public UseSnapshotFromBanner() {
this.agHelper.GetNClick(this.useSnapshotBannerButton, 0, true);
this.agHelper.GetNClick(this.useSnapshotDialogButton, 0, true);
cy.wait(2000);
this.agHelper.GetNClick(this.refreshAppDialogButton, 0, true);
cy.wait(2000);
}
public DiscardSnapshot() {
this.agHelper.GetNClick(this.discardSnapshotBannerButton, 0, true);
this.agHelper.GetNClick(this.discardDialogButton, 0, true);
}
public VerifyIsAutoLayout() {
this.agHelper.GetNClick(this.locators._selectionCanvas("0"), 0, true);
cy.get(this.autoConvertButton).should("contain", "fixed layout");
cy.get(this.flexMainContainer).should("exist");
}
public VerifyIsFixedLayout() {
this.agHelper.GetNClick(this.locators._selectionCanvas("0"), 0, true);
cy.get(this.autoConvertButton).should("contain", "auto-layout");
cy.get(this.flexMainContainer).should("not.exist");
}
public VerifyCurrentWidgetIsAutolayout(widgetTypeName: string) {
if (widgetTypeName === WIDGET.MODAL) {
cy.get(`${this.locators._modal} canvas`)
.siblings(this._flexComponentClass)
.should("exist");
} else {
this.agHelper.AssertExistingCheckedState;
cy.get(`${this.locators._widgetInCanvas(widgetTypeName)} canvas`)
.siblings(this._flexComponentClass)
.should("exist");
}
}
public VerifyCurrentWidgetIsFixedlayout(widgetTypeName: string) {
if (widgetTypeName === WIDGET.MODAL) {
cy.get(`${this.locators._modal} canvas`)
.siblings(this._flexComponentClass)
.should("not.exist");
} else {
cy.get(`${this.locators._widgetInCanvas(widgetTypeName)} canvas`)
.siblings(this._flexComponentClass)
.should("not.exist");
}
}
public VerifyIfChildWidgetPositionInFlexContainer(
canvasWrapperSelector: string,
childWidgetSelector: string,
layerIndex: number,
alignment: Alignments,
) {
cy.get(`${canvasWrapperSelector} canvas`)
.siblings(this._flexComponentClass)
.children()
.eq(layerIndex)
.children()
.eq(alignmentIndex[alignment])
.find(childWidgetSelector)
.should("exist");
}
/**
* Drag and drop a button widget and verify if the bounding box fits perfectly
* after adjusting the label length
*
* @param {number} x
* @param {number} y
* @param {string} [dropTarget=""]
*/
DropButtonAndTestForAutoDimension(x: number, y: number, dropTarget = "") {
this.entityExplorer.DragDropWidgetNVerify(WIDGET.BUTTON, x, y, dropTarget);
// Check if bounding box fits perfectly to the Button Widget
this.EnsureBoundingBoxFitsComponent(
this._buttonWidgetSelector,
this._buttonComponentSelector,
);
// Increase the length of button label & verify if the component expands
this.agHelper.GetWidgetWidth(this._buttonWidgetSelector).as("initialWidth");
this.propPane.UpdatePropertyFieldValue("Label", "Lengthy Button Label");
this.agHelper.GetWidgetWidth(this._buttonWidgetSelector).then((width) => {
cy.get<number>("@initialWidth").then((initialWidth) => {
expect(width).to.be.greaterThan(initialWidth);
});
});
// verify if the bounding box fits perfectly to the Button Widget after expanding
this.EnsureBoundingBoxFitsComponent(
this._buttonWidgetSelector,
this._buttonComponentSelector,
);
// Decrease the length of button label & verify if the component shrinks
this.agHelper.GetWidgetWidth(this._buttonWidgetSelector).as("initialWidth");
this.propPane.UpdatePropertyFieldValue("Label", "Label");
this.agHelper.GetWidgetWidth(this._buttonWidgetSelector).then((width) => {
cy.get<number>("@initialWidth").then((initialWidth) => {
expect(width).to.be.lessThan(initialWidth);
});
});
// verify if the bounding box fits perfectly to the Button Widget after expanding
this.EnsureBoundingBoxFitsComponent(
this._buttonWidgetSelector,
this._buttonComponentSelector,
);
}
/**
* Drag and drop a text widget and verify if the bounding box fits perfectly
* after adding & removing multi-line text
*
* @param {number} x
* @param {number} y
* @param {string} [dropTarget=""]
*/
DropTextAndTestForAutoDimension(x: number, y: number, dropTarget = "") {
this.entityExplorer.DragDropWidgetNVerify(WIDGET.TEXT, x, y, dropTarget);
// Check if bounding box fits perfectly to the Text Widget
this.EnsureBoundingBoxFitsComponent(
this._textWidgetSelector,
this._textComponentSelector,
);
// Add multi-line text & verify if the component's height increases
this.agHelper.GetWidgetHeight(this._textWidgetSelector).as("initialHeight");
this.propPane.UpdatePropertyFieldValue(
"Text",
"hello\nWorld\nThis\nis\na\nMulti-line\nText",
);
this.agHelper.GetWidgetHeight(this._textWidgetSelector).then((width) => {
cy.get<number>("@initialHeight").then((initialHeight) => {
expect(width).to.be.greaterThan(initialHeight);
});
});
// Check if bounding box fits perfectly to the Text Widget
this.EnsureBoundingBoxFitsComponent(
this._textWidgetSelector,
this._textComponentSelector,
);
// Remove some lines & verify if the component's height decreases
this.agHelper.GetWidgetHeight(this._textWidgetSelector).as("initialHeight");
this.propPane.UpdatePropertyFieldValue("Text", "hello\nWorld\nblabla");
this.agHelper.GetWidgetHeight(this._textWidgetSelector).then((width) => {
cy.get<number>("@initialHeight").then((initialWidth) => {
expect(width).to.be.lessThan(initialWidth);
});
});
// Check if bounding box fits perfectly to the Text Widget
this.EnsureBoundingBoxFitsComponent(
this._textWidgetSelector,
this._textComponentSelector,
);
}
/**
* Ensures that the bounding box of a widget fits perfectly with the component.
*
* @param {string} widgetSelector - Selector for the widget element.
* @param {string} componentSelector - Selector for the component element.
* @returns {void}
*/
EnsureBoundingBoxFitsComponent(
widgetSelector: string,
componentSelector: string,
) {
// TODO(aswathkk): Delta should be made 0.5 once the issue with list widget in mobile view is fixed.
const DELTA = 1;
this.agHelper.GetElement(widgetSelector).then((widget) => {
const widgetRect = widget.get(0).getBoundingClientRect();
this.agHelper.GetElement(componentSelector).then((component) => {
const componentRect = component.get(0).getBoundingClientRect();
expect(widgetRect.x).to.be.closeTo(componentRect.x - 2, DELTA);
expect(widgetRect.y).to.be.closeTo(componentRect.y - 2, DELTA);
expect(widgetRect.top).to.be.closeTo(componentRect.top - 2, DELTA);
expect(widgetRect.bottom).to.be.closeTo(
componentRect.bottom + 2,
DELTA,
);
expect(widgetRect.left).to.be.closeTo(componentRect.left - 2, DELTA);
expect(widgetRect.right).to.be.closeTo(componentRect.right + 2, DELTA);
expect(widgetRect.height).to.be.closeTo(
componentRect.height + 4,
DELTA,
);
expect(widgetRect.width).to.be.closeTo(componentRect.width + 4, DELTA);
});
});
}
}