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 RestAPIDatasource #37337

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 path in the Cypress testing environment.

Copy link
Contributor

coderabbitai bot commented Nov 12, 2024

Walkthrough

The changes in this pull request involve updating the limited-tests.txt file, which is utilized in a Cypress testing environment. The primary modification is the replacement of a regression test path with a new sanity test path. Specifically, the entry for Fork_Template_spec.js has been changed to RestApiDatasource_spec.js, while other comments in the file remain unchanged.

Changes

File Path Change Summary
app/client/cypress/limited-tests.txt Updated test specification from cypress/e2e/Regression/ClientSide/Templates/Fork_Template_spec.js to cypress/e2e/Sanity/Datasources/RestApiDatasource_spec.js.

Possibly related PRs

Suggested labels

ok-to-test

Suggested reviewers

  • ApekshaBhosale
  • sagar-qa007

🌟 In the land of tests, a change was made,
From Fork_Template to RestApiDatasource, a new path laid.
With Cypress in hand, we venture forth,
To ensure our sanity, we test with worth!
So here's to the updates, both bright and bold,
In the realm of code, new stories unfold! 🌟


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

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

📒 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 3-6: Consider impact on test coverage

The switch from regression to sanity test might affect overall test coverage. Ensure that critical template forking functionality is covered elsewhere in the test suite.

#!/bin/bash
# Description: Check for other template forking test coverage

# Search for other template-related test files
fd "Template.*spec\.js$" --type f

# Look for fork-related test cases in other files
rg -i "fork.*template" -g "*.{js,ts}"

1-2: Verify the test specification path exists

Let's ensure the new test path exists and follows Cypress conventions.

✅ Verification successful

The previous search didn't yield results, so I'm trying a more targeted approach to:

  1. Find the exact test file
  2. Verify the directory structure exists
  3. Find any similarly named test files

This will help us determine if the path in limited-tests.txt is correct and accessible.


Test specification path is valid and correctly structured

The path cypress/e2e/Sanity/Datasources/RestApiDatasource_spec.js exists and follows Cypress's conventional directory structure. The file location matches exactly with what's specified in the limited-tests.txt configuration.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the existence and structure of the RestApiDatasource_spec.js file

# Check if the test file exists
fd "RestApiDatasource_spec.js" --type f

# Verify the test file structure
if [ -f "app/client/cypress/e2e/Sanity/Datasources/RestApiDatasource_spec.js" ]; then
  # Check for Cypress best practices
  rg -A 5 "cy\.wait|cy\.pause|agHelper\.sleep|it\.only|after\(|afterEach\(" "app/client/cypress/e2e/Sanity/Datasources/RestApiDatasource_spec.js"
  
  # Check for proper selector usage
  rg "\.btn\.|button\[|xpath=|css=" "app/client/cypress/e2e/Sanity/Datasources/RestApiDatasource_spec.js"
fi

Length of output: 4722


Script:

#!/bin/bash
# Let's verify the test file existence with a more specific search
fd "RestApiDatasource_spec.js$" --type f

# Also check the directory structure
fd "Sanity/Datasources$" --type d

# Check if there are any similar test files
fd ".*RestApi.*spec\.js$" --type f

Length of output: 251


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

Copy link

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

***** Repeat Run Summary ***** Total Tests with repeat: 100 Total Passed: 85 Total Failed: 15 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