Ví dụ về các bài kiểm tra tự dụng cụ

Khi thử nghiệm thiết bị được bắt đầu, gói mục tiêu của nó được khởi động lại với mã thiết bị được đưa vào và khởi tạo để thực thi. Một ngoại lệ là gói mục tiêu ở đây không thể là chính khung ứng dụng Android, tức là gói android , vì làm như vậy sẽ dẫn đến một tình huống nghịch lý là khung Android sẽ cần được khởi động lại, đây là thứ hỗ trợ các chức năng của hệ thống, bao gồm cả thiết bị đo đạc chính nó.

Điều này có nghĩa là một bài kiểm tra thiết bị không thể tự đưa chính nó vào khung Android, hay còn gọi là máy chủ hệ thống, để thực thi. Để kiểm tra khung Android, mã kiểm tra chỉ có thể gọi các bề mặt API công khai hoặc những bề mặt được hiển thị thông qua Ngôn ngữ định nghĩa giao diện Android AIDL có sẵn trong cây nguồn nền tảng. Đối với loại thử nghiệm này, việc nhắm mục tiêu bất kỳ gói cụ thể nào là không có ý nghĩa. Do đó, theo thông lệ, các công cụ như vậy sẽ được khai báo để nhắm mục tiêu gói ứng dụng thử nghiệm của chính nó, như được định nghĩa trong <manifest> của riêng nó là AndroidManifest.xml .

Tùy thuộc vào yêu cầu, các gói ứng dụng thử nghiệm trong danh mục này cũng có thể:

• Gói các hoạt động cần thiết để thử nghiệm.
• Chia sẻ ID người dùng với hệ thống.
• Được ký bằng khóa nền tảng.
• Được biên dịch dựa trên nguồn khung thay vì SDK công khai.

Loại thử nghiệm thiết bị này đôi khi được gọi là tự thiết bị. Dưới đây là một số ví dụ về các bài kiểm tra tự thiết bị trong nguồn nền tảng:

• khung/cơ sở/lõi/thử nghiệm/
• khung/cơ sở/dịch vụ/kiểm tra/dịch vụ kiểm tra

Ví dụ được đề cập ở đây là viết một thử nghiệm thiết bị mới với gói mục tiêu được đặt tại gói ứng dụng thử nghiệm của chính nó. Hướng dẫn này sử dụng bài kiểm tra sau để làm ví dụ:

• Kiểm tra thiết bị Hello World

Trước tiên, bạn nên duyệt qua mã để có ấn tượng sơ bộ trước khi tiếp tục.

Quyết định vị trí nguồn

Thông thường, nhóm của bạn sẽ có sẵn một mẫu thiết lập các vị trí để kiểm tra mã và các vị trí để thêm các bài kiểm tra. Hầu hết các nhóm sở hữu một kho lưu trữ git duy nhất hoặc chia sẻ một kho lưu trữ với các nhóm khác nhưng có một thư mục con chuyên dụng chứa mã nguồn thành phần.

Giả sử vị trí gốc cho nguồn thành phần của bạn là tại <component source root> , hầu hết các thành phần đều có các thư mục src và tests bên dưới và một số tệp bổ sung như Android.mk (hoặc được chia thành các tệp .mk bổ sung), tệp kê khai AndroidManifest.xml và tệp cấu hình thử nghiệm 'AndroidTest.xml'.

Vì bạn đang thêm một bài kiểm tra hoàn toàn mới, nên có thể bạn sẽ cần tạo thư mục tests bên cạnh thành phần src của mình và điền nội dung vào đó.

Trong một số trường hợp, nhóm của bạn có thể có nhiều cấu trúc thư mục hơn trong tests do nhu cầu đóng gói các bộ thử nghiệm khác nhau thành các gói ứng dụng riêng lẻ. Và trong trường hợp này, bạn sẽ cần tạo một thư mục con mới trong tests .

