[JENKINS-41449] Get lint issues via API call - Jenkins Jira

Victor Martinez added a comment - 2017-01-26 18:17

Fair point, I've been playing a bit with the RestAPI and it seems to be a pretty simple feature by adding some annotations,

There are a couple of interesting points though:

Current data structure is based on ArrayList which means the output will look like

      "checkList" : [
        {
          "name" : "GradleWrapperChecker",
          "description" : "",
          "severity" : "Medium"
        },
        {
         "description" : "Jenkins project description might help you to know what it does and further details.",
         "name" : "JobDescriptionChecker",
         "severity" : "Medium"
        },
      ],

I'm tempted to use some Hashtable as I've already done with my first approach and have something like:

"checkSet" : {
        "GradleWrapperChecker" : {
      "description" : "By distributing the wrapper with your project, anyone can work with it without needing to install Gradle beforehand. Even better, users of the build <br/> are guaranteed to use the version of Gradle that the build was designed to work with. Further details: <a href=https://docs.gradle.org/current/userguide/gradle_wrapper.html> Gradle Wrapper docs</a>.",
      "name" : "GradleWrapperChecker",
      "severity" : "Medium"
    },
    "JobDescriptionChecker" : {
      "description" : "Jenkins project description might help you to know what it does and further details.",
      "name" : "JobDescriptionChecker",
      "severity" : "Medium"
    },
...
}

If i go for the second approach then I'll need to deprecate some public methods in case someone is accessing those methods somehow through the API.

I'll ask some feedback to the community then

Cheers

Victor Martinez added a comment - 2017-01-26 18:17 Fair point, I've been playing a bit with the RestAPI and it seems to be a pretty simple feature by adding some annotations, There are a couple of interesting points though: Current data structure is based on ArrayList which means the output will look like "checkList" : [ { "name" : "GradleWrapperChecker" , "description" : "", "severity" : "Medium" }, { "description" : "Jenkins project description might help you to know what it does and further details." , "name" : "JobDescriptionChecker" , "severity" : "Medium" }, ], I'm tempted to use some Hashtable as I've already done with my first approach and have something like: "checkSet" : { "GradleWrapperChecker" : { "description" : "By distributing the wrapper with your project, anyone can work with it without needing to install Gradle beforehand. Even better, users of the build <br/> are guaranteed to use the version of Gradle that the build was designed to work with. Further details: <a href=https: //docs.gradle.org/current/userguide/gradle_wrapper.html> Gradle Wrapper docs</a>." , "name" : "GradleWrapperChecker" , "severity" : "Medium" }, "JobDescriptionChecker" : { "description" : "Jenkins project description might help you to know what it does and further details." , "name" : "JobDescriptionChecker" , "severity" : "Medium" }, ... } If i go for the second approach then I'll need to deprecate some public methods in case someone is accessing those methods somehow through the API. I'll ask some feedback to the community then Cheers

Petrik van der Velde added a comment - 2017-01-26 19:02

I think I'm slightly partial to the latter but we could work with the former as well, so I guess it depends on what the rest of the community wants and how hard it would be to implement the Hashtable approach.

Petrik van der Velde added a comment - 2017-01-26 19:02 I think I'm slightly partial to the latter but we could work with the former as well, so I guess it depends on what the rest of the community wants and how hard it would be to implement the Hashtable approach.

SCM/JIRA link daemon added a comment - 2017-01-26 20:55

Code changed in jenkins
User: Victor Martinez
Path:
src/main/java/org/jenkins/ci/plugins/jenkinslint/JenkinsLintAction.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/AbstractCheck.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/AbstractSlaveCheck.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/InterfaceCheck.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/InterfaceSlaveCheck.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Job.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Lint.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Slave.java
src/main/resources/org/jenkins/ci/plugins/jenkinslint/JenkinsLintAction/index.jelly
http://jenkins-ci.org/commit/jenkinslint-plugin/99aae03674d0144657b0baaa8e0113c31df89b9e
Log:
~~JENKINS-41449~~ RestAPI feature based on hashes

