Skip to content

armgit / ente

Public Imported from GitHub
0

πŸ’š End-to-end encrypted cloud for everything.

Enforce Android lint warnings and protect lint policy

Manav Rathif425ab2b325f
diff --git a/.github/checks/change-approval/android.mjs b/.github/checks/change-approval/android.mjs
new file mode 100644
index 0000000000..3a701cbf69
--- /dev/null
+++ b/.github/checks/change-approval/android.mjs
@@ -0,0 +1,15 @@
+export function checkAndroid({ files, readAddedLines }) {
+ return files
+ .filter(
+ ({ path, binary, deleted }) =>
+ !binary &&
+ !deleted &&
+ /^android\/.*\.(?:kt|kts|java|xml)$/.test(path),
+ )
+ .filter(({ path }) =>
+ /\b(?:Suppress(?:Lint|Warnings)?\s*\(|tools\s*:\s*ignore\b|noinspection\b)/.test(
+ readAddedLines(path),
+ ),
+ )
+ .map(({ path }) => path);
+}
diff --git a/.github/checks/change-approval/check.mjs b/.github/checks/change-approval/check.mjs
index 3bec5e2ad0..a6386d60aa 100644
--- a/.github/checks/change-approval/check.mjs
+++ b/.github/checks/change-approval/check.mjs
@@ -1,3 +1,4 @@
+import { checkAndroid } from "./android.mjs";
import { readChanges } from "./changes.mjs";
import { checkDependencies } from "./dependencies.mjs";
import { checkFiles } from "./files.mjs";
@@ -15,4 +16,5 @@ writeReport({
rust: checkRust(changes),
swift: checkSwift(changes),
web: checkWeb(changes),
+ android: checkAndroid(changes),
});
diff --git a/.github/checks/change-approval/files.mjs b/.github/checks/change-approval/files.mjs
index dbf1c5ea50..0a3a71d67c 100644
--- a/.github/checks/change-approval/files.mjs
+++ b/.github/checks/change-approval/files.mjs
@@ -4,6 +4,9 @@ const routineBinary = (file) =>
/\.(png|jpe?g|webp|gif|ico|icns|ttf|otf|woff2?|riv|mp3)$/i.test(file) ||
file.includes("Assets.xcassets/");
const guardrailDirs = [
+ "android/checks/",
+ "android/scripts/",
+ "android/gradle/",
"apple/scripts/",
"mobile/checks/",
"mobile/scripts/",
@@ -24,6 +27,19 @@ const guardrailFiles = new Set([
".prettierrc.json",
"analysis_options.yaml",
]);
+const androidConfigFiles = new Set([
+ "build.gradle",
+ "build.gradle.kts",
+ "settings.gradle",
+ "settings.gradle.kts",
+ "gradle.properties",
+ "detekt.yml",
+ "detekt.yaml",
+ "lint.xml",
+ "gradlew",
+ "gradlew.bat",
+ "verification-metadata.xml",
+]);
const configFile =
/(^|\/)(\.gitattributes|\.?clippy\.toml|rust-toolchain\.toml|\.cargo\/(config|audit)\.toml|\.npmrc|\.nvmrc|\.tool-versions|\.node-version|\.python-version|gradle-wrapper\.properties)$/;
@@ -43,7 +59,9 @@ export function checkFiles({ files }) {
path.startsWith(".github/") ||
(!added && guardrailDirs.some((dir) => path.startsWith(dir))) ||
guardrailFiles.has(path) ||
- guardrailFiles.has(basename(path)),
+ guardrailFiles.has(basename(path)) ||
+ (path.startsWith("android/") &&
+ androidConfigFiles.has(basename(path))),
)
.map(({ path }) => path);
const configs = files
diff --git a/.github/checks/change-approval/report.mjs b/.github/checks/change-approval/report.mjs
index 7395238203..95f774fe33 100644
--- a/.github/checks/change-approval/report.mjs
+++ b/.github/checks/change-approval/report.mjs
@@ -6,6 +6,7 @@ export function writeReport({
rust,
swift,
web,
+ android,
}) {
const categories = [
{
@@ -55,6 +56,11 @@ export function writeReport({
plural: "Web lint policy files",
count: web.length,
},
+ {
+ singular: "Android lint policy file",
+ plural: "Android lint policy files",
+ count: android.length,
+ },
].filter(({ count }) => count);
const summary = categories
.map(
@@ -94,6 +100,10 @@ export function writeReport({
sections.push(`## Swift lint directives\n\n${list(swift.map(code))}`);
if (web.length)
sections.push(`## Web lint directives\n\n${list(web.map(code))}`);
+ if (android.length)
+ sections.push(
+ `## Android lint directives\n\n${list(android.map(code))}`,
+ );
const detail = sections.join("\n\n");
const { GITHUB_OUTPUT, GITHUB_STEP_SUMMARY } = process.env;
diff --git a/.github/checks/change-approval/test.mjs b/.github/checks/change-approval/test.mjs
index 7250631bae..032d9c3f36 100644
--- a/.github/checks/change-approval/test.mjs
+++ b/.github/checks/change-approval/test.mjs
@@ -656,6 +656,54 @@ test("new lint and formatter configs need approval, including untracked files",
assert.match(scan(t, {}, files, { commit: false }), /^7 guardrail files\n/);
});
+test("Android lint configurations need approval when added, edited, or deleted", (t) => {
+ const files = {
+ "android/build.gradle.kts": "",
+ "android/settings.gradle.kts": "",
+ "android/gradle.properties": "",
+ "android/gradlew": "",
+ "android/gradlew.bat": "",
+ "android/gradle/verification-metadata.xml": "",
+ "android/detekt.yml": "",
+ "android/apps/example/detekt.yaml": "",
+ "android/apps/example/lint.xml": "",
+ "android/apps/example/build.gradle": "",
+ };
+ for (const [base, change] of [
+ [{}, files],
+ [
+ files,
+ Object.fromEntries(Object.keys(files).map((file) => [file, "\n"])),
+ ],
+ [
+ files,
+ Object.fromEntries(Object.keys(files).map((file) => [file, null])),
+ ],
+ ]) {
+ const { summary } = scan(t, base, change, { ci: true });
+ assert.match(summary, /10 guardrail files/);
+ for (const file of Object.keys(files))
+ assert.ok(summary.includes(`\`${file}\``));
+ }
+});
+
+test("Android lint scripts and checks need approval when edited", (t) => {
+ assert.match(
+ scan(
+ t,
+ {
+ "android/scripts/lint.sh": "",
+ "android/checks/gradle-order/check.py": "",
+ },
+ {
+ "android/scripts/lint.sh": "\n",
+ "android/checks/gradle-order/check.py": "\n",
+ },
+ ),
+ /^2 guardrail files\n/,
+ );
+});
+
test("toolchain and registry config added, modified, or deleted", (t) => {
const output = scan(
t,
@@ -1106,6 +1154,34 @@ test("Swift directive edits need approval; ordinary edits and removals do not",
assert.equal(scan(t, { [file]: before }, { [file]: after }), "");
});
+test("added Android lint suppressions need approval", (t) => {
+ for (const [extension, directive] of [
+ ["kt", '@Suppress("UnsafeCallOnNullableType")'],
+ ["kts", '@file:Suppress("DEPRECATION")'],
+ ["java", '@android.annotation.SuppressLint("NewApi")'],
+ ["java", '@SuppressWarnings("deprecation")'],
+ ["xml", 'tools:ignore="HardcodedText"'],
+ ["kt", "//noinspection KotlinConstantConditions"],
+ ]) {
+ const file = `android/apps/example/Example.${extension}`;
+ assert.match(
+ scan(
+ t,
+ { [file]: "first()\n" },
+ { [file]: `${directive}\nfirst()\n` },
+ ),
+ /^1 Android lint policy file\n/,
+ );
+ }
+});
+
+test("ordinary Android edits and removed suppressions need no approval", (t) => {
+ const file = "android/apps/example/Example.kt";
+ const before = '@Suppress("DEPRECATION")\nfirst()\n';
+ for (const after of [before.replace("first", "second"), "first()\n", null])
+ assert.equal(scan(t, { [file]: before }, { [file]: after }), "");
+});
+
test("checks started in a subdirectory inspect repository-wide changes", (t) => {
const summary =
"1 binary file, 1 new dependency\n\n## Binary files\n\n- `new.bin` (16 bytes)\n\n## New dependencies\n\n`rust/Cargo.lock`\n\n- b 2.0.0\n";
diff --git a/.github/workflows/android-lint.yml b/.github/workflows/android-lint.yml
index e1def9c9cb..79c357c060 100644
--- a/.github/workflows/android-lint.yml
+++ b/.github/workflows/android-lint.yml
@@ -11,4 +11,6 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+ with:
+ persist-credentials: false
- run: ./android/scripts/lint.sh
diff --git a/android/build.gradle.kts b/android/build.gradle.kts
index 5355450966..e3c030a399 100644
--- a/android/build.gradle.kts
+++ b/android/build.gradle.kts
@@ -1,3 +1,4 @@
+import com.android.build.api.dsl.CommonExtension
import com.ncorti.ktfmt.gradle.KtfmtExtension
import dev.detekt.gradle.extensions.DetektExtension
import org.jetbrains.kotlin.gradle.tasks.KotlinCompilationTask
@@ -18,13 +19,16 @@ allprojects {
apply(plugin = "com.ncorti.ktfmt.gradle")
apply(plugin = "dev.detekt")
- extensions.configure<KtfmtExtension> {
- kotlinLangStyle()
- maxWidth.set(100)
- }
+ extensions.configure<KtfmtExtension> { kotlinLangStyle() }
extensions.configure<DetektExtension> { config.setFrom(rootProject.file("detekt.yml")) }
+ listOf("com.android.application", "com.android.library").forEach { id ->
+ pluginManager.withPlugin(id) {
+ extensions.configure<CommonExtension<*, *, *, *, *, *>> { lint.warningsAsErrors = true }
+ }
+ }
+
tasks.withType<KotlinCompilationTask<*>>().configureEach {
compilerOptions.allWarningsAsErrors.set(true)
}