Add transformManifest recipe

Test: this is a test
Fixes: NA
Change-Id: I26bcf8229cda18c014d695bceafd02788b83ab76

BUILD

@@ -86,3 +86,7 @@ recipe_test(
 recipe_test(
     name = "addCustomSourceFolders",
 )
+
+recipe_test(
+    name = "transformManifest",
+)

recipes/transformManifest/README.md

@@ -0,0 +1,39 @@
+# Transform multiple artifacts during build
+
+This sample demonstrates how to update the Android manifest in a meaningful way.
+It obtains information from the git repository and inserts it into AndroidManifest.xml.
+
+The plugin uses `wiredWithFiles(<input>, <output>)` to modify the Android public manifest
+(`SingleArtifact.MERGED_MANIFEST`) after it has been merged by standard tasks. Plugin installs
+three tasks: [GitVersionTask.kt](build-logic/plugins/src/main/kotlin/GitVersionTask.kt) to
+get version and put it in file and [ManifestTransformerTask.kt](build-logic/plugins/src/main/kotlin/ManifestTransformerTask.kt)
+to pick up this information and update `AndroidManifest.xml`.
+
+The sample shows how to wire multiple tasks together so that the output of the first
+task is the input of the second task, and so on. Gradle places these tasks in a task
+tree to be executed in the proper order during the build.
+
+## To Run
+To run the example, you can just do
+
+```
+./gradlew :app:debugManifestUpdater
+```
+and you will see
+
+```
+...
+
+> Task :app:gitVersionProvider
+
+...
+
+> Task :app:debugManifestUpdater
+Writes to .../app/build/intermediates/merged_manifest/debug/debugManifestUpdater/AndroidManifest.xml
+
+...
+
+SUCCESS
+```
+You can then find AndroidManifest.xml and check that there is a version in android:versionCode
+and it's equal to "1234" (the default value).

recipes/transformManifest/app/build.gradle.kts

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2022 The Android Open Source Project
+ *
+ * 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
+ *
+ *     https://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.
+ */
+
+plugins {
+    alias(libs.plugins.android.application)
+    alias(libs.plugins.kotlin.android)
+    id("android.recipes.transformManifestPlugin")
+}
+
+android {
+    namespace = "com.example.android.recipes.transformManifest"
+    compileSdk = $COMPILE_SDK
+    defaultConfig {
+       minSdk = $MINIMUM_SDK
+       targetSdk = $COMPILE_SDK
+    }
+}
+
+java {
+    toolchain {
+        languageVersion.set(JavaLanguageVersion.of(17))
+    }
+}

recipes/transformManifest/app/src/main/AndroidManifest.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <!--
+         Copyright 2022 The Android Open Source Project
+         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.
+    -->
+    <application android:label="Minimal">
+    </application>
+</manifest>

recipes/transformManifest/build-logic/gradle.properties

@@ -0,0 +1,2 @@
+# Gradle properties are not passed to included builds https://github.com/gradle/gradle/issues/2534
+org.gradle.parallel=true

recipes/transformManifest/build-logic/gradle/libs.versions.toml

@@ -0,0 +1,9 @@
+[versions]
+androidGradlePlugin = $AGP_VERSION
+kotlin = $KOTLIN_VERSION
+
+[libraries]
+android-gradlePlugin-api = { group = "com.android.tools.build", name = "gradle-api", version.ref = "androidGradlePlugin" }
+
+[plugins]
+kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }

recipes/transformManifest/build-logic/plugins/build.gradle.kts

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2022 The Android Open Source Project
+ *
+ * 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
+ *
+ *     https://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.
+ */
+
+plugins {
+    `java-gradle-plugin`
+    alias(libs.plugins.kotlin.jvm)
+}
+
+java {
+    toolchain {
+        languageVersion.set(JavaLanguageVersion.of(17))
+    }
+}
+
+dependencies {
+    compileOnly(libs.android.gradlePlugin.api)
+    implementation(gradleKotlinDsl())
+}
+
+gradlePlugin {
+    plugins {
+        create("transformManifestPlugin") {
+            id = "android.recipes.transformManifestPlugin"
+            implementationClass = "CustomPlugin"
+        }
+    }
+}

recipes/transformManifest/build-logic/plugins/src/main/kotlin/CustomPlugin.kt

@@ -0,0 +1,66 @@
+/*
+ * Copyright 2022 The Android Open Source Project
+ *
+ *   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
+ *
+ *       https://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.
+ */
+
+import com.android.build.gradle.AppPlugin
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+import org.gradle.api.file.DirectoryProperty
+import org.gradle.api.tasks.OutputDirectory
+import org.gradle.kotlin.dsl.register
+import com.android.build.api.artifact.SingleArtifact
+import java.io.File
+import com.android.build.api.variant.AndroidComponentsExtension
+
+/**
+ * This custom plugin will register tree tasks that will update and veridy Android manifest.
+ */
+class CustomPlugin : Plugin<Project> {
+    override fun apply(project: Project) {
+        // Registers a callback on the application of the Android Application plugin.
+        // This allows the CustomPlugin to work whether it's applied before or after
+        // the Android Application plugin.
+        project.plugins.withType(AppPlugin::class.java) {
+
+            // register single task for getting versions from git
+            val gitVersionProvider =
+                project.tasks.register("gitVersionProvider", GitVersionTask::class.java) {
+                    it.gitVersionOutputFile.set(
+                        File(project.buildDir, "intermediates/gitVersionProvider/output")
+                    )
+                    it.outputs.upToDateWhen { false } // never use cache
+                }
+
+            val androidComponents = project.extensions.getByType(AndroidComponentsExtension::class.java)
+            // Registers a callback to be called, when a new variant is configured
+            androidComponents.onVariants { variant ->
+
+                val manifestUpdater =
+                    project.tasks.register(variant.name + "ManifestUpdater", ManifestTransformerTask::class.java) {
+                        it.gitInfoFile.set(gitVersionProvider.flatMap(GitVersionTask::gitVersionOutputFile))
+                    }
+                // update manifest with version information that we got from gitVersionProvider
+                variant.artifacts.use(manifestUpdater)
+                    .wiredWithFiles(
+                        ManifestTransformerTask::mergedManifest,
+                        ManifestTransformerTask::updatedManifest
+                    )
+                    .toTransform(SingleArtifact.MERGED_MANIFEST)
+            }
+        }
+
+
+    }
+}

