📸 Kotlin을 사용한 스냅샷 테스트

스냅샷 테스트는 테스트가 처음 실행될 때 테스트 중인 함수의 출력이 파일에 저장되고 스냅샷이 저장되며 이후의 테스트 실행은 함수가 동일한 출력을 생성하는 경우에만 통과하는 테스트 기술입니다.

이것은 the fronted community에서 매우 인기 있는 것 같지만 우리 백엔드에서도 사용할 수 있습니다!

이 PoC에서는 origin-energy/java-snapshot-testing을 사용하고 "the testing framework loved by l̶a̶z̶y̶ productive devs"에 명시된 대로 수동으로 테스트 기대치를 텍스트 파일로 저장할 때마다 사용합니다 😅

로저비나스 / 스냅샷 테스트

📸 Origin-energy/java-snapshot-testing 및 Kotlin을 사용한 스냅샷 테스트

라이브러리를 구성하려면 Junit5 + Gradle quickstart을 따르십시오.

필요한 종속성을 추가합니다

.

필수 src/test/resources/snapshot.properties 파일을 추가합니다. 기본적으로 output-dir=src/test/java를 사용하므로 소스 코드 내에서 스냅샷이 생성되지만(git에 커밋하는 것을 잊지 않도록 가정합니다) 개인적으로 output-dir=src/test/snapshots를 사용하므로 스냅샷이 자체 디렉토리에 생성됩니다.

시작하자!

Test a simple implementation

Use other serializers

Use parameterized test

Tests should be deterministic

간단한 구현 테스트

다음과 같은 간단한 구현이 있다고 상상해 보십시오.

class MyImpl {
  fun doSomething(input: Int) = MyResult(
    oneInteger = input,
    oneDouble = 3.7 * input,
    oneString = "a".repeat(input),
    oneDateTime = LocalDateTime.of(
      LocalDate.of(2022, 5, 3),
      LocalTime.of(13, 46, 18)
    )
  )
}

다음과 같은 방법으로 스냅샷 테스트를 할 수 있습니다.

@ExtendWith(SnapshotExtension::class)
internal class SnapshotTesting {

  private val myImpl = MyImpl()

  @Test
  fun `should do something`(expect: Expect) {
    val myResult = myImpl.doSomething(7)
    expect.toMatchSnapshot(myResult)
  }
}

다음 내용으로 스냅샷 파일 MyImplTest.snap 을 생성합니다.

org.rogervinas.MyImplTest.should do something=[
MyResult(oneInteger=7, oneDouble=25.900000000000002, oneString=aaaaaaa, oneDateTime=2022-05-03T13:46:18)
]

테스트를 다시 실행하면 스냅샷과 일치합니다.

다른 직렬 변환기 사용

이전 예제에서 볼 수 있듯이 기본적으로 이 라이브러리는 "ToString"직렬 변환기를 사용하여 스냅샷을 생성합니다. 대신 JSON 직렬 변환기를 사용할 수 있습니다.

@Test
fun `should do something`(expect: Expect) {
  val myResult = myImpl.doSomething(7)
  expect.serializer("json").toMatchSnapshot(myResult)
}

필수com.fasterxml.jackson.core 종속성을 추가하고 이전 스냅샷을 삭제하는 것을 잊지 마십시오.

그러면 새 스냅샷 파일이 다음과 같이 표시됩니다.

org.rogervinas.MyImplTest.should do something=[
  {
    "oneInteger": 7,
    "oneDouble": 25.900000000000002,
    "oneString": "aaaaaaa",
    "oneDateTime": "2022-05-03T13:46:18"
  }
]

또한 serializer 메서드에서 직렬 변환기 클래스, 직렬 변환기 인스턴스 또는 snapshot.properties 에 구성된 직렬 변환기 이름 중 하나를 제공하는 자체 사용자 정의 직렬 변환기를 사용할 수도 있습니다.

매개변수화된 테스트 사용

이 라이브러리가 매개변수화된 테스트와 함께 작동하도록 하려면 scenario 메서드를 사용해야 합니다.

@ParameterizedTest
@ValueSource(ints = [1, 2, 3, 4, 5, 6, 7, 8, 9])
fun `should do something`(input: Int, expect: Expect) {
  val myResult = myImpl.doSomething(input)
  expect.serializer("json")
        .scenario("$input")
        .toMatchSnapshot(myResult)
}

이렇게 하면 각 실행마다 고유한 스냅샷 기대치가 있습니다.

org.rogervinas.MyImplTest.should do something[1]=[
  {
    "oneInteger": 1,
    "oneDouble": 3.7,
    "oneString": "a",
    "oneDateTime": "2022-05-03T13:46:18"
  }
]

...

org.rogervinas.MyImplTest.should do something[9]=[
  {
    "oneInteger": 9,
    "oneDouble": 33.300000000000004,
    "oneString": "aaaaaaaaa",
    "oneDateTime": "2022-05-03T13:46:18"
  }
]

테스트는 결정론적이어야 합니다.

우리가 테스트해야 하는 구현이 이것이면 어떻게 될까요?

class MyImpl {

  private val random = Random.Default

  fun doSomethingMore() = MyResult(
    oneInteger = random.nextInt(),
    oneDouble = random.nextDouble(),
    oneString = "a".repeat(random.nextInt(10)),
    oneDateTime = LocalDateTime.now()
  )
}

이 스냅샷 테스트가 있는 경우:

@Test
fun `should do something more`(expect: Expect) {
  val myResult = myImpl.doSomethingMore()
  expect.serializer("json").toMatchSnapshot(myResult)
}

처음에는 스냅샷 생성에 통과하지만 테스트가 결정적이지 않기 때문에 다음 실행은 실패합니다 😱

이 경우 MyImpl 및 Random 구현을 사용하여 Clock에 전달하는 이유를 이 테스트 결정론적으로 쉽게 만들 수 있습니다.

class MyImpl(
  private val random: Random, 
  private val clock: Clock
) {
  fun doSomethingMore() = MyResult(
    oneInteger = random.nextInt(),
    oneDouble = random.nextDouble(),
    oneString = "a".repeat(random.nextInt(10)),
    oneDateTime = LocalDateTime.now(clock)
  )
}

그런 다음 결정론적으로 테스트할 수 있습니다.

@ExtendWith(SnapshotExtension::class)
internal class MyImplTest {

  private val myImpl = MyImpl(
    Random(seed=1234),
    Clock.fixed(
      Instant.parse("2022-10-01T10:30:00.000Z"), 
      ZoneId.of("UTC")
    )
  )

  @Test
  fun `should do something more`(expect: Expect) {
    val myResult = myImpl.doSomethingMore()
    expect.serializer("json").toMatchSnapshot(myResult)
  }
}

따라서 스냅샷은 항상 다음과 같습니다.

org.rogervinas.MyImplTest.should do something more=[
  {
    "oneInteger": 345130239,
    "oneDouble": 0.6887620080485805,
    "oneString": "aaaaaaaaa",
    "oneDateTime": "2022-10-01T10:30:00"
  }
]

프로덕션 환경에서 다음과 같이 MyImpl 인스턴스를 생성할 수 있습니다.

fun main() {
  val myImpl = MyImpl(Random.Default, Clock.systemDefaultZone())
  println("myImpl.doSomething(3) = ${myImpl.doSomething(3)}")
  println("myImpl.doSomethingMore = ${myImpl.doSomethingMore()}")
}

감사합니다. 즐거운 코딩하세요! 💙