Development: Add check for REST endpoints to be in kebab case

src/test/java/de/tum/in/www1/artemis/architecture/AbstractArchitectureTest.java

@@ -11,6 +11,7 @@
 import java.lang.annotation.Annotation;
 import java.util.Arrays;
 import java.util.Collection;
+import java.util.regex.Pattern;
 
 import org.apache.commons.lang3.ClassUtils;
 import org.junit.jupiter.api.BeforeAll;
@@ -35,6 +36,8 @@ public abstract class AbstractArchitectureTest {
 
     protected static final String ARTEMIS_PACKAGE = "de.tum.in.www1.artemis";
 
+    private static final Pattern KEBAB_CASE_OR_PATH_VARIABLE_PATTERN = Pattern.compile("^([a-z]+(-[a-z]+)*|\\{[^}]+\\}|[a-z]+.json|saml2)$");
+
     protected static JavaClasses testClasses;
 
     protected static JavaClasses allClasses;
@@ -141,6 +144,23 @@ public void check(JavaMethod item, ConditionEvents events) {
         };
     }
 
+    protected ArchCondition<JavaMethod> useKebabCaseForRestAnnotations(DescribedPredicate<? super JavaAnnotation<?>> annotationPredicate) {
+        return new ArchCondition<>("use kebab case for rest mapping annotations") {
+
+            @Override
+            public void check(JavaMethod item, ConditionEvents events) {
+                var restMappingAnnotation = item.getAnnotations().stream().filter(annotationPredicate).findFirst();
+                if (restMappingAnnotation.isPresent()) {
+                    boolean satisfied = Arrays.stream(((String[]) restMappingAnnotation.get().tryGetExplicitlyDeclaredProperty("value").get())[0].split("/"))
+                            .allMatch(part -> KEBAB_CASE_OR_PATH_VARIABLE_PATTERN.matcher(part).matches());
+                    if (!satisfied) {
+                        events.add(violated(item, String.format("%s violates rule to use kebab case for rest call annotations", item.getFullName())));
+                    }
+                }
+            }
+        };
+    }
+
     /**
      * Checks if the given method has a parameter with the given name.
      *

src/test/java/de/tum/in/www1/artemis/architecture/ArchitectureTest.java

@@ -135,6 +135,21 @@
         toListUsage.check(allClasses);
     }
 
+    @Test
+    void testUseKebabCaseForRestEndpoints() {
+        var postMapping = simpleNameAnnotation("PostMapping");
+        var getMapping = simpleNameAnnotation("GetMapping");
+        var putMapping = simpleNameAnnotation("PutMapping");
+        var deleteMapping = simpleNameAnnotation("DeleteMapping");
+
+        Set<DescribedPredicate<? super JavaAnnotation<?>>> allPredicates = Set.of(postMapping, getMapping, putMapping, deleteMapping);
+
+        for (var predicate : allPredicates) {
+            ArchRule restRequestAnnotatedMethods = methods().should(useKebabCaseForRestAnnotations(predicate));
+            restRequestAnnotatedMethods.check(allClasses);
+        }
+    }
+
     @Test
     void testNullnessAnnotations() {
         var notNullPredicate = and(not(resideInPackageAnnotation("jakarta.validation.constraints")), simpleNameAnnotation("NotNull"));