recipes/transformManifest/build-logic/plugins/src/main/kotlin/GitVersionTask.kt

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2022 The Android Open Source Project
+ *
+ *   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
+ *
+ *       https://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.
+ */
+import org.gradle.api.DefaultTask
+import org.gradle.api.file.RegularFileProperty
+import org.gradle.api.tasks.OutputFile
+import org.gradle.api.tasks.TaskAction
+
+abstract class GitVersionTask: DefaultTask() {
+    @get:OutputFile
+    abstract val gitVersionOutputFile: RegularFileProperty
+
+    @TaskAction
+    fun taskAction() {
+        // this would be the code to get the tip of tree version,
+        // val firstProcess = ProcessBuilder("git","rev-parse --short HEAD").start()
+        // val error = firstProcess.errorStream.readBytes().decodeToString()
+        // if (error.isNotBlank()) {
+        //      System.err.println("Git error : $error")
+        // }
+        // var gitVersion = firstProcess.inputStream.readBytes().decodeToString()
+        // but here, we are just hardcoding :
+        gitVersionOutputFile.get().asFile.writeText("1234")
+    }
+}

recipes/transformManifest/build-logic/plugins/src/main/kotlin/ManifestTransformerTask.kt

@@ -0,0 +1,42 @@
+/*
+ * Copyright (C) 2023 The Android Open Source Project
+ *
+ * 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.
+ */
+import org.gradle.api.DefaultTask
+import org.gradle.api.file.RegularFileProperty
+import org.gradle.api.tasks.InputFile
+import org.gradle.api.tasks.OutputFile
+import org.gradle.api.tasks.TaskAction
+
+abstract class ManifestTransformerTask: DefaultTask() {
+
+    @get:InputFile
+    abstract val gitInfoFile: RegularFileProperty
+
+    @get:InputFile
+    abstract val mergedManifest: RegularFileProperty
+
+    @get:OutputFile
+    abstract val updatedManifest: RegularFileProperty
+
+    @TaskAction
+    fun taskAction() {
+
+        val gitVersion = gitInfoFile.get().asFile.readText()
+        var manifest = mergedManifest.asFile.get().readText()
+        manifest = manifest.replace("android:versionCode=\"1\"", "android:versionCode=\"$gitVersion\"")
+        println("Writes to " + updatedManifest.get().asFile.getAbsolutePath())
+        updatedManifest.get().asFile.writeText(manifest)
+    }
+}

recipes/transformManifest/build-logic/settings.gradle.kts

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2022 The Android Open Source Project
+ *
+ * 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
+ *
+ *     https://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.
+ */
+
+rootProject.name = "build-logic"
+
+pluginManagement {
+    repositories {
+        $AGP_REPOSITORY
+        $PLUGIN_REPOSITORIES
+    }
+}
+
+dependencyResolutionManagement {
+    repositories {
+        $AGP_REPOSITORY
+        $DEPENDENCY_REPOSITORIES
+    }
+}
+
+include(":plugins")

recipes/transformManifest/build.gradle.kts

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2022 The Android Open Source Project
+ *
+ * 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
+ *
+ *     https://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.
+ */
+
+plugins {
+    alias(libs.plugins.android.application) apply false
+    alias(libs.plugins.kotlin.android) apply false
+}

recipes/transformManifest/gradle.properties

@@ -0,0 +1,23 @@
+# Project-wide Gradle settings.
+# IDE (e.g. Android Studio) users:
+# Gradle settings configured through the IDE *will override*
+# any settings specified in this file.
+# For more details on how to configure your build environment visit
+# http://www.gradle.org/docs/current/userguide/build_environment.html
+# Specifies the JVM arguments used for the daemon process.
+# The setting is particularly useful for tweaking memory settings.
+org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8
+# When configured, Gradle will run in incubating parallel mode.
+# This option should only be used with decoupled projects. More details, visit
+# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
+org.gradle.parallel=true
+# AndroidX package structure to make it clearer which packages are bundled with the
+# Android operating system, and which are packaged with your app's APK
+# https://developer.android.com/topic/libraries/support-library/androidx-rn
+android.useAndroidX=true
+# Kotlin code style for this project: "official" or "obsolete":
+kotlin.code.style=official
+# Enables namespacing of each library's R class so that its R class includes only the
+# resources declared in the library itself and none from the library's dependencies,
+# thereby reducing the size of the R class for that library
+android.nonTransitiveRClass=true

recipes/transformManifest/gradle/libs.versions.toml

@@ -0,0 +1,9 @@
+[versions]
+androidGradlePlugin = $AGP_VERSION
+kotlin = $KOTLIN_VERSION
+
+[plugins]
+android-application = { id = "com.android.application", version.ref = "androidGradlePlugin" }
+kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }
+
+