호환성

지원되는 언어:

지원되는 플랫폼:

Swift 테스팅 SDK 설치

테스팅 프레임워크를 설치할 수 있는 세 가지 방법이 있습니다.

Xcode 프로젝트 사용

1. 프로젝트를 dd-sdk-swift-testing 패키지에 추가합니다. https://github.com/DataDog/dd-sdk-swift-testing에 위치합니다.

2. 패키지에서 DatadogSDKTesting라이브러리와 테스트 대상을 연결합니다.

3. UITests를 실행하는 경우, 이 라이브러리와 테스트를 실행하는 앱을 연결합니다.

Swift 패키지 프로젝트 사용

1. 예를 들어, 패키지 종속성 어레이에 dd-sdk-swift-testing를 추가합니다. 예:

Copy

.package(url: "https://github.com/DataDog/dd-sdk-swift-testing.git", from: "2.2.0")

2. 대상 종속성 테스팅에 테스팅 프레임워크를 추가하려면 다음 줄을 테스트 대상 종속성 어레이에 추가합니다.

Copy

.product(name: "DatadogSDKTesting", package: "dd-sdk-swift-testing")

3. UITest를 실행하는 경우, 또한 테스트를 실행하는 애플리케이션에 종속성에 추가합니다.

1. DatadogSDKTesting 종속성을 Podfile 테스트 대상에 추가합니다.

Copy

target 'MyApp' do
  # ...

  target 'MyAppTests' do
    inherit! :search_paths
    pod 'DatadogSDKTesting'
  end
end

2. UITest를 실행하는 경우, 종속성을 테스트를 실행하는 앱에 추가합니다.

1. 릴리스 페이지에서 DatadogSDKTesting.zip을 다운로드하고 압축 해제합니다.

2. 결과 XCFramework를 사용해 테스트 대상을 복사하고 연결합니다.

3. UITest를 실행하는 경우, 이 라이브러리와 테스트를 실행하는 앱을 연결할 수 있습니다..

GitHub를 사용하는 경우 GitHub 마켓플레이스에서 Swift 테스트 작업을 사용하여 자동으로 설정 테스트를 실행할 수 있습니다. 기본적으로 이 페이지에 설명된 설정의 나머지 부분(작업 자체의 설정 제외)은 건너뛸 수 있지만 설정 환경 변수를 사용하여 추가 기능을 비활성화하거나 구성할 수 있습니다.

연결과 같은 다른 방법과 비교할 때 Swift 테스트 액션 옵션은 유연성이 떨어질 수 있습니다. 설정하고 실행하기는 어렵지만 코드를 변경할 필요가 없습니다..

테스트 계측하기

Datadog 구성

Xcode Project 사용

테스트 계측을 사용하려면 다음 환경 변수를 테스트 대상이나 Info.plist 파일에 아래 설명과 같이 추가하세요. 테스트 계획을 사용한다면 반드시 Expand variables based on이나 Target for Variable Expansion에서 주요 대상을 선택해야 합니다.

UITests의 경우 프레임워크에서 자동으로 이러한 값을 애플리케이션에 삽입하기 때문에 테스트 대상에서만 환경 변수를 설정하면 됩니다.

Swift Package Project 사용

테스트 계측을 사용하려면 다음 환경 변수를 테스트 명령줄 실행을 통해 설정해야 합니다. 또는 테스트 실행 전에 환경에서 설정하거나 명령 앞에 추가할 수도 있습니다.

DD_TEST_RUNNER=1 DD_API_KEY= DD_APPLICATION_KEY= DD_SITE=us1 SRCROOT=$PWD swift test ...

or

DD_TEST_RUNNER=1 DD_API_KEY= DD_APPLICATION_KEY= DD_SITE=us1 SRCROOT=$PWD xcodebuild test -scheme ...

다음 변수 모두를 테스트 대상에서 설정합니다.

DD_TEST_RUNNER

테스트 계측을 활성화하거나 비활성화합니다. 테스트 프로세스 외부(예: CI 빌드)에 정의된 환경 변수를 사용하여 테스트 계측을 활성화 또는 비활성화할 수 있도록 이 값을 $(DD_TEST_RUNNER)로 설정합니다.
기본값: false
권장: $(DD_TEST_RUNNER)

DD_API_KEY

테스트 결과를 업로드할 때 사용하는 Datadog API 키.
기본값: (empty)

DD_APPLICATION_KEY

테스트 결과를 업로드할 때 사용되는 Datadog 애플리케이션 키.
기본값: (empty)

DD_SERVICE

테스트 중인 서비스나 라이브러리의 이름.
기본값: 리포지토리 이름
예시: my-ios-app

DD_ENV

테스트가 실행 중인 환경 이름. 런타임에서 환경 변수를 사용하여 이를 설정할 수 있도록 값을 $(DD_ENV)로 설정합니다.
기본값: none
권장: $(DD_ENV)
예시: ci, local

SRCROOT

프로젝트 위치 경로. Xcode를 사용하는 경우, 값을 자동으로 설정하는 $(SRCROOT) 값을 사용합니다.
기본값: (empty)
권장: $(SRCROOT)
예시: /Users/ci/source/MyApp

service 및 env 예약 태그 에 대한 자세한 내용은 통합 서비스 태깅 을 참조하세요.

또한 선택한 사이트 ()를 사용하도록 Datadog 사이트를 설정합니다.

DD_SITE (필수)

결과를 업로드하는 Datadog 사이트.
기본값: datadoghq.com
선택한 사이트:

Git 메타데이터 수집하기

Datadog은 Git 정보를 사용하여 테스트 결과를 시각화하고 리포지토리, 브랜치, 커밋별로 그룹화합니다. Git 메타데이터는 CI 공급자 환경 변수와 프로젝트 경로의 로컬 .git 폴더(사용 가능한 경우)에서 테스트 계측으로 자동 수집합니다.

지원되지 않는 CI 공급자이거나 .git 폴더가 없는 상태에서 테스트를 실행하는 경우, 환경 변수를 사용하여 Git 정보를 수동으로 설정할 수 있습니다. 해당 환경 변수는 자동 탐지된 정보보다 우선합니다. 다음 환경 변수를 설정하여 Git 정보를 제공합니다.

DD_GIT_REPOSITORY_URL

코드가 저장된 리포지토리 URL입니다. HTTP, SSH URL이 모두 지원됩니다.
예시: git@github.com:MyCompany/MyApp.git, https://github.com/MyCompany/MyApp.git

DD_GIT_BRANCH

테스트 중인 Git 브랜치입니다. 대신 태그 정보를 제공하는 경우 비워 둡니다.
예시: develop

DD_GIT_TAG

테스트 중인 Git 태그입니다(해당되는 경우). 대신 브랜치 정보를 제공하는 경우 비워 둡니다.
예시: 1.0.1

DD_GIT_COMMIT_SHA

전체 커밋 해시입니다.
예시: a18ebf361cc831f5535e58ec4fae04ffd98d8152

DD_GIT_COMMIT_MESSAGE

커밋 메시지입니다.
예시: Set release number

DD_GIT_COMMIT_AUTHOR_NAME

커밋 작성자 이름입니다.
예시: John Smith

DD_GIT_COMMIT_AUTHOR_EMAIL

커밋 작성자 이메일입니다.
예시: john@example.com

DD_GIT_COMMIT_AUTHOR_DATE

ISO 8601 형식의 커밋 작성자 날짜입니다.
예시: 2021-03-12T16:00:28Z

DD_GIT_COMMIT_COMMITTER_NAME

커밋 커미터 이름입니다.
예시: Jane Smith

DD_GIT_COMMIT_COMMITTER_EMAIL

커밋 커미터 이메일입니다.
예시: jane@example.com

DD_GIT_COMMIT_COMMITTER_DATE

ISO 8601 형식의 커밋 커미터 날짜입니다.
예시: 2021-03-12T16:00:28Z

테스트 실행

설치가 완료된 후에는 일반적인 방법(예: xcodebuild test 명령 사용)으로 테스트를 실행합니다. 테스트, 네트워크 요청, 애플리케이션 충돌이 자동으로 계측됩니다. CI에서 테스트를 실행할 때는 환경 변수를 전달합니다. 다음 예를 참고하세요.

DD_TEST_RUNNER=1 DD_ENV=ci DD_SITE= xcodebuild \
  -project "MyProject.xcodeproj" \
  -scheme "MyScheme" \
  -destination "platform=macOS,arch=x86_64" \
  test

UI 테스트

UITests의 경우, 테스트 대상과 UITests에서 실행되는 애플리케이션 둘 다 프레임워크에 연결되어야 합니다. 환경 변수는 프레임워크가 자동으로 애플리케이션에 해당 값을 주입하므로 테스트 대상에서만 설정하면 됩니다.

RUM 통합

테스트 중이 애플리케이션이 RUM을 사용하여 계측되는 경우 UI 테스트 결과와 생성된 RUM 세션이 자동으로 연결됩니다. RUM에 관한 자세한 내용은 RUM iOS 통합 가이드를 참고하세요. iOS RUM 버전 >=1.10이 필요합니다.

추가적인 설정(선택 사항)

다음 설정을 참고하세요.

• Boolean 변수는 1, 0, true, false, YES, NO 중에서 사용할 수 있습니다.
• String 목록 변수는 ,나 ;으로 구분된 구성 요소 목록을 허용합니다.

자동 계측 사용

DD_ENABLE_STDOUT_INSTRUMENTATION

stdout에 작성된 메시지(예: print())를 캡처하고 로그로 보고합니다. 이는 청구 요금에 영향을 줄 수 있습니다. (부울)

DD_ENABLE_STDERR_INSTRUMENTATION

stderr에 작성된 메시지(예: NSLog(), UITest 단계)를 캡처하고 로그로 보고합니다. 이는 청구 요금에 영향을 줄 수 있습니다(부울).

자동 계측 사용 해제

이 프레임워크를 사용해 지원하는 모든 라이브러리에서 자동 계측을 사용할 수 있지만, 일부 사용하고 싶지 않은 경우도 있을 수 있습니다. 이때 다음 환경 변수를 설정해 (또는 Info.plist 파일에서 아래 설명에 따라) 특정 라이브러리에서 자동 계측을 사용 해제할 수 있습니다.

DD_DISABLE_NETWORK_INSTRUMENTATION

모든 네트워크 계측 사용 중지 (부울)

DD_DISABLE_RUM_INTEGRATION

RUM 세션과의 통합 사용 중지 (부울)

DD_DISABLE_SOURCE_LOCATION

테스트 소스 코드 위치와 Codeowners 사용 중지 (부울)

DD_DISABLE_CRASH_HANDLER

충돌 처리 및 보고 사용 중지. (부울)

네트워크 자동 계측

네트워크 자동 계측에 대해 다음 추가 설정을 구성할 수 있습니다:

DD_DISABLE_HEADERS_INJECTION

추적 헤더의 모든 삽입 사용 중지(부울)

DD_INSTRUMENTATION_EXTRA_HEADERS

기록하려는 특정 추가 헤더(문자열 목록)

DD_EXCLUDED_URLS

기록하거나 헤더를 삽입하지 않으려는 URL(문자열 목록)

DD_ENABLE_RECORD_PAYLOAD

요청 및 응답에 있는 페이로드의 하위 집합(1024 바이트) 보고 사용(부울)

DD_MAX_PAYLOAD_SIZE

페이로드에서 보고하는 최대 크기 설정. 기본값 1024(정수)

DD_DISABLE_NETWORK_CALL_STACK

네트워크 스팬에서 호출 스택 정보 사용 중지(부울)

DD_ENABLE_NETWORK_CALL_STACK_SYMBOLICATED

호출 스택 정보에 메서드 이름뿐만 아니라 정확한 파일 및 줄 정보 표시. 테스트 성능에 영향을 줄 수 있음(부울)

인프라스트럭처 테스트 상관 관계

자체 인프라스트럭처(macOS 또는 시뮬레이터 테스트)에서 테스트를 실행하는 경우, Datadog Agent를 설치하고 다음을 설정해 테스트와 인프라스트럭처 메트릭을 상호 연결할 수 있습니다.

DD_CIVISIBILITY_REPORT_HOSTNAME

테스트를 실행하는 컴퓨터의 호스트 이름 보고(부울)

또한 Swift나 Objective-C에서 모듈 DatadogSDKTesting를 가져오고 클래스 DDInstrumentationControl을 사용해 일부 테스트에서 특정 자동 계측을 사용하거나 사용 중지하도록 할 수 있습니다.

커스텀 태그

환경 변수

DD_TAGS 환경 변수(또는 아래 설명에 따라 Info.plist 파일에서)를 사용할 수 있습니다. 띄어쓰기로 구분된 key:tag 쌍이 포함되어 있어야 합니다. 다음 예를 참고하세요.

DD_TAGS=tag-key-0:tag-value-0 tag-key-1:tag-value-1

값 중 하나가 $ 문자로 시작하는 경우 같은 이름의 환경 변수(존재하는 경우)로 대체됩니다. 다음 예를 참고하세요.

DD_TAGS=home:$HOME

또한 $ 문자를 사용하면 환경 변수가 지원되지 않는 문자(a-z, A-Z, _)가 포함되어 있을 경우 값 시작 부분에서 환경 변수를 대체할 수 있습니다. 다음 예를 참고하세요.

FOO = BAR
DD_TAGS=key1:$FOO-v1 // expected: key1:BAR-v1

OpenTelemetry

참고: OpenTelemetry는 Swift에서만 지원됩니다.

Datadog Swift 테스트 프레임워크는 내부적으로 OpenTelemetry를 추적 기술로 사용합니다. DDInstrumentationControl.openTelemetryTracer를 사용해 OpenTelemetry 트레이서에 액세스할 수 있고, OpenTelemetry API를 사용할 수 있습니다. 태그나 속성을 추가하려면 다음 예를 참고하세요.

import DatadogSDKTesting
import OpenTelemetryApi

let tracer = DDInstrumentationControl.openTelemetryTracer as? Tracer
let span = tracer?.spanBuilder(spanName: "ChildSpan").startSpan()
span?.setAttribute(key: "OTTag2", value: "OTValue2")
span?.end()

테스트 대상이 opentelemetry-swift와 명시적으로 연결되어 있어야 합니다.

코드 커버리지 보고하기

코드 커버리지를 사용할 수 있는 경우, Datadog SDK(v2.2.7+)는 이를 테스트 세션의 test.code_coverage.lines_pct 태그 아래에 보고합니다.

Xcode에서는 Test Scheme에서 코드 커버리지 보고를 활성화할 수 있습니다.

테스트 세션의 Coverage 탭에서 테스트 커버리지 내역을 확인할 수 있습니다.

Info.plist를 사용해 설정

환경 변수를 설정하는 대신 테스트 번들(앱 번들 아님)의 Info.plist 파일에 모든 설정 값을 추가해 제공할 수 있습니다. 환경 변수와 Info.plist 파일의 설정이 동일할 경우, 환경 변수가 우선합니다.

CI 공급자 환경 변수

수동 테스트 API

Swift 프로젝트와 함께 XCTests를 사용하는 경우 DatadogSDKTesting 프레임워크에서 자동으로 이를 계측하고 결과를 Datadog 백엔드로 전송합니다. XCTests를 사용하지 않는다면 대신 Swift/Objective-C 수동 테스팅 API를 사용해 결과를 백엔드로 보고할 수 있습니다.

이 API는 테스트 모듈, 테스트 스위트, 테스트 이 세 개의 개념을 기반으로 작동합니다.

테스트 모듈

테스트 모듈은 테스트가 포함된 라이브러리 또는 번들의 로드를 나타냅니다.

테스트 모듈을 시작하려면 DDTestModule.start()를 호출하고 테스트하려는 모듈이나 번들의 이름을 전달합니다.

테스트가 모두 완료되면 module.end()를 호출해 라이브러리가 나머지 테스트 결과를 모두 백엔드로 보내도록 합니다.

테스트 스위트

테스트 스위트는 일반적인 기능을 공유하는 테스트 세트로 이뤄져 있습니다. 일반적인 초기화 및 해제 기능을 공유하고 일부 변수를 공유하는 경우도 있습니다.

module.suiteStart()를 호출하고 테스트 스위트의 이름을 전달하여 테스트 모듈에서 테스트 스위트를 생성합니다.

스위트 내의 관련 테스트가 모두 실행을 마치면 suite.end()를 호출합니다.

테스트

스위트 내에서 실행되는 각 테스트는 pass, fail, skip 중 하나의 상태로 종료되어야 합니다. 테스트는 선택적으로 속성 및 오류 정보와 같은 추가 정보를 가질 수 있습니다.

suite.testStart()를 호출하고 테스트 이름을 전달하여 스위트에서 테스트를 생성합니다. 테스트가 끝나면 미리 정의된 상태 중 하나를 설정해야 합니다.

API 인터페이스

클래스 DDTestModule {
    // 모듈을 시작합니다.
    // - 파라미터:
    // - 번들 이름: 테스트할 모듈 또는 번들의 이름입니다.
    // - startTime: 부수적인. 모듈이 시작된 시간입니다.
    static func start(bundleName: String, startTime: Date? = nil) -> DDTestModule
    //
    // 모듈을 종료합니다.
    // - 파라미터:
    // - endTime: 부수적인. 모듈이 종료된 시간입니다.
    func end(endTime: Date? = nil)
    // 테스트 모듈에 태그를 설정하다/어트리뷰트를 테스트 모듈에 추가합니다. 태그 을 얼마든지 추가할 수 있습니다.
    // - 파라미터:
    // - 키: 테스트 모듈의 태그를 설정하다. 같은 이름의 태그를 설정하다 가 이미 존재하는 경우
    // 그 값은 새 값으로 대체됩니다.
    // - 값: 값은 태그를 설정하다. 숫자나 문자열일 수 있습니다.
    함수 setTag(키: 문자열, 값: 임의)
    //
    // 이 모듈에서 스위트(suite) 을 시작합니다.
    // - 파라미터:
    // - name: 스위트(suite) 의 이름.
    // - startTime: 부수적인. 스위트(suite) 이 시작된 시간.
    func suiteStart(name: String, startTime: Date? = nil) -> DDTestSuite
}
    //
public class DDTestSuite : NSObject {
    // 테스트를 종료합니다 스위트(suite).
    // - 파라미터:
    // - endTime: 부수적인. 스위트(suite) 이 종료된 시간입니다.
    func end(endTime: Date? = nil)
    // 테스트에 태그를 설정하다/속성을 테스트에 추가합니다 스위트(suite). 태그 을 얼마든지 추가할 수 있습니다.
    // - 파라미터:
    // - 키: 테스트의 이름 태그를 설정하다. 같은 이름의 태그를 설정하다 가 이미 존재하는 경우
    // 그 값은 새 값으로 대체됩니다.
    // - 값: 값은 태그를 설정하다. 숫자나 문자열일 수 있습니다.
    함수 setTag(키: 문자열, 값: 임의)
    //
    // 이 안에서 테스트를 시작합니다 스위트(suite).
    // - 파라미터:
    // - name: 테스트 이름.
    // - startTime: 부수적인. 테스트가 시작된 시간입니다.
    func testStart(name: String, startTime: Date? = nil) -> DDTest
}
    //
public class DDTest : NSObject {
    // 테스트에 태그를 설정하다/속성을 테스트에 추가합니다. 태그 을 얼마든지 추가할 수 있습니다.
    // - 파라미터:
    // - 키: 테스트의 이름 태그를 설정하다. 같은 이름의 태그를 설정하다 가 이미 존재하는 경우
    // 그 값은 새 값으로 대체됩니다.
    // - 값: 값은 태그를 설정하다. 숫자나 문자열일 수 있습니다.
    함수 setTag(키: 문자열, 값: 임의)
    //
    // 테스트에 오류 정보를 추가합니다. 테스트는 하나의 errorInfo만 보고할 수 있습니다.
    // - 파라미터:
    // - 유형: 보고할 오류 유형입니다.
    // - 메시지: 오류와 관련된 메시지입니다.
    // - 콜스택: 부수적인. 오류와 연관된 콜스택입니다.
    함수 setErrorInfo(유형: 문자열, 메시지: 문자열, 콜스택: 문자열? = nil)
    //
    // 테스트를 종료합니다.
    // - 파라미터:
    // - 상태: 이 테스트에 대해 보고된 상태입니다.
    // - endTime: 부수적인. 테스트가 종료된 시간입니다.
    func end(status: DDTestStatus, endTime: Date? = nil)
}
    //
// 테스트가 보고할 수 있는 상태입니다:
enum DDTestStatus {
  // 테스트가 통과했습니다.
  case pass
  //
  //테스트가 실패했습니다.
  case fail
  //
  //테스트가 건너뛰었습니다.
  case skip
}

코드 예시

다음은 API를 사용한 간단한 코드 예시입니다.

import DatadogSDKTesting
let module = DDTestModule.start(bundleName: "ManualModule")
let suite1 = module.suiteStart(name: "ManualSuite 1")
let test1 = suite1.testStart(name: "Test 1")
test1.setTag(key: "key", value: "value")
test1.end(status: .pass)
let test2 = suite1.testStart(name: "Test 2")
test2.SetErrorInfo(type: "Error Type", message: "Error message", callstack: "Optional callstack")
test2.end(test: test2, status: .fail)
suite1.end()
let suite2 = module.suiteStart(name: "ManualSuite 2")
..
..
module.end()

항상 끝에 module.end()를 호출해 테스트 정보가 Datadog로 전송될 수 있도록 하세요.

모범 사례

테스팅 프레임워크와 CI Visibility를 최대한 활용하려면 다음 사례를 참고하세요.

빌드 시 심볼 파일 생성

Xcode에서 DWARF with dSYM File(또는 -Xswiftc -debug-info-format=dwarfswift)을 사용해 코드 빌드

테스트 프레임워크에서는 크래시 기호화, 테스트 소스 위치 보고, 코드 소유자 보고 등 일부 기능에 기호 파일을 사용합니다. 디버그 기호가 바이너리에 포함될 때 때 자동으로 기호 파일을 생성하지만 로드하는 데 시간이 다소 걸릴 수 있습니다.

macOS에서 UI 테스트 시 샌드백스 사용 해제

일부 Xcode 버전에서는 UI Test 번들이 기본적으로 샌드박스와 함께 빌드됩니다. 샌드박스와 함께 제공되는 설정으로 인해 일부 시스템 명령에서 테스트 프레임워크가 xcrun를 사용하여 실행되지 않으므로 이를 비활성화해야 합니다.

UI Test 러너 번들에 Entitlements를 추가한 후 App Sandbox = NO를 추가하여 샌드박스를 비활성화합니다. 또 .entitlement 파일을 생성하여 Signing Build Settings에 추가할 수도 있습니다. 이 파일에는 다음 내용이 포함되어야 합니다.

<key>com.apple.security.app-sandbox</key>
 <false/>

참고 자료

추가 유용한 문서, 링크 및 기사:

테스트 결과 및 성능 탐색설명서 Intelligent Test Runner로 테스트 작업 속도 향상시키기설명서 CI Visibility 문제 해결설명서