Enable automatic coding style linting with ktlint (also on CI)

This way the coding style is guaranteed to stay consistent.
grote · Oct 7, 2020 · 6c53106 · 6c53106
1 parent 53937bd
commit 6c53106
Show file tree

Hide file tree

Showing 31 changed files with 167 additions and 70 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,4 @@
+[*.{kt,kts}]
+indent_size=4
+insert_final_newline=true
+max_line_length=100
diff --git a/.gitignore b/.gitignore
@@ -9,6 +9,7 @@ out/
 lib/
 .idea/*
 !.idea/runConfigurations*
+!.idea/inspectionProfiles*
 !.idea/codeStyles*
 *.ipr
 *.iws

diff --git a/.idea/codeStyles/Project.xml b/.idea/codeStyles/Project.xml
diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml
diff --git a/.travis.yml b/.travis.yml
@@ -24,7 +24,7 @@ before_cache:
   - rm -f  $HOME/.gradle/caches/modules-2/modules-2.lock
   - rm -fr $HOME/.gradle/caches/*/plugin-resolution/
 
-script: ./gradlew check assemble
+script: ./gradlew check assemble ktlintCheck
 
 cache:
   directories:

diff --git a/app/build.gradle b/app/build.gradle
@@ -1,7 +1,10 @@
 import groovy.xml.XmlUtil
 
