Skip to content

test: add ordering for theme import test to fix flakiness#35473

Merged
nidhi-nair merged 2 commits intoreleasefrom
fix/theme-test
Aug 7, 2024
Merged

test: add ordering for theme import test to fix flakiness#35473
nidhi-nair merged 2 commits intoreleasefrom
fix/theme-test

Conversation

@AnaghHegde
Copy link
Contributor

@AnaghHegde AnaghHegde commented Aug 7, 2024

Description

Tip

Add a TL;DR when the description is longer than 500 words or extremely technical (helps the content, marketing, and DevRel team).

Please also include relevant motivation and context. List any dependencies that are required for this change. Add links to Notion, Figma or any other documents that might be relevant to the PR.

Fixes #Issue Number
or
Fixes Issue URL

Warning

If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

Automation

/ok-to-test tags=""

🔍 Cypress test results

Caution

If you modify the content in this section, you are likely to disrupt the CI result for your PR.

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • Bug Fixes
    • Improved the test execution order for theme import functionality, ensuring consistent and reliable test outcomes.
    • Simplified test structure by consolidating application creation logic within the theme import tests, enhancing readability and maintainability.

@AnaghHegde AnaghHegde self-assigned this Aug 7, 2024
@AnaghHegde AnaghHegde requested a review from a team as a code owner August 7, 2024 07:06
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 7, 2024

Walkthrough

The recent updates to the ThemeImportableServiceCETest class enhance test reliability by introducing the @Order annotation to key test methods, ensuring they execute in a specific sequence. Additionally, several methods were removed, and their logic was integrated directly into the primary test. This consolidation simplifies the code structure, making it more readable and maintainable while potentially improving the interaction with application state during testing.

Changes

Files Change Summary
appsmith-server/src/test/java/com/appsmith/server/services/ce/ThemeImportableServiceCETest.java Added @Order annotations to two test methods for defined execution order; consolidated logic by integrating application creation directly into tests and removed several helper methods.

Sequence Diagram(s)

sequenceDiagram
    participant A as Test Runner
    participant B as ThemeImportableServiceCETest

    A->>B: Start Test Execution
    B->>A: Execute importThemesToApplication_WhenBothImportedThemesAreCustom_NewThemesCreated
    B->>A: Execute importThemesToApplication_ApplicationThemeNotFound_DefaultThemeImported
    A->>B: Finish Test Execution
Loading

Poem

In tests we trust, with order set,
Themes dance in line, no need to fret.
With each execution, clear and bright,
Reliable outcomes, a coder's delight!
🎉 So let us cheer for this refined art,
In the realm of code, we play our part!


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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 Aug 7, 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: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0b1bcf2 and 7a365fe.

Files selected for processing (1)
  • app/server/appsmith-server/src/test/java/com/appsmith/server/services/ce/ThemeImportableServiceCETest.java (3 hunks)
Additional comments not posted (2)
app/server/appsmith-server/src/test/java/com/appsmith/server/services/ce/ThemeImportableServiceCETest.java (2)

163-164: Good practice: Test order specified.

The addition of the @Order(1) annotation ensures that this test runs first, which is crucial for maintaining the sequence of test execution.


206-207: Good practice: Test order specified.

The addition of the @Order(2) annotation ensures that this test runs second, maintaining the sequence of test execution.

@AnaghHegde AnaghHegde requested a review from nidhi-nair August 7, 2024 07:24
Copy link
Contributor

@nidhi-nair nidhi-nair left a comment

Choose a reason for hiding this comment

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

Could you please help understand why these tests are dependent on each other?

@github-actions
Copy link

github-actions bot commented Aug 7, 2024

Failed server tests

  • com.appsmith.server.solutions.AuthenticationServiceTest#testGetAuthorizationCodeURL_validDatasource

@AnaghHegde
Copy link
Contributor Author

@nidhi-nair Its because of the create application flow method that was used by both methods was causing the ids to get messed up.

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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7a365fe and ee9ada5.

Files selected for processing (1)
  • app/server/appsmith-server/src/test/java/com/appsmith/server/services/ce/ThemeImportableServiceCETest.java (4 hunks)
Files skipped from review as they are similar to previous changes (1)
  • app/server/appsmith-server/src/test/java/com/appsmith/server/services/ce/ThemeImportableServiceCETest.java

@github-actions
Copy link

github-actions bot commented Aug 7, 2024

Failed server tests

  • com.appsmith.server.solutions.AuthenticationServiceTest#testGetAuthorizationCodeURL_missingDatasource

1 similar comment
@github-actions
Copy link

github-actions bot commented Aug 7, 2024

Failed server tests

  • com.appsmith.server.solutions.AuthenticationServiceTest#testGetAuthorizationCodeURL_missingDatasource

@nidhi-nair nidhi-nair merged commit c8efe56 into release Aug 7, 2024
@nidhi-nair nidhi-nair deleted the fix/theme-test branch August 7, 2024 11:20
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.

2 participants