VirtualBoxPlugin.java

package hudson.plugins.virtualbox;

import hudson.Plugin;
import hudson.model.Hudson;
import hudson.model.Node;
import hudson.slaves.Cloud;
import hudson.util.ListBoxModel;
import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;

import javax.servlet.ServletException;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.logging.Logger;

/**
 * TODO see https://jax-ws.dev.java.net/issues/show_bug.cgi?id=554
 *
 * @author Evgeny Mandrikov
 */
public class VirtualBoxPlugin extends Plugin {

  private static final Logger LOG = Logger.getLogger(VirtualBoxPlugin.class.getName());

  @Override
  public void start() throws Exception {
    LOG.info("Starting " + getClass().getSimpleName());
    super.start();
  }

  @Override
  public void stop() throws Exception {
    LOG.info("Stopping " + getClass().getSimpleName());
    super.stop();
  }

  /**
   * @return all registered {@link VirtualBoxCloud}
   */
  public static List<VirtualBoxCloud> getHosts() {
    List<VirtualBoxCloud> result = new ArrayList<VirtualBoxCloud>();
    for (Cloud cloud : Hudson.getInstance().clouds) {
      if (cloud instanceof VirtualBoxCloud) {
        result.add((VirtualBoxCloud) cloud);
      }
    }
    return result;
  }

  /**
   * @param hostName host name
   * @return {@link VirtualBoxCloud} by specified name, null if not found
   */
  public static VirtualBoxCloud getHost(String hostName) {
    if (hostName == null) {
      return null;
    }
    for (VirtualBoxCloud host : getHosts()) {
      if (hostName.equals(host.getDisplayName())) {
        return host;
      }
    }
    return null;
  }

  /**
   * @param hostName host name
   * @return all registered {@link VirtualBoxMachine} from specified host, empty list if unknown host
   */
  public static List<VirtualBoxMachine> getDefinedVirtualMachines(String hostName) {
    VirtualBoxCloud host = getHost(hostName);
    if (host == null) {
      return Collections.emptyList();
    }
    return host.getVirtualMachines();
  }

  /**
   * @param hostName           host name
   * @param virtualMachineName virtual machine name
   * @return {@link VirtualBoxMachine} from specified host with specified name, null if not found
   */
  public static VirtualBoxMachine getVirtualBoxMachine(String hostName, String virtualMachineName) {
    if (virtualMachineName == null) {
      return null;
    }
    VirtualBoxCloud host = VirtualBoxPlugin.getHost(hostName);
    if (host == null) {
      return null;
    }
    for (VirtualBoxMachine machine : host.getVirtualMachines()) {
      if (virtualMachineName.equals(machine.getName())) {
        return machine;
      }
    }
    return null;
  }

  /**
   * For UI.
   */
  @SuppressWarnings({"UnusedDeclaration", "JavaDoc"})
  public void doComputerNameValues(StaplerRequest req, StaplerResponse resp, @QueryParameter("hostName") String hostName)
      throws IOException, ServletException {
    ListBoxModel m = new ListBoxModel();
    List<VirtualBoxMachine> virtualMachines = getDefinedVirtualMachines(hostName);
    if (virtualMachines != null && virtualMachines.size() > 0) {
      for (VirtualBoxMachine vm : virtualMachines) {
        m.add(new ListBoxModel.Option(vm.getName(), vm.getName()));
      }
      m.get(0).selected = true;
    }
    m.writeTo(req, resp);
  }

  /**
   * Used for discovering {@link VirtualBoxSlave} with specified MAC Address.
   * HTTP 404 Error will be returned, if slave can't be found.
   * <p>
   * For example: if slave named "virtual" has MAC Adress 080027E852CC, then
   * http://localhost:8080/hudson/plugin/virtualbox/getSlaveAgent?macAddress=080027E852CC
   * redirects to
   * http://localhost:8080/hudson/computer/virtual/slave-agent.jnlp
   * </p>
   *
   * @param req        request
   * @param resp       response
   * @param macAddress MAC Address
   * @throws IOException if something wrong
   */
  @SuppressWarnings({"UnusedDeclaration"})
  public void doGetSlaveAgent(StaplerRequest req, StaplerResponse resp, @QueryParameter("macAddress") String macAddress)
      throws IOException {
    LOG.info("Searching VirtualBox machine with MacAddress " + macAddress);
    for (Node node : Hudson.getInstance().getNodes()) {
      if (node instanceof VirtualBoxSlave) {
        VirtualBoxSlave slave = (VirtualBoxSlave) node;
        VirtualBoxMachine vbox = getVirtualBoxMachine(slave.getHostName(), slave.getVirtualMachineName());

        String vboxMacAddress = VirtualBoxUtils.getMacAddress(vbox);
        LOG.info("MacAddress for " + slave.getNodeName() + " is " + vboxMacAddress);

        if (macAddress.equalsIgnoreCase(vboxMacAddress)) {
          String url = Hudson.getInstance().getRootUrl() + "/computer/" + slave.getNodeName() + "/slave-agent.jnlp";
          LOG.info("Found " + slave + " for Mac Address " + macAddress + ", sending redirect to " + url);
          resp.sendRedirect(url);
          return;
        }
      }
    }
    resp.sendError(404);
  }
}