Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[JENKINS-21202] - Generalization of Command installers
This change adds an AbstractCommandInstaller, which can be extended for every script-based installation command. Related to https://issues.jenkins-ci.org/browse/JENKINS-21202 Signed-off-by: Oleg Nenashev <nenashev@synopsys.com>
- Loading branch information
1 parent
1e849c0
commit 38afe16
Showing
27 changed files
with
130 additions
and
70 deletions.
There are no files selected for viewing
119 changes: 119 additions & 0 deletions
119
core/src/main/java/hudson/tools/AbstractCommandInstaller.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| /* | ||
| * The MIT License | ||
| * | ||
| * Copyright 2009-2014 Sun Microsystems and contributors | ||
| * | ||
| * 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.tools; | ||
|
|
||
| import hudson.FilePath; | ||
| import hudson.model.Node; | ||
| import hudson.model.TaskListener; | ||
| import hudson.util.FormValidation; | ||
| import java.io.IOException; | ||
| import org.kohsuke.stapler.QueryParameter; | ||
|
|
||
| /** | ||
| * A generic script-based installer. | ||
| * @since TODO: define a version | ||
| * @see BatchCommandInstaller | ||
| * @see CommandInstaller | ||
| * @author Oleg Nenashev | ||
| * | ||
| */ | ||
| public abstract class AbstractCommandInstaller extends ToolInstaller { | ||
|
|
||
| /** | ||
| * Command to execute, similar to {@link CommandInterpreter#command}. | ||
| */ | ||
| private final String command; | ||
| private final String toolHome; | ||
|
|
||
| public AbstractCommandInstaller(String label, String command, String toolHome) { | ||
| super(label); | ||
| this.command = fixCrLf(command); | ||
| this.toolHome = toolHome; | ||
| } | ||
|
|
||
| public String getCommand() { | ||
| return command; | ||
| } | ||
|
|
||
| public String getToolHome() { | ||
| return toolHome; | ||
| } | ||
|
|
||
| public abstract String getCommandFileExtension(); | ||
|
|
||
| /** | ||
| * Retrieves a call for remote script caller. | ||
| */ | ||
| public abstract String[] getCommandCall(FilePath script); | ||
|
|
||
| @Override | ||
| public FilePath performInstallation(ToolInstallation tool, Node node, TaskListener log) throws IOException, InterruptedException { | ||
| FilePath dir = preferredLocation(tool, node); | ||
| // XXX support Windows batch scripts, Unix scripts with interpreter line, etc. (see CommandInterpreter subclasses) | ||
| FilePath script = dir.createTextTempFile("hudson", getCommandFileExtension(), command); | ||
| try { | ||
| String cmd[] = getCommandCall(script); | ||
| int r = node.createLauncher(log).launch().cmds(cmd).stdout(log).pwd(dir).join(); | ||
| if (r != 0) { | ||
| throw new IOException("Command returned status " + r); | ||
| } | ||
| } finally { | ||
| script.delete(); | ||
| } | ||
| return dir.child(getToolHome()); | ||
| } | ||
|
|
||
| /** | ||
| * Fix CR/LF and always make it Unix style. | ||
| */ | ||
| //TODO: replace by a Windows style | ||
| private static String fixCrLf(String s) { | ||
| // eliminate CR | ||
| int idx; | ||
| while ((idx = s.indexOf("\r\n")) != -1) { | ||
| s = s.substring(0, idx) + s.substring(idx + 1); | ||
| } | ||
| return s; | ||
| } | ||
|
|
||
| public static abstract class Descriptor<TInstallerClass extends AbstractCommandInstaller> | ||
| extends ToolInstallerDescriptor<TInstallerClass> { | ||
|
|
||
| public FormValidation doCheckCommand(@QueryParameter String value) { | ||
| if (value.length() > 0) { | ||
| return FormValidation.ok(); | ||
| } else { | ||
| return FormValidation.error(Messages.CommandInstaller_no_command()); | ||
| } | ||
| } | ||
|
|
||
| public FormValidation doCheckToolHome(@QueryParameter String value) { | ||
| if (value.length() > 0) { | ||
| return FormValidation.ok(); | ||
| } else { | ||
| return FormValidation.error(Messages.CommandInstaller_no_command()); | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.