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

Commit dc62de47 authored by Bob Badour's avatar Bob Badour
Browse files

Refactor projectmetadata into separate package. 

Replace regular expressions to extract fields from a text proto with
and actual parsed protobuf.

Refactor TestFS into its own package, and implement StatFS.

Test: m droid dist cts alllicensemetadata

Test: repo forall -c 'echo -n "$REPO_PATH  " && $ANDROID_BUILD_TOP/out/host/linux-x86/bin/compliance_checkmetadata . 2>&1' | fgrep -v PASS

Change-Id: Icd17a6a2b6a4e2b6ffded48e964b9c9d6e4d64d6
parent 69742238

tools/compliance/Android.bp

+13 −0
Original line number Diff line number Diff line
@@ -17,6 +17,17 @@ package { 
    default_applicable_licenses: ["Android-Apache-2.0"],

}



blueprint_go_binary {

    name: "compliance_checkmetadata",

    srcs: ["cmd/checkmetadata/checkmetadata.go"],

    deps: [

        "compliance-module",

        "projectmetadata-module",

        "soong-response",

    ],

    testSrcs: ["cmd/checkmetadata/checkmetadata_test.go"],

}



blueprint_go_binary {

    name: "compliance_checkshare",

    srcs: ["cmd/checkshare/checkshare.go"],
@@ -156,6 +167,8 @@ bootstrap_go_package { 
        "test_util.go",

    ],

    deps: [

        "compliance-test-fs-module",

        "projectmetadata-module",

        "golang-protobuf-proto",

        "golang-protobuf-encoding-prototext",

        "license_metadata_proto",

tools/compliance/cmd/checkmetadata/checkmetadata.go

0 → 100644
+148 −0
Original line number Diff line number Diff line 
// Copyright 2022 Google LLC

//

// 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 main



import (

	"bytes"

	"flag"

	"fmt"

	"io"

	"io/fs"

	"os"

	"path/filepath"

	"strings"



	"android/soong/response"

	"android/soong/tools/compliance"

	"android/soong/tools/compliance/projectmetadata"

)



var (

	failNoneRequested = fmt.Errorf("\nNo projects requested")

)



func main() {

	var expandedArgs []string

	for _, arg := range os.Args[1:] {

		if strings.HasPrefix(arg, "@") {

			f, err := os.Open(strings.TrimPrefix(arg, "@"))

			if err != nil {

				fmt.Fprintln(os.Stderr, err.Error())

				os.Exit(1)

			}



			respArgs, err := response.ReadRspFile(f)

			f.Close()

			if err != nil {

				fmt.Fprintln(os.Stderr, err.Error())

				os.Exit(1)

			}

			expandedArgs = append(expandedArgs, respArgs...)

		} else {

			expandedArgs = append(expandedArgs, arg)

		}

	}



	flags := flag.NewFlagSet("flags", flag.ExitOnError)



	flags.Usage = func() {

		fmt.Fprintf(os.Stderr, `Usage: %s {-o outfile} projectdir {projectdir...}



Tries to open the METADATA.android or METADATA file in each projectdir

reporting any errors on stderr.



Reports "FAIL" to stdout if any errors found and exits with status 1.



Otherwise, reports "PASS" and the number of project metadata files

found exiting with status 0.

`, filepath.Base(os.Args[0]))

		flags.PrintDefaults()

	}



	outputFile := flags.String("o", "-", "Where to write the output. (default stdout)")



	flags.Parse(expandedArgs)



	// Must specify at least one root target.

	if flags.NArg() == 0 {

		flags.Usage()

		os.Exit(2)

	}



	if len(*outputFile) == 0 {

		flags.Usage()

		fmt.Fprintf(os.Stderr, "must specify file for -o; use - for stdout\n")

		os.Exit(2)

	} else {

		dir, err := filepath.Abs(filepath.Dir(*outputFile))

		if err != nil {

			fmt.Fprintf(os.Stderr, "cannot determine path to %q: %s\n", *outputFile, err)

			os.Exit(1)

		}

		fi, err := os.Stat(dir)

		if err != nil {

			fmt.Fprintf(os.Stderr, "cannot read directory %q of %q: %s\n", dir, *outputFile, err)

			os.Exit(1)

		}

		if !fi.IsDir() {

			fmt.Fprintf(os.Stderr, "parent %q of %q is not a directory\n", dir, *outputFile)

			os.Exit(1)

		}

	}



	var ofile io.Writer

	ofile = os.Stdout

	var obuf *bytes.Buffer

	if *outputFile != "-" {

		obuf = &bytes.Buffer{}

		ofile = obuf

	}



	err := checkProjectMetadata(ofile, os.Stderr, compliance.FS, flags.Args()...)

	if err != nil {

		if err == failNoneRequested {

			flags.Usage()

		}

		fmt.Fprintf(os.Stderr, "%s\n", err.Error())

		fmt.Fprintln(ofile, "FAIL")

		os.Exit(1)

	}

	if *outputFile != "-" {

		err := os.WriteFile(*outputFile, obuf.Bytes(), 0666)

		if err != nil {

			fmt.Fprintf(os.Stderr, "could not write output to %q from %q: %s\n", *outputFile, os.Getenv("PWD"), err)

			os.Exit(1)

		}

	}

	os.Exit(0)

}



// checkProjectMetadata implements the checkmetadata utility.

func checkProjectMetadata(stdout, stderr io.Writer, rootFS fs.FS, projects ...string) error {



	if len(projects) < 1 {

		return failNoneRequested

	}



	// Read the project metadata files from `projects`

	ix := projectmetadata.NewIndex(rootFS)

	pms, err := ix.MetadataForProjects(projects...)

	if err != nil {

		return fmt.Errorf("Unable to read project metadata file(s) %q from %q: %w\n", projects, os.Getenv("PWD"), err)

	}



	fmt.Fprintf(stdout, "PASS -- parsed %d project metadata files for %d projects\n", len(pms), len(projects))

	return nil

}

tools/compliance/cmd/checkmetadata/checkmetadata_test.go

0 → 100644
+191 −0
Original line number Diff line number Diff line 
// Copyright 2022 Google LLC

//

// 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 main



import (

	"bytes"

	"fmt"

	"os"

	"strings"

	"testing"



	"android/soong/tools/compliance"

)



func TestMain(m *testing.M) {

	// Change into the parent directory before running the tests

	// so they can find the testdata directory.

	if err := os.Chdir(".."); err != nil {

		fmt.Printf("failed to change to testdata directory: %s\n", err)

		os.Exit(1)

	}

	os.Exit(m.Run())

}



func Test(t *testing.T) {

	tests := []struct {

		name           string

		projects       []string

		expectedStdout string

	}{

		{

			name:           "1p",

			projects:       []string{"firstparty"},

			expectedStdout: "PASS -- parsed 1 project metadata files for 1 projects",

		},

		{

			name:           "notice",

			projects:       []string{"notice"},

			expectedStdout: "PASS -- parsed 1 project metadata files for 1 projects",

		},

		{

			name:           "1p+notice",

			projects:       []string{"firstparty", "notice"},

			expectedStdout: "PASS -- parsed 2 project metadata files for 2 projects",

		},

		{

			name:           "reciprocal",

			projects:       []string{"reciprocal"},

			expectedStdout: "PASS -- parsed 1 project metadata files for 1 projects",

		},

		{

			name:           "1p+notice+reciprocal",

			projects:       []string{"firstparty", "notice", "reciprocal"},

			expectedStdout: "PASS -- parsed 3 project metadata files for 3 projects",

		},

		{

			name:           "restricted",

			projects:       []string{"restricted"},

			expectedStdout: "PASS -- parsed 1 project metadata files for 1 projects",

		},

		{

			name:           "1p+notice+reciprocal+restricted",

			projects:       []string{

				"firstparty",

				"notice",

				"reciprocal",

				"restricted",

			},

			expectedStdout: "PASS -- parsed 4 project metadata files for 4 projects",

		},

		{

			name:           "proprietary",

			projects:       []string{"proprietary"},

			expectedStdout: "PASS -- parsed 1 project metadata files for 1 projects",

		},

		{

			name:           "1p+notice+reciprocal+restricted+proprietary",

			projects:       []string{

				"firstparty",

				"notice",

				"reciprocal",

				"restricted",

				"proprietary",

			},

			expectedStdout: "PASS -- parsed 5 project metadata files for 5 projects",

		},

		{

			name:           "missing1",

			projects:       []string{"regressgpl1"},

			expectedStdout: "PASS -- parsed 0 project metadata files for 1 projects",

		},

		{

			name:           "1p+notice+reciprocal+restricted+proprietary+missing1",

			projects:       []string{

				"firstparty",

				"notice",

				"reciprocal",

				"restricted",

				"proprietary",

				"regressgpl1",

			},

			expectedStdout: "PASS -- parsed 5 project metadata files for 6 projects",

		},

		{

			name:           "missing2",

			projects:       []string{"regressgpl2"},

			expectedStdout: "PASS -- parsed 0 project metadata files for 1 projects",

		},

		{

			name:           "1p+notice+reciprocal+restricted+proprietary+missing1+missing2",

			projects:       []string{

				"firstparty",

				"notice",

				"reciprocal",

				"restricted",

				"proprietary",

				"regressgpl1",

				"regressgpl2",

			},

			expectedStdout: "PASS -- parsed 5 project metadata files for 7 projects",

		},

		{

			name:           "missing2+1p+notice+reciprocal+restricted+proprietary+missing1",

			projects:       []string{

				"regressgpl2",

				"firstparty",

				"notice",

				"reciprocal",

				"restricted",

				"proprietary",

				"regressgpl1",

			},

			expectedStdout: "PASS -- parsed 5 project metadata files for 7 projects",

		},

		{

			name:           "missing2+1p+notice+missing1+reciprocal+restricted+proprietary",

			projects:       []string{

				"regressgpl2",

				"firstparty",

				"notice",

				"regressgpl1",

				"reciprocal",

				"restricted",

				"proprietary",

			},

			expectedStdout: "PASS -- parsed 5 project metadata files for 7 projects",

		},

	}

	for _, tt := range tests {

		t.Run(tt.name, func(t *testing.T) {

			stdout := &bytes.Buffer{}

			stderr := &bytes.Buffer{}



			projects := make([]string, 0, len(tt.projects))

			for _, project := range tt.projects {

				projects = append(projects, "testdata/"+project)

			}

			err := checkProjectMetadata(stdout, stderr, compliance.GetFS(""), projects...)

			if err != nil {

				t.Fatalf("checkmetadata: error = %v, stderr = %v", err, stderr)

				return

			}

			var actualStdout string

			for _, s := range strings.Split(stdout.String(), "\n") {

				ts := strings.TrimLeft(s, " \t")

				if len(ts) < 1 {

					continue

				}

				if len(actualStdout) > 0 {

					t.Errorf("checkmetadata: unexpected multiple output lines %q, want %q", actualStdout+"\n"+ts, tt.expectedStdout)

				}

				actualStdout = ts

			}

			if actualStdout != tt.expectedStdout {

				t.Errorf("checkmetadata: unexpected stdout %q, want %q", actualStdout, tt.expectedStdout)

			}

		})

	}

}

tools/compliance/cmd/testdata/firstparty/METADATA

0 → 100644
+6 −0
Original line number Diff line number Diff line 
# Comments are allowed

name: "1ptd"

description: "First Party Test Data"

third_party {

    version: "1.0"

}

tools/compliance/cmd/testdata/notice/METADATA

0 → 100644
+6 −0
Original line number Diff line number Diff line 
# Comments are allowed

name: "noticetd"

description: "Notice Test Data"

third_party {

    version: "1.0"

}