README.md

xebia-archunit-extension

A test library built on top of ArchUnit. It codifies best practices that we use at Xebia in our Java Spring Boot JPA projects.

Do not use version older than 0.3.0 that are published on Github packages. We publish latest packages on Bintray now. Github does not allow to delete public packages so we will have to live with them.

Following are the rules that this library adds:

1. No Get API should return List or Set. This is to enforce pagination
2. Enforce pagination to avoid performance issues
3. Entities should not be directly exposed in the REST controllers
4. REST controllers should return DTOs only
5. REST controllers name should end with Resource
6. All @Entity classes should have @Versioned field
7. Favor Unchecked exception over checked exception
8. Utils class should have private constructor
9. Root package should have Application class
10. Slf4j Logger should be private static final
11. Repository interfaces should be inside ..repository.. package
12. Util classes should not be injected
13. Util class methods should be static
14. Spring Singleton components should have only final fields
15. Layers should not have cycles
16. Favor constructor injection over field injection
17. Favor Java 8 Date Time over Joda API
18. Favor Builder over long list constructor

We will keep adding more tests to this repository.

Usage

For Maven users first add the repository to your pom.xml

 <repository>
    <id>bintray</id>
    <name>Xebia BinTray Packages</name>
    <url>https://dl.bintray.com/xebia-os/maven-repo/</url>
</repository>

For Gradle add following

maven {
   url('https://dl.bintray.com/xebia-os/maven-repo/')
}

Then add the following library to your Maven pom.xml

<dependency>
  <groupId>com.github.xebia</groupId>
  <artifactId>archunit-extension</artifactId>
  <version>0.5.0</version>
  <scope>test</scope>
</dependency>

if you use Gradle then add following

testImplementation 'com.github.xebia:archunit-extension:0.5.0'

Once you have added the library you can use it in two ways.

Approach 1: Extending com.github.xebia.archunit.AbstractArchitectureTests class

Create a new test class extending com.github.xebia.archunit.AbstractArchitectureTests class. This will add all the test cases.

import com.example.demo.domain.UserEntity;
import com.github.xebia.archunit.AbstractArchitectureTests;
import com.tngtech.archunit.core.importer.ClassFileImporter;
import com.tngtech.archunit.core.importer.ImportOption;

class DemoApplicationArchitectureTest extends AbstractArchitectureTests {

    public DemoApplicationArchitectureTest() {
        super(new ClassFileImporter()
                        .withImportOption(ImportOption.Predefined.DO_NOT_INCLUDE_TESTS)
                        .importPackagesOf(Application.class),
                new String[]{UserEntity.class.getPackage().getName()},
                "com.example.(*service).domain",
                Application.class.getPackage().getName(),
                "com.example.demo.(*)..",
                new String[]{"Dto"},
                new String[]{"Util", "Utils"});
    }
}

You can the run your test class and all the test will run.

Approach 2: Write your own test class and pick the test you want to run

All the rules are in com.github.xebia.archunit.rules.XebiaArchitectureRules class.

So, you can directly import it and use them.

Releasing a new package

To publish a new package use the following commands.

$ ./mvnw -Prelease clean install
$ ./mvnw release:prepare
$ ./mvnw release:perform