Programming exercises: Fix an issue when parsing empty files

[Strohgelaender]

Checklist

General

• I tested all changes and their related features with all corresponding user types on a test server.
• This is a small issue that I tested locally and was confirmed by another developer on a test server.
• Language: I followed the guidelines for inclusive, diversity-sensitive, and appreciative language.
• I chose a title conforming to the naming conventions for pull requests.

Server

• Important: I implemented the changes with a very good performance and prevented too many (unnecessary) database calls.
• I strictly followed the server coding and design guidelines.
• I documented the Java code using JavaDoc style.

Motivation and Context

We encountered an issue where students saw a "Failed to process build results" error.

Description

The error was caused by trying to parse an empty string, which we now filter out.

Steps for Testing

Create a new PE with language empty and a buildscript like this:
echo "" > results.xml

Test that you see a build failed results, but without any internal exceptions in the log.

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

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Summary by CodeRabbit

• New Features

  • Improved handling of empty test result files by logging a warning and updating build logs accordingly.

• Tests

  • Added a new test to validate the handling of empty test result files.

[coderabbitai]

Walkthrough

The changes involve modifying the BuildJobExecutionService to handle empty test result files by adding a conditional check, logging a warning, and updating build logs. Additionally, a constant is added in AbstractSpringIntegrationLocalCILocalVCTest for the empty test results path, and a new test method, testEmptyResultFile, is introduced in LocalCIIntegrationTest to validate this new functionality.

Changes

Files	Change Summary
.../localci/buildagent/BuildJobExecutionService.java	Added a check for empty test result files, logging a warning and updating build logs if the file is empty.
.../AbstractSpringIntegrationLocalCILocalVCTest.java	Introduced a new constant EMPTY_TEST_RESULTS_PATH to represent the path for empty test result files.
.../localvcci/LocalCIIntegrationTest.java	Added a new test method testEmptyResultFile() to verify the handling of empty test result files in build logs and logs.

Sequence Diagram(s)

sequenceDiagram
    participant LocalCIIntegrationTest
    participant BuildJobExecutionService

    LocalCIIntegrationTest->>BuildJobExecutionService: testEmptyResultFile()
    BuildJobExecutionService-->>BuildJobExecutionService: if (testResultFileString.isBlank())
    BuildJobExecutionService-->>BuildJobExecutionService: log.warn(msg)
    BuildJobExecutionService-->>BuildJobExecutionService: buildLogsMap.appendBuildLogEntry(buildJobId, msg)
    LocalCIIntegrationTest->>BuildJobExecutionService: assert log and buildLog entry

Loading

Tip

AI model upgrade

gpt-4o model for reviews and chat is now live

OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our Discord Community to provide any feedback or to report any issues.

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between a394ae8 and 88aca99.

Files ignored due to path filters (1)

• src/test/resources/test-data/test-results/java-gradle/empty/results.xml is excluded by !**/*.xml

Files selected for processing (2)

• src/test/java/de/tum/in/www1/artemis/AbstractSpringIntegrationLocalCILocalVCTest.java (1 hunks)
• src/test/java/de/tum/in/www1/artemis/localvcci/LocalCIIntegrationTest.java (1 hunks)

Additional context used

Path-based instructions (2)

src/test/java/de/tum/in/www1/artemis/AbstractSpringIntegrationLocalCILocalVCTest.java (1)

Pattern src/test/java/**/*.java: test_naming: descriptive; test_size: small_specific; fixed_data: true; junit5_features: true; assert_use: assertThat; assert_specificity: true; archunit_use: enforce_package_rules; db_query_count_tests: track_performance; util_service_factory_pattern: true; avoid_db_access: true; mock_strategy: static_mocks; context_restart_minimize: true

src/test/java/de/tum/in/www1/artemis/localvcci/LocalCIIntegrationTest.java (1)

Pattern src/test/java/**/*.java: test_naming: descriptive; test_size: small_specific; fixed_data: true; junit5_features: true; assert_use: assertThat; assert_specificity: true; archunit_use: enforce_package_rules; db_query_count_tests: track_performance; util_service_factory_pattern: true; avoid_db_access: true; mock_strategy: static_mocks; context_restart_minimize: true

Additional comments not posted (2)

src/test/java/de/tum/in/www1/artemis/AbstractSpringIntegrationLocalCILocalVCTest.java (1)

143-143: Addition of EMPTY_TEST_RESULTS_PATH constant looks good.

The added constant aligns with the PR objective to handle empty test result files.

src/test/java/de/tum/in/www1/artemis/localvcci/LocalCIIntegrationTest.java (1)

382-399: New test method testEmptyResultFile looks good.

The added test method correctly verifies handling of empty test result files and follows best practices.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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 Configration 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.

[krusche]

Code looks good to me 👍