Integrated code lifecycle: Fix handling of empty error text nodes in XML result parser

[just-max]

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

Motivation and Context

Currently, Artemis fails if test reports contain empty error/failure nodes:

<testsuites>
  <testsuite package="mwe-package" id="0" name="mwe-suite-name" timestamp="2024-08-09T12:34:56"
    hostname="localhost" tests="1" failures="1" errors="0" time="0">
    <properties></properties>
    <testcase name="mwe-name" classname="mwe-class" time="0">
      <failure type="empty"></failure>
    </testcase>
  </testsuite>
</testsuites>

Error while parsing report filegrading.xml [sic], ignoring.

This is because JacksonXMLText deserializes empty text nodes as null instead of "" (or even e.g. " " when the node contains only whitespace). An exception is then raised by List.of from trying to create a List.of list with nulls.

Description

Empty error/failure nodes are instead turned into "".

Steps for Testing

1. Create an exercise that writes the given XML to the test report directory
2. See that an exception is raised (before this fix)
3. After the fix, see that the result is created successfully

I have not had the chance to test this change myself.

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
• I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Exam Mode Test

• Test 1
• Test 2

Test Coverage

Screenshots

@coderabbitai ignore

Summary by CodeRabbit

• Bug Fixes
  • Improved handling of XML deserialization to prevent null assignments in the detailed message field.
  • Ensured that empty text nodes are handled correctly, enhancing the robustness of the application.

[coderabbitai]

Walkthrough

The recent change to the setDetailedMessage method in the TestResultXmlParser class enhances how the detailedMessage field is assigned. It now checks for null values, assigning an empty string instead. This adjustment improves robustness by preventing unintended null assignments during XML deserialization, though it still requires further handling for strings made up solely of whitespace.

Changes

File Path	Change Summary
src/main/java/de/tum/in/www1/artemis/service/connectors/localci/buildagent/TestResultXmlParser.java	Modifies setDetailedMessage method to assign an empty string for null values, improving handling of deserialized XML data.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant TestResultXmlParser
    
    Client->>TestResultXmlParser: setDetailedMessage(detailedMessage)
    alt detailedMessage is null
        TestResultXmlParser-->>Client: detailedMessage is set to ""
    else detailedMessage is not null
        TestResultXmlParser-->>Client: detailedMessage is set to provided value
    end

Loading

---

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

[coderabbitai]

Actionable comments posted: 1

[just-max]

Thanks coderabbit 🤣

@coderabbitai ignore please

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

@just-max: Got it, I'll ignore this comment.

[Strohgelaender]

Changes make sense. Can you also add your example as a test?

[BBesrour]

code lgtm

[MichaelOwenDyer]

Code looks good