Skip to content

test: Admin setting test cases #38172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sagar-qa007 merged 5 commits into from
Dec 23, 2024
Merged

test: Admin setting test cases #38172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b2e8dc5
Admin setting convert to TS
sagar-qa007 Dec 16, 2024
2c99cb3
2 cases written_in progress
sagar-qa007 Dec 16, 2024
0dbeb6c
Merge branch 'release' into test/adminsettingnew
sagar-qa007 Dec 20, 2024
88bae5c
Merge branch 'release' into test/adminsettingnew
sagar-qa007 Dec 23, 2024
fabd248
Admin setting spec update
sagar-qa007 Dec 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
143 changes: 89 additions & 54 deletions ...Side/AdminSettings/Admin_settings_spec.js → ...Side/AdminSettings/Admin_settings_spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,26 +24,25 @@ describe("Admin settings page", { tags: ["@tag.Settings"] }, function () {
it("1. Should test that settings page is accessible to super user", () => {
cy.LogOut();
cy.LoginFromAPI(Cypress.env("USERNAME"), Cypress.env("PASSWORD"));
cy.get(".admin-settings-menu-option").should("be.visible");
cy.get(".admin-settings-menu-option").click();
cy.url().should("contain", adminSettingsHelper.routes.GENERAL);
agHelper.GetNClick(adminSettingsHelper._adminSettingsBtn);
agHelper.AssertURL(adminSettingsHelper.routes.GENERAL);
cy.wait("@getEnvVariables");
Copy link
Contributor

@coderabbitai coderabbitai bot Dec 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Remove unnecessary cy.wait

Replace cy.wait("@getEnvVariables") with proper assertion using agHelper.ValidateNetworkStatus("@getEnvVariables") to follow best practices.

-    cy.wait("@getEnvVariables");
+    agHelper.ValidateNetworkStatus("@getEnvVariables");
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
cy.wait("@getEnvVariables");
agHelper.ValidateNetworkStatus("@getEnvVariables");

cy.LogOut();
});

it("2. Should test that settings page is not accessible to normal users", () => {
cy.LoginFromAPI(Cypress.env("TESTUSERNAME3"), Cypress.env("TESTPASSWORD3"));
cy.get(".admin-settings-menu-option").should("not.exist");
agHelper.AssertElementAbsence(adminSettingsHelper._adminSettingsBtn);
agHelper.VisitNAssert(adminSettingsHelper.routes.GENERAL);
// non super users are redirected to home page
cy.url().should("contain", "/applications");
agHelper.AssertURL("/applications");
cy.LogOut(false);
});

it("3. Should test that settings page is redirected to default tab", () => {
cy.LoginFromAPI(Cypress.env("USERNAME"), Cypress.env("PASSWORD"));
cy.visit("/settings", { timeout: 60000 });
cy.url().should("contain", adminSettingsHelper.routes.GENERAL);
agHelper.AssertURL(adminSettingsHelper.routes.GENERAL);
cy.wait("@getEnvVariables");
});

Expand All @@ -55,19 +54,19 @@ describe("Admin settings page", { tags: ["@tag.Settings"] }, function () {
cy.visit("/applications", { timeout: 60000 });
if (!Cypress.env("AIRGAPPED")) cy.wait("@getAllWorkspaces");

cy.get(".admin-settings-menu-option").click();
agHelper.GetNClick(adminSettingsHelper._adminSettingsBtn);
cy.wait("@getEnvVariables");
cy.get(adminsSettings.generalTab).click();
cy.url().should("contain", adminSettingsHelper.routes.GENERAL);
cy.get(adminsSettings.advancedTab).click();
cy.url().should("contain", adminSettingsHelper.routes.ADVANCED);
cy.get(adminsSettings.authenticationTab).click();
cy.url().should("contain", adminSettingsHelper.routes.AUTHENTICATION);
cy.get(adminsSettings.emailTab).click();
cy.url().should("contain", adminSettingsHelper.routes.EMAIL);
cy.get(adminsSettings.developerSettingsTab).should("not.exist");
cy.get(adminsSettings.versionTab).click();
cy.url().should("contain", adminSettingsHelper.routes.VERSION);
agHelper.GetNClick(adminsSettings.generalTab);
agHelper.AssertURL(adminSettingsHelper.routes.GENERAL);
agHelper.GetNClick(adminsSettings.advancedTab);
agHelper.AssertURL(adminSettingsHelper.routes.ADVANCED);
agHelper.GetNClick(adminsSettings.authenticationTab);
agHelper.AssertURL(adminSettingsHelper.routes.AUTHENTICATION);
agHelper.GetNClick(adminsSettings.emailTab);
agHelper.AssertURL(adminSettingsHelper.routes.EMAIL);
agHelper.AssertElementAbsence(adminsSettings.developerSettingsTab);
agHelper.GetNClick(adminsSettings.versionTab);
agHelper.AssertURL(adminSettingsHelper.routes.VERSION);
},
);

Expand All @@ -80,12 +79,12 @@ describe("Admin settings page", { tags: ["@tag.Settings"] }, function () {
adminSettingsHelper.routes.GENERAL,
"getEnvVariables",
);
cy.get(adminsSettings.authenticationTab).click();
cy.url().should("contain", adminSettingsHelper.routes.AUTHENTICATION);
cy.get(adminsSettings.googleButton).should("not.exist");
cy.get(adminsSettings.githubButton).should("not.exist");
cy.get(adminsSettings.formloginButton).click();
cy.url().should("contain", adminSettingsHelper.routes.FORMLOGIN);
agHelper.GetNClick(adminsSettings.authenticationTab);
agHelper.AssertURL(adminSettingsHelper.routes.AUTHENTICATION);
agHelper.AssertElementAbsence(adminsSettings.googleButton);
agHelper.AssertElementAbsence(adminsSettings.githubButton);
agHelper.GetNClick(adminsSettings.formloginButton);
agHelper.AssertURL(adminSettingsHelper.routes.FORMLOGIN);
},
);

Expand All @@ -97,16 +96,16 @@ describe("Admin settings page", { tags: ["@tag.Settings"] }, function () {
adminSettingsHelper.routes.GENERAL,
"getEnvVariables",
);
cy.get(adminsSettings.authenticationTab).click();
cy.url().should("contain", adminSettingsHelper.routes.AUTHENTICATION);
cy.get(adminsSettings.googleButton).click();
cy.url().should("contain", adminSettingsHelper.routes.GOOGLEAUTH);
agHelper.GetNClick(adminsSettings.authenticationTab);
agHelper.AssertURL(adminSettingsHelper.routes.AUTHENTICATION);
agHelper.GetNClick(adminsSettings.googleButton);
agHelper.AssertURL(adminSettingsHelper.routes.GOOGLEAUTH);
cy.get(adminsSettings.readMoreLink).within(() => {
cy.get("a")
.should("have.attr", "target", "_blank")
.invoke("removeAttr", "target")
.click();
cy.url().should("contain", GOOGLE_SIGNUP_SETUP_DOC);
agHelper.AssertURL(GOOGLE_SIGNUP_SETUP_DOC);
});
},
);
Expand All @@ -117,19 +116,19 @@ describe("Admin settings page", { tags: ["@tag.Settings"] }, function () {
"getEnvVariables",
);
const assertVisibilityAndDisabledState = () => {
cy.get(adminsSettings.saveButton).should("be.visible");
agHelper.AssertElementVisibility(adminsSettings.saveButton);
cy.get(adminsSettings.saveButton).should("be.disabled");
cy.get(adminsSettings.resetButton).should("be.visible");
agHelper.AssertElementVisibility(adminsSettings.resetButton);
cy.get(adminsSettings.resetButton).should("be.disabled");
};
assertVisibilityAndDisabledState();
cy.get(adminsSettings.instanceName).should("be.visible");
agHelper.AssertElementVisibility(adminsSettings.instanceName);
cy.get(adminsSettings.instanceName).clear().type("AppsmithInstance");
cy.get(adminsSettings.saveButton).should("be.visible");
agHelper.AssertElementVisibility(adminsSettings.saveButton);
cy.get(adminsSettings.saveButton).should("not.be.disabled");
cy.get(adminsSettings.resetButton).should("be.visible");
agHelper.AssertElementVisibility(adminsSettings.resetButton);
cy.get(adminsSettings.resetButton).should("not.be.disabled");
cy.get(adminsSettings.resetButton).click();
agHelper.GetNClick(adminsSettings.resetButton);
assertVisibilityAndDisabledState();
});

