[The JAVA, 테스트] 6부. 아키텍처 테스트

[tonykang22]

6부. 아키텍처 테스트

1. ArchUnit 소개

• https://www.archunit.org/
• 애플리케이션의 아키텍처를 테스트 할 수 있는 오픈 소스 라이브러리로, 패키지, 클래스, 레이어, 슬라이스 간의 의존성을 확인할 수 있는 기능을 제공한다.
• Circular dependency를 피할 수 있도록 package, class를 아키텍처해야한다.
  • 순환 참조 : 닭과 달걀의 문제가 생길 수 있고, 코드를 분석할 때도 일괄적인 흐름을 갖기고 어렵다.
• 아키텍처 테스트 유즈 케이스
  • A라는 패키지가 B(또는 C, D)패키지에서만 사용되고 있는지 확인 가능.
  • Serivce라는 이름의 클래스들이 Controller 또는 *Service라는 이름의 클래스에서만 참조하고 있는지 확인.
  • *Service라는 이름의 클래스들이 ..service.. 라는 패키지에 들어있는지 확인.
  • A라는 애노테이션을 선언한 메소드만 특정 패키지 또는 특정 애노테이션을 가진 클래스를 호출하고 있는지 확인.
  • 특정한 스타일의 아키텍처를 따르고 있는지 확인.
• 참고
  • https://blogs.oracle.com/javamagazine/unit-test-your-architecture-with-archunit
  • https://www.archunit.org/userguide/html/000_Index.html
  • Moduliths

2. ArchUnit 설치

• https://www.archunit.org/userguide/html/000_Index.html#_junit_5
• JUnit 5용 ArchUnit 설치

  <dependency> 
  <groupId>com.tngtech.archunit</groupId> 
  <artifactId>archunit-junit5-engine</artifactId> 
  <version>0.12.0</version> 
  <scope>test</scope>
  </dependency>

• 주요 사용법
  1. 특정 패키지에 해당하는 클래스를 (바이트코드를 통해) 읽어들이고
  2. 확인할 규칙을 정의하고
  3. 읽어들인 클래스들이 그 규칙을 잘 따르는지 확인한다.
• JUnit 5 확장팩 제공
  • @AnalyzeClasses: 클래스를 읽어들여서 확인할 패키지 설정
  • @ArchTest: 확인할 규칙 정의

3. ArchUnit: 패키지 의존성 확인하기

• 확인하려는 패키지 구조
• 실제로 그런지 확인하려면...
  • ..domain.. 패키지에 있는 클래스는 ..study.., ..member.., ..domain에서 참조 가능.
  • ..member.. 패키지에 있는 클래스는 ..study..와 ..member.. 에서만 참조 가능.
    • (반대로) ..domain.. 패키지는 ..member.. 패키지를 참조하지 못한다.
  • ..study.. 패키지에 있는 클래스는 ..study.. 에서만 참조 가능.
  • 순환 참조 없어야 한다.

예시 코드

public class ArchTests {

    @Test
    void packageDependencyTests() {
        JavaClasses classes = new ClassFileImporter().importPackages("me.whiteship.inflearnthejavatest");

        ArchRule domainPackageRule = classes().that().resideInAPackage("..domain..")
                .should().onlyBeAccessed().byClassesThat()
                .resideInAnyPackage("..study..", "..member..", "..domain..");
        domainPackageRule.check(classes);

        ArchRule memberPackageRule = noClasses().that().resideInAPackage("..domain..")
                .should().accessClassesThat().resideInAPackage("..member..");
        memberPackageRule.check(classes);

        ArchRule studyPackageRule = noClasses().that().resideOutsideOfPackage("..study..")
                .should().accessClassesThat().resideInAnyPackage("..study..");
        studyPackageRule.check(classes);

        ArchRule freeOfCycles = slices().matching("..inflearnthejavatest.(*)..")
                .should().beFreeOfCycles();
        freeOfCycles.check(classes);
    }

}

4. ArchUnit: JUnit 5 연동하기

• @AnalyzeClasses: 클래스를 읽어들여서 확인할 패키지 설정
• @ArchTest: 확인할 규칙 정의

예시 코드

@AnalyzeClasses(packagesOf = App.class)
public class ArchTests {

    @ArchTest
    ArchRule domainPackageRule = classes().that().resideInAPackage("..domain..")
            .should().onlyBeAccessed().byClassesThat()
            .resideInAnyPackage("..study..", "..member..", "..domain..");

    @ArchTest
    ArchRule memberPackageRule = noClasses().that().resideInAPackage("..domain..")
            .should().accessClassesThat().resideInAPackage("..member..");

    @ArchTest
    ArchRule studyPackageRule = noClasses().that().resideOutsideOfPackage("..study..")
            .should().accessClassesThat().resideInAnyPackage("..study..");

    @ArchTest
    ArchRule freeOfCycles = slices().matching("..inflearnthejavatest.(*)..")
            .should().beFreeOfCycles();

}

5. ArchUnit: 클래스 의존성 확인하기

• 확인하려는 클래스 의존성
• 테스트 할 내용
  • StudyController는 StudyService와 StudyRepository를 사용할 수 있다.
  • Study* 로 시작하는 클래스는 ..study.. 패키지에 있어야 한다.
  • StudyRepository는 StudyService와 StudyController를 사용할 수 없다.

예시 코드

@AnalyzeClasses(packagesOf = App.class)
public class ArchClassTests {

    @ArchTest
    ArchRule controllerClassRule = classes().that().haveSimpleNameEndingWith("Controller")
            .should().accessClassesThat().haveSimpleNameEndingWith("Service")
            .orShould().accessClassesThat().haveSimpleNameEndingWith("Repository");

    @ArchTest
    ArchRule repositoryClassRule = noClasses().that().haveSimpleNameEndingWith("Repository")
            .should().accessClassesThat().haveSimpleNameEndingWith("Service");

    @ArchTest
    ArchRule studyClassesRule = classes().that().haveSimpleNameStartingWith("Study")
            .and().areNotEnums()
            .and().areNotAnnotatedWith(Entity.class)
            .should().resideInAnyPackage("..study..");

}

6. 정리

이 밖에도...

• Selenium WebDriver
  • 웹 브라우저 기반 자동화된 테스트 작성에 사용할 수 있는 툴
• DBUnit
  • 데이터베이스에 데이터를 CVS, Excel 등으로 넣어주는 툴
• REST Assured
  • REST API 테스트 라이브러리
• Cucumber
  • BDD를 지원하는 테스트 라이브러리.