-apply plugin: 'com.android.application'
-apply plugin: 'kotlin-android'
+plugins {
+    id "com.android.application"
+    id "kotlin-android"
+    id "org.jlleitschuh.gradle.ktlint" version "9.4.0"
+}
 
 android {
 
@@ -74,6 +77,17 @@ android {
 
 apply from: '../gradle/dependencies.gradle'
 
+ktlint {
+    version = "0.36.0" // https://github.com/pinterest/ktlint/issues/764
+    android = true
+    enableExperimentalRules = false
+    verbose = true
+    disabledRules = [
+            "import-ordering",
+            "no-blank-line-before-rbrace",
+    ]
+}
+
 gradle.projectsEvaluated {
     tasks.withType(JavaCompile) {
         if (JavaVersion.current() >= JavaVersion.VERSION_1_9) {
@@ -92,9 +106,14 @@ preBuild.doLast {
         def jdkNode = parsedXml.component[1].orderEntry.find { it.'@type' == 'jdk' }
         parsedXml.component[1].remove(jdkNode)
 
-        def sdkString = "Android API " + android.compileSdkVersion.substring("android-".length()) + " Platform"
+        def apiString = android.compileSdkVersion.substring("android-".length())
+        def sdkString = "Android API " + apiString + " Platform"
         //noinspection GroovyResultOfObjectAllocationIgnored // the note gets inserted
-        new Node(parsedXml.component[1], 'orderEntry', ['type': 'jdk', 'jdkName': sdkString, 'jdkType': 'Android SDK'])
+        new Node(parsedXml.component[1], 'orderEntry', [
+                'type'   : 'jdk',
+                'jdkName': sdkString,
+                'jdkType': 'Android SDK'
+        ])
         XmlUtil.serialize(parsedXml, new FileOutputStream(imlFile))
 
     } catch (NullPointerException | FileNotFoundException ex) {

diff --git a/app/src/main/java/com/stevesoltys/seedvault/App.kt b/app/src/main/java/com/stevesoltys/seedvault/App.kt
@@ -56,7 +56,7 @@ class App : Application() {
                     cryptoModule,
                     headerModule,
                     metadataModule,
-                    documentsProviderModule,  // storage plugin
+                    documentsProviderModule, // storage plugin
                     backupModule,
                     restoreModule,
                     appModule

diff --git a/app/src/main/java/com/stevesoltys/seedvault/UsbIntentReceiver.kt b/app/src/main/java/com/stevesoltys/seedvault/UsbIntentReceiver.kt
@@ -69,7 +69,9 @@ abstract class UsbMonitor : BroadcastReceiver() {
 
     override fun onReceive(context: Context, intent: Intent) {
         val action = intent.action ?: return
-        if (intent.action == ACTION_USB_DEVICE_ATTACHED || intent.action == ACTION_USB_DEVICE_DETACHED) {
+        if (intent.action == ACTION_USB_DEVICE_ATTACHED ||
+            intent.action == ACTION_USB_DEVICE_DETACHED
+        ) {
             val device = intent.extras?.getParcelable<UsbDevice>(EXTRA_DEVICE) ?: return
             Log.d(TAG, "New USB mass-storage device attached.")
             device.log()

diff --git a/app/src/main/java/com/stevesoltys/seedvault/crypto/Crypto.kt b/app/src/main/java/com/stevesoltys/seedvault/crypto/Crypto.kt
@@ -115,7 +115,8 @@ internal class CryptoImpl(
         val cipher = cipherFactory.createEncryptionCipher()
 
         check(cipher.getOutputSize(cleartext.size) <= MAX_SEGMENT_LENGTH) {
-            "Cipher's output size ${cipher.getOutputSize(cleartext.size)} is larger than maximum segment length ($MAX_SEGMENT_LENGTH)"
+            "Cipher's output size ${cipher.getOutputSize(cleartext.size)} is larger" +
+                "than maximum segment length ($MAX_SEGMENT_LENGTH)"
         }
         encryptSegment(cipher, outputStream, cleartext)
     }
@@ -162,9 +163,9 @@ internal class CryptoImpl(
                     "expected '$expectedPackageName'."
             )
         }
-        if (header.key != expectedKey) {
-            throw SecurityException("Invalid key '${header.key}' in header, expected '$expectedKey'.")
-        }
+        if (header.key != expectedKey) throw SecurityException(
+            "Invalid key '${header.key}' in header, expected '$expectedKey'."
+        )
 
         return header
     }
@@ -190,9 +191,9 @@ internal class CryptoImpl(
     @Throws(EOFException::class, IOException::class, SecurityException::class)
     private fun decryptSegment(inputStream: InputStream, maxSegmentLength: Int): ByteArray {
         val segmentHeader = headerReader.readSegmentHeader(inputStream)
-        if (segmentHeader.segmentLength > maxSegmentLength) {
-            throw SecurityException("Segment length too long: ${segmentHeader.segmentLength} > $maxSegmentLength")
-        }
+        if (segmentHeader.segmentLength > maxSegmentLength) throw SecurityException(
+            "Segment length too long: ${segmentHeader.segmentLength} > $maxSegmentLength"
+        )
 
         val buffer = ByteArray(segmentHeader.segmentLength.toInt())
         val bytesRead = inputStream.read(buffer)

diff --git a/app/src/main/java/com/stevesoltys/seedvault/header/Header.kt b/app/src/main/java/com/stevesoltys/seedvault/header/Header.kt
@@ -22,7 +22,9 @@ data class VersionHeader(
             "Package $packageName has name longer than $MAX_PACKAGE_LENGTH_SIZE"
         }
         key?.let {
-            check(key.length <= MAX_KEY_LENGTH_SIZE) { "Key $key is longer than $MAX_KEY_LENGTH_SIZE" }
+            check(key.length <= MAX_KEY_LENGTH_SIZE) {
+                "Key $key is longer than $MAX_KEY_LENGTH_SIZE"
+            }
         }
     }
 }

diff --git a/app/src/main/java/com/stevesoltys/seedvault/header/HeaderReader.kt b/app/src/main/java/com/stevesoltys/seedvault/header/HeaderReader.kt
@@ -33,15 +33,21 @@ internal class HeaderReaderImpl : HeaderReader {
 
         val packageLength = buffer.short.toInt()
         if (packageLength <= 0) throw SecurityException("Invalid package length: $packageLength")
-        if (packageLength > MAX_PACKAGE_LENGTH_SIZE) throw SecurityException("Too large package length: $packageLength")
-        if (packageLength > buffer.remaining()) throw SecurityException("Not enough bytes for package name")
+        if (packageLength > MAX_PACKAGE_LENGTH_SIZE) throw SecurityException(
+            "Too large package length: $packageLength"
+        )
+        if (packageLength > buffer.remaining()) throw SecurityException(
+            "Not enough bytes for package name"
+        )
         val packageName = ByteArray(packageLength)
             .apply { buffer.get(this) }
             .toString(Utf8)
 
         val keyLength = buffer.short.toInt()
         if (keyLength < 0) throw SecurityException("Invalid key length: $keyLength")
-        if (keyLength > MAX_KEY_LENGTH_SIZE) throw SecurityException("Too large key length: $keyLength")
+        if (keyLength > MAX_KEY_LENGTH_SIZE) throw SecurityException(
+            "Too large key length: $keyLength"
+        )
         if (keyLength > buffer.remaining()) throw SecurityException("Not enough bytes for key")
         val key = if (keyLength == 0) null else ByteArray(keyLength)
             .apply { buffer.get(this) }

diff --git a/app/src/main/java/com/stevesoltys/seedvault/metadata/MetadataManager.kt b/app/src/main/java/com/stevesoltys/seedvault/metadata/MetadataManager.kt
@@ -80,7 +80,8 @@ class MetadataManager(
                 "APK backup returned version null"
             }
             check(it.version == null || it.version < packageMetadata.version) {
-                "APK backup backed up the same or a smaller version: was ${it.version} is ${packageMetadata.version}"
+                "APK backup backed up the same or a smaller version:" +
+                    "was ${it.version} is ${packageMetadata.version}"
             }
         }
         val oldPackageMetadata = metadata.packageMetadataMap[packageName]

diff --git a/app/src/main/java/com/stevesoltys/seedvault/metadata/MetadataReader.kt b/app/src/main/java/com/stevesoltys/seedvault/metadata/MetadataReader.kt
@@ -78,9 +78,9 @@ internal class MetadataReaderImpl(private val crypto: Crypto) : MetadataReader {
                 )
             }
             val token = meta.getLong(JSON_METADATA_TOKEN)
-            if (expectedToken != null && token != expectedToken) {
-                throw SecurityException("Invalid token '$token' in metadata, expected '$expectedToken'.")
-            }
+            if (expectedToken != null && token != expectedToken) throw SecurityException(
+                "Invalid token '$token' in metadata, expected '$expectedToken'."
+            )
             // get package metadata
             val packageMetadataMap = PackageMetadataMap()
             for (packageName in json.keys()) {

diff --git a/app/src/main/java/com/stevesoltys/seedvault/restore/RestoreErrorBroadcastReceiver.kt b/app/src/main/java/com/stevesoltys/seedvault/restore/RestoreErrorBroadcastReceiver.kt
@@ -15,7 +15,9 @@ internal const val REQUEST_CODE_UNINSTALL = 4576841
 class RestoreErrorBroadcastReceiver : BroadcastReceiver() {
 
     // using KoinComponent would crash robolectric tests :(
-    private val notificationManager: BackupNotificationManager by lazy { get().get<BackupNotificationManager>() }
+    private val notificationManager: BackupNotificationManager by lazy {
+        get().get<BackupNotificationManager>()
+    }
 
     override fun onReceive(context: Context, intent: Intent) {
         if (intent.action != ACTION_RESTORE_ERROR_UNINSTALL) return
@@ -24,7 +26,7 @@ class RestoreErrorBroadcastReceiver : BroadcastReceiver() {
 
         val packageName = intent.getStringExtra(EXTRA_PACKAGE_NAME)!!
 
-        @Suppress("DEPRECATION")  // the alternative doesn't work for us
+        @Suppress("DEPRECATION") // the alternative doesn't work for us
         val i = Intent(Intent.ACTION_UNINSTALL_PACKAGE).apply {
             data = "package:$packageName".toUri()
             flags = FLAG_ACTIVITY_NEW_TASK

diff --git a/app/src/main/java/com/stevesoltys/seedvault/restore/RestoreViewModel.kt b/app/src/main/java/com/stevesoltys/seedvault/restore/RestoreViewModel.kt
@@ -186,7 +186,9 @@ internal class RestoreViewModel(
         // we need to start a new session and retrieve the restore sets before starting the restore
         val restoreSetResult = getAvailableRestoreSets()
         if (restoreSetResult.hasError()) {
-            mRestoreBackupResult.postValue(RestoreBackupResult(app.getString(R.string.restore_finished_error)))
+            mRestoreBackupResult.postValue(
+                RestoreBackupResult(app.getString(R.string.restore_finished_error))
+            )
             return
         }
 
@@ -196,7 +198,9 @@ internal class RestoreViewModel(
         if (restoreAllResult != 0) {
             if (session == null) Log.e(TAG, "session was null")
             else Log.e(TAG, "restoreAll() returned non-zero value")
-            mRestoreBackupResult.postValue(RestoreBackupResult(app.getString(R.string.restore_finished_error)))
+            mRestoreBackupResult.postValue(
+                RestoreBackupResult(app.getString(R.string.restore_finished_error))
+            )
             return
         }
     }
@@ -306,8 +310,9 @@ internal class RestoreViewModel(
                     val restorableBackups = restoreSets.mapNotNull { set ->
                         getRestorableBackup(set, backupMetadata[set.token])
                     }
-                    if (restorableBackups.isEmpty()) RestoreSetResult(app.getString(R.string.restore_set_empty_result))
-                    else RestoreSetResult(restorableBackups)
+                    if (restorableBackups.isEmpty()) {
+                        RestoreSetResult(app.getString(R.string.restore_set_empty_result))
+                    } else RestoreSetResult(restorableBackups)
                 }
             }
             continuation.resume(result)

diff --git a/app/src/main/java/com/stevesoltys/seedvault/settings/SettingsFragment.kt b/app/src/main/java/com/stevesoltys/seedvault/settings/SettingsFragment.kt
@@ -2,7 +2,7 @@ package com.stevesoltys.seedvault.settings
 
 import android.app.backup.IBackupManager
 import android.content.Context
-import android.content.Context.BACKUP_SERVICE
+import android.content.Context.BACKUP_SERVICE // ktlint-disable no-unused-imports
 import android.content.Intent
 import android.content.IntentFilter
 import android.hardware.usb.UsbDevice
@@ -11,7 +11,7 @@ import android.hardware.usb.UsbManager.ACTION_USB_DEVICE_DETACHED
 import android.os.Bundle
 import android.os.RemoteException
 import android.provider.Settings
-import android.provider.Settings.Secure.BACKUP_AUTO_RESTORE
+import android.provider.Settings.Secure.BACKUP_AUTO_RESTORE // ktlint-disable no-unused-imports
 import android.util.Log
 import android.view.Menu
 import android.view.MenuInflater

diff --git a/app/src/main/java/com/stevesoltys/seedvault/transport/ConfigurableBackupTransportService.kt b/app/src/main/java/com/stevesoltys/seedvault/transport/ConfigurableBackupTransportService.kt
@@ -2,10 +2,10 @@ package com.stevesoltys.seedvault.transport
 
 import android.app.Service
 import android.app.backup.BackupManager
-import android.app.backup.BackupManager.FLAG_NON_INCREMENTAL_BACKUP
+import android.app.backup.BackupManager.FLAG_NON_INCREMENTAL_BACKUP // ktlint-disable no-unused-imports
 import android.app.backup.IBackupManager
 import android.content.Context
-import android.content.Context.BACKUP_SERVICE
+import android.content.Context.BACKUP_SERVICE // ktlint-disable no-unused-imports
 import android.content.Intent
 import android.os.IBinder
 import android.os.RemoteException

diff --git a/app/src/main/java/com/stevesoltys/seedvault/transport/backup/ApkBackup.kt b/app/src/main/java/com/stevesoltys/seedvault/transport/backup/ApkBackup.kt
@@ -79,8 +79,8 @@ class ApkBackup(
         // do not backup if we have the version already and signatures did not change
         if (version <= backedUpVersion && !signaturesChanged(packageMetadata, signatures)) {
             Log.d(
-                TAG,
-                "Package $packageName with version $version already has a backup ($backedUpVersion)" +
+                TAG, "Package $packageName with version $version" +
+                    " already has a backup ($backedUpVersion)" +
                     " with the same signature. Not backing it up."
             )
             return null

diff --git a/app/src/main/java/com/stevesoltys/seedvault/transport/backup/BackupCoordinator.kt b/app/src/main/java/com/stevesoltys/seedvault/transport/backup/BackupCoordinator.kt
@@ -327,12 +327,16 @@ internal class BackupCoordinator(
      */
     suspend fun finishBackup(): Int = when {
         kv.hasState() -> {
-            check(!full.hasState()) { "K/V backup has state, but full backup has dangling state as well" }
+            check(!full.hasState()) {
+                "K/V backup has state, but full backup has dangling state as well"
+            }
             onPackageBackedUp(kv.getCurrentPackage()!!) // not-null because we have state
             kv.finishBackup()
         }
         full.hasState() -> {
-            check(!kv.hasState()) { "Full backup has state, but K/V backup has dangling state as well" }
+            check(!kv.hasState()) {
+                "Full backup has state, but K/V backup has dangling state as well"
+            }
             onPackageBackedUp(full.getCurrentPackage()!!) // not-null because we have state
             full.finishBackup()
         }
@@ -352,15 +356,17 @@ internal class BackupCoordinator(
             val packageName = packageInfo.packageName
             try {
                 nm.onOptOutAppBackup(packageName, i + 1, notAllowedPackages.size)
-                val packageState = if (packageInfo.isStopped()) WAS_STOPPED else NOT_ALLOWED
+                val packageState =
+                    if (packageInfo.isStopped()) WAS_STOPPED else NOT_ALLOWED
                 val wasBackedUp = backUpApk(packageInfo, packageState)
                 if (!wasBackedUp) {
-                    val packageMetadata = metadataManager.getPackageMetadata(packageName)
+                    val packageMetadata =
+                        metadataManager.getPackageMetadata(packageName)
                     val oldPackageState = packageMetadata?.state
                     if (oldPackageState != null && oldPackageState != packageState) {
                         Log.e(
-                            TAG,
-                            "Package $packageName was in $oldPackageState, update to $packageState"
+                            TAG, "Package $packageName was in $oldPackageState" +
+                                ", update to $packageState"
                         )
                         plugin.getMetadataOutputStream().use {
                             metadataManager.onPackageBackupError(packageInfo, packageState, it)

diff --git a/app/src/main/java/com/stevesoltys/seedvault/transport/restore/ApkInstaller.kt b/app/src/main/java/com/stevesoltys/seedvault/transport/restore/ApkInstaller.kt
@@ -62,7 +62,7 @@ internal class ApkInstaller(private val context: Context) {
         }
         // Don't set more sessionParams intentionally here.
         // We saw strange permission issues when doing setInstallReason() or setting installFlags.
-        @Suppress("BlockingMethodInNonBlockingContext")  // flows on Dispatcher.IO
+        @Suppress("BlockingMethodInNonBlockingContext") // flows on Dispatcher.IO
         val session = installer.openSession(installer.createSession(sessionParams))
         val sizeBytes = cachedApk.length()
         session.use { s ->
@@ -96,7 +96,9 @@ internal class ApkInstaller(private val context: Context) {
         val success = i.getIntExtra(EXTRA_STATUS, -1) == STATUS_SUCCESS
         val statusMsg = i.getStringExtra(EXTRA_STATUS_MESSAGE)!!
 
-        check(packageName == expectedPackageName) { "Expected $expectedPackageName, but got $packageName." }
+        check(packageName == expectedPackageName) {
+            "Expected $expectedPackageName, but got $packageName."
+        }
         Log.d(TAG, "Received result for $packageName: success=$success $statusMsg")
 
         // delete cached APK file

diff --git a/app/src/main/java/com/stevesoltys/seedvault/transport/restore/ApkRestore.kt b/app/src/main/java/com/stevesoltys/seedvault/transport/restore/ApkRestore.kt
@@ -95,19 +95,19 @@ internal class ApkRestore(
 
         // check APK's SHA-256 hash
         val sha256 = messageDigest.digest().encodeBase64()
-        if (metadata.sha256 != sha256) {
-            throw SecurityException("Package $packageName has sha256 '$sha256', but '${metadata.sha256}' expected.")
-        }
+        if (metadata.sha256 != sha256) throw SecurityException(
+            "Package $packageName has sha256 '$sha256', but '${metadata.sha256}' expected."
+        )
 
         // parse APK (GET_SIGNATURES is needed even though deprecated)
         @Suppress("DEPRECATION") val flags = GET_SIGNING_CERTIFICATES or GET_SIGNATURES
         val packageInfo = pm.getPackageArchiveInfo(cachedApk.absolutePath, flags)
             ?: throw IOException("getPackageArchiveInfo returned null")
 
         // check APK package name
-        if (packageName != packageInfo.packageName) {
-            throw SecurityException("Package $packageName expected, but ${packageInfo.packageName} found.")
-        }
+        if (packageName != packageInfo.packageName) throw SecurityException(
+            "Package $packageName expected, but ${packageInfo.packageName} found."
+        )
 
         // check APK version code
         if (metadata.version != packageInfo.longVersionCode) {
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,6 +9,7 @@ out/ @@
     lib/
     .idea/*
     !.idea/runConfigurations*
+    !.idea/inspectionProfiles*
     !.idea/codeStyles*
     *.ipr
     *.iws
@@ Expand Down @@