Integrated code lifecycle: Regularly clean up stranded build job containers

[laurenzfb]

Checklist

General

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

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

Motivation and Context

In rare cases build job docker containers do not get removed and are left hanging. They are removed when the server is restarted but should also be removed regularly while the server is running.

Description

This PR extends the scheduled container clean up to regularly check for stranded containers while the server is running. How often this is done (default: every 60 min) and at what point a container is considered stranded (default: after 5 min), can be configured with the config variables artemis.continuous-integration.container-cleanup.cleanup-schedule-minutes and ...expiry-minutes

Steps for Testing

Test locally
Prerequisites:

1. Set cleanup-schedule-minutes to 10
2. Create a docker container with the name "local-ci-blabla"
3. Start you Artemis Server (Buildagent is enough)
4. Verify your container gets removed after startup
5. Start another container with the same name
6. Wait for 10 min, it should remove the container again

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

Screenshots

Summary by CodeRabbit

• New Features
  • Implemented a scheduled task for automated container cleanup to enhance system efficiency.
• Refactor
  • Improved container cleanup logic by considering container age.
• Tests
  • Added a test for verifying the removal of stranded containers based on their creation time.
• Chores
  • Updated dependencies and configurations for testing.

[coderabbitai]

Walkthrough

The recent updates focus on streamlining the container cleanup process in a local Continuous Integration (CI) Docker service. Changes include introducing a mechanism to schedule cleanup tasks during initialization, enhancing the cleanup logic based on container age, and optimizing the event handling. Testing capabilities have also been improved with a new test scenario to validate the enhanced cleanup functionality and mocking improvements for more realistic container removal simulations.

Changes

Files	Summary
.../service/connectors/localci/buildagent/LocalCIDockerService.java	- Added java.time.Instant import - Introduced isFirstCleanup flag - Refactored cleanup scheduling - Enhanced cleanUpContainers() logic
.../artemis/localvcci/LocalCIDockerServiceTest.java	- Added imports for testing utilities - Implemented testRemoveStrandedContainers() for cleanup testing
.../artemis/localvcci/LocalCITestConfiguration.java	- Mocked removeContainerCmd with withForce set to true in dockerClient

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/coderabbit-overrides.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.

[rstief]

Code looks good. Also demonstrated in testing session.

[mateusmm01]

Code lgtm! Also demonstrated in testing session and works well