Expand All @@ -139,16 +138,16 @@ describe("Admin settings page", { tags: ["@tag.Settings"] }, function () {
"getEnvVariables",
);

cy.get(adminsSettings.restartNotice).should("not.exist");
cy.get(adminsSettings.instanceName).should("be.visible");
let instanceName;
cy.generateUUID().then((uuid) => {
agHelper.AssertElementAbsence(adminsSettings.restartNotice);
agHelper.AssertElementVisibility(adminsSettings.instanceName);
let instanceName: string;
cy.generateUUID().then((uuid: string) => {
instanceName = uuid;
cy.get(adminsSettings.instanceName).clear().type(uuid);
});
cy.get(adminsSettings.saveButton).should("be.visible");
agHelper.AssertElementVisibility(adminsSettings.saveButton);
cy.get(adminsSettings.saveButton).should("not.be.disabled");
cy.get(adminsSettings.saveButton).click();
agHelper.GetNClick(adminsSettings.saveButton);
cy.wait("@postTenantConfig").then((interception) => {
expect(interception.request.body.instanceName).to.equal(instanceName);
});
Expand All @@ -163,28 +162,28 @@ describe("Admin settings page", { tags: ["@tag.Settings"] }, function () {
adminSettingsHelper.routes.GENERAL,
"getEnvVariables",
);
cy.get(adminsSettings.restartNotice).should("not.exist");
cy.get(adminsSettings.instanceName).should("be.visible");
let instanceName;
cy.generateUUID().then((uuid) => {
agHelper.AssertElementAbsence(adminsSettings.restartNotice);
agHelper.AssertElementVisibility(adminsSettings.instanceName);
let instanceName: string;
cy.generateUUID().then((uuid: string) => {
instanceName = uuid;
cy.get(adminsSettings.instanceName).clear().type(uuid);
});
cy.get(adminsSettings.saveButton).should("be.visible");
agHelper.AssertElementVisibility(adminsSettings.saveButton);
cy.get(adminsSettings.saveButton).should("not.be.disabled");
cy.get(adminsSettings.emailTab).click();
cy.get(adminsSettings.saveButton).should("be.visible");
agHelper.GetNClick(adminsSettings.emailTab);
agHelper.AssertElementVisibility(adminsSettings.saveButton);
cy.get(adminsSettings.saveButton).should("not.be.disabled");
cy.get(adminsSettings.fromAddress).should("be.visible");
let fromAddress;
cy.generateUUID().then((uuid) => {
agHelper.AssertElementVisibility(adminsSettings.fromAddress);
let fromAddress: string;
cy.generateUUID().then((uuid: string) => {
fromAddress = uuid;
cy.get(adminsSettings.fromAddress).clear().type(`${uuid}@appsmith.com`);
});
cy.intercept("POST", "/api/v1/admin/restart", {
body: { responseMeta: { status: 200, success: true }, data: true },
});
cy.get(adminsSettings.saveButton).click();
agHelper.GetNClick(adminsSettings.saveButton);
cy.wait("@postTenantConfig").then((interception) => {
expect(interception.request.body.instanceName).to.equal(instanceName);
});
Expand All @@ -193,7 +192,43 @@ describe("Admin settings page", { tags: ["@tag.Settings"] }, function () {
`${fromAddress}@appsmith.com`,
);
});
cy.get(adminsSettings.restartNotice).should("be.visible");
cy.get(adminsSettings.restartNotice).should("not.exist");
agHelper.AssertElementVisibility(adminsSettings.restartNotice);
});

it("10. Verify default instance name", () => {
cy.LogOut();
cy.LoginFromAPI(Cypress.env("USERNAME"), Cypress.env("PASSWORD"));
agHelper.GetNClick(adminSettingsHelper._adminSettingsBtn);
agHelper.AssertURL(adminSettingsHelper.routes.GENERAL);
cy.wait("@getEnvVariables");
agHelper
.GetText(adminSettingsHelper._instanceName, "val")
.then(($text) => expect($text).to.eq("Appsmith"));
});

it("11. Verify all admin setting sections are accessible", () => {
cy.visit("/applications", { timeout: 60000 });
agHelper.GetNClick(adminSettingsHelper._adminSettingsBtn);
cy.wait("@getEnvVariables");
agHelper.GetNClick(adminsSettings.generalTab);
agHelper.AssertURL(adminSettingsHelper.routes.GENERAL);
agHelper.GetNClick(adminsSettings.advancedTab);
agHelper.AssertURL(adminSettingsHelper.routes.ADVANCED);
agHelper.GetNClick(adminsSettings.authenticationTab);
agHelper.AssertURL(adminSettingsHelper.routes.AUTHENTICATION);
agHelper.GetNClick(adminsSettings.emailTab);
agHelper.AssertURL(adminSettingsHelper.routes.EMAIL);
agHelper.GetNClick(adminsSettings.developerSettingsTab);
agHelper.AssertURL(adminSettingsHelper.routes.DEVELOPER_SETTINGS);
agHelper.GetNClick(adminsSettings.versionTab);
agHelper.AssertURL(adminSettingsHelper.routes.VERSION);
agHelper.GetNClick(adminsSettings.branding);
agHelper.AssertURL(adminSettingsHelper.routes.BRANDING);
agHelper.GetNClick(adminsSettings.provisioning);
agHelper.AssertURL(adminSettingsHelper.routes.PROVISIONING);
agHelper.GetNClick(adminsSettings.accessControl);
agHelper.AssertURL(adminSettingsHelper.routes.ACCESS_CONTROL);
agHelper.GetNClick(adminsSettings.auditLogs);
agHelper.AssertURL(adminSettingsHelper.routes.AUDIT_LOGS);
});
});
1 change: 1 addition & 0 deletions app/client/cypress/locators/AdminsSettings.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,5 @@ export default {
singleSessionPerUserInput: "[data-testid='singleSessionPerUserEnabled']",
sessionTimeoutWrapper: ".t--admin-settings-userSessionTimeoutInMinutes",
sessionTimeoutInput: "[name='userSessionTimeoutInMinutes']",
adminEmailsData: ".t--admin-settings-APPSMITH_ADMIN_EMAILS span > span",
Copy link
Contributor

@coderabbitai coderabbitai bot Dec 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Replace CSS path selector with data- attribute.*

The selector uses CSS path with child selectors (span > span). According to our coding guidelines, we should avoid CSS paths and use data-* attributes instead.

Consider this change:

-  adminEmailsData: ".t--admin-settings-APPSMITH_ADMIN_EMAILS span > span",
+  adminEmailsData: "[data-testid='admin-settings-emails-data']",

Remember to update the corresponding element in your component with the new data-testid attribute.

Committable suggestion skipped: line range outside the PR's diff.

};