RestAPI feature: creating a list of elements with some hierarchy

RestAPI feature: refreshing data when quering through the api otherwise it will keep the previous run which means null when it hasn't been requested through the UI

RestAPI feature: fixing bug when creating a list of elements with some hierarchy

Deprecated public api and created an alternative one based on Hashes

SCM/JIRA link daemon added a comment - 2017-01-26 20:55 Code changed in jenkins User: Victor Martinez Path: src/main/java/org/jenkins/ci/plugins/jenkinslint/JenkinsLintAction.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/AbstractCheck.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/AbstractSlaveCheck.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/InterfaceCheck.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/InterfaceSlaveCheck.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Job.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Lint.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Slave.java src/main/resources/org/jenkins/ci/plugins/jenkinslint/JenkinsLintAction/index.jelly http://jenkins-ci.org/commit/jenkinslint-plugin/99aae03674d0144657b0baaa8e0113c31df89b9e Log: JENKINS-41449 RestAPI feature based on hashes RestAPI feature: creating a list of elements with some hierarchy RestAPI feature: refreshing data when quering through the api otherwise it will keep the previous run which means null when it hasn't been requested through the UI RestAPI feature: fixing bug when creating a list of elements with some hierarchy Deprecated public api and created an alternative one based on Hashes

Victor Martinez added a comment - 2017-01-26 21:07

Initial approach based on Hashes rather than ArrayList:

https://github.com/jenkinsci/jenkinslint-plugin/pull/1

Victor Martinez added a comment - 2017-01-26 21:07 Initial approach based on Hashes rather than ArrayList: https://github.com/jenkinsci/jenkinslint-plugin/pull/1

SCM/JIRA link daemon added a comment - 2017-02-03 17:55

Code changed in jenkins
User: Victor Martinez
Path:
.gitignore
src/main/java/org/jenkins/ci/plugins/jenkinslint/JenkinsLintAction.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/AbstractCheck.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/AbstractSlaveCheck.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/InterfaceCheck.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/InterfaceSlaveCheck.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Job.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Lint.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Slave.java
src/main/resources/org/jenkins/ci/plugins/jenkinslint/JenkinsLintAction/index.jelly
src/test/java/org/jenkins/ci/plugins/jenkinslint/JenkinsLintActionTestCase.java
http://jenkins-ci.org/commit/jenkinslint-plugin/dc6f1d1ac0481de9447eb8ce0f5446a225ae7f23
Log:
~~JENKINS-41449~~ RestAPI feature based on hashes

RestAPI feature: creating a list of elements with some hierarchy

RestAPI feature: refreshing data when quering through the api otherwise it will keep the previous run which means null when it hasn't been requested through the UI

RestAPI feature: fixing bug when creating a list of elements with some hierarchy

Deprecated public api and created an alternative one based on Hashes

Added some test api cases

Added Rest API test cases

Excluding evil macosx files

Removed wrong size method

Using the class name rather than the package+class name, then those data structures amp correctly

SCM/JIRA link daemon added a comment - 2017-02-03 17:55 Code changed in jenkins User: Victor Martinez Path: .gitignore src/main/java/org/jenkins/ci/plugins/jenkinslint/JenkinsLintAction.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/AbstractCheck.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/AbstractSlaveCheck.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/InterfaceCheck.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/InterfaceSlaveCheck.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Job.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Lint.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Slave.java src/main/resources/org/jenkins/ci/plugins/jenkinslint/JenkinsLintAction/index.jelly src/test/java/org/jenkins/ci/plugins/jenkinslint/JenkinsLintActionTestCase.java http://jenkins-ci.org/commit/jenkinslint-plugin/dc6f1d1ac0481de9447eb8ce0f5446a225ae7f23 Log: JENKINS-41449 RestAPI feature based on hashes RestAPI feature: creating a list of elements with some hierarchy RestAPI feature: refreshing data when quering through the api otherwise it will keep the previous run which means null when it hasn't been requested through the UI RestAPI feature: fixing bug when creating a list of elements with some hierarchy Deprecated public api and created an alternative one based on Hashes Added some test api cases Added Rest API test cases Excluding evil macosx files Removed wrong size method Using the class name rather than the package+class name, then those data structures amp correctly

