Track allowed transitive deps in any updatable module. (4e1f2bd0) · Commits · e / os / android_build_soong

android/apex.go

+3 −3

Original line number	Diff line number	Diff line
		@@ -581,7 +581,7 @@ func (d *ApexBundleDepsInfo) BuildDepsInfoLists(ctx ModuleContext, minSdkVersion
		var fullContent strings.Builder
		var flatContent strings.Builder

		fmt.Fprintf(&flatContent, "%s(minSdkVersion:%s):\\n", ctx.ModuleName(), minSdkVersion)
		fmt.Fprintf(&fullContent, "%s(minSdkVersion:%s):\\n", ctx.ModuleName(), minSdkVersion)
		for _, key := range FirstUniqueStrings(SortedStringKeys(depInfos)) {
		info := depInfos[key]
		toName := fmt.Sprintf("%s(minSdkVersion:%s)", info.To, info.MinSdkVersion)

apex/OWNERS

+4 −1

Original line number	Diff line number	Diff line
		per-file * = jiyong@google.com

		per-file allowed_deps.txt = set noparent
		per-file allowed_deps.txt = dariofreni@google.com,hansson@google.com,harpin@google.com,jiyong@google.com,narayan@google.com,omakoto@google.com,jham@google.com

apex/allowed_deps.txt

0 → 100644

+521 −0

File added.

Preview size limit exceeded, changes collapsed.

apex/apex_singleton.go

+57 −17

Original line number	Diff line number	Diff line
		@@ -17,9 +17,9 @@
		package apex

		import (
		"github.com/google/blueprint"

		"android/soong/android"

		"github.com/google/blueprint"
		)

		func init() {
		@@ -27,39 +27,79 @@ func init() {
		}

		type apexDepsInfoSingleton struct {
		// Output file with all flatlists from updatable modules' deps-info combined
		updatableFlatListsPath android.OutputPath
		allowedApexDepsInfoCheckResult android.OutputPath
		}

		func apexDepsInfoSingletonFactory() android.Singleton {
		return &apexDepsInfoSingleton{}
		}

		var combineFilesRule = pctx.AndroidStaticRule("combineFilesRule",
		blueprint.RuleParams{
		Command: "cat $out.rsp \| xargs cat > $out",
		var (
		// Generate new apex allowed_deps.txt by merging all internal dependencies.
		generateApexDepsInfoFilesRule = pctx.AndroidStaticRule("generateApexDepsInfoFilesRule", blueprint.RuleParams{
		Command: "cat $out.rsp \| xargs cat" +
		// Only track non-external dependencies, i.e. those that end up in the binary
		" \| grep -v '(external)'" +
		// Ignore comments in any of the files
		" \| grep -v '^#'" +
		" \| sort -u -f >$out",
		Rspfile: "$out.rsp",
		RspfileContent: "$in",
		},
		})

		// Diff two given lists while ignoring comments in the allowed deps file.
		diffAllowedApexDepsInfoRule = pctx.AndroidStaticRule("diffAllowedApexDepsInfoRule", blueprint.RuleParams{
		Description: "Diff ${allowed_deps} and ${new_allowed_deps}",
		Command: `
		if grep -v '^#' ${allowed_deps} \| diff -B - ${new_allowed_deps}; then
		touch ${out};
		else
		echo -e "\n******************************";
		echo "ERROR: go/apex-allowed-deps-error";
		echo "******************************";
		echo "Detected changes to allowed dependencies in updatable modules.";
		echo "To fix and update build/soong/apex/allowed_deps.txt, please run:";
		echo "$$ (croot && build/soong/scripts/update-apex-allowed-deps.sh)";
		echo "Members of mainline-modularization@google.com will review the changes.";
		echo -e "******************************\n";
		exit 1;
		fi;
		`,
		}, "allowed_deps", "new_allowed_deps")
		)

		func (s *apexDepsInfoSingleton) GenerateBuildActions(ctx android.SingletonContext) {
		updatableFlatLists := android.Paths{}
		ctx.VisitAllModules(func(module android.Module) {
		if binaryInfo, ok := module.(android.ApexBundleDepsInfoIntf); ok {
		if path := binaryInfo.FlatListPath(); path != nil {
		if binaryInfo.Updatable() {
		if path := binaryInfo.FlatListPath(); path != nil && binaryInfo.Updatable() {
		updatableFlatLists = append(updatableFlatLists, path)
		}
		}
		}
		})

		s.updatableFlatListsPath = android.PathForOutput(ctx, "apex", "depsinfo", "updatable-flatlists.txt")
		allowedDeps := android.ExistentPathForSource(ctx, "build/soong/apex/allowed_deps.txt").Path()

		newAllowedDeps := android.PathForOutput(ctx, "apex", "depsinfo", "new-allowed-deps.txt")
		ctx.Build(pctx, android.BuildParams{
		Rule: combineFilesRule,
		Description: "Generate " + s.updatableFlatListsPath.String(),
		Inputs: updatableFlatLists,
		Output: s.updatableFlatListsPath,
		Rule: generateApexDepsInfoFilesRule,
		Inputs: append(updatableFlatLists, allowedDeps),
		Output: newAllowedDeps,
		})

		s.allowedApexDepsInfoCheckResult = android.PathForOutput(ctx, newAllowedDeps.Rel()+".check")
		ctx.Build(pctx, android.BuildParams{
		Rule: diffAllowedApexDepsInfoRule,
		Input: newAllowedDeps,
		Output: s.allowedApexDepsInfoCheckResult,
		Args: map[string]string{
		"allowed_deps": allowedDeps.String(),
		"new_allowed_deps": newAllowedDeps.String(),
		},
		})
		}

		func (s *apexDepsInfoSingleton) MakeVars(ctx android.MakeVarsContext) {
		// Export check result to Make. The path is added to droidcore.
		ctx.Strict("APEX_ALLOWED_DEPS_CHECK", s.allowedApexDepsInfoCheckResult.String())
		}

scripts/update-apex-allowed-deps.sh

0 → 100755

+39 −0

Original line number	Diff line number	Diff line
		#!/bin/bash -e
		#
		# The script to run locally to re-generate global allowed list of dependencies
		# for updatable modules.

		if [ ! -e "build/envsetup.sh" ]; then
		echo "ERROR: $0 must be run from the top of the tree"
		exit 1
		fi

		source build/envsetup.sh > /dev/null \|\| exit 1

		readonly OUT_DIR=$(get_build_var OUT_DIR)

		readonly ALLOWED_DEPS_FILE="build/soong/apex/allowed_deps.txt"
		readonly NEW_ALLOWED_DEPS_FILE="${OUT_DIR}/soong/apex/depsinfo/new-allowed-deps.txt"

		# If the script is run after droidcore failure, ${NEW_ALLOWED_DEPS_FILE}
		# should already be built. If running the script manually, make sure it exists.
		m "${NEW_ALLOWED_DEPS_FILE}" -j

		cat > "${ALLOWED_DEPS_FILE}" << EndOfFileComment
		# A list of allowed dependencies for all updatable modules.
		#
		# The list tracks all direct and transitive dependencies that end up within any
		# of the updatable binaries; specifically excluding external dependencies
		# required to compile those binaries. This prevents potential regressions in
		# case a new dependency is not aware of the different functional and
		# non-functional requirements being part of an updatable module, for example
		# setting correct min_sdk_version.
		#
		# To update the list, run:
		# repo-root$ build/soong/scripts/update-apex-allowed-deps.sh
		#
		# See go/apex-allowed-deps-error for more details.
		# TODO(b/157465465): introduce automated quality signals and remove this list.
		EndOfFileComment

		cat "${NEW_ALLOWED_DEPS_FILE}" >> "${ALLOWED_DEPS_FILE}"

apex/apex_test.go

+16 −16

File changed.

Contains only whitespace changes.