org.netbeans.modules.hudson.subversion.HudsonSubversionSCM Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.netbeans.modules.hudson.subversion;
import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.netbeans.modules.hudson.api.ConnectionBuilder;
import org.netbeans.modules.hudson.api.HudsonJob;
import org.netbeans.modules.hudson.api.HudsonJobBuild;
import org.netbeans.modules.hudson.api.Utilities;
import org.netbeans.modules.hudson.spi.HudsonJobChangeItem;
import org.netbeans.modules.hudson.spi.HudsonJobChangeItem.HudsonJobChangeFile;
import org.netbeans.modules.hudson.spi.HudsonJobChangeItem.HudsonJobChangeFile.EditType;
import org.netbeans.modules.hudson.spi.HudsonSCM;
import org.netbeans.modules.hudson.spi.HudsonSCM.ConfigurationStatus;
import static org.netbeans.modules.hudson.subversion.Bundle.*;
import org.netbeans.modules.hudson.ui.api.HudsonSCMHelper;
import org.openide.util.NbBundle.Messages;
import org.openide.util.lookup.ServiceProvider;
import org.openide.windows.OutputListener;
import org.openide.xml.XMLUtil;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;
/**
* Lets Hudson understand things about Subversion.
*/
@ServiceProvider(service=HudsonSCM.class, position=100)
public class HudsonSubversionSCM implements HudsonSCM {
private static final Logger LOG = Logger.getLogger(HudsonSubversionSCM.class.getName());
@Messages({
"# {0} - error message", "ERR_reading_folder=Could not inspect Subversion checkout: {0}",
"ERR_unsupported=This Subversion working copy version is not supported."
})
public @Override Configuration forFolder(File folder) {
try {
SvnUtils.Info info = SvnUtils.parseCheckout(org.openide.util.Utilities.toURI(folder).toURL());
if (info == null) {
return null;
}
final String urlS = info.module.toString();
return new Configuration() {
public @Override void configure(Document doc) {
Element root = doc.getDocumentElement();
Element configXmlSCM = (Element) root.appendChild(doc.createElement("scm")); // NOI18N
configXmlSCM.setAttribute("class", "hudson.scm.SubversionSCM"); // NOI18N
Element loc = (Element) configXmlSCM.appendChild(doc.createElement("locations")). // NOI18N
appendChild(doc.createElement("hudson.scm.SubversionSCM_-ModuleLocation")); // NOI18N
loc.appendChild(doc.createElement("remote")).appendChild(doc.createTextNode(urlS)); // NOI18N
loc.appendChild(doc.createElement("local")).appendChild(doc.createTextNode(".")); // NOI18N
// HUDSON-3390 would be a more attractive alternative:
configXmlSCM.appendChild(doc.createElement("useUpdate")).appendChild(doc.createTextNode("false")); // NOI18N
HudsonSCMHelper.addTrigger(doc);
}
public @Override ConfigurationStatus problems() {
return null;
}
};
} catch (final IOException x) {
return new Configuration() {
@Override public void configure(Document configXml) {}
@Override public ConfigurationStatus problems() {
return ConfigurationStatus.withError(ERR_reading_folder(x.toString()));
}
};
} catch (final SvnUtils.UnsupportedSubversionVersionException x) {
return new Configuration() {
@Override public void configure(Document configXml) {}
@Override public ConfigurationStatus problems() {
return ConfigurationStatus.withError(ERR_unsupported());
}
};
}
}
public @Override String translateWorkspacePath(HudsonJob job, String workspacePath, File localRoot) {
try {
SvnUtils.Info local = SvnUtils.parseCheckout(org.openide.util.Utilities.toURI(localRoot).toURL());
if (local == null) {
return null;
}
int slash = workspacePath.lastIndexOf('/');
String workspaceDir = workspacePath.substring(0, slash + 1);
String workspaceFile = workspacePath.substring(slash + 1);
URL remoteCheckout = new URL(job.getUrl() + "ws/" + workspaceDir); // NOI18N
SvnUtils.Info remote = SvnUtils.parseCheckout(remoteCheckout, job);
if (remote == null) {
LOG.log(Level.FINE, "no remote checkout found at {0}", remoteCheckout);
return null;
}
// Example:
// workspacePath = trunk/myprj/nbproject/build-impl.xml
// workspaceDir = trunk/myprj/nbproject/
// workspaceFile = build-impl.xml
// remoteCheckout = http://my.build.server/hudson/job/myprj/ws/trunk/myprj/nbproject/
// remote.repository = https://myprj.dev.java.net/svnroot/myprj
// remote.module = https://myprj.dev.java.net/svnroot/myprj/trunk/myprj/nbproject
// local.repository = https://myprj.dev.java.net/svnroot/myprj
// local.module = https://myprj.dev.java.net/svnroot/myprj/trunk/myprj
// checkoutPath = /svnroot/myprj/trunk/myprj/nbproject/build-impl.xml
// infoURLPath = /svnroot/myprj/trunk/myprj/
// translatedPath = nbproject/build-impl.xml
if (!remote.repository.getPath().equals(local.repository.getPath())) {
LOG.log(Level.FINE, "repository mismatch between {0} and {1}", new Object[] {remote.repository, local.repository});
return null;
}
String remoteModule = new URL(remote.module + "/" + workspaceFile).getPath(); // NOI18N
String localModuleBase = new URL(local.module + "/").getPath(); // NOI18N
if (!remoteModule.startsWith(localModuleBase)) {
LOG.log(Level.FINE, "checkout mismatch between {0} and {1}", new Object[] {localModuleBase, remoteModule});
return null;
}
String translatedPath = remoteModule.substring(localModuleBase.length());
LOG.log(Level.FINE, "translated path as {0}", translatedPath);
return translatedPath;
} catch (Exception x) {
LOG.log(Level.FINE, "cannot translate path", x);
return null;
}
}
public @Override List parseChangeSet(final HudsonJobBuild build) {
final Element changeSet;
try {
changeSet = XMLUtil.findElement(new ConnectionBuilder().job(build.getJob()).url(build.getUrl() + "api/xml?tree=changeSet[kind,items[user,msg,paths[file,editType],revision],revisions[module]]").parseXML().getDocumentElement(), "changeSet", null);
} catch (IOException x) {
LOG.log(Level.WARNING, "could not parse changelog for {0}: {1}", new Object[] {build, x});
return Collections.emptyList();
}
if (!"svn".equals(Utilities.xpath("kind", changeSet))) { // NOI18N
return null;
}
class SubversionItem implements HudsonJobChangeItem {
final Element itemXML;
SubversionItem(Element xml) {
this.itemXML = xml;
}
public @Override String getUser() {
return Utilities.xpath("user", itemXML); // NOI18N
}
public @Override String getMessage() {
return Utilities.xpath("msg", itemXML); // NOI18N
}
public @Override Collection getFiles() {
class SubversionFile implements HudsonJobChangeFile {
final Element fileXML;
SubversionFile(Element xml) {
this.fileXML = xml;
}
public @Override String getName() {
return Utilities.xpath("file", fileXML); // NOI18N
}
public @Override EditType getEditType() {
return EditType.valueOf(Utilities.xpath("editType", fileXML)); // NOI18N
}
public @Override OutputListener hyperlink() {
String module = Utilities.xpath("revision/module", changeSet); // NOI18N
String rev = Utilities.xpath("revision", itemXML); // NOI18N
if (module == null || !module.startsWith("http") || rev == null) { // NOI18N
return null;
}
int r = Integer.parseInt(rev);
String path = getName();
int startRev, endRev;
switch (getEditType()) {
case edit:
startRev = r - 1;
endRev = r;
break;
case add:
startRev = 0;
endRev = r;
break;
case delete:
startRev = r - 1;
endRev = 0;
break;
default:
throw new AssertionError();
}
return new SubversionHyperlink(module, path, startRev, endRev, build.getJob());
}
}
List files = new ArrayList();
NodeList nl = itemXML.getElementsByTagName("path"); // NOI18N
for (int i = 0; i < nl.getLength(); i++) {
files.add(new SubversionFile((Element) nl.item(i)));
}
return files;
}
}
List items = new ArrayList();
NodeList nl = changeSet.getElementsByTagName("item"); // NOI18N
for (int i = 0; i < nl.getLength(); i++) {
items.add(new SubversionItem((Element) nl.item(i)));
}
return items;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy