/*
* The MIT License
*
* Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
*
* 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.model;
import hudson.Proc;
import hudson.util.DecodingStream;
import hudson.util.DualOutputStream;
import org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import java.io.File;
import java.io.IOException;
import java.io.PrintStream;
import java.io.Reader;
import static javax.xml.stream.XMLStreamConstants.*;
/**
* {@link Run} for {@link ExternalJob}.
*
* @author Kohsuke Kawaguchi
*/
public class ExternalRun extends Run<ExternalJob,ExternalRun> {
/**
* Loads a run from a log file.
*/
ExternalRun(ExternalJob owner, File runDir) throws IOException {
super(owner,runDir);
}
/**
* Creates a new run.
*/
ExternalRun(ExternalJob project) throws IOException {
super(project);
}
/**
* Instead of performing a build, run the specified command,
* record the log and its exit code, then call it a build.
*/
public void run(final String[] cmd) {
run(new Runner() {
public Result run(BuildListener listener) throws Exception {
Proc proc = new Proc.LocalProc(cmd,getEnvironment(listener),System.in,new DualOutputStream(System.out,listener.getLogger()));
return proc.join()==0?Result.SUCCESS:Result.FAILURE;
}
public void post(BuildListener listener) {
// do nothing
}
public void cleanUp(BuildListener listener) {
// do nothing
}
});
}
/**
* Instead of performing a build, accept the log and the return code
* from a remote machine.
*
* <p>
* The format of the XML is:
*
* <pre><xmp>
* <run>
* <log>...console output...</log>
* <result>exit code</result>
* </run>
* </xmp></pre>
*/
@SuppressWarnings({"Since15"})
@IgnoreJRERequirement
public void acceptRemoteSubmission(final Reader in) throws IOException {
final long[] duration = new long[1];
run(new Runner() {
private String elementText(XMLStreamReader r) throws XMLStreamException {
StringBuilder buf = new StringBuilder();
while(true) {
int type = r.next();
if(type== CHARACTERS || type== CDATA)
buf.append(r.getTextCharacters(), r.getTextStart(), r.getTextLength());
else
return buf.toString();
}
}
public Result run(BuildListener listener) throws Exception {
PrintStream logger = new PrintStream(new DecodingStream(listener.getLogger()));
XMLInputFactory xif = XMLInputFactory.newInstance();
XMLStreamReader p = xif.createXMLStreamReader(in);
p.nextTag(); // get to the <run>
p.nextTag(); // get to the <log>
charset=p.getAttributeValue(null,"content-encoding");
while(p.next()!= END_ELEMENT) {
int type = p.getEventType();
if(type== CHARACTERS || type== CDATA)
logger.print(p.getText());
}
p.nextTag(); // get to <result>
Result r = Integer.parseInt(elementText(p))==0?Result.SUCCESS:Result.FAILURE;
do {
p.nextTag();
if(p.getEventType()== START_ELEMENT){
if(p.getLocalName().equals("duration")) {
duration[0] = Long.parseLong(elementText(p));
}
else if(p.getLocalName().equals("displayName")) {
setDisplayName(p.getElementText());
}
else if(p.getLocalName().equals("description")) {
setDescription(p.getElementText());
}
}
} while(!(p.getEventType() == END_ELEMENT && p.getLocalName().equals("run")));
return r;
}
public void post(BuildListener listener) {
// do nothing
}
public void cleanUp(BuildListener listener) {
// do nothing
}
});
if(duration[0]!=0) {
super.duration = duration[0];
// save the updated duration
save();
}
}
}