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

Development: Fix e2e tests for modeling exercises #9613

Merged
merged 5 commits into from
Oct 27, 2024

Conversation

muradium
Copy link
Contributor

@muradium muradium commented Oct 27, 2024

Checklist

General

Client

Motivation and Context

Some of the E2E tests that use Apollon UMLs fail because of Apollon freeze issue when "Package" UML elements are interacted with. This PR changes these tests to not use any "Package" UML elements as a temporary fix.

Description

Changes UML models to not use "Package" elements.

Steps for Testing

  • Code Review: Ensure that tests pass for valid reasons, functionality is adequately tested and check the code quality.
  • Run the tests (optional): Tests are checked by automatic run in CI environment. You can optionally run them locally and check if they pass.

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked







Review Progress

Code Review

  • Code Review 1
  • Code Review 2

Manual Tests

  • Test 1
  • Test 2

Summary by CodeRabbit

  • New Features

    • Enhanced modeling exercise submission process by adding a fourth component.
    • Improved drag-and-drop functionality by targeting a different element in the sidebar.
  • Bug Fixes

    • Resolved issues related to component addition sequence in modeling exercises.
    • Adjusted element selection for drag-and-drop quizzes to improve user experience.

@muradium muradium requested a review from a team as a code owner October 27, 2024 20:40
Copy link

coderabbitai bot commented Oct 27, 2024

Walkthrough

The changes in this pull request involve modifications to two classes: ExamParticipationPage and DragAndDropQuiz. In ExamParticipationPage, the method makeModelingExerciseSubmission is updated to change the component addition sequence by replacing an argument from 1 to 4. In DragAndDropQuiz, the dragUsingCoordinates method is altered to target a different element in the sidebar by changing the index from nth(2) to nth(3). No other functionalities or error handling aspects are affected.

Changes

File Change Summary
src/test/playwright/support/pageobjects/exam/ExamParticipationPage.ts Modified makeModelingExerciseSubmission to call addComponentToModel with argument 4 instead of 1.
src/test/playwright/support/pageobjects/exercises/quiz/DragAndDropQuiz.ts Changed index in dragUsingCoordinates from nth(2) to nth(3) for element selection.

Possibly related PRs

Suggested labels

bugfix

Suggested reviewers

  • SimonEntholzer
  • krusche
  • BBesrour
  • pzdr7

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 or @coderabbitai title 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.

Copy link

@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

🧹 Outside diff range and nitpick comments (2)
src/test/playwright/support/pageobjects/exercises/quiz/DragAndDropQuiz.ts (1)

31-31: Consider making the sidebar element selection more maintainable.

While the change from nth(2) to nth(3) aligns with the PR's objective to fix UML-related E2E tests, using hardcoded indices makes the test fragile and harder to maintain.

Consider one of these approaches to make the element selection more robust:

- const classElement = this.page.locator('#modeling-editor-sidebar').locator('div').nth(3);
+ // Option 1: Use a more specific selector
+ const classElement = this.page.locator('#modeling-editor-sidebar [data-element-type="class"]');

+ // Option 2: Define the index as a named constant
+ const CLASS_ELEMENT_INDEX = 3;
+ const classElement = this.page.locator('#modeling-editor-sidebar').locator('div').nth(CLASS_ELEMENT_INDEX);

Also, consider adding a comment explaining why this specific index is chosen to help future maintainers understand the context of this change.

src/test/playwright/support/pageobjects/exam/ExamParticipationPage.ts (1)

90-90: LGTM, but document the component numbering.

The change aligns with the PR objective of avoiding Package UML elements. However, please add a comment explaining what each component number (2,3,4) represents in the UML model to improve maintainability.

+        // Component numbers represent different UML elements:
+        // 2: [Please specify the UML element type]
+        // 3: [Please specify the UML element type]
+        // 4: [Please specify the UML element type]
         await this.modelingExerciseEditor.addComponentToModel(exerciseID, 4);
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between b8c922a and 02aa6f5.

📒 Files selected for processing (2)
  • src/test/playwright/support/pageobjects/exam/ExamParticipationPage.ts (1 hunks)
  • src/test/playwright/support/pageobjects/exercises/quiz/DragAndDropQuiz.ts (1 hunks)
🔇 Additional comments (1)
src/test/playwright/support/pageobjects/exam/ExamParticipationPage.ts (1)

89-91: Flag: This appears to be a temporary workaround.

While this change fixes the immediate issue with Package UML elements, it's worth noting that this is a workaround rather than a proper fix for the freeze issue. Consider creating a follow-up ticket to properly address the root cause of the Package element freeze.

Let's verify the component types being used:

@krusche krusche changed the title Development: Fix e2e tests that use UMLs Development: Fix e2e tests for modeling exercises Oct 27, 2024
@krusche krusche added this to the 7.6.4 milestone Oct 27, 2024
@krusche krusche merged commit 9958d17 into develop Oct 27, 2024
30 of 35 checks passed
@krusche krusche deleted the feature/playwright/fix-modeling-exercise-tests branch October 27, 2024 21:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Merged
Development

Successfully merging this pull request may close these issues.

2 participants