summaryrefslogtreecommitdiffstats
path: root/cps-application
diff options
context:
space:
mode:
authorDylanB95EST <dylan.byrne@est.tech>2021-06-22 16:57:16 +0100
committerDylanB95EST <dylan.byrne@est.tech>2021-07-06 10:33:22 +0100
commitdb1f37899762ba7d169b526c2333a1e2e4fa5cd7 (patch)
tree43b18d0cd5fda0f178e7ddba0738d75720bfc277 /cps-application
parenta4d48e1de86829240e6ddd13c6cb37dea3df8cfc (diff)
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>
Diffstat (limited to 'cps-application')
-rwxr-xr-xcps-application/pom.xml4
-rw-r--r--cps-application/src/test/java/org/onap/cps/architecture/LayeredArchitectureTest.java61
-rw-r--r--cps-application/src/test/resources/archunit.properties18
3 files changed, 83 insertions, 0 deletions
diff --git a/cps-application/pom.xml b/cps-application/pom.xml
index 8c79666252..7f30f06132 100755
--- 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
index 0000000000..24454615a3
--- /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
index 0000000000..d68f266695
--- /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