Development: Add pre-generated bash scripts for LocalCI

[reschandreas]

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

Client

• Important: I implemented the changes with a very good performance, prevented too many (unnecessary) REST calls and made sure the UI is responsive, even with large data.
• I followed the coding and design guidelines.
• Following the theming guidelines, I specified colors only in the theming variable files and checked that the changes look consistent in both the light and the dark theme.
• I added multiple integration tests (Jest) related to the features (with a high test coverage), while following the test guidelines.
• I added multiple screenshots/screencasts of my UI changes.
• I translated all newly inserted strings into English and German.

Motivation and Context

In order to remove hardcoded scripts within the Java code, we add the generated bash scripts of all aeolus templates to the resources. This allows us to have a good baseline for build scripts.
Now the UI changes a bit for Programming Exercises, if you start Artemis with the profile aeolus, you will be greeted with the existing UI. With localci as a profile, the UI changes to show a single code editor that contains the generated build plan.

Description

I added the class BuildScriptProvider and the abstract class BuildScriptGenerationService. The AeolusBuildScriptGenerationService extends the abstract service to provide a code generation from the windfile. If Aeolus is not active, the BuildScriptProvider will provide the pregenerated bash scripts added by this PR.
In addition to the new classes, we no cache all scripts on the startup of Artemis.

The bash scripts are generated using the new bash script supporting_scripts/generate-aeolus-scripts.sh using Aeolus. To ensure that the windfiles and bash scripts always up-to-date, I added a new workflow that checks and complains if the source and the generated content does not match.

Database revert

In the unlikely case my database change makes problems, use alter table programming_exercise_details drop column build_script; to revert it

Steps for Testing

Prerequisites:

• 1 Instructor
• LocalCI setup or Aeolus setup

1. Log in to Artemis
2. Create a Programming exercise in every language and confirm that the build job works as before.

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

Test Coverage

Client

Class/File	Line Coverage	Confirmation (assert/expect)
programming-exercise.model.ts	100%	✅
programming-exercise-update.component.ts	87.88%	✅
programming-exercise-custom-build-plan.component.ts	94.23%	✅
programming-exercise-docker-image.component.ts	100%	✅
programming-exercise-language.component.ts	100%	✅
aeolus.service.ts	100%	✅

Server

Class/File	Line Coverage	Confirmation (assert/expect)
AeolusTarget.java	100%	✅
ProfileService.java	100%	✅
BuildScriptGenerationService.java	100%	✅
AeolusBuildPlanService.java	87%	✅
AeolusTemplateService.java	92%	✅

Screenshots

Summary by CodeRabbit

• New Features

  • Introduced a new configuration for YAML files in the editor settings.
  • Added a buildScript attribute for programming exercises to handle build configurations.
  • Introduced new constants and services for build script generation and management.
  • Expanded programming exercise features to support custom build plans and Docker image management.

• Enhancements

  • Improved code modularity in ProfileService with refactored methods for profile checks.
  • Enhanced ProgrammingExerciseService with integration of BuildScriptGenerationService.
  • Updated web components to support new programming exercise configurations.

• Bug Fixes

  • Fixed issues related to conditional rendering in programming exercise language components.

• Documentation

  • Updated inline documentation to reflect new features and changes.

• Tests

  • Added and modified test cases to cover new functionality and profile configurations.

• Chores

  • Created supporting scripts for automated script generation.
  • Set up GitHub Actions workflow for consistency checks on scripts.

• Refactor

  • Refactored existing components to integrate new build plan customization options.

• Style

  • Adjusted styles and templates to accommodate new programming exercise attributes.

• Revert

  • No reverts in this release.

[mateusmm01]

New code changes lgtm

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 5a94bc6 and 0c3a812.

Files ignored due to filter (1)

• src/main/resources/config/liquibase/master.xml

Files selected for processing (2)

• src/main/java/de/tum/in/www1/artemis/service/connectors/GenericBuildScriptGenerationService.java (1 hunks)
• src/main/java/de/tum/in/www1/artemis/service/connectors/aeolus/AeolusBuildScriptGenerationService.java (1 hunks)

Additional comments: 5

src/main/java/de/tum/in/www1/artemis/service/connectors/GenericBuildScriptGenerationService.java (2)

• 16-17: The @Profile annotation specifies that this service is active when the aeolus profile is not active and the localci profile is. This is consistent with the PR's objective to support LocalCI.

• 27-28: The constructor is correctly using dependency injection to obtain a BuildScriptProvider. This follows the best practice of constructor injection for dependencies.

src/main/java/de/tum/in/www1/artemis/service/connectors/aeolus/AeolusBuildScriptGenerationService.java (3)

• 15-17: The @Profile annotation specifies that this service is active when both aeolus and localci profiles are active. This seems to be a change from the previous version and should be verified to ensure it aligns with the intended behavior.

Verification successful

---

The review comment is correct. The AeolusBuildScriptGenerationService is intended to be active only when both aeolus and localci profiles are active, as confirmed by the @Profile("aeolus && localci") annotation in the codebase.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Verify that the AeolusBuildScriptGenerationService is intended to be active only when both aeolus and localci profiles are active.
grep -R '@Profile' --include=*.java

Length of output: 19395

* 33-38: The constructor is correctly using dependency injection for `BuildScriptProvider`, `AeolusBuildPlanService`, `AeolusTemplateService`, and `ProfileService`. This follows the best practice of constructor injection for dependencies.

• 41-56: The getScript method now includes logic to handle the case when the localci profile is not active by returning null. It also handles the case when a windfile is not present by attempting to get a default one. The previous comment about returning null still stands, and it would be better to throw a custom exception instead of returning null.

- return null;
+ throw new BuildScriptNotAvailableException("Local CI profile is not active or windfile is not present.");

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 0c3a812 and 9fd2629.

Files selected for processing (1)

• src/main/java/de/tum/in/www1/artemis/service/connectors/aeolus/AeolusBuildScriptGenerationService.java (1 hunks)

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

• src/main/java/de/tum/in/www1/artemis/service/connectors/aeolus/AeolusBuildScriptGenerationService.java

[coderabbitai]

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 9fd2629 and cb98336.

Files selected for processing (2)

• src/main/java/de/tum/in/www1/artemis/service/ProfileService.java (2 hunks)
• src/main/java/de/tum/in/www1/artemis/service/connectors/aeolus/AeolusBuildPlanService.java (5 hunks)

Additional comments: 4

src/main/java/de/tum/in/www1/artemis/service/ProfileService.java (1)

• 25-25: The refactoring of isLocalVcsCi() to use the new methods isLocalVcs() and isLocalCi() is a good example of clean code and improves readability.

src/main/java/de/tum/in/www1/artemis/service/connectors/aeolus/AeolusBuildPlanService.java (3)

• 19-20: The addition of imports for LinkedMultiValueMap and MultiValueMap is necessary for the new generateBuildScript method. Ensure that these classes are used appropriately within the method.

• 43-43: Renaming the LOGGER variable to log aligns with the common Java logging convention and improves readability.

• 92-92: The error handling in the publishBuildPlan method has been updated to use the log variable. Ensure that the logging statements provide enough context for debugging in case of errors.

Also applies to: 111-112

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between cb98336 and 5f65661.

Files selected for processing (1)

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

Files skipped from review due to trivial changes (1)

• src/test/java/de/tum/in/www1/artemis/AbstractSpringIntegrationLocalCILocalVCTest.java

[Mtze]

Changes are looking good to me - Thanks for taking care!

[milljoniaer]

approve after code changes 🚀

[laurenzfb]

changes look good

[mateusmm01]

code changes lgtm

[basak-akan]

code lgtm