Development: Add build config entity for programming exercises

[BBesrour]

🚨🚨🚨USE ONLY TS3 DO NOT DEPLOY TO TEST SERVERS 🚨🚨🚨

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.

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 strictly followed the client coding and design guidelines.

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).
• I tested all changes and their related features with all corresponding user types on a test server configured with Gitlab and Jenkins.

Motivation and Context

To reduce database queries, we want to move some attributes from ProgrammingExercise to a new entity, ProgrammingExerciseBuildConfig. This is the first PR for this issue #8887

Steps for Testing

PLEASE DON'T DEPLOY TO TEST SERVERS UNTIL CODE REVIEWS ARE DONE
There are no particular testing steps, please test everything that comes to mind that's related to programming exercises. And please specify what you tested in a comment
General testing steps:

• Check that you can submit programming exercises and that it works as expected.
• Try editing a programming exercise, please change the values relevant to the build, like buildscript, sequential tests, etc make sure that the values are saved correctly
• Import an exercise (normal import within Artemis)
• Export exercise
• Import an exercise from file
• Repeat steps for exam

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

Summary by CodeRabbit

• New Features

  • Introduced a dedicated configuration entity for programming exercises, enhancing management of build settings.
  • Enhanced data retrieval methods to include associated build configurations, improving the completeness of programming exercise data.

• Bug Fixes

  • Improved handling of build configurations to ensure they are saved and retrieved correctly across various services and tests.

• Tests

  • Updated multiple test cases to incorporate and validate the new build configuration management, ensuring comprehensive testing of programming exercises.
  • Refactored tests to utilize build configurations in assertions and setup processes, improving test reliability and accuracy.

[github-actions]

There hasn't been any activity on this pull request recently. Therefore, this pull request has been automatically marked as stale and will be closed if no further activity occurs within seven days. Thank you for your contributions.

[coderabbitai]

Actionable comments posted: 34

Outside diff range comments (1)

src/test/java/de/tum/in/www1/artemis/exercise/programming/ProgrammingExerciseFactory.java (1)

Line range hint 124-142: Encapsulation Improvement Suggestion

Consider encapsulating build configuration setup within ProgrammingExerciseBuildConfig to promote modularity and reduce direct manipulation of its properties.

public class ProgrammingExerciseBuildConfig {
    public void initializeDefaults() {
        this.setTestwiseCoverageEnabled(false);
        this.setBuildScript("Some script");
        this.setBuildPlanConfiguration("{\"api\":\"v0.0.1\",\"metadata\":{},\"actions\":[]}");
        this.setBranch(DEFAULT_BRANCH);
    }
}

[coderabbitai]

Actionable comments posted: 19

[JohannesStoehr]

Code

[coderabbitai]

Actionable comments posted: 29

Outside diff range comments (1)

src/main/java/de/tum/in/www1/artemis/service/connectors/gitlabci/GitLabCIService.java (1)

Line range hint 173-173: Consider addressing TODO comments for variable management.

The TODOs suggest improvements in managing variables at the group level and updating existing ones.

Would you like assistance in implementing these improvements or opening a GitHub issue to track them?

[coderabbitai]

Actionable comments posted: 26