lab-manager 1.0.7 → 1.0.8

data/bin/lab_checkout.sh

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# ########################################################################################## 
+# lab_checkout.rb
+#
+#     bin/lab_checkout.rb "ORG" "WORKSPACE" "CONFIGURATION" "NEW CONFIGURATION"
+# ########################################################################################## 
+
+require 'rubygems'
+$:.unshift "#{File.dirname(__FILE__)}/../lib"
+require "lab_manager"
+
+if (ARGV.size < 4)
+  puts "usage: #{File.basename __FILE__} <organization> <workspace> <configuration> <new configuration>"
+  Process.exit(1)
+end
+
+organization = ARGV[0]
+workspace = ARGV[1]
+configuration = ARGV[2]
+new_configuration = ARGV[3]
+
+lab = LabManager.new(organization)
+lab.workspace = workspace
+lab.checkout(configuration, new_configuration)
+
+puts "Clone of library complete"
+

data/bin/lab_clone.sh

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# ########################################################################################## 
+# lab_clone.rb
+#
+#     bin/lab_clone.rb "ORG" "WORKSPACE" "CONFIGURATION" "NEW CONFIGURATION"
+# ########################################################################################## 
+
+require 'rubygems'
+$:.unshift "#{File.dirname(__FILE__)}/../lib"
+require "lab_manager"
+
+if (ARGV.size < 4)
+  puts "usage: #{File.basename __FILE__} <organization> <workspace> <configuration> <new configuration>"
+  Process.exit(1)
+end
+
+organization = ARGV[0]
+workspace = ARGV[1]
+configuration = ARGV[2]
+new_configuration = ARGV[3]
+
+lab = LabManager.new(organization)
+lab.workspace = workspace
+lab.clone(configuration, new_configuration)
+
+puts "Clone complete"
+

data/bin/lab_delete.sh

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# ########################################################################################## 
+# lab_delete.rb
+#
+#     bin/lab_delete.rb "ORG" "WORKSPACE" "CONFIGURATION"
+# ########################################################################################## 
+
+require 'rubygems'
+$:.unshift "#{File.dirname(__FILE__)}/../lib"
+require "lab_manager"
+
+if (ARGV.size < 3)
+  puts "usage: #{File.basename __FILE__} <organization> <workspace> <configuration>"
+  Process.exit(1)
+end
+
+organization = ARGV[0]
+workspace = ARGV[1]
+configuration = ARGV[2]
+
+lab = LabManager.new(organization)
+lab.workspace = workspace
+lab.delete(configuration)
+
+puts "Delete complete"
+

data/lib/lab_manager.rb

@@ -5,8 +5,10 @@ require 'soap/element'
 require 'soap/netHttpClient'
 require 'xsd/datatypes'
 require 'yaml'
+require 'ostruct'
 
 require 'lab_manager/machine'
+require 'lab_manager/configuration'
 
 require 'lab_manager/httpclient_patch'
 
@@ -65,32 +67,53 @@ class LabManager
     @organization = organization
   end
 
-  #<GetConfigurationByName xmlns="http://vmware.com/labmanager">
-  #  <name>string</name>
-  #</GetConfigurationByName>
-  #
-  #<GetConfigurationByNameResponse xmlns="http://vmware.com/labmanager">
-  #  <GetConfigurationByNameResult>
-  #    <Configuration>
-  #      <id>int</id>
-  #      <name>string</name>
-  #      <description>string</description>
-  #      <isPublic>boolean</isPublic>
-  #      <isDeployed>boolean</isDeployed>
-  #      <fenceMode>int</fenceMode>
-  #      <type>int</type>
-  #      <owner>string</owner>
-  #      <dateCreated>dateTime</dateCreated>
-  #      <autoDeleteInMilliSeconds>double</autoDeleteInMilliSeconds>
-  #      <bucketName>string</bucketName>
-  #      <mustBeFenced>NotSpecified or True or False</mustBeFenced>
-  #      <autoDeleteDateTime>dateTime</autoDeleteDateTime>
-  #    </Configuration>
-  #
-  def configuration(name)
-    proxy.GetConfigurationByName(:name => name)
+  # Retrieve configuration information
+  #
+  # ==== XML Sample
+  #
+  # <GetConfigurationByName xmlns="http://vmware.com/labmanager">
+  #   <name>string</name>
+  # </GetConfigurationByName>
+  #
+  # <GetConfigurationByNameResponse xmlns="http://vmware.com/labmanager">
+  #   <GetConfigurationByNameResult>
+  #     <Configuration>
+  #       <id>int</id>
+  #       <name>string</name>
+  #       <description>string</description>
+  #       <isPublic>boolean</isPublic>
+  #       <isDeployed>boolean</isDeployed>
+  #       <fenceMode>int</fenceMode>
+  #       <type>int</type>
+  #       <owner>string</owner>
+  #       <dateCreated>dateTime</dateCreated>
+  #       <autoDeleteInMilliSeconds>double</autoDeleteInMilliSeconds>
+  #       <bucketName>string</bucketName>
+  #       <mustBeFenced>NotSpecified or True or False</mustBeFenced>
+  #       <autoDeleteDateTime>dateTime</autoDeleteDateTime>
+  #     </Configuration>
+  # 
+  # * name_or_id can be a configuration name or a configuration id returned
+  # by another method. An id is identified as only digits.
+  #
+  def configuration(name_or_id)
+    if name_or_id =~ /^\d+$/
+      config_data = proxy.GetConfiguration(:configurationId => name_or_id)
+    else
+      config_data = proxy.GetConfigurationByName(:name => name_or_id)
+    end
+    Configuration.parse(config_data)
+  end
+
+  # Retrieve a list of configuration information
+  def configurations()
+    proxy.ListConfigurations(:configurationType => 2)
   end
 
+  #  Retrieve a list of machines in a configuration
+  #
+  # ==== XML Sample
+  #
   #  <ListMachines xmlns="http://vmware.com/labmanager">
   #    <configurationId>int</configurationId>
   #  </ListMachines>
@@ -112,15 +135,18 @@ class LabManager
   #        <HostNameDeployedOn>string</HostNameDeployedOn>
   #        <OwnerFullName>string</OwnerFullName>
   #      </Machine>
+  # 
+  # * configuration_name
+  #
+  # ==== Examples
   #
   #   lab_manager.machines("CONFIG NAME")
   #   lab_manager.machines("CONFIG NAME", :exclude => ["machine name"])
   #
-  def machines(configurationName, options = {})
-    configuration = proxy.GetConfigurationByName(:name => configurationName)
-    configurationId = configuration["GetConfigurationByNameResult"]["Configuration"]["id"]
+  def machines(configuration_name, options = {})
+    config = configuration(configuration_name)
 
-    data = proxy.ListMachines(:configurationId => configurationId)
+    data = proxy.ListMachines(:configurationId => config.id)
 
     machines = Machine.from_list(data)
 
@@ -133,13 +159,109 @@ class LabManager
     machines
   end
 
-  def machine(configurationName, machineName)
-    machines(configurationName).find { |machine|
+  # Retrieve the informaiton for a single machine in a configuration
+  def machine(configuration_name, machineName)
+    machines(configuration_name).find { |machine|
       machine.name == machineName
     }
   end
 
+  # Clones a configuration from a library.
+  #
+  # ==== XML Samples
+  #
+  #   <ConfigurationCheckout xmlns:n1="http://vmware.com/labmanager">
+  #     <configurationId>1138</configurationId>
+  #     <workspaceName>NEW TEST CONFIG</workspaceName>
+  #   </ConfigurationCheckout>
+  #
+  # * configuration_name to clone from the library
+  # * new_configuration_name to clone to
+  #
+  # return the new configuration id
+  #
+  def checkout(configuration_name, new_configuration_name)
+    config = configuration(configuration_name)
+
+    data = proxy.ConfigurationCheckout(
+              :configurationId => config.id,
+              :workspaceName => new_configuration_name)
+    data["ConfigurationCheckoutResult"]
+  end
+
+  # Clone a configuration to a new name
+  #
+  # ==== XML Sample
+  #
+  #  <ConfigurationClone xmlns="http://vmware.com/labmanager">
+  #     <configurationId>int</configurationId>
+  #     <newWorkspaceName>string</newWorkspaceName>
+  #  </ConfigurationClone>
+  #
+  #  <ConfigurationCloneResponse xmlns="http://vmware.com/labmanager">
+  #      <ConfigurationCloneResult>1150</ConfigurationCloneResult>
+  #  </ConfigurationCloneResponse>
+  #
+  # * configuration_name to clone
+  # * new_configuration_name to clone to
+  #
+  # returns the id of the cloned configuration.
+  #
+  def clone(configuration_name, new_configuration_name)
+    config = configuration(configuration_name)
+
+    data = proxy.ConfigurationClone(
+              :configurationId => config.id, 
+              :newWorkspaceName => new_configuration_name)
+    data["ConfigurationCloneResult"]
+  end
+
+  # Undeploys a configuration
+  # 
+  # ==== XML Sample
+  #
+  # * configuration_name to undeploy
+  #
+  def undeploy(configuration_name)
+    config = configuration(configuration_name)
+    
+    proxy.ConfigurationUndeploy(:configurationId => config.id)
+  end
+
+  # Delete a configuration
+  #
+  # ==== XML Sample
+  #
+  #  <ConfigurationDelete xmlns="http://vmware.com/labmanager">
+  #     <configurationId>int</configurationId>
+  #  </ConfigurationDelete>
+  #
+  #  <ConfigurationDeleteResponse xmlns="http://vmware.com/labmanager" />
+  #
+  # * configuration_name to be deleted
+  #
+  # raises SOAP:FaultError. See e.faultstring or e.detail
+  #
+  def delete(configuration_name, options = {})
+    config = configuration(configuration_name)
+
+    if (config.deployed)
+      fault = OpenStruct.new(
+          :faultstring => "Can not delete configuration that is deployed",
+          :detail => "Must use force flag to auto-undeploy.")
+      raise SOAP::FaultError.new(fault) unless options[:force]
+
+      proxy.ConfigurationUndeploy(:configurationId => config.id)
+    end
+
+    proxy.ConfigurationDelete(:configurationId => config.id)
+  end
+
   private
+  def self.config
+    YAML::load_file(@@configPath)
+  end
+
   def proxy
     factory = SOAP::WSDLDriverFactory.new("#{@@url}?WSDL")
     proxy = factory.create_rpc_driver
@@ -147,6 +269,9 @@ class LabManager
     proxy.generate_explicit_type = false  # No datatype with request
     proxy.headerhandler << LabManagerHeader.new(@organization, @workspace, @@username, @@password)
 
+    # The lab manager clone and checkout requests can take a long time.
+    proxy.streamhandler.client.receive_timeout = 15 * 60 # seconds
+
     #proxy.streamhandler.client.ssl_config.verify_mode = false
 
     proxy
@@ -154,10 +279,10 @@ class LabManager
 
   def load_config(url, username, password)
     if File.exists? @@configPath
-      config = YAML::load_file(@@configPath)
-      @@url = config["url"]
-      @@username = config["username"]
-      @@password = config["password"]
+      configData = LabManager.config
+      @@url = configData["url"]
+      @@username = configData["username"]
+      @@password = configData["password"]
     end
     
     @@url = url if !url.nil?

data/lib/lab_manager/configuration.rb

@@ -0,0 +1,23 @@
+class Configuration
+
+  def self.parse(data)
+
+    if !data.keys.empty? && data.keys.first != "Configuration"
+      data = data.values[0]
+    end
+
+    configuration = Configuration.new
+    data_config = data["Configuration"]
+    if data_config
+      configuration.id = data_config["id"]
+      configuration.name = data_config["name"]
+      configuration.deployed = data_config["isDeployed"] == "true" ? true : false
+    end
+
+    configuration
+  end
+
+  attr_accessor :id
+  attr_accessor :name
+  attr_accessor :deployed
+end

metadata

@@ -1,97 +1,84 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: lab-manager
-version: !ruby/object:Gem::Version 
-  hash: 25
+version: !ruby/object:Gem::Version
+  version: 1.0.8
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 7
-  version: 1.0.7
 platform: ruby
-authors: 
+authors:
 - Ed Sumerfield
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-11-05 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: mumboe-soap4r
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Access information about your Lab Manager configurations.
 email: esumerfield@ipcoop.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- lib/lab_manager/configuration.rb
 - lib/lab_manager/httpclient_patch.rb
 - lib/lab_manager/machine.rb
 - lib/lab_manager.rb
+- bin/lab_checkout.sh
+- bin/lab_clone.sh
+- bin/lab_delete.sh
 - bin/lab_machines.sh
-has_rdoc: true
 homepage: 
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Client for VMWare Lab Manager
 test_files: []
-