From 68fdb3a815123b586049c56c74d75590aee0e7f3 Mon Sep 17 00:00:00 2001 From: Kirill Nayduik Date: Wed, 27 Apr 2022 15:27:54 +0300 Subject: [PATCH 1/7] Disable Android linter as a temporary workaround --- .../static_analysis/plugins/StaticAnalysisAndroidPlugin.kt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/gradle/plugins/src/main/java/static_analysis/plugins/StaticAnalysisAndroidPlugin.kt b/gradle/plugins/src/main/java/static_analysis/plugins/StaticAnalysisAndroidPlugin.kt index 7b7b4eeb..91966669 100644 --- a/gradle/plugins/src/main/java/static_analysis/plugins/StaticAnalysisAndroidPlugin.kt +++ b/gradle/plugins/src/main/java/static_analysis/plugins/StaticAnalysisAndroidPlugin.kt @@ -3,7 +3,6 @@ package static_analysis.plugins import com.android.build.gradle.AppExtension import org.gradle.api.Project import org.gradle.kotlin.dsl.getByType -import static_analysis.linters.AndroidLinter import static_analysis.linters.CpdLinter import static_analysis.linters.DetektLinter import static_analysis.linters.Linter @@ -35,7 +34,8 @@ class StaticAnalysisAndroidPlugin : StaticAnalysisPlugin() { override fun createLinters(): List = listOf( DetektLinter(), CpdLinter(), - AndroidLinter() + //TODO temporary disable Android Linter to avoid FileNotFoundException when generating report + //AndroidLinter() ) } From e175e66e579183c96ca3384c6c926428139de6d5 Mon Sep 17 00:00:00 2001 From: Kirill Nayduik Date: Thu, 28 Apr 2022 16:56:21 +0300 Subject: [PATCH 2/7] Update parcelize implementation --- .../src/main/java/static_analysis/linters/AndroidLinter.kt | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/gradle/plugins/src/main/java/static_analysis/linters/AndroidLinter.kt b/gradle/plugins/src/main/java/static_analysis/linters/AndroidLinter.kt index fa6ff5b3..c7acf1c6 100644 --- a/gradle/plugins/src/main/java/static_analysis/linters/AndroidLinter.kt +++ b/gradle/plugins/src/main/java/static_analysis/linters/AndroidLinter.kt @@ -43,6 +43,7 @@ class AndroidLinter : Linter { isWarningsAsErrors = false xmlReport = true htmlReport = false + textReport = false isCheckDependencies = true disable("MissingConstraints", "VectorRaster") xmlOutput = getLintReportFile() @@ -58,13 +59,16 @@ class AndroidLinter : Linter { return project .subprojects + .onEach { println(it) } .filter { it.plugins.hasPlugin(AppPlugin::class.java) } + .onEach { println(it) } .mapNotNull { subproject: Project -> subproject .tasks .find { task -> task.name.contains(buildType, ignoreCase = true) && task.name.contains("lint") } ?.path } + .onEach { println(it) } } private fun Project.getLintReportFile() = file("${rootProject.buildDir}/reports/lint-report.xml") From 5e7a39d14ddfedb36a50355b97f500aafa6ca28e Mon Sep 17 00:00:00 2001 From: Kirill Nayduik Date: Fri, 29 Apr 2022 22:13:42 +0300 Subject: [PATCH 3/7] Add comments for temporary workaround to avoid Android Linter configuration error --- gradle/plugins/build.gradle.kts | 2 +- .../static_analysis/linters/AndroidLinter.kt | 37 ++++++++++--------- .../plugins/StaticAnalysisAndroidPlugin.kt | 4 +- 3 files changed, 23 insertions(+), 20 deletions(-) diff --git a/gradle/plugins/build.gradle.kts b/gradle/plugins/build.gradle.kts index 3611bcbd..daf09c84 100644 --- a/gradle/plugins/build.gradle.kts +++ b/gradle/plugins/build.gradle.kts @@ -13,7 +13,7 @@ repositories { dependencies { // android gradle plugin, required by custom plugin - implementation("com.android.tools.build:gradle:4.0.1") + implementation("com.android.tools.build:gradle:7.1.3") implementation("io.gitlab.arturbosch.detekt:detekt-gradle-plugin:1.10.0") implementation("de.aaschmid:gradle-cpd-plugin:3.1") diff --git a/gradle/plugins/src/main/java/static_analysis/linters/AndroidLinter.kt b/gradle/plugins/src/main/java/static_analysis/linters/AndroidLinter.kt index c7acf1c6..7c438b26 100644 --- a/gradle/plugins/src/main/java/static_analysis/linters/AndroidLinter.kt +++ b/gradle/plugins/src/main/java/static_analysis/linters/AndroidLinter.kt @@ -1,6 +1,6 @@ package static_analysis.linters -import com.android.build.gradle.AppExtension +import com.android.build.api.variant.AndroidComponentsExtension import com.android.build.gradle.AppPlugin import org.gradle.api.Project import org.gradle.kotlin.dsl.findByType @@ -32,22 +32,28 @@ class AndroidLinter : Linter { } .flatten() + @Suppress("UnstableApiUsage") override fun setupForProject(project: Project, extension: StaticAnalysisExtension) { + // Make sure to set lint options manually in app module gradle file + // Otherwise you will get java.io.FileNotFoundException + project.beforeEvaluate { subprojects - .mapNotNull { it.extensions.findByType() } + .mapNotNull { it.extensions.findByType(AndroidComponentsExtension::class) } .first() - .lintOptions.apply { - isAbortOnError = false - isCheckAllWarnings = true - isWarningsAsErrors = false - xmlReport = true - htmlReport = false - textReport = false - isCheckDependencies = true - disable("MissingConstraints", "VectorRaster") - xmlOutput = getLintReportFile() - lintConfig = file("${extension.buildScriptDir}/static_analysis_configs/lint.xml") + .finalizeDsl { ext -> + ext.lint { + abortOnError = false + checkAllWarnings = true + warningsAsErrors = false + checkDependencies = true + htmlReport = false + textReport = false + xmlReport = true + disable.addAll(listOf("MissingConstraints", "VectorRaster")) + xmlOutput = project.getLintReportFile() + lintConfig = file("${extension.buildScriptDir}/static_analysis_configs/lint.xml") + } } } } @@ -59,16 +65,13 @@ class AndroidLinter : Linter { return project .subprojects - .onEach { println(it) } .filter { it.plugins.hasPlugin(AppPlugin::class.java) } - .onEach { println(it) } .mapNotNull { subproject: Project -> subproject .tasks - .find { task -> task.name.contains(buildType, ignoreCase = true) && task.name.contains("lint") } + .find { task -> task.name.equals("lint$buildType") } ?.path } - .onEach { println(it) } } private fun Project.getLintReportFile() = file("${rootProject.buildDir}/reports/lint-report.xml") diff --git a/gradle/plugins/src/main/java/static_analysis/plugins/StaticAnalysisAndroidPlugin.kt b/gradle/plugins/src/main/java/static_analysis/plugins/StaticAnalysisAndroidPlugin.kt index 91966669..7b7b4eeb 100644 --- a/gradle/plugins/src/main/java/static_analysis/plugins/StaticAnalysisAndroidPlugin.kt +++ b/gradle/plugins/src/main/java/static_analysis/plugins/StaticAnalysisAndroidPlugin.kt @@ -3,6 +3,7 @@ package static_analysis.plugins import com.android.build.gradle.AppExtension import org.gradle.api.Project import org.gradle.kotlin.dsl.getByType +import static_analysis.linters.AndroidLinter import static_analysis.linters.CpdLinter import static_analysis.linters.DetektLinter import static_analysis.linters.Linter @@ -34,8 +35,7 @@ class StaticAnalysisAndroidPlugin : StaticAnalysisPlugin() { override fun createLinters(): List = listOf( DetektLinter(), CpdLinter(), - //TODO temporary disable Android Linter to avoid FileNotFoundException when generating report - //AndroidLinter() + AndroidLinter() ) } From 78024ea1a6f8c0f6398df549a5ad99e3ef126a7e Mon Sep 17 00:00:00 2001 From: Kirill Nayduik Date: Wed, 11 May 2022 17:10:27 +0300 Subject: [PATCH 4/7] Add script for setting lintOptions --- .../static_analysis/linters/AndroidLinter.kt | 27 +++---------------- gradle/scripts/lintOptions.gradle | 12 +++++++++ 2 files changed, 15 insertions(+), 24 deletions(-) create mode 100644 gradle/scripts/lintOptions.gradle diff --git a/gradle/plugins/src/main/java/static_analysis/linters/AndroidLinter.kt b/gradle/plugins/src/main/java/static_analysis/linters/AndroidLinter.kt index 7c438b26..56b6aec8 100644 --- a/gradle/plugins/src/main/java/static_analysis/linters/AndroidLinter.kt +++ b/gradle/plugins/src/main/java/static_analysis/linters/AndroidLinter.kt @@ -1,9 +1,7 @@ package static_analysis.linters -import com.android.build.api.variant.AndroidComponentsExtension import com.android.build.gradle.AppPlugin import org.gradle.api.Project -import org.gradle.kotlin.dsl.findByType import static_analysis.errors.AndroidLintError import static_analysis.errors.StaticAnalysisError import static_analysis.plugins.StaticAnalysisExtension @@ -32,30 +30,11 @@ class AndroidLinter : Linter { } .flatten() - @Suppress("UnstableApiUsage") override fun setupForProject(project: Project, extension: StaticAnalysisExtension) { - // Make sure to set lint options manually in app module gradle file + // Make sure to set lint options manually in modules gradle file // Otherwise you will get java.io.FileNotFoundException - project.beforeEvaluate { - subprojects - .mapNotNull { it.extensions.findByType(AndroidComponentsExtension::class) } - .first() - .finalizeDsl { ext -> - ext.lint { - abortOnError = false - checkAllWarnings = true - warningsAsErrors = false - checkDependencies = true - htmlReport = false - textReport = false - xmlReport = true - disable.addAll(listOf("MissingConstraints", "VectorRaster")) - xmlOutput = project.getLintReportFile() - lintConfig = file("${extension.buildScriptDir}/static_analysis_configs/lint.xml") - } - } - } + // See issue: https://github.com/TouchInstinct/BuildScripts/issues/310 } override fun getTaskNames(project: Project, buildType: String?): List { @@ -69,7 +48,7 @@ class AndroidLinter : Linter { .mapNotNull { subproject: Project -> subproject .tasks - .find { task -> task.name.equals("lint$buildType") } + .find { task -> task.name.equals("lint$buildType", ignoreCase = true) } ?.path } } diff --git a/gradle/scripts/lintOptions.gradle b/gradle/scripts/lintOptions.gradle new file mode 100644 index 00000000..e143f8af --- /dev/null +++ b/gradle/scripts/lintOptions.gradle @@ -0,0 +1,12 @@ +android { + lint { + abortOnError false + checkAllWarnings true + warningsAsErrors false + checkDependencies true + htmlReport false + textReport false + xmlReport true + xmlOutput file("${rootProject.buildDir}/reports/lint-report.xml") + } +} From ec358728eb7096fe48b28f69dd1990945a5c4595 Mon Sep 17 00:00:00 2001 From: Kirill Nayduik Date: Wed, 11 May 2022 17:40:08 +0300 Subject: [PATCH 5/7] Set lintConfig file direction --- gradle/scripts/lintOptions.gradle | 1 + 1 file changed, 1 insertion(+) diff --git a/gradle/scripts/lintOptions.gradle b/gradle/scripts/lintOptions.gradle index e143f8af..e1fd0326 100644 --- a/gradle/scripts/lintOptions.gradle +++ b/gradle/scripts/lintOptions.gradle @@ -8,5 +8,6 @@ android { textReport false xmlReport true xmlOutput file("${rootProject.buildDir}/reports/lint-report.xml") + lintConfig file("${rootProject.ext["buildScriptsDir"]}/static_analysis_configs/lint.xml") } } From 3cc63ffe5e6297e3d07f6cbab4275de504b5fe21 Mon Sep 17 00:00:00 2001 From: Kirill Nayduik Date: Wed, 11 May 2022 19:10:22 +0300 Subject: [PATCH 6/7] Ignore WrongTimberUsageDetector error --- static_analysis_configs/lint.xml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/static_analysis_configs/lint.xml b/static_analysis_configs/lint.xml index 98227d48..511e843d 100644 --- a/static_analysis_configs/lint.xml +++ b/static_analysis_configs/lint.xml @@ -16,6 +16,9 @@ + + + From 5c46386ebff66626452533b72d8a29098c756def Mon Sep 17 00:00:00 2001 From: Konstantin Kuzhim Date: Tue, 7 Feb 2023 14:26:50 +0700 Subject: [PATCH 7/7] update BuildScripts to include copy task in AndroidLinter.kt --- .../main/java/static_analysis/linters/AndroidLinter.kt | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/gradle/plugins/src/main/java/static_analysis/linters/AndroidLinter.kt b/gradle/plugins/src/main/java/static_analysis/linters/AndroidLinter.kt index 56b6aec8..d211215b 100644 --- a/gradle/plugins/src/main/java/static_analysis/linters/AndroidLinter.kt +++ b/gradle/plugins/src/main/java/static_analysis/linters/AndroidLinter.kt @@ -48,11 +48,14 @@ class AndroidLinter : Linter { .mapNotNull { subproject: Project -> subproject .tasks - .find { task -> task.name.equals("lint$buildType", ignoreCase = true) } - ?.path + .filter { task -> + task.name.equals("lint${buildType}", ignoreCase = true) + || task.name.equals("copy${buildType}AndroidLintReports", ignoreCase = true) + } + .map { it.path } } + .flatten() } private fun Project.getLintReportFile() = file("${rootProject.buildDir}/reports/lint-report.xml") - }