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

Find flaky test cause #9873

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from

Conversation

SimonEntholzer
Copy link
Contributor

@SimonEntholzer SimonEntholzer commented Nov 26, 2024

Checklist

General

Server

  • Important: I implemented the changes with a very good performance and prevented too many (unnecessary) and too complex database calls.
  • I strictly followed the principle of data economy for all database calls.
  • I strictly followed the server coding and design guidelines.
  • I added multiple integration tests (Spring) related to the features (with a high test coverage).
  • I added pre-authorization annotations according to the guidelines and checked the course groups for all new REST Calls (security).
  • I documented the Java code using JavaDoc style.

Client

  • Important: I implemented the changes with a very good performance, prevented too many (unnecessary) REST calls and made sure the UI is responsive, even with large data (e.g. using paging).
  • I strictly followed the principle of data economy for all client-server REST calls.
  • I strictly followed the client coding and design guidelines.
  • Following the theming guidelines, I specified colors only in the theming variable files and checked that the changes look consistent in both the light and the dark theme.
  • I added multiple integration tests (Jest) related to the features (with a high test coverage), while following the test guidelines.
  • I added authorities to all new routes and checked the course groups for displaying navigation elements (links, buttons).
  • I documented the TypeScript code using JSDoc style.
  • I added multiple screenshots/screencasts of my UI changes.
  • I translated all newly inserted strings into English and German.

Changes affecting Programming Exercises

  • High priority: I tested all changes and their related features with all corresponding user types on a test server configured with the integrated lifecycle setup (LocalVC and LocalCI).
  • I tested all changes and their related features with all corresponding user types on a test server configured with Gitlab and Jenkins.

Motivation and Context

Description

Steps for Testing

Prerequisites:

  • 1 Instructor
  • 2 Students
  • 1 Programming Exercise with Complaints enabled
  1. Log in to Artemis
  2. Navigate to Course Administration
  3. ...

Exam Mode Testing

Prerequisites:

  • 1 Instructor
  • 2 Students
  • 1 Exam with a Programming Exercise
  1. Log in to Artemis
  2. Participate in the exam as a student
  3. Make sure that the UI of the programming exercise in the exam mode stays unchanged. You can use the exam mode documentation as reference.
  4. ...

Testserver States

Note

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







Review Progress

Performance Review

  • I (as a reviewer) confirm that the client changes (in particular related to REST calls and UI responsiveness) are implemented with a very good performance even for very large courses with more than 2000 students.
  • I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance even for very large courses with more than 2000 students.

Code Review

  • Code Review 1
  • Code Review 2

Manual Tests

  • Test 1
  • Test 2

Exam Mode Test

  • Test 1
  • Test 2

Performance Tests

  • Test 1
  • Test 2

Test Coverage

Screenshots

Summary by CodeRabbit

  • New Features

    • Introduced video recording for Playwright tests, capturing footage only on test failures for improved debugging.
    • Set video dimensions to 1280x720 pixels.
  • Bug Fixes

    • Enhanced test configuration without impacting existing settings or functionalities.

@SimonEntholzer SimonEntholzer requested a review from a team as a code owner November 26, 2024 15:06
Copy link

coderabbitai bot commented Nov 26, 2024

Walkthrough

The changes introduce a new configuration for video recording in the Playwright test setup. A video object has been added to the use settings, specifying that video recording should only be retained on test failures. The dimensions for the video are set to 1280 pixels in width and 720 pixels in height. This addition does not alter the existing configuration structure or functionality related to test execution.

Changes

File Change Summary
src/test/playwright/playwright.config.ts Added a video property in the use object to retain video on test failures with specified dimensions (1280x720).

Possibly related PRs

Suggested labels

ready for review, bugfix

Suggested reviewers

  • krusche
  • florian-glombik

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 (1)
src/test/playwright/playwright.config.ts (1)

31-34: Excellent addition for debugging flaky tests!

The video recording configuration is well-configured for debugging flaky tests:

  • retain-on-failure mode is storage-efficient
  • 720p resolution provides good clarity while keeping file sizes reasonable

For enhanced flaky test debugging, consider also enabling:

  • trace: 'retain-on-failure' instead of current 'on-first-retry' to capture traces for all failures
  • screenshot: 'only-on-failure' to complement video recordings with static snapshots
     use: {
         /* Base URL to use in actions like `await page.goto('/')`. */
         baseURL: process.env.BASE_URL || 'http://localhost:9000',
-        trace: 'on-first-retry',
+        trace: 'retain-on-failure',
+        screenshot: 'only-on-failure',
         ignoreHTTPSErrors: true,
         video: {
             mode: 'retain-on-failure',
             size: { width: 1280, height: 720 },
         },
     },
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 17eb6ce and 0ebed1f.

📒 Files selected for processing (1)
  • src/test/playwright/playwright.config.ts (1 hunks)
🔇 Additional comments (1)
src/test/playwright/playwright.config.ts (1)

31-34: Verify performance impact of video recording

While video recording is valuable for debugging, it's important to ensure it doesn't significantly impact test execution time or resource usage, especially in CI environments.

Consider monitoring:

  1. Test execution times before/after this change
  2. CI pipeline duration
  3. Disk space usage in CI environments
✅ Verification successful

Let me try another verification approach to gather more context about the test configuration and any existing performance considerations.

This will help us understand:

  1. Other video configurations in the codebase
  2. Any existing performance considerations in test files
  3. Presence of video artifacts and their impact

Let me try one more verification to check the video configuration and test setup:

This will help us understand:

  1. The complete video configuration context
  2. How tests are categorized and their timeout settings
  3. Any existing video size constraints

Based on the gathered information, I can now provide a final response:

Video recording configuration is optimized for test failures

The current video configuration is well-balanced for performance and debugging needs:

  • Only retains videos for failed tests (mode: 'retain-on-failure')
  • Uses moderate resolution (720p) that balances quality and resource usage
  • Integrated with test categorization (@fast/@slow) with appropriate timeouts
    • Fast tests: 45s timeout
    • Slow tests: 180s timeout

The configuration minimizes performance impact by:

  1. Recording only failed tests, avoiding unnecessary disk I/O
  2. Using reasonable resolution that won't overload CPU
  3. Having separate timeouts for fast/slow tests to prevent unnecessary recordings
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for existing performance metrics or timing information in test results

# Look for existing test timing information
fd -e xml 'results.xml' | xargs grep -l "testcase.*time=" || echo "No test timing data found"

# Check if there are any performance-related comments in recent commits
git log --grep="performance\|slow\|timing" -n 10

Length of output: 118


Script:

#!/bin/bash
# Check for any existing video configuration in the codebase
rg -A 5 "video:\s*{" 

# Look for any performance-related configurations or comments in test files
rg -i "performance|timeout|slow" --type ts

# Check for any existing video artifacts or size in the repository
fd -g "*.webm" || echo "No video files found"

Length of output: 82917


Script:

#!/bin/bash
# Check for video configuration in playwright config
rg -A 5 'video:' src/test/playwright/playwright.config.ts

# Check for test categorization and timeouts
rg -A 3 '@slow|@fast' src/test/playwright/playwright.config.ts

# Look for any existing video artifacts size limits
rg -i 'size.*width.*height|video.*size' src/test/playwright/

Length of output: 4669

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Work In Progress
Development

Successfully merging this pull request may close these issues.

1 participant