android/mutator_test.go - platform/build/soong - Git at Google

 // Copyright 2015 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.

 package android

 import (
 	"fmt"
 	"reflect"
 	"strings"
 	"testing"

 	"github.com/google/blueprint"
 	"github.com/google/blueprint/proptools"
 )

 type mutatorTestModule struct {
 	ModuleBase
 	props struct {
 		Deps_missing_deps    []string
 		Mutator_missing_deps []string
 	}

 	missingDeps []string
 }

 func mutatorTestModuleFactory() Module {
 	module := &mutatorTestModule{}
 	module.AddProperties(&module.props)
 	InitAndroidModule(module)
 	return module
 }

 func (m *mutatorTestModule) GenerateAndroidBuildActions(ctx ModuleContext) {
 	ctx.Build(pctx, BuildParams{
 		Rule:   Touch,
 		Output: PathForModuleOut(ctx, "output"),
 	})

 	m.missingDeps = ctx.GetMissingDependencies()
 }

 func (m *mutatorTestModule) DepsMutator(ctx BottomUpMutatorContext) {
 	ctx.AddDependency(ctx.Module(), nil, m.props.Deps_missing_deps...)
 }

 func addMissingDependenciesMutator(ctx TopDownMutatorContext) {
 	ctx.AddMissingDependencies(ctx.Module().(*mutatorTestModule).props.Mutator_missing_deps)
 }

 func TestMutatorAddMissingDependencies(t *testing.T) {
 	bp := `
 		test {
 			name: "foo",
 			deps_missing_deps: ["regular_missing_dep"],
 			mutator_missing_deps: ["added_missing_dep"],
 		}
 	`

 	config := TestConfig(buildDir, nil, bp, nil)
 	config.TestProductVariables.Allow_missing_dependencies = proptools.BoolPtr(true)

 	ctx := NewTestContext(config)
 	ctx.SetAllowMissingDependencies(true)

 	ctx.RegisterModuleType("test", mutatorTestModuleFactory)
 	ctx.PreDepsMutators(func(ctx RegisterMutatorsContext) {
 		ctx.TopDown("add_missing_dependencies", addMissingDependenciesMutator)
 	})

 	ctx.Register()
 	_, errs := ctx.ParseFileList(".", []string{"Android.bp"})
 	FailIfErrored(t, errs)
 	_, errs = ctx.PrepareBuildActions(config)
 	FailIfErrored(t, errs)

 	foo := ctx.ModuleForTests("foo", "").Module().(*mutatorTestModule)

 	if g, w := foo.missingDeps, []string{"added_missing_dep", "regular_missing_dep"}; !reflect.DeepEqual(g, w) {
 		t.Errorf("want foo missing deps %q, got %q", w, g)
 	}
 }

 func TestModuleString(t *testing.T) {
 	bp := `
 		test {
 			name: "foo",
 		}
 	`

 	config := TestConfig(buildDir, nil, bp, nil)

 	ctx := NewTestContext(config)

 	var moduleStrings []string

 	ctx.PreArchMutators(func(ctx RegisterMutatorsContext) {
 		ctx.BottomUp("pre_arch", func(ctx BottomUpMutatorContext) {
 			moduleStrings = append(moduleStrings, ctx.Module().String())
 			ctx.CreateVariations("a", "b")
 		})
 		ctx.TopDown("rename_top_down", func(ctx TopDownMutatorContext) {
 			moduleStrings = append(moduleStrings, ctx.Module().String())
 			ctx.Rename(ctx.Module().base().Name() + "_renamed1")
 		})
 	})

 	ctx.PreDepsMutators(func(ctx RegisterMutatorsContext) {
 		ctx.BottomUp("pre_deps", func(ctx BottomUpMutatorContext) {
 			moduleStrings = append(moduleStrings, ctx.Module().String())
 			ctx.CreateVariations("c", "d")
 		})
 	})

 	ctx.PostDepsMutators(func(ctx RegisterMutatorsContext) {
 		ctx.BottomUp("post_deps", func(ctx BottomUpMutatorContext) {
 			moduleStrings = append(moduleStrings, ctx.Module().String())
 			ctx.CreateLocalVariations("e", "f")
 		})
 		ctx.BottomUp("rename_bottom_up", func(ctx BottomUpMutatorContext) {
 			moduleStrings = append(moduleStrings, ctx.Module().String())
 			ctx.Rename(ctx.Module().base().Name() + "_renamed2")
 		})
 		ctx.BottomUp("final", func(ctx BottomUpMutatorContext) {
 			moduleStrings = append(moduleStrings, ctx.Module().String())
 		})
 	})

 	ctx.RegisterModuleType("test", mutatorTestModuleFactory)

 	ctx.Register()

 	_, errs := ctx.ParseFileList(".", []string{"Android.bp"})
 	FailIfErrored(t, errs)
 	_, errs = ctx.PrepareBuildActions(config)
 	FailIfErrored(t, errs)

 	want := []string{
 		// Initial name.
 		"foo{}",

 		// After pre_arch (reversed because rename_top_down is TopDown so it visits in reverse order).
 		"foo{pre_arch:b}",
 		"foo{pre_arch:a}",

 		// After rename_top_down.
 		"foo_renamed1{pre_arch:a}",
 		"foo_renamed1{pre_arch:b}",

 		// After pre_deps.
 		"foo_renamed1{pre_arch:a,pre_deps:c}",
 		"foo_renamed1{pre_arch:a,pre_deps:d}",
 		"foo_renamed1{pre_arch:b,pre_deps:c}",
 		"foo_renamed1{pre_arch:b,pre_deps:d}",

 		// After post_deps.
 		"foo_renamed1{pre_arch:a,pre_deps:c,post_deps:e}",
 		"foo_renamed1{pre_arch:a,pre_deps:c,post_deps:f}",
 		"foo_renamed1{pre_arch:a,pre_deps:d,post_deps:e}",
 		"foo_renamed1{pre_arch:a,pre_deps:d,post_deps:f}",
 		"foo_renamed1{pre_arch:b,pre_deps:c,post_deps:e}",
 		"foo_renamed1{pre_arch:b,pre_deps:c,post_deps:f}",
 		"foo_renamed1{pre_arch:b,pre_deps:d,post_deps:e}",
 		"foo_renamed1{pre_arch:b,pre_deps:d,post_deps:f}",

 		// After rename_bottom_up.
 		"foo_renamed2{pre_arch:a,pre_deps:c,post_deps:e}",
 		"foo_renamed2{pre_arch:a,pre_deps:c,post_deps:f}",
 		"foo_renamed2{pre_arch:a,pre_deps:d,post_deps:e}",
 		"foo_renamed2{pre_arch:a,pre_deps:d,post_deps:f}",
 		"foo_renamed2{pre_arch:b,pre_deps:c,post_deps:e}",
 		"foo_renamed2{pre_arch:b,pre_deps:c,post_deps:f}",
 		"foo_renamed2{pre_arch:b,pre_deps:d,post_deps:e}",
 		"foo_renamed2{pre_arch:b,pre_deps:d,post_deps:f}",
 	}

 	if !reflect.DeepEqual(moduleStrings, want) {
 		t.Errorf("want module String() values:\n%q\ngot:\n%q", want, moduleStrings)
 	}
 }

 func TestFinalDepsPhase(t *testing.T) {
 	bp := `
 		test {
 			name: "common_dep_1",
 		}
 		test {
 			name: "common_dep_2",
 		}
 		test {
 			name: "foo",
 		}
 	`

 	config := TestConfig(buildDir, nil, bp, nil)

 	ctx := NewTestContext(config)

 	finalGot := map[string]int{}

 	dep1Tag := struct {
 		blueprint.BaseDependencyTag
 	}{}
 	dep2Tag := struct {
 		blueprint.BaseDependencyTag
 	}{}

 	ctx.PostDepsMutators(func(ctx RegisterMutatorsContext) {
 		ctx.BottomUp("far_deps_1", func(ctx BottomUpMutatorContext) {
 			if !strings.HasPrefix(ctx.ModuleName(), "common_dep") {
 				ctx.AddFarVariationDependencies([]blueprint.Variation{}, dep1Tag, "common_dep_1")
 			}
 		})
 		ctx.BottomUp("variant", func(ctx BottomUpMutatorContext) {
 			ctx.CreateLocalVariations("a", "b")
 		})
 	})

 	ctx.FinalDepsMutators(func(ctx RegisterMutatorsContext) {
 		ctx.BottomUp("far_deps_2", func(ctx BottomUpMutatorContext) {
 			if !strings.HasPrefix(ctx.ModuleName(), "common_dep") {
 				ctx.AddFarVariationDependencies([]blueprint.Variation{}, dep2Tag, "common_dep_2")
 			}
 		})
 		ctx.BottomUp("final", func(ctx BottomUpMutatorContext) {
 			finalGot[ctx.Module().String()] += 1
 			ctx.VisitDirectDeps(func(mod Module) {
 				finalGot[fmt.Sprintf("%s -> %s", ctx.Module().String(), mod)] += 1
 			})
 		})
 	})

 	ctx.RegisterModuleType("test", mutatorTestModuleFactory)

 	ctx.Register()

 	_, errs := ctx.ParseFileList(".", []string{"Android.bp"})
 	FailIfErrored(t, errs)
 	_, errs = ctx.PrepareBuildActions(config)
 	FailIfErrored(t, errs)

 	finalWant := map[string]int{
 		"common_dep_1{variant:a}":                   1,
 		"common_dep_1{variant:b}":                   1,
 		"common_dep_2{variant:a}":                   1,
 		"common_dep_2{variant:b}":                   1,
 		"foo{variant:a}":                            1,
 		"foo{variant:a} -> common_dep_1{variant:a}": 1,
 		"foo{variant:a} -> common_dep_2{variant:a}": 1,
 		"foo{variant:b}":                            1,
 		"foo{variant:b} -> common_dep_1{variant:b}": 1,
 		"foo{variant:b} -> common_dep_2{variant:a}": 1,
 	}

 	if !reflect.DeepEqual(finalWant, finalGot) {
 		t.Errorf("want:\n%q\ngot:\n%q", finalWant, finalGot)
 	}
 }

 func TestNoCreateVariationsInFinalDeps(t *testing.T) {
 	config := TestConfig(buildDir, nil, `test {name: "foo"}`, nil)
 	ctx := NewTestContext(config)

 	checkErr := func() {
 		if err := recover(); err == nil || !strings.Contains(fmt.Sprintf("%s", err), "not allowed in FinalDepsMutators") {
 			panic("Expected FinalDepsMutators consistency check to fail")
 		}
 	}

 	ctx.FinalDepsMutators(func(ctx RegisterMutatorsContext) {
 		ctx.BottomUp("vars", func(ctx BottomUpMutatorContext) {
 			defer checkErr()
 			ctx.CreateVariations("a", "b")
 		})
 		ctx.BottomUp("local_vars", func(ctx BottomUpMutatorContext) {
 			defer checkErr()
 			ctx.CreateLocalVariations("a", "b")
 		})
 	})

 	ctx.RegisterModuleType("test", mutatorTestModuleFactory)
 	ctx.Register()

 	_, errs := ctx.ParseFileList(".", []string{"Android.bp"})
 	FailIfErrored(t, errs)
 	_, errs = ctx.PrepareBuildActions(config)
 	FailIfErrored(t, errs)
 }
	// Copyright 2015 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.

	package android

	import (
	"fmt"
	"reflect"
	"strings"
	"testing"

	"github.com/google/blueprint"
	"github.com/google/blueprint/proptools"
	)

	type mutatorTestModule struct {
	ModuleBase
	props struct {
	Deps_missing_deps []string
	Mutator_missing_deps []string
	}

	missingDeps []string
	}

	func mutatorTestModuleFactory() Module {
	module := &mutatorTestModule{}
	module.AddProperties(&module.props)
	InitAndroidModule(module)
	return module
	}

	func (m *mutatorTestModule) GenerateAndroidBuildActions(ctx ModuleContext) {
	ctx.Build(pctx, BuildParams{
	Rule: Touch,
	Output: PathForModuleOut(ctx, "output"),
	})

	m.missingDeps = ctx.GetMissingDependencies()
	}

	func (m *mutatorTestModule) DepsMutator(ctx BottomUpMutatorContext) {
	ctx.AddDependency(ctx.Module(), nil, m.props.Deps_missing_deps...)
	}

	func addMissingDependenciesMutator(ctx TopDownMutatorContext) {
	ctx.AddMissingDependencies(ctx.Module().(*mutatorTestModule).props.Mutator_missing_deps)
	}

	func TestMutatorAddMissingDependencies(t *testing.T) {
	bp := `
	test {
	name: "foo",
	deps_missing_deps: ["regular_missing_dep"],
	mutator_missing_deps: ["added_missing_dep"],
	}
	`

	config := TestConfig(buildDir, nil, bp, nil)
	config.TestProductVariables.Allow_missing_dependencies = proptools.BoolPtr(true)

	ctx := NewTestContext(config)
	ctx.SetAllowMissingDependencies(true)

	ctx.RegisterModuleType("test", mutatorTestModuleFactory)
	ctx.PreDepsMutators(func(ctx RegisterMutatorsContext) {
	ctx.TopDown("add_missing_dependencies", addMissingDependenciesMutator)
	})

	ctx.Register()
	_, errs := ctx.ParseFileList(".", []string{"Android.bp"})
	FailIfErrored(t, errs)
	_, errs = ctx.PrepareBuildActions(config)
	FailIfErrored(t, errs)

	foo := ctx.ModuleForTests("foo", "").Module().(*mutatorTestModule)

	if g, w := foo.missingDeps, []string{"added_missing_dep", "regular_missing_dep"}; !reflect.DeepEqual(g, w) {
	t.Errorf("want foo missing deps %q, got %q", w, g)
	}
	}

	func TestModuleString(t *testing.T) {
	bp := `
	test {
	name: "foo",
	}
	`

	config := TestConfig(buildDir, nil, bp, nil)

	ctx := NewTestContext(config)

	var moduleStrings []string

	ctx.PreArchMutators(func(ctx RegisterMutatorsContext) {
	ctx.BottomUp("pre_arch", func(ctx BottomUpMutatorContext) {
	moduleStrings = append(moduleStrings, ctx.Module().String())
	ctx.CreateVariations("a", "b")
	})
	ctx.TopDown("rename_top_down", func(ctx TopDownMutatorContext) {
	moduleStrings = append(moduleStrings, ctx.Module().String())
	ctx.Rename(ctx.Module().base().Name() + "_renamed1")
	})
	})

	ctx.PreDepsMutators(func(ctx RegisterMutatorsContext) {
	ctx.BottomUp("pre_deps", func(ctx BottomUpMutatorContext) {
	moduleStrings = append(moduleStrings, ctx.Module().String())
	ctx.CreateVariations("c", "d")
	})
	})

	ctx.PostDepsMutators(func(ctx RegisterMutatorsContext) {
	ctx.BottomUp("post_deps", func(ctx BottomUpMutatorContext) {
	moduleStrings = append(moduleStrings, ctx.Module().String())
	ctx.CreateLocalVariations("e", "f")
	})
	ctx.BottomUp("rename_bottom_up", func(ctx BottomUpMutatorContext) {
	moduleStrings = append(moduleStrings, ctx.Module().String())
	ctx.Rename(ctx.Module().base().Name() + "_renamed2")
	})
	ctx.BottomUp("final", func(ctx BottomUpMutatorContext) {
	moduleStrings = append(moduleStrings, ctx.Module().String())
	})
	})

	ctx.RegisterModuleType("test", mutatorTestModuleFactory)

	ctx.Register()

	_, errs := ctx.ParseFileList(".", []string{"Android.bp"})
	FailIfErrored(t, errs)
	_, errs = ctx.PrepareBuildActions(config)
	FailIfErrored(t, errs)

	want := []string{
	// Initial name.
	"foo{}",

	// After pre_arch (reversed because rename_top_down is TopDown so it visits in reverse order).
	"foo{pre_arch:b}",
	"foo{pre_arch:a}",

	// After rename_top_down.
	"foo_renamed1{pre_arch:a}",
	"foo_renamed1{pre_arch:b}",

	// After pre_deps.
	"foo_renamed1{pre_arch:a,pre_deps:c}",
	"foo_renamed1{pre_arch:a,pre_deps:d}",
	"foo_renamed1{pre_arch:b,pre_deps:c}",
	"foo_renamed1{pre_arch:b,pre_deps:d}",

	// After post_deps.
	"foo_renamed1{pre_arch:a,pre_deps:c,post_deps:e}",
	"foo_renamed1{pre_arch:a,pre_deps:c,post_deps:f}",
	"foo_renamed1{pre_arch:a,pre_deps:d,post_deps:e}",
	"foo_renamed1{pre_arch:a,pre_deps:d,post_deps:f}",
	"foo_renamed1{pre_arch:b,pre_deps:c,post_deps:e}",
	"foo_renamed1{pre_arch:b,pre_deps:c,post_deps:f}",
	"foo_renamed1{pre_arch:b,pre_deps:d,post_deps:e}",
	"foo_renamed1{pre_arch:b,pre_deps:d,post_deps:f}",

	// After rename_bottom_up.
	"foo_renamed2{pre_arch:a,pre_deps:c,post_deps:e}",
	"foo_renamed2{pre_arch:a,pre_deps:c,post_deps:f}",
	"foo_renamed2{pre_arch:a,pre_deps:d,post_deps:e}",
	"foo_renamed2{pre_arch:a,pre_deps:d,post_deps:f}",
	"foo_renamed2{pre_arch:b,pre_deps:c,post_deps:e}",
	"foo_renamed2{pre_arch:b,pre_deps:c,post_deps:f}",
	"foo_renamed2{pre_arch:b,pre_deps:d,post_deps:e}",
	"foo_renamed2{pre_arch:b,pre_deps:d,post_deps:f}",
	}

	if !reflect.DeepEqual(moduleStrings, want) {
	t.Errorf("want module String() values:\n%q\ngot:\n%q", want, moduleStrings)
	}
	}

	func TestFinalDepsPhase(t *testing.T) {
	bp := `
	test {
	name: "common_dep_1",
	}
	test {
	name: "common_dep_2",
	}
	test {
	name: "foo",
	}
	`

	config := TestConfig(buildDir, nil, bp, nil)

	ctx := NewTestContext(config)

	finalGot := map[string]int{}

	dep1Tag := struct {
	blueprint.BaseDependencyTag
	}{}
	dep2Tag := struct {
	blueprint.BaseDependencyTag
	}{}

	ctx.PostDepsMutators(func(ctx RegisterMutatorsContext) {
	ctx.BottomUp("far_deps_1", func(ctx BottomUpMutatorContext) {
	if !strings.HasPrefix(ctx.ModuleName(), "common_dep") {
	ctx.AddFarVariationDependencies([]blueprint.Variation{}, dep1Tag, "common_dep_1")
	}
	})
	ctx.BottomUp("variant", func(ctx BottomUpMutatorContext) {
	ctx.CreateLocalVariations("a", "b")
	})
	})

	ctx.FinalDepsMutators(func(ctx RegisterMutatorsContext) {
	ctx.BottomUp("far_deps_2", func(ctx BottomUpMutatorContext) {
	if !strings.HasPrefix(ctx.ModuleName(), "common_dep") {
	ctx.AddFarVariationDependencies([]blueprint.Variation{}, dep2Tag, "common_dep_2")
	}
	})
	ctx.BottomUp("final", func(ctx BottomUpMutatorContext) {
	finalGot[ctx.Module().String()] += 1
	ctx.VisitDirectDeps(func(mod Module) {
	finalGot[fmt.Sprintf("%s -> %s", ctx.Module().String(), mod)] += 1
	})
	})
	})

	ctx.RegisterModuleType("test", mutatorTestModuleFactory)

	ctx.Register()

	_, errs := ctx.ParseFileList(".", []string{"Android.bp"})
	FailIfErrored(t, errs)
	_, errs = ctx.PrepareBuildActions(config)
	FailIfErrored(t, errs)

	finalWant := map[string]int{
	"common_dep_1{variant:a}": 1,
	"common_dep_1{variant:b}": 1,
	"common_dep_2{variant:a}": 1,
	"common_dep_2{variant:b}": 1,
	"foo{variant:a}": 1,
	"foo{variant:a} -> common_dep_1{variant:a}": 1,
	"foo{variant:a} -> common_dep_2{variant:a}": 1,
	"foo{variant:b}": 1,
	"foo{variant:b} -> common_dep_1{variant:b}": 1,
	"foo{variant:b} -> common_dep_2{variant:a}": 1,
	}

	if !reflect.DeepEqual(finalWant, finalGot) {
	t.Errorf("want:\n%q\ngot:\n%q", finalWant, finalGot)
	}
	}

	func TestNoCreateVariationsInFinalDeps(t *testing.T) {
	config := TestConfig(buildDir, nil, `test {name: "foo"}`, nil)
	ctx := NewTestContext(config)

	checkErr := func() {
	if err := recover(); err == nil \|\| !strings.Contains(fmt.Sprintf("%s", err), "not allowed in FinalDepsMutators") {
	panic("Expected FinalDepsMutators consistency check to fail")
	}
	}

	ctx.FinalDepsMutators(func(ctx RegisterMutatorsContext) {
	ctx.BottomUp("vars", func(ctx BottomUpMutatorContext) {
	defer checkErr()
	ctx.CreateVariations("a", "b")
	})
	ctx.BottomUp("local_vars", func(ctx BottomUpMutatorContext) {
	defer checkErr()
	ctx.CreateLocalVariations("a", "b")
	})
	})

	ctx.RegisterModuleType("test", mutatorTestModuleFactory)
	ctx.Register()

	_, errs := ctx.ParseFileList(".", []string{"Android.bp"})
	FailIfErrored(t, errs)
	_, errs = ctx.PrepareBuildActions(config)
	FailIfErrored(t, errs)
	}