테스트 코드로 아키텍처 & 컨벤션 을 검증해보자

1. 개요

레이어드 아키텍처, 클린 아키텍처, 헥사고날 아키텍처 등 많은 아키텍처가 존재하고 아키텍처 없이 개발하는 개발자는 거의 없다.  

 

그런데 이처럼 정해진 아키텍처 규칙이 실제 프로젝트 진행 과정에서 잘 지켜지는 것을 어떻게 보장할 수 있을까?

 

 

급하게 개발하는 과정에서 이러한 규칙을 어기는 코드가 생겨났을 때, 개발자들이 일일이 이를 잡아내고 고치는 것은 그 자체로 비용이다.

 

그리고 이러한 규칙이 하나가 아니라 여러 개 존재한다면 개발자들이 실수할 가능성은 훨씬 높아질 것이다.

 

그러므로 개발자들이 이러한 규칙에 위배되는 코드를 작성하지 않도록 강제할 수 있는 수단이 필요하다.

 

 

 

 

의존성을 강제하기 위해선 Spring Multi Module 을 사용할 수 있다. 

레이어별 혹은 영역별로 모듈을 생성하고 아래와 같이 의존성을 걸어주면 된다.

 

dependencies {
	implementation project(':listener:application')
	implementation project(':listener:domain')
    
    ...
}

 

 

 

하지만 Spring에서는 Bean을 통해 객체 간의 의존성을 관리하고 주입하기 때문에, 멀티모듈 구조를 사용할 경우 아래와 같이 Bean에 대한 의존성도 추가로 관리해줘야 한다. 

@Configuration
@ComponentScan(basePackages = "com.example.repository")
public class ServiceConfig {}

 

 

 

Bean 또한 의존성을 강제할 수 있긴 하지만 관리 포인트가 늘어나게 된다. 

 

나의 경우, 모듈로 아키텍처를 강제화 하고 싶지 않았던 가장 큰 이유는 뎁스가 너무 깊어져서 이다.

src -> main -> java -> com -> example -> ...  

 

개발하며 내가 어디 파일을 보고 있는지도 헷갈릴 정도로 뎁스가 깊고 많아져 버린다. 

 

 

그래서 ArchUnit 테스트 + 패키지 구조 아키텍처로 설계하기로 결정했다.   

 

 

 

 

 

 

 

 

 

 

 

2. ArchUnit 라이브러리

ArchUnit 라이브러리는 아키텍처 테스트를 위한 라이브러리이다.

 

단위 테스트와 같은 방법으로 작성되며 아키텍처의 패키지, 클래스, 계층, 슬라이스 간의 의존성을 확인하고 객체 간의 참조를 확인할 수 있게 도와준다.

 

 

 

- build.gradle 의존성 추가

testImplementation 'com.tngtech.archunit:archunit-junit5:1.3.0'

 

 

 

 

ArchUnit 라이브러리엔 굉장히 많은 함수들을 제공해준다. 전체적인 구성(짜임새)만 알면 함수명을 보고 추측해서 작성할 수 있을 것이다.

 

 

- 테스트할 클래스 집합 불러오기

private final JavaClasses importedClasses = new ClassFileImporter()
        .importPackages("com.example"); // 프로젝트 루트 패키지

 

 

 

 

 

- 대상 및 조건 설정

ArchRuleDefinition.[대상 및 조건]()

// 예시
// 이후 조건들에 대해 모든 클래스가 만족해야 함
ArchRuleDefinition.classes()

// 이후 조건들에 대해 모든 클래스가 만족하지 않아야 함
ArchRuleDefinition.noClasses()

// 이후 조건들에 대해 모든 메서드가 만족해야 함
ArchRuleDefinition.methods()

// 이후 조건들에 대해 모든 클래스가 만족하지 않아야 함
ArchRuleDefinition.noMethods()

// 이후 조건들에 대해 모든 필드가 만족해야 함
ArchRuleDefinition.fields()

// 이후 조건들에 대해 모든 필드가 만족하지 않아야 함
ArchRuleDefinition.noFields()

 

 

 

 

 

- 대상 필터링

ArchRuleDefinition.classes()
	.that().[대상 필터링]
	
	
// 예시
.that().resideInAPackage("..application..")
.that().resideInAnyPackage("com.example..api..", "com.example..domain..")

 

 

 

 

 

- 규칙 지정

ArchRuleDefinition.classes()
	.that().[대상 필터링]
	.should().[규칙 지정];
	
// 예시
.should().dependOnClassesThat().resideInAnyPackage(
                "com.example..api..",
            );

 

 

 

 

 

- 규칙 검사

ArchRule rule = ArchRuleDefinition.classes()
	.that().[대상 필터링]
	.should().[규칙 지정];
	
rule.check([클래스 집합]);

 

 

 

 

 

 

 

 

 

 

 

3. ArchTest Code 예시

내가 작성한 ArchTest 몇 가지만 가져와봤다.

 

 

- Application 영역에선 Infrastructure, Persistence 영역을 참조할 수 없음을 강제

    @Test
    @DisplayName("application 영역은 [infrastructure, persistence] 영역을 참조할 수 없다.")
    void application_area_test() {
        ArchRule rule = noClasses()
            .that().resideInAPackage("..application..")

            // 참조 금지 패키지 지정
            .should().dependOnClassesThat().resideInAnyPackage(
                "com.example..infrastructure..",
                "com.example..persistence.."
            );

        rule.check(importedClasses);
    }

 

 

 

 

 

- Domain 영역에선 Infrastructure, Persistence, Application 영역을 참조할 수 없음을 강제

    @Test
    @DisplayName("domain 영역은 [infrastructure, persistence, application] 영역을 참조할 수 없다.")
    void domain_area_test() {
        ArchRule rule = noClasses()
            .that().resideInAPackage("..domain..")

            // 참조 금지 패키지 지정
            .should().dependOnClassesThat().resideInAnyPackage(
                "com.example..infrastructure..",
                "com.example..persistence..",
                "com.example..application.."
            );

        rule.check(importedClasses);
    }

 

 

 

 

 

아키텍처 영역을 넘어 컨벤션 또한 검증할 수 있다.

예를 들어, 엔티티의 기본 생성자의 Accss Level을 Protected로 강제하고 싶을 수 있다.

@NoArgsConstructor(access = AccessLevel.PROTECTED)

 

 

 

아래와 같이 Custom 조건도 만들어 사용할 수 있다. 

@Test
    @DisplayName("Entity 클래스의 기본 생성자는 반드시 protected여야 한다.")
    void entity_default_constructor_should_be_protected() {
        ArchCondition<JavaConstructor> defaultConstructorCondition = new ArchCondition<>(
            "have protected modifier") {
            @Override
            public void check(JavaConstructor constructor, ConditionEvents events) {
                int modifiers = constructor.reflect().getModifiers();

                if (!Modifier.isProtected(modifiers)) {
                    String message = String.format(
                        "Class %s의 기본 생성자는 protected가 아님.",
                        constructor.getOwner().getFullName()
                    );
                    events.add(SimpleConditionEvent.violated(constructor, message));
                }
            }
        };

        ArchRule rule = constructors()
            .that().areDeclaredInClassesThat().haveSimpleNameEndingWith("Entity")
            .and().haveRawParameterTypes(new Class<?>[0]) // 기본 생성자 (파라미터 없음) 명시
            .should(defaultConstructorCondition);

        rule.check(importedClasses);
    }