Phân phối ứng dụng Android cho người kiểm thử bằng cách sử dụng công cụ phát triển nhanh


Tài liệu này mô tả cách phân phối các bản dựng APK cho người kiểm thử bằng fastlane, một nền tảng nguồn mở tự động hoá việc tạo và phát hành ứng dụng iOS và Android. Tài liệu này tuân theo các hướng dẫn được xác định trong một Fastfile. Sau khi thiết lập fastlane và Fastfile, bạn có thể tích hợp App Distribution với cấu hình fastlane.

Trước khi bắt đầu

Nếu chưa thực hiện, hãy thêm Firebase vào dự án Android.

Nếu không sử dụng bất kỳ sản phẩm nào khác của Firebase, bạn chỉ cần tạo một dự án và đăng ký ứng dụng của mình. Tuy nhiên, nếu quyết định sử dụng các sản phẩm khác trong tương lai, hãy nhớ hoàn tất tất cả các bước trên trang được liên kết ở trên.

Bước 1. Thiết lập fastlane

  1. Cài đặt và thiết lập fastlane.

  2. Để thêm App Distribution vào cấu hình fastlane, hãy chạy lệnh sau từ gốc của dự án Android:

    fastlane add_plugin firebase_app_distribution

    Nếu lệnh nhắc bạn chọn một tuỳ chọn, hãy chọn Option 3: RubyGems.org.

Bước 2. Xác thực bằng Firebase

Trước khi có thể sử dụng trình bổ trợ fastlane, trước tiên, bạn phải xác thực bằng dự án Firebase theo một trong những cách sau. Theo mặc định, trình bổ trợ fastlane sẽ tìm thông tin đăng nhập từ giao diện dòng lệnh Firebase nếu không dùng phương thức xác thực nào khác.

Bước 3. Thiết lập Fastfile và phân phối ứng dụng

  1. Trong một làn đường ./fastlane/Fastfile, hãy thêm một khối firebase_app_distribution. Sử dụng các tham số sau để định cấu hình chế độ phân phối:
    Thông số firebase_app_distribution
    app

    Bắt buộc: Mã ứng dụng Firebase của ứng dụng. Bạn có thể tìm thấy mã ứng dụng trong bảng điều khiển Firebase, trên trang Cài đặt chung.

    app: "1:1234567890:android:0a1b2c3d4e5f67890"
    firebase_cli_token

    Mã làm mới được in khi bạn xác thực môi trường CI bằng CLI Firebase (đọc phần Sử dụng CLI với hệ thống CI để biết thêm thông tin).

    service_credentials_file

    Đường dẫn đến tệp json tài khoản dịch vụ của Google. Xem phần trên để biết cách xác thực bằng thông tin đăng nhập tài khoản dịch vụ.

    android_artifact_type

    Chỉ định loại tệp Android (APK hoặc AAB).

    android_artifact_path

    Thay thế apk_path (không dùng nữa). Đường dẫn tuyệt đối đến tệp APK hoặc AAB mà bạn muốn tải lên. Nếu không được chỉ định, fastlane sẽ xác định vị trí của tệp từ làn đường mà tệp được tạo.

    release_notes
    release_notes_file

    Ghi chú phát hành cho bản dựng này.

    Bạn có thể chỉ định trực tiếp ghi chú phát hành:

    release_notes: "Text of release notes"

    Hoặc chỉ định đường dẫn đến một tệp văn bản thuần tuý:

    release_notes_file: "/path/to/release-notes.txt"
    testers
    testers_file

    Địa chỉ email của những người kiểm thử mà bạn muốn mời.

    Bạn có thể chỉ định người kiểm thử dưới dạng một danh sách địa chỉ email được phân tách bằng dấu phẩy:

    testers: "ali@example.com, bri@example.com, cal@example.com"

    Hoặc bạn có thể chỉ định đường dẫn đến một tệp văn bản thuần tuý chứa danh sách địa chỉ email được phân tách bằng dấu phẩy:

    testers_file: "/path/to/testers.txt"
    groups
    groups_file

    Nhóm người kiểm thử mà bạn muốn mời (xem phần Quản lý người kiểm thử). Các nhóm được chỉ định bằng email đại diện của nhóm. Bạn có thể tra cứu email đại diện này trong bảng điều khiển Firebase.

    Bạn có thể chỉ định các nhóm dưới dạng một danh sách được phân tách bằng dấu phẩy:

    groups: "qa-team, trusted-testers"

    Hoặc bạn có thể chỉ định đường dẫn đến một tệp văn bản thuần tuý chứa danh sách tên nhóm được phân tách bằng dấu phẩy:

    groups_file: "/path/to/groups.txt"
    test_devices
    test_devices_file

    Các loại phân phối sau đây là một phần của Tính năng thử nghiệm beta dành cho người kiểm thử tự động.

    Các thiết bị kiểm thử mà bạn muốn phân phối bản dựng đến (tham khảo phần Kiểm thử tự động).

    Bạn có thể chỉ định các thiết bị kiểm thử dưới dạng danh sách các thiết bị kiểm thử được phân tách bằng dấu chấm phẩy:

    test_devices: "model=shiba,version=34,locale=en,orientation=portrait;model=b0q,version=33,locale=en,orientation=portrait"

    Hoặc bạn có thể chỉ định đường dẫn đến một tệp văn bản thuần tuý chứa danh sách các thiết bị kiểm thử được phân tách bằng dấu chấm phẩy:

    test_devices_file: "/path/to/test-devices.txt"
    test_username

    Tên người dùng để đăng nhập tự động sẽ được dùng trong các kiểm thử tự động.

    test_password
    test_password_file

    Mật khẩu để đăng nhập tự động sẽ được dùng trong các kiểm thử tự động.

    Hoặc bạn có thể chỉ định đường dẫn đến một tệp văn bản thuần tuý chứa mật khẩu:

    test_password_file: "/path/to/test-password.txt"
    test_username_resource

    Tên tài nguyên cho trường tên người dùng để đăng nhập tự động sẽ được dùng trong các kiểm thử tự động.

    test_password_resource

    Tên tài nguyên cho trường mật khẩu để đăng nhập tự động sẽ được dùng trong các kiểm thử tự động.

    test_non_blocking

    Chạy kiểm thử tự động không đồng bộ. Truy cập vào bảng điều khiển của Firebase để xem kết quả kiểm thử tự động.

    debug

    Một cờ boolean. Bạn có thể đặt giá trị này thành true để in đầu ra gỡ lỗi chi tiết.