SCM/JIRA link daemon added a comment - 2017-02-23 23:42

Code changed in jenkins
User: Victor Martinez
Path:
.gitignore
src/main/java/org/jenkins/ci/plugins/jenkinslint/JenkinsLintAction.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/AbstractCheck.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/AbstractSlaveCheck.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/InterfaceCheck.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/InterfaceSlaveCheck.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Job.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Lint.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Slave.java
src/main/resources/org/jenkins/ci/plugins/jenkinslint/JenkinsLintAction/index.jelly
src/test/java/org/jenkins/ci/plugins/jenkinslint/JenkinsLintActionTestCase.java
http://jenkins-ci.org/commit/jenkinslint-plugin/b894ab99f864fbf13f036303399a1aca9c95bbd9
Log:
~~JENKINS-41449~~ RestAPI feature based on hashes

RestAPI feature: creating a list of elements with some hierarchy

RestAPI feature: refreshing data when quering through the api otherwise it will keep the previous run which means null when it hasn't been requested through the UI

RestAPI feature: fixing bug when creating a list of elements with some hierarchy

Deprecated public api and created an alternative one based on Hashes

Added some test api cases

Added Rest API test cases

Excluding evil macosx files

Removed wrong size method

Using the class name rather than the package+class name, then those data structures amp correctly

SCM/JIRA link daemon added a comment - 2017-02-23 23:42 Code changed in jenkins User: Victor Martinez Path: .gitignore src/main/java/org/jenkins/ci/plugins/jenkinslint/JenkinsLintAction.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/AbstractCheck.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/AbstractSlaveCheck.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/InterfaceCheck.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/InterfaceSlaveCheck.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Job.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Lint.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Slave.java src/main/resources/org/jenkins/ci/plugins/jenkinslint/JenkinsLintAction/index.jelly src/test/java/org/jenkins/ci/plugins/jenkinslint/JenkinsLintActionTestCase.java http://jenkins-ci.org/commit/jenkinslint-plugin/b894ab99f864fbf13f036303399a1aca9c95bbd9 Log: JENKINS-41449 RestAPI feature based on hashes RestAPI feature: creating a list of elements with some hierarchy RestAPI feature: refreshing data when quering through the api otherwise it will keep the previous run which means null when it hasn't been requested through the UI RestAPI feature: fixing bug when creating a list of elements with some hierarchy Deprecated public api and created an alternative one based on Hashes Added some test api cases Added Rest API test cases Excluding evil macosx files Removed wrong size method Using the class name rather than the package+class name, then those data structures amp correctly

SCM/JIRA link daemon added a comment - 2017-02-26 00:10

Code changed in jenkins
User: Victor Martinez
Path:
.gitignore
src/main/java/org/jenkins/ci/plugins/jenkinslint/JenkinsLintAction.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/AbstractCheck.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/AbstractSlaveCheck.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/InterfaceCheck.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/InterfaceSlaveCheck.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Job.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Lint.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Slave.java
src/main/resources/org/jenkins/ci/plugins/jenkinslint/JenkinsLintAction/index.jelly
src/test/java/org/jenkins/ci/plugins/jenkinslint/JenkinsLintActionTestCase.java
http://jenkins-ci.org/commit/jenkinslint-plugin/24925a418e732e33d42d53898417cb62efecc4f1
Log:
~~JENKINS-41449~~ RestAPI feature based on hashes

RestAPI feature: creating a list of elements with some hierarchy

