Integrated code lifecycle: Add checks for the docker image architecture

[Hialus]

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

We had an issue where a build job for an exercise did not run without any proper error in the client or exception in the log. This was due to the docker image only supporting arm64, while the build agent only supported amd64.

Description

I added some checks and a config value to limit the architecture of the docker images that can be used. By default this is amd64

Steps for Testing

Prerequisites:

• 1 Instructor

1. Log in to Artemis
2. Change the used docker image in an exercise to one that only supports arm64. E.g. just use arm64v8/ubuntu:latest
3. In the logs you will see a proper exception (Build Logs are currently not displayed, due to another LocalCI bug)

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

Virtually unchanged

Summary by CodeRabbit

• Documentation
  • Updated continuous integration setup guide to include ARM architecture specifics.
• New Features
  • Enhanced local continuous integration service to support ARM architecture.
• Tests
  • Improved test configurations and added new test cases to validate ARM architecture handling.
• Bug Fixes
  • Implemented exception handling in Docker image pulling process.

[krusche]

Except two minor comments for improved inline documentation, the code looks good 👍 great work

[krusche]

Code looks good 👍

[coderabbitai]

Walkthrough

The recent updates focus on enhancing Docker integration and testing configurations for ARM-based systems across various Java and RST files. These changes include the addition of new methods for mocking Docker image inspections, updating Docker image architecture settings, and refining exception handling in tests. The modifications aim to improve clarity, extend support for different architectures, and ensure robustness in continuous integration workflows.

Changes

File Path	Change Summary
docs/dev/setup/.../integrated-code-lifecycle.rst	Updated CI configuration settings for ARM architectures and improved comment clarity.
src/main/java/.../LocalCIDockerService.java	Added new fields and methods for Docker image inspection.
src/test/java/.../ProgrammingExerciseLocalVCLocalCIIntegrationTest.java	Added mocking of Docker image inspection in test methods.
src/test/java/.../LocalCIDockerServiceTest.java	Introduced exception handling for LocalCIException.
src/test/java/.../LocalCIIntegrationTest.java	Added Docker image inspection mocking in repository initialization.
src/test/java/.../LocalCITestConfiguration.java	Enhanced mock setup for Docker image pulling.
src/test/java/.../LocalVCLocalCIIntegrationTest.java	Enhanced repository initialization with Docker image inspection mocking.
src/test/java/.../LocalVCLocalCITestService.java	Added methods for mocking Docker image inspection with specific architecture.

---

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.

[laurenzfb]

code lgtm. very good find

[BBesrour]

tested locally

[krusche]

Code looks good 👍