Added new ArchUnit rules

fuinorg · Mar 30, 2024 · 4e9d94d · 4e9d94d
1 parent 35c5dc7
commit 4e9d94d
Show file tree

Hide file tree

Showing 18 changed files with 207 additions and 82 deletions.
diff --git a/core/src/main/java/org/fuin/ddd4j/core/AggregateNoCache.java b/core/src/main/java/org/fuin/ddd4j/core/AggregateNoCache.java
@@ -17,12 +17,15 @@
  */
 package org.fuin.ddd4j.core;
 
+import org.fuin.utils4j.TestOmitted;
+
 /**
  * Never caches anything.
  *
  * @param <AGGREGATE>
  *            Type of the aggregate.
  */
+@TestOmitted("Nothing useful to test")
 public final class AggregateNoCache<AGGREGATE> implements AggregateCache<AGGREGATE> {
 
     @Override

diff --git a/core/src/main/java/org/fuin/ddd4j/core/Ddd4JUtils.java b/core/src/main/java/org/fuin/ddd4j/core/Ddd4JUtils.java
@@ -17,9 +17,12 @@
  */
 package org.fuin.ddd4j.core;
 
+import org.fuin.utils4j.TestOmitted;
+
 /**
  * Utility methods and constants.
  */
+@TestOmitted("Currently nothing to test")
 public final class Ddd4JUtils {
 
     /**

diff --git a/core/src/test/java/org/fuin/ddd4j/core/AggregateNoCacheTest.java b/core/src/test/java/org/fuin/ddd4j/core/AggregateNoCacheTest.java
diff --git a/core/src/test/java/org/fuin/ddd4j/core/ArchitectureTest.java b/core/src/test/java/org/fuin/ddd4j/core/ArchitectureTest.java
@@ -40,7 +40,7 @@ public class ArchitectureTest {
                     "org.fuin.objects4j.common..",
                     "org.fuin.objects4j.core..",
                     "org.fuin.objects4j.ui..",
-                    "org.fuin.utils4j.jandex..",
+                    "org.fuin.utils4j..",
                     "org.jboss.jandex..",
                     "org.slf4j..");
 

diff --git a/core/src/test/java/org/fuin/ddd4j/core/BaseTest.java b/core/src/test/java/org/fuin/ddd4j/core/BaseTest.java
@@ -22,6 +22,7 @@
 import com.tngtech.archunit.junit.ArchIgnore;
 import com.tngtech.archunit.junit.ArchTest;
 import com.tngtech.archunit.lang.ArchRule;
+import org.fuin.units4j.archunit.Units4JConditions;
 
 import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.classes;
 import static org.fuin.units4j.archunit.AllTopLevelClassesHaveATestCondition.haveACorrespondingClassEndingWith;
@@ -30,16 +31,7 @@
 class BaseTest {
 
     @ArchTest
-    static final ArchRule all_classes_should_have_tests =
-            classes()
-                    .that()
-                    .areTopLevelClasses()
-                    .and().areNotInterfaces()
-                    .and().areNotRecords()
-                    .and().areNotEnums()
-                    .and().doNotHaveModifier(JavaModifier.ABSTRACT)
-                    .and().areNotAnnotatedWith(ArchIgnore.class)
-                    .should(haveACorrespondingClassEndingWith("Test"));
+    static final ArchRule all_classes_should_have_tests = Units4JConditions.ALL_CLASSES_SHOULD_HAVE_TESTS;
 
 }
 
diff --git a/core/src/test/java/org/fuin/ddd4j/core/Ddd4JUtilsTest.java b/core/src/test/java/org/fuin/ddd4j/core/Ddd4JUtilsTest.java
diff --git a/esc/pom.xml b/esc/pom.xml
@@ -63,6 +63,12 @@
             <scope>test</scope>
         </dependency>
 
+        <dependency>
+            <groupId>org.fuin</groupId>
+            <artifactId>utils4j</artifactId>
+            <scope>test</scope>
+        </dependency>
+
         <dependency>
             <groupId>org.fuin.esc</groupId>
             <artifactId>esc-mem</artifactId>

diff --git a/esc/src/test/java/org/fuin/ddd4j/esc/BaseTest.java b/esc/src/test/java/org/fuin/ddd4j/esc/BaseTest.java
@@ -22,6 +22,7 @@
 import com.tngtech.archunit.junit.ArchIgnore;
 import com.tngtech.archunit.junit.ArchTest;
 import com.tngtech.archunit.lang.ArchRule;
+import org.fuin.units4j.archunit.Units4JConditions;
 
 import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.classes;
 import static org.fuin.units4j.archunit.AllTopLevelClassesHaveATestCondition.haveACorrespondingClassEndingWith;
@@ -30,16 +31,7 @@
 class BaseTest {
 
     @ArchTest
-    static final ArchRule all_classes_should_have_tests =
-            classes()
-                    .that()
-                    .areTopLevelClasses()
-                    .and().areNotInterfaces()
-                    .and().areNotRecords()
-                    .and().areNotEnums()
-                    .and().doNotHaveModifier(JavaModifier.ABSTRACT)
-                    .and().areNotAnnotatedWith(ArchIgnore.class)
-                    .should(haveACorrespondingClassEndingWith("Test"));
+    static final ArchRule all_classes_should_have_tests = Units4JConditions.ALL_CLASSES_SHOULD_HAVE_TESTS;
 
 }
 
diff --git a/esc/src/test/java/org/fuin/ddd4j/esc/VendorRepository.java b/esc/src/test/java/org/fuin/ddd4j/esc/VendorRepository.java
@@ -25,13 +25,14 @@
 import org.fuin.ddd4j.jsonbtestmodel.Vendor;
 import org.fuin.ddd4j.jsonbtestmodel.VendorId;
 import org.fuin.esc.api.EventStore;
+import org.fuin.utils4j.TestOmitted;
 
 import java.util.List;
 
 /**
  * Implements a repository that is capable of storing vendors.
  */
-@ArchIgnore
+@TestOmitted("Only a test class")
 public final class VendorRepository extends EventStoreRepository<VendorId, Vendor> {
 
     /**

diff --git a/jaxb/src/test/java/org/fuin/ddd4j/jaxb/BaseTest.java b/jaxb/src/test/java/org/fuin/ddd4j/jaxb/BaseTest.java
@@ -22,6 +22,7 @@
 import com.tngtech.archunit.junit.ArchIgnore;
 import com.tngtech.archunit.junit.ArchTest;
 import com.tngtech.archunit.lang.ArchRule;
+import org.fuin.units4j.archunit.Units4JConditions;
 
 import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.classes;
 import static org.fuin.units4j.archunit.AllTopLevelClassesHaveATestCondition.haveACorrespondingClassEndingWith;
@@ -30,16 +31,7 @@
 class BaseTest {
 
     @ArchTest
-    static final ArchRule all_classes_should_have_tests =
-            classes()
-                    .that()
-                    .areTopLevelClasses()
-                    .and().areNotInterfaces()
-                    .and().areNotRecords()
-                    .and().areNotEnums()
-                    .and().doNotHaveModifier(JavaModifier.ABSTRACT)
-                    .and().areNotAnnotatedWith(ArchIgnore.class)
-                    .should(haveACorrespondingClassEndingWith("Test"));
+    static final ArchRule all_classes_should_have_tests = Units4JConditions.ALL_CLASSES_SHOULD_HAVE_TESTS;
 
 }
 
diff --git a/jsonb-testmodel/pom.xml b/jsonb-testmodel/pom.xml
@@ -39,6 +39,12 @@
             <artifactId>ddd-4-java-core</artifactId>
         </dependency>
 
+        <dependency>
+            <groupId>org.fuin.ddd4j</groupId>
+            <artifactId>ddd-4-java-junit</artifactId>
+        </dependency>
+
+
         <dependency>
             <groupId>org.fuin.objects4j</groupId>
             <artifactId>objects4j-common</artifactId>

diff --git a/jsonb-testmodel/src/test/java/org/fuin/ddd4j/jsonbtestmodel/ArchitectureTest.java b/jsonb-testmodel/src/test/java/org/fuin/ddd4j/jsonbtestmodel/ArchitectureTest.java
@@ -1,17 +1,11 @@
 package org.fuin.ddd4j.jsonbtestmodel;
 
-import com.tngtech.archunit.core.domain.JavaModifier;
 import com.tngtech.archunit.core.importer.ImportOption;
 import com.tngtech.archunit.junit.AnalyzeClasses;
 import com.tngtech.archunit.junit.ArchTest;
 import com.tngtech.archunit.lang.ArchRule;
-import org.fuin.ddd4j.core.DomainEvent;
-import org.fuin.ddd4j.core.EntityId;
 import org.fuin.ddd4j.core.EntityType;
-import org.fuin.ddd4j.core.HasEntityTypeConstant;
-import org.fuin.esc.api.HasSerializedDataTypeConstant;
-import org.fuin.objects4j.common.HasPublicStaticIsValidMethod;
-import org.fuin.objects4j.common.HasPublicStaticValueOfMethod;
+import org.fuin.ddd4j.junit.Ddd4JConditions;
 
 import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.classes;
 import static com.tngtech.archunit.library.DependencyRules.NO_CLASSES_SHOULD_DEPEND_UPPER_PACKAGES;
@@ -49,17 +43,9 @@ public class ArchitectureTest {
                     "org.fuin.objects4j.ui..");
 
     @ArchTest
-    static final ArchRule verify_domain_events = classes()
-            .that().implement(DomainEvent.class)
-            .and().doNotHaveModifier(JavaModifier.ABSTRACT)
-            .should().beAnnotatedWith(HasSerializedDataTypeConstant.class);
+    static final ArchRule verify_domain_events = Ddd4JConditions.DOMAIN_EVENT_RULES;
 
     @ArchTest
-    static final ArchRule verify_entity_ids = classes()
-            .that().areAssignableTo(EntityId.class)
-            .and().doNotHaveModifier(JavaModifier.ABSTRACT)
-            .should().beAnnotatedWith(HasPublicStaticValueOfMethod.class)
-            .andShould().beAnnotatedWith(HasPublicStaticIsValidMethod.class)
-            .andShould().beAnnotatedWith(HasEntityTypeConstant.class);
+    static final ArchRule verify_entity_ids = Ddd4JConditions.ENTITY_ID_RULES;
 
 }
diff --git a/jsonb/src/test/java/org/fuin/ddd4j/jsonb/BaseTest.java b/jsonb/src/test/java/org/fuin/ddd4j/jsonb/BaseTest.java
@@ -22,6 +22,7 @@
 import com.tngtech.archunit.junit.ArchIgnore;
 import com.tngtech.archunit.junit.ArchTest;
 import com.tngtech.archunit.lang.ArchRule;
+import org.fuin.units4j.archunit.Units4JConditions;
 
 import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.classes;
 import static org.fuin.units4j.archunit.AllTopLevelClassesHaveATestCondition.haveACorrespondingClassEndingWith;
@@ -30,16 +31,7 @@
 class BaseTest {
 
     @ArchTest
-    static final ArchRule all_classes_should_have_tests =
-            classes()
-                    .that()
-                    .areTopLevelClasses()
-                    .and().areNotInterfaces()
-                    .and().areNotRecords()
-                    .and().areNotEnums()
-                    .and().doNotHaveModifier(JavaModifier.ABSTRACT)
-                    .and().areNotAnnotatedWith(ArchIgnore.class)
-                    .should(haveACorrespondingClassEndingWith("Test"));
+    static final ArchRule all_classes_should_have_tests = Units4JConditions.ALL_CLASSES_SHOULD_HAVE_TESTS;
 
 }
 
diff --git a/jsonb/src/test/java/org/fuin/ddd4j/jsonb/TestUtils.java b/jsonb/src/test/java/org/fuin/ddd4j/jsonb/TestUtils.java
@@ -9,14 +9,15 @@
 import org.eclipse.yasson.FieldAccessStrategy;
 import org.fuin.ddd4j.core.EntityIdFactory;
 import org.fuin.ddd4j.jsonbtest.JsonbTestEntityIdFactory;
+import org.fuin.utils4j.TestOmitted;
 
 import java.nio.charset.StandardCharsets;
 import java.util.List;
 
 /**
  * Utils for the package.
  */
-@ArchIgnore
+@TestOmitted("Only a test class")
 final class TestUtils {
 
     private static final EntityIdFactory ENTITY_ID_FACTORY = new JsonbTestEntityIdFactory();

diff --git a/junit/ddd-4-java-junit.iml b/junit/ddd-4-java-junit.iml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module version="4">
+  <component name="SonarLintModuleSettings">
+    <option name="uniqueId" value="a69938dc-ebda-4a65-9b67-d28711ef8198" />
+  </component>
+</module>
diff --git a/junit/pom.xml b/junit/pom.xml
@@ -0,0 +1,110 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>org.fuin.ddd4j</groupId>
+        <artifactId>ddd-4-java</artifactId>
+        <version>0.6.0-SNAPSHOT</version>
+        <relativePath>../pom.xml</relativePath>
+    </parent>
+
+    <artifactId>ddd-4-java-junit</artifactId>
+
+    <dependencies>
+
+        <!-- compile -->
+
+        <dependency>
+            <groupId>org.fuin.ddd4j</groupId>
+            <artifactId>ddd-4-java-core</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.fuin.esc</groupId>
+            <artifactId>esc-api</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>com.tngtech.archunit</groupId>
+            <artifactId>archunit</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.fuin.objects4j</groupId>
+            <artifactId>objects4j-common</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.fuin.objects4j</groupId>
+            <artifactId>objects4j-junit</artifactId>
+        </dependency>
+
+        <!-- test -->
+
+        <dependency>
+            <groupId>com.tngtech.archunit</groupId>
+            <artifactId>archunit-junit5</artifactId>
+            <scope>test</scope>			
+        </dependency>
+
+    </dependencies>
+
+    <build>
+
+        <plugins>
+
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+            </plugin>
+
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-source-plugin</artifactId>
+            </plugin>
+
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+            </plugin>
+
+            <plugin>
+                <groupId>io.smallrye</groupId>
+                <artifactId>jandex-maven-plugin</artifactId>
+            </plugin>
+
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-jdeps-plugin</artifactId>
+            </plugin>
+
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+            </plugin>
+
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-dependency-plugin</artifactId>
+                <configuration>
+                    <ignoredUnusedDeclaredDependencies>
+                        <ignoredUnusedDeclaredDependency>jakarta.el:jakarta.el-api</ignoredUnusedDeclaredDependency>
+                        <ignoredUnusedDeclaredDependency>org.glassfish:jakarta.el</ignoredUnusedDeclaredDependency>
+                        <ignoredUnusedDeclaredDependency>org.hibernate.validator:hibernate-validator</ignoredUnusedDeclaredDependency>
+                        <ignoredUnusedDeclaredDependency>org.fuin.objects4j:objects4j-junit</ignoredUnusedDeclaredDependency>
+                        <ignoredUnusedDeclaredDependency>com.tngtech.archunit:archunit-junit5</ignoredUnusedDeclaredDependency>
+                    </ignoredUnusedDeclaredDependencies>
+                    <ignoredUsedUndeclaredDependencies>
+                        <ignoredUsedUndeclaredDependency>com.tngtech.archunit:archunit-junit5-api</ignoredUsedUndeclaredDependency>
+                    </ignoredUsedUndeclaredDependencies>
+                </configuration>
+            </plugin>
+
+        </plugins>
+
+    </build>
+
+</project>