vanniktech / gradle-code-quality-tools-plugin Goto Github PK

Hi!
I am going to upgrade my project to Gradle 8 and I am interested to know does the plugins support Gradle 8?

https://github.com/amaembo/huntbugs

I've added the plugin to my build.gradle file. Now I'm a bit at a loss on what to do next. From an other issue here I gathered that this plugin hooks into the check task. Also I expected some new tasks in ./gradlew tasks --all. But I see nothing particular.

How am I supposed to kick this off?

The output of ./gradlew tasks --all:

./gradlew tasks --all                                                                                                                                                                                                         0/0.61
:tasks

------------------------------------------------------------
All tasks runnable from root project
------------------------------------------------------------

Application tasks
-----------------
bootRun - Run the project with support for auto-detecting main class and reloading static resources

Build tasks
-----------
assemble - Assembles the outputs of this project.
bootRepackage - Repackage existing JAR and WAR archives so that they can be executed from the command line using 'java -jar'
build - Assembles and tests this project.
buildDependents - Assembles and tests this project and all projects that depend on it.
buildNeeded - Assembles and tests this project and all projects it depends on.
classes - Assembles main classes.
clean - Deletes the build directory.
jar - Assembles a jar archive containing the main classes.
testClasses - Assembles test classes.

Build Setup tasks
-----------------
init - Initializes a new Gradle build. [incubating]
wrapper - Generates Gradle wrapper files. [incubating]

Documentation tasks
-------------------
javadoc - Generates Javadoc API documentation for the main source code.

Help tasks
----------
buildEnvironment - Displays all buildscript dependencies declared in root project 'bslegacy'.
components - Displays the components produced by root project 'bslegacy'. [incubating]
dependencies - Displays all dependencies declared in root project 'bslegacy'.
dependencyInsight - Displays the insight into a specific dependency in root project 'bslegacy'.
dependentComponents - Displays the dependent components of components in root project 'bslegacy'. [incubating]
help - Displays a help message.
model - Displays the configuration model of root project 'bslegacy'. [incubating]
projects - Displays the sub-projects of root project 'bslegacy'.
properties - Displays the properties of root project 'bslegacy'.
tasks - Displays the tasks runnable from root project 'bslegacy'.

Verification tasks
------------------
check - Runs all checks.
test - Runs the unit tests.

Other tasks
-----------
compileJava - Compiles main Java source.
compileTestJava - Compiles test Java source.
dependencyManagement
findMainClass
processResources - Processes main resources.
processTestResources - Processes test resources.
stage

Rules
-----
Pattern: clean<TaskName>: Cleans the output files of a task.
Pattern: build<ConfigurationName>: Assembles the artifacts of a configuration.
Pattern: upload<ConfigurationName>: Assembles and uploads the artifacts belonging to a configuration.

BUILD SUCCESSFUL

Total time: 1.04 secs

The relevant portions of the builde.gradle file:

buildscript {
        ext {
                springBootVersion = '1.5.1.RELEASE'
        }
        repositories {
                mavenCentral()
                jcenter()
        }
        dependencies {
                classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
                classpath('com.vanniktech:gradle-code-quality-tools-plugin:0.4.0')
        }
}

apply plugin: 'com.vanniktech.code.quality.tools'

Hello again, I opened an issue on the detekt project because I was having trouble with the VariableMinLength setting on detekt. I've been busy this days, but I got back on the project I had the issue on today, and couldn't reproduce either so there's that.

I've however been making some tests on my own and there is something weird going on with this. Now it's possible that I'm a complete idiot and there's something obvious that I'm missing but, I'm getting different results on my project and this test project with copy pasted settings. To illustrate why I think there's something weird going on, the project has variables of length < 10 but is passing gradle check with detekt reporting 0 smells., with this detekt.yml

autoCorrect: false
failFast: true

style:
  VariableMinLength:
    active: true
    minimumVariableNameLength: 10

