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: adding test for git import export for gitconnected app #37604

Closed
wants to merge 1 commit into from

Conversation

NandanAnantharamu
Copy link
Collaborator

@NandanAnantharamu NandanAnantharamu commented Nov 20, 2024

Added test for git import and export for a git connected app

Summary by CodeRabbit

  • New Features

    • Introduced a comprehensive suite of end-to-end tests for partial import and export functionality within Git-connected applications.
    • Validated various scenarios including exporting/importing elements, re-importing to the same page, importing into new applications, and importing to a Git branch.
  • Tests

    • Added multiple test cases to ensure robustness of the import/export features.

Copy link
Contributor

coderabbitai bot commented Nov 20, 2024

Walkthrough

This pull request introduces a new Cypress end-to-end test suite for the partial import and export functionality in a Git-connected application. The suite includes four test cases that validate various scenarios, such as exporting and importing elements, re-importing to the same page, importing into a new application, and importing to a Git branch. The tests are structured to ensure comprehensive coverage of the import/export processes and utilize helper functions for managing application state.

Changes

File Path Change Summary
app/client/cypress/e2e/Regression/ClientSide/PartialImportExport/PartialImportWithGitConnectedApp_spec.ts - New test suite added for partial import/export functionality.
- Four new test cases added covering various import/export scenarios.

Possibly related PRs

Suggested labels

ok-to-test, Test, Git Product, Git Platform Pod, Enhancement

Suggested reviewers

  • ApekshaBhosale
  • sagar-qa007
  • brayn003

🎉 In the land of code where widgets play,
New tests emerge to save the day!
With imports and exports, they dance and twirl,
Validating functions in a testing whirl.
Git branches await, as scenarios unfold,
A suite of tests, brave and bold! 🌟


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 20, 2024
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: 2

🧹 Outside diff range and nitpick comments (2)
app/client/cypress/e2e/Regression/ClientSide/PartialImportExport/PartialImportWithGitConnectedApp_spec.ts (2)

33-33: Remove empty beforeEach block.

Empty beforeEach blocks should be removed to maintain clean test code.

-    beforeEach(() => {});

35-188: Consider extracting common import/export steps into helper functions.

The test cases contain repeated patterns for importing widgets and queries. Consider creating helper functions to reduce code duplication:

const importWidgetsAndQueries = (widgetFile: string, queryFile: string) => {
  // Import Widgets
  partialImportExport.OpenImportModal();
  partialImportExport.ImportPartiallyExportedFile(
    widgetFile,
    "Widgets",
    ["Table1", "Button1"],
  );

  // Import Queries
  partialImportExport.OpenImportModal();
  partialImportExport.ImportPartiallyExportedFile(
    queryFile,
    "Queries",
    ["Api1"],
  );
};
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 81b7727 and af2e4b9.

📒 Files selected for processing (1)
  • app/client/cypress/e2e/Regression/ClientSide/PartialImportExport/PartialImportWithGitConnectedApp_spec.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
app/client/cypress/e2e/Regression/ClientSide/PartialImportExport/PartialImportWithGitConnectedApp_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.
🔇 Additional comments (2)
app/client/cypress/e2e/Regression/ClientSide/PartialImportExport/PartialImportWithGitConnectedApp_spec.ts (2)

1-15: LGTM! Well-organized imports and setup.

The imports are properly structured using ObjectsCore, and constants are appropriately defined.


137-138: Verify the purpose of consecutive CreateGitBranch calls.

Two consecutive CreateGitBranch calls seem suspicious. The second call has no branch name parameter.

Comment on lines +60 to +61
partialImportExport.OpenImportModal();
partialImportExport.ImportPartiallyExportedFile(
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Refactor duplicate OpenImportModal calls.

Multiple consecutive calls to OpenImportModal are redundant and should be removed.

-      partialImportExport.OpenImportModal();
       partialImportExport.ImportPartiallyExportedFile(

Also applies to: 68-69, 143-144, 151-152, 168-169, 176-177

fixtureName,
);

cy.wait(5000);
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Replace cy.wait with proper assertions.

Using cy.wait is against the coding guidelines. Instead, wait for specific elements or network requests to complete.

-      cy.wait(5000);
+      // Wait for specific condition instead, e.g.:
+      agHelper.AssertElementVisibility(locators._newPage);

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

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

github-actions bot commented Dec 5, 2024

This PR has been closed because of inactivity.

@github-actions github-actions bot closed this Dec 5, 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