Development: Fix Docker container cleanup issue

[laurenzfb]

Checklist

General

• I tested all changes and their related features with all corresponding user types locally (difficult to test otherwise).
• 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 documented the Java code using JavaDoc style.

Motivation and Context

There was an issue with the cleanup for stranded Docker containers that would cause containers that were not outdated to be removed by the service causing an unhandled exception. The issue was caused due to some time unit differences.

Description

This PR fixes the Docker container cleanup by using the unified time units to calculate whether a container is outdated or not. Furthermore, we add some additional exception handling and adapt a test.

Steps for Testing

Only test locally
Prerequisites:

1. In your application-local.yml, add the values

artemis:
    continuous-integration:
        container-cleanup:
            expiry-minutes: 4
            cleanup-schedule-minutes: 8

2. Start your Artemis Server
3. Right after the startup (after you see the first cleanup in the logs), create a Docker container with the name local-ci-1
4. 4 min later, create another container local-ci-2
5. Wait until the next cleanup (8 min after startup), verify that the cleanup deletes container local-ci-2
6. In the next cleanup, the second container should be removed

Testserver States

Note

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

Review Progress

Performance Review

• 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

Test Coverage

Server

Class/File	Line Coverage	Confirmation (assert/expect)
BuildJobContainerService.java	73%	✅
LocalCIDockerService.java	87%	✅

Summary by CodeRabbit

Summary by CodeRabbit

• Bug Fixes

  • Improved error handling in Docker command executions by using a more specific exception.
  • Broadened exception handling in build job execution to improve reliability.

• Refactor

  • Adjusted time calculations for container cleanup from milliseconds to seconds to enhance accuracy.

• Tests

  • Updated time calculation methods in tests to use Instant for more precise simulation of container creation times.

[coderabbitai]

Walkthrough

The updates involve enhancing exception handling and refining time calculations in the local continuous integration (CI) services of a Java application. Changes include better management of Docker-related exceptions, a more generalized exception catching strategy in build job execution, and improved accuracy in time-based operations for Docker container management and testing.

Changes

File Path	Change Summary
.../buildagent/BuildJobContainerService.java .../buildagent/BuildJobManagementService.java	Improved exception handling by catching ConflictException in BuildJobContainerService and using a more general exception catch in BuildJobManagementService.
.../buildagent/LocalCIDockerService.java	Adjusted time calculations in cleanUpContainers from milliseconds to seconds for determining container age thresholds.
.../localvcci/LocalCIDockerServiceTest.java	Updated mocking of container creation time to use Instant, enhancing the precision of time calculations in tests.

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c6a24ad and a419e17.

Files selected for processing (2)

• src/main/java/de/tum/in/www1/artemis/service/connectors/localci/buildagent/BuildJobContainerService.java (2 hunks)
• src/main/java/de/tum/in/www1/artemis/service/connectors/localci/buildagent/BuildJobManagementService.java (1 hunks)

Files skipped from review as they are similar to previous changes (2)

• src/main/java/de/tum/in/www1/artemis/service/connectors/localci/buildagent/BuildJobContainerService.java
• src/main/java/de/tum/in/www1/artemis/service/connectors/localci/buildagent/BuildJobManagementService.java

---

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.

[milljoniaer]

Code looks good 👍

[rstief]

Demonstrated in testing session, code also LGTM 👍