Adding Layered Architecture test and Arch Unit Library for CPS-CORE

Adding Layered Architecture Test

Will Add Depedency Test at later time after potential refactoring of
project structure

Adding Archunit property file to avoid Store Initialization Exception

Issue-ID: CPS-380

Change-Id: I364294a46b1ab78b86a9c271856805fce09f75a0
Signed-off-by: DylanB95EST <dylan.byrne@est.tech>

diff --git a/.gitignore b/.gitignore
index 3ab1019..3c5994f 100755 (executable)
--- a/.gitignore
+++ b/.gitignore
@@ -4,6 +4,7 @@
 *.zip
 *.log
 
+cps-application/archunit_store
 target/
 log/
 

diff --git a/cps-application/pom.xml b/cps-application/pom.xml
index 8c79666..7f30f06 100755 (executable)
--- a/cps-application/pom.xml
+++ b/cps-application/pom.xml
@@ -106,6 +106,10 @@
                 </exclusion>
             </exclusions>
         </dependency>
+        <dependency>
+            <groupId>com.tngtech.archunit</groupId>
+            <artifactId>archunit-junit5</artifactId>
+        </dependency>
     </dependencies>
 
     <build>

diff --git a/cps-application/src/test/java/org/onap/cps/architecture/LayeredArchitectureTest.java b/cps-application/src/test/java/org/onap/cps/architecture/LayeredArchitectureTest.java
new file mode 100644 (file)
index 0000000..2445461
--- /dev/null
+++ b/cps-application/src/test/java/org/onap/cps/architecture/LayeredArchitectureTest.java
@@ -0,0 +1,61 @@
+/*
+ *  ============LICENSE_START=======================================================
+ *  Copyright (C) 2021 Nordix Foundation
+ *  ================================================================================
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ *
+ *  SPDX-License-Identifier: Apache-2.0
+ *  ============LICENSE_END=========================================================
+ */
+
+package org.onap.cps.architecture;
+
+
+import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.classes;
+import static com.tngtech.archunit.library.freeze.FreezingArchRule.freeze;
+
+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;
+
+/**
+ * Test class responsible for layered architecture.
+ */
+@AnalyzeClasses(packages = "org.onap.cps", importOptions = {ImportOption.DoNotIncludeTests.class})
+public class LayeredArchitectureTest {
+
+    private static final String REST_CONTROLLER_PACKAGE = "org.onap.cps.rest..";
+    private static final String NCMP_REST_PACKAGE = "org.onap.cps.ncmp.rest..";
+    private static final String API_SERVICE_PACKAGE = "org.onap.cps.api..";
+    private static final String SPI_SERVICE_PACKAGE = "org.onap.cps.spi..";
+    private static final String NCMP_SERVICE_PACKAGE =  "org.onap.cps.ncmp.api..";
+    private static final String SPI_REPOSITORY_PACKAGE = "org.onap.cps.spi.repository..";
+    private static final String YANG_SCHEMA_PACKAGE = "org.onap.cps.yang..";
+
+    @ArchTest
+    static final ArchRule restControllerShouldOnlyDependOnRestController =
+        classes().that().resideInAPackage(REST_CONTROLLER_PACKAGE).should().onlyHaveDependentClassesThat()
+            .resideInAPackage(REST_CONTROLLER_PACKAGE);
+
+    @ArchTest
+    static final ArchRule apiOrSpiServiceShouldOnlyBeDependedOnByControllerAndServices =
+        freeze(classes().that().resideInAPackage(API_SERVICE_PACKAGE)
+            .or().resideInAPackage(SPI_SERVICE_PACKAGE).should().onlyHaveDependentClassesThat()
+            .resideInAnyPackage(REST_CONTROLLER_PACKAGE, API_SERVICE_PACKAGE, SPI_SERVICE_PACKAGE, NCMP_REST_PACKAGE,
+                NCMP_SERVICE_PACKAGE, YANG_SCHEMA_PACKAGE));
+
+    @ArchTest
+    static final ArchRule repositoryShouldOnlyBeDependedOnByServicesAndRepository =
+        classes().that().resideInAPackage(SPI_REPOSITORY_PACKAGE).should().onlyHaveDependentClassesThat()
+            .resideInAnyPackage(API_SERVICE_PACKAGE, SPI_SERVICE_PACKAGE, SPI_REPOSITORY_PACKAGE);
+}

diff --git a/cps-application/src/test/resources/archunit.properties b/cps-application/src/test/resources/archunit.properties
new file mode 100644 (file)
index 0000000..d68f266
--- /dev/null
+++ b/cps-application/src/test/resources/archunit.properties
@@ -0,0 +1,18 @@
+#  ============LICENSE_START=======================================================
+#  Copyright (C) 2021 Nordix Foundation
+#  ================================================================================
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+#  SPDX-License-Identifier: Apache-2.0
+#  ============LICENSE_END=========================================================
+
+freeze.store.default.allowStoreCreation=true
\ No newline at end of file

diff --git a/cps-dependencies/pom.xml b/cps-dependencies/pom.xml
index afe4de0..b72ccdf 100755 (executable)
--- a/cps-dependencies/pom.xml
+++ b/cps-dependencies/pom.xml
@@ -31,6 +31,7 @@
 
     <properties>
         <antlr4-runtime.version>4.9.2</antlr4-runtime.version>
+        <archunit.version>0.18.0</archunit.version>
         <cglib-nodep.version>3.1</cglib-nodep.version>
         <commons-codec.version>1.15</commons-codec.version>
         <commons-lang3.version>3.11</commons-lang3.version>
@@ -170,6 +171,12 @@
                 <artifactId>liquibase-core</artifactId>
                 <version>${liquibase.version}</version>
             </dependency>
+            <dependency>
+                <groupId>com.tngtech.archunit</groupId>
+                <artifactId>archunit-junit5</artifactId>
+                <version>${archunit.version}</version>
+                <scope>test</scope>
+            </dependency>
         </dependencies>
     </dependencyManagement>
 </project>