aconfig/codegen/cc_aconfig_library_test.go

// Copyright 2023 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 codegen

import (
	"fmt"
	"testing"

	"android/soong/android"
	"android/soong/cc"

	"github.com/google/blueprint"
)

var ccCodegenModeTestData = []struct {
	setting, expected string
}{
	{"", "production"},
	{"mode: `production`,", "production"},
	{"mode: `test`,", "test"},
	{"mode: `exported`,", "exported"},
	{"mode: `force-read-only`,", "force-read-only"},
}

func TestCCCodegenMode(t *testing.T) {
	for _, testData := range ccCodegenModeTestData {
		testCCCodegenModeHelper(t, testData.setting, testData.expected)
	}
}

func testCCCodegenModeHelper(t *testing.T, bpMode string, ruleMode string) {
	t.Helper()
	result := android.GroupFixturePreparers(
		PrepareForTestWithAconfigBuildComponents,
		cc.PrepareForTestWithCcDefaultModules).
		ExtendWithErrorHandler(android.FixtureExpectsNoErrors).
		RunTestWithBp(t, fmt.Sprintf(`
			aconfig_declarations {
				name: "my_aconfig_declarations",
				package: "com.example.package",
				container: "com.android.foo",
				srcs: ["foo.aconfig"],
			}

			cc_library {
    		name: "server_configurable_flags",
    		srcs: ["server_configurable_flags.cc"],
			}

			cc_library {
    		name: "libbase",
    		srcs: ["libbase.cc"],
			}

			cc_library {
    		name: "liblog",
    		srcs: ["liblog.cc"],
			}

			cc_library {
    		name: "libaconfig_storage_read_api_cc",
    		srcs: ["libaconfig_storage_read_api_cc.cc"],
			}

			cc_aconfig_library {
				name: "my_cc_aconfig_library",
				aconfig_declarations: "my_aconfig_declarations",
				%s
			}
		`, bpMode))

	module := result.ModuleForTests("my_cc_aconfig_library", "android_arm64_armv8-a_shared")
	rule := module.Rule("cc_aconfig_library")
	android.AssertStringEquals(t, "rule must contain test mode", rule.Args["mode"], ruleMode)
}

var incorrectCCCodegenModeTestData = []struct {
	setting, expectedErr string
}{
	{"mode: `unsupported`,", "mode: \"unsupported\" is not a supported mode"},
}

func TestIncorrectCCCodegenMode(t *testing.T) {
	for _, testData := range incorrectCCCodegenModeTestData {
		testIncorrectCCCodegenModeHelper(t, testData.setting, testData.expectedErr)
	}
}

func testIncorrectCCCodegenModeHelper(t *testing.T, bpMode string, err string) {
	t.Helper()
	android.GroupFixturePreparers(
		PrepareForTestWithAconfigBuildComponents,
		cc.PrepareForTestWithCcDefaultModules).
		ExtendWithErrorHandler(android.FixtureExpectsOneErrorPattern(err)).
		RunTestWithBp(t, fmt.Sprintf(`
			aconfig_declarations {
				name: "my_aconfig_declarations",
				package: "com.example.package",
				container: "com.android.foo",
				srcs: ["foo.aconfig"],
			}

			cc_library {
    		name: "server_configurable_flags",
    		srcs: ["server_configurable_flags.cc"],
			}

			cc_library {
    		name: "libbase",
    		srcs: ["libbase.cc"],
			}

			cc_library {
    		name: "liblog",
    		srcs: ["liblog.cc"],
			}

			cc_library {
    		name: "libaconfig_storage_read_api_cc",
    		srcs: ["libaconfig_storage_read_api_cc.cc"],
			}

			cc_aconfig_library {
				name: "my_cc_aconfig_library",
				aconfig_declarations: "my_aconfig_declarations",
				%s
			}
		`, bpMode))
}

func TestAndroidMkCcLibrary(t *testing.T) {
	bp := `
		aconfig_declarations {
			name: "my_aconfig_declarations_foo",
			package: "com.example.package",
			srcs: ["foo.aconfig"],
			container: "vendor",
		}

		cc_aconfig_library {
			name: "my_cc_aconfig_library_foo",
			aconfig_declarations: "my_aconfig_declarations_foo",
			vendor_available: true,
		}

		aconfig_declarations {
			name: "my_aconfig_declarations_bar",
			package: "com.example.package",
			container: "com.android.foo",
			srcs: ["bar.aconfig"],
		}

		cc_aconfig_library {
			name: "my_cc_aconfig_library_bar",
			aconfig_declarations: "my_aconfig_declarations_bar",
			vendor_available: true,
		}

		cc_library {
			name: "my_cc_library",
			srcs: [
				"src/foo.cc",
			],
			static_libs: [
				"my_cc_aconfig_library_foo",
				"my_cc_aconfig_library_bar",
			],
			vendor: true,
		}

		cc_library {
			name: "server_configurable_flags",
			srcs: ["server_configurable_flags.cc"],
			vendor_available: true,
		}

		cc_library {
			name: "libbase",
			srcs: ["libbase.cc"],
			vendor_available: true,
		}

		cc_library {
			name: "liblog",
			srcs: ["liblog.cc"],
			vendor_available: true,
		}

		cc_library {
			name: "libaconfig_storage_read_api_cc",
			srcs: ["libaconfig_storage_read_api_cc.cc"],
			vendor_available: true,
		}
	`
	result := android.GroupFixturePreparers(
		PrepareForTestWithAconfigBuildComponents,
		cc.PrepareForTestWithCcDefaultModules).
		ExtendWithErrorHandler(android.FixtureExpectsNoErrors).RunTestWithBp(t, bp)

	module := result.ModuleForTests("my_cc_library", "android_vendor_arm64_armv8-a_shared").Module()

	entry := android.AndroidMkEntriesForTest(t, result.TestContext, module)[0]

	makeVar := entry.EntryMap["LOCAL_ACONFIG_FILES"]
	android.EnsureListContainsSuffix(t, makeVar, "my_aconfig_declarations_foo/intermediate.pb")
}

func TestForceReadOnly(t *testing.T) {
	t.Helper()
	result := android.GroupFixturePreparers(
		PrepareForTestWithAconfigBuildComponents,
		cc.PrepareForTestWithCcDefaultModules).
		ExtendWithErrorHandler(android.FixtureExpectsNoErrors).
		RunTestWithBp(t, fmt.Sprintf(`
			aconfig_declarations {
				name: "my_aconfig_declarations",
				package: "com.example.package",
				container: "com.android.foo",
				srcs: ["foo.aconfig"],
			}

			cc_aconfig_library {
				name: "my_cc_aconfig_library",
				aconfig_declarations: "my_aconfig_declarations",
				mode: "force-read-only",
			}


			cc_library {
    		                name: "libbase",
    		                srcs: ["libbase.cc"],
			}

			cc_library {
    		                name: "liblog",
    		                srcs: ["liblog.cc"],
			}

			cc_library {
    		                name: "libaconfig_storage_read_api_cc",
    		                srcs: ["libaconfig_storage_read_api_cc.cc"],
			}
		`))

	module := result.ModuleForTests("my_cc_aconfig_library", "android_arm64_armv8-a_shared").Module()
	dependOnBaseLib := false
	result.VisitDirectDeps(module, func(dep blueprint.Module) {
		if dep.Name() == baseLibDep {
			dependOnBaseLib = true
		}
	})
	android.AssertBoolEquals(t, "should not have dependency on server_configuriable_flags",
		dependOnBaseLib, false)
}