org.hudsonci.maven.plugin.install.SlaveBundleInstaller Maven / Gradle / Ivy

Go to download
/**
 * The MIT License
 *
 * Copyright (c) 2010-2011 Sonatype, Inc. All rights reserved.
 *
 * 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 org.hudsonci.maven.plugin.install;

import org.hudsonci.events.EventConsumer;
import org.hudsonci.events.ready.ReadyEvent;

import hudson.FilePath;
import hudson.model.Computer;
import hudson.model.Executor;
import hudson.model.Node;
import hudson.model.TaskListener;
import hudson.remoting.Channel;
import hudson.slaves.ComputerListener;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.inject.Named;
import javax.inject.Singleton;
import java.io.IOException;
import java.net.URL;
import java.util.EventObject;

/**
 * Handles installation of the slave bundle.
 *
 * @author Jason Dillon
 * @since 2.1.0
 */
@Named
@Singleton
public class SlaveBundleInstaller
    extends ComputerListener
    implements EventConsumer
{
    private static final Logger log = LoggerFactory.getLogger(SlaveBundleInstaller.class);

    public static final String BASE_PATH = "maven/slavebundle";

    public static final String BUNDLE_ARCHIVE = "maven3-slavebundle.zip";

    private boolean install(final FilePath root, TaskListener listener) throws IOException, InterruptedException {
        assert root != null;
        if (listener == null) {
            listener = TaskListener.NULL;
        }

        String resource = BUNDLE_ARCHIVE;
        URL url = SlaveBundleInstaller.class.getResource(resource);
        if (url == null) {
            throw new RuntimeException("Unable to install Maven 3 slave " +
                    "bundle; missing resource: " + resource);
        }

        FilePath dir = new FilePath(root, BASE_PATH);
        dir.mkdirs();
        log.debug("Maven slave bundle installation directory: {}", dir);

        return dir.installIfNecessaryFrom(url, listener, "Installing: " + resource);
    }

    /**
     * Handles installation onto the master node.
     */
    public void consume(final EventObject event) throws Exception {
        if (event instanceof ReadyEvent) {
            ReadyEvent target = (ReadyEvent)event;
            FilePath root = target.getHudson().getRootPath();

            if (install(root, null)) {
                log.info("Maven slave bundle installed");
            }
        }
    }

    /**
     * Handles installation onto slave nodes.
     */
    @Override
    public void preOnline(final Computer c, final Channel channel, final FilePath root, final TaskListener listener)
        throws IOException, InterruptedException
    {
        if (install(root, listener)) {
            listener.getLogger().println("done");
            log.info("Maven slave bundle installed on computer: {}", c.getName());
        }
    }

    /**
     * Get a reference to the installed bundle root.
     */
    public static FilePath getInstallRoot() throws IOException, InterruptedException {
        return getInstallRoot(Executor.currentExecutor().getOwner().getNode());
    }

    /**
     * Get a reference to the installed bundle root.
     */
    public static FilePath getInstallRoot(final Node node) throws IOException, InterruptedException {
        return node.getRootPath().child(BASE_PATH);
    }
}