Development: Allow all filenames in programming exercise templates

[magaupp]

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

Programming exercise templates cannot include files without file extensions (Makefile) and .gitignore/.gitattributes without the use of a workaround. Directories with dots in their name (.config/) are not possible at all. The workaround requires the template author to use an alternative name which is replaced with the required name from a set of predefined translations (Makefile.file => Makefile).

This makes the authoring of programming exercise templates error-prone and more difficult than necessary.

Description

.gitignore and .gitattributes are removed from gradle's default excludes.

The ResourceLoaderService is modified to remove directories from the results. This is what all use-cases expect.

The ant pattern meaning to represent all files is adjusted to not include a dot.

Steps for Testing

These instructions use a C programming language template which does not support GitlabCI.
Deploy to a test server which uses the Integrated Code Lifecycle if you follow them.

Prerequisites:

• 1 Instructor
• 1 Course

1. Log in to Artemis
2. Navigate to Course Administration of the Course
3. Create a new Programming Exercise
4. Select C for the programming language
5. Select GCC for the project type
6. Fill out the remaining fields
7. Save the exercise
8. Clone the exercise repository
9. The repository should contain the .gitignore, .gitattributes and Makefile files

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)
FileService.java	89%	✅
ResourceLoaderService.java	89%	✅

[coderabbitai]

Walkthrough

The recent updates primarily involve renaming methods and constants in ResourceLoaderService.java to enhance clarity and consistency. Additionally, the settings.gradle file now includes configurations for the 'Artemis' project and modifications to handle .gitattributes and .gitignore files. Several service classes and test files have been updated to reflect these changes, ensuring that resource loading operations align with the new method names.

Changes

File Path	Change Summary
settings.gradle	Added import org.apache.tools.ant.DirectoryScanner and configurations for 'Artemis' project.
src/main/java/.../ResourceLoaderService.java	Renamed methods and constants for clarity; added a new private method for filtering file resources.
src/main/java/.../BuildScriptProviderService.java	Updated cacheOnBoot method to use getFileResources instead of getResources.
src/main/java/.../AeolusTemplateService.java	Modified cacheOnBoot method to use getFileResources instead of getResources.
src/main/java/.../JavaTemplateUpgradeService.java	Changed getTemplateResources method to use getFileResources instead of getResources.
src/main/java/.../ProgrammingExerciseRepositoryService.java	Replaced getResources calls with getFileResources for resource loading operations.
src/test/java/.../FileServiceTest.java	Removed testRenameSpecialFilename; updated copyResources method to use getFileResources.
src/test/java/.../ResourceLoaderServiceTest.java	Renamed method calls to align with updated method names; added new test methods for resource loading scenarios.

---

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.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @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.

[magaupp]

Administrators who made use of the filename translations in template overrides could experience issues. However, this translation behavior was never mentioned in the documentation. How should we handle this?

[b-fein]

Administrators who made use of the filename translations in template overrides could experience issues. However, this translation behavior was never mentioned in the documentation. How should we handle this?

It is only possible since release 7.0.1 (#8380) to override such files. Before that only files in templates/jenkins/** could be overridden in the filesystem.

Since this feature does not exist for long, I don’t assume this feature to be widely used (if at all). I think breaking this without backwards compatibility is therefore fine.

[b-fein]

That’s a nice improvement. Thanks for implementing this.

Code looks good. 👍

[edkaya]

I can not change the programming language to C, it only shows Java and Empty. Am I doing something wrong?

[magaupp]

@edkaya Test Server 5 uses GitlabCI which is only supported by these 2 templates.

The Java template has the git files but no extension-less files you could check for.

[kaancayli]

Tested on TS4. Works as expected. Code looks good 👍🏻. Can verify that the cloned repository includes Makefile, .gitignore and .gitattributes files

[DominikRemo]

Tested in testing session on ts4. LGTM

[SimonEntholzer]

Tested during testing session 👍

[coolchock]

tested during testing session, the repositories include files starting with . and Makefile

[EneaGore]

Tested during testing session in ts4.