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

Commit a0dbf43a authored by Paul Duffin's avatar Paul Duffin
Browse files

Support header and implementation jars in sdk 

Add a new java_header_libs property that exports header jars (as
java_libs currently does) and switch java_libs to export implementation
jars instead.

Refactors implementation of the existing library sdk member type so
both properties can be supported from common code as they differ only
on the jar being exported.

Bug: 143678475
Test: m nothing
Change-Id: I04642122f72d083bbdfd3290624f957b71ee8875
parent d835daaa

java/java.go

+49 −15
Original line number Diff line number Diff line
@@ -1712,17 +1712,15 @@ func (j *Library) DepsMutator(ctx android.BottomUpMutatorContext) { 


const (

	aidlIncludeDir = "aidl"

	javaStubDir        = "java"

	javaStubFileSuffix = ".jar"

	javaDir        = "java"

	jarFileSuffix  = ".jar"

)



// path to the stub file of a java library. Relative to <sdk_root>/<api_dir>

func (j *Library) javaStubFilePathFor() string {

	return filepath.Join(javaStubDir, j.Name()+javaStubFileSuffix)

// path to the jar file of a java library. Relative to <sdk_root>/<api_dir>

func (j *Library) sdkSnapshotFilePathForJar() string {

	return filepath.Join(javaDir, j.Name()+jarFileSuffix)

}



var LibrarySdkMemberType = &librarySdkMemberType{}



type librarySdkMemberType struct {

}
@@ -1735,7 +1733,12 @@ func (mt *librarySdkMemberType) IsInstance(module android.Module) bool { 
	return ok

}



func (mt *librarySdkMemberType) BuildSnapshot(sdkModuleContext android.ModuleContext, builder android.SnapshotBuilder, member android.SdkMember) {

func (mt *librarySdkMemberType) buildSnapshot(

	sdkModuleContext android.ModuleContext,

	builder android.SnapshotBuilder,

	member android.SdkMember,

	jarToExportGetter func(j *Library) android.Path) {



	variants := member.Variants()

	if len(variants) != 1 {

		sdkModuleContext.ModuleErrorf("sdk contains %d variants of member %q but only one is allowed", len(variants), member.Name())
@@ -1746,12 +1749,9 @@ func (mt *librarySdkMemberType) BuildSnapshot(sdkModuleContext android.ModuleCon 
	variant := variants[0]

	j := variant.(*Library)



	headerJars := j.HeaderJars()

	if len(headerJars) != 1 {

		panic(fmt.Errorf("there must be only one header jar from %q", j.Name()))

	}

	snapshotRelativeJavaLibPath := j.javaStubFilePathFor()

	builder.CopyToSnapshot(headerJars[0], snapshotRelativeJavaLibPath)

	exportedJar := jarToExportGetter(j)

	snapshotRelativeJavaLibPath := j.sdkSnapshotFilePathForJar()

	builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)



	for _, dir := range j.AidlIncludeDirs() {

		// TODO(jiyong): copy parcelable declarations only
@@ -1765,6 +1765,40 @@ func (mt *librarySdkMemberType) BuildSnapshot(sdkModuleContext android.ModuleCon 
	module.AddProperty("jars", []string{snapshotRelativeJavaLibPath})

}



var HeaderLibrarySdkMemberType = &headerLibrarySdkMemberType{}



type headerLibrarySdkMemberType struct {

	librarySdkMemberType

}



func (mt *headerLibrarySdkMemberType) BuildSnapshot(sdkModuleContext android.ModuleContext, builder android.SnapshotBuilder, member android.SdkMember) {

	mt.librarySdkMemberType.buildSnapshot(sdkModuleContext, builder, member, func(j *Library) android.Path {

		headerJars := j.HeaderJars()

		if len(headerJars) != 1 {

			panic(fmt.Errorf("there must be only one header jar from %q", j.Name()))

		}



		return headerJars[0]

	})

}



var ImplLibrarySdkMemberType = &implLibrarySdkMemberType{}



type implLibrarySdkMemberType struct {

	librarySdkMemberType

}



func (mt *implLibrarySdkMemberType) BuildSnapshot(sdkModuleContext android.ModuleContext, builder android.SnapshotBuilder, member android.SdkMember) {

	mt.librarySdkMemberType.buildSnapshot(sdkModuleContext, builder, member, func(j *Library) android.Path {

		implementationJars := j.ImplementationJars()

		if len(implementationJars) != 1 {

			panic(fmt.Errorf("there must be only one implementation jar from %q", j.Name()))

		}



		return implementationJars[0]

	})

}



// java_library builds and links sources into a `.jar` file for the device, and possibly for the host as well.

//

// By default, a java_library has a single variant that produces a `.jar` file containing `.class` files that were

sdk/java_sdk_test.go

+115 −6
Original line number Diff line number Diff line
@@ -34,17 +34,17 @@ func TestBasicSdkWithJavaLibrary(t *testing.T) { 
	result := testSdkWithJava(t, `

		sdk {

			name: "mysdk",

			java_libs: ["myjavalib"],

			java_header_libs: ["myjavalib"],

		}



		sdk_snapshot {

			name: "mysdk@1",

			java_libs: ["sdkmember_mysdk_1"],

			java_header_libs: ["sdkmember_mysdk_1"],

		}



		sdk_snapshot {

			name: "mysdk@2",

			java_libs: ["sdkmember_mysdk_2"],

			java_header_libs: ["sdkmember_mysdk_2"],

		}



		java_import {
@@ -103,7 +103,116 @@ func TestBasicSdkWithJavaLibrary(t *testing.T) { 
	ensureListContains(t, pathsToStrings(javalibForMyApex2.Rule("javac").Implicits), sdkMemberV2.String())

}



func TestSnapshotWithJavaLibrary(t *testing.T) {

func TestSnapshotWithJavaHeaderLibrary(t *testing.T) {

	result := testSdkWithJava(t, `

		sdk {

			name: "mysdk",

			java_header_libs: ["myjavalib"],

		}



		java_library {

			name: "myjavalib",

			srcs: ["Test.java"],

			aidl: {

				export_include_dirs: ["aidl"],

			},

			system_modules: "none",

			sdk_version: "none",

			compile_dex: true,

			host_supported: true,

		}

	`)



	result.CheckSnapshot("mysdk", "android_common",

		checkAndroidBpContents(`

// This is auto-generated. DO NOT EDIT.



java_import {

    name: "mysdk_myjavalib@current",

    sdk_member_name: "myjavalib",

    jars: ["java/myjavalib.jar"],

}



java_import {

    name: "myjavalib",

    prefer: false,

    jars: ["java/myjavalib.jar"],

}



sdk_snapshot {

    name: "mysdk@current",

    java_header_libs: ["mysdk_myjavalib@current"],

}



`),

		checkAllCopyRules(`

.intermediates/myjavalib/android_common/turbine-combined/myjavalib.jar -> java/myjavalib.jar

aidl/foo/bar/Test.aidl -> aidl/aidl/foo/bar/Test.aidl

`),

	)

}



func TestHostSnapshotWithJavaHeaderLibrary(t *testing.T) {

	// b/145598135 - Generating host snapshots for anything other than linux is not supported.

	SkipIfNotLinux(t)



	result := testSdkWithJava(t, `

		sdk {

			name: "mysdk",

			device_supported: false,

			host_supported: true,

			java_header_libs: ["myjavalib"],

		}



		java_library {

			name: "myjavalib",

			device_supported: false,

			host_supported: true,

			srcs: ["Test.java"],

			aidl: {

				export_include_dirs: ["aidl"],

			},

			system_modules: "none",

			sdk_version: "none",

			compile_dex: true,

		}

	`)



	result.CheckSnapshot("mysdk", "linux_glibc_common",

		checkAndroidBpContents(`

// This is auto-generated. DO NOT EDIT.



java_import {

    name: "mysdk_myjavalib@current",

    sdk_member_name: "myjavalib",

    device_supported: false,

    host_supported: true,

    jars: ["java/myjavalib.jar"],

}



java_import {

    name: "myjavalib",

    prefer: false,

    device_supported: false,

    host_supported: true,

    jars: ["java/myjavalib.jar"],

}



sdk_snapshot {

    name: "mysdk@current",

    device_supported: false,

    host_supported: true,

    java_header_libs: ["mysdk_myjavalib@current"],

}

`),

		checkAllCopyRules(`

.intermediates/myjavalib/linux_glibc_common/javac/myjavalib.jar -> java/myjavalib.jar

aidl/foo/bar/Test.aidl -> aidl/aidl/foo/bar/Test.aidl

`),

	)

}



func TestSnapshotWithJavaImplLibrary(t *testing.T) {

	result := testSdkWithJava(t, `

		sdk {

			name: "mysdk",
@@ -146,13 +255,13 @@ sdk_snapshot { 


`),

		checkAllCopyRules(`

.intermediates/myjavalib/android_common/turbine-combined/myjavalib.jar -> java/myjavalib.jar

.intermediates/myjavalib/android_common/javac/myjavalib.jar -> java/myjavalib.jar

aidl/foo/bar/Test.aidl -> aidl/aidl/foo/bar/Test.aidl

`),

	)

}



func TestHostSnapshotWithJavaLibrary(t *testing.T) {

func TestHostSnapshotWithJavaImplLibrary(t *testing.T) {

	// b/145598135 - Generating host snapshots for anything other than linux is not supported.

	SkipIfNotLinux(t)

sdk/sdk.go

+13 −3
Original line number Diff line number Diff line
@@ -61,7 +61,12 @@ type sdk struct { 
}



type sdkProperties struct {

	// The list of java libraries in this SDK

	// The list of java header libraries in this SDK

	//

	// This should be used for java libraries that are provided separately at runtime,

	// e.g. through an APEX.

	Java_header_libs []string

	// The list of java implementation libraries in this SDK

	Java_libs []string

	// The list of native libraries in this SDK

	Native_shared_libs []string
@@ -77,7 +82,7 @@ type sdkMemberDependencyTag struct { 
}



// Contains information about the sdk properties that list sdk members, e.g.

// Java_libs.

// Java_header_libs.

type sdkMemberListProperty struct {

	// the name of the property as used in a .bp file

	name string
@@ -105,10 +110,15 @@ var sdkMemberListProperties = []*sdkMemberListProperty{ 
		memberType: cc.LibrarySdkMemberType,

	},

	// Members from java package.

	{

		name:       "java_header_libs",

		getter:     func(properties *sdkProperties) []string { return properties.Java_header_libs },

		memberType: java.HeaderLibrarySdkMemberType,

	},

	{

		name:       "java_libs",

		getter:     func(properties *sdkProperties) []string { return properties.Java_libs },

		memberType: java.LibrarySdkMemberType,

		memberType: java.ImplLibrarySdkMemberType,

	},

	{

		name:       "stubs_sources",

sdk/sdk_test.go

+2 −2
Original line number Diff line number Diff line
@@ -27,12 +27,12 @@ func TestDepNotInRequiredSdks(t *testing.T) { 
	testSdkError(t, `module "myjavalib".*depends on "otherlib".*that isn't part of the required SDKs:.*`, `

		sdk {

			name: "mysdk",

			java_libs: ["sdkmember"],

			java_header_libs: ["sdkmember"],

		}



		sdk_snapshot {

			name: "mysdk@1",

			java_libs: ["sdkmember_mysdk_1"],

			java_header_libs: ["sdkmember_mysdk_1"],

		}



		java_import {