naming:
  VariableMinLength:
    active: true
    minimumVariableNameLength: 10

With gradle officially deprecating the findbugs plugin (to be removed in v6, See: https://docs.gradle.org/current/userguide/findbugs_plugin.html), the code quality tools should migrate to spotbugs instead (https://plugins.gradle.org/plugin/com.github.spotbugs)

We add them by hand and they'll be executed every time.

https://github.com/arturbosch/detekt

Can you please provide KtLint baseline support?

Like in this article:
https://joshfein.medium.com/ktlint-baseline-3bb948d461c9

As far as I understand, something similar to
https://github.com/vanniktech/gradle-code-quality-tools-plugin/pull/138/files#diff-5e372104ee9907a1224537bd40c65d107999455ba32159982b36da0233aa44c2R23

should be added here:
https://github.com/vanniktech/gradle-code-quality-tools-plugin/blob/master/src/main/kotlin/com/vanniktech/code/quality/tools/KtLintTask.kt#L62

and there:
https://github.com/vanniktech/gradle-code-quality-tools-plugin/blob/master/src/main/kotlin/com/vanniktech/code/quality/tools/KtlintExtension.kt#L11

I am trying to apply the plugin but get this build error

FAILURE: Build failed with an exception.

• What went wrong:
  A problem occurred configuring project ':app'.

Failed to notify project evaluation listener.
java.lang.reflect.InvocationTargetException (no error message)

pmd/pmd#419

I have tried to use this plugin to ease including "ktlint", however, the command ./gradlew spotlessApply would not be found.
Is diffplug/spotless integrated?

I am using Gradle 5.2.1

FAILURE: Build failed with an exception.

* What went wrong:
A problem occurred configuring root project 'react-native'.
> Could not resolve all artifacts for configuration ':classpath'.
   > Could not find net.ltgt.gradle:gradle-errorprone-plugin:0.0.14.
     Searched in the following locations:
       - file:/Users/daniel/.m2/repository/net/ltgt/gradle/gradle-errorprone-plugin/0.0.14/gradle-errorprone-plugin-0.0.14.pom
       - file:/Users/daniel/.m2/repository/net/ltgt/gradle/gradle-errorprone-plugin/0.0.14/gradle-errorprone-plugin-0.0.14.jar
       - https://dl.google.com/dl/android/maven2/net/ltgt/gradle/gradle-errorprone-plugin/0.0.14/gradle-errorprone-plugin-0.0.14.pom
       - https://dl.google.com/dl/android/maven2/net/ltgt/gradle/gradle-errorprone-plugin/0.0.14/gradle-errorprone-plugin-0.0.14.jar
       - https://jcenter.bintray.com/net/ltgt/gradle/gradle-errorprone-plugin/0.0.14/gradle-errorprone-plugin-0.0.14.pom
       - https://jcenter.bintray.com/net/ltgt/gradle/gradle-errorprone-plugin/0.0.14/gradle-errorprone-plugin-0.0.14.jar
     Required by:
         project : > com.vanniktech:gradle-code-quality-tools-plugin:0.18.0

On debug/release with Checkstyle deps you will see:

Warning:WARNING: Dependency commons-logging:commons-logging:1.1.1 is ignored for debug as it may be conflicting with the internal version provided by Android.

Its probably nothing too major just doc-ing in case that turns out to be something

If it turns out to be something will figure out work-around and submit so that I can be included in the plugin readme.

https://github.com/arturbosch/detekt/pull/1417/files

It's a small issue, but for beginners incomplete documentation may be confusing :
In the readme.md file, at chapter
https://github.com/vanniktech/gradle-code-quality-tools-plugin#configuration
contains following dead link : src/main/groovy/com/vanniktech/code/quality/tools/CodeQualityToolsPluginExtension.groovy

If I understand correctly,
apply plugin: "com.vanniktech.code.quality.tools"
and the config block just go in the main project's build.gradle ?

Also maybe some more explanation needed:
In android studio, the specific tool (findbugs etc) XML config files are usually under the .idea folder,
Does this plugin need to have it's own set under code_quality_tools folder,
because this folder is empty, except for detekt.yml ?

Hey, I ran into an issue with cpd. It cannot create the cpd task and thus doesn't run when cpd isn't disabled. Is there a way to fix it?

Plugin version 0.19.0
Android plugin is '3.6.1'
Gradle is '6.2.2'

> Failed to apply plugin [class 'de.aaschmid.gradle.plugins.cpd.CpdPlugin']
   > Could not create task ':testlab:cpdCheck'.
      > Could not create task of type 'Cpd'.
         > Could not create an instance of type de.aaschmid.gradle.plugins.cpd.internal.CpdReportsImpl.
            > org.gradle.api.reporting.internal.TaskReportContainer.<init>(Ljava/lang/Class;Lorg/gradle/api/Task;)V

My build.gradle

...

apply plugin: "com.vanniktech.code.quality.tools"

...

subprojects {
    codeQualityTools {
        failEarly = true
        htmlReports = true

        checkstyle {
            toolVersion = '8.30'
        }
        cpd {
            enabled = false
        }
        detekt {
            toolVersion = '1.6.0'
            config = "$rootProject.projectDir/.codequality/detekt.yml"
        }
        errorProne {
            toolVersion = '2.3.2'

        }
        kotlin {
            allWarningsAsErrors = true
        }
        ktlint {
            toolVersion = '0.36.0'
        }
        lint {
            abortOnError = true
            checkAllWarnings = true
            checkReleaseBuilds = false
            warningsAsErrors = true
        }
        pmd {
            toolVersion = '6.21.0'
        }
    }
}

Thank's in advance. Keep up the great work.

It would be great to add per-flavor findbugs tasks to check only required classes
and don't depend on 'assemble' anymore, like it's done in:
https://github.com/ChaitanyaPramod/findbugs-android

Such measure should significantly decrease the build time.

With Version 0.15.0 and gradle 4.10, everything works as expected.
When updating to 0.16.0 or 0.17.0 I am getting following output:

FAILURE: Build failed with an exception.

* What went wrong:
A problem occurred configuring project ':app'.
> Failed to notify project evaluation listener.
   > org.gradle.api.tasks.TaskContainer.named(Ljava/lang/String;Ljava/lang/Class;Lorg/gradle/api/Action;)Lorg/gradle/api/tasks/TaskProvider;

The solution is quite easy, just update gradle. But it's nowhere mentioned.

Tested with gradle 5.2.1

kotlin language ( cpd { language = 'kotlin' } ) can not be set because kotlin files have .kt extension and the plugin sets .kotlin
https://github.com/vanniktech/gradle-code-quality-tools-plugin/blob/master/src/main/kotlin/com/vanniktech/code/quality/tools/CodeQualityToolsPlugin.kt#L296

https://github.com/shyiko/ktlint

Hi @vanniktech, thanks for the great plugin! I believe it will become very popular soon.
There some issues, however, that prevent us from use it in production. Here is one of them.

We found that there is no way to setup more then on exclusion patter for checkstyle configuration, because checkstyle exclude setting has a string type:
https://github.com/vanniktech/gradle-code-quality-tools-plugin/blob/master/src/main/groovy/com/vanniktech/code/quality/tools/CodeQualityToolsPluginExtension.groovy#L96

IMHO it would be great to replace it with a array-like structure to configure it in more flexible way.

I think one of the tools broke and ideally we'd spin up some instrumentation tests for the tool that broke - with others following afterwards.

I can see that you've added some docs to the ext variable.

but when I request for the docs from IDE, it's not showing

Actually am trying to build a plugin. I am having similar issue. Do you know how to fix it?

https://stackoverflow.com/questions/61985548/how-to-add-docs-to-gradle-plugin-extension-variables

Hi,

Applying the plugin produces an error by default because some dependencies are missing.
I think this is a bad user experience.
In my case I'm not building an android app so IMO the plugin should work.
Why should it fail because it wants to build android or kotlin and I'm not using either.
Less (automation or defaults) is more :) .

