Skip to content
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.

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

test: Admin setting new test cases with email #38522

Open
wants to merge 4 commits into
base: release
Choose a base branch
from

Conversation

sagar-qa007
Copy link
Contributor

@sagar-qa007 sagar-qa007 commented Jan 8, 2025

Description

New cypress test case for admin setting

Fixes # https://app.zenhub.com/workspaces/stability-pod-6690c4814e31602e25cab7fd/issues/gh/appsmithorg/appsmith/38459

Automation

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

🔍 Cypress test results

Caution

🔴 🔴 🔴 Some tests have failed.
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12664257144
Commit: dc6c585
Cypress dashboard.
Tags: @tag.All
Spec:
The following are new failures, please fix them before merging the PR:

  1. cypress/e2e/Regression/ClientSide/AdminSettings/Email_settings_Spec.ts
  2. cypress/e2e/Regression/ServerSide/JsFunctionExecution/JSFunctionExecution_spec.ts
List of identified flaky tests.
Wed, 08 Jan 2025 06:15:37 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Summary by CodeRabbit

  • Tests

    • Added comprehensive Cypress end-to-end tests for email settings functionality
    • Implemented tests for:
      • Adding new admin users
      • SMTP configuration
      • Password reset email verification
      • Workspace invitation emails
  • Locators

    • Added new locators for SMTP settings and email-related UI elements
    • Introduced password recovery link locator
  • Improvements

    • Enhanced email verification method in test support utilities
    • Updated request header handling for more dynamic configuration

Copy link
Contributor

coderabbitai bot commented Jan 8, 2025

Walkthrough

This pull request focuses on enhancing Cypress end-to-end testing for email settings in an application. The changes introduce comprehensive tests for admin email configurations, including SMTP setup, user invitations, and password reset functionality. The modifications span multiple files, adding new locators, email verification methods, and updating header validation to improve test robustness and flexibility.

Changes

File Change Summary
cypress/e2e/Regression/ClientSide/AdminSettings/Email_settings_Spec.ts Added comprehensive E2E tests for email settings, covering admin user addition, SMTP configuration, password reset, and workspace invitations
cypress/locators/AdminsSettings.js Introduced new locators for SMTP configuration inputs and buttons
cypress/locators/SignupPage.json Added forgetPasswordLink locator
cypress/support/Pages/AggregateHelper.ts Added waitForEmail method for asynchronous email verification
cypress/support/Pages/HomePage.ts Updated header validation to use dynamic base URL configuration

Sequence Diagram

sequenceDiagram
    participant User
    participant AdminSettings
    participant SMTPServer
    participant EmailService
    
    User->>AdminSettings: Configure SMTP Settings
    AdminSettings->>SMTPServer: Test Connection
    SMTPServer-->>AdminSettings: Confirm Configuration
    User->>AdminSettings: Send Test Email
    AdminSettings->>EmailService: Trigger Email
    EmailService->>SMTPServer: Transmit Email
    SMTPServer-->>User: Deliver Email
Loading

Possibly related PRs

Suggested Labels

skip-changelog, ok-to-test, Test, Task

Suggested Reviewers

  • ApekshaBhosale
  • NandanAnantharamu

Poem

🚀 Emails dancing through the wire,
Cypress tests spark testing fire!
SMTP configs gleam so bright,
Invitations take their digital flight
Code quality reaches new height! 📧✨


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added skip-changelog Adding this label to a PR prevents it from being listed in the changelog Test labels Jan 8, 2025
@sagar-qa007 sagar-qa007 added the ok-to-test Required label for CI label Jan 8, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
app/client/cypress/locators/SignupPage.json (2)

8-10: LGTM on JSON structure, but locator needs improvement

The new locator should use data-* attributes instead of href for better maintainability.

-  "forgetPasswordLink": "[href='/user/forgotPassword']"
+  "forgetPasswordLink": "[data-testid='t--forgot-password-link']"

Line range hint 1-10: Consider refactoring all selectors to use data- attributes*

Several selectors in this file use attribute selectors or CSS classes which are fragile and against best practices.

{
-  "username": "input[name='email']",
-  "password": "input[name='password']",
-  "submitBtn": "button[type='submit']",
+  "username": "[data-testid='t--email-input']",
+  "password": "[data-testid='t--password-input']",
+  "submitBtn": "[data-testid='t--submit-button']",
   "proficiencyGroupButton": "[data-testid='t--user-proficiency'] button",
   "useCaseGroupButton": "[data-testid='t--user-use-case'] button",
-  "dropdownOption": ".rc-select-item-option:first",
-  "getStartedSubmit": ".t--get-started-button",
-  "forgetPasswordLink": "[href='/user/forgotPassword']"
+  "dropdownOption": "[data-testid='t--dropdown-option']",
+  "getStartedSubmit": "[data-testid='t--get-started-button']",
+  "forgetPasswordLink": "[data-testid='t--forgot-password-link']"
}
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f7296ef and dc6c585.

📒 Files selected for processing (5)
  • app/client/cypress/e2e/Regression/ClientSide/AdminSettings/Email_settings_Spec.ts (1 hunks)
  • app/client/cypress/locators/AdminsSettings.js (1 hunks)
  • app/client/cypress/locators/SignupPage.json (1 hunks)
  • app/client/cypress/support/Pages/AggregateHelper.ts (1 hunks)
  • app/client/cypress/support/Pages/HomePage.ts (4 hunks)
