아치유닛(ArchUnit)을 사용하는 이유
“두 패키지 사이에 순환 참조(Circular Dependency)가 존재합니다. 변경이 필요해요.”
“@SpringBootTest 어노테이션을 사용하는 통합 테스트 코드는 test 폴더가 아니라 integration-test 폴더에 위치해야합니다.”
“Service 레이어는 Controller와 Model 패키지 에서만 접근해야 합니다”
팀내 경력이 오래된 시니어 개발자는 위와 같은 커멘트를 작성할 때가 많다. 그러면서 왜 그래야 하는지 코드나 패키지 단위로 다이어그램을 그려서 어떻게 컴포넌트들이 서로 작동을 해야하는지 설명한 경험이 있지 않은가?
새롭게 팀에 들어왔거나 해당 지식을 가지지 않은 사람들은 제일 경험이 많은 사람이 친절하게 알려주는 것이 팀내 지식 공유 차원에서는 제일 바람직할 것이다. 하지만 확장 가능하지 않고 팀내 고급인력의 끊임 없는 관심을 요구한다. 갑자기 사람이 늘어나거나 담당자가 휴가를 가버리거나 퇴사하면 잘 작동하지 않는 모델인 것이다.
우리는 이미 유사한 상황들에 많이 대처해봤다. 아치유닛을 사용하면 아키텍처상의 결정사항이나 결함들도 통합 빌드의 한 부분으로 테스트를 작성하고 자동화 하는 것이 가능하다.
홈페이지에서도 언급하고 있듯이 아치유닛이 아니어도 AspectJ나 CheckStyle, Findbugs를 사용해서 유사한 테스트를 수행할 수 있다. 하지만 해당 도구들은 조금 더 범용적인 성격을 가지고 있기 때문에 코드의 구조를 분석해서 읽기 쉬운 테스트를 작성하기 위해서는 아치유닛을 사용하는 것을 것을 추천한다.
아치유닛 구성
아치유닛은 Core 레이어, Lang 레이어, Library 레이어가 존재한다. Core API를 통해 대상을 특정하고 Lang API를 사용해 규칙을 정의한다. Library 레이어는 미리 정의된 규칙들, 예를들어 3 Tier 아키텍처, 6각형 아키텍처(Hexagonal Architecture) 등을 위한 규칙들을 제공한다. 아직은 실험적인 상태로 보이며 추후 확장의 여지가 있는 부분이다.
Core 레이어의 ClassImporter
리플렉션과 유사한 기능을 제공하는 Core레이어에서는 ClassImporter가 가장 중요한 API들을 제공한다. ClassImporters는 컴파일된 클래스들을 불러오기 위해 사용한다. 다음 코드는 com.book 패키지내의 클래스중에 Jar나 테스트 폴더등을 빼놓고프로덕션 코드만 대상으로 지정하는 설정이다.
ClassFileImporter()
.withImportOption(ImportOption.Predefined.DO_NOT_INCLUDE_ARCHIVES)
.withImportOption(ImportOption.Predefined.DO_NOT_INCLUDE_JARS)
.withImportOption(ImportOption.Predefined.DO_NOT_INCLUDE_TESTS)
.importPackages("com.book")
Lang 레이어는 아키텍처 규칙을 정의하는 API들을 제공한다. 규칙을 정하고 나면 다음과 같이 실제 검증을 수행한다.
JavaClasses importedClasses = new ClassFileImporter().importPackage("com.myapp");
ArchRule rule = // 아래 예와 같이 다양한 룰 생성
rule.check(importedClasses);
패키지 의존성 확인
service 패키지는 controller와 resource에서만 접근 가능하다.
classes()
.that()
.resideInAPackage("..service..")
.should()
.onlyHaveDependentClassesThat()
.resideInAnyPackage("..controller..", "..resource..")
클래스 의존성 확인
*Service 클래스는 Controller 클래스 에서만 접근 가능하다.
classes()
.that()
.haveNameMatching(".*Service")
.should()
.onlyBeAccessed()
.byClassesThat()
.haveSimpleName("Controller")
클래스와 패키지 관계 확인
Book으로 시작하는 클래스는 com.book 패키지에 위치해야 한다
classes()
.that()
.haveSimpleNameStartingWith("Book")
.should()
.resideInAPackage("com.book")
상속 관계 확인
Connection 인터페이스를 구현하는 클래스는 이름이 Connectiond으로 끝나야한다.
classes()
.that()
.implement(Connection.class)
.should()
.haveSimpleNameEndingWith("Connection")
EntityManger클래스로 할당 가능한 클래스들은 persistence 패키지에 위치해야 한다.
classes()
.that()
.areAssignableTo(EntityManager.class)
.should()
.onlyBeAccessed()
.byAnyPackage("..persistence..")
주석 테스트
com.book 패키지 중에서도 “build/classes/kotlin/test” 폴더에 위치한 테스트들은 SpringBootTest를 사용해서는 안된다.
classes()
.that()
.resideInAPackage("com.book")
.should()
.notBeAnnotatedWith(SpringBootTest::class.java)
.check(ClassFileImporter()
.importPath("build/classes/kotlin/test"))
레이어 테스트
논리적인 레이어를 구성해서 그 관계를 검증한다. 패키지로 구분된 controller, service, persistence 레이어를 각각 정의하고 각 레이어 별로 접근가능한 레이어들을 정의한다.
layeredArchitecture()
.layer("Controller").definedBy("..controller..")
.layer("Service").definedBy("..service..")
.layer("Persistence").definedBy("..persistence..")
.whereLayer("Controller")
.mayNotBeAccessedByAnyLayer()
.whereLayer("Service")
.mayOnlyBeAccessedByLayers("Controller")
.whereLayer("Persistence")
.mayOnlyBeAccessedByLayers("Service")
순환 참조 테스트
패키지 com.book 의 하위 패키지들을 slice로 구성해서 각 slice들이 순환 참조 하지 않는 지 검사한다.
slices()
.matching("com.book.(**)")
.should().beFreeOfCycles()
.check(javaClasses)