Quick, Nimble 너희들 너무 좋잖니...

개요

Quick은 TDD 스펙을 쉽게 작성하기 위한 오픈소스 라이브러리이고 Nimble은 결과에 대한 표현식을 쉽게 작성하기 위한 오픈소스 라이브러리다.

Quick과 Nimble을 이용 해 유닛 테스트 코드를 작성 해 보자.

Quick 코드 적용

import Quick
@testable import RibsDog

class LoggedInInteractorTests: QuickSpec {
    override func spec() {
        // Given
        describe("LoggedIninteractor 테스트") {
            beforeEach {
                // prepare
            }
            // When
            context("액티브를 호출하면") {
                // Then
                it("내부 변수 초기화가 되었는지 확인 해야 함.") {
                }
            }
        }
        
        // Given
        describe("LoggedIninteractor 테스트") {
            beforeEach {
                // prepare
            }
            // When
            context("requestStart 호출하면") {
                // Then
                it("TicTacToe로 라우팅 돼야 함") {
                }
            }
        }
    }
}

Quick 코드 요약

• Quick은 GWT(Given-When-Then) 방식의 TDD를 작성하여 테스트를 진행한다.
• Given (Positive, Negative 환경 설정) → describe() 코드 블럭 안에 beforeEach 블럭에 해당 함
  • 필요로 하는 변수 및 객체를 생성 해 설정하는 단계이다.
  • 초기 설정(객체 생성 및 디펜던시)을 하게 되며 설정이 끝나야 아래 코드가 진행 된다.
• When (테스트 할 대상의 기능을 실행하면) → context() 코드 블럭에 해당 함
  • 테스트 할 객체에 기능 실행을 하는 단계이다.
  • 단, context에서는 어떤 기능 실행인지 명시만 한다.
• Then (어떤 결과가 나와야 함) → it() 코드 블럭에 해당 함
  • 기능 실행 후 원하는 결과가 나왔는지 확인하는 단계이다.
  • it 코드 블럭 안에서 기능 실행을 하면 된다.
• XCTestCase에 경우 테스트 함수명(func test_LoggedIninteractor_테스트__액티브를_호출하면__내부_변수_초기화가_되었는지_확인_해야_함)으로 유닛이 생성 되지만 Quick의 경우 테스트를 실행하게 되면 작성해 놓은 표현식으로 유닛 테스트가 생성 된다. 즉, 테스트를 돌리기 전까지는 테스트 항목이 나타나지 않는다.
  • LoggedIninteractor_테스트__액티브를_호출하면__내부_변수_초기화가_되었는지_확인_해야_함.
  • LoggedIninteractor_테스트__requestStart_호출하면__TicTacToe로_라우팅_돼야_함

Nimble 코드 적용

• Nimble은 테스트 결과 값의 대한 유효성 검사를 진행한다.

• Nimble은 매칭, 타입체크, 비교, 예외 등등 다양한 유효성 검사 기능을 제공한다.

  Built-in Matcher Functions
  expect(1).to(beAKindOf(Int.self))
  expect("turtle").to(beAKindOf(String.self))
  expect(1).to(beAnInstanceOf(Int.self))
  expect("turtle").to(beAnInstanceOf(String.self))
  
  Equivalence
  expect(actual).to(equal(expected))
  expect(actual).toNot(equal(expected))
  
  Identity
  // expect(actual) === expected
  expect(actual).to(beIdenticalTo(expected)) 
  // expect(actual) !== expected
  expect(actual).toNot(beIdenticalTo(expected))
  
  Comparisons
  // expect(actual) < expected
  expect(actual).to(beLessThan(expected))
  // expect(actual) <= expected
  expect(actual).to(beLessThanOrEqualTo(expected))
  
  Types/Classes
  expect(instance).to(beAnInstanceOf(aClass))
  expect(instance).to(beAKindOf(aClass))
  
  Truthiness
  expect(actual).to(beTrue())
  expect(actual).to(beFalse())
  expect(actual).to(beNil())
  
  Swift Assertions
  expect { try somethingThatThrows() }.to(throwAssertion())
  expect { () -> Void in fatalError() }.to(throwAssertion())
  expect { throw NSError(domain: "test", code: 0, userInfo: nil) }.toNot(throwAssertion())
  
  Swift Error Handling
  expect { try somethingThatThrows() }.to(throwError { (error: Error) in
      expect(error._domain).to(equal(NSCocoaErrorDomain))
  })
  expect { try somethingThatThrows() }.to(throwError(errorType: NimbleError.self))
  
  Exceptions
  expect(actual).to(raiseException(named: name))
  expect { exception.raise() }.to(raiseException { (exception: NSException) in
      expect(exception.name).to(beginWith("a r"))
  })
  
  Collection Membership
  expect(["whale", "dolphin", "starfish"]).to(contain("dolphin", "starfish"))
  expect(actual).to(beEmpty())
  
  Strings
  expect(actual).to(contain(substring))
  expect(actual).to(match(expected))
  
  Collection Elements
  expect([1, 2, 3, 4]).to(allPass { $0! < 5 })
  expect([1, 2, 3, 4]).to(allPass(beLessThan(5)))
  
  Collection Count
  expect(actual).to(haveCount(expected))
  expect(actual).notTo(haveCount(expected))
  
  Notifications
  let testNotification = Notification(name: Notification.Name("Foo"), object: nil)
  expect {
      NotificationCenter.default.post(testNotification)
  }.to(postNotifications(equal([testNotification])))
  
  Matching a value to any of a group of matchers
  expect(actual).to(satisfyAnyOf(beLessThan(10), beGreaterThan(20)))
  expect(6).to(satisfyAnyOf(equal(2), equal(3), equal(4), equal(5), equal(6), equal(7)))
  
  Custom Validation
  expect({
      guard case .enumCaseWithAssociatedValueThatIDontCareAbout = actual else {
          return .failed(reason: "wrong enum case")
      }
  
      return .succeeded
  }).to(succeed())
  

  class LoggedInInteractorTests: QuickSpec {
      override func spec() {
          // Given
          var interactor: LoggedInInteractor!
          var listener: LoggedInListenerMock!
          var router: LoggedInRouterMock!
          describe("LoggedIninteractor 테스트") {
              beforeEach {
                  // prepare
                  interactor = LoggedInInteractor()
                  listener = LoggedInListenerMock()
                  interactor.listener = listener
                  router = LoggedInRouterMock(interactor: interactor)
                  interactor.router = router
              }
              // When
              context("requestStart 호출하면") {
                  // Then
                  it("TicTacToe로 라우팅 돼야 함") {
                      interactor.requestStart()
                      expect(router.setRouteToTicTacToeCount).to(equal(1))
                  }
              }
          }
      }
  }
  

샘플 코드