добавлены правила для детекта

m.zharinova · m.zharinova · commit 9d4d5381cd0b · 2025-05-16T11:24:37.000+05:00
diff --git a/buildSrc/src/main/kotlin/sb-ot-demo.kotlin-conventions.gradle.kts b/buildSrc/src/main/kotlin/sb-ot-demo.kotlin-conventions.gradle.kts
@@ -41,6 +41,7 @@ detekt {
     toolVersion = versionCatalog.findVersion("detekt").get().requiredVersion
     config.setFrom(file("${rootDir}/config/detekt/detekt.yml"))
     buildUponDefaultConfig = true
+    autoCorrect = true
 }
 
 tasks {
diff --git a/config/detekt/detekt.yml b/config/detekt/detekt.yml
@@ -2,6 +2,219 @@ performance:
     SpreadOperator:
         active: false
 
+formatting:
+    active: true
+    android: false
+    AnnotationOnSeparateLine:
+        active: false
+    ChainWrapping:
+        active: true
+    CommentSpacing:
+        active: true
+    Filename:
+        active: true
+    FinalNewline:
+        active: true
+    ImportOrdering:
+        active: false
+    Indentation:
+        active: true
+        indentSize: 4
+        # continuationIndentSize: 4
+    MaximumLineLength:
+        active: true
+        maxLineLength: 240
+    ModifierOrdering:
+        active: true
+    MultiLineIfElse:
+        active: true
+    NoBlankLineBeforeRbrace:
+        active: true
+    NoConsecutiveBlankLines:
+        active: true
+    NoEmptyClassBody:
+        active: true
+    NoLineBreakAfterElse:
+        active: true
+    NoLineBreakBeforeAssignment:
+        active: true
+    NoMultipleSpaces:
+        active: true
+    NoSemicolons:
+        active: true
+    NoTrailingSpaces:
+        active: true
+    NoUnitReturn:
+        active: true
+    NoUnusedImports:
+        active: true
+    NoWildcardImports:
+        active: true
+    PackageName:
+        active: true
+    ParameterListWrapping:
+        active: true
+        # indentSize: 4
+    SpacingAroundColon:
+        active: true
+    SpacingAroundComma:
+        active: true
+    SpacingAroundCurly:
+        active: true
+    SpacingAroundDot:
+        active: true
+    SpacingAroundKeyword:
+        active: true
+    SpacingAroundOperators:
+        active: true
+    SpacingAroundParens:
+        active: true
+    SpacingAroundRangeOperator:
+        active: true
+    StringTemplate:
+        active: true
+
 style:
+    active: true
+    CollapsibleIfStatements:
+        active: false
+    DataClassContainsFunctions:
+        active: false
+        conversionFunctionPrefix: ['to']
+    DataClassShouldBeImmutable:
+        active: false
+    EqualsNullCall:
+        active: true
+    EqualsOnSignatureLine:
+        active: false
+    ExplicitItLambdaParameter:
+        active: false
+    ExpressionBodySyntax:
+        active: false
+        includeLineWrapping: false
+    ForbiddenComment:
+        active: false
+        comments: [ 'TODO:','FIXME:','STOPSHIP:' ]
+        allowedPatterns: ""
+    ForbiddenImport:
+        active: false
+        imports: [ ]
+        forbiddenPatterns: ""
+    ForbiddenVoid:
+        active: false
+        ignoreOverridden: false
+        ignoreUsageInGenerics: false
+    FunctionOnlyReturningConstant:
+        active: true
+        ignoreOverridableFunction: true
+        excludedFunctions: [ 'describeContents' ]
+    LoopWithTooManyJumpStatements:
+        active: true
+        maxJumpCount: 1
+    MagicNumber:
+        active: true
+        excludes: [ "**/test/**","**/*.Test.kt","**/*.Spec.kt","**/*.Spek.kt","**/*Properties.kt","**/*Configuration.kt" ]
+        ignoreNumbers: [ '-1','0','1','2' ]
+        ignoreHashCodeFunction: true
+        ignorePropertyDeclaration: false
+        ignoreLocalVariableDeclaration: false
+        ignoreConstantDeclaration: true
+        ignoreCompanionObjectPropertyDeclaration: true
+        ignoreAnnotation: false
+        ignoreNamedArgument: true
+        ignoreEnums: false
+        ignoreRanges: false
     MaxLineLength:
-        maxLineLength: 200
+        active: true
+        maxLineLength: 240
+        excludePackageStatements: true
+        excludeImportStatements: true
+        excludeCommentStatements: false
+    MayBeConst:
+        active: true
+    ModifierOrder:
+        active: true
+    NestedClassesVisibility:
+        active: false
+    NewLineAtEndOfFile:
+        active: true
+    NoTabs:
+        active: true
+    OptionalAbstractKeyword:
+        active: true
+    OptionalUnit:
+        active: false
+    PreferToOverPairSyntax:
+        active: true
+    ProtectedMemberInFinalClass:
+        active: true
+    RedundantExplicitType:
+        active: false
+    RedundantVisibilityModifierRule:
+        active: true
+    ReturnCount:
+        active: true
+        max: 2
+        excludedFunctions: [ "equals" ]
+        excludeLabeled: false
+        excludeReturnFromLambda: true
+        excludeGuardClauses: false
+    SafeCast:
+        active: true
+    SerialVersionUIDInSerializableClass:
+        active: false
+    SpacingBetweenPackageAndImports:
+        active: false
+    ThrowsCount:
+        active: true
+        max: 2
+    TrailingWhitespace:
+        active: false
+    UnderscoresInNumericLiterals:
+        active: false
+        acceptableLength: 5
+    UnnecessaryAbstractClass:
+        active: false
+    UnnecessaryApply:
+        active: false
+    UnnecessaryInheritance:
+        active: true
+    UnnecessaryLet:
+        active: false
+    UnnecessaryParentheses:
+        active: false
+    UntilInsteadOfRangeTo:
+        active: false
+    UnusedImports:
+        active: true
+    UnusedPrivateClass:
+        active: true
+    UnusedPrivateMember:
+        active: true
+        allowedNames: "(_|ignored|expected|serialVersionUID)"
+    UseArrayLiteralsInAnnotations:
+        active: false
+    UseCheckOrError:
+        active: false
+    UseDataClass:
+        active: false
+        ignoreAnnotated: [ ]
+        allowVars: false
+    UseIfInsteadOfWhen:
+        active: false
+    UseRequire:
+        active: false
+    UselessCallOnNotNull:
+        active: true
+    UtilityClassWithPublicConstructor:
+        active: true
+    VarCouldBeVal:
+        active: false
+    WildcardImport:
+        active: true
+
+libraries:
+    LibraryEntitiesShouldNotBePublic:
+        active: false
+    ForbiddenPublicDataClass:
+        active: false
diff --git a/spring-boot-3-demo-app-kotlin/src/main/kotlin/io/github/mfvanek/spring/boot3/kotlin/test/service/PublicApiService.kt b/spring-boot-3-demo-app-kotlin/src/main/kotlin/io/github/mfvanek/spring/boot3/kotlin/test/service/PublicApiService.kt
@@ -59,7 +59,8 @@ class PublicApiService(
             .doBeforeRetry { retrySignal: Retry.RetrySignal ->
                 withLoggingContext("instance_timezone" to zoneName) {
                     logger.info {
-                        "Retrying request to '/$zoneName', attempt ${retrySignal.totalRetries() + 1}/$retries due to error: ${retrySignal.failure()}"
+                        "Retrying request to '/$zoneName', attempt ${retrySignal.totalRetries() + 1}/$retries " +
+                            "due to error: ${retrySignal.failure()}"
                     }
                 }
             }
diff --git a/spring-boot-3-demo-app-kotlin/src/test/kotlin/io/github/mfvanek/spring/boot3/kotlin/test/ActuatorEndpointTest.kt b/spring-boot-3-demo-app-kotlin/src/test/kotlin/io/github/mfvanek/spring/boot3/kotlin/test/ActuatorEndpointTest.kt
@@ -37,8 +37,12 @@ class ActuatorEndpointTest : TestBase() {
 
     @ParameterizedTest
     @CsvSource(
-        value = ["prometheus|jvm_threads_live_threads|text/plain", "health|{\"status\":\"UP\",\"groups\":[\"liveness\",\"readiness\"]}|application/json",
-            "health/liveness|{\"status\":\"UP\"}|application/json", "health/readiness|{\"status\":\"UP\"}|application/json", "info|\"version\":|application/json"],
+        value = [
+            "prometheus|jvm_threads_live_threads|text/plain",
+            "health|{\"status\":\"UP\",\"groups\":[\"liveness\",\"readiness\"]}|application/json",
+            "health/liveness|{\"status\":\"UP\"}|application/json",
+            "health/readiness|{\"status\":\"UP\"}|application/json", "info|\"version\":|application/json"
+        ],
         delimiter = '|'
     )
     fun actuatorEndpointShouldReturnOk(
diff --git a/spring-boot-3-demo-app-kotlin/src/test/kotlin/io/github/mfvanek/spring/boot3/kotlin/test/ApplicationTests.kt b/spring-boot-3-demo-app-kotlin/src/test/kotlin/io/github/mfvanek/spring/boot3/kotlin/test/ApplicationTests.kt
@@ -7,14 +7,16 @@ import io.micrometer.tracing.Span
 import io.micrometer.tracing.Tracer
 import io.micrometer.tracing.otel.bridge.OtelTracer
 import io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter
-import org.assertj.core.api.Assertions.*
+import java.util.Locale
+import org.assertj.core.api.Assertions.assertThat
+import org.assertj.core.api.Assertions.assertThatNoException
+import org.assertj.core.api.Assertions.assertThatThrownBy
 import org.assertj.core.api.ThrowingConsumer
 import org.junit.jupiter.api.DisplayName
 import org.junit.jupiter.api.Test
 import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.context.ApplicationContext
 import org.springframework.dao.DataAccessResourceFailureException
-import java.util.*
 
 class ApplicationTests : TestBase() {
     @Autowired
@@ -30,18 +32,22 @@ class ApplicationTests : TestBase() {
         assertThat(applicationContext.getBean(Tracer::class.java))
             .isNotNull()
             .isInstanceOf(OtelTracer::class.java)
-            .satisfies(ThrowingConsumer { t: Tracer ->
-                assertThat(t.currentSpan())
-                    .isNotEqualTo(Span.NOOP)
-            })
+            .satisfies(
+                ThrowingConsumer { t: Tracer ->
+                    assertThat(t.currentSpan())
+                        .isNotEqualTo(Span.NOOP)
+                }
+            )
         assertThat(applicationContext.getBean("otelJaegerGrpcSpanExporter"))
             .isNotNull()
             .isInstanceOf(OtlpGrpcSpanExporter::class.java)
             .hasToString(
                 String.format(
-                    Locale.ROOT, """
-                OtlpGrpcSpanExporter{exporterName=otlp, type=span, endpoint=http://localhost:%d, endpointPath=/opentelemetry.proto.collector.trace.v1.TraceService/Export, timeoutNanos=5000000000, connectTimeoutNanos=10000000000, compressorEncoding=null, headers=Headers{User-Agent=OBFUSCATED}, retryPolicy=RetryPolicy{maxAttempts=5, initialBackoff=PT1S, maxBackoff=PT5S, backoffMultiplier=1.5}, memoryMode=IMMUTABLE_DATA}
-                """.trimIndent(), JaegerInitializer.getFirstMappedPort()
+                    Locale.ROOT,
+                    """
+                    OtlpGrpcSpanExporter{exporterName=otlp, type=span, endpoint=http://localhost:%d, endpointPath=/opentelemetry.proto.collector.trace.v1.TraceService/Export, timeoutNanos=5000000000, connectTimeoutNanos=10000000000, compressorEncoding=null, headers=Headers{User-Agent=OBFUSCATED}, retryPolicy=RetryPolicy{maxAttempts=5, initialBackoff=PT1S, maxBackoff=PT5S, backoffMultiplier=1.5}, memoryMode=IMMUTABLE_DATA}
+                    """.trimIndent(),
+                    JaegerInitializer.getFirstMappedPort()
                 )
             )
     }
diff --git a/spring-boot-3-demo-app-kotlin/src/test/kotlin/io/github/mfvanek/spring/boot3/kotlin/test/controllers/TimeControllerTest.kt b/spring-boot-3-demo-app-kotlin/src/test/kotlin/io/github/mfvanek/spring/boot3/kotlin/test/controllers/TimeControllerTest.kt
@@ -4,6 +4,15 @@ import io.github.mfvanek.spring.boot3.kotlin.test.filters.TraceIdInResponseServl
 import io.github.mfvanek.spring.boot3.kotlin.test.service.dto.toParsedDateTime
 import io.github.mfvanek.spring.boot3.kotlin.test.support.KafkaInitializer
 import io.github.mfvanek.spring.boot3.kotlin.test.support.TestBase
+import java.nio.charset.StandardCharsets
+import java.time.Duration
+import java.time.LocalDateTime
+import java.time.temporal.ChronoUnit
+import java.util.Locale
+import java.util.UUID
+import java.util.concurrent.BlockingQueue
+import java.util.concurrent.LinkedBlockingQueue
+import java.util.concurrent.TimeUnit
 import org.apache.kafka.clients.CommonClientConfigs
 import org.apache.kafka.clients.consumer.ConsumerConfig
 import org.apache.kafka.clients.consumer.ConsumerRecord
@@ -29,15 +38,6 @@ import org.springframework.kafka.listener.MessageListener
 import org.springframework.kafka.test.utils.ContainerTestUtils
 import org.springframework.kafka.test.utils.KafkaTestUtils
 import org.testcontainers.shaded.org.awaitility.Awaitility
-import java.nio.charset.StandardCharsets
-import java.time.Duration
-import java.time.LocalDateTime
-import java.time.temporal.ChronoUnit
-import java.util.Locale
-import java.util.UUID
-import java.util.concurrent.BlockingQueue
-import java.util.concurrent.LinkedBlockingQueue
-import java.util.concurrent.TimeUnit
 
 @ExtendWith(OutputCaptureExtension::class)
 @TestInstance(TestInstance.Lifecycle.PER_CLASS)
@@ -119,7 +119,8 @@ class TimeControllerTest : TestBase() {
             .containsPattern(
                 String.format(
                     Locale.ROOT,
-                    ".*\"message\":\"Request to '/%s' failed after 2 attempts.\",\"logger\":\"io\\.github\\.mfvanek\\.spring\\.boot3\\.kotlin\\.test\\.service\\.PublicApiService\"," +
+                    ".*\"message\":\"Request to '/%s' failed after 2 attempts.\"," +
+                        "\"logger\":\"io\\.github\\.mfvanek\\.spring\\.boot3\\.kotlin\\.test\\.service\\.PublicApiService\"," +
                         "\"thread\":\"[^\"]+\",\"level\":\"ERROR\"," +
                         "\"traceId\":\"38c19768104ab8ae64fabbeed65bbbdf\",\"spanId\":\"[a-f0-9]+\",\"applicationName\":\"spring-boot-3-demo-app\"\\}%n",
                     zoneName
@@ -128,13 +129,13 @@ class TimeControllerTest : TestBase() {
             .containsPattern(
                 String.format(
                     Locale.ROOT,
-                    ".*\"message\":\"Request to '/%s' failed after 2 attempts.\",\"logger\":\"io\\.github\\.mfvanek\\.spring\\.boot3\\.kotlin\\.test\\.service\\.PublicApiService\"," +
+                    ".*\"message\":\"Request to '/%s' failed after 2 attempts.\"," +
+                        "\"logger\":\"io\\.github\\.mfvanek\\.spring\\.boot3\\.kotlin\\.test\\.service\\.PublicApiService\"," +
                         "\"thread\":\"[^\"]+\",\"level\":\"ERROR\"," +
                         "\"traceId\":\"38c19768104ab8ae64fabbeed65bbbdf\",\"spanId\":\"[a-f0-9]+\",\"applicationName\":\"spring-boot-3-demo-app\"\\}%n",
                     zoneName
                 ).toPattern()
             )
-
     }
 
     @Order(3)
@@ -161,12 +162,12 @@ class TimeControllerTest : TestBase() {
     }
 
     private fun assertThatTraceIdPresentInKafkaHeaders(received: ConsumerRecord<UUID, String>, expectedTraceId: String) {
-        assertThat(received.value()).startsWith("Current time = ");
+        assertThat(received.value()).startsWith("Current time = ")
         val headers = received.headers().toArray()
         val headerNames = headers.map { it.key() }
         assertThat(headerNames)
             .hasSize(2)
-            .containsExactlyInAnyOrder("traceparent", "b3");
+            .containsExactlyInAnyOrder("traceparent", "b3")
         val headerValues = headers
             .map { String(it.value(), StandardCharsets.UTF_8) }
         assertThat(headerValues)
@@ -185,7 +186,7 @@ class TimeControllerTest : TestBase() {
 
 private fun setUpKafkaConsumer(kafkaProperties: KafkaProperties, consumerRecords: BlockingQueue<ConsumerRecord<UUID, String>>): KafkaMessageListenerContainer<UUID, String> {
     val containerProperties = ContainerProperties(kafkaProperties.template.defaultTopic)
-    val consumerProperties = KafkaTestUtils.consumerProps(KafkaInitializer.getBootstrapSevers(), "test-group", "false");
+    val consumerProperties = KafkaTestUtils.consumerProps(KafkaInitializer.getBootstrapSevers(), "test-group", "false")
     consumerProperties[CommonClientConfigs.SECURITY_PROTOCOL_CONFIG] = "SASL_PLAINTEXT"
     consumerProperties[SaslConfigs.SASL_MECHANISM] = "PLAIN"
     consumerProperties[SaslConfigs.SASL_JAAS_CONFIG] = KafkaInitializer.plainJaas()
diff --git a/spring-boot-3-demo-app-kotlin/src/test/kotlin/io/github/mfvanek/spring/boot3/kotlin/test/service/PublicApiServiceTest.kt b/spring-boot-3-demo-app-kotlin/src/test/kotlin/io/github/mfvanek/spring/boot3/kotlin/test/service/PublicApiServiceTest.kt
diff --git a/spring-boot-3-demo-app-kotlin/src/test/kotlin/io/github/mfvanek/spring/boot3/kotlin/test/support/KafkaInitializer.kt b/spring-boot-3-demo-app-kotlin/src/test/kotlin/io/github/mfvanek/spring/boot3/kotlin/test/support/KafkaInitializer.kt

Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,7 @@ detekt {`
`41`	`41`	`toolVersion = versionCatalog.findVersion("detekt").get().requiredVersion`
`42`	`42`	`config.setFrom(file("${rootDir}/config/detekt/detekt.yml"))`
`43`	`43`	`buildUponDefaultConfig = true`
	`44`	`+ autoCorrect = true`
`44`	`45`	`}`
`45`	`46`
`46`	`47`	`tasks {`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,8 @@ class PublicApiService(`
`59`	`59`	`.doBeforeRetry { retrySignal: Retry.RetrySignal ->`
`60`	`60`	`withLoggingContext("instance_timezone" to zoneName) {`
`61`	`61`	`logger.info {`
`62`		`- "Retrying request to '/$zoneName', attempt ${retrySignal.totalRetries() + 1}/$retries due to error: ${retrySignal.failure()}"`
	`62`	`+ "Retrying request to '/$zoneName', attempt ${retrySignal.totalRetries() + 1}/$retries " +`
	`63`	`+ "due to error: ${retrySignal.failure()}"`
`63`	`64`	`}`
`64`	`65`	`}`
`65`	`66`	`}`