Bất kể cấu trúc như thế nào, cuối cùng bạn sẽ điền vào thư mục tests hoặc thư mục con mới được tạo với các tệp tương tự như những gì trong thư mục instrumentation trong thay đổi gerrit mẫu. Các phần bên dưới sẽ giải thích chi tiết hơn về từng tệp.

Tệp kê khai

Cũng giống như một ứng dụng thông thường, mỗi mô-đun kiểm tra thiết bị cần một tệp kê khai. Nếu bạn đặt tên cho tệp là AndroidManifest.xml và cung cấp tệp bên cạnh Android.mk cho mô-đun thử nghiệm của mình, thì tệp đó sẽ tự động được đưa vào bởi tệp tạo lõi BUILD_PACKAGE .

Trước khi tiếp tục, bạn nên xem qua Tổng quan về tệp kê khai ứng dụng trước.

Phần này cung cấp tổng quan về các thành phần cơ bản của tệp kê khai và các chức năng của chúng. Xem ví dụ tại platform_testing/tests/example/instrumentation/AndroidManifest.xml .

Một ảnh chụp nhanh được bao gồm ở đây để thuận tiện:

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="android.test.example.helloworld" >

    <application/>

    <instrumentation android:name="androidx.test.runner.AndroidJUnitRunner"
                     android:targetPackage="android.test.example.helloworld"
                     android:label="Hello World Test"/>

</manifest>

Một số nhận xét chọn lọc trên tệp kê khai:

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="android.test.example.helloworld" >

Thuộc tính package là tên gói ứng dụng: đây là mã định danh duy nhất mà khung ứng dụng Android sử dụng để xác định ứng dụng (hoặc trong ngữ cảnh này: ứng dụng thử nghiệm của bạn). Mỗi người dùng trong hệ thống chỉ có thể cài đặt một ứng dụng với tên gói đó.

Hơn nữa, thuộc tính package này giống với thuộc tính ComponentName#getPackageName() trả về và cũng giống như thuộc tính mà bạn sẽ sử dụng để tương tác với các lệnh phụ pm khác nhau thông qua adb shell .

Cũng xin lưu ý rằng mặc dù tên gói thường có cùng kiểu với tên gói Java, nhưng thực tế nó có rất ít thứ liên quan đến nó. Nói cách khác, gói ứng dụng (hoặc thử nghiệm) của bạn có thể chứa các lớp với bất kỳ tên gói nào, mặc dù vậy, bạn có thể chọn đơn giản hơn và đặt tên gói Java cấp cao nhất trong ứng dụng hoặc thử nghiệm của mình giống với tên gói ứng dụng.

android:sharedUserId="android.uid.system"

Điều này tuyên bố rằng tại thời điểm cài đặt, gói ứng dụng này sẽ được cấp cùng một id người dùng, tức là danh tính thời gian chạy, làm nền tảng cốt lõi. Lưu ý rằng điều này phụ thuộc vào gói ứng dụng được ký bằng cùng chứng chỉ với nền tảng cốt lõi (xem LOCAL_CERTIFICATE ở phần trên), tuy nhiên chúng là các khái niệm khác nhau:

• một số quyền hoặc API được bảo vệ bằng chữ ký, yêu cầu cùng một chứng chỉ ký
• một số quyền hoặc API yêu cầu danh tính người dùng system của người gọi, yêu cầu gói gọi chia sẻ id người dùng với system , nếu đó là gói riêng biệt với chính nền tảng cốt lõi

<uses-library android:name="android.test.runner" />

Điều này là bắt buộc đối với tất cả các bài kiểm tra Thiết bị vì các lớp liên quan được đóng gói trong một tệp thư viện jar khung riêng biệt, do đó yêu cầu các mục nhập đường dẫn lớp bổ sung khi gói kiểm tra được gọi bởi khung ứng dụng.

android:targetPackage="android.test.example.helloworld"

Bạn có thể nhận thấy rằng gói mục targetPackage ở đây được khai báo giống như thuộc tính package được khai báo trong thẻ manifest của tệp này. Như đã đề cập trong phần cơ bản về thử nghiệm , danh mục thử nghiệm thiết bị này thường dành cho thử nghiệm các API khung, do đó, việc chúng có một gói ứng dụng được nhắm mục tiêu cụ thể, ngoài chính nó, là không có ý nghĩa lắm.

Tập tin cấu hình đơn giản

Mỗi mô-đun thử nghiệm mới phải có một tệp cấu hình để chỉ đạo hệ thống xây dựng với siêu dữ liệu mô-đun, các phụ thuộc thời gian biên dịch và hướng dẫn đóng gói. Trong hầu hết các trường hợp, tùy chọn tệp Blueprint dựa trên Soong là đủ. Để biết chi tiết, hãy xem Cấu hình thử nghiệm đơn giản .

Tập tin cấu hình phức tạp

Quan trọng: Hướng dẫn trong phần này chỉ cần thiết cho các bài kiểm tra CTS hoặc những bài kiểm tra yêu cầu thiết lập đặc biệt, chẳng hạn như tắt Bluetooth hoặc thu thập dữ liệu mẫu. Tất cả các trường hợp khác có thể được đề cập thông qua Cấu hình thử nghiệm đơn giản . Xem Cấu hình thử nghiệm phức tạp để biết thêm chi tiết áp dụng cho phần này.

Đối với những trường hợp phức tạp hơn này, bạn cũng cần viết tệp cấu hình thử nghiệm cho bộ khai thác thử nghiệm của Android, Trade Federation .

Cấu hình thử nghiệm có thể chỉ định các tùy chọn thiết lập thiết bị đặc biệt và các đối số mặc định để cung cấp cho lớp thử nghiệm. Xem ví dụ tại /platform_testing/tests/example/instrumentation/AndroidTest.xml .

Một ảnh chụp nhanh được bao gồm ở đây để thuận tiện:

<configuration description="Runs sample instrumentation test.">
  <target_preparer class="com.android.tradefed.targetprep.TestFilePushSetup"/>
  <target_preparer class="com.android.tradefed.targetprep.TestAppInstallSetup">
    <option name="test-file-name" value="HelloWorldTests.apk"/>
  </target_preparer>
  <target_preparer class="com.android.tradefed.targetprep.PushFilePreparer"/>
  <target_preparer class="com.android.tradefed.targetprep.RunCommandTargetPreparer"/>
  <option name="test-suite-tag" value="apct"/>
  <option name="test-tag" value="SampleInstrumentationTest"/>

  <test class="com.android.tradefed.testtype.AndroidJUnitTest">
    <option name="package" value="android.test.example.helloworld"/>
    <option name="runner" value="android.support.test.runner.AndroidJUnitRunner"/>
  </test>
</configuration>

Một số nhận xét chọn lọc trên tệp cấu hình thử nghiệm:

<target_preparer class="com.android.tradefed.targetprep.TestAppInstallSetup">
  <option name="test-file-name" value="HelloWorldTests.apk"/>
</target_preparer>

Điều này báo cho Liên đoàn Thương mại cài đặt HelloWorldTests.apk trên thiết bị đích bằng target_preparer được chỉ định. Có nhiều công cụ chuẩn bị mục tiêu dành cho nhà phát triển trong Liên đoàn Thương mại và những công cụ này có thể được sử dụng để đảm bảo thiết bị được thiết lập đúng cách trước khi thực hiện thử nghiệm.

<test class="com.android.tradefed.testtype.AndroidJUnitTest">
  <option name="package" value="android.test.example.helloworld"/>
  <option name="runner" value="android.support.test.runner.AndroidJUnitRunner"/>
</test>

Điều này chỉ định lớp kiểm tra Trade Federation sẽ sử dụng để thực hiện kiểm tra và chuyển vào gói trên thiết bị sẽ được thực thi và khung trình chạy thử nghiệm là JUnit trong trường hợp này.

Để biết thêm thông tin, hãy xem Cấu hình mô-đun thử nghiệm .

Các tính năng của JUnit4

Việc sử dụng thư viện android-support-test làm trình chạy thử cho phép áp dụng các lớp kiểm tra kiểu JUnit4 mới và thay đổi gerrit mẫu chứa một số cách sử dụng rất cơ bản các tính năng của nó. Xem ví dụ tại /platform_testing/tests/example/instrumentation/src/android/test/example/helloworld/HelloWorldTest.java .

Mặc dù các mẫu thử nghiệm thường dành riêng cho các nhóm thành phần, nhưng có một số mẫu sử dụng hữu ích nói chung.

@RunWith(JUnit4.class)
public class HelloWorldTest {

Một sự khác biệt đáng kể trong JUnit4 là các bài kiểm tra không còn bắt buộc phải kế thừa từ một lớp kiểm tra cơ sở chung; thay vào đó, bạn viết các bài kiểm tra trong các lớp Java đơn giản và sử dụng chú thích để chỉ ra các ràng buộc và thiết lập kiểm tra nhất định. Trong ví dụ này, chúng tôi đang hướng dẫn rằng lớp này sẽ được chạy dưới dạng thử nghiệm JUnit4.

    @BeforeClass
    public static void beforeClass() {
    ...
    @AfterClass
    public static void afterClass() {
    ...
    @Before
    public void before() {
    ...
    @After
    public void after() {
    ...
    @Test
    @SmallTest
    public void testHelloWorld() {
    ...

Các chú thích @Before Before và @After được JUnit4 sử dụng trên các phương thức để thực hiện thiết lập kiểm tra trước và chia nhỏ kiểm tra sau. Tương tự, các chú thích @BeforeClass BeforeClass và @AfterClass được JUnit4 sử dụng trên các phương thức để thực hiện thiết lập trước khi thực hiện tất cả các kiểm tra trong một lớp kiểm tra và phân tích sau đó. Lưu ý rằng các phương thức thiết lập và chia nhỏ phạm vi lớp phải là tĩnh. Đối với các phương thức thử nghiệm, không giống như trong phiên bản trước của JUnit, chúng không còn cần phải bắt đầu tên phương thức bằng test , thay vào đó, mỗi phương thức phải được chú thích bằng @Test . Như thường lệ, các phương thức kiểm tra phải công khai, không khai báo giá trị trả về, không nhận tham số và có thể đưa ra ngoại lệ.

Quan trọng : bản thân các phương thức kiểm tra được chú thích bằng chú thích @Test ; và lưu ý rằng đối với các thử nghiệm được thực thi qua APCT, chúng phải được chú thích bằng các kích thước thử nghiệm: ví dụ về phương thức được chú thích testHelloWorld là @SmallTest . Chú thích có thể được áp dụng ở phạm vi phương thức hoặc phạm vi lớp.

Truy cập instrumentation

Mặc dù không được đề cập trong ví dụ cơ bản về hello world, nhưng việc thử nghiệm Android yêu cầu phiên bản Instrumentation truy cập là điều khá phổ biến: đây là giao diện API cốt lõi cung cấp quyền truy cập vào ngữ cảnh ứng dụng, API thử nghiệm liên quan đến vòng đời hoạt động, v.v.

Bởi vì các thử nghiệm JUnit4 không còn yêu cầu một lớp cơ sở chung, nên không còn cần thiết phải lấy phiên bản Thiết bị thông qua Instrumentation InstrumentationTestCase#getInstrumentation() , thay vào đó, trình chạy thử nghiệm mới sẽ quản lý nó thông qua InstrumentationRegistry nơi lưu trữ thiết lập theo ngữ cảnh và môi trường do khung thiết bị tạo ra.

Để truy cập thể hiện của lớp Instrumentation , chỉ cần gọi phương thức tĩnh getInstrumentation() trên lớp InstrumentationRegistry :

Instrumentation instrumentation = InstrumentationRegistry.getInstrumentation()

Xây dựng và thử nghiệm cục bộ

Đối với các trường hợp sử dụng phổ biến nhất, hãy sử dụng Atest .

Đối với các trường hợp phức tạp hơn cần tùy chỉnh nặng hơn, hãy làm theo hướng dẫn của thiết bị .