| // Copyright 2019 The Android Open Source Project |
| // |
| // Licensed under the Apache License, Version 2.0 (the "License"); |
| // you may not use this file except in compliance with the License. |
| // You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, software |
| // distributed under the License is distributed on an "AS IS" BASIS, |
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| // See the License for the specific language governing permissions and |
| // limitations under the License. |
| |
| package rust |
| |
| import ( |
| "strings" |
| "testing" |
| |
| "android/soong/android" |
| ) |
| |
| // Test that variants are being generated correctly, and that crate-types are correct. |
| func TestLibraryVariants(t *testing.T) { |
| |
| ctx := testRust(t, ` |
| rust_library_host { |
| name: "libfoo", |
| srcs: ["foo.rs"], |
| crate_name: "foo", |
| } |
| rust_ffi_host { |
| name: "libfoo.ffi", |
| srcs: ["foo.rs"], |
| crate_name: "foo" |
| }`) |
| |
| // Test all variants are being built. |
| libfooStatic := ctx.ModuleForTests("libfoo.ffi", "linux_glibc_x86_64_static").Rule("rustc") |
| libfooRlib := ctx.ModuleForTests("libfoo", "linux_glibc_x86_64_rlib_rlib-std").Rule("rustc") |
| libfooDylib := ctx.ModuleForTests("libfoo", "linux_glibc_x86_64_dylib").Rule("rustc") |
| libfooFFIRlib := ctx.ModuleForTests("libfoo.ffi", "linux_glibc_x86_64_rlib_rlib-std").Rule("rustc") |
| libfooShared := ctx.ModuleForTests("libfoo.ffi", "linux_glibc_x86_64_shared").Rule("rustc") |
| |
| rlibCrateType := "rlib" |
| dylibCrateType := "dylib" |
| sharedCrateType := "cdylib" |
| staticCrateType := "staticlib" |
| |
| // Test crate type for rlib is correct. |
| if !strings.Contains(libfooRlib.Args["rustcFlags"], "crate-type="+rlibCrateType) { |
| t.Errorf("missing crate-type for static variant, expecting %#v, rustcFlags: %#v", rlibCrateType, libfooRlib.Args["rustcFlags"]) |
| } |
| |
| // Test crate type for dylib is correct. |
| if !strings.Contains(libfooDylib.Args["rustcFlags"], "crate-type="+dylibCrateType) { |
| t.Errorf("missing crate-type for static variant, expecting %#v, rustcFlags: %#v", dylibCrateType, libfooDylib.Args["rustcFlags"]) |
| } |
| |
| // Test crate type for C static libraries is correct. |
| if !strings.Contains(libfooStatic.Args["rustcFlags"], "crate-type="+staticCrateType) { |
| t.Errorf("missing crate-type for static variant, expecting %#v, rustcFlags: %#v", staticCrateType, libfooStatic.Args["rustcFlags"]) |
| } |
| |
| // Test crate type for FFI rlibs is correct |
| if !strings.Contains(libfooFFIRlib.Args["rustcFlags"], "crate-type="+rlibCrateType) { |
| t.Errorf("missing crate-type for static variant, expecting %#v, rustcFlags: %#v", rlibCrateType, libfooFFIRlib.Args["rustcFlags"]) |
| } |
| |
| // Test crate type for C shared libraries is correct. |
| if !strings.Contains(libfooShared.Args["rustcFlags"], "crate-type="+sharedCrateType) { |
| t.Errorf("missing crate-type for shared variant, expecting %#v, got rustcFlags: %#v", sharedCrateType, libfooShared.Args["rustcFlags"]) |
| } |
| |
| } |
| |
| // Test that dylibs are not statically linking the standard library. |
| func TestDylibPreferDynamic(t *testing.T) { |
| ctx := testRust(t, ` |
| rust_library_host_dylib { |
| name: "libfoo", |
| srcs: ["foo.rs"], |
| crate_name: "foo", |
| }`) |
| |
| libfooDylib := ctx.ModuleForTests("libfoo", "linux_glibc_x86_64_dylib").Rule("rustc") |
| |
| if !strings.Contains(libfooDylib.Args["rustcFlags"], "prefer-dynamic") { |
| t.Errorf("missing prefer-dynamic flag for libfoo dylib, rustcFlags: %#v", libfooDylib.Args["rustcFlags"]) |
| } |
| } |
| |
| // Check that we are passing the android_dylib config flag |
| func TestAndroidDylib(t *testing.T) { |
| ctx := testRust(t, ` |
| rust_library_host_dylib { |
| name: "libfoo", |
| srcs: ["foo.rs"], |
| crate_name: "foo", |
| }`) |
| |
| libfooDylib := ctx.ModuleForTests("libfoo", "linux_glibc_x86_64_dylib").Rule("rustc") |
| |
| if !strings.Contains(libfooDylib.Args["rustcFlags"], "--cfg 'android_dylib'") { |
| t.Errorf("missing android_dylib cfg flag for libfoo dylib, rustcFlags: %#v", libfooDylib.Args["rustcFlags"]) |
| } |
| } |
| |
| func TestValidateLibraryStem(t *testing.T) { |
| testRustError(t, "crate_name must be defined.", ` |
| rust_library_host { |
| name: "libfoo", |
| srcs: ["foo.rs"], |
| }`) |
| |
| testRustError(t, "library crate_names must be alphanumeric with underscores allowed", ` |
| rust_library_host { |
| name: "libfoo-bar", |
| srcs: ["foo.rs"], |
| crate_name: "foo-bar" |
| }`) |
| |
| testRustError(t, "Invalid name or stem property; library filenames must start with lib<crate_name>", ` |
| rust_library_host { |
| name: "foobar", |
| srcs: ["foo.rs"], |
| crate_name: "foo_bar" |
| }`) |
| testRustError(t, "Invalid name or stem property; library filenames must start with lib<crate_name>", ` |
| rust_library_host { |
| name: "foobar", |
| stem: "libfoo", |
| srcs: ["foo.rs"], |
| crate_name: "foo_bar" |
| }`) |
| testRustError(t, "Invalid name or stem property; library filenames must start with lib<crate_name>", ` |
| rust_library_host { |
| name: "foobar", |
| stem: "foo_bar", |
| srcs: ["foo.rs"], |
| crate_name: "foo_bar" |
| }`) |
| |
| } |
| |
| func TestSharedLibrary(t *testing.T) { |
| ctx := testRust(t, ` |
| rust_ffi_shared { |
| name: "libfoo", |
| srcs: ["foo.rs"], |
| crate_name: "foo", |
| }`) |
| |
| libfoo := ctx.ModuleForTests("libfoo", "android_arm64_armv8-a_shared") |
| |
| libfooOutput := libfoo.Rule("rustc") |
| if !strings.Contains(libfooOutput.Args["linkFlags"], "-Wl,-soname=libfoo.so") { |
| t.Errorf("missing expected -Wl,-soname linker flag for libfoo shared lib, linkFlags: %#v", |
| libfooOutput.Args["linkFlags"]) |
| } |
| |
| if !android.InList("libstd", libfoo.Module().(*Module).Properties.AndroidMkDylibs) { |
| t.Errorf("Non-static libstd dylib expected to be a dependency of Rust shared libraries. Dylib deps are: %#v", |
| libfoo.Module().(*Module).Properties.AndroidMkDylibs) |
| } |
| } |
| |
| func TestSharedLibraryToc(t *testing.T) { |
| ctx := testRust(t, ` |
| rust_ffi_shared { |
| name: "libfoo", |
| srcs: ["foo.rs"], |
| crate_name: "foo", |
| } |
| cc_binary { |
| name: "fizzbuzz", |
| shared_libs: ["libfoo"], |
| }`) |
| |
| fizzbuzz := ctx.ModuleForTests("fizzbuzz", "android_arm64_armv8-a").Rule("ld") |
| |
| if !android.SuffixInList(fizzbuzz.Implicits.Strings(), "libfoo.so.toc") { |
| t.Errorf("missing expected libfoo.so.toc implicit dependency, instead found: %#v", |
| fizzbuzz.Implicits.Strings()) |
| } |
| } |
| |
| func TestStaticLibraryLinkage(t *testing.T) { |
| ctx := testRust(t, ` |
| rust_ffi { |
| name: "libfoo", |
| srcs: ["foo.rs"], |
| crate_name: "foo", |
| }`) |
| |
| libfoo := ctx.ModuleForTests("libfoo", "android_arm64_armv8-a_rlib_rlib-std") |
| libfooStatic := ctx.ModuleForTests("libfoo", "android_arm64_armv8-a_static") |
| |
| if !android.InList("libstd", libfoo.Module().(*Module).Properties.AndroidMkRlibs) { |
| t.Errorf("Static libstd rlib expected to be a dependency of Rust rlib libraries. Rlib deps are: %#v", |
| libfoo.Module().(*Module).Properties.AndroidMkDylibs) |
| } |
| if !android.InList("libstd", libfooStatic.Module().(*Module).Properties.AndroidMkRlibs) { |
| t.Errorf("Static libstd rlib expected to be a dependency of Rust static libraries. Rlib deps are: %#v", |
| libfoo.Module().(*Module).Properties.AndroidMkDylibs) |
| } |
| } |
| |
| func TestNativeDependencyOfRlib(t *testing.T) { |
| ctx := testRust(t, ` |
| rust_ffi_rlib { |
| name: "libffi_rlib", |
| crate_name: "ffi_rlib", |
| rlibs: ["librust_rlib"], |
| srcs: ["foo.rs"], |
| } |
| rust_ffi_static { |
| name: "libffi_static", |
| crate_name: "ffi_static", |
| rlibs: ["librust_rlib"], |
| srcs: ["foo.rs"], |
| } |
| rust_library_rlib { |
| name: "librust_rlib", |
| crate_name: "rust_rlib", |
| srcs: ["foo.rs"], |
| shared_libs: ["shared_cc_dep"], |
| static_libs: ["static_cc_dep"], |
| } |
| cc_library_shared { |
| name: "shared_cc_dep", |
| srcs: ["foo.cpp"], |
| } |
| cc_library_static { |
| name: "static_cc_dep", |
| srcs: ["foo.cpp"], |
| } |
| `) |
| |
| rustRlibRlibStd := ctx.ModuleForTests("librust_rlib", "android_arm64_armv8-a_rlib_rlib-std") |
| rustRlibDylibStd := ctx.ModuleForTests("librust_rlib", "android_arm64_armv8-a_rlib_dylib-std") |
| ffiStatic := ctx.ModuleForTests("libffi_static", "android_arm64_armv8-a_static") |
| ffiRlib := ctx.ModuleForTests("libffi_rlib", "android_arm64_armv8-a_rlib_rlib-std") |
| |
| modules := []android.TestingModule{ |
| rustRlibRlibStd, |
| rustRlibDylibStd, |
| ffiRlib, |
| ffiStatic, |
| } |
| |
| // librust_rlib specifies -L flag to cc deps output directory on rustc command |
| // and re-export the cc deps to rdep libffi_static |
| // When building rlib crate, rustc doesn't link the native libraries |
| // The build system assumes the cc deps will be at the final linkage (either a shared library or binary) |
| // Hence, these flags are no-op |
| // TODO: We could consider removing these flags |
| for _, module := range modules { |
| if !strings.Contains(module.Rule("rustc").Args["libFlags"], |
| "-L out/soong/.intermediates/shared_cc_dep/android_arm64_armv8-a_shared/") { |
| t.Errorf( |
| "missing -L flag for shared_cc_dep, rustcFlags: %#v", |
| rustRlibRlibStd.Rule("rustc").Args["libFlags"], |
| ) |
| } |
| if !strings.Contains(module.Rule("rustc").Args["libFlags"], |
| "-L out/soong/.intermediates/static_cc_dep/android_arm64_armv8-a_static/") { |
| t.Errorf( |
| "missing -L flag for static_cc_dep, rustcFlags: %#v", |
| rustRlibRlibStd.Rule("rustc").Args["libFlags"], |
| ) |
| } |
| } |
| } |
| |
| // Test that variants pull in the right type of rustlib autodep |
| func TestAutoDeps(t *testing.T) { |
| |
| ctx := testRust(t, ` |
| rust_library_host { |
| name: "libbar", |
| srcs: ["bar.rs"], |
| crate_name: "bar", |
| } |
| rust_library_host_rlib { |
| name: "librlib_only", |
| srcs: ["bar.rs"], |
| crate_name: "rlib_only", |
| } |
| rust_library_host { |
| name: "libfoo", |
| srcs: ["foo.rs"], |
| crate_name: "foo", |
| rustlibs: [ |
| "libbar", |
| "librlib_only", |
| ], |
| } |
| rust_ffi_host { |
| name: "libfoo.ffi", |
| srcs: ["foo.rs"], |
| crate_name: "foo", |
| rustlibs: [ |
| "libbar", |
| "librlib_only", |
| ], |
| }`) |
| |
| libfooRlib := ctx.ModuleForTests("libfoo", "linux_glibc_x86_64_rlib_rlib-std") |
| libfooDylib := ctx.ModuleForTests("libfoo", "linux_glibc_x86_64_dylib") |
| libfooFFIRlib := ctx.ModuleForTests("libfoo.ffi", "linux_glibc_x86_64_rlib_rlib-std") |
| libfooStatic := ctx.ModuleForTests("libfoo.ffi", "linux_glibc_x86_64_static") |
| libfooShared := ctx.ModuleForTests("libfoo.ffi", "linux_glibc_x86_64_shared") |
| |
| for _, static := range []android.TestingModule{libfooRlib, libfooStatic, libfooFFIRlib} { |
| if !android.InList("libbar.rlib-std", static.Module().(*Module).Properties.AndroidMkRlibs) { |
| t.Errorf("libbar not present as rlib dependency in static lib: %s", static.Module().Name()) |
| } |
| if android.InList("libbar", static.Module().(*Module).Properties.AndroidMkDylibs) { |
| t.Errorf("libbar present as dynamic dependency in static lib: %s", static.Module().Name()) |
| } |
| } |
| |
| for _, dyn := range []android.TestingModule{libfooDylib, libfooShared} { |
| if !android.InList("libbar", dyn.Module().(*Module).Properties.AndroidMkDylibs) { |
| t.Errorf("libbar not present as dynamic dependency in dynamic lib: %s", dyn.Module().Name()) |
| } |
| if android.InList("libbar", dyn.Module().(*Module).Properties.AndroidMkRlibs) { |
| t.Errorf("libbar present as rlib dependency in dynamic lib: %s", dyn.Module().Name()) |
| } |
| if !android.InList("librlib_only", dyn.Module().(*Module).Properties.AndroidMkRlibs) { |
| t.Errorf("librlib_only should be selected by rustlibs as an rlib: %s.", dyn.Module().Name()) |
| } |
| } |
| } |
| |
| // Test that stripped versions are correctly generated and used. |
| func TestStrippedLibrary(t *testing.T) { |
| ctx := testRust(t, ` |
| rust_library_dylib { |
| name: "libfoo", |
| crate_name: "foo", |
| srcs: ["foo.rs"], |
| } |
| rust_library_dylib { |
| name: "libbar", |
| crate_name: "bar", |
| srcs: ["foo.rs"], |
| strip: { |
| none: true |
| } |
| } |
| `) |
| |
| foo := ctx.ModuleForTests("libfoo", "android_arm64_armv8-a_dylib") |
| foo.Output("libfoo.dylib.so") |
| foo.Output("unstripped/libfoo.dylib.so") |
| // Check that the `cp` rule is using the stripped version as input. |
| cp := foo.Rule("android.Cp") |
| if strings.HasSuffix(cp.Input.String(), "unstripped/libfoo.dylib.so") { |
| t.Errorf("installed library not based on stripped version: %v", cp.Input) |
| } |
| |
| fizzBar := ctx.ModuleForTests("libbar", "android_arm64_armv8-a_dylib").MaybeOutput("unstripped/libbar.dylib.so") |
| if fizzBar.Rule != nil { |
| t.Errorf("unstripped library exists, so stripped library has incorrectly been generated") |
| } |
| } |
| |
| func TestLibstdLinkage(t *testing.T) { |
| ctx := testRust(t, ` |
| rust_library { |
| name: "libfoo", |
| srcs: ["foo.rs"], |
| crate_name: "foo", |
| } |
| rust_ffi { |
| name: "libbar", |
| srcs: ["foo.rs"], |
| crate_name: "bar", |
| rustlibs: ["libfoo"], |
| } |
| rust_ffi { |
| name: "libbar.prefer_rlib", |
| srcs: ["foo.rs"], |
| crate_name: "bar", |
| rustlibs: ["libfoo"], |
| prefer_rlib: true, |
| }`) |
| |
| libfooDylib := ctx.ModuleForTests("libfoo", "android_arm64_armv8-a_dylib").Module().(*Module) |
| libfooRlibStatic := ctx.ModuleForTests("libfoo", "android_arm64_armv8-a_rlib_rlib-std").Module().(*Module) |
| libfooRlibDynamic := ctx.ModuleForTests("libfoo", "android_arm64_armv8-a_rlib_dylib-std").Module().(*Module) |
| |
| libbarShared := ctx.ModuleForTests("libbar", "android_arm64_armv8-a_shared").Module().(*Module) |
| libbarStatic := ctx.ModuleForTests("libbar", "android_arm64_armv8-a_static").Module().(*Module) |
| libbarFFIRlib := ctx.ModuleForTests("libbar", "android_arm64_armv8-a_rlib_rlib-std").Module().(*Module) |
| |
| // prefer_rlib works the same for both rust_library and rust_ffi, so a single check is sufficient here. |
| libbarRlibStd := ctx.ModuleForTests("libbar.prefer_rlib", "android_arm64_armv8-a_shared").Module().(*Module) |
| |
| if !android.InList("libstd", libfooRlibStatic.Properties.AndroidMkRlibs) { |
| t.Errorf("rlib-std variant for device rust_library_rlib does not link libstd as an rlib") |
| } |
| if !android.InList("libstd", libfooRlibDynamic.Properties.AndroidMkDylibs) { |
| t.Errorf("dylib-std variant for device rust_library_rlib does not link libstd as an dylib") |
| } |
| if !android.InList("libstd", libfooDylib.Properties.AndroidMkDylibs) { |
| t.Errorf("Device rust_library_dylib does not link libstd as an dylib") |
| } |
| |
| if !android.InList("libstd", libbarShared.Properties.AndroidMkDylibs) { |
| t.Errorf("Device rust_ffi_shared does not link libstd as an dylib") |
| } |
| if !android.InList("libstd", libbarStatic.Properties.AndroidMkRlibs) { |
| t.Errorf("Device rust_ffi_static does not link libstd as an rlib") |
| } |
| if !android.InList("libfoo.rlib-std", libbarStatic.Properties.AndroidMkRlibs) { |
| t.Errorf("Device rust_ffi_static does not link dependent rustlib rlib-std variant") |
| } |
| if !android.InList("libstd", libbarFFIRlib.Properties.AndroidMkRlibs) { |
| t.Errorf("Device rust_ffi_rlib does not link libstd as an rlib") |
| } |
| if !android.InList("libfoo.rlib-std", libbarFFIRlib.Properties.AndroidMkRlibs) { |
| t.Errorf("Device rust_ffi_rlib does not link dependent rustlib rlib-std variant") |
| } |
| if !android.InList("libstd", libbarRlibStd.Properties.AndroidMkRlibs) { |
| t.Errorf("rust_ffi with prefer_rlib does not link libstd as an rlib") |
| } |
| |
| } |
| |
| func TestRustFFIExportedIncludes(t *testing.T) { |
| ctx := testRust(t, ` |
| rust_ffi { |
| name: "libbar", |
| srcs: ["foo.rs"], |
| crate_name: "bar", |
| export_include_dirs: ["rust_includes"], |
| host_supported: true, |
| } |
| cc_library_static { |
| name: "libfoo", |
| srcs: ["foo.cpp"], |
| shared_libs: ["libbar"], |
| host_supported: true, |
| }`) |
| libfooStatic := ctx.ModuleForTests("libfoo", "linux_glibc_x86_64_static").Rule("cc") |
| android.AssertStringDoesContain(t, "cFlags for lib module", libfooStatic.Args["cFlags"], " -Irust_includes ") |
| } |