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: analyse TBP failure EnableGoogleSheet #37335

Open
wants to merge 1 commit into
base: release
Choose a base branch
from

Conversation

NandanAnantharamu
Copy link
Collaborator

@NandanAnantharamu NandanAnantharamu commented Nov 12, 2024

Summary by CodeRabbit

  • Chores
    • Updated test specification focus from "Fork Template" to "Enable Google" in the Cypress testing environment.

@NandanAnantharamu
Copy link
Collaborator Author

/ci-test-limit-count run_count=100

Copy link
Contributor

coderabbitai bot commented Nov 12, 2024

Walkthrough

The changes involve updating the limited-tests.txt file in the Cypress testing environment. The modification specifies a new test case path, shifting the focus from the "Fork Template" functionality to the "Enable Google" functionality. The overall structure and comments in the file remain unchanged.

Changes

File Change Summary
app/client/cypress/limited-tests.txt Updated test specification path from Fork_Template_spec.js to EnableGoogle_spec.js.

Possibly related PRs

Suggested labels

ok-to-test, Test, Bug

Suggested reviewers

  • ApekshaBhosale
  • sagar-qa007

🎉 In the land of code, a change took flight,
From Fork Templates to Google, oh what a sight!
Tests now align with a new focus bright,
In Cypress we trust, our future's so right!
So here's to the shifts, both clever and keen,
In the world of testing, we reign supreme! 🚀


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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 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 Nov 12, 2024
Copy link

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: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d4007e1 and 38f8552.

📒 Files selected for processing (1)
  • app/client/cypress/limited-tests.txt (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
app/client/cypress/limited-tests.txt (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.

@@ -1,5 +1,5 @@
# To run only limited tests - give the spec names in below format:
cypress/e2e/Regression/ClientSide/Templates/Fork_Template_spec.js
cypress/e2e/Regression/ClientSide/Google/EnableGoogle_spec.js
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Cypress test spec needs improvements to follow best practices

The test spec contains multiple instances of hard-coded waits (cy.wait) which is against Cypress best practices. These should be replaced with proper assertions or cy.waitUntil with specific conditions.

  • Replace cy.wait(2000) on lines with proper assertions or waitUntil conditions
  • Consider using agHelper.WaitUntilToastDisappear() or agHelper.WaitUntilEleAppear() instead of arbitrary waits
  • Review usage of cy.waitUntil(() => cy.get(homePage.profileMenu)) to ensure it's the most appropriate approach
🔗 Analysis chain

Verify the EnableGoogle test spec existence and implementation.

The change aligns with the PR objective to analyze TBP failure related to EnableGoogleSheet functionality.

Let's verify the test spec existence and its implementation:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the existence of EnableGoogle_spec.js and check its implementation
# for compliance with Cypress best practices

# Check if the spec file exists
if ! fd "EnableGoogle_spec.js" app/client/cypress/; then
    echo "ERROR: Test spec not found"
    exit 1
fi

# Check for prohibited practices in the spec file
echo "Checking for prohibited practices..."
rg -i "cy\.wait|cy\.pause|agHelper\.sleep|it\.only|after\(|afterEach\(" \
    app/client/cypress/e2e/Regression/ClientSide/Google/EnableGoogle_spec.js || true

# Check for proper selector usage
echo "Checking selector patterns..."
rg -i "\.btn\.|button\[|xpath\=|\.submit" \
    app/client/cypress/e2e/Regression/ClientSide/Google/EnableGoogle_spec.js || true

Length of output: 1033

Copy link

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/11793400879.
Cypress dashboard url: Click here!
All Cypress tests have passed 🎉🎉🎉

***** Repeat Run Summary ***** Total Tests with repeat: 300 Total Passed: 282 Total Failed: 18 Total Skipped: 0 *****************************

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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