Create AndroidGlobalLintChecker
This change creates a separate lint jar "AndroidGlobalLintChecker". This set of custom checks that is intended to be global. These checks should run across the entire tree, not just the framework. - separate lint checking code broadly into "common", "framework", and "global" - publish AndroidGlobalLintChecker into the android distribution for consumption by prebuilts/cmdline-tools Bug: 236558918 Test: AndroidGlobalLintCheckerTest Change-Id: Ib1606a7bc8adfab2f13974e7366288a4e44bbfa2
This commit is contained in:
committed by
Matt Gilbride
parent
b769860c31
commit
afc3a22782
29
tools/lint/common/Android.bp
Normal file
29
tools/lint/common/Android.bp
Normal file
@@ -0,0 +1,29 @@
|
||||
// Copyright (C) 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.
|
||||
|
||||
package {
|
||||
// See: http://go/android-license-faq
|
||||
// A large-scale-change added 'default_applicable_licenses' to import
|
||||
// all of the 'license_kinds' from "frameworks_base_license"
|
||||
// to get the below license kinds:
|
||||
// SPDX-license-identifier-Apache-2.0
|
||||
default_applicable_licenses: ["frameworks_base_license"],
|
||||
}
|
||||
|
||||
java_library_host {
|
||||
name: "AndroidCommonLint",
|
||||
srcs: ["src/main/java/**/*.kt"],
|
||||
libs: ["lint_api"],
|
||||
kotlincflags: ["-Xjvm-default=all"],
|
||||
}
|
||||
@@ -0,0 +1,36 @@
|
||||
/*
|
||||
* Copyright (C) 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.
|
||||
*/
|
||||
|
||||
package com.google.android.lint
|
||||
|
||||
import com.android.tools.lint.detector.api.getUMethod
|
||||
import org.jetbrains.uast.UCallExpression
|
||||
import org.jetbrains.uast.UMethod
|
||||
import org.jetbrains.uast.UParameter
|
||||
|
||||
fun isPermissionMethodCall(callExpression: UCallExpression): Boolean {
|
||||
val method = callExpression.resolve()?.getUMethod() ?: return false
|
||||
return hasPermissionMethodAnnotation(method)
|
||||
}
|
||||
|
||||
fun hasPermissionMethodAnnotation(method: UMethod): Boolean = method.annotations
|
||||
.any {
|
||||
it.hasQualifiedName(ANNOTATION_PERMISSION_METHOD)
|
||||
}
|
||||
|
||||
fun hasPermissionNameAnnotation(parameter: UParameter) = parameter.annotations.any {
|
||||
it.hasQualifiedName(ANNOTATION_PERMISSION_NAME)
|
||||
}
|
||||
28
tools/lint/fix/Android.bp
Normal file
28
tools/lint/fix/Android.bp
Normal file
@@ -0,0 +1,28 @@
|
||||
// Copyright (C) 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.
|
||||
|
||||
package {
|
||||
// See: http://go/android-license-faq
|
||||
// A large-scale-change added 'default_applicable_licenses' to import
|
||||
// all of the 'license_kinds' from "frameworks_base_license"
|
||||
// to get the below license kinds:
|
||||
// SPDX-license-identifier-Apache-2.0
|
||||
default_applicable_licenses: ["frameworks_base_license"],
|
||||
}
|
||||
|
||||
python_binary_host {
|
||||
name: "lint_fix",
|
||||
main: "lint_fix.py",
|
||||
srcs: ["lint_fix.py"],
|
||||
}
|
||||
@@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2021 The Android Open Source Project
|
||||
// Copyright (C) 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.
|
||||
@@ -29,6 +29,11 @@ java_library_host {
|
||||
"auto_service_annotations",
|
||||
"lint_api",
|
||||
],
|
||||
static_libs: [
|
||||
"AndroidCommonLint",
|
||||
// TODO: remove once b/236558918 is resolved and the below checks actually run globally
|
||||
"AndroidGlobalLintChecker",
|
||||
],
|
||||
kotlincflags: ["-Xjvm-default=all"],
|
||||
}
|
||||
|
||||
@@ -51,9 +56,3 @@ java_test_host {
|
||||
unit_test: true,
|
||||
},
|
||||
}
|
||||
|
||||
python_binary_host {
|
||||
name: "lint_fix",
|
||||
main: "fix/lint_fix.py",
|
||||
srcs: ["fix/lint_fix.py"],
|
||||
}
|
||||
@@ -26,7 +26,6 @@ import com.android.tools.lint.detector.api.Scope
|
||||
import com.android.tools.lint.detector.api.Severity
|
||||
import com.android.tools.lint.detector.api.SourceCodeScanner
|
||||
import com.android.tools.lint.detector.api.getUMethod
|
||||
import com.google.android.lint.aidl.hasPermissionMethodAnnotation
|
||||
import com.intellij.psi.PsiType
|
||||
import org.jetbrains.uast.UAnnotation
|
||||
import org.jetbrains.uast.UBlockExpression
|
||||
@@ -193,5 +192,8 @@ class PermissionMethodDetector : Detector(), SourceCodeScanner {
|
||||
else -> false
|
||||
}
|
||||
}
|
||||
|
||||
private fun hasPermissionMethodAnnotation(method: UMethod): Boolean = method.annotations
|
||||
.any { it.hasQualifiedName(ANNOTATION_PERMISSION_METHOD) }
|
||||
}
|
||||
}
|
||||
57
tools/lint/global/Android.bp
Normal file
57
tools/lint/global/Android.bp
Normal file
@@ -0,0 +1,57 @@
|
||||
// Copyright (C) 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.
|
||||
|
||||
package {
|
||||
// See: http://go/android-license-faq
|
||||
// A large-scale-change added 'default_applicable_licenses' to import
|
||||
// all of the 'license_kinds' from "frameworks_base_license"
|
||||
// to get the below license kinds:
|
||||
// SPDX-license-identifier-Apache-2.0
|
||||
default_applicable_licenses: ["frameworks_base_license"],
|
||||
}
|
||||
|
||||
java_library_host {
|
||||
name: "AndroidGlobalLintChecker",
|
||||
srcs: ["checks/src/main/java/**/*.kt"],
|
||||
plugins: ["auto_service_plugin"],
|
||||
libs: [
|
||||
"auto_service_annotations",
|
||||
"lint_api",
|
||||
],
|
||||
static_libs: ["AndroidCommonLint"],
|
||||
kotlincflags: ["-Xjvm-default=all"],
|
||||
dist: {
|
||||
targets: ["droid"],
|
||||
},
|
||||
}
|
||||
|
||||
java_test_host {
|
||||
name: "AndroidGlobalLintCheckerTest",
|
||||
// TODO(b/239881504): Since this test was written, Android
|
||||
// Lint was updated, and now includes classes that were
|
||||
// compiled for java 15. The soong build doesn't support
|
||||
// java 15 yet, so we can't compile against "lint". Disable
|
||||
// the test until java 15 is supported.
|
||||
enabled: false,
|
||||
srcs: ["checks/src/test/java/**/*.kt"],
|
||||
static_libs: [
|
||||
"AndroidGlobalLintChecker",
|
||||
"junit",
|
||||
"lint",
|
||||
"lint_tests",
|
||||
],
|
||||
test_options: {
|
||||
unit_test: true,
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,48 @@
|
||||
/*
|
||||
* Copyright (C) 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.
|
||||
*/
|
||||
|
||||
package com.google.android.lint
|
||||
|
||||
import com.android.tools.lint.client.api.IssueRegistry
|
||||
import com.android.tools.lint.client.api.Vendor
|
||||
import com.android.tools.lint.detector.api.CURRENT_API
|
||||
import com.google.android.lint.aidl.EnforcePermissionDetector
|
||||
import com.google.android.lint.aidl.EnforcePermissionHelperDetector
|
||||
import com.google.android.lint.aidl.SimpleManualPermissionEnforcementDetector
|
||||
import com.google.auto.service.AutoService
|
||||
|
||||
@AutoService(IssueRegistry::class)
|
||||
@Suppress("UnstableApiUsage")
|
||||
class AndroidGlobalIssueRegistry : IssueRegistry() {
|
||||
override val issues = listOf(
|
||||
EnforcePermissionDetector.ISSUE_MISSING_ENFORCE_PERMISSION,
|
||||
EnforcePermissionDetector.ISSUE_MISMATCHING_ENFORCE_PERMISSION,
|
||||
EnforcePermissionHelperDetector.ISSUE_ENFORCE_PERMISSION_HELPER,
|
||||
SimpleManualPermissionEnforcementDetector.ISSUE_USE_ENFORCE_PERMISSION_ANNOTATION,
|
||||
)
|
||||
|
||||
override val api: Int
|
||||
get() = CURRENT_API
|
||||
|
||||
override val minApi: Int
|
||||
get() = 8
|
||||
|
||||
override val vendor: Vendor = Vendor(
|
||||
vendorName = "Android",
|
||||
feedbackUrl = "http://b/issues/new?component=315013",
|
||||
contact = "repsonsible-apis@google.com"
|
||||
)
|
||||
}
|
||||
@@ -19,6 +19,8 @@ package com.google.android.lint.aidl
|
||||
import com.android.tools.lint.detector.api.JavaContext
|
||||
import com.android.tools.lint.detector.api.Location
|
||||
import com.android.tools.lint.detector.api.getUMethod
|
||||
import com.google.android.lint.hasPermissionNameAnnotation
|
||||
import com.google.android.lint.isPermissionMethodCall
|
||||
import org.jetbrains.kotlin.psi.psiUtil.parameterIndex
|
||||
import org.jetbrains.uast.UCallExpression
|
||||
import org.jetbrains.uast.evaluateString
|
||||
@@ -16,14 +16,9 @@
|
||||
|
||||
package com.google.android.lint.aidl
|
||||
|
||||
import com.android.tools.lint.detector.api.getUMethod
|
||||
import com.google.android.lint.ANNOTATION_PERMISSION_METHOD
|
||||
import com.google.android.lint.ANNOTATION_PERMISSION_NAME
|
||||
import com.google.android.lint.CLASS_STUB
|
||||
import com.intellij.psi.PsiAnonymousClass
|
||||
import org.jetbrains.uast.UCallExpression
|
||||
import org.jetbrains.uast.UMethod
|
||||
import org.jetbrains.uast.UParameter
|
||||
|
||||
/**
|
||||
* Given a UMethod, determine if this method is
|
||||
@@ -51,17 +46,3 @@ private fun isInClassCalledStub(node: UMethod): Boolean {
|
||||
it.referenceName == CLASS_STUB
|
||||
} ?: false
|
||||
}
|
||||
|
||||
fun isPermissionMethodCall(callExpression: UCallExpression): Boolean {
|
||||
val method = callExpression.resolve()?.getUMethod() ?: return false
|
||||
return hasPermissionMethodAnnotation(method)
|
||||
}
|
||||
|
||||
fun hasPermissionMethodAnnotation(method: UMethod): Boolean = method.annotations
|
||||
.any {
|
||||
it.hasQualifiedName(ANNOTATION_PERMISSION_METHOD)
|
||||
}
|
||||
|
||||
fun hasPermissionNameAnnotation(parameter: UParameter) = parameter.annotations.any {
|
||||
it.hasQualifiedName(ANNOTATION_PERMISSION_NAME)
|
||||
}
|
||||
Reference in New Issue
Block a user