RestAPI feature: refreshing data when quering through the api otherwise it will keep the previous run which means null when it hasn't been requested through the UI

RestAPI feature: fixing bug when creating a list of elements with some hierarchy

Deprecated public api and created an alternative one based on Hashes

Added some test api cases

Added Rest API test cases

Excluding evil macosx files

Removed wrong size method

Using the class name rather than the package+class name, then those data structures amp correctly

SCM/JIRA link daemon added a comment - 2017-02-26 00:10 Code changed in jenkins User: Victor Martinez Path: .gitignore src/main/java/org/jenkins/ci/plugins/jenkinslint/JenkinsLintAction.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/AbstractCheck.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/AbstractSlaveCheck.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/InterfaceCheck.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/InterfaceSlaveCheck.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Job.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Lint.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Slave.java src/main/resources/org/jenkins/ci/plugins/jenkinslint/JenkinsLintAction/index.jelly src/test/java/org/jenkins/ci/plugins/jenkinslint/JenkinsLintActionTestCase.java http://jenkins-ci.org/commit/jenkinslint-plugin/24925a418e732e33d42d53898417cb62efecc4f1 Log: JENKINS-41449 RestAPI feature based on hashes RestAPI feature: creating a list of elements with some hierarchy RestAPI feature: refreshing data when quering through the api otherwise it will keep the previous run which means null when it hasn't been requested through the UI RestAPI feature: fixing bug when creating a list of elements with some hierarchy Deprecated public api and created an alternative one based on Hashes Added some test api cases Added Rest API test cases Excluding evil macosx files Removed wrong size method Using the class name rather than the package+class name, then those data structures amp correctly

SCM/JIRA link daemon added a comment - 2017-02-27 21:45

Code changed in jenkins
User: Victor Martinez
Path:
.gitignore
src/main/java/org/jenkins/ci/plugins/jenkinslint/JenkinsLintAction.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/AbstractCheck.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/AbstractSlaveCheck.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/InterfaceCheck.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/InterfaceSlaveCheck.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Job.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Lint.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Slave.java
src/main/resources/org/jenkins/ci/plugins/jenkinslint/JenkinsLintAction/index.jelly
src/test/java/org/jenkins/ci/plugins/jenkinslint/JenkinsLintActionTestCase.java
http://jenkins-ci.org/commit/jenkinslint-plugin/994c38f1a3ab995cba967da7ff7ffbb17db99766
Log:
~~JENKINS-41449~~ RestAPI feature based on hashes

RestAPI feature: creating a list of elements with some hierarchy

RestAPI feature: refreshing data when quering through the api otherwise it will keep the previous run which means null when it hasn't been requested through the UI

RestAPI feature: fixing bug when creating a list of elements with some hierarchy

Deprecated public api and created an alternative one based on Hashes

Added some test api cases

Added Rest API test cases

Excluding evil macosx files

Removed wrong size method

Using the class name rather than the package+class name, then those data structures amp correctly

SCM/JIRA link daemon added a comment - 2017-02-27 21:45 Code changed in jenkins User: Victor Martinez Path: .gitignore src/main/java/org/jenkins/ci/plugins/jenkinslint/JenkinsLintAction.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/AbstractCheck.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/AbstractSlaveCheck.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/InterfaceCheck.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/InterfaceSlaveCheck.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Job.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Lint.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Slave.java src/main/resources/org/jenkins/ci/plugins/jenkinslint/JenkinsLintAction/index.jelly src/test/java/org/jenkins/ci/plugins/jenkinslint/JenkinsLintActionTestCase.java http://jenkins-ci.org/commit/jenkinslint-plugin/994c38f1a3ab995cba967da7ff7ffbb17db99766 Log: JENKINS-41449 RestAPI feature based on hashes RestAPI feature: creating a list of elements with some hierarchy RestAPI feature: refreshing data when quering through the api otherwise it will keep the previous run which means null when it hasn't been requested through the UI RestAPI feature: fixing bug when creating a list of elements with some hierarchy Deprecated public api and created an alternative one based on Hashes Added some test api cases Added Rest API test cases Excluding evil macosx files Removed wrong size method Using the class name rather than the package+class name, then those data structures amp correctly

