https://github.com/mehmetpekdemir/spring-boot-archunit

Spring boot ArchUnit
https://github.com/mehmetpekdemir/spring-boot-archunit

archunit java11 spring-boot testing

Last synced: about 2 months ago
JSON representation

Spring boot ArchUnit

• Host: GitHub
• URL: https://github.com/mehmetpekdemir/spring-boot-archunit
• Owner: mehmetpekdemir
• License: mit
• Created: 2021-08-24T18:36:22.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-08-24T19:40:32.000Z (almost 5 years ago)
• Last Synced: 2023-03-01T07:32:43.652Z (over 3 years ago)
• Topics: archunit, java11, spring-boot, testing
• Language: Java
• Homepage: https://github.com/mehmetpekdemir/spring-boot-archunit
• Size: 7.81 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ArchUnit

- ArchUnit is a free, simple and extensible library for checking the architecture of your Java code. 

- That is, ArchUnit can check dependencies between packages and classes, layers and slices, check for cyclic dependencies and more. 

- It does so by analyzing given Java bytecode, importing all classes into a Java code structure. 

- ArchUnit's main focus is to automatically test architecture and coding rules, using any plain Java unit testing framework.

### Import maven dependency

    

        com.tngtech.archunit

        archunit-junit5

        ${archunit.version}

        test

    

### Create a test class

    class ArchunitApplicationTests {

          private JavaClasses importedClasses;

          @BeforeEach

          void setup() {

              importedClasses = new ClassFileImporter()

                    .withImportOption(ImportOption.Predefined.DO_NOT_INCLUDE_TESTS)

                    .importPackages("com.springboot.testing.archunit");

          }

     }

### Annotations checks

    @Test

    void field_injection_not_use_autowired_annotation() {

        noFields()

                .should().beAnnotatedWith(Autowired.class)

                .check(importedClasses);

    }

    @Test

    void repository_classes_should_have_spring_repository_annotation() {

        classes()

                .that().resideInAPackage("..repository..")

                .should().beAnnotatedWith(Repository.class)

                .check(importedClasses);

    }

    @Test

    void service_classes_should_have_spring_service_annotation() {

        classes()

                .that().resideInAPackage("..service..")

                .should().beAnnotatedWith(Service.class)

                .check(importedClasses);

    }

### Package Dependency Checks

    @Test

    void services_and_repositories_should_not_depend_on_controller() {

        noClasses()

                .that().resideInAnyPackage("com.springboot.testing.archunit.service..")

                .or().resideInAnyPackage("com.springboot.testing.archunit.repository..")

                .should()

                .dependOnClassesThat()

                .resideInAnyPackage("com.springboot.testing.archunit.controller..")

                .because("Services and repositories should not depend on web layer")

                .check(importedClasses);

    }

### Class Dependency Checks

    @Test

    void service_classes_should_only_be_accessed_by_controller() {

        classes()

                .that().resideInAPackage("..service..")

                .should().onlyBeAccessed().byAnyPackage("..service..", "..controller..")

                .check(importedClasses);

    }

    @Test

    void repository_classes_should_only_be_accessed_by_service() {

        classes()

                .that().resideInAPackage("..repository..")

                .should().onlyBeAccessed().byAnyPackage("..repository..", "..service..")

                .check(importedClasses);

    }

### Naming convention

    @Test

    void service_classes_should_be_named_blabla_service() {

        classes()

                .that().resideInAPackage("..service..")

                .should().haveSimpleNameEndingWith("Service")

                .check(importedClasses);

    }

    @Test

    void repository_classes_should_be_named_blabla_repository() {

        classes()

                .that().resideInAPackage("..repository..")

                .should().haveSimpleNameEndingWith("Repository")

                .check(importedClasses);

    }

    @Test

    void controller_classes_should_be_named_blabla_controller() {

        classes()

                .that().resideInAPackage("..controller..")

                .should().haveSimpleNameEndingWith("Controller")

                .check(importedClasses);

    }

### Layer Dependency Rules Test

    @Test

    void layered_architecture_should_be_respected() {

        layeredArchitecture()

                .layer("Controller").definedBy("..controller..")

                .layer("Service").definedBy("..service..")

                .layer("Repository").definedBy("..repository..")

                .whereLayer("Controller").mayNotBeAccessedByAnyLayer()

                .whereLayer("Service").mayOnlyBeAccessedByLayers("Controller")

                .whereLayer("Repository").mayOnlyBeAccessedByLayers("Service")

                .check(importedClasses);

    }

    @Test

    void repositories_must_reside_in_repository_package() {

        classes().that()

                .haveNameMatching(".*Repository").should().resideInAPackage("..repository..")

                .as("Repositories should reside in a package '..repository..'")

                .check(importedClasses);

    }

    @Test

    void services_must_reside_in_service_package() {

        classes().that()

                .haveNameMatching(".*Service").should().resideInAPackage("..service..")

                .as("Services should reside in a package '..service..'")

                .check(importedClasses);

    }

    @Test

    void entity_classes_should_be_public() {

        classes()

                .that().resideInAPackage("..entity..")

                .should()

                .bePublic()

                .check(importedClasses);

    }

### License

- Distributed under the MIT License. See [LICENSE](LICENSE) for more information.