Split droidstubs out of droiddoc.go (2207f877) · Commits · e / os / android_build_soong

java/Android.bp

+3 −0

Original line number	Diff line number	Diff line
		@@ -38,6 +38,7 @@ bootstrap_go_package {
		"dexpreopt_bootjars.go",
		"dexpreopt_config.go",
		"droiddoc.go",
		"droidstubs.go",
		"gen.go",
		"genrule.go",
		"hiddenapi.go",
		@@ -72,6 +73,8 @@ bootstrap_go_package {
		"device_host_converter_test.go",
		"dexpreopt_test.go",
		"dexpreopt_bootjars_test.go",
		"droiddoc_test.go",
		"droidstubs_test.go",
		"hiddenapi_singleton_test.go",
		"java_test.go",
		"jdeps_test.go",

java/droiddoc.go

+0 −853

File changed.

Preview size limit exceeded, changes collapsed.

java/droiddoc_test.go

0 → 100644

+147 −0

Original line number	Diff line number	Diff line
		// Copyright 2021 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 java

		import (
		"reflect"
		"strings"
		"testing"

		"android/soong/android"
		)

		func TestDroiddoc(t *testing.T) {
		ctx, _ := testJavaWithFS(t, `
		droiddoc_exported_dir {
		name: "droiddoc-templates-sdk",
		path: ".",
		}
		filegroup {
		name: "bar-doc-aidl-srcs",
		srcs: ["bar-doc/IBar.aidl"],
		path: "bar-doc",
		}
		droidstubs {
		name: "bar-stubs",
		srcs: [
		"bar-doc/a.java",
		],
		exclude_srcs: [
		"bar-doc/b.java"
		],
		api_levels_annotations_dirs: [
		"droiddoc-templates-sdk",
		],
		api_levels_annotations_enabled: true,
		}
		droiddoc {
		name: "bar-doc",
		srcs: [
		":bar-stubs",
		"bar-doc/IFoo.aidl",
		":bar-doc-aidl-srcs",
		],
		custom_template: "droiddoc-templates-sdk",
		hdf: [
		"android.whichdoc offline",
		],
		knowntags: [
		"bar-doc/known_oj_tags.txt",
		],
		proofread_file: "libcore-proofread.txt",
		todo_file: "libcore-docs-todo.html",
		flags: ["-offlinemode -title \"libcore\""],
		}
		`,
		map[string][]byte{
		"bar-doc/a.java": nil,
		"bar-doc/b.java": nil,
		})
		barStubs := ctx.ModuleForTests("bar-stubs", "android_common")
		barStubsOutputs, err := barStubs.Module().(*Droidstubs).OutputFiles("")
		if err != nil {
		t.Errorf("Unexpected error %q retrieving \"bar-stubs\" output file", err)
		}
		if len(barStubsOutputs) != 1 {
		t.Errorf("Expected one output from \"bar-stubs\" got %s", barStubsOutputs)
		}

		barStubsOutput := barStubsOutputs[0]
		barDoc := ctx.ModuleForTests("bar-doc", "android_common")
		javaDoc := barDoc.Rule("javadoc").RelativeToTop()
		if g, w := android.PathsRelativeToTop(javaDoc.Implicits), android.PathRelativeToTop(barStubsOutput); !inList(w, g) {
		t.Errorf("implicits of bar-doc must contain %q, but was %q.", w, g)
		}

		expected := "-sourcepath out/soong/.intermediates/bar-doc/android_common/srcjars "
		if !strings.Contains(javaDoc.RuleParams.Command, expected) {
		t.Errorf("bar-doc command does not contain flag %q, but should\n%q", expected, javaDoc.RuleParams.Command)
		}

		aidl := barDoc.Rule("aidl")
		if g, w := android.PathsRelativeToTop(javaDoc.Implicits), android.PathRelativeToTop(aidl.Output); !inList(w, g) {
		t.Errorf("implicits of bar-doc must contain %q, but was %q.", w, g)
		}

		if g, w := aidl.Implicits.Strings(), []string{"bar-doc/IBar.aidl", "bar-doc/IFoo.aidl"}; !reflect.DeepEqual(w, g) {
		t.Errorf("aidl inputs must be %q, but was %q", w, g)
		}
		}

		func TestDroiddocArgsAndFlagsCausesError(t *testing.T) {
		testJavaError(t, "flags is set. Cannot set args", `
		droiddoc_exported_dir {
		name: "droiddoc-templates-sdk",
		path: ".",
		}
		filegroup {
		name: "bar-doc-aidl-srcs",
		srcs: ["bar-doc/IBar.aidl"],
		path: "bar-doc",
		}
		droidstubs {
		name: "bar-stubs",
		srcs: [
		"bar-doc/a.java",
		],
		exclude_srcs: [
		"bar-doc/b.java"
		],
		api_levels_annotations_dirs: [
		"droiddoc-templates-sdk",
		],
		api_levels_annotations_enabled: true,
		}
		droiddoc {
		name: "bar-doc",
		srcs: [
		":bar-stubs",
		"bar-doc/IFoo.aidl",
		":bar-doc-aidl-srcs",
		],
		custom_template: "droiddoc-templates-sdk",
		hdf: [
		"android.whichdoc offline",
		],
		knowntags: [
		"bar-doc/known_oj_tags.txt",
		],
		proofread_file: "libcore-proofread.txt",
		todo_file: "libcore-docs-todo.html",
		flags: ["-offlinemode -title \"libcore\""],
		args: "-offlinemode -title \"libcore\"",
		}
		`)
		}

java/droidstubs.go

0 → 100644

+878 −0

File added.

Preview size limit exceeded, changes collapsed.

java/droidstubs_test.go

0 → 100644

+138 −0

Original line number	Diff line number	Diff line
		// Copyright 2021 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 java

		import (
		"strings"
		"testing"

		"android/soong/android"
		)

		func TestDroidstubs(t *testing.T) {
		ctx, _ := testJavaWithFS(t, `
		droiddoc_exported_dir {
		name: "droiddoc-templates-sdk",
		path: ".",
		}

		droidstubs {
		name: "bar-stubs",
		srcs: ["bar-doc/a.java"],
		api_levels_annotations_dirs: ["droiddoc-templates-sdk"],
		api_levels_annotations_enabled: true,
		}

		droidstubs {
		name: "bar-stubs-other",
		srcs: ["bar-doc/a.java"],
		high_mem: true,
		api_levels_annotations_dirs: ["droiddoc-templates-sdk"],
		api_levels_annotations_enabled: true,
		api_levels_jar_filename: "android.other.jar",
		}
		`,
		map[string][]byte{
		"bar-doc/a.java": nil,
		})
		testcases := []struct {
		moduleName string
		expectedJarFilename string
		high_mem bool
		}{
		{
		moduleName: "bar-stubs",
		expectedJarFilename: "android.jar",
		high_mem: false,
		},
		{
		moduleName: "bar-stubs-other",
		expectedJarFilename: "android.other.jar",
		high_mem: true,
		},
		}
		for _, c := range testcases {
		m := ctx.ModuleForTests(c.moduleName, "android_common")
		metalava := m.Rule("metalava")
		rp := metalava.RuleParams
		expected := "--android-jar-pattern ./%/public/" + c.expectedJarFilename
		if actual := rp.Command; !strings.Contains(actual, expected) {
		t.Errorf("For %q, expected metalava argument %q, but was not found %q", c.moduleName, expected, actual)
		}

		if actual := rp.Pool != nil && strings.Contains(rp.Pool.String(), "highmem"); actual != c.high_mem {
		t.Errorf("Expected %q high_mem to be %v, was %v", c.moduleName, c.high_mem, actual)
		}
		}
		}

		func TestDroidstubsWithSystemModules(t *testing.T) {
		ctx, _ := testJava(t, `
		droidstubs {
		name: "stubs-source-system-modules",
		srcs: [
		"bar-doc/a.java",
		],
		sdk_version: "none",
		system_modules: "source-system-modules",
		}

		java_library {
		name: "source-jar",
		srcs: [
		"a.java",
		],
		}

		java_system_modules {
		name: "source-system-modules",
		libs: ["source-jar"],
		}

		droidstubs {
		name: "stubs-prebuilt-system-modules",
		srcs: [
		"bar-doc/a.java",
		],
		sdk_version: "none",
		system_modules: "prebuilt-system-modules",
		}

		java_import {
		name: "prebuilt-jar",
		jars: ["a.jar"],
		}

		java_system_modules_import {
		name: "prebuilt-system-modules",
		libs: ["prebuilt-jar"],
		}
		`)

		checkSystemModulesUseByDroidstubs(t, ctx, "stubs-source-system-modules", "source-jar.jar")

		checkSystemModulesUseByDroidstubs(t, ctx, "stubs-prebuilt-system-modules", "prebuilt-jar.jar")
		}

		func checkSystemModulesUseByDroidstubs(t testing.T, ctx android.TestContext, moduleName string, systemJar string) {
		metalavaRule := ctx.ModuleForTests(moduleName, "android_common").Rule("metalava")
		var systemJars []string
		for _, i := range metalavaRule.Implicits {
		systemJars = append(systemJars, i.Base())
		}
		if len(systemJars) < 1 \|\| systemJars[0] != systemJar {
		t.Errorf("inputs of %q must be []string{%q}, but was %#v.", moduleName, systemJar, systemJars)
		}
		}