Merge pull request #18 from sghill/add-api

Add api support to PluginUsageView

Author: froque

pom.xml

@@ -52,6 +52,13 @@
       <version>3.0</version>
       <optional>true</optional>
     </dependency>
+
+    <dependency>
+      <groupId>com.google.code.gson</groupId>
+      <artifactId>gson</artifactId>
+      <version>2.8.6</version>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
   <dependencyManagement>

src/main/java/org/jenkinsci/plugins/pluginusage/JobsPerPlugin.java

@@ -2,13 +2,16 @@
 
 import hudson.PluginWrapper;
 import hudson.model.Job;
+import org.kohsuke.stapler.export.Exported;
+import org.kohsuke.stapler.export.ExportedBean;
 
 import java.util.ArrayList;
 import java.util.Comparator;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
+@ExportedBean
 public class JobsPerPlugin {
 
 	private PluginWrapper plugin;
@@ -23,6 +26,7 @@ public void addProject(Job project) {
 		this.jobMap.put(project.getFullDisplayName(), project);
 	}
 
+	@Exported
 	public List<Job> getProjects() {
 		ArrayList<Job> projects = new ArrayList<Job>();
 		projects.addAll(jobMap.values());
@@ -42,6 +46,7 @@ public int getNumberOfJobs() {
 		return jobMap.size();
 	}
 
+	@Exported
 	public PluginWrapper getPlugin()
 	{
 		return plugin;

src/main/java/org/jenkinsci/plugins/pluginusage/PluginUsageModel.java

@@ -6,9 +6,13 @@
 
 import hudson.PluginWrapper;
 import org.jenkinsci.plugins.pluginusage.analyzer.JobCollector;
+import org.kohsuke.stapler.export.Exported;
+import org.kohsuke.stapler.export.ExportedBean;
 
+@ExportedBean
 public class PluginUsageModel {
 
+	@Exported
 	public List<JobsPerPlugin> getJobsPerPlugin() {
 		ArrayList<JobsPerPlugin> list = new ArrayList<JobsPerPlugin>();
 		list.addAll(new JobCollector().getJobsPerPlugin().values());

src/main/java/org/jenkinsci/plugins/pluginusage/PluginUsageView.java

@@ -1,6 +1,7 @@
 package org.jenkinsci.plugins.pluginusage;
 
 import hudson.Extension;
+import hudson.model.Api;
 import hudson.model.RootAction;
 
 @Extension
@@ -23,4 +24,7 @@ public PluginUsageModel getData() {
 		return pluginUsageModel;
 	}
 
+	public Api getApi() {
+		return new Api(getData());
+	}
 }

src/test/java/org/jenkinsci/plugins/pluginusage/PluginUsageViewApiTest.java

@@ -0,0 +1,56 @@
+package org.jenkinsci.plugins.pluginusage;
+
+import com.google.common.collect.Lists;
+import com.google.common.io.Resources;
+import com.google.gson.Gson;
+import org.jenkinsci.plugins.pluginusage.api.Plugin;
+import org.jenkinsci.plugins.pluginusage.api.PluginProjects;
+import org.jenkinsci.plugins.pluginusage.api.PluginUsage;
+import org.jenkinsci.plugins.pluginusage.api.Project;
+import org.junit.Rule;
+import org.junit.Test;
+import org.jvnet.hudson.test.JenkinsRule;
+import org.jvnet.hudson.test.recipes.WithPlugin;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.net.URL;
+import java.util.List;
+
+import static org.junit.Assert.assertEquals;
+
+public class PluginUsageViewApiTest {
+    private final Gson gson = new Gson();
+
+    @Rule
+    public JenkinsRule j = new JenkinsRule();
+
+    @Test
+    @WithPlugin({"structs-1.17.hpi", "ant-1.9.hpi"})
+    public void shouldRenderJson() throws Exception {
+        // given two jobs are using the ant builder
+        URL configUsingAnt = Resources.getResource("with-ant.xml");
+        File config = new File(configUsingAnt.toURI());
+        List<String> jobsUsingAnt = Lists.newArrayList("a", "b");
+        for (String job : jobsUsingAnt) {
+            try (FileInputStream is = new FileInputStream(config)) {
+                j.jenkins.createProjectFromXML(job, is);
+            }
+        }
+        // and one job is not
+        j.createFreeStyleProject("c");
+        PluginUsage expected = new PluginUsage(Lists.newArrayList(
+                new PluginProjects(new Plugin("ant", "1.9"), Lists.newArrayList(
+                        new Project("a"),
+                        new Project("b")
+                ))
+        ));
+
+        // when the api is fetched
+        String body = j.getJSON("pluginusage/api/json?depth=2").getContentAsString();
+        PluginUsage actual = gson.fromJson(body, PluginUsage.class);
+
+        // then
+        assertEquals(expected, actual);
+    }
+}

src/test/java/org/jenkinsci/plugins/pluginusage/api/Plugin.java

@@ -0,0 +1,38 @@
+package org.jenkinsci.plugins.pluginusage.api;
+
+import java.util.Objects;
+import java.util.StringJoiner;
+
+public class Plugin {
+    String shortName;
+    String version;
+
+    public Plugin() {
+    }
+
+    public Plugin(String shortName, String version) {
+        this.shortName = shortName;
+        this.version = version;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        Plugin plugin = (Plugin) o;
+        return Objects.equals(shortName, plugin.shortName) && Objects.equals(version, plugin.version);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(shortName, version);
+    }
+
+    @Override
+    public String toString() {
+        return new StringJoiner(", ", Plugin.class.getSimpleName() + "[", "]")
+                .add("shortName='" + shortName + "'")
+                .add("version='" + version + "'")
+                .toString();
+    }
+}

src/test/java/org/jenkinsci/plugins/pluginusage/api/PluginProjects.java

@@ -0,0 +1,39 @@
+package org.jenkinsci.plugins.pluginusage.api;
+
+import java.util.List;
+import java.util.Objects;
+import java.util.StringJoiner;
+
+public class PluginProjects {
+    Plugin plugin;
+    List<Project> projects;
+
+    public PluginProjects() {
+    }
+
+    public PluginProjects(Plugin plugin, List<Project> projects) {
+        this.plugin = plugin;
+        this.projects = projects;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        PluginProjects that = (PluginProjects) o;
+        return Objects.equals(plugin, that.plugin) && Objects.equals(projects, that.projects);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(plugin, projects);
+    }
+
+    @Override
+    public String toString() {
+        return new StringJoiner(", ", PluginProjects.class.getSimpleName() + "[", "]")
+                .add("plugin=" + plugin)
+                .add("projects=" + projects)
+                .toString();
+    }
+}

src/test/java/org/jenkinsci/plugins/pluginusage/api/PluginUsage.java

@@ -0,0 +1,36 @@
+package org.jenkinsci.plugins.pluginusage.api;
+
+import java.util.List;
+import java.util.Objects;
+import java.util.StringJoiner;
+
+public class PluginUsage {
+    private List<PluginProjects> jobsPerPlugin;
+
+    public PluginUsage() {
+    }
+
+    public PluginUsage(List<PluginProjects> jobsPerPlugin) {
+        this.jobsPerPlugin = jobsPerPlugin;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        PluginUsage that = (PluginUsage) o;
+        return Objects.equals(jobsPerPlugin, that.jobsPerPlugin);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(jobsPerPlugin);
+    }
+
+    @Override
+    public String toString() {
+        return new StringJoiner(", ", PluginUsage.class.getSimpleName() + "[", "]")
+                .add("jobsPerPlugin=" + jobsPerPlugin)
+                .toString();
+    }
+}

src/test/java/org/jenkinsci/plugins/pluginusage/api/Project.java

@@ -0,0 +1,35 @@
+package org.jenkinsci.plugins.pluginusage.api;
+
+import java.util.Objects;
+import java.util.StringJoiner;
+
+public class Project {
+    String fullName;
+
+    public Project() {
+    }
+
+    public Project(String fullName) {
+        this.fullName = fullName;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        Project project = (Project) o;
+        return Objects.equals(fullName, project.fullName);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(fullName);
+    }
+
+    @Override
+    public String toString() {
+        return new StringJoiner(", ", Project.class.getSimpleName() + "[", "]")
+                .add("fullName='" + fullName + "'")
+                .toString();
+    }
+}