測試模組

本頁面提供基本資訊，說明如何建構使用 Rust 測試架構的 rust_test 模組。

編寫基本的 Rust 測試

如要查看裝置端和主機端 Rust 測試的即時範例，請查看 keystore2 Android.bp，或在 external/rust/crates 目錄的許多 Crate 中尋找。

rust_test 模組會使用 rustc 的 --test 標記建構，並從標有 #[test] 屬性的程式碼建立測試。詳情請參閱「Rust 參考測試屬性」說明文件。

定義測試模組，如下所示：

rust_test {
    name: "libfoo_inline_tests",

    // Specify the entry point of your library or binary to run all tests
    // specified in-line with the test attribute.
    srcs: ["src/lib.rs"],

    // Tradefed test suite to include this test in.
    test_suites: ["general-tests"],

    // Autogenerate the test config
    auto_gen_config: true,

    rustlibs: [
        "libfoo",
    ],
}

TEST_MAPPING 檔案包含測試清單。雖然不是必要條件，但如果您建立 TEST_MAPPING 檔案，其中包含的測試會在預先提交測試中執行，並可使用 atest 叫用。

如要瞭解詳情，請參閱 TEST_MAPPING 說明文件，但就 libfoo_inline_tests 範例而言，請將下列內容新增至預先提交，以便在 TreeHugger 上啟用測試執行：

{
  "presubmit": [
    {
      "name": "libfoo_inline_tests",
    },
  ]
}

請注意，除非 unit_tests: 設為 false，否則預設會在預先提交時執行 rust_test_host 模組，因此您不需要在 TEST_MAPPING 檔案中宣告這些模組。

如要進一步瞭解 auto_gen_config 和 test_suites 屬性的運作方式，請參閱測試開發工作流程說明文件的「設定」一節。

重要的 Rust 測試屬性

如「二進位模組」頁面所述，rust_test 模組會從 rust_binary 模組繼承屬性。

下表定義的屬性是適用於所有模組的重要通用屬性。這些項目對 Rust 測試模組特別重要，或展現 rust_test 模組類型特有的行為。

  • test_harness：進階用法，預設為 true。

如果 rust_test 實作了自己的測試架構，且您不需要使用內建的 Rust 測試架構，請將此值設為 false (換句話說，將此值設為 false「不會」將 --test 標記傳遞至 rustc)。

避免 rust_library 和 rust_test 之間重複

透過巢狀模組使用內嵌 Rust 測試時，Android.bp 檔案中會出現重複項目。問題是您必須列出依附元件兩次，一次用於 rust_library，一次用於 rust_test：

rust_library {
    name: "libfoo",
    srcs: ["src/lib.rs"],
    rustlibs: [
        "libx",
        "liby",
        "libz",
    ],
}

rust_test {
    name: "libfoo_inline_tests",
    srcs: ["src/lib.rs"],
    test_suites: ["general-tests"],
    rustlibs: [
        "libx",
        "liby",
        "libz",
    ],
}

每個 rust_test 模組最終都會列出與對應 rust_library 模組相同的依附元件。為確保模組之間的一致性，您可以在 rust_defaults 模組中列出依附元件一次：

rust_defaults {
    name: "libfoo_defaults",
    srcs: ["src/lib.rs"],
    rustlibs: [
        "libx",
        "liby",
        "libz",
    ],
}

rust_library {
    name: "libfoo",
    defaults: ["libfoo_defaults"],
}

rust_test {
    name: "libfoo_inline_tests",
    defaults: ["libfoo_defaults"],
    test_suites: ["general-tests"],
}

這樣一來，程式庫和測試模組一律會使用相同的依附元件。