Add pre-commit hooks

Author: LEDfan

.pre-commit-config.yaml

@@ -0,0 +1,40 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v6.0.0
+  hooks:
+    - id: check-added-large-files
+      args: ['--maxkb=1024']
+    - id: check-merge-conflict
+    - id: check-vcs-permalinks
+    - id: forbid-new-submodules
+    - id: end-of-file-fixer
+    - id: trailing-whitespace
+      args: [--markdown-linebreak-ext=md]
+      exclude: CHANGELOG.md
+    - id: check-yaml
+      args: [--allow-multiple-documents]
+    - id: check-executables-have-shebangs
+    - id: check-symlinks
+    - id: destroyed-symlinks
+
+    # Cross platform
+    - id: check-case-conflict
+    - id: mixed-line-ending
+      args: [--fix=lf]
+
+    # Security
+    - id: detect-aws-credentials
+      args: ['--allow-missing-credentials']
+    - id: detect-private-key
+- repo: local
+  hooks:
+    - id: license-check
+      name: format license headers using maven
+      always_run: true
+      language: script
+      entry: /bin/sh -c "mvn validate license:format"
+      pass_filenames: false
+- repo: https://github.com/crate-ci/typos
+  rev: v1.35.8
+  hooks:
+    - id: typos

LICENSE_HEADER

@@ -5,7 +5,7 @@ kind: ServiceAccount
 metadata:
   name: shinyproxy-operator-sa
 ---
-# Role for the SerivceAcount of the operator
+# Role for the ServiceAccount of the operator
 kind: Role
 apiVersion: rbac.authorization.k8s.io/v1
 metadata:

docs/deployment/bases/namespaced/resources/shinyproxy-operator.rbac.yaml

@@ -67,7 +67,7 @@ fun JsonNode.getTextValueOrNull(key: String): String? {
 
 fun Exception.prettyMessage(): String? {
     val name = javaClass.simpleName
-    if (listOf("Exception", "RuntimeException", "IllegalArgumentException", "IllegalStateException", "IOExecption").contains(name)) {
+    if (listOf("Exception", "RuntimeException", "IllegalArgumentException", "IllegalStateException", "IOException").contains(name)) {
         // don't include name of exception if it's too generic
         return message
     }

src/main/kotlin/eu/openanalytics/shinyproxyoperator/extensions.kt

@@ -160,7 +160,7 @@ class DockerOrchestrator(channel: Channel<ShinyProxyEvent>,
         if (instance.isLatestInstance) {
             throw IllegalStateException("Instance being removed is latest")
         }
-        val status = state[instance.realmId] ?: error("No status found") // TOOD
+        val status = state[instance.realmId] ?: error("No status found") // TODO
         val instances = ArrayList(status.instances)
         instances.remove(instance)
         state[instance.realmId] = status.copy(instances = instances)
@@ -248,7 +248,7 @@ class DockerOrchestrator(channel: Channel<ShinyProxyEvent>,
                 copyTemplates(shinyProxy, dir)
                 val mountCaBundle = copyCaBundle(shinyProxy, inputDir, dir)
                 fileManager.createDirectories(dir.resolve("logs"))
-                val additioanlConfigFiles = copyAdditionalConfigFiles(shinyProxy, dir)
+                val additionalConfigFiles = copyAdditionalConfigFiles(shinyProxy, dir)
                 val envVars = arrayListOf("PROXY_VERSION=${version}", "PROXY_REALM_ID=${shinyProxy.realmId}", "SPRING_CONFIG_IMPORT_0=/opt/shinyproxy/generated.yml", "USE_SYSTEM_CA_CERTS=true")
 
                 val binds = mutableListOf(HostConfig.Bind.builder()
@@ -288,7 +288,7 @@ class DockerOrchestrator(channel: Channel<ShinyProxyEvent>,
                         .build())
                 }
 
-                for ((idx, file) in additioanlConfigFiles.withIndex()) {
+                for ((idx, file) in additionalConfigFiles.withIndex()) {
                     val destination = "/opt/shinyproxy/${file}"
                     binds.add(HostConfig.Bind.builder()
                         .from(dir.resolve(file).toString())

src/main/kotlin/eu/openanalytics/shinyproxyoperator/impl/docker/DockerOrchestrator.kt

@@ -196,14 +196,14 @@ class PodTemplateSpecFactory(config: Config) {
         val resourceBuilder = ResourceRequirementsBuilder()
         if (shinyProxy.memoryRequest != null) {
             try {
-                resourceBuilder.addToRequests("memory", parseMemorQuantity(shinyProxy.memoryRequest!!))
+                resourceBuilder.addToRequests("memory", parseMemoryQuantity(shinyProxy.memoryRequest!!))
             } catch (e: Exception) {
                 throw RuntimeException("Invalid memoryRequest: " + e.prettyMessage(), e)
             }
         }
         if (shinyProxy.memoryLimit != null) {
             try {
-                resourceBuilder.addToLimits("memory", parseMemorQuantity(shinyProxy.memoryLimit!!))
+                resourceBuilder.addToLimits("memory", parseMemoryQuantity(shinyProxy.memoryLimit!!))
             } catch (e: Exception) {
                 throw RuntimeException("Invalid memoryLimit: " + e.prettyMessage(), e)
             }
@@ -240,7 +240,7 @@ class PodTemplateSpecFactory(config: Config) {
         return quantity
     }
 
-    private fun parseMemorQuantity(value: String): Quantity {
+    private fun parseMemoryQuantity(value: String): Quantity {
         var converted = value
         // convert lower case suffixes automatically to a value accepted by k8s
         for (suffix in listOf("p", "t", "g", "m", "k")) {