Deprecate configuration of reports in detekt Gradle extension #3687

3flex · 2021-04-19T13:42:41Z

Reports need to be configured on tasks directly, not by using the detekt extension.

This is to avoid setting the same destination path for multiple detekt reports. An example of this can be seen in the detektTest task of this build scan where the html report is written to the same path as the report generated by the detektMain task because both tasks get the destination path from the extension.

I will add a new section to the Gradle config doc and link to it from the deprecation message on the extension once the PR has been reviewed.

Fixes: #3926
Fixes: #4035
Fixes: #4044
Edit by @cortinico - Added fix issue reference

codecov · 2021-04-19T14:03:41Z

Codecov Report

Merging #3687 (183eaa4) into main (1a2ca4b) will decrease coverage by 0.00%.
The diff coverage is n/a.

❗ Current head 183eaa4 differs from pull request most recent head 00f8a2a. Consider uploading reports for the commit 00f8a2a to get more accurate results

@@             Coverage Diff              @@
##               main    #3687      +/-   ##
============================================
- Coverage     83.58%   83.58%   -0.01%     
+ Complexity     3187     3186       -1     
============================================
  Files           459      459              
  Lines          9101     9099       -2     
  Branches       1772     1772              
============================================
- Hits           7607     7605       -2     
  Misses          561      561              
  Partials        933      933