Thanks,

plugins {
   ....
    id "com.vanniktech.code.quality.tools" version "0.9.0"
}

Could not find com.android.tools.build:gradle:3.0.1.
Searched in the following locations:
    https://plugins.gradle.org/m2/com/android/tools/build/gradle/3.0.1/gradle-3.0.1.pom
    https://plugins.gradle.org/m2/com/android/tools/build/gradle/3.0.1/gradle-3.0.1.jar
Required by:
    project :core > com.vanniktech.code.quality.tools:com.vanniktech.code.quality.tools.gradle.plugin:0.9.0 > gradle.plugin.com.vanniktech:gradle-code-quality-tools-plugin:0.9.0

Hi @vanniktech, thanks for the great plugin! I believe it will become very popular soon.
There some issues, however, that prevent us from use it in production. Here is one of them.

Our project has a number of ABI flavors, like "arm" and "x86".
We found that it's not possible to perform FindBugs check on it:

./gradlew findbugs
... assembles all flavours ...
:app:assemble
:app:findbugs FAILED

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':app:findbugs'.
> No classes configured for FindBugs analysis.

* Try:
Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output.

BUILD FAILED

That's because it searches for classes to analyze in hardcoded place:
https://github.com/vanniktech/gradle-code-quality-tools-plugin/blob/master/src/main/groovy/com/vanniktech/code/quality/tools/CodeQualityToolsPlugin.groovy#L158 , but in our project these classes are placed in
a build/intermediates/classes/arm/debug .

https://github.com/tbroyer/gradle-errorprone-plugin

The same issue
vincentbrison/vb-android-app-quality#18

https://github.com/aaschmid/gradle-cpd-plugin/

The declaration:

codeQualityTools {
    boolean failEarly = true
    boolean xmlReports = false
    boolean htmlReports = true
    boolean textReports = false
    String[] ignoreProjects = []

   // More code
}

seems to be ignored. It has not a consequence, making customization just really hard. Please, could you help with this? @vanniktech

I have attempted to put in an Android project root/build.gradle and even root/module/build.gradle and still no effect. For example, if I shut off xml reports, and turn on html reports, I still see the xml reports generated.

Environment

• Android Studio 3.4.1
• Gradle plugin 5.0

The detekt tool and official plugin do not require a config file. If not configured, the default is used. This is impossible using this plugin.

Related, the official plugin can generate a default file. This is again not possible with this plugin.

At least, please allow executing the plugin with just defaults. At best, add a task to generate the default file as well.

First of all, thank you so much for building this plugin, I really appreciate not having to do much to configure my project for a bunch of static analysis tooling.

The plugin dependencies that this tool provides are getting old at this point. Would it be possible for you to upgrade the dependencies and publish a new release?

Added the plugin to my project and in the debug output it shows that Gradle finds it, downloads it and recognizes the plugin as an available tool in the project, but it doesn't automatically hook the plugin into the build life cycle.

I configured it to the build.gradle as your readme instructed. I'm running Java 8 and Gradle 2.12.

  findbugs {
    String excludeFilter = 'code_quality_tools/findbugs-filter.xml'
  }
  checkstyle {
    String configFile = 'code_quality_tools/checkstyle.xml'
  }
  pmd {
    String ruleSetFile = 'code_quality_tools/pmd.xml'
  }
  lint {
    File lintConfig = null
  }
  detekt {
    String config = 'code_quality_tools/detekt.yml'
  }

It's all the same with a different name. Even though they are probably called by the tool library like this.

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

• fix(deps): update dependency org.jetbrains.kotlin:kotlin-gradle-plugin to v1.7.20

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository