sandbox-apis/virtualbox/src/main/java/org/jclouds/virtualbox/functions/CloneAndRegisterMachineFromIMachineIfNotAlreadyExists.java

/**
 * Licensed to jclouds, Inc. (jclouds) under one or more
 * contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  jclouds licenses this file
 * to you under the Apache 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.apache.org/licenses/LICENSE-2.0
 *
 * 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.jclouds.virtualbox.functions;

import com.google.common.base.Function;
import com.google.inject.Inject;
import org.jclouds.compute.ComputeServiceContext;
import org.jclouds.compute.reference.ComputeServiceConstants;
import org.jclouds.logging.Logger;
import org.virtualbox_4_1.*;

import javax.annotation.Nullable;
import javax.annotation.Resource;
import javax.inject.Named;
import java.util.ArrayList;
import java.util.List;

import static com.google.common.base.Preconditions.checkNotNull;
import static org.jclouds.virtualbox.util.MachineUtils.lockMachineAndApply;
import static org.virtualbox_4_1.LockType.Write;

/**
 * CloneAndRegisterMachineFromIMachineIfNotAlreadyExists will take care of the
 * followings: - cloning the master - register the clone machine -
 * ensureBridgedNetworkingIsAppliedToMachine(cloneName, macAddress,
 * hostInterface)
 *
 * @author Andrea Turli
 */
public class CloneAndRegisterMachineFromIMachineIfNotAlreadyExists implements Function<IMachine, IMachine> {

   @Resource
   @Named(ComputeServiceConstants.COMPUTE_LOGGER)
   protected Logger logger = Logger.NULL;

   private VirtualBoxManager manager;
   private ComputeServiceContext context;
   private String settingsFile;
   private String osTypeId;
   private String vmId;
   private boolean forceOverwrite;
   private String cloneName;
   private String hostId;
   private String snapshotName;
   private String snapshotDesc;
   private String controllerIDE;

   @Inject
   public CloneAndRegisterMachineFromIMachineIfNotAlreadyExists(
           VirtualBoxManager manager, ComputeServiceContext context,
           String settingsFile, String osTypeId, String vmId,
           boolean forceOverwrite, String cloneName, String hostId,
           String snapshotName, String snapshotDesc, String controllerIDE) {
      this.manager = manager;
      this.context = context;
      this.settingsFile = settingsFile;
      this.osTypeId = osTypeId;
      this.vmId = vmId;
      this.forceOverwrite = forceOverwrite;
      this.cloneName = cloneName;
      this.hostId = hostId;
      this.snapshotName = snapshotName;
      this.snapshotDesc = snapshotDesc;
      this.controllerIDE = controllerIDE;
   }

   @Override
   public IMachine apply(@Nullable IMachine master) {
      final IVirtualBox vBox = manager.getVBox();
      try {
         vBox.findMachine(cloneName);
         throw new IllegalStateException("Machine " + cloneName + " is already registered.");
      } catch (VBoxException e) {
         if (machineNotFoundException(e))
            return cloneMachine(cloneName, master);
         else
            throw e;
      }
   }

   private boolean machineNotFoundException(VBoxException e) {
      return e.getMessage().contains("VirtualBox error: Could not find a registered machine named ");
   }

   private IMachine cloneMachine(String cloneName, IMachine master) {
      IMachine clonedMachine = manager.getVBox().createMachine(settingsFile, cloneName, osTypeId, vmId, forceOverwrite);
      List<CloneOptions> options = new ArrayList<CloneOptions>();
      options.add(CloneOptions.Link);

      // takeSnapshotIfNotAlreadyExists
      ISnapshot currentSnapshot = new TakeSnapshotIfNotAlreadyAttached(manager, snapshotName, snapshotDesc).apply(master);

      // clone
      IProgress progress = currentSnapshot.getMachine().cloneTo(clonedMachine, CloneMode.MachineState, options);

      if (progress.getCompleted())
         logger.debug("clone done");

      // registering
      manager.getVBox().registerMachine(clonedMachine);

      // Bridged Network
      List<String> activeBridgedInterfaces = new RetrieveActiveBridgedInterfaces(context).apply(hostId);
      checkNotNull(activeBridgedInterfaces);
      String macAddress = manager.getVBox().getHost().generateMACAddress();

      // TODO this behavior can be improved
      String bridgedInterface = activeBridgedInterfaces.get(0);
      long adapterSlot = 0l;
      ensureBridgedNetworkingIsAppliedToMachine(adapterSlot, cloneName, macAddress, bridgedInterface);

      // detach iso
      // TODO: also hard-coded values here
      int controllerPort = 0;
      int device = 0;
      ensureMachineHasDistroMediumDetached(cloneName, controllerIDE, controllerPort, device);

      return clonedMachine;
   }

   private void ensureBridgedNetworkingIsAppliedToMachine(long adapterSlot, String vmName, String macAddress, String hostInterface) {
      lockMachineAndApply(manager, Write, vmName, new AttachBridgedAdapterToMachine(adapterSlot, macAddress, hostInterface));
   }

   private void ensureMachineHasDistroMediumDetached(String vmName, String controllerIDE, int controllerPort, int device) {
      lockMachineAndApply(manager, Write, vmName, new DetachDistroMediumFromMachine(checkNotNull(controllerIDE, "controllerIDE"), controllerPort, device));
   }

}