Provide a new Spring Rule checking that service classes do not depend…

… on controllers CLoses gh-33
enofex · Jun 19, 2024 · 75d52d7 · 75d52d7
1 parent 22b1ef7
commit 75d52d7
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 2 deletions.
diff --git a/docs/USERGUIDE.md b/docs/USERGUIDE.md
@@ -54,6 +54,7 @@ Architecture rules are defined using Taikai's fluent API, allowing developers to
 |            | Configurations | `namesShouldMatch`                                     | Configuration classes should match a regex pattern                                                                    | Default (WITHOUT_TESTS) |
 |            | Controllers    | `namesShouldEndWithController`                         | Controllers should end with "Controller"                                                                              | Default (WITHOUT_TESTS) |
 |            | Controllers    | `namesShouldMatch`                                     | Controllers should match a regex pattern                                                                              | Default (WITHOUT_TESTS) |
+|            | Controllers    | `shouldBeAnnotatedWithController`                      | Controllers should be annotated with `@Controller`                                                                    | Default (WITHOUT_TESTS) |
 |            | Controllers    | `shouldBeAnnotatedWithRestController`                  | Controllers should be annotated with `@RestController`                                                                | Default (WITHOUT_TESTS) |
 |            | Controllers    | `shouldBePackagePrivate`                               | Controllers should be package-private                                                                                 | Default (WITHOUT_TESTS) |
 |            | Controllers    | `shouldNotDependOnOtherControllers`                    | Controllers should not depend on other controllers                                                                    | Default (WITHOUT_TESTS) |
@@ -63,6 +64,7 @@ Architecture rules are defined using Taikai's fluent API, allowing developers to
 |            | Services       | `namesShouldEndWithService`                            | Services should end with "Service"                                                                                    | Default (WITHOUT_TESTS) |
 |            | Services       | `namesShouldMatch`                                     | Services should match a regex pattern                                                                                 | Default (WITHOUT_TESTS) |
 |            | Services       | `shouldBeAnnotatedWithService`                         | Services should be annotated with `@Service`                                                                          | Default (WITHOUT_TESTS) |
+|            | Services       | `shouldNotDependOnControllers`                         | Services should not depend on Controllers                                                                             | Default (WITHOUT_TESTS) |
 
 ### Java Configuration
 
@@ -345,14 +347,15 @@ Taikai.builder()
     .check();
 ```
 
-- **Services Configuration**: Ensure that service classes end with "Service" or match a specific regex pattern and are annotated with `@Service`.
+- **Services Configuration**: Ensure that service classes end with "Service" or match a specific regex pattern and are annotated with `@Service` and do not depend on other controllers.
 
 ```java
 Taikai.builder()
     .namespace("com.company.yourproject")
     .spring(spring -> spring
         .services(services -> services
-            .shouldBeAnnotatedWithService()
+            .shouldBeAnnotatedWithService()    
+            .shouldNotDependOnControllers()
             .namesShouldMatch("regex")
             .namesShouldEndWithService()))
     .build()

diff --git a/src/main/java/com/enofex/taikai/spring/ServicesConfigurer.java b/src/main/java/com/enofex/taikai/spring/ServicesConfigurer.java
@@ -1,8 +1,11 @@
 package com.enofex.taikai.spring;
 
 import static com.enofex.taikai.spring.SpringPredicates.ANNOTATION_SERVICE;
+import static com.enofex.taikai.spring.SpringPredicates.annotatedWithControllerOrRestController;
 import static com.enofex.taikai.spring.SpringPredicates.annotatedWithService;
 import static com.tngtech.archunit.lang.conditions.ArchConditions.be;
+import static com.tngtech.archunit.lang.conditions.ArchConditions.dependOnClassesThat;
+import static com.tngtech.archunit.lang.conditions.ArchConditions.not;
 import static com.tngtech.archunit.lang.conditions.ArchPredicates.are;
 import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.classes;
 
@@ -58,5 +61,17 @@ public ServicesConfigurer shouldBeAnnotatedWithService(String regex,
             .as("Services should be annotated with %s".formatted(ANNOTATION_SERVICE)),
         configuration));
   }
+
+  public ServicesConfigurer shouldNotDependOnControllers() {
+    return shouldNotDependOnControllers(null);
+  }
+
+  public ServicesConfigurer shouldNotDependOnControllers(Configuration configuration) {
+    return addRule(TaikaiRule.of(classes()
+            .that(are(annotatedWithService(true)))
+            .should(not(dependOnClassesThat(annotatedWithControllerOrRestController(true))))
+            .as("Services should not depend on Controllers or RestControllers"),
+        configuration));
+  }
 }
 
diff --git a/src/test/java/com/enofex/taikai/Usage.java b/src/test/java/com/enofex/taikai/Usage.java
@@ -23,6 +23,7 @@ public static void main(String[] args) {
                 .namesShouldMatch("regex"))
             .services(services -> services
                 .shouldBeAnnotatedWithService()
+                .shouldNotDependOnControllers()
                 .namesShouldMatch("regex")
                 .namesShouldEndWithService())
             .repositories(repositories -> repositories