Impacted Files	Coverage Δ
...otlin/io/gitlab/arturbosch/detekt/api/MultiRule.kt	`100.00% <0.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1a2ca4b...00f8a2a. Read the comment docs.

BraisGabin · 2021-04-19T16:30:27Z

docs/pages/gettingstarted/gradle.md

-            reportId = "CustomJsonReport"                   
-            destination = file("build/reports/detekt.json")
-        }
-    }


How do I enable/disable some reports now? And should we talk about reportsDir here? Or is it a default in gradle so we don't need to?

All report config is done on the task, so you would enable/disable reports either on the individual task level or using withType. That's the doc section I need to write.

reportsDir is used in Gradle for other code quality plugins so we'd now follow that convention. I can mention that in the doc and remove references to the deprecated option (I didn't search to see if there are any yet)

BraisGabin · 2021-04-21T12:39:54Z

...kt-gradle-plugin/src/main/kotlin/io/gitlab/arturbosch/detekt/internal/DetektMultiplatform.kt

+                                    File(extension.reportsDir, compilation.name + ".sarif").absolutePath
+                                }
+                            )
+                        )


would it be possible to extract this to a function/extension function so we should need to pass the name and it will configure all the reports? We have a lot of duplicated code between Multiplatform, JVM and Android (not only this)

And, should we change Plain too?

Plain is OK because it defers to the default report path set in the task if the report destination (or now, the outputLocation) is not set (it's an odd exception because the task isn't setup the same way as the others but at least it works):

detekt/detekt-gradle-plugin/src/main/kotlin/io/gitlab/arturbosch/detekt/Detekt.kt

Lines 270 to 273 in da8676d

if (isEnabled) {

val destination = report.destination ?: reportsDir.getOrElse(defaultReportsDir.asFile)

.resolve("${DetektReport.DEFAULT_FILENAME}.${report.type.extension}")

provider.set(destination)

There's a fair bit of refactoring that can be done in the plugin, lots of which is easier once we're on Gradle 6.1. I'd prefer to wait until then before fixing up the repetition.

chao2zhang · 2021-04-22T16:10:05Z

detekt-gradle-plugin/src/main/kotlin/io/gitlab/arturbosch/detekt/extensions/DetektExtension.kt

+    @Suppress("DeprecatedCallableAddReplaceWith", "DEPRECATION")
+    @Deprecated("Customise the reports on the Detekt task(s) instead.", level = DeprecationLevel.WARNING)
    fun reports(configure: Action<DetektReports>) = configure.execute(reports)


In the DetektExtension, will it make sense to keep the enabling flags for each report type? My assumptions are:

Fewer users are configuring the report output location

More users are configuring whether to keep txt/xml/html/sarif.

I understand your point, but in Gradle reports are configured on tasks, not on the extension. That's what's done for CodeNarc, Checkstyle and PMD extensions, and that intention is made explicit in the docs:

Things that produce reports (typically tasks) expose a report container that contains Report objects for each possible report that they can produce.

reference

We can't implement ReportContainer directly but in keeping with that convention (and slightly simplifying the plugin) I still think it should be removed.

3flex · 2021-05-05T00:48:43Z

Any other concerns on this before merging? I'd only suggest waiting until after 1.17 release now some RCs have been published.

BraisGabin · 2021-05-05T07:31:42Z

Agree, we should wait until 1.17.0 is released.

3flex · 2021-05-25T12:04:07Z

LGTM?

cortinico

Can we please extend a bit on the documentation for this PR?

Specifically we're deprecating a property that is suggested to use in our README and in the homepage of the website: https://detekt.github.io/detekt/ Therefore we should provide clear alternatives to our users.

Potentially also a migration page should be added as well.

cortinico · 2021-07-22T20:41:56Z

Should we push this to 1.19.0?

3flex · 2021-07-24T02:38:51Z

Yeah sorry I haven't had time to dedicate to this recently. Happy to push it back.

I'll need to rebase and still write some docs.

3flex · 2021-08-21T03:47:51Z

Rebased & docs updated. I believe I've updated all sections where the deprecated configuration was used, except the old "News" posts.

Migration instructions were added to the changelog.

BraisGabin

I'd vote to split this PR in two. One with code and chancellor and the other with the doc. Otherwise the users will see a "too updated" documentation untilnwe release 1.19

Doc update for detekt#3687

3flex · 2021-08-21T11:58:25Z

Time for versioned docs? :)

I've split them up - doc updates in #4064. I've left the changelog & migration update in this PR because the changelog is versioned so it's clear that it's related to unreleased changes.

detekt-gradle-plugin/src/main/kotlin/io/gitlab/arturbosch/detekt/extensions/DetektExtension.kt

This is unnecessary as it just returns the value of reportsDir

This matches the property names & types used in Gradle's code quality plugins.

BraisGabin · 2021-09-11T13:31:38Z

Is there something missing here? Can we merge this? This is a big change fot 1.19.0 so I think that as soon as we merge it as better. Someone using the SNAPSHOT can find some issue or we can find some issue while developing the tool itself.

cortinico · 2021-09-13T12:46:01Z

☝️ Agree. I believe we're good to go for merging this

Doc update for detekt#3687 # Conflicts: # docs/pages/gettingstarted/gradle.md

Doc update for #3687 # Conflicts: # docs/pages/gettingstarted/gradle.md

3flex force-pushed the reports-dsl branch from 34270cc to d20aeb8 Compare April 19, 2021 13:47

3flex mentioned this pull request Apr 19, 2021

Paralellize tasks detektMain and detektTest #3682

Closed

BraisGabin reviewed Apr 19, 2021

View reviewed changes

BraisGabin reviewed Apr 21, 2021

View reviewed changes

3flex force-pushed the reports-dsl branch from 6f7b7ab to d3968c3 Compare April 21, 2021 13:10

BraisGabin approved these changes Apr 21, 2021

View reviewed changes

3flex force-pushed the reports-dsl branch from e6f59fb to 5c46b27 Compare April 22, 2021 11:59

chao2zhang reviewed Apr 22, 2021

View reviewed changes

chao2zhang added this to the 1.17.0 milestone Apr 26, 2021

BraisGabin removed this from the 1.17.0 milestone May 5, 2021

3flex added this to the 1.18 milestone May 14, 2021

3flex force-pushed the reports-dsl branch from 5c46b27 to 2642d23 Compare May 15, 2021 13:29

cortinico added gradle-plugin notable changes Marker for notable changes in the changelog labels May 20, 2021

3flex force-pushed the reports-dsl branch from 2642d23 to 95e77cd Compare May 21, 2021 13:01

BraisGabin approved these changes May 25, 2021

View reviewed changes

cortinico reviewed May 25, 2021

View reviewed changes

cortinico mentioned this pull request Jun 19, 2021

Cannot configure Detekt task options individually #3866

Closed

BraisGabin modified the milestones: 1.18.0, 1.19.0 Jul 24, 2021

cortinico mentioned this pull request Aug 9, 2021

Detekt final report name is weird #3926

Closed

3flex mentioned this pull request Aug 16, 2021

DetektMain doesn't work as expected in Android projects #4044

Closed

3flex force-pushed the reports-dsl branch 2 times, most recently from 7d7d7fe to 99fa293 Compare August 21, 2021 03:44

BraisGabin approved these changes Aug 21, 2021

View reviewed changes

3flex added a commit to 3flex/detekt that referenced this pull request Aug 21, 2021

Document report output customization for Gradle tasks

0a2fc06

Doc update for detekt#3687

3flex force-pushed the reports-dsl branch from 99fa293 to 14a01b1 Compare August 21, 2021 11:57

3flex mentioned this pull request Aug 21, 2021

Document report output customization for Gradle tasks #4064

Merged

cortinico reviewed Aug 21, 2021

View reviewed changes

detekt-gradle-plugin/src/main/kotlin/io/gitlab/arturbosch/detekt/extensions/DetektExtension.kt Show resolved Hide resolved

cortinico approved these changes Aug 30, 2021

View reviewed changes

3flex added 6 commits September 9, 2021 22:37

Deprecate configuration of reports in detekt extension

e4da225

Deprecate customReportsDir

68af190

This is unnecessary as it just returns the value of reportsDir

Introduce required and outputLocation report properties

bad21fa

This matches the property names & types used in Gradle's code quality plugins.

Fix issues detected by detekt

74ebf77

Add changelog and migration guide for reporting changes

fd2c33c

Add warning when outputLocation set on detekt extension

00f8a2a

3flex force-pushed the reports-dsl branch from 053f3ab to 00f8a2a Compare September 9, 2021 12:38

3flex merged commit bbbbd25 into detekt:main Sep 17, 2021

3flex deleted the reports-dsl branch September 17, 2021 01:17

3flex added a commit to 3flex/detekt that referenced this pull request Nov 29, 2021

Document report output customization for Gradle tasks

0c9f143

Doc update for detekt#3687 # Conflicts: # docs/pages/gettingstarted/gradle.md

BraisGabin pushed a commit that referenced this pull request Nov 29, 2021

Document report output customization for Gradle tasks (#4064)

bfb049b

Doc update for #3687 # Conflicts: # docs/pages/gettingstarted/gradle.md

yeikel mentioned this pull request Oct 5, 2022

buil(deps): Bump detekt from 1.18.0 to 1.21.0 oshai/kotlin-logging#246

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate configuration of reports in detekt Gradle extension #3687

Deprecate configuration of reports in detekt Gradle extension #3687

3flex commented Apr 19, 2021 •

edited

Loading

codecov bot commented Apr 19, 2021 •

edited

Loading

BraisGabin Apr 19, 2021

3flex Apr 19, 2021

BraisGabin Apr 21, 2021

BraisGabin Apr 21, 2021

3flex Apr 21, 2021 •

edited

Loading

chao2zhang Apr 22, 2021

3flex Apr 23, 2021

3flex commented May 5, 2021

BraisGabin commented May 5, 2021

3flex commented May 25, 2021

cortinico left a comment •

edited

Loading

cortinico commented Jul 22, 2021

3flex commented Jul 24, 2021

3flex commented Aug 21, 2021

BraisGabin left a comment

3flex commented Aug 21, 2021

BraisGabin commented Sep 11, 2021

cortinico commented Sep 13, 2021

	if (isEnabled) {
	val destination = report.destination ?: reportsDir.getOrElse(defaultReportsDir.asFile)
	.resolve("${DetektReport.DEFAULT_FILENAME}.${report.type.extension}")
	provider.set(destination)

Deprecate configuration of reports in detekt Gradle extension #3687

Deprecate configuration of reports in detekt Gradle extension #3687

Conversation

3flex commented Apr 19, 2021 • edited Loading

codecov bot commented Apr 19, 2021 • edited Loading

Codecov Report

BraisGabin Apr 19, 2021

Choose a reason for hiding this comment

3flex Apr 19, 2021

Choose a reason for hiding this comment

BraisGabin Apr 21, 2021

Choose a reason for hiding this comment

BraisGabin Apr 21, 2021

Choose a reason for hiding this comment

3flex Apr 21, 2021 • edited Loading

Choose a reason for hiding this comment

chao2zhang Apr 22, 2021

Choose a reason for hiding this comment

3flex Apr 23, 2021

Choose a reason for hiding this comment

3flex commented May 5, 2021

BraisGabin commented May 5, 2021

3flex commented May 25, 2021

cortinico left a comment • edited Loading

Choose a reason for hiding this comment

cortinico commented Jul 22, 2021

3flex commented Jul 24, 2021

3flex commented Aug 21, 2021

BraisGabin left a comment

Choose a reason for hiding this comment

3flex commented Aug 21, 2021

BraisGabin commented Sep 11, 2021

cortinico commented Sep 13, 2021

3flex commented Apr 19, 2021 •

edited

Loading

codecov bot commented Apr 19, 2021 •

edited

Loading

3flex Apr 21, 2021 •

edited

Loading

cortinico left a comment •

edited

Loading