SCM/JIRA link daemon added a comment - 2017-02-27 22:13

Code changed in jenkins
User: Victor Martinez
Path:
.gitignore
src/main/java/org/jenkins/ci/plugins/jenkinslint/JenkinsLintAction.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/AbstractCheck.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/AbstractSlaveCheck.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/InterfaceCheck.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/InterfaceSlaveCheck.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Job.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Lint.java
src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Slave.java
src/main/resources/org/jenkins/ci/plugins/jenkinslint/JenkinsLintAction/index.jelly
src/test/java/org/jenkins/ci/plugins/jenkinslint/JenkinsLintActionTestCase.java
http://jenkins-ci.org/commit/jenkinslint-plugin/88781f1dab7c4c9c08d3be54a3c414d943fe2f0e
Log:
~~JENKINS-41449~~ RestAPI feature (#1)

~~JENKINS-41449~~ RestAPI feature based on hashes

RestAPI feature: creating a list of elements with some hierarchy

RestAPI feature: refreshing data when quering through the api otherwise it will keep the previous run which means null when it hasn't been requested through the UI

RestAPI feature: fixing bug when creating a list of elements with some hierarchy

Deprecated public api and created an alternative one based on Hashes

Added some test api cases

Added Rest API test cases

Excluding evil macosx files

Removed wrong size method

Using the class name rather than the package+class name, then those data structures amp correctly

TODO: Hashes caused issues when showing the matrix in the UI, since the ordering is not following the sequential declaration as expclicitly defined in the array section

We cannot deprecate since we need to use that sorted arraylist to show the UI details since we don't use a specific Key identifier in the hasharray

Better UI with big tables

Added better api test case to check the exposed api

SCM/JIRA link daemon added a comment - 2017-02-27 22:13 Code changed in jenkins User: Victor Martinez Path: .gitignore src/main/java/org/jenkins/ci/plugins/jenkinslint/JenkinsLintAction.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/AbstractCheck.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/AbstractSlaveCheck.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/InterfaceCheck.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/InterfaceSlaveCheck.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Job.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Lint.java src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Slave.java src/main/resources/org/jenkins/ci/plugins/jenkinslint/JenkinsLintAction/index.jelly src/test/java/org/jenkins/ci/plugins/jenkinslint/JenkinsLintActionTestCase.java http://jenkins-ci.org/commit/jenkinslint-plugin/88781f1dab7c4c9c08d3be54a3c414d943fe2f0e Log: JENKINS-41449 RestAPI feature (#1) JENKINS-41449 RestAPI feature based on hashes RestAPI feature: creating a list of elements with some hierarchy RestAPI feature: refreshing data when quering through the api otherwise it will keep the previous run which means null when it hasn't been requested through the UI RestAPI feature: fixing bug when creating a list of elements with some hierarchy Deprecated public api and created an alternative one based on Hashes Added some test api cases Added Rest API test cases Excluding evil macosx files Removed wrong size method Using the class name rather than the package+class name, then those data structures amp correctly TODO: Hashes caused issues when showing the matrix in the UI, since the ordering is not following the sequential declaration as expclicitly defined in the array section We cannot deprecate since we need to use that sorted arraylist to show the UI details since we don't use a specific Key identifier in the hasharray Better UI with big tables Added better api test case to check the exposed api

Victor Martinez added a comment - 2017-02-27 22:17

Already merged to Master. Upcoming release: 0.8.0

Victor Martinez added a comment - 2017-02-27 22:17 Already merged to Master. Upcoming release: 0.8.0

Jenkins

Get lint issues via API call

Details

Description

Attachments

Activity

People

Dates