platform :android do
    desc "My awesome app"
    lane :distribute do
        build_android_app(...)
        # build_android_app is a built-in fastlane action.
        release = firebase_app_distribution(
            app: "1:123456789:android:abcd1234",
            testers: "tester1@company.com, tester2@company.com",
            release_notes: "Lots of amazing new features to test out!"
        )
    end
end

Để cung cấp bản dựng cho người kiểm thử, hãy chạy làn đường của bạn:

fastlane <lane>

Giá trị trả về của thao tác này là một hàm băm đại diện cho bản phát hành đã tải lên. Bạn cũng có thể dùng hàm băm này bằng cách sử dụng lane_context[SharedValues::FIREBASE_APP_DISTRO_RELEASE]. Để biết thêm thông tin về các trường có sẵn trong hàm băm này, hãy xem tài liệu về REST API.

Trình bổ trợ fastlane sẽ xuất các đường liên kết sau đây sau khi tải bản phát hành lên. Các đường liên kết này giúp bạn quản lý các tệp nhị phân và đảm bảo người kiểm thử cũng như các nhà phát triển khác có bản phát hành phù hợp:

  • Đường liên kết đến bảng điều khiển Firebase hiển thị một bản phát hành duy nhất. Bạn có thể chia sẻ đường liên kết này với các nhà phát triển khác trong tổ chức của mình.
  • Đường liên kết đến bản phát hành trong trải nghiệm của người kiểm thử (ứng dụng gốc Android) cho phép người kiểm thử xem ghi chú phát hành và cài đặt ứng dụng vào thiết bị của họ. Người kiểm thử cần có quyền truy cập vào bản phát hành để sử dụng đường liên kết này.
  • Đường liên kết đã ký để tải trực tiếp và cài đặt tệp nhị phân ứng dụng (tệp APK hoặc AAB). Đường liên kết sẽ hết hạn sau một giờ.

Sau khi bạn phân phối bản dựng, bản dựng đó sẽ xuất hiện trên trang tổng quan App Distribution của bảng điều khiển Firebase trong 150 ngày. Khi bản dựng còn 30 ngày nữa là hết hạn, thông báo hết hạn sẽ xuất hiện trong bảng điều khiển và trong danh sách bản dựng của người kiểm thử trên thiết bị kiểm thử.

Những người thử nghiệm chưa từng được mời thử nghiệm ứng dụng sẽ nhận được email mời để bắt đầu. Người kiểm thử hiện tại sẽ nhận được thông báo qua email rằng bản dựng mới đã sẵn sàng để kiểm thử. Để tìm hiểu cách cài đặt ứng dụng kiểm thử, hãy xem hướng dẫn thiết lập cho người kiểm thử. Bạn có thể theo dõi trạng thái của từng người kiểm thử để xác định xem họ đã chấp nhận lời mời hay chưa và họ đã tải ứng dụng xuống trong bảng điều khiển Firebase hay chưa.

(Không bắt buộc) Để tự động tăng số bản dựng mỗi khi tạo một bản phát hành mới trong Phân phối ứng dụng, bạn có thể sử dụng thao tác firebase_app_distribution_get_latest_release và ví dụ: trình bổ trợ increment_version_code fastlane. Đoạn mã sau đây cung cấp ví dụ về cách tự động tăng số bản dựng:

lane :increment_version do
  latest_release = firebase_app_distribution_get_latest_release(
    app: "<your Firebase app ID>"
  )
  increment_version_code({ version_code: latest_release[:buildVersion].to_i + 1 })
end

Để tìm hiểu thêm về thao tác firebase_app_distribution_get_latest_release, hãy xem phần Xem thông tin về bản phát hành mới nhất của ứng dụng.

Bước 4 (Không bắt buộc). Quản lý người thử nghiệm cho hoạt động phân phối

Bạn có thể thêm và xoá người kiểm thử khỏi dự án hoặc nhóm bằng tệp Fastfile hoặc bằng cách chạy trực tiếp các thao tác fastlane. Việc chạy các thao tác trực tiếp sẽ ghi đè các giá trị được đặt trong Fastfile.

Sau khi thêm người kiểm thử vào dự án Firebase, bạn có thể thêm họ vào từng bản phát hành. Những người thử nghiệm bị xoá khỏi dự án Firebase của bạn sẽ không còn quyền truy cập vào các bản phát hành trong dự án của bạn nữa, nhưng họ có thể vẫn có quyền truy cập vào các bản phát hành của bạn trong một khoảng thời gian.

Nếu có nhiều người kiểm thử, bạn nên cân nhắc sử dụng các nhóm.

Sử dụng Fastfile

# Use lanes to add or remove testers from a project.
lane(:add_testers) do
  firebase_app_distribution_add_testers(
    emails: "foo@google.com,bar@google.com"
    # or file: "/path/to/testers.txt"
    group_alias: "qa-team" # (Optional) add testers to this group
  )
end

lane(:remove_testers) do
  firebase_app_distribution_remove_testers(
    emails: "foo@google.com,bar@google.com"
    # or file: "/path/to/testers.txt"
    group_alias: "qa-team" # (Optional) remove testers from this group only
  )
end
# Add or remove testers with the terminal
$ fastlane add_testers
$ fastlane remove_testers

Chạy các thao tác fastlane

fastlane run firebase_app_distribution_create_group display_name:"QA Team" alias:"qa-team"
fastlane run firebase_app_distribution_add_testers group_alias:"qa-team" emails:"foo@google.com,bar@google.com"
fastlane run firebase_app_distribution_remove_testers group_alias:"qa-team" emails:"foo@google.com,bar@google.com"
fastlane run firebase_app_distribution_delete_group alias:"qa-team"

Bạn cũng có thể chỉ định người kiểm thử bằng cách sử dụng --file="/path/to/testers.txt thay vì --emails.

Các tác vụ firebase_app_distribution_add_testersfirebase_app_distribution_remove_testers cũng chấp nhận các đối số sau:

  • project_name: Số dự án Firebase của bạn.
  • group_alias (không bắt buộc): Nếu được chỉ định, người kiểm thử sẽ được thêm vào (hoặc xoá khỏi) nhóm được chỉ định.
  • service_credentials_file: Đường dẫn đến tệp thông tin đăng nhập dịch vụ của Google.
  • firebase_cli_token: Mã thông báo uỷ quyền cho Firebase CLI.

service_credentials_filefirebase_cli_token là các đối số giống nhau mà thao tác tải lên sử dụng.

Bước 5 (Không bắt buộc). Xem thông tin về bản phát hành mới nhất của ứng dụng

Bạn có thể dùng thao tác firebase_app_distribution_get_latest_release để tìm nạp thông tin về bản phát hành mới nhất của ứng dụng trong App Distribution, bao gồm cả thông tin về phiên bản ứng dụng, ghi chú phát hành và thời gian tạo. Các trường hợp sử dụng bao gồm tự động tăng phiên bản và chuyển ghi chú phát hành từ bản phát hành trước.

Giá trị trả về của thao tác là một hàm băm biểu thị bản phát hành mới nhất. Bạn cũng có thể dùng hàm băm này bằng cách sử dụng lane_context[SharedValues::FIREBASE_APP_DISTRO_LATEST_RELEASE]. Để biết thêm thông tin về các trường có sẵn trong hàm băm này, hãy xem tài liệu về REST API.

Thông số

Các tham số firebase_app_distribution_get_latest_release
app

Bắt buộc: Mã ứng dụng Firebase của ứng dụng. Bạn có thể tìm thấy mã ứng dụng trong bảng điều khiển Firebase, trên trang Cài đặt chung.

app: "1:1234567890:android:0a1b2c3d4e5f67890"
firebase_cli_token

Mã làm mới được in khi bạn xác thực môi trường CI bằng CLI Firebase (đọc phần Sử dụng CLI với hệ thống CI để biết thêm thông tin).

service_credentials_file

Đường dẫn đến tệp json tài khoản dịch vụ của Google. Xem phần trên để biết cách xác thực bằng thông tin đăng nhập tài khoản dịch vụ.

debug

Một cờ boolean. Bạn có thể đặt giá trị này thành true để in đầu ra gỡ lỗi chi tiết.

Các bước tiếp theo