Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add manifest validation, replace manifest build dir generation #104

Merged
merged 4 commits into from
Nov 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion application/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,7 @@ androidProjectConfiguration(
compileSdk = 29,
versionCode = 1,
versionName = "1.0",
dataBinding = true
dataBinding = true,
validateManifestPackages = true,
generateMissedManifests = true
)
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<manifest package="com.stepango.blockme.common.extensions.android.util"/>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<manifest package="com.stepango.blockme.common.extensions.databinding.adapter"/>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<manifest package="com.stepango.blockme.common.placeholder.res"/>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<manifest package="com.stepango.blockme.common.progressbar.databinding"/>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<manifest package="com.stepango.common.progressbar.res"/>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<manifest package="com.stepango.blockme.common.recyclerview.widget"/>
1 change: 1 addition & 0 deletions application/core/di/library/src/main/AndroidManifest.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<manifest package="com.stepango.blockme.core.di.library"/>
1 change: 1 addition & 0 deletions application/core/mvvm/library/src/main/AndroidManifest.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<manifest package="com.stepango.blockme.core.mvvm.library"/>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<manifest package="com.stepango.blockme.core.navigation.library"/>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<manifest package="com.stepango.blockme.core.theme.android.util"/>
1 change: 1 addition & 0 deletions application/core/theme/res/src/main/AndroidManifest.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<manifest package="com.stepango.blockme.core.theme.android.res"/>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<manifest package="com.stepango.blockme.feature.characters.core.impl"/>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<manifest package="com.stepango.blockme.feature.characters.detail.databinding"/>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<manifest package="com.stepango.blockme.feature.characters.detail.impl"/>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<manifest package="com.stepango.blockme.feature.character.detail.res"/>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<manifest package="com.stepango.blockme.feature.favorite.res"/>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<manifest package="com.stepango.blockme.feature.characters.favorite.impl"/>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<manifest package="com.stepango.blockme.feature.character.favorite.res"/>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<manifest package="com.stepango.blockme.feature.characters.list.databinding"/>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<manifest package="com.stepango.blockme.feature.characters.list.impl"/>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<manifest package="com.stepango.blockme.feature.character.list.res"/>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<manifest package="com.stepango.blockme.feature.home.databinding"/>
1 change: 1 addition & 0 deletions application/feature/home/impl/src/main/AndroidManifest.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<manifest package="com.stepango.blockme.feature.home.impl"/>
1 change: 1 addition & 0 deletions application/feature/home/res/src/main/AndroidManifest.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<manifest package="com.stepango.blockme.feature.home.res"/>
1 change: 1 addition & 0 deletions application/root-res/src/main/AndroidManifest.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<manifest package="com.stepango.blockme.rootres"/>
1 change: 1 addition & 0 deletions application/toggle-widget/src/main/AndroidManifest.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<manifest package="com.stepango.blockme.widget.toggle"/>
4 changes: 1 addition & 3 deletions plugins/android/src/main/java/androidApp.kt
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,7 @@ fun Project.androidApp(
buildConfiguration,
testInstrumentationRunner,
consumerMinificationFiles,
manifestPlaceholders,
// AndroidApp should always use custom manifest
generateManifest = false
manifestPlaceholders
)
applyFeatures(
androidLibraryFeatureDefinition(libraryFeatureConfiguration),
Expand Down
2 changes: 0 additions & 2 deletions plugins/android/src/main/java/androidLibrary.kt
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ fun Project.androidLibrary(
buildConfiguration: BuildConfiguration = BuildConfiguration(),
consumerMinificationFiles: Set<String> = emptySet(),
manifestPlaceholders: Map<String, Any> = emptyMap(),
generateManifest: Boolean = true
): TargetBuilder {
target.validate(LibraryTargetTemplate)
val libraryFeatureConfiguration = AndroidLibraryFeatureConfiguration(
Expand All @@ -39,7 +38,6 @@ fun Project.androidLibrary(
testInstrumentationRunner,
consumerMinificationFiles,
manifestPlaceholders,
generateManifest
)
applyFeatures(
androidLibraryFeatureDefinition(libraryFeatureConfiguration),
Expand Down
14 changes: 14 additions & 0 deletions plugins/android/src/main/java/androidProjectConfiguration.kt
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,16 @@ import org.gradle.api.tasks.Delete
import tools.forma.android.config.FormaConfiguration
import tools.forma.android.utils.register

// TODO: add docs for every fun param
/**
* Configures common values for whole forma modules.
* @param minSdk is min android sdk
* @param targetSdk is target android sdk
* @param compileSdk is compile android sdk
* @param versionCode is version code for
* @param validateManifestPackages enabling validation of manifests during configuration
* @param generateMissedManifests enabling generation missing manifests during configuration
*/
fun Project.androidProjectConfiguration(
minSdk: Int,
targetSdk: Int,
Expand All @@ -15,6 +25,8 @@ fun Project.androidProjectConfiguration(
versionName: String,
repositories: RepositoryHandler.() -> Unit = {},
dataBinding: Boolean = false,
validateManifestPackages: Boolean = false,
generateMissedManifests: Boolean = false,
javaVersionCompatibility: JavaVersion = JavaVersion.VERSION_1_8, // Java/Kotlin configuration
mandatoryOwners: Boolean = false
) {
Expand All @@ -37,6 +49,8 @@ fun Project.androidProjectConfiguration(
versionName = versionName,
repositories = repositories,
dataBinding = dataBinding,
generateMissedManifests = generateMissedManifests,
validateManifestPackages = validateManifestPackages,
javaVersionCompatibility = javaVersionCompatibility,
mandatoryOwners = mandatoryOwners
)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ data class FormaConfiguration(
// Databinding is Application level feature, android_binary will be infering dataBinding flag, developers does not need to know about
val dataBinding: Boolean = false,
val compose: Boolean = false,
val validateManifestPackages: Boolean = false,
val generateMissedManifests: Boolean = false,
val vectorDrawablesUseSupportLibrary: Boolean = minSdk < AndroidSdkVersion.N,
val javaVersionCompatibility: JavaVersion = JavaVersion.VERSION_1_8, // Java/Kotlin configuration
val mandatoryOwners: Boolean
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,15 @@ import androidJunitRunner
import com.android.build.gradle.LibraryExtension
import org.gradle.api.Project
import org.gradle.kotlin.dsl.get
import org.gradle.kotlin.dsl.support.listFilesOrdered
import org.xml.sax.InputSource
import tools.forma.android.target.LibraryTargetTemplate
import tools.forma.android.utils.BuildConfiguration
import tools.forma.android.utils.applyFrom
import tools.forma.validation.Validator
import tools.forma.validation.validator
import java.io.File
import javax.xml.parsers.DocumentBuilderFactory

class AndroidLibraryFeatureConfiguration(
val packageName: String,
Expand All @@ -19,7 +22,6 @@ class AndroidLibraryFeatureConfiguration(
val manifestPlaceholders: Map<String, Any> = emptyMap(),
val viewBinding: Boolean = false,
val dataBinding: Boolean = false,
val generateManifest: Boolean = true,
val selfValidator: Validator = validator(LibraryTargetTemplate)
)

Expand All @@ -31,10 +33,12 @@ fun androidLibraryFeatureDefinition(
featureConfiguration = featureConfiguration,
configuration = { extension, feature, project, formaConfiguration ->
with(extension) {
if (feature.generateManifest) {
if (formaConfiguration.generateMissedManifests) {
maybeGenerateManifest(project, feature)
}

if (formaConfiguration.validateManifestPackages) {
validateManifestPackage(feature.packageName, project)
}
compileSdkVersion(formaConfiguration.compileSdk)

defaultConfig.applyFrom(
Expand All @@ -57,24 +61,51 @@ fun androidLibraryFeatureDefinition(
}
)

private fun LibraryExtension.validateManifestPackage(
packageName: String,
project: Project
) {
sourceSets.forEach {
if (it.manifest.srcFile.exists()) {
val manifestPackageName = DocumentBuilderFactory
.newInstance()
.newDocumentBuilder()
.parse(InputSource(it.manifest.srcFile.reader()))
.documentElement
.getAttribute("package")

if (manifestPackageName != packageName) {
error(
"Manifest package != build.gradle.kts packageName, it must be equal" +
"\nmanifest ${it.manifest.srcFile.absolutePath}" +
"\npackage $manifestPackageName" +
"\nbuild script ${project.buildFile.absolutePath}" +
"\npackageName $packageName"
)
}
}
}
}

private fun LibraryExtension.maybeGenerateManifest(
project: Project,
feature: AndroidLibraryFeatureConfiguration
) {
val manifestFile = manifestFile(project.buildDir, feature.packageName)
populateManifest(manifestFile, feature.packageName)
sourceSets {
/**
* Manifest file resolved during configuration,
* so we need to create file before we get into plugin is configured
*/
getByName("main").manifest.srcFile(manifestFile.path)
val srcDir = File(project.projectDir, "src")
val mainDir = File(srcDir, "main")
// other source sets inherit manifest in case of existing main manifest
if (mainDir.isDirectory && mainDir.exists()) {
populateManifest(File(mainDir, "AndroidManifest.xml"), feature.packageName)
} else {
val sourceSetNames = sourceSets.names
srcDir
.listFilesOrdered { it.name in sourceSetNames && it.isDirectory }
.forEach {
populateManifest(File(it, "AndroidManifest.xml"), feature.packageName)
}
}
}

fun manifestFile(buildDir: File, packageName: String) =
File(buildDir, "tmp/manifest/${packageName}.xml")

/**
* Manifest file generated and added it to sourceSet
* @param buildDir - project's build dir
Expand All @@ -94,9 +125,8 @@ private fun populateManifest(
parentFile.mkdirs()
createNewFile()
writeText(
"""<?xml version="1.0" encoding="utf-8"?>
<manifest package="$packageName"/>
""".trimIndent()
"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n" +
"<manifest package=\"$packageName\"/>"
)
}
}
Expand Down
2 changes: 0 additions & 2 deletions plugins/android/src/main/java/uiLibrary.kt
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ fun Project.uiLibrary(
buildConfiguration: BuildConfiguration = BuildConfiguration(),
consumerMinificationFiles: Set<String> = emptySet(),
manifestPlaceholders: Map<String, Any> = emptyMap(),
generateManifest: Boolean = true
): TargetBuilder {
target.validate(UiLibraryTargetTemplate)
val libraryFeatureConfiguration = AndroidLibraryFeatureConfiguration(
Expand All @@ -45,7 +44,6 @@ fun Project.uiLibrary(
testInstrumentationRunner,
consumerMinificationFiles,
manifestPlaceholders,
generateManifest
)
applyFeatures(
androidLibraryFeatureDefinition(libraryFeatureConfiguration),
Expand Down