{"type":"doc","content":[{"type":"paragraph","content":[{"type":"inlineCard","attrs":{"url":"https://lf-onap.atlassian.net/browse/CPS-347"}}]},{"type":"paragraph","content":[{"text":"We are proposing","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"5c6ff7de-ae43-4557-96fd-22cb70825174"}}]},{"text":" the introduction of automatic tools to support architecture and design quality during all application life cycle.","type":"text"}]},{"type":"paragraph","content":[{"text":" This architecture quality is an enabler for:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Long term application maintainability and evolution","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Being able to split and separate application artifacts later on if needed.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"ArchUnit","type":"text"}]},{"type":"paragraph","content":[{"text":"ArchUnit","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.archunit.org/"}}]},{"text":" is a library that can be used for this architecture quality purpose. It integrates with Unit Test to verify the application code structure the same way standard Unit Test classes are verifying the application code logic.","type":"text"}]},{"type":"paragraph","content":[{"text":"ArchUnit can be used to:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Verify application packages and classes dependencies","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Detect dependency cycles in the application structure","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Verify annotations, inheritance, naming conventions, ...","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Compute some software architecture metrics","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"For more info about what to check: ","type":"text"},{"text":"https://www.archunit.org/userguide/html/000_Index.html#_what_to_check","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.archunit.org/userguide/html/000_Index.html#_what_to_check"}}]}]},{"type":"paragraph","content":[{"text":"ArchUnit gives flexibility to:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Ignore some specific classes if needed (","type":"text"},{"text":"https://www.archunit.org/userguide/html/000_Index.html#_ignoring_violations","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.archunit.org/userguide/html/000_Index.html#_ignoring_violations"}}]},{"text":")","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Be implemented incrementally for existing code base (","type":"text"},{"text":"https://www.archunit.org/userguide/html/000_Index.html#_freezing_arch_rules","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.archunit.org/userguide/html/000_Index.html#_freezing_arch_rules"}}]},{"text":")","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Implementation notes","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Maven dependency:","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"576195d0-f8c1-443a-9c24-2661ffefb5ee"}}]}]},{"type":"codeBlock","content":[{"text":" \n com.tngtech.archunit\n archunit-junit5\n 0.18.0\n test\n ","type":"text"}]},{"type":"paragraph","content":[{"text":"Test classes examples:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"/**\n * Test class responsible for dependencies validations.\n */\n@AnalyzeClasses(packages = \"org.onap.cps\", importOptions = { ImportOption.DoNotIncludeTests.class })\npublic class DependencyArchitectureTest {\n\n @ArchTest\n static final ArchRule noCyclesRule =\n slices().matching(\"org.onap.cps.(**)..\").should().beFreeOfCycles();\n\n @ArchTest\n static final ArchRule noUpperPackageDependencyRule = NO_CLASSES_SHOULD_DEPEND_UPPER_PACKAGES;\n\n}\n\n/**\n * Test class responsible for layered architecture.\n */\n@AnalyzeClasses(packages = \"org.onap.cps\", importOptions = { ImportOption.DoNotIncludeTests.class })\npublic class LayeredArchitectureTest {\n\n private static final String A_CONTROLLER_PACKAGE = \"org.onap.cps.controller..\";\n private static final String A_SERVICE_PACKAGE = \"org.onap.cps.service..\";\n private static final String A_REPOSITORY_PACKAGE = \"org.onap.cps.repository..\";\n\n @ArchTest\n public static final ArchRule layeredArchitectureRule =\n layeredArchitecture()\n .layer(\"Controller\").definedBy(A_CONTROLLER_PACKAGE)\n .layer(\"Service\").definedBy(A_SERVICE_PACKAGE)\n .layer(\"Repository\").definedBy(A_REPOSITORY_PACKAGE)\n .whereLayer(\"Controller\").mayNotBeAccessedByAnyLayer()\n .whereLayer(\"Service\").mayOnlyBeAccessedByLayers(\"Controller\")\n .whereLayer(\"Repository\").mayOnlyBeAccessedByLayers(\"Service\");\n\n // 'access' catches only violations by real accesses,\n // i.e. accessing a field, calling a method; compare 'dependOn' further down\n\n @ArchTest\n public static final ArchRule controllerAccessRule =\n classes().that().resideInAPackage(A_CONTROLLER_PACKAGE)\n .should().onlyBeAccessed().byAnyPackage(A_CONTROLLER_PACKAGE);\n\n @ArchTest\n public static final ArchRule serviceAccessRule =\n classes().that().resideInAPackage(A_SERVICE_PACKAGE)\n .should().onlyBeAccessed().byAnyPackage(A_CONTROLLER_PACKAGE, A_SERVICE_PACKAGE);\n\n @ArchTest\n public static final ArchRule repositoryAccessRule =\n classes().that().resideInAPackage(A_REPOSITORY_PACKAGE)\n .should().onlyBeAccessed().byAnyPackage(A_SERVICE_PACKAGE, A_REPOSITORY_PACKAGE);\n\n // 'dependOn' catches a wider variety of violations,\n // e.g. having fields of type, having method parameters of type, extending type ...\n\n @ArchTest\n static final ArchRule controllerDependencyRule =\n classes().that().resideInAPackage(A_CONTROLLER_PACKAGE)\n .should().onlyHaveDependentClassesThat()\n .resideInAPackage(A_CONTROLLER_PACKAGE);\n\n @ArchTest\n static final ArchRule serviceDependencyRule =\n classes().that().resideInAPackage(A_SERVICE_PACKAGE)\n .should().onlyHaveDependentClassesThat()\n .resideInAnyPackage(A_CONTROLLER_PACKAGE, A_SERVICE_PACKAGE);\n\n @ArchTest\n static final ArchRule repositoryDependencyRule =\n classes().that().resideInAPackage(A_REPOSITORY_PACKAGE)\n .should().onlyHaveDependentClassesThat()\n .resideInAnyPackage(A_SERVICE_PACKAGE, A_REPOSITORY_PACKAGE);\n\n}\n\n","type":"text"}]},{"type":"paragraph","content":[{"text":"Finding example:","type":"text","marks":[{"type":"underline"}]}]},{"type":"codeBlock","attrs":{"language":"plaintext"},"content":[{"text":"[ERROR] Failures:\n[ERROR] Architecture Violation [Priority: MEDIUM] - Rule 'slices matching 'org.onap.cps.(**)..' should be free of cycles' was violated (1 times):\nCycle detected: Slice spi.model -> Slice utils -> Slice spi.model\n\nDependencies of Slice spi.model\nMethod calls method in (DataNodeBuilder.java:175)\n\nDependencies of Slice utils\nMethod has parameter of type in (DataMapUtils.java:0)\nMethod has parameter of type in (DataMapUtils.java:0)\nMethod has parameter of type in (DataMapUtils.java:0)\nMethod has parameter of type in (DataMapUtils.java:0)\nMethod has parameter of type in (DataMapUtils.java:0)\nMethod calls method in (DataMapUtils.java:48)\nMethod calls method in (DataMapUtils.java:49)\nMethod calls method in (DataMapUtils.java:50)\nMethod calls method in (DataMapUtils.java:61)\nMethod calls method in (DataMapUtils.java:63)\nMethod calls method in (DataMapUtils.java:74)\nMethod calls method in (DataMapUtils.java:77)","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Sonargraph","type":"text"}]},{"type":"paragraph","content":[{"text":"Sonargraph is not considered has its ","type":"text"},{"text":"free licence","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.hello2morrow.com/products/sonargraph/architect_pricelist"}}]},{"text":" is not compatible.","type":"text"}]}],"version":1}