Navigation Menu

Skip to content

Commit

Permalink
[JENKINS-41449] RestAPI feature (#1)
Browse files Browse the repository at this point in the history 
* [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
  • Loading branch information
@v1v
v1v committed Feb 27, 2017
1 parent bae0a9e commit 88781f1
Show file tree
Hide file tree
Showing 11 changed files with 122 additions and 18 deletions.
2 changes: 2 additions & 0 deletions .gitignore
View file
Expand Up @@ -8,3 +8,5 @@ jenkins.war
*.iml
*.ipr
*.iws
.DS_Store

42 changes: 38 additions & 4 deletions src/main/java/org/jenkins/ci/plugins/jenkinslint/JenkinsLintAction.java
View file
Expand Up @@ -33,13 +33,18 @@
import org.jenkins.ci.plugins.jenkinslint.model.Job;
import org.jenkins.ci.plugins.jenkinslint.model.Lint;
import org.jenkins.ci.plugins.jenkinslint.model.Slave;
import org.jenkins.ci.plugins.jenkinslint.model.AbstractCheck;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Hashtable;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.kohsuke.stapler.export.Exported;
import org.kohsuke.stapler.export.ExportedBean;
import hudson.model.Api;

@ExportedBean
@Extension
public final class JenkinsLintAction implements RootAction {

Expand All @@ -49,6 +54,15 @@ public final class JenkinsLintAction implements RootAction {
private Hashtable<String, Slave> slaveSet = new Hashtable<String, Slave>();
private ArrayList<InterfaceSlaveCheck> slaveCheckList = new ArrayList<InterfaceSlaveCheck>();

public Api getApi() {
try {
this.getData();
} catch (IOException ioe) {
LOG.log(Level.INFO, "Failing when getting the JenkinsLint data through the API");
}
return new Api(this);
}

public void getData() throws IOException {
LOG.log(Level.FINE, "getData()");
jobSet.clear();
Expand Down Expand Up @@ -85,8 +99,8 @@ public void getData() throws IOException {
LOG.log(Level.FINER, "queryChecks " + item.getDisplayName());
Job newJob = new Job(item.getName(), item.getUrl());
for (InterfaceCheck checker : checkList) {
LOG.log(Level.FINER, checker.getClass().getName() + " " + item.getName() + " " + checker.executeCheck(item));
newJob.addLint(new Lint(checker.getClass().getName(), checker.executeCheck(item), checker.isIgnored(item.getDescription())));
LOG.log(Level.FINER, checker.getName() + " " + item.getName() + " " + checker.executeCheck(item));
newJob.addLint(new Lint(checker.getName(), checker.executeCheck(item), checker.isIgnored(item.getDescription())));
}
jobSet.put(item.getName(),newJob);
LOG.log(Level.FINER, newJob.toString());
Expand All @@ -99,8 +113,8 @@ public void getData() throws IOException {
Slave newSlave = new Slave(node.getNodeName(), node.getSearchUrl());
for (InterfaceSlaveCheck checker : slaveCheckList) {
boolean status = checker.executeCheck(node);
LOG.log(Level.FINER, checker.getClass().getName() + " " + node.getDisplayName() + " " + status);
newSlave.addLint(new Lint(checker.getClass().getName(), status, checker.isIgnored(node.getNodeDescription())));
LOG.log(Level.FINER, checker.getName() + " " + node.getDisplayName() + " " + status);
newSlave.addLint(new Lint(checker.getName(), status, checker.isIgnored(node.getNodeDescription())));
}
slaveSet.put(newSlave.getName(), newSlave);
LOG.log(Level.FINER, newSlave.toString());
Expand All @@ -120,6 +134,7 @@ public String getUrlName() {
return Messages.UrlName();
}

@Exported
public Hashtable<String, Job> getJobSet() {
return jobSet;
}
Expand All @@ -128,11 +143,30 @@ public ArrayList<InterfaceCheck> getCheckList() {
return checkList;
}

@Exported
public Hashtable<String, InterfaceCheck> getCheckSet() {
Hashtable<String, InterfaceCheck> temp = new Hashtable<String, InterfaceCheck>();
for (InterfaceCheck check : checkList) {
temp.put(check.getName(), check);
}
return temp;
}

@Exported
public Hashtable<String, Slave> getSlaveSet() {
return slaveSet;
}

public ArrayList<InterfaceSlaveCheck> getSlaveCheckList() {
return slaveCheckList;
}

@Exported
public Hashtable<String, InterfaceSlaveCheck> getSlaveCheckSet() {
Hashtable<String, InterfaceSlaveCheck> temp = new Hashtable<String, InterfaceSlaveCheck>();
for (InterfaceSlaveCheck check : slaveCheckList) {
temp.put(check.getName(), check);
}
return temp;
}
}
6 changes: 6 additions & 0 deletions src/main/java/org/jenkins/ci/plugins/jenkinslint/model/AbstractCheck.java
View file
@@ -1,11 +1,14 @@
package org.jenkins.ci.plugins.jenkinslint.model;

import java.util.logging.Logger;
import org.kohsuke.stapler.export.ExportedBean;
import org.kohsuke.stapler.export.Exported;

/**
* AbstractCheck class.
* @author Victor Martinez
*/
@ExportedBean
public abstract class AbstractCheck implements Comparable<AbstractCheck>, InterfaceCheck {
private String name;
private String description;
Expand All @@ -18,6 +21,7 @@ public AbstractCheck() {
this.setName(this.getClass().getSimpleName());
}

@Exported
public String getName() {
return name;
}
Expand All @@ -30,6 +34,7 @@ public String getId() {
return id;
}

@Exported
public String getDescription() {
return description;
}
Expand All @@ -38,6 +43,7 @@ public void setDescription(final String description) {
this.description = description;
}

@Exported
public String getSeverity() {
return severity;
}
Expand Down
6 changes: 6 additions & 0 deletions src/main/java/org/jenkins/ci/plugins/jenkinslint/model/AbstractSlaveCheck.java
View file
@@ -1,11 +1,14 @@
package org.jenkins.ci.plugins.jenkinslint.model;

import java.util.logging.Logger;
import org.kohsuke.stapler.export.ExportedBean;
import org.kohsuke.stapler.export.Exported;

/**
* AbstractCheck class.
* @author Victor Martinez
*/
@ExportedBean
public abstract class AbstractSlaveCheck implements Comparable<AbstractSlaveCheck>, InterfaceSlaveCheck {
private String name;
private String description;
Expand All @@ -18,6 +21,7 @@ public AbstractSlaveCheck() {
this.setName(this.getClass().getSimpleName());
}

@Exported
public String getName() {
return name;
}
Expand All @@ -30,6 +34,7 @@ public String getId() {
return id;
}

@Exported
public String getDescription() {
return description;
}
Expand All @@ -38,6 +43,7 @@ public void setDescription(final String description) {
this.description = description;
}

@Exported
public String getSeverity() {
return severity;
}
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/jenkins/ci/plugins/jenkinslint/model/InterfaceCheck.java
View file
Expand Up @@ -7,7 +7,7 @@
* @author Victor Martinez
*/
public interface InterfaceCheck {

public String getName();
boolean executeCheck(Item item);
boolean isIgnored(String jobDescription);
}
2 changes: 1 addition & 1 deletion src/main/java/org/jenkins/ci/plugins/jenkinslint/model/InterfaceSlaveCheck.java
View file
Expand Up @@ -7,7 +7,7 @@
* @author Victor Martinez
*/
public interface InterfaceSlaveCheck {

public String getName();
boolean executeCheck(Node item);
boolean isIgnored(String jobDescription);
}
16 changes: 15 additions & 1 deletion src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Job.java
View file
Expand Up @@ -3,11 +3,14 @@
import hudson.model.HealthReport;
import org.jenkins.ci.plugins.jenkinslint.Messages;
import java.util.ArrayList;

import java.util.Hashtable;
import org.kohsuke.stapler.export.ExportedBean;
import org.kohsuke.stapler.export.Exported;
/**
* Job class.
* @author Victor Martinez
*/
@ExportedBean
public final class Job implements Comparable<Job> {
private String name;
private String url;
Expand All @@ -19,6 +22,7 @@ public Job(final String name, final String url) {
this.url = url;
}

@Exported
public String getName() {
return name;
}
Expand All @@ -39,6 +43,15 @@ public ArrayList<Lint> getLintList() {
return lintList;
}

@Exported
public Hashtable<String, Lint> getLintSet() {
Hashtable<String, Lint> temp = new Hashtable<String, Lint>();
for (Lint lint : lintList) {
temp.put(lint.getName(), lint);
}
return temp;
}

public void addLint(Lint lint) {
lintList.add(lint);
}
Expand Down Expand Up @@ -75,6 +88,7 @@ public String toString() {
append(", ").append(lintList).toString();
}

@Exported
public HealthReport getLintHealthReport() {
if (lintList != null && lintList.size() > 0) {
int ok = 0;
Expand Down
7 changes: 7 additions & 0 deletions src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Lint.java
View file
@@ -1,9 +1,13 @@
package org.jenkins.ci.plugins.jenkinslint.model;

import org.kohsuke.stapler.export.ExportedBean;
import org.kohsuke.stapler.export.Exported;

/**
* Check class.
* @author Victor Martinez
*/
@ExportedBean
public final class Lint implements Comparable<Lint> {
private String name;
private boolean found = false;
Expand All @@ -16,6 +20,7 @@ public Lint(final String name, final boolean found, final boolean ignored) {
this.setIgnored(ignored);
}

@Exported
public String getName() {
return name;
}
Expand All @@ -31,6 +36,7 @@ public int compareTo(final Lint other) {
return getName().compareTo(other.getName());
}

@Exported
public boolean isFound() {
return found;
}
Expand All @@ -39,6 +45,7 @@ public void setFound(boolean found) {
this.found = found;
}

@Exported
public boolean isIgnored() {
return ignored;
}
Expand Down
15 changes: 15 additions & 0 deletions src/main/java/org/jenkins/ci/plugins/jenkinslint/model/Slave.java
View file
Expand Up @@ -4,11 +4,15 @@
import org.jenkins.ci.plugins.jenkinslint.Messages;

import java.util.ArrayList;
import java.util.Hashtable;
import org.kohsuke.stapler.export.ExportedBean;
import org.kohsuke.stapler.export.Exported;

/**
* Slave class.
* @author Victor Martinez
*/
@ExportedBean
public final class Slave implements Comparable<Slave> {
private String name;
private String url;
Expand All @@ -20,6 +24,7 @@ public Slave(final String name, final String url) {
this.url = url;
}

@Exported
public String getName() {
return name;
}
Expand All @@ -40,6 +45,15 @@ public ArrayList<Lint> getLintList() {
return lintList;
}

@Exported
public Hashtable<String, Lint> getLintSet() {
Hashtable<String, Lint> temp = new Hashtable<String, Lint>();
for (Lint lint : lintList) {
temp.put(lint.getName(), lint);
}
return temp;
}

public void addLint(Lint lint) {
lintList.add(lint);
}
Expand Down Expand Up @@ -76,6 +90,7 @@ public String toString() {
append(", ").append(lintList).toString();
}

@Exported
public HealthReport getLintHealthReport() {
if (lintList != null && lintList.size() > 0) {
int ok = 0;
Expand Down
8 changes: 4 additions & 4 deletions src/main/resources/org/jenkins/ci/plugins/jenkinslint/JenkinsLintAction/index.jelly
View file
Expand Up @@ -49,10 +49,10 @@
</j:if>
<j:if test="${!lint.ignored}">
<j:if test="${lint.found}">
<td tooltip="found" style="background-color: #FF8566;"/>
<td tooltip="${lint.name} found" style="background-color: #FF8566;"/>
</j:if>
<j:if test="${!lint.found}">
<td tooltip="notFound" style="background-color: #B8EEB8;"/>
<td tooltip="${lint.name} notFound" style="background-color: #B8EEB8;"/>
</j:if>
</j:if>
</j:forEach>
Expand Down Expand Up @@ -139,10 +139,10 @@
</j:if>
<j:if test="${!lint.ignored}">
<j:if test="${lint.found}">
<td tooltip="found" style="background-color: #FF8566;"/>
<td tooltip="${lint.name} found" style="background-color: #FF8566;"/>
</j:if>
<j:if test="${!lint.found}">
<td tooltip="notFound" style="background-color: #B8EEB8;"/>
<td tooltip="${lint.name} notFound" style="background-color: #B8EEB8;"/>
</j:if>
</j:if>
</j:forEach>
Expand Down

0 comments on commit 88781f1

Please sign in to comment.