Merge pull request #10 from elordahl/snapshot_deletion

Adding snapshot deletion functionality

Author: jswager

pom.xml

@@ -66,9 +66,9 @@
             <type>jar</type>
         </dependency>
     <dependency>
-      <groupId>com.cloudbees.thirdparty</groupId>
+      <groupId>com.vmware</groupId>
       <artifactId>vijava</artifactId>
-      <version>5.0.0</version>
+      <version>5.1</version>
      </dependency>
     </dependencies>
 </project>  

src/main/java/org/jenkinsci/plugins/vsphere/builders/DeleteSnapshot.java

@@ -0,0 +1,147 @@
+/*   Copyright 2013, MANDIANT, Eric Lordahl
+ *
+ *   Licensed 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.jenkinsci.plugins.vsphere.builders;
+
+import hudson.EnvVars;
+import hudson.Extension;
+import hudson.Launcher;
+import hudson.model.BuildListener;
+import hudson.model.AbstractBuild;
+import hudson.util.FormValidation;
+
+import java.io.IOException;
+import java.io.PrintStream;
+
+import javax.servlet.ServletException;
+
+import org.jenkinsci.plugins.vsphere.VSphereBuildStep;
+import org.jenkinsci.plugins.vsphere.tools.VSphere;
+import org.jenkinsci.plugins.vsphere.tools.VSphereException;
+import org.jenkinsci.plugins.vsphere.tools.VSphereLogger;
+import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.QueryParameter;
+
+import com.vmware.vim25.mo.VirtualMachineSnapshot;
+
+public class DeleteSnapshot extends VSphereBuildStep {
+
+	private final String vm;    
+	private final String snapshotName;
+	private final boolean consolidate;
+	private final boolean failOnNoExist;
+
+	@DataBoundConstructor
+	public DeleteSnapshot(final String vm, final String snapshotName, final boolean consolidate, final boolean failOnNoExist) throws VSphereException {
+		this.vm = vm;
+		this.snapshotName = snapshotName;
+		this.consolidate = consolidate;
+		this.failOnNoExist = failOnNoExist;
+	}
+
+	public String getVm() {
+		return vm;
+	}
+
+	public String getSnapshotName() {
+		return snapshotName;
+	}
+
+	public boolean isConsolidate() {
+		return consolidate;
+	}
+
+	public boolean isFailOnNoExist() {
+		return failOnNoExist;
+	}
+
+	public boolean perform(final AbstractBuild<?, ?> build, Launcher launcher, final BuildListener listener) throws VSphereException {
+		return deleteSnapshot(build, launcher, listener);
+		//TODO throw AbortException instead of returning value
+	}
+
+	private boolean deleteSnapshot(final AbstractBuild<?, ?> build, Launcher launcher, final BuildListener listener) throws VSphereException{
+		PrintStream jLogger = listener.getLogger();
+		EnvVars env;
+		try {
+			env = build.getEnvironment(listener);
+		} catch (Exception e) {
+			throw new VSphereException(e);
+		}
+
+		env.overrideAll(build.getBuildVariables()); // Add in matrix axes..
+		String expandedSnap = env.expand(snapshotName);
+		String expandedVm = env.expand(vm);
+
+		VSphereLogger.vsLogger(jLogger, "Deleting snapshot \""+expandedSnap+"\" of VM "+expandedVm+"...");
+		vsphere.deleteSnapshot(expandedVm, expandedSnap, consolidate, failOnNoExist);
+		VSphereLogger.vsLogger(jLogger, "Complete.");
+
+		return true;
+	}
+
+	@Extension
+	public static class DeleteSnapshotDescriptor extends VSphereBuildStepDescriptor {
+
+		@Override
+		public String getDisplayName() {
+			return Messages.vm_title_DeleteSnapshot();
+		}
+
+		public FormValidation doCheckVm(@QueryParameter String value)
+				throws IOException, ServletException {
+
+			if (value.length() == 0)
+				return FormValidation.error(Messages.validation_required("the VM name"));
+			return FormValidation.ok();
+		}
+
+		public FormValidation doCheckSnapshotName(@QueryParameter String value)
+				throws IOException, ServletException {
+
+			if (value.length() == 0)
+				return FormValidation.error(Messages.validation_required("the snapshot name"));
+			return FormValidation.ok();
+		}
+
+		public FormValidation doTestData(@QueryParameter String serverName,
+				@QueryParameter String vm, @QueryParameter String snapshotName) {
+			try {
+
+				if (vm.length() == 0 || serverName.length()==0 || snapshotName.length()==0)
+					return FormValidation.error(Messages.validation_requiredValues());
+
+				VSphere vsphere = getVSphereCloudByName(serverName).vSphereInstance();
+
+				if (vm.indexOf('$') >= 0)
+					return FormValidation.warning(Messages.validation_buildParameter("VM"));
+
+				if (vsphere.getVmByName(vm) == null)
+					return FormValidation.error(Messages.validation_notFound("VM"));
+
+				if (snapshotName.indexOf('$') >= 0)
+					return FormValidation.warning(Messages.validation_buildParameter("Snapshot"));
+
+				VirtualMachineSnapshot snap = vsphere.getSnapshotInTree(vsphere.getVmByName(vm), snapshotName);
+				if (snap==null){
+					return FormValidation.error(Messages.validation_notFound("Snapshot"));
+				}
+
+				return FormValidation.ok(Messages.validation_success());
+			} catch (Exception e) {
+				throw new RuntimeException(e);
+			}
+		}
+	}
+}

src/main/java/org/jenkinsci/plugins/vsphere/tools/VSphere.java

@@ -193,7 +193,7 @@ private ManagedObjectReference findSnapshotInTree(
 	}
 
 	public VirtualMachineSnapshot getSnapshotInTree(
-			VirtualMachine vm, String snapName) throws VSphereException {
+			VirtualMachine vm, String snapName) {
 		if (vm == null || snapName == null) {
 			return null;
 		}
@@ -212,10 +212,7 @@ public VirtualMachineSnapshot getSnapshotInTree(
 				}
 			}
 		}
-		else
-		{
-			throw new VSphereException("No snapshots exist or unable to access the snapshot array");
-		}            
+
 		return null;
 	}
 
@@ -238,6 +235,40 @@ public void revertToSnapshot(String vmName, String snapName) throws VSphereExcep
 		}
 	}
 
+	public void deleteSnapshot(String vmName, String snapName, boolean consolidate, boolean failOnNoExist) throws VSphereException{
+
+		VirtualMachine vm = getVmByName(vmName);
+		VirtualMachineSnapshot snap = getSnapshotInTree(vm, snapName);
+
+		if (snap == null && failOnNoExist) {
+			throw new VSphereException("Virtual Machine snapshot cannot be found");
+		}
+
+		try{
+
+			Task task;
+			if (snap!=null){
+				//Does not delete subtree; Implicitly consolidates disk
+				task = snap.removeSnapshot_Task(false);
+				if (!task.waitForTask().equals(Task.SUCCESS)) {
+					throw new VSphereException("Could not delete snapshot");
+				}
+			}
+
+			if(!consolidate)
+				return;
+
+			//This might be redundant, but I think it consolidates all disks,
+			//where as the removeSnapshot only consolidates the individual disk
+			task = vm.consolidateVMDisks_Task();
+			if (!task.waitForTask().equals(Task.SUCCESS)) {
+				throw new VSphereException("Could not consolidate VM disks");
+			}
+		}catch(Exception e){
+			throw new VSphereException(e);
+		}
+	}
+
 	public void takeSnapshot(String vmName, String snapshot, String description, boolean snapMemory) throws VSphereException{
 
 		try {

src/main/resources/org/jenkinsci/plugins/vsphere/builders/DeleteSnapshot/config.jelly

@@ -0,0 +1,35 @@
+<!--
+Copyright 2013, MANDIANT, Eric Lordahl
+
+Licensed 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.
+-->
+ 
+<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form">
+	<f:entry title="${%VM}" field="vm">
+      <f:textbox  />
+    </f:entry>
+	
+	<f:entry title="${%Snapshot Name}" field="snapshotName">
+	  <f:textbox />
+	</f:entry>
+	
+	<f:entry title="${%Consolidate disks?}" field="consolidate">
+	  <f:checkbox />
+	</f:entry>
+	
+	<f:entry title="${%Fail on null?}" field="failOnNoExist">
+  	  <f:checkbox  />
+  	</f:entry>
+	
+	<f:validateButton title="${%Check Data}" progress="${%Testing...}" method="testData" with="serverName,vm,snapshotName"/>
+</j:jelly>

src/main/resources/org/jenkinsci/plugins/vsphere/builders/DeleteSnapshot/help-consolidate.html

@@ -0,0 +1,3 @@
+<div>
+ Consolidate all redundant redo logs for this VM?
+</div>

src/main/resources/org/jenkinsci/plugins/vsphere/builders/DeleteSnapshot/help-failOnNoExist.html

@@ -0,0 +1,3 @@
+<div>
+  If the snapshot you are trying to delete doesnt exist, fail this build step.  Sometimes, the job doesnt care if deletion was successful and only wants it gone---if this is the case, leave unchecked.
+</div>

src/main/resources/org/jenkinsci/plugins/vsphere/builders/DeleteSnapshot/help-snapshotName.html

@@ -0,0 +1,3 @@
+<div>
+ The name of the snapshot.
+</div>

src/main/resources/org/jenkinsci/plugins/vsphere/builders/DeleteSnapshot/help-vm.html

@@ -0,0 +1,3 @@
+<div>
+  The name of the VM.
+</div>

src/main/resources/org/jenkinsci/plugins/vsphere/builders/Messages.properties

@@ -8,7 +8,8 @@ vm.title.PowerOn=Power-On/Resume VM
 vm.title.PowerOff=Power-Off VM
 vm.title.SuspendVM=Suspend VM
 vm.title.RevertToSnapshot=Revert to Snapshot
-vm.title.TakeSnapshot=Take snapshot
+vm.title.TakeSnapshot=Take Snapshot
+vm.title.DeleteSnapshot=Delete a Snapshot
 
 validation.requiredValues=Please enter required values!
 validation.required=Please enter {0}!