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 API Edit spec #37240

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

Conversation

NandanAnantharamu
Copy link
Collaborator

@NandanAnantharamu NandanAnantharamu commented Nov 5, 2024

/ci-test-limit-count run_count=100

Summary by CodeRabbit

  • Chores
    • Updated the test specification path to focus on server-side API edit tests instead of client-side template tests.

Copy link
Contributor

coderabbitai bot commented Nov 5, 2024

Walkthrough

The pull request updates the limited-tests.txt file in the Cypress testing environment by changing the path of a specified test case. The previous path for a client-side template test has been replaced with a new path pointing to a server-side API edit test. The overall structure and comments in the file remain unchanged.

Changes

File Path Change Summary
app/client/cypress/limited-tests.txt Updated test specification path from cypress/e2e/Regression/ClientSide/Templates/Fork_Template_spec.js to cypress/e2e/Regression/ServerSide/ApiTests/API_Edit_spec.js.

Possibly related PRs

Suggested labels

ok-to-test

Suggested reviewers

  • ApekshaBhosale
  • sagar-qa007

🎉 In the land of tests, a shift we see,
From client-side worries to server-side glee.
A path now leads where APIs play,
In Cypress we trust, come what may!
With limited-tests.txt, we pave the way,
For better tests, hip-hip-hooray! 🎊


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 0b2cffb and 17a019c.

📒 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.
🔇 Additional comments (2)
app/client/cypress/limited-tests.txt (2)

Line range hint 1-6: File structure and comments look good.

The file maintains its proper structure with clear comments explaining its purpose and usage.


2-2: Verify the API Edit spec exists and follows best practices.

The path change looks correct, but let's verify the existence of the API test specification and ensure it follows Cypress best practices.

✅ Verification successful

API Edit spec exists and follows Cypress best practices

The test file exists and follows good practices:

  • Uses page object pattern with proper imports
  • Avoids hard-coded selectors by using locators
  • Contains well-structured test cases with clear descriptions
  • No anti-patterns like arbitrary waits or .only blocks
  • Proper test organization with describe and it blocks
  • Uses appropriate tags for test categorization
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify the existence of the API Edit spec
if [ -f "app/client/cypress/e2e/Regression/ServerSide/ApiTests/API_Edit_spec.js" ]; then
    echo "API Edit spec exists"
    # Check for common anti-patterns
    echo "Checking for anti-patterns..."
    rg -i "cy\.wait|cy\.pause|agHelper\.sleep|it\.only|after\(|afterEach\(" "app/client/cypress/e2e/Regression/ServerSide/ApiTests/API_Edit_spec.js"
    # Check for proper selector usage
    echo "Checking selector patterns..."
    rg -i "\.btn\.|button\[|xpath =|cy\.get\('[^data-]" "app/client/cypress/e2e/Regression/ServerSide/ApiTests/API_Edit_spec.js"
else
    echo "Warning: API Edit spec not found at the specified path"
fi

Length of output: 545


Script:

#!/bin/bash
# Let's check the actual content of the API Edit spec to verify its structure and best practices
if [ -f "app/client/cypress/e2e/Regression/ServerSide/ApiTests/API_Edit_spec.js" ]; then
    echo "=== API Edit spec content ==="
    cat "app/client/cypress/e2e/Regression/ServerSide/ApiTests/API_Edit_spec.js"
else
    # Try to find the correct path using fd
    echo "=== Searching for API_Edit_spec.js ==="
    fd "API_Edit_spec.js" app/client/cypress
fi

Length of output: 4088


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.

@NandanAnantharamu
Copy link
Collaborator Author

/ci-test-limit-count run_count=100

@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 5, 2024
Copy link

github-actions bot commented Nov 5, 2024

Copy link

github-actions bot commented Nov 5, 2024

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

***** Repeat Run Summary ***** Total Tests with repeat: 500 Total Passed: 491 Total Failed: 9 Total Skipped: 0 *****************************

@NandanAnantharamu
Copy link
Collaborator Author

/ci-test-limit-count run_count=100

Copy link

Copy link

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

***** Repeat Run Summary ***** Total Tests with repeat: 500 Total Passed: 488 Total Failed: 12 Total Skipped: 0 *****************************

Copy link

This PR has not seen activitiy for a while. It will be closed in 7 days unless further activity is detected.

@github-actions github-actions bot added the Stale label Nov 20, 2024
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 Stale Test
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant