Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 3c312668 authored by Treehugger Robot's avatar Treehugger Robot Committed by Gerrit Code Review
Browse files

Merge "Remove makefile_goal"

parents 444b7ff1 a2b57abb
Loading
Loading
Loading
Loading
+0 −1
Original line number Diff line number Diff line
@@ -60,7 +60,6 @@ bootstrap_go_package {
        "license_metadata.go",
        "license_sdk_member.go",
        "licenses.go",
        "makefile_goal.go",
        "makevars.go",
        "metrics.go",
        "module.go",

android/makefile_goal.go

deleted100644 → 0
+0 −98
Original line number Diff line number Diff line
// Copyright 2020 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"
	"io"
	"path/filepath"

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

func init() {
	RegisterModuleType("makefile_goal", MakefileGoalFactory)
}

type makefileGoalProperties struct {
	// Sources.

	// Makefile goal output file path, relative to PRODUCT_OUT.
	Product_out_path *string
}

type makefileGoal struct {
	ModuleBase

	properties makefileGoalProperties

	// Destination. Output file path of this module.
	outputFilePath OutputPath
}

var _ AndroidMkEntriesProvider = (*makefileGoal)(nil)
var _ OutputFileProducer = (*makefileGoal)(nil)

// Input file of this makefile_goal module. Nil if none specified. May use variable names in makefiles.
func (p *makefileGoal) inputPath() *string {
	if p.properties.Product_out_path != nil {
		return proptools.StringPtr(filepath.Join("$(PRODUCT_OUT)", proptools.String(p.properties.Product_out_path)))
	}
	return nil
}

// OutputFileProducer
func (p *makefileGoal) OutputFiles(tag string) (Paths, error) {
	if tag != "" {
		return nil, fmt.Errorf("unsupported tag %q", tag)
	}
	return Paths{p.outputFilePath}, nil
}

// AndroidMkEntriesProvider
func (p *makefileGoal) DepsMutator(ctx BottomUpMutatorContext) {
	if p.inputPath() == nil {
		ctx.PropertyErrorf("product_out_path", "Path relative to PRODUCT_OUT required")
	}
}

func (p *makefileGoal) GenerateAndroidBuildActions(ctx ModuleContext) {
	filename := filepath.Base(proptools.String(p.inputPath()))
	p.outputFilePath = PathForModuleOut(ctx, filename).OutputPath

	ctx.InstallFile(PathForModuleInstall(ctx, "etc"), ctx.ModuleName(), p.outputFilePath)
}

func (p *makefileGoal) AndroidMkEntries() []AndroidMkEntries {
	return []AndroidMkEntries{AndroidMkEntries{
		Class:      "ETC",
		OutputFile: OptionalPathForPath(p.outputFilePath),
		ExtraFooters: []AndroidMkExtraFootersFunc{
			func(w io.Writer, name, prefix, moduleDir string) {
				// Can't use Cp because inputPath() is not a valid Path.
				fmt.Fprintf(w, "$(eval $(call copy-one-file,%s,%s))\n", proptools.String(p.inputPath()), p.outputFilePath)
			},
		},
	}}
}

// Import a Makefile goal to Soong by copying the file built by
// the goal to a path visible to Soong. This rule only works on boot images.
func MakefileGoalFactory() Module {
	module := &makefileGoal{}
	module.AddProperties(&module.properties)
	InitAndroidModule(module)
	return module
}
+0 −15
Original line number Diff line number Diff line
@@ -55,7 +55,6 @@ func init() {
	AddNeverAllowRules(createJavaDeviceForHostRules()...)
	AddNeverAllowRules(createCcSdkVariantRules()...)
	AddNeverAllowRules(createUncompressDexRules()...)
	AddNeverAllowRules(createMakefileGoalRules()...)
	AddNeverAllowRules(createInitFirstStageRules()...)
	AddNeverAllowRules(createProhibitFrameworkAccessRules()...)
	AddNeverAllowRules(createBp2BuildRule())
@@ -236,20 +235,6 @@ func createUncompressDexRules() []Rule {
	}
}

func createMakefileGoalRules() []Rule {
	allowlist := []string{
		// libwifi_hal uses makefile_goal for its dependencies
		"frameworks/opt/net/wifi/libwifi_hal",
	}
	return []Rule{
		NeverAllow().
			ModuleType("makefile_goal").
			WithoutMatcher("product_out_path", Regexp("^boot[0-9a-zA-Z.-]*[.]img$")).
			NotIn(allowlist...).
			Because("Only boot images may be imported as a makefile goal if not in allowed projects"),
	}
}

func createInitFirstStageRules() []Rule {
	return []Rule{
		NeverAllow().
+0 −59
Original line number Diff line number Diff line
@@ -313,45 +313,6 @@ var neverallowTests = []struct {
			"module \"outside_art_libraries\": violates neverallow",
		},
	},
	{
		name: "disallowed makefile_goal",
		fs: map[string][]byte{
			"Android.bp": []byte(`
				makefile_goal {
					name: "foo",
					product_out_path: "boot/trap.img"
				}
			`),
		},
		expectedErrors: []string{
			"Only boot images.* may be imported as a makefile goal",
		},
	},
	{
		name: "disallowed makefile_goal outside external",
		fs: map[string][]byte{
			"project/Android.bp": []byte(`
				makefile_goal {
					name: "foo",
					product_out_path: "obj/EXE/foo",
				}
			`),
		},
		expectedErrors: []string{
			"not in allowed projects",
		},
	},
	{
		name: "allow makefile_goal within external",
		fs: map[string][]byte{
			"frameworks/opt/net/wifi/libwifi_hal/Android.bp": []byte(`
				makefile_goal {
					name: "foo",
					product_out_path: "obj/EXE/foo",
				}
			`),
		},
	},
	// Tests for the rule prohibiting the use of framework
	{
		name: "prohibit framework",
@@ -391,7 +352,6 @@ var prepareForNeverAllowTest = GroupFixturePreparers(
		ctx.RegisterModuleType("java_library", newMockJavaLibraryModule)
		ctx.RegisterModuleType("java_library_host", newMockJavaLibraryModule)
		ctx.RegisterModuleType("java_device_for_host", newMockJavaLibraryModule)
		ctx.RegisterModuleType("makefile_goal", newMockMakefileGoalModule)
	}),
)

@@ -489,22 +449,3 @@ func newMockJavaLibraryModule() Module {

func (p *mockJavaLibraryModule) GenerateAndroidBuildActions(ModuleContext) {
}

type mockMakefileGoalProperties struct {
	Product_out_path *string
}

type mockMakefileGoalModule struct {
	ModuleBase
	properties mockMakefileGoalProperties
}

func newMockMakefileGoalModule() Module {
	m := &mockMakefileGoalModule{}
	m.AddProperties(&m.properties)
	InitAndroidModule(m)
	return m
}

func (p *mockMakefileGoalModule) GenerateAndroidBuildActions(ModuleContext) {
}