12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058 |
- // Copyright 2017 Google Inc. All rights reserved.
- //
- // 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.
- // This file implements the logic of bpfix and also provides a programmatic interface
- package bpfix
- import (
- "bytes"
- "fmt"
- "strings"
- "testing"
- "reflect"
- "github.com/google/blueprint/parser"
- )
- // TODO(jeffrygaston) remove this when position is removed from ParseNode (in b/38325146) and we can directly do reflect.DeepEqual
- func printListOfStrings(items []string) (text string) {
- if len(items) == 0 {
- return "[]"
- }
- return fmt.Sprintf("[\"%s\"]", strings.Join(items, "\", \""))
- }
- func buildTree(local_include_dirs []string, export_include_dirs []string) (file *parser.File, errs []error) {
- // TODO(jeffrygaston) use the builder class when b/38325146 is done
- input := fmt.Sprintf(`cc_library_shared {
- name: "iAmAModule",
- local_include_dirs: %s,
- export_include_dirs: %s,
- }
- `,
- printListOfStrings(local_include_dirs), printListOfStrings(export_include_dirs))
- tree, errs := parser.Parse("", strings.NewReader(input), parser.NewScope(nil))
- if len(errs) > 0 {
- errs = append([]error{fmt.Errorf("failed to parse:\n%s", input)}, errs...)
- }
- return tree, errs
- }
- func implFilterListTest(t *testing.T, local_include_dirs []string, export_include_dirs []string, expectedResult []string) {
- // build tree
- tree, errs := buildTree(local_include_dirs, export_include_dirs)
- if len(errs) > 0 {
- t.Error("failed to build tree")
- for _, err := range errs {
- t.Error(err)
- }
- t.Fatalf("%d parse errors", len(errs))
- }
- fixer := NewFixer(tree)
- // apply simplifications
- err := runPatchListMod(simplifyKnownPropertiesDuplicatingEachOther)(fixer)
- if len(errs) > 0 {
- t.Fatal(err)
- }
- // lookup legacy property
- mod := fixer.tree.Defs[0].(*parser.Module)
- expectedResultString := fmt.Sprintf("%q", expectedResult)
- if expectedResult == nil {
- expectedResultString = "unset"
- }
- // check that the value for the legacy property was updated to the correct value
- errorHeader := fmt.Sprintf("\nFailed to correctly simplify key 'local_include_dirs' in the presence of 'export_include_dirs.'\n"+
- "original local_include_dirs: %q\n"+
- "original export_include_dirs: %q\n"+
- "expected result: %s\n"+
- "actual result: ",
- local_include_dirs, export_include_dirs, expectedResultString)
- result, found := mod.GetProperty("local_include_dirs")
- if !found {
- if expectedResult == nil {
- return
- }
- t.Fatal(errorHeader + "property not found")
- }
- listResult, ok := result.Value.(*parser.List)
- if !ok {
- t.Fatalf("%sproperty is not a list: %v", errorHeader, listResult)
- }
- if expectedResult == nil {
- t.Fatalf("%sproperty exists: %v", errorHeader, listResult)
- }
- actualExpressions := listResult.Values
- actualValues := make([]string, 0)
- for _, expr := range actualExpressions {
- str := expr.(*parser.String)
- actualValues = append(actualValues, str.Value)
- }
- if !reflect.DeepEqual(actualValues, expectedResult) {
- t.Fatalf("%s%q\nlists are different", errorHeader, actualValues)
- }
- }
- func TestSimplifyKnownVariablesDuplicatingEachOther(t *testing.T) {
- // TODO use []Expression{} once buildTree above can support it (which is after b/38325146 is done)
- implFilterListTest(t, []string{"include"}, []string{"include"}, nil)
- implFilterListTest(t, []string{"include1"}, []string{"include2"}, []string{"include1"})
- implFilterListTest(t, []string{"include1", "include2", "include3", "include4"}, []string{"include2"},
- []string{"include1", "include3", "include4"})
- implFilterListTest(t, []string{}, []string{"include"}, []string{})
- implFilterListTest(t, []string{}, []string{}, []string{})
- }
- func runPass(t *testing.T, in, out string, innerTest func(*Fixer) error) {
- expected, err := Reformat(out)
- if err != nil {
- t.Fatal(err)
- }
- in, err = Reformat(in)
- if err != nil {
- t.Fatal(err)
- }
- tree, errs := parser.Parse("<testcase>", bytes.NewBufferString(in), parser.NewScope(nil))
- if errs != nil {
- t.Fatal(errs)
- }
- fixer := NewFixer(tree)
- got := ""
- prev := "foo"
- passes := 0
- for got != prev && passes < 10 {
- err := innerTest(fixer)
- if err != nil {
- t.Fatal(err)
- }
- out, err := parser.Print(fixer.tree)
- if err != nil {
- t.Fatal(err)
- }
- prev = got
- got = string(out)
- passes++
- }
- if got != expected {
- t.Errorf("output didn't match:\ninput:\n%s\n\nexpected:\n%s\ngot:\n%s\n",
- in, expected, got)
- }
- }
- func TestMergeMatchingProperties(t *testing.T) {
- tests := []struct {
- name string
- in string
- out string
- }{
- {
- name: "empty",
- in: `
- java_library {
- name: "foo",
- static_libs: [],
- static_libs: [],
- }
- `,
- out: `
- java_library {
- name: "foo",
- static_libs: [],
- }
- `,
- },
- {
- name: "single line into multiline",
- in: `
- java_library {
- name: "foo",
- static_libs: [
- "a",
- "b",
- ],
- //c1
- static_libs: ["c" /*c2*/],
- }
- `,
- out: `
- java_library {
- name: "foo",
- static_libs: [
- "a",
- "b",
- "c", /*c2*/
- ],
- //c1
- }
- `,
- },
- {
- name: "multiline into multiline",
- in: `
- java_library {
- name: "foo",
- static_libs: [
- "a",
- "b",
- ],
- //c1
- static_libs: [
- //c2
- "c", //c3
- "d",
- ],
- }
- `,
- out: `
- java_library {
- name: "foo",
- static_libs: [
- "a",
- "b",
- //c2
- "c", //c3
- "d",
- ],
- //c1
- }
- `,
- },
- }
- for _, test := range tests {
- t.Run(test.name, func(t *testing.T) {
- runPass(t, test.in, test.out, func(fixer *Fixer) error {
- return runPatchListMod(mergeMatchingModuleProperties)(fixer)
- })
- })
- }
- }
- func TestReorderCommonProperties(t *testing.T) {
- var tests = []struct {
- name string
- in string
- out string
- }{
- {
- name: "empty",
- in: `cc_library {}`,
- out: `cc_library {}`,
- },
- {
- name: "only priority",
- in: `
- cc_library {
- name: "foo",
- }
- `,
- out: `
- cc_library {
- name: "foo",
- }
- `,
- },
- {
- name: "already in order",
- in: `
- cc_library {
- name: "foo",
- defaults: ["bar"],
- }
- `,
- out: `
- cc_library {
- name: "foo",
- defaults: ["bar"],
- }
- `,
- },
- {
- name: "reorder only priority",
- in: `
- cc_library {
- defaults: ["bar"],
- name: "foo",
- }
- `,
- out: `
- cc_library {
- name: "foo",
- defaults: ["bar"],
- }
- `,
- },
- {
- name: "reorder",
- in: `
- cc_library {
- name: "foo",
- srcs: ["a.c"],
- host_supported: true,
- defaults: ["bar"],
- shared_libs: ["baz"],
- }
- `,
- out: `
- cc_library {
- name: "foo",
- defaults: ["bar"],
- host_supported: true,
- srcs: ["a.c"],
- shared_libs: ["baz"],
- }
- `,
- },
- }
- for _, test := range tests {
- t.Run(test.name, func(t *testing.T) {
- runPass(t, test.in, test.out, func(fixer *Fixer) error {
- return runPatchListMod(reorderCommonProperties)(fixer)
- })
- })
- }
- }
- func TestRemoveMatchingModuleListProperties(t *testing.T) {
- var tests = []struct {
- name string
- in string
- out string
- }{
- {
- name: "simple",
- in: `
- cc_library {
- name: "foo",
- foo: ["a"],
- bar: ["a"],
- }
- `,
- out: `
- cc_library {
- name: "foo",
- bar: ["a"],
- }
- `,
- },
- {
- name: "long",
- in: `
- cc_library {
- name: "foo",
- foo: [
- "a",
- "b",
- ],
- bar: ["a"],
- }
- `,
- out: `
- cc_library {
- name: "foo",
- foo: [
- "b",
- ],
- bar: ["a"],
- }
- `,
- },
- {
- name: "long fully removed",
- in: `
- cc_library {
- name: "foo",
- foo: [
- "a",
- ],
- bar: ["a"],
- }
- `,
- out: `
- cc_library {
- name: "foo",
- bar: ["a"],
- }
- `,
- },
- {
- name: "comment",
- in: `
- cc_library {
- name: "foo",
- // comment
- foo: ["a"],
- bar: ["a"],
- }
- `,
- out: `
- cc_library {
- name: "foo",
- // comment
- bar: ["a"],
- }
- `,
- },
- {
- name: "inner comment",
- in: `
- cc_library {
- name: "foo",
- foo: [
- // comment
- "a",
- ],
- bar: ["a"],
- }
- `,
- out: `
- cc_library {
- name: "foo",
- bar: ["a"],
- }
- `,
- },
- {
- name: "eol comment",
- in: `
- cc_library {
- name: "foo",
- foo: ["a"], // comment
- bar: ["a"],
- }
- `,
- out: `
- cc_library {
- name: "foo",
- // comment
- bar: ["a"],
- }
- `,
- },
- {
- name: "eol comment with blank lines",
- in: `
- cc_library {
- name: "foo",
- foo: ["a"], // comment
- // bar
- bar: ["a"],
- }
- `,
- out: `
- cc_library {
- name: "foo",
- // comment
- // bar
- bar: ["a"],
- }
- `,
- },
- }
- for _, test := range tests {
- t.Run(test.name, func(t *testing.T) {
- runPass(t, test.in, test.out, func(fixer *Fixer) error {
- return runPatchListMod(func(mod *parser.Module, buf []byte, patchList *parser.PatchList) error {
- return removeMatchingModuleListProperties(mod, patchList, "bar", "foo")
- })(fixer)
- })
- })
- }
- }
- func TestReplaceJavaStaticLibs(t *testing.T) {
- tests := []struct {
- name string
- in string
- out string
- }{
- {
- name: "static lib",
- in: `
- java_library_static {
- name: "foo",
- }
- `,
- out: `
- java_library {
- name: "foo",
- }
- `,
- },
- {
- name: "java lib",
- in: `
- java_library {
- name: "foo",
- }
- `,
- out: `
- java_library {
- name: "foo",
- }
- `,
- },
- {
- name: "java installable lib",
- in: `
- java_library {
- name: "foo",
- installable: true,
- }
- `,
- out: `
- java_library {
- name: "foo",
- installable: true,
- }
- `,
- },
- }
- for _, test := range tests {
- t.Run(test.name, func(t *testing.T) {
- runPass(t, test.in, test.out, func(fixer *Fixer) error {
- return rewriteJavaStaticLibs(fixer)
- })
- })
- }
- }
- func TestRewritePrebuilts(t *testing.T) {
- tests := []struct {
- name string
- in string
- out string
- }{
- {
- name: "jar srcs",
- in: `
- java_import {
- name: "foo",
- srcs: ["foo.jar"],
- }
- `,
- out: `
- java_import {
- name: "foo",
- jars: ["foo.jar"],
- }
- `,
- },
- {
- name: "aar srcs",
- in: `
- java_import {
- name: "foo",
- srcs: ["foo.aar"],
- installable: true,
- }
- `,
- out: `
- android_library_import {
- name: "foo",
- aars: ["foo.aar"],
- }
- `,
- },
- {
- name: "host prebuilt",
- in: `
- java_import {
- name: "foo",
- srcs: ["foo.jar"],
- host: true,
- }
- `,
- out: `
- java_import_host {
- name: "foo",
- jars: ["foo.jar"],
- }
- `,
- },
- }
- for _, test := range tests {
- t.Run(test.name, func(t *testing.T) {
- runPass(t, test.in, test.out, func(fixer *Fixer) error {
- return rewriteIncorrectAndroidmkPrebuilts(fixer)
- })
- })
- }
- }
- func TestRewriteCtsModuleTypes(t *testing.T) {
- tests := []struct {
- name string
- in string
- out string
- }{
- {
- name: "cts_support_package",
- in: `
- cts_support_package {
- name: "foo",
- }
- `,
- out: `
- android_test {
- name: "foo",
- defaults: ["cts_support_defaults"],
- }
- `,
- },
- {
- name: "cts_package",
- in: `
- cts_package {
- name: "foo",
- }
- `,
- out: `
- android_test {
- name: "foo",
- defaults: ["cts_defaults"],
- }
- `,
- },
- {
- name: "cts_target_java_library",
- in: `
- cts_target_java_library {
- name: "foo",
- }
- `,
- out: `
- java_library {
- name: "foo",
- defaults: ["cts_defaults"],
- }
- `,
- },
- {
- name: "cts_host_java_library",
- in: `
- cts_host_java_library {
- name: "foo",
- }
- `,
- out: `
- java_library_host {
- name: "foo",
- defaults: ["cts_defaults"],
- }
- `,
- },
- }
- for _, test := range tests {
- t.Run(test.name, func(t *testing.T) {
- runPass(t, test.in, test.out, rewriteCtsModuleTypes)
- })
- }
- }
- func TestRewritePrebuiltEtc(t *testing.T) {
- tests := []struct {
- name string
- in string
- out string
- }{
- {
- name: "prebuilt_etc src",
- in: `
- prebuilt_etc {
- name: "foo",
- srcs: ["bar"],
- }
- `,
- out: `prebuilt_etc {
- name: "foo",
- src: "bar",
- }
- `,
- },
- {
- name: "prebuilt_etc src",
- in: `
- prebuilt_etc {
- name: "foo",
- srcs: FOO,
- }
- `,
- out: `prebuilt_etc {
- name: "foo",
- src: FOO,
- }
- `,
- },
- {
- name: "prebuilt_etc src",
- in: `
- prebuilt_etc {
- name: "foo",
- srcs: ["bar", "baz"],
- }
- `,
- out: `prebuilt_etc {
- name: "foo",
- src: "ERROR: LOCAL_SRC_FILES should contain at most one item",
- }
- `,
- },
- {
- name: "prebuilt_etc sub_dir",
- in: `
- prebuilt_etc {
- name: "foo",
- src: "bar",
- sub_dir: "baz",
- }
- `,
- out: `prebuilt_etc {
- name: "foo",
- src: "bar",
- relative_install_dir: "baz",
- }
- `,
- },
- }
- for _, test := range tests {
- t.Run(test.name, func(t *testing.T) {
- runPass(t, test.in, test.out, func(fixer *Fixer) error {
- return rewriteAndroidmkPrebuiltEtc(fixer)
- })
- })
- }
- }
- func TestRewriteAndroidTest(t *testing.T) {
- tests := []struct {
- name string
- in string
- out string
- }{
- {
- name: "android_test valid module path",
- in: `
- android_test {
- name: "foo",
- local_module_path: {
- var: "TARGET_OUT_DATA_APPS",
- },
- }
- `,
- out: `
- android_test {
- name: "foo",
- }
- `,
- },
- }
- for _, test := range tests {
- t.Run(test.name, func(t *testing.T) {
- runPass(t, test.in, test.out, func(fixer *Fixer) error {
- return rewriteAndroidTest(fixer)
- })
- })
- }
- }
- func TestRewriteAndroidAppImport(t *testing.T) {
- tests := []struct {
- name string
- in string
- out string
- }{
- {
- name: "android_app_import apk",
- in: `
- android_app_import {
- name: "foo",
- srcs: ["package.apk"],
- }
- `,
- out: `
- android_app_import {
- name: "foo",
- apk: "package.apk",
- }
- `,
- },
- {
- name: "android_app_import presigned",
- in: `
- android_app_import {
- name: "foo",
- apk: "package.apk",
- certificate: "PRESIGNED",
- }
- `,
- out: `
- android_app_import {
- name: "foo",
- apk: "package.apk",
- presigned: true,
- }
- `,
- },
- }
- for _, test := range tests {
- t.Run(test.name, func(t *testing.T) {
- runPass(t, test.in, test.out, func(fixer *Fixer) error {
- return rewriteAndroidAppImport(fixer)
- })
- })
- }
- }
- func TestRemoveEmptyLibDependencies(t *testing.T) {
- tests := []struct {
- name string
- in string
- out string
- }{
- {
- name: "remove sole shared lib",
- in: `
- cc_library {
- name: "foo",
- shared_libs: ["libhwbinder"],
- }
- `,
- out: `
- cc_library {
- name: "foo",
- }
- `,
- },
- {
- name: "remove a shared lib",
- in: `
- cc_library {
- name: "foo",
- shared_libs: [
- "libhwbinder",
- "libfoo",
- "libhidltransport",
- ],
- }
- `,
- out: `
- cc_library {
- name: "foo",
- shared_libs: [
- "libfoo",
- ],
- }
- `,
- },
- }
- for _, test := range tests {
- t.Run(test.name, func(t *testing.T) {
- runPass(t, test.in, test.out, func(fixer *Fixer) error {
- return removeEmptyLibDependencies(fixer)
- })
- })
- }
- }
- func TestRemoveHidlInterfaceTypes(t *testing.T) {
- tests := []struct {
- name string
- in string
- out string
- }{
- {
- name: "remove types",
- in: `
- hidl_interface {
- name: "foo@1.0",
- types: ["ParcelFooBar"],
- }
- `,
- out: `
- hidl_interface {
- name: "foo@1.0",
- }
- `,
- },
- }
- for _, test := range tests {
- t.Run(test.name, func(t *testing.T) {
- runPass(t, test.in, test.out, func(fixer *Fixer) error {
- return removeHidlInterfaceTypes(fixer)
- })
- })
- }
- }
- func TestRemoveSoongConfigBoolVariable(t *testing.T) {
- tests := []struct {
- name string
- in string
- out string
- }{
- {
- name: "remove bool",
- in: `
- soong_config_module_type {
- name: "foo",
- variables: ["bar", "baz"],
- }
- soong_config_bool_variable {
- name: "bar",
- }
- soong_config_string_variable {
- name: "baz",
- }
- `,
- out: `
- soong_config_module_type {
- name: "foo",
- variables: [
- "baz"
- ],
- bool_variables: ["bar"],
- }
- soong_config_string_variable {
- name: "baz",
- }
- `,
- },
- {
- name: "existing bool_variables",
- in: `
- soong_config_module_type {
- name: "foo",
- variables: ["baz"],
- bool_variables: ["bar"],
- }
- soong_config_bool_variable {
- name: "baz",
- }
- `,
- out: `
- soong_config_module_type {
- name: "foo",
- bool_variables: ["bar", "baz"],
- }
- `,
- },
- }
- for _, test := range tests {
- t.Run(test.name, func(t *testing.T) {
- runPass(t, test.in, test.out, removeSoongConfigBoolVariable)
- })
- }
- }
- func TestRemovePdkProperty(t *testing.T) {
- tests := []struct {
- name string
- in string
- out string
- }{
- {
- name: "remove property",
- in: `
- cc_library_shared {
- name: "foo",
- product_variables: {
- other: {
- bar: true,
- },
- pdk: {
- enabled: false,
- },
- },
- }
- `,
- out: `
- cc_library_shared {
- name: "foo",
- product_variables: {
- other: {
- bar: true,
- },
- },
- }
- `,
- },
- {
- name: "remove property and empty product_variables",
- in: `
- cc_library_shared {
- name: "foo",
- product_variables: {
- pdk: {
- enabled: false,
- },
- },
- }
- `,
- out: `
- cc_library_shared {
- name: "foo",
- }
- `,
- },
- }
- for _, test := range tests {
- t.Run(test.name, func(t *testing.T) {
- runPass(t, test.in, test.out, runPatchListMod(removePdkProperty))
- })
- }
- }
|