PageRenderTime 11ms CodeModel.GetById 2ms app.highlight 6ms RepoModel.GetById 1ms app.codeStats 0ms

/hudson-core/src/main/java/hudson/cli/CommandDuringBuild.java

http://github.com/hudson/hudson
Java | 82 lines | 39 code | 8 blank | 35 comment | 5 complexity | 9abff734f434f9a1fdb0b91bd8a8c929 MD5 | raw file
 1/*
 2 * The MIT License
 3 *
 4 * Copyright (c) 2010, InfraDNA, Inc.
 5 *
 6 * Permission is hereby granted, free of charge, to any person obtaining a copy
 7 * of this software and associated documentation files (the "Software"), to deal
 8 * in the Software without restriction, including without limitation the rights
 9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24
25package hudson.cli;
26
27import hudson.model.Hudson;
28import hudson.model.Job;
29import hudson.model.Run;
30import hudson.remoting.Callable;
31import org.kohsuke.args4j.CmdLineException;
32
33import java.io.IOException;
34
35/**
36 * Base class for those commands that are valid only during a build.
37 *
38 * @author Kohsuke Kawaguchi
39 */
40public abstract class CommandDuringBuild extends CLICommand {
41    /**
42     * This method makes sense only when called from within the build kicked by Hudson.
43     * We use the environment variables that Hudson sets to determine the build that is being run.
44     */
45    protected Run getCurrentlyBuilding() throws CmdLineException {
46        try {
47            CLICommand c = CLICommand.getCurrent();
48            if (c==null)    throw new IllegalStateException("Not executing a CLI command");
49            String[] envs = c.channel.call(new GetCharacteristicEnvironmentVariables());
50
51            if (envs[0]==null || envs[1]==null)
52                throw new CmdLineException("This CLI command works only when invoked from inside a build");
53
54            Job j = Hudson.getInstance().getItemByFullName(envs[0],Job.class);
55            if (j==null)    throw new CmdLineException("No such job: "+envs[0]);
56
57            try {
58                Run r = j.getBuildByNumber(Integer.parseInt(envs[1]));
59                if (r==null)    throw new CmdLineException("No such build #"+envs[1]+" in "+envs[0]);
60                return r;
61            } catch (NumberFormatException e) {
62                throw new CmdLineException("Invalid build number: "+envs[1]);
63            }
64        } catch (IOException e) {
65            throw new CmdLineException("Failed to identify the build being executed",e);
66        } catch (InterruptedException e) {
67            throw new CmdLineException("Failed to identify the build being executed",e);
68        }
69    }
70
71    /**
72     * Gets the environment variables that points to the build being executed.
73     */
74    private static final class GetCharacteristicEnvironmentVariables implements Callable<String[],IOException> {
75        public String[] call() throws IOException {
76            return new String[] {
77                System.getenv("JOB_NAME"),
78                System.getenv("BUILD_NUMBER")
79            };
80        }
81    }
82}