org.kuali.maven.plugins.jenkins.CliMojo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jenkins-maven-plugin Show documentation

Automated management of Jenkins jobs via Maven. Much of the information needed by Jenkins when creating a job is already in the Maven pom. The SCM information and CI url are present there. Jenkins jobs also typically have names that reflect the groupId, artifactId, and version in some manner. This plugin automates the process of creating Jenkins jobs by harvesting information from the POM to create XML config files in the format Jenkins needs. The Jenkins CLI wrapper is then used to create, update, read, and delete Jenkins jobs on the CI server.

There is a newer version: 1.2.8

Show newest version

/**
 * Copyright 2011-2012 The Kuali Foundation
 *
 * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
 *
 * 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.kuali.maven.plugins.jenkins;

import java.util.List;

/**
 * Connect to a Jenkins server and execute one or more Jenkins CLI commands.
 *
 * @goal cli
 * @threadSafe
 * @requiresDependencyResolution test
 */
public class CliMojo extends BaseMojo {

    /**
     * Jenkins CLI command to issue eg "help", "version", "who-ami-i", "build my-job -c -s" etc
     *
     * @parameter expression="${jenkins.cmd}" default-value="version"
     * @required
     */
    private String cmd;

    /**
     * Anything supplied here is provided as input to the standard input stream of Jenkins CLI
     *
     * @parameter expression="${jenkins.stdin}"
     */
    private String stdin;

    /**
     * This can be a file on the file system, a classpath resource using Spring's "classpath:" notation, or any other
     * url Spring 3.0 resource loading can understand. If supplied, the content of the url is provided as input to the
     * standard input stream of Jenkins CLI. If 'stdinUrl' is supplied 'stdin' is ignored.
     *
     * @parameter expression="${jenkins.stdinUrl}"
     */
    private String stdinUrl;

    /**
     * List of commands to issue to Jenkins CLI eg "help", "version", "who-ami-i" etc
     *
     * If 'cmds' is provided 'cmd' is ignored
     *
     * @parameter
     */
    private List commands;

    @Override
    protected void executeMojo() {
        helper.execute(this);
    }

    public String getCmd() {
        return cmd;
    }

    public void setCmd(String cmd) {
        this.cmd = cmd;
    }

    public String getStdin() {
        return stdin;
    }

    public void setStdin(String stdin) {
        this.stdin = stdin;
    }

    public String getStdinUrl() {
        return stdinUrl;
    }

    public void setStdinUrl(String stdinUrl) {
        this.stdinUrl = stdinUrl;
    }

    public List getCommands() {
        return commands;
    }

    public void setCommands(List commands) {
        this.commands = commands;
    }

}