-
Notifications
You must be signed in to change notification settings - Fork 194
/
MavenSiteArchiver.java
191 lines (165 loc) · 7.16 KB
/
MavenSiteArchiver.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
/*
* The MIT License
*
* Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi, Seiji Sogabe
*
* 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.maven.reporters;
import hudson.Extension;
import hudson.FilePath;
import hudson.Util;
import hudson.maven.MavenBuild;
import hudson.maven.MavenBuildProxy;
import hudson.maven.MavenBuildProxy.BuildCallable;
import hudson.maven.MavenModule;
import hudson.maven.MavenModuleSet;
import hudson.maven.MavenModuleSetBuild;
import hudson.maven.MavenReporter;
import hudson.maven.MavenReporterDescriptor;
import hudson.maven.MojoInfo;
import hudson.model.AbstractItem;
import hudson.model.Action;
import hudson.model.BuildListener;
import hudson.model.DirectoryBrowserSupport;
import hudson.model.ProminentProjectAction;
import hudson.model.Result;
import java.io.File;
import java.io.IOException;
import java.util.Collection;
import java.util.Collections;
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.component.configurator.ComponentConfigurationException;
/**
* Watches out for the execution of maven-site-plugin and records its output.
* Simple projects with one POM will find the site directly beneath {@code site}.
* For multi module projects the project whose pom is referenced in the configuration (i.e. the {@link MavenBuild#getParentBuild()} will be recorded to
* the {@code site}, module projects' sites will be stored beneath {@code site/${moduleProject.artifactId}}.
*
* @author Kohsuke Kawaguchi
*/
public class MavenSiteArchiver extends MavenReporter {
public boolean postExecute(MavenBuildProxy build, MavenProject pom, MojoInfo mojo, BuildListener listener, Throwable error) throws InterruptedException, IOException {
if(!mojo.is("org.apache.maven.plugins","maven-site-plugin","site"))
return true;
if(build.isSiteArchivingDisabled()) {
listener.getLogger().println("[JENKINS] Archiving disabled - not archiving site for " + pom.getName());
return true;
}
File destDir;
try {
destDir = mojo.getConfigurationValue("outputDirectory", File.class);
} catch (ComponentConfigurationException e) {
e.printStackTrace(listener.fatalError("Unable to find the site output directory"));
build.setResult(Result.FAILURE);
return true;
}
if(destDir != null && destDir.exists()) {
// try to get the storage location if this is a multi-module project.
final FilePath target = getModulePath(build, pom);
try {
listener.getLogger().printf("[JENKINS] Archiving site from %s to %s%n", destDir, target);
new FilePath(destDir).copyRecursiveTo(target);
} catch (IOException e) {
Util.displayIOException(e,listener);
e.printStackTrace(listener.fatalError("Unable to copy site from %s to %s",destDir,target));
build.setResult(Result.FAILURE);
}
build.registerAsAggregatedProjectAction(this);
}
return true;
}
/**
* In multi module builds, ascend to the parents until hitting the project
* root.
*
* @param build
* @param pom
*
* @return the relative path component to copy sites of multi module builds.
* @throws IOException
* @throws InterruptedException
*/
private FilePath getModulePath(MavenBuildProxy build, MavenProject pom) throws IOException, InterruptedException {
String rootArtifactId = build.execute(new BuildCallable<String, IOException>() {
private static final long serialVersionUID = 1L;
//@Override
public String call(MavenBuild mavenBuild) throws IOException, InterruptedException {
MavenModuleSet moduleSet = mavenBuild.getModuleSetBuild().getParent();
if (moduleSet == null) {
throw new IOException("Parent build not found!");
}
return moduleSet.getRootModule().getArtifactId();
}
});
String path = "";
MavenProject currentLevel = pom;
// build the path to the module by ascending to the parent pom until the root project
while (!rootArtifactId.equals(currentLevel.getArtifactId())) {
path = currentLevel.getArtifactId() + File.separator + path;
currentLevel = currentLevel.getParent();
}
return build.getModuleSetRootDir().child("site").child(path);
}
public Collection<? extends Action> getProjectActions(MavenModule project) {
return Collections.singleton(new SiteAction(project));
}
public Action getAggregatedProjectAction(MavenModuleSet project) {
return new SiteAction(project);
}
private static File getSiteDir(AbstractItem project) {
return new File(project.getRootDir(),"site");
}
public static class SiteAction implements ProminentProjectAction {
private final AbstractItem project;
public SiteAction(AbstractItem project) {
this.project = project;
}
public String getUrlName() {
return "site";
}
public String getDisplayName() {
return Messages.MavenSiteArchiver_DisplayName();
}
public String getIconFileName() {
if(getSiteDir(project).exists())
return "help.png";
else
// hide it since we don't have site yet.
return null;
}
/**
* Serves the site.
*/
public DirectoryBrowserSupport doDynamic() {
File siteDir = getSiteDir(project);
return new DirectoryBrowserSupport(project, new FilePath(siteDir), project.getDisplayName() + " site", "help.gif", !new File(siteDir, "index.html").isFile());
}
}
@Extension
public static final class DescriptorImpl extends MavenReporterDescriptor {
public String getDisplayName() {
return "Maven site";
}
public MavenSiteArchiver newAutoInstance(MavenModule module) {
return new MavenSiteArchiver();
}
}
private static final long serialVersionUID = 1L;
}