Development: Add architecture test for endpoint naming conventions

[Strohgelaender]

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

• I strictly followed the server coding and design guidelines.

Motivation and Context

We want to enforce consistency when setting endpoint path values.

Description

This adds an architecture test checking for leading and trailing slashes in request mapping annotations.

Steps for Testing

code review

Review Progress

Code Review

• Code Review 1
• Code Review 2

Summary by CodeRabbit

• New Features

  • Enhanced API endpoint consistency across various resources by standardizing URL path formats.
  • Improved dynamic registration for LTI 1.3 configurations.

• Bug Fixes

  • Corrected API endpoint paths in multiple resources to ensure proper access and functionality.

• Documentation

  • Updated API annotations for clarity and compliance with standard practices.

• Refactor

  • Standardized endpoint declarations across multiple classes to improve maintainability and readability.

[coderabbitai]

Walkthrough

The recent updates focus on standardizing API endpoint paths across various resources in the Artemis project. By removing incorrect leading slashes and adjusting @RequestMapping annotations, the changes aim to enhance consistency and streamline endpoint definitions. This effort can simplify development and testing processes, potentially improving overall code maintainability.

Changes

Files	Change Summary
CustomLti13Configurer.java	Corrected LTI13_BASE_PATH definition by adding a leading slash and adjusting loginPath.
AeolusTemplateResource.java, ApollonDiagramResource.java, TextSubmissionResource.java, GroupChatResource.java, OneToOneChatResource.java	Updated @RequestMapping or @GetMapping annotations to include/exclude trailing/leading slashes.
CompetencyResource.java, ModelingSubmissionResource.java, ProgrammingExerciseParticipationResource.java	Removed leading slashes from @PostMapping or @GetMapping annotations.
LectureResource.java, BuildJobQueueResource.java	Modified @GetMapping annotation paths.
QuizExerciseResource.java, RepositoryProgrammingExerciseParticipationResource.java	Updated @PostMapping, @PutMapping, and @GetMapping annotations.
StudentExamResource.java, AdminBuildJobQueueResource.java, AdminLtiConfigurationResource.java, ProgrammingExerciseResource.java, PushNotificationResource.java	Adjusted endpoint paths in annotations.
TeamResource.java	Modified @GetMapping annotation path.
ChannelResource.java, ConversationResource.java	Updated @RequestMapping annotations.
PublicOAuth2JWKSResource.java, ResourceArchitectureTest.java	Removed leading slash from @GetMapping annotation.
Lti13LaunchIntegrationTest.java	Refactored endpoint paths related to LTI 1.3 authentication callbacks.
AbstractArchitectureTest.java, ArchitectureTest.java	Added new methods and conditions related to @RequestMapping annotations.

Possibly related issues

• Parsing of server sided endpoints #8429: The recent changes align with the automation goals of this issue by standardizing endpoint paths, facilitating easier parsing and analysis. This standardization could support efficient endpoint identification in GitHub actions development as described in the issue.

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 69934c7 and 2cd4552.

Files selected for processing (1)

• src/main/java/de/tum/in/www1/artemis/web/rest/QuizExerciseResource.java (4 hunks)

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

• src/main/java/de/tum/in/www1/artemis/web/rest/QuizExerciseResource.java

---

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.

[coderabbitai]

Actionable comments posted: 1

[MaximilianAnzinger]

Looks good

One comment: Maybe we should add URLs with the following pattern: {resourceId}/{resourceId} as a violation?

[Strohgelaender]

We currently have some violations here, e.g. files/attachments/lecture/{lectureId}/{filename}. Since these are endpoints that are also used by the Artemis-Apps, I'll not touch them in this PR.

[rstief]

LGTM overall, just two minor comments 👍

[rstief]

Code LGTM

[coolchock]

code LGTM

[marlon-luca-bu]

nice improvement 👍 ... Code LGTM

[DominikRemo]

Code LGTM and tests succeed

[laadvo]

Code LGTM