👮 Files not reviewed due to content moderation or server errors (4)
  • app/client/cypress/locators/AdminsSettings.js
  • app/client/cypress/e2e/Regression/ClientSide/AdminSettings/Email_settings_Spec.ts
  • app/client/cypress/support/Pages/HomePage.ts
  • app/client/cypress/support/Pages/AggregateHelper.ts
🧰 Additional context used
📓 Path-based instructions (5)
app/client/cypress/locators/SignupPage.json (1)

Pattern app/client/cypress/**/**.*: Review the following e2e test code written using the Cypress test library. Ensure that:

  • Follow best practices for Cypress code and e2e automation.
  • Avoid using cy.wait in code.
  • Avoid using cy.pause in code.
  • Avoid using agHelper.sleep().
  • Use locator variables for locators and do not use plain strings.
  • Use data-* attributes for selectors.
  • Avoid Xpaths, Attributes and CSS path.
  • Avoid selectors like .btn.submit or button[type=submit].
  • Perform logins via API with LoginFromAPI.
  • Perform logout via API with LogOutviaAPI.
  • Perform signup via API with SignupFromAPI.
  • Avoid using it.only.
  • Avoid using after and aftereach in test cases.
  • Use multiple assertions for expect statements.
  • Avoid using strings for assertions.
  • Do not use duplicate filenames even with different paths.
  • Avoid using agHelper.Sleep, this.Sleep in any file in code.
app/client/cypress/support/Pages/HomePage.ts (1)

Pattern app/client/cypress/**/**.*: Review the following e2e test code written using the Cypress test library. Ensure that:

  • Follow best practices for Cypress code and e2e automation.
  • Avoid using cy.wait in code.
  • Avoid using cy.pause in code.
  • Avoid using agHelper.sleep().
  • Use locator variables for locators and do not use plain strings.
  • Use data-* attributes for selectors.
  • Avoid Xpaths, Attributes and CSS path.
  • Avoid selectors like .btn.submit or button[type=submit].
  • Perform logins via API with LoginFromAPI.
  • Perform logout via API with LogOutviaAPI.
  • Perform signup via API with SignupFromAPI.
  • Avoid using it.only.
  • Avoid using after and aftereach in test cases.
  • Use multiple assertions for expect statements.
  • Avoid using strings for assertions.
  • Do not use duplicate filenames even with different paths.
  • Avoid using agHelper.Sleep, this.Sleep in any file in code.
app/client/cypress/support/Pages/AggregateHelper.ts (1)

Pattern app/client/cypress/**/**.*: Review the following e2e test code written using the Cypress test library. Ensure that:

  • Follow best practices for Cypress code and e2e automation.
  • Avoid using cy.wait in code.
  • Avoid using cy.pause in code.
  • Avoid using agHelper.sleep().
  • Use locator variables for locators and do not use plain strings.
  • Use data-* attributes for selectors.
  • Avoid Xpaths, Attributes and CSS path.
  • Avoid selectors like .btn.submit or button[type=submit].
  • Perform logins via API with LoginFromAPI.
  • Perform logout via API with LogOutviaAPI.
  • Perform signup via API with SignupFromAPI.
  • Avoid using it.only.
  • Avoid using after and aftereach in test cases.
  • Use multiple assertions for expect statements.
  • Avoid using strings for assertions.
  • Do not use duplicate filenames even with different paths.
  • Avoid using agHelper.Sleep, this.Sleep in any file in code.
app/client/cypress/e2e/Regression/ClientSide/AdminSettings/Email_settings_Spec.ts (1)

Pattern app/client/cypress/**/**.*: Review the following e2e test code written using the Cypress test library. Ensure that:

  • Follow best practices for Cypress code and e2e automation.
  • Avoid using cy.wait in code.
  • Avoid using cy.pause in code.
  • Avoid using agHelper.sleep().
  • Use locator variables for locators and do not use plain strings.
  • Use data-* attributes for selectors.
  • Avoid Xpaths, Attributes and CSS path.
  • Avoid selectors like .btn.submit or button[type=submit].
  • Perform logins via API with LoginFromAPI.
  • Perform logout via API with LogOutviaAPI.
  • Perform signup via API with SignupFromAPI.
  • Avoid using it.only.
  • Avoid using after and aftereach in test cases.
  • Use multiple assertions for expect statements.
  • Avoid using strings for assertions.
  • Do not use duplicate filenames even with different paths.
  • Avoid using agHelper.Sleep, this.Sleep in any file in code.
app/client/cypress/locators/AdminsSettings.js (1)

Pattern app/client/cypress/**/**.*: Review the following e2e test code written using the Cypress test library. Ensure that:

  • Follow best practices for Cypress code and e2e automation.
  • Avoid using cy.wait in code.
  • Avoid using cy.pause in code.
  • Avoid using agHelper.sleep().
  • Use locator variables for locators and do not use plain strings.
  • Use data-* attributes for selectors.
  • Avoid Xpaths, Attributes and CSS path.
  • Avoid selectors like .btn.submit or button[type=submit].
  • Perform logins via API with LoginFromAPI.
  • Perform logout via API with LogOutviaAPI.
  • Perform signup via API with SignupFromAPI.
  • Avoid using it.only.
  • Avoid using after and aftereach in test cases.
  • Use multiple assertions for expect statements.
  • Avoid using strings for assertions.
  • Do not use duplicate filenames even with different paths.
  • Avoid using agHelper.Sleep, this.Sleep in any file in code.
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: perform-test / rts-build / build
  • GitHub Check: client-lint / client-lint
  • GitHub Check: client-build / client-build
  • GitHub Check: client-prettier / prettier-check

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ok-to-test Required label for CI skip-changelog Adding this label to a PR prevents it from being listed in the changelog Test
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant