Bộ kiểm thử trong trình bổ trợ Android cho Gradle

Trình bổ trợ Android cho Gradle (AGP) cho phép bạn sắp xếp các hoạt động kiểm thử thành các bộ kiểm thử có tên trong khối testOptions của mô-đun. Mỗi bộ kiểm thử xác định nhóm tài nguyên, phần phụ thuộc, công cụ kiểm thử Nền tảng JUnit và biến thể bản dựng mục tiêu riêng.

Lý do nên sử dụng bộ kiểm thử

Theo mặc định, một mô-đun Android cung cấp một nhóm tài nguyên test cho kiểm thử đơn vị cục bộ và một nhóm tài nguyên androidTest cho kiểm thử đo lường. Bộ kiểm thử tách biệt việc tổ chức kiểm thử khỏi hai nhóm tài nguyên đó để bạn có thể làm những việc sau:

  • Tách riêng các bài kiểm thử theo mục đích: Giữ các bài kiểm thử đơn vị, Robolectric, giao diện người dùng, ảnh chụp màn hình và sao lưu trong các thư mục src/{suiteName}/ chuyên dụng thay vì kết hợp chúng trong thư mục src/test/ hoặc src/androidTest/.
  • Tách biệt các phần phụ thuộc và công cụ: Định cấu hình classpath của từng bộ kiểm thử và công cụ kiểm thử Nền tảng JUnit mà không cần thêm phần phụ thuộc vào ứng dụng hoặc cấu hình testImplementation và androidTestImplementation.
  • Nhắm đến các biến thể và thiết bị cụ thể: Chọn các biến thể bản dựng và thiết bị cho mỗi bộ kiểm thử để các quy trình kiểm tra nhanh chạy cục bộ và các bộ kiểm thử dài hơn chạy trong quá trình tích hợp liên tục.

Loại phòng suite

AGP bao gồm các bộ kiểm thử tích hợp sẵn cho quy trình công việc chuyên biệt và giao diện AgpTestSuite cho các bộ kiểm thử tuỳ chỉnh. Bảng sau đây liệt kê các loại bộ ứng dụng hiện có:

Loại phòng suite Vùng chứa DSL Mục đích
Bộ kiểm thử đơn vị testOptions.customSuites Chạy kiểm thử JUnit 5, JUnit 4 hoặc Robolectric trên JVM cục bộ bằng khối hostJar.
Bộ kiểm thử đo lường testOptions.customSuites Chạy kiểm thử thiết bị trên các thiết bị được kết nối hoặc do bản dựng quản lý bằng khối testApk và công cụ kiểm thử android-test-engine.
Kiểm thử ảnh chụp màn hình bằng bộ kiểm thử testOptions.screenshotTests Hiển thị và so sánh @PreviewTest bản xem trước của Compose trên máy chủ.
Kiểm thử tự động chức năng sao lưu và khôi phục testOptions.backupTests Xác minh dữ liệu ứng dụng trên các hoạt động chuyển dữ liệu cục bộ, qua đám mây và giữa các thiết bị.
Hành trình cho Android Studio testOptions.customSuites Chạy hành trình của người dùng XML dựa trên AI trên các thiết bị thông minh.
Bộ thành phần tuỳ chỉnh hoặc kết hợp testOptions.customSuites Chạy các định nghĩa kiểm thử tĩnh bằng một công cụ tuỳ chỉnh hoặc kết hợp các khối hostJar, testApk và assets trong một bộ.

Yêu cầu

Để sử dụng bộ kiểm thử tuỳ chỉnh, hãy đảm bảo rằng dự án của bạn đáp ứng các yêu cầu sau:

  • Android Studio Rabbit 3 Canary 3 trở lên
  • AGP 9.6.0-alpha03 trở lên
  • Gradle 9.7.1 trở lên và JDK 17 trở lên
  • Mô-đun com.android.application hoặc com.android.library

Bộ kiểm thử không được hỗ trợ trong mô-đun com.android.kotlin.multiplatform.library hoặc com.android.test. Để biết thêm thông tin về việc so khớp phiên bản xem trước, hãy xem phần Khả năng tương thích với các bản xem trước của trình bổ trợ Android cho Gradle.

Thiết lập bộ kiểm thử tuỳ chỉnh

Để xem hướng dẫn thiết lập từng bước, hãy xem phần Bộ kiểm thử đơn vị và Bộ kiểm thử đo lường. Để xác định bộ kiểm thử tuỳ chỉnh của riêng bạn, trước tiên, hãy bật bộ kiểm thử trong tệp gradle.properties của dự án:

android.experimental.testSuiteSupport=true

Tiếp theo, hãy khai báo một bộ trong khối testOptions.customSuites của tệp build.gradle.kts trong mô-đun. Chỉ định thuộc tính targetVariants, một hoặc nhiều khối nguồn, khối useJunitEngine và ít nhất một mục tiêu trong khối targets:

import com.android.build.api.dsl.AgpTestSuiteInputParameters

android {
    testOptions {
        customSuites {
            create("mySuite") {
                // Exact variant names to test, such as "debug" or "demoDebug".
                targetVariants += listOf("debug")

                // Add one or more blocks: hostJar {}, testApk {}, or assets {}.
                assets {}

                useJunitEngine {
                    includeEngines += listOf("my-custom-engine")
                    enginesDependencies.add(
                        "com.example:my-custom-junit-engine:1.0.0"
                    )
                    enginesDependencies.add(
                        "org.junit.platform:junit-platform-launcher:1.10.2"
                    )

                    // Request build and SDK artifacts read by your engine.
                    inputs += listOf(
                        AgpTestSuiteInputParameters.STATIC_FILES,
                        // Omit TESTED_APKS in com.android.library modules.
                        AgpTestSuiteInputParameters.TESTED_APKS,
                        AgpTestSuiteInputParameters.ADB_EXECUTABLE,
                    )
                }

                targets {
                    create("default")
                }
            }
        }
    }
}

Trong quá trình triển khai TestEngine tuỳ chỉnh, hãy sử dụng thuộc tính TestSuiteExecutionClient.default để đọc các giá trị enum AgpTestSuiteInputParameters và hằng số TestEngineInputProperty chuẩn, chẳng hạn như SERIAL_IDS và RESULTS_DIR.

Thư mục nhóm tài nguyên

Bố cục thư mục của mỗi bộ phụ thuộc vào việc bộ đó khai báo một khối nguồn hay kết hợp nhiều khối nguồn. Bảng sau đây liệt kê các đường dẫn mặc định trong thư mục {module}/src/{suiteName}/:

Khối nguồn Bộ công cụ một nguồn Phòng suite hỗn hợp
hostJar kotlin/, java/, resources/ test/kotlin/, test/java/, test/resources/
testApk kotlin/, java/, res/, assets/, AndroidManifest.xml androidTest/kotlin/, androidTest/java/, androidTest/res/, androidTest/assets/, androidTest/AndroidManifest.xml
assets Thư mục gốc của bộ ứng dụng assetsTest/

Đừng sử dụng lại nhóm tài nguyên, phiên bản, loại bản dựng hoặc tên biến thể tích hợp sẵn (chẳng hạn như main, androidTest hoặc debug) làm tên bộ kiểm thử.

Số mục tiêu kiểm soát cho mỗi biến thể

Để bật hoặc tắt mục tiêu bộ ứng dụng cho các biến thể cụ thể, hãy định cấu hình giao diện TestSuiteTargetBuilder thông qua thuộc tính HasTestSuitesBuilder.suites trong khối beforeVariants:

androidComponents {
    beforeVariants { variantBuilder ->
        if (variantBuilder.buildType == "release") {
            variantBuilder.suites["mySuite"]
                ?.targets
                ?.get("default")
                ?.enable = false
        }
    }
}

Chạy bộ kiểm thử và kiểm tra báo cáo

AGP tạo một tác vụ Gradle cho mỗi tổ hợp biến thể, bộ và mục tiêu. Bảng sau đây liệt kê các mẫu việc cần làm:

Loại việc cần làm Mẫu đặt tên Lệnh mẫu
Mục tiêu bộ tiêu chuẩn test{Variant}{SuiteName}{Target}TestSuite ./gradlew :app:testDebugMySuiteDefaultTestSuite
Mục tiêu có thuộc tính targetDevices test{Variant}{SuiteName}{Target}{Devices}TestSuite ./gradlew :app:testDebugAndroidSuiteManagedCiPhonesTestSuite
Bản cập nhật cơ sở (requiresUpdateTask = true) update{Variant}{SuiteName}{Target}TestSuite ./gradlew :app:updateDebugScreenshotTestDefaultTestSuite
Tổng hợp báo cáo mô-đun testAllSuites ./gradlew :app:testAllSuites
Tổng hợp mô-đun và phần phụ thuộc testAllSuitesWithDependencies ./gradlew :app:testAllSuitesWithDependencies

Các tác vụ test, connectedCheck và check không chạy các bộ kiểm thử tuỳ chỉnh trừ phi bạn kết nối các tác vụ đó bằng phương thức withTestTaskProviders. Để bật các tác vụ testAllSuites và testAllSuitesWithDependencies, hãy đặt thuộc tính android.experimental.reportAggregationSupport=true trong tệp gradle.properties.

Mỗi lần chạy bộ kiểm thử sẽ ghi kết quả vào các vị trí sau:

  • Báo cáo thử nghiệm HTML: {module}/build/reports/tests/{taskName}/index.html
  • Kết quả XML của JUnit: {module}/build/test-results/{taskName}/
  • Báo cáo mức độ sử dụng mã: {module}/build/reports/coverage/{suiteName}/index.html
  • Báo cáo tổng hợp: {module}/build/reports/{aggregationTask}/test-report/index.html và coverage-report/index.html

Để tạo báo cáo mức độ sử dụng mã, hãy đặt thuộc tính codeCoverage thành true trên bộ kiểm thử. Đối với bộ ảnh chụp màn hình Compose, hãy định cấu hình bộ ảnh chụp màn hình trong tệp build.gradle.kts bằng testOptions.customSuites.named("{suiteName}") { codeCoverage = true }.

Các vấn đề và hạn chế đã biết

Bộ kiểm thử có các giới hạn sau:

  • Tích hợp IDE: Android Studio không hỗ trợ các bộ kiểm thử tuỳ chỉnh. Trình soạn thảo mã có thể hiển thị lỗi tham chiếu chưa được giải quyết trong các tệp nguồn của bộ ứng dụng ngay cả khi bản dựng của bạn được định cấu hình đúng cách. Thay vào đó, hãy tạo và chạy bộ kiểm thử từ dòng lệnh bằng Gradle.
  • Lưu tác vụ vào bộ nhớ đệm: Các tác vụ của bộ kiểm thử luôn chạy lại khi được gọi và không được tải từ bộ nhớ đệm bản dựng Gradle. Các bộ kiểm thử không có tệp kiểm thử sẽ bị bỏ qua và có trạng thái NO-SOURCE.