Skip to content

Commit

Permalink
* Added License
Browse files Browse the repository at this point in the history 
* Improved Javadoc
  • Loading branch information
@wolfs
wolfs committed Dec 12, 2010
1 parent 49f4258 commit 6b895c6
Show file tree
Hide file tree
Showing 16 changed files with 608 additions and 185 deletions.
23 changes: 23 additions & 0 deletions pom.xml
View file
@@ -1,3 +1,26 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Copyright (c) 2010 Stefan Wolf
~
~ Permission is hereby granted, free of charge, to any person obtaining a copy
~ of this software and associated documentation files (the "Software"), to deal
~ in the Software without restriction, including without limitation the rights
~ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
~ copies of the Software, and to permit persons to whom the Software is
~ furnished to do so, subject to the following conditions:
~
~ The above copyright notice and this permission notice shall be included in
~ all copies or substantial portions of the Software.
~
~ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
~ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
~ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
~ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
~ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
~ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
~ THE SOFTWARE.
-->

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
Expand Down
353 changes: 205 additions & 148 deletions src/main/java/hudson/plugins/depgraph_view/AbstractDependencyGraphAction.java
View file
@@ -1,3 +1,25 @@
/*
* Copyright (c) 2010 Stefan Wolf
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/

package hudson.plugins.depgraph_view;

import com.google.common.collect.ImmutableMap;
Expand All @@ -21,156 +43,191 @@
import java.util.logging.Level;
import java.util.logging.Logger;

/**
* Basic action for creating a Dot-Image of the DependencyGraph
*
* @author wolfs
*/
public abstract class AbstractDependencyGraphAction implements Action {
private final Logger LOGGER = Logger.getLogger(Logger.class.getName());

protected static final ImmutableMap<String, SupportedImageType> extension2Type =
ImmutableMap.of(
"png",SupportedImageType.of("image/png", "png"),
"svg",SupportedImageType.of("image/svg", "svg"),
"map",SupportedImageType.of("image/cmapx", "cmapx"),
"gv",SupportedImageType.of("text/plain", "gv")
);

private static final Comparator<Dependency> DEP_COMPARATOR = new Comparator<Dependency>() {
@Override
public int compare(Dependency o1, Dependency o2) {
int down = (PROJECT_COMPARATOR.compare(o1.getDownstreamProject(),o2.getDownstreamProject()));
return down != 0 ? down : PROJECT_COMPARATOR
.compare(o1.getUpstreamProject(),o2.getUpstreamProject());
}
};
private static final Comparator<AbstractProject<?,?>> PROJECT_COMPARATOR = new Comparator<AbstractProject<?,?>>() {
@Override
public int compare(AbstractProject<?,?> o1, AbstractProject<?,?> o2) {
return o1.getName().compareTo(o2.getName());
}
};

protected static class SupportedImageType {
final String contentType;
final String dotType;

private SupportedImageType(String contentType,
String dotType) {
this.contentType = contentType;
this.dotType = dotType;
}

public static SupportedImageType of(String contentType, String dotType) {
return new SupportedImageType(contentType, dotType);
}

}

@Override
public String getIconFileName() {
return "graph.gif";
}

@Override
public String getDisplayName() {
return Messages.AbstractDependencyGraphAction_DependencyGraph();
}

@Override
public String getUrlName() {
return "depgraph-view";
}

protected void runDot(OutputStream output, InputStream input, String type)
throws IOException {
DescriptorImpl descriptor = Hudson.getInstance().getDescriptorByType(DependencyGraphProperty.DescriptorImpl.class);
String dotPath = descriptor.getDotExeOrDefault();
Launcher launcher = Hudson.getInstance().createLauncher(new LogTaskListener(LOGGER, Level.CONFIG));
try {
launcher.launch()
.cmds(dotPath,"-T" + type)
.stdin(input)
.stdout(output).start().join();
} catch (InterruptedException e) {
LOGGER.severe("Interrupted while waiting for dot-file to be created:" + e);
e.printStackTrace();
}
finally {
if (output != null) {
output.close();
}
}
}

public String generateDotText(Set<AbstractProject<?,?>> projects, Set<Dependency> deps) {
List<Dependency> sortedDeps = new ArrayList<Dependency>(deps);
Collections.sort(sortedDeps, DEP_COMPARATOR);

List<AbstractProject<?, ?>> depProjects = new ArrayList<AbstractProject<?, ?>>();
for (Dependency dependency : sortedDeps) {
depProjects.add(dependency.getUpstreamProject());
depProjects.add(dependency.getDownstreamProject());
}

List<AbstractProject<?, ?>> sortedProjects = new ArrayList<AbstractProject<?, ?>>(projects);
sortedProjects.removeAll(depProjects);
Collections.sort(sortedProjects, PROJECT_COMPARATOR);
Collections.sort(depProjects, PROJECT_COMPARATOR);
sortedProjects.addAll(depProjects);

StringBuilder builder = new StringBuilder("digraph {\n");
builder.append("node [shape=box, style=rounded];\n");
builder.append("subgraph clusterdepgraph {\n");
for (AbstractProject<?, ?> proj:sortedProjects) {
builder.append(projectToNodeString(proj)).append(";\n");
}

for (Dependency dep : sortedDeps) {
builder.append(dependencyToEdgeString(dep));
builder.append(";\n");
}

builder.append("color=white;\n}\n");
return builder.append("}").toString();
}

private String projectToNodeString(AbstractProject<?, ?> proj) {
return escapeString(proj.getName()) +
" [href=" +
escapeString(Hudson.getInstance().getRootUrlFromRequest() + proj.getUrl()) + "]";
}

private String dependencyToEdgeString(Dependency dep) {
return escapeString(dep.getUpstreamProject().getName()) + " -> " +
escapeString(dep.getDownstreamProject().getName());
}

private String escapeString(String toEscape) {
return "\"" + toEscape + "\"";
}

protected abstract Collection<? extends AbstractProject<?, ?>> getProjectsForDepgraph(StaplerRequest req);

public abstract String getTitle();

private final Logger LOGGER = Logger.getLogger(Logger.class.getName());

/**
* Maps the extension of the requested file to the content type and the
* argument for the -T option of the graphviz tools
*/
protected static final ImmutableMap<String, SupportedImageType> extension2Type =
ImmutableMap.of(
"png",SupportedImageType.of("image/png", "png"),
"svg",SupportedImageType.of("image/svg", "svg"),
"map",SupportedImageType.of("image/cmapx", "cmapx"),
"gv",SupportedImageType.of("text/plain", "gv") // Special case - do no processing
);

// Lexicographic order of the dependencies
private static final Comparator<Dependency> DEP_COMPARATOR = new Comparator<Dependency>() {
@Override
public int compare(Dependency o1, Dependency o2) {
int down = (PROJECT_COMPARATOR.compare(o1.getDownstreamProject(),o2.getDownstreamProject()));
return down != 0 ? down : PROJECT_COMPARATOR
.compare(o1.getUpstreamProject(),o2.getUpstreamProject());
}
};

// Compares projects by name
private static final Comparator<AbstractProject<?,?>> PROJECT_COMPARATOR = new Comparator<AbstractProject<?,?>>() {
@Override
public int compare(AbstractProject<?,?> o1, AbstractProject<?,?> o2) {
return o1.getName().compareTo(o2.getName());
}
};

// Data Structure to encode the content type and the -T argument for the graphviz tools
protected static class SupportedImageType {
final String contentType;
final String dotType;

private SupportedImageType(String contentType,
String dotType) {
this.contentType = contentType;
this.dotType = dotType;
}

public static SupportedImageType of(String contentType, String dotType) {
return new SupportedImageType(contentType, dotType);
}

}

/**
* graph.{png,gv,...} is mapped to the corresponding output
*/
public void doDynamic(StaplerRequest req, StaplerResponse rsp) throws IOException {
String path = req.getRestOfPath();
if (path.startsWith("/graph.")) {
String extension = path.substring("/graph.".length());
if (extension2Type.containsKey(extension.toLowerCase())) {
SupportedImageType imageType = extension2Type.get(extension.toLowerCase());
CalculateDeps calculateDeps = new CalculateDeps(getProjectsForDepgraph());
String graphDot = generateDotText(calculateDeps.getProjects(), calculateDeps.getDependencies());
rsp.setContentType(imageType.contentType);
if ("gv".equalsIgnoreCase(extension)) {
rsp.getWriter().append(graphDot).close();
} else {
runDot(rsp.getOutputStream(), new ByteArrayInputStream(graphDot.getBytes()), imageType.dotType);
}
}
} else {
rsp.sendError(HttpServletResponse.SC_NOT_IMPLEMENTED);
return;
}
}

/**
* Generates the graphviz code for the given projects and dependencies
* @param projects the nodes of the graph
* @param deps the edges of the graph
* @return graphviz code
*/
public String generateDotText(Set<AbstractProject<?,?>> projects, Set<Dependency> deps) {
List<Dependency> sortedDeps = new ArrayList<Dependency>(deps);
Collections.sort(sortedDeps, DEP_COMPARATOR);

List<AbstractProject<?, ?>> depProjects = new ArrayList<AbstractProject<?, ?>>();
for (Dependency dependency : sortedDeps) {
depProjects.add(dependency.getUpstreamProject());
depProjects.add(dependency.getDownstreamProject());
}

List<AbstractProject<?, ?>> sortedProjects = new ArrayList<AbstractProject<?, ?>>(projects);
sortedProjects.removeAll(depProjects);
Collections.sort(sortedProjects, PROJECT_COMPARATOR);
Collections.sort(depProjects, PROJECT_COMPARATOR);
sortedProjects.addAll(depProjects);

StringBuilder builder = new StringBuilder("digraph {\n");
builder.append("node [shape=box, style=rounded];\n");
builder.append("subgraph clusterdepgraph {\n");
for (AbstractProject<?, ?> proj:sortedProjects) {
builder.append(projectToNodeString(proj)).append(";\n");
}

for (Dependency dep : sortedDeps) {
builder.append(dependencyToEdgeString(dep));
builder.append(";\n");
}

builder.append("color=white;\n}\n");
return builder.append("}").toString();
}

private String projectToNodeString(AbstractProject<?, ?> proj) {
return escapeString(proj.getName()) +
" [href=" +
escapeString(Hudson.getInstance().getRootUrlFromRequest() + proj.getUrl()) + "]";
}

private String dependencyToEdgeString(Dependency dep) {
return escapeString(dep.getUpstreamProject().getName()) + " -> " +
escapeString(dep.getDownstreamProject().getName());
}

private String escapeString(String toEscape) {
return "\"" + toEscape + "\"";
}

/**
* Execute the dot commando with given input and output stream
* @param type the parameter for the -T option of the graphviz tools
*/
protected void runDot(OutputStream output, InputStream input, String type)
throws IOException {
DescriptorImpl descriptor = Hudson.getInstance().getDescriptorByType(DependencyGraphProperty.DescriptorImpl.class);
String dotPath = descriptor.getDotExeOrDefault();
Launcher launcher = Hudson.getInstance().createLauncher(new LogTaskListener(LOGGER, Level.CONFIG));
try {
launcher.launch()
.cmds(dotPath,"-T" + type)
.stdin(input)
.stdout(output).start().join();
} catch (InterruptedException e) {
LOGGER.severe("Interrupted while waiting for dot-file to be created:" + e);
e.printStackTrace();
}
finally {
if (output != null) {
output.close();
}
}
}

/**
* @return projects for which the dependency graph should be calculated
*/
protected abstract Collection<? extends AbstractProject<?, ?>> getProjectsForDepgraph();

/**
* @return title of the dependency graph page
*/
public abstract String getTitle();

/**
* @return object for which the sidepanel.jelly will be shown
*/
public abstract AbstractModelObject getParentObject();

public void doDynamic(StaplerRequest req, StaplerResponse rsp) throws IOException {
String path = req.getRestOfPath();
if (path.startsWith("/graph.")) {
String extension = path.substring("/graph.".length());
if (extension2Type.containsKey(extension.toLowerCase())) {
SupportedImageType imageType = extension2Type.get(extension.toLowerCase());
CalculateDeps calculateDeps = new CalculateDeps(getProjectsForDepgraph(req));
String graphDot = generateDotText(calculateDeps.getProjects(), calculateDeps.getDependencies());
rsp.setContentType(imageType.contentType);
if ("gv".equalsIgnoreCase(extension)) {
rsp.getWriter().append(graphDot).close();
} else {
runDot(rsp.getOutputStream(), new ByteArrayInputStream(graphDot.getBytes()), imageType.dotType);
}
}
} else {
rsp.sendError(HttpServletResponse.SC_NOT_IMPLEMENTED);
return;
}
}
@Override
public String getIconFileName() {
return "graph.gif";
}

@Override
public String getDisplayName() {
return Messages.AbstractDependencyGraphAction_DependencyGraph();
}

@Override
public String getUrlName() {
return "depgraph-view";
}

}

0 comments on commit 6b895c6

Please sign in to comment.