Prototype a lint check for fis.

Author: vkryachko

firebase-installations/customer-lint-checks/customer-lint-checks.gradle

@@ -0,0 +1,35 @@
+// Copyright 2020 Google LLC
+//
+// 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.
+
+plugins {
+    id 'org.jetbrains.kotlin.jvm'
+}
+
+def lintVersion = '26.4.1'
+
+dependencies {
+    compileOnly "com.android.tools.lint:lint-api:$lintVersion"
+    compileOnly "com.android.tools.lint:lint-checks:$lintVersion"
+
+    testImplementation "junit:junit:4.12"
+    testImplementation "com.android.tools.lint:lint:$lintVersion"
+    testImplementation "com.android.tools.lint:lint-tests:$lintVersion"
+    testImplementation "com.android.tools:testutils:$lintVersion"
+}
+
+jar {
+    manifest {
+        attributes('Lint-Registry-v2': 'com.google.firebase.installations.lint.Checks')
+    }
+}

firebase-installations/customer-lint-checks/src/main/java/com/google/firebase/installations/lint/com/google/firebase/installations/lint/Checks.kt

@@ -0,0 +1,23 @@
+// Copyright 2020 Google LLC
+//
+// 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.
+
+package com.google.firebase.installations.lint.com.google.firebase.installations.lint
+
+import com.android.tools.lint.client.api.IssueRegistry
+import com.android.tools.lint.detector.api.Issue
+
+class Checks: IssueRegistry() {
+    override val issues: List<Issue>
+        get() = listOf()
+}

firebase-installations/customer-lint-checks/src/main/java/com/google/firebase/installations/lint/com/google/firebase/installations/lint/IncompatibleIidVersionDetector.kt

@@ -0,0 +1,73 @@
+// Copyright 2020 Google LLC
+//
+// 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.
+
+package com.google.firebase.installations.lint.com.google.firebase.installations.lint
+
+import com.android.tools.lint.detector.api.Detector
+
+import com.android.builder.model.MavenCoordinates
+import com.android.tools.lint.detector.api.Category
+import com.android.tools.lint.detector.api.Context
+import com.android.tools.lint.detector.api.Implementation
+import com.android.tools.lint.detector.api.Issue
+import com.android.tools.lint.detector.api.Location
+import com.android.tools.lint.detector.api.Scope
+import com.android.tools.lint.detector.api.Severity
+
+class IncompatibleIidVersionDetector : Detector() {
+    companion object Issues {
+        private val IMPLEMENTATION = Implementation(
+                IncompatibleIidVersionDetector::class.java,
+                Scope.EMPTY
+        )
+
+        @JvmField
+        val INCOMPATIBLE_IID_VERSION = Issue.create(
+                id = "IncompatibleIidVersion",
+                briefDescription = "FirebaseInstanceId version is not compatible with FirebaseInstallations",
+
+                explanation = """
+            Blah-blah-blah, some text for developers.
+            """,
+                category = Category.INTEROPERABILITY,
+                priority = 1,
+                severity = Severity.ERROR,
+                implementation = IMPLEMENTATION
+        )
+    }
+
+    override fun beforeCheckEachProject(context: Context) {
+        if (!context.project.isGradleProject) {
+            return
+        }
+
+        for (variant in context.project.gradleProjectModel.variants) {
+            for (lib in variant.mainArtifact.dependencies.libraries) {
+                val coordinates = lib.resolvedCoordinates
+                if (coordinates.groupId == "com.google.firebase" && coordinates.artifactId == "firebase-iid") {
+                    if (isIncompatibleVersion(coordinates)) {
+                        context.report(INCOMPATIBLE_IID_VERSION,
+                                Location.create(context.file),
+                                "Incompatible IID version found in variant ${variant.name}: ${lib.name}")
+                    }
+                }
+            }
+        }
+    }
+
+    private fun isIncompatibleVersion(coordinates: MavenCoordinates): Boolean {
+        // TODO: implement version check
+        return coordinates.version != "0.0.0"
+    }
+}

firebase-installations/firebase-installations.gradle

@@ -49,6 +49,9 @@ dependencies {
     compileOnly "com.google.auto.value:auto-value-annotations:1.6.5"
     annotationProcessor "com.google.auto.value:auto-value:1.6.2"
 
+    // ship the check within the SDK
+    lintPublish project(':firebase-installations:customer-lint-checks')
+
     testImplementation 'androidx.test:core:1.2.0'
     testImplementation 'junit:junit:4.12'
     testImplementation "org.robolectric:robolectric:$robolectricVersion"

subprojects.cfg

@@ -25,6 +25,7 @@ firebase-inappmessaging-display
 firebase-inappmessaging-display:ktx
 firebase-installations-interop
 firebase-installations
+firebase-installations:customer-lint-checks
 firebase-segmentation
 firebase-storage
 firebase-storage:ktx