Upgrade ktlint to mitigate CVE-2023-6378 (#1095)

* upgrade ktlint to mitigate CVE-2023-6378 Signed-off-by: Rohit Ashiwal <rashiwal@amazon.com> * lint: add rules and apply formatting Signed-off-by: Rohit Ashiwal <rashiwal@amazon.com> --------- Signed-off-by: Rohit Ashiwal <rashiwal@amazon.com>
opensearch-project · Feb 8, 2024 · 4d8ef69 · 4d8ef69
1 parent 7b3f88e
commit 4d8ef69
Show file tree

Hide file tree

Showing 516 changed files with 14,172 additions and 12,336 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -3,9 +3,16 @@
 root = true
 
 [*.{kt,kts}]
+ktlint_code_style = intellij_idea
 # we have detekt also checking for max line length. Disable the linter and use only one tool to check for max line length.
-
 # See https://github.com/arturbosch/detekt
-max_line_length=off
+ktlint_standard_max-line-length = disabled
+ktlint_ignore_back_ticked_identifier = true
+
+ktlint_standard_function-naming = disabled
+ktlint_standard_property-naming = disabled
+ktlint_standard_function-signature = disabled
+ktlint_standard_value-argument-comment = disabled
+ktlint_standard_argument-list-wrapping = disabled
+ktlint_standard_value-parameter-comment = disabled
 
-disabled_rules=import-ordering
diff --git a/build.gradle b/build.gradle
@@ -151,15 +151,15 @@ configurations {
 
 task ktlint(type: JavaExec, group: "verification") {
     description = "Check Kotlin code style."
-    main = "com.pinterest.ktlint.Main"
+    mainClass = "com.pinterest.ktlint.Main"
     classpath = configurations.ktlint
     args "src/**/*.kt", "spi/src/main/**/*.kt"
 }
 check.dependsOn ktlint
 
 task ktlintFormat(type: JavaExec, group: "formatting") {
     description = "Fix Kotlin code style deviations."
-    main = "com.pinterest.ktlint.Main"
+    mainClass = "com.pinterest.ktlint.Main"
     classpath = configurations.ktlint
     args "-F", "src/**/*.kt", "spi/src/main/**/*.kt"
     // https://github.com/pinterest/ktlint/issues/1391
@@ -216,11 +216,14 @@ dependencies {
     testImplementation "com.nhaarman.mockitokotlin2:mockito-kotlin:2.2.0"
     testImplementation "org.mockito:mockito-core:${versions.mockito}"
 
-    add("ktlint", "com.pinterest:ktlint:0.45.1") {
+    add("ktlint", "com.pinterest.ktlint:ktlint-cli:1.1.0") {
         attributes {
             attribute(Bundling.BUNDLING_ATTRIBUTE, objects.named(Bundling, Bundling.EXTERNAL))
         }
     }
+    configurations.ktlint {
+        resolutionStrategy.force "org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.8.22"
+    }
 
     // https://aws.oss.sonatype.org/content/repositories/snapshots/org/opensearch/plugin/
     opensearchPlugin "org.opensearch.plugin:opensearch-job-scheduler:${job_scheduler_version}@zip"

diff --git a/detekt.yml b/detekt.yml
@@ -11,7 +11,7 @@ style:
   ForbiddenComment:
     active: false
   MaxLineLength:
-    maxLineLength: 150
+    maxLineLength: 160
     excludes: ['**/test/**']
   FunctionOnlyReturningConstant:
     active: false
@@ -20,6 +20,7 @@ complexity:
   LargeClass:
     excludes: ['**/test/**']
   LongMethod:
+    threshold: 80
     excludes: ['**/test/**']
   LongParameterList:
     excludes: ['**/test/**']

diff --git a/spi/src/main/kotlin/org.opensearch.indexmanagement.spi/IndexManagementExtension.kt b/spi/src/main/kotlin/org.opensearch.indexmanagement.spi/IndexManagementExtension.kt
@@ -14,7 +14,6 @@ import org.opensearch.indexmanagement.spi.indexstatemanagement.StatusChecker
  * SPI for IndexManagement
  */
 interface IndexManagementExtension {
-
     /**
      * List of action parsers that are supported by the extension, each of the action parser will parse the policy action into the defined action.
      * The ActionParser provides the ability to parse the action

diff --git a/spi/src/main/kotlin/org.opensearch.indexmanagement.spi/indexstatemanagement/Action.kt b/spi/src/main/kotlin/org.opensearch.indexmanagement.spi/indexstatemanagement/Action.kt
@@ -19,9 +19,8 @@ import java.time.Instant
 
 abstract class Action(
     val type: String,
-    val actionIndex: Int
+    val actionIndex: Int,
 ) : ToXContentObject, Writeable {
-
     var configTimeout: ActionTimeout? = null
     var configRetry: ActionRetry? = ActionRetry(DEFAULT_RETRIES)
     var customAction: Boolean = false

diff --git a/spi/src/main/kotlin/org.opensearch.indexmanagement.spi/indexstatemanagement/ActionParser.kt b/spi/src/main/kotlin/org.opensearch.indexmanagement.spi/indexstatemanagement/ActionParser.kt
@@ -9,7 +9,6 @@ import org.opensearch.core.common.io.stream.StreamInput
 import org.opensearch.core.xcontent.XContentParser
 
 abstract class ActionParser(var customAction: Boolean = false) {
-
     /**
      * The action type parser will parse
      */

diff --git a/...in/kotlin/org.opensearch.indexmanagement.spi/indexstatemanagement/IndexMetadataService.kt b/...in/kotlin/org.opensearch.indexmanagement.spi/indexstatemanagement/IndexMetadataService.kt
@@ -21,7 +21,6 @@ import org.opensearch.indexmanagement.spi.indexstatemanagement.model.ISMIndexMet
  * else uses the default i.e cluster state
  */
 interface IndexMetadataService {
-
     /**
      * Returns the index metadata needed for ISM
      */

diff --git a/spi/src/main/kotlin/org.opensearch.indexmanagement.spi/indexstatemanagement/StatusChecker.kt b/spi/src/main/kotlin/org.opensearch.indexmanagement.spi/indexstatemanagement/StatusChecker.kt
@@ -8,7 +8,6 @@ package org.opensearch.indexmanagement.spi.indexstatemanagement
 import org.opensearch.cluster.ClusterState
 
 interface StatusChecker {
-
     /**
      * checks and returns the status of the extension
      */
@@ -19,7 +18,8 @@ interface StatusChecker {
 
 enum class Status(private val value: String) {
     ENABLED("enabled"),
-    DISABLED("disabled");
+    DISABLED("disabled"),
+    ;
 
     override fun toString(): String {
         return value

diff --git a/spi/src/main/kotlin/org.opensearch.indexmanagement.spi/indexstatemanagement/Step.kt b/spi/src/main/kotlin/org.opensearch.indexmanagement.spi/indexstatemanagement/Step.kt
@@ -16,7 +16,6 @@ import java.time.Instant
 import java.util.Locale
 
 abstract class Step(val name: String, val isSafeToDisableOn: Boolean = true) {
-
     var context: StepContext? = null
         private set
 
@@ -56,7 +55,8 @@ abstract class Step(val name: String, val isSafeToDisableOn: Boolean = true) {
         STARTING("starting"),
         CONDITION_NOT_MET("condition_not_met"),
         FAILED("failed"),
-        COMPLETED("completed");
+        COMPLETED("completed"),
+        ;
 
         override fun toString(): String {
             return status

diff --git a/spi/src/main/kotlin/org.opensearch.indexmanagement.spi/indexstatemanagement/Validate.kt b/spi/src/main/kotlin/org.opensearch.indexmanagement.spi/indexstatemanagement/Validate.kt
@@ -6,19 +6,18 @@
 package org.opensearch.indexmanagement.spi.indexstatemanagement
 
 import org.opensearch.cluster.service.ClusterService
+import org.opensearch.common.settings.Settings
 import org.opensearch.core.common.io.stream.StreamInput
 import org.opensearch.core.common.io.stream.StreamOutput
 import org.opensearch.core.common.io.stream.Writeable
-import org.opensearch.common.settings.Settings
 import org.opensearch.monitor.jvm.JvmService
 import java.util.Locale
 
 abstract class Validate(
     val settings: Settings,
     val clusterService: ClusterService,
-    val jvmService: JvmService
+    val jvmService: JvmService,
 ) {
-
     var validationStatus = ValidationStatus.PASSED
     var validationMessage: String? = "Starting Validation"
 
@@ -27,7 +26,8 @@ abstract class Validate(
     enum class ValidationStatus(val status: String) : Writeable {
         PASSED("passed"),
         RE_VALIDATING("re_validating"),
-        FAILED("failed");
+        FAILED("failed"),
+        ;
 
         override fun toString(): String {
             return status

diff --git a/...in/kotlin/org.opensearch.indexmanagement.spi/indexstatemanagement/model/ActionMetaData.kt b/...in/kotlin/org.opensearch.indexmanagement.spi/indexstatemanagement/model/ActionMetaData.kt
@@ -5,17 +5,17 @@
 
 package org.opensearch.indexmanagement.spi.indexstatemanagement.model
 
+import org.opensearch.common.xcontent.LoggingDeprecationHandler
+import org.opensearch.common.xcontent.XContentType
 import org.opensearch.core.common.Strings
 import org.opensearch.core.common.io.stream.StreamInput
 import org.opensearch.core.common.io.stream.StreamOutput
 import org.opensearch.core.common.io.stream.Writeable
-import org.opensearch.common.xcontent.LoggingDeprecationHandler
 import org.opensearch.core.xcontent.NamedXContentRegistry
 import org.opensearch.core.xcontent.ToXContent
 import org.opensearch.core.xcontent.ToXContentFragment
 import org.opensearch.core.xcontent.XContentBuilder
 import org.opensearch.core.xcontent.XContentParser
-import org.opensearch.common.xcontent.XContentType
 import org.opensearch.core.xcontent.XContentParserUtils
 import org.opensearch.indexmanagement.spi.indexstatemanagement.model.ManagedIndexMetaData.Companion.NAME
 import org.opensearch.indexmanagement.spi.indexstatemanagement.model.ManagedIndexMetaData.Companion.START_TIME
@@ -29,9 +29,8 @@ data class ActionMetaData(
     val failed: Boolean,
     val consumedRetries: Int,
     val lastRetryTime: Long?,
-    val actionProperties: ActionProperties?
+    val actionProperties: ActionProperties?,
 ) : Writeable, ToXContentFragment {
-
     override fun writeTo(out: StreamOutput) {
         out.writeString(name)
         out.writeOptionalLong(startTime)
@@ -89,7 +88,7 @@ data class ActionMetaData(
                 requireNotNull(failed) { "$FAILED is null" },
                 requireNotNull(consumedRetries) { "$CONSUMED_RETRIES is null" },
                 lastRetryTime,
-                actionProperties
+                actionProperties,
             )
         }
 
@@ -139,7 +138,7 @@ data class ActionMetaData(
                 requireNotNull(failed) { "$FAILED is null" },
                 requireNotNull(consumedRetries) { "$CONSUMED_RETRIES is null" },
                 lastRetryTime,
-                actionProperties
+                actionProperties,
             )
         }
     }

diff --git a/.../kotlin/org.opensearch.indexmanagement.spi/indexstatemanagement/model/ActionProperties.kt b/.../kotlin/org.opensearch.indexmanagement.spi/indexstatemanagement/model/ActionProperties.kt
@@ -16,17 +16,17 @@ import org.opensearch.core.xcontent.XContentParser.Token
 import org.opensearch.core.xcontent.XContentParserUtils.ensureExpectedToken
 import org.opensearch.indexmanagement.spi.indexstatemanagement.addObject
 
-/** Properties that will persist across steps of a single Action. Will be stored in the [ActionMetaData]. */
 // TODO: Create namespaces to group properties together
+
+/** Properties that will persist across steps of a single Action. Will be stored in the [ActionMetaData]. */
 data class ActionProperties(
     val maxNumSegments: Int? = null,
     val snapshotName: String? = null,
     val rollupId: String? = null,
     val hasRollupFailed: Boolean? = null,
     val shrinkActionProperties: ShrinkActionProperties? = null,
-    val transformActionProperties: TransformActionProperties? = null
+    val transformActionProperties: TransformActionProperties? = null,
 ) : Writeable, ToXContentFragment {
-
     override fun writeTo(out: StreamOutput) {
         out.writeOptionalInt(maxNumSegments)
         out.writeOptionalString(snapshotName)
@@ -94,6 +94,6 @@ data class ActionProperties(
         MAX_NUM_SEGMENTS("max_num_segments"),
         SNAPSHOT_NAME("snapshot_name"),
         ROLLUP_ID("rollup_id"),
-        HAS_ROLLUP_FAILED("has_rollup_failed")
+        HAS_ROLLUP_FAILED("has_rollup_failed"),
     }
 }
diff --git a/.../main/kotlin/org.opensearch.indexmanagement.spi/indexstatemanagement/model/ActionRetry.kt b/.../main/kotlin/org.opensearch.indexmanagement.spi/indexstatemanagement/model/ActionRetry.kt
@@ -6,10 +6,10 @@
 package org.opensearch.indexmanagement.spi.indexstatemanagement.model
 
 import org.apache.logging.log4j.LogManager
+import org.opensearch.common.unit.TimeValue
 import org.opensearch.core.common.io.stream.StreamInput
 import org.opensearch.core.common.io.stream.StreamOutput
 import org.opensearch.core.common.io.stream.Writeable
-import org.opensearch.common.unit.TimeValue
 import org.opensearch.core.xcontent.ToXContent
 import org.opensearch.core.xcontent.ToXContentFragment
 import org.opensearch.core.xcontent.XContentBuilder
@@ -23,10 +23,11 @@ import kotlin.math.pow
 data class ActionRetry(
     val count: Long,
     val backoff: Backoff = Backoff.EXPONENTIAL,
-    val delay: TimeValue = TimeValue.timeValueMinutes(1)
+    val delay: TimeValue = TimeValue.timeValueMinutes(1),
 ) : ToXContentFragment, Writeable {
-
-    init { require(count >= 0) { "Count for ActionRetry must be a non-negative number" } }
+    init {
+        require(count >= 0) { "Count for ActionRetry must be a non-negative number" }
+    }
 
     override fun toXContent(builder: XContentBuilder, params: ToXContent.Params): XContentBuilder {
         builder
@@ -42,7 +43,7 @@ data class ActionRetry(
     constructor(sin: StreamInput) : this(
         count = sin.readLong(),
         backoff = sin.readEnum(Backoff::class.java),
-        delay = sin.readTimeValue()
+        delay = sin.readTimeValue(),
     )
 
     @Throws(IOException::class)
@@ -80,7 +81,7 @@ data class ActionRetry(
             return ActionRetry(
                 count = requireNotNull(count) { "ActionRetry count is null" },
                 backoff = backoff,
-                delay = delay
+                delay = delay,
             )
         }
     }
@@ -90,20 +91,21 @@ data class ActionRetry(
             "exponential",
             { consumedRetries, timeValue ->
                 (2.0.pow(consumedRetries - 1)).toLong() * timeValue.millis
-            }
+            },
         ),
         CONSTANT(
             "constant",
             { _, timeValue ->
                 timeValue.millis
-            }
+            },
         ),
         LINEAR(
             "linear",
             { consumedRetries, timeValue ->
                 consumedRetries * timeValue.millis
-            }
-        );
+            },
+        ),
+        ;
 
         private val logger = LogManager.getLogger(javaClass)
 
@@ -120,8 +122,9 @@ data class ActionRetry(
 
             if (actionMetaData.consumedRetries > 0) {
                 if (actionMetaData.lastRetryTime != null) {
-                    val remainingTime = getNextRetryTime(actionMetaData.consumedRetries, actionRetry.delay) -
-                        (Instant.now().toEpochMilli() - actionMetaData.lastRetryTime)
+                    val remainingTime =
+                        getNextRetryTime(actionMetaData.consumedRetries, actionRetry.delay) -
+                            (Instant.now().toEpochMilli() - actionMetaData.lastRetryTime)
 
                     return Pair(remainingTime > 0, remainingTime)
                 }

diff --git a/...ain/kotlin/org.opensearch.indexmanagement.spi/indexstatemanagement/model/ActionTimeout.kt b/...ain/kotlin/org.opensearch.indexmanagement.spi/indexstatemanagement/model/ActionTimeout.kt
@@ -5,25 +5,24 @@
 
 package org.opensearch.indexmanagement.spi.indexstatemanagement.model
 
+import org.opensearch.common.unit.TimeValue
 import org.opensearch.core.common.io.stream.StreamInput
 import org.opensearch.core.common.io.stream.StreamOutput
 import org.opensearch.core.common.io.stream.Writeable
-import org.opensearch.common.unit.TimeValue
 import org.opensearch.core.xcontent.ToXContent
 import org.opensearch.core.xcontent.ToXContentFragment
 import org.opensearch.core.xcontent.XContentBuilder
 import org.opensearch.core.xcontent.XContentParser
 import java.io.IOException
 
 data class ActionTimeout(val timeout: TimeValue) : ToXContentFragment, Writeable {
-
     override fun toXContent(builder: XContentBuilder, params: ToXContent.Params): XContentBuilder {
         return builder.field(TIMEOUT_FIELD, timeout.stringRep)
     }
 
     @Throws(IOException::class)
     constructor(sin: StreamInput) : this(
-        timeout = sin.readTimeValue()
+        timeout = sin.readTimeValue(),
     )
 
     @Throws(IOException::class)
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,7 +9,6 @@ import org.opensearch.core.common.io.stream.StreamInput @@
     import org.opensearch.core.xcontent.XContentParser
     abstract class ActionParser(var customAction: Boolean = false) {
         /**
          * The action type parser will parse
          */
@@ Expand Down @@