Implement junit compatible report for Android Lint (#167)

Fixes #167

project_views/default.bazelproject

@@ -1,6 +1,11 @@
 directories:
   .
+  -bazel-bin
+  -bazel-grab-bazel-common
+  -bazel-out
   -bazel-cache
+  -bazel-testlogs
+  -bazel-genfiles
 
 # Automatically includes all relevant targets under the 'directories' above
 derive_targets_from_directories: true
@@ -9,6 +14,9 @@ workspace_type: java
 
 java_language_level: 11
 
+test_sources:
+  */src/test/*
+
 additional_languages:
   java
   kotlin

rules/android/lint/lint_aspect.bzl

@@ -360,6 +360,7 @@ def _lint_report_action(
         fail_on_warning,
         fail_on_information,
         lint_result_xml_file,
+        lint_result_junit_xml_file,
         partial_results_dir,
         jdk_home,
         project_xml_file,
@@ -402,7 +403,8 @@ def _lint_report_action(
     args.add("--fail-on-warning", fail_on_warning)
     args.add("--fail-on-information", fail_on_information)
 
-    args.add("--output-xml", lint_result_xml_file.path)
+    args.add("--output-xml", lint_result_xml_file)
+    args.add("--output-junit-xml", lint_result_junit_xml_file)
     args.add("--result-code", result_code)
 
     mnemonic = "AndroidLint"
@@ -458,6 +460,7 @@ def _lint_aspect_impl(target, ctx):
             lint_results_dir = ctx.actions.declare_directory("lint/" + target.label.name + "_results_dir")
 
             lint_result_xml_file = ctx.actions.declare_file("lint/" + target.label.name + "_lint_result.xml")
+            lint_result_junit_xml_file = ctx.actions.declare_file("lint/" + target.label.name + "_lint_result_junit.xml")
             lint_result_code_file = ctx.actions.declare_file("lint/" + target.label.name + "_lint_result_code")
 
             # Project Xmls
@@ -573,6 +576,7 @@ def _lint_aspect_impl(target, ctx):
                 fail_on_warning = sources.fail_on_warning,
                 fail_on_information = sources.fail_on_information,
                 lint_result_xml_file = lint_result_xml_file,
+                lint_result_junit_xml_file = lint_result_junit_xml_file,
                 partial_results_dir = lint_results_dir,
                 models_dir = lint_models_dir,
                 jdk_home = java_runtime_info.java_home,
@@ -599,6 +603,7 @@ def _lint_aspect_impl(target, ctx):
                 outputs = [
                     lint_results_dir,
                     lint_result_xml_file,
+                    lint_result_junit_xml_file,
                     lint_updated_baseline_file,
                     lint_result_code_file,
                 ],
@@ -612,6 +617,7 @@ def _lint_aspect_impl(target, ctx):
                 partial_results_dir = lint_partial_results_dir,
                 models_dir = lint_models_dir,
                 lint_result_xml = lint_result_xml_file,
+                lint_junit_xml = lint_result_junit_xml_file,
                 result_code = lint_result_code_file,
                 updated_baseline = lint_updated_baseline_file,
             )
@@ -623,6 +629,7 @@ def _lint_aspect_impl(target, ctx):
                 enabled = enabled,
                 partial_results_dir = None,
                 lint_result_xml = None,
+                lint_junit_xml = None,
                 result_code = None,
                 updated_baseline = None,
             )

rules/android/lint/lint_test.bzl

@@ -7,6 +7,7 @@ def _lint_test_impl(ctx):
 
     executable = ctx.actions.declare_file("%s_lint.sh" % target.label.name)
 
+    lint_junit_xml_file = lint_info.lint_junit_xml
     lint_result_xml_file = ctx.outputs.lint_result
     lint_result_code = lint_info.result_code
     if lint_info.enabled:
@@ -15,8 +16,12 @@ def _lint_test_impl(ctx):
             output = lint_result_xml_file,
         )
     else:
-        lint_result_code = ctx.actions.declare_file("%s_result_code" % target.label.name)
+        lint_junit_xml_file = ctx.actions.declare_file("%s_junit.xml" % target.label.name)
+        ctx.actions.write(output = lint_junit_xml_file, content = "")
+
         ctx.actions.write(output = lint_result_xml_file, content = "")
+
+        lint_result_code = ctx.actions.declare_file("%s_result_code" % target.label.name)
         ctx.actions.write(output = lint_result_code, content = "0")
 
     ctx.actions.write(
@@ -25,17 +30,23 @@ def _lint_test_impl(ctx):
         content = """
 #!/bin/bash
 cat {lint_result_xml_file}
+cp {lint_junit_xml_file} $XML_OUTPUT_FILE
 exit $(cat {lint_result_code})
             """.format(
             lint_result_xml_file = lint_result_xml_file.short_path,
+            lint_junit_xml_file = lint_junit_xml_file.short_path,
             lint_result_code = lint_result_code.short_path,
         ),
     )
 
     return [
         DefaultInfo(
             executable = executable,
-            runfiles = ctx.runfiles(files = [lint_result_xml_file, lint_result_code]),
+            runfiles = ctx.runfiles(files = [
+                lint_junit_xml_file,
+                lint_result_xml_file,
+                lint_result_code,
+            ]),
             files = depset([
                 ctx.outputs.lint_result,
             ]),

rules/android/lint/providers.bzl

@@ -10,6 +10,7 @@ AndroidLintNodeInfo = provider(
         models_dir = "Lint models directory",
         updated_baseline = "The updated baseline XML",
         lint_result_xml = "The lint results XML file",
+        lint_junit_xml = "Lint result formatted in Junit format",
     ),
 )
 

tools/cli_utils/BUILD.bazel

@@ -8,6 +8,4 @@ kotlin_library(
     visibility = [
         "//visibility:public",
     ],
-    deps = [
-    ],
 )

tools/lint/src/main/java/com/grab/lint/Document.kt

@@ -0,0 +1,9 @@
+package com.grab.lint
+
+import org.w3c.dom.Element
+import org.w3c.dom.NodeList
+
+fun NodeList.elements() = (0 until length).map { item(it) as Element }
+
+operator fun Element.get(name: String): String = getAttribute(name)
+operator fun Element.set(name: String, value: String) = setAttribute(name, value)

tools/lint/src/main/java/com/grab/lint/LintDependency.kt

@@ -12,7 +12,6 @@ data class LintDependency(
     companion object {
         fun from(encodedString: String): LintDependency {
             val (name, android, library, partialResultsDir, modelsDir) = encodedString.split("^")
-            // val partialResults = resolveSymlinks(File(partialResultsDir), workingDir)
             return LintDependency(
                 name = name,
                 android = android.toBoolean(),

tools/lint/src/main/java/com/grab/lint/LintReportCommand.kt

@@ -7,6 +7,7 @@ import com.github.ajalt.clikt.parameters.options.required
 import java.io.File
 import java.nio.file.Path
 import kotlin.io.path.pathString
+import kotlin.system.measureTimeMillis
 import com.android.tools.lint.Main as LintCli
 
 class LintReportCommand : LintBaseCommand() {
@@ -17,12 +18,18 @@ class LintReportCommand : LintBaseCommand() {
         help = "The lint baseline file"
     ).convert { File(it) }.required()
 
-    private val outputXml by option(
+    private val lintResultXml by option(
         "-o",
         "--output-xml",
         help = "Lint output xml"
     ).convert { File(it) }.required()
 
+    private val outputJunitXml by option(
+        "-oj",
+        "--output-junit-xml",
+        help = "Lint output in Junit format"
+    ).convert { File(it) }.required()
+
     private val resultCode by option(
         "-rc",
         "--result-code",
@@ -46,13 +53,18 @@ class LintReportCommand : LintBaseCommand() {
         projectXml: File,
         tmpBaseline: File,
     ) {
-        val newBaseline = runLint(workingDir, projectXml, tmpBaseline)
-        newBaseline.copyTo(updatedBaseline)
+        val elapsed = measureTimeMillis {
+            runLint(workingDir, projectXml, tmpBaseline, lintResultXml)
+        }
+        tmpBaseline.copyTo(updatedBaseline)
         LintResults(
+            name = name,
+            lintResultsFile = lintResultXml,
+            elapsed = elapsed,
             resultCodeFile = resultCode,
-            lintResultsFile = outputXml,
-            failOnWarnings = failOnWarnings,
+            outputJunitXml = outputJunitXml,
             failOnInformation = failOnInformation,
+            failOnWarnings = failOnWarnings,
         ).process()
     }
 
@@ -62,17 +74,16 @@ class LintReportCommand : LintBaseCommand() {
 
     override val createProjectXml: Boolean = false
 
-    private fun runLint(workingDir: Path, projectXml: File, tmpBaseline: File): File {
+    private fun runLint(workingDir: Path, projectXml: File, tmpBaseline: File, lintResultXml: File) {
         val cliArgs = (defaultLintOptions + listOf(
             "--project", projectXml.toString(),
-            "--xml", outputXml.toString(),
+            "--xml", lintResultXml.toString(),
             "--baseline", tmpBaseline.absolutePath,
             "--path-variables", pathVariables,
             "--cache-dir", workingDir.resolve("cache").pathString,
             "--update-baseline", // Always update the baseline, so we can copy later if needed
             "--report-only" // Only do reporting
         )).toTypedArray()
         LintCli().run(cliArgs)
-        return tmpBaseline
     }
 }