miq_dev_util 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33a5c74387d9a90323882a0e7f42bfd9c5f9b6a4
-  data.tar.gz: ef62be82dd8cdbe7a413c8b475525601635bbbe5
+  metadata.gz: f2483591e6af4106bc28390033ee7eb5e2777a69
+  data.tar.gz: ed101b6f73c32ce124b2ce6da506959a9e79dde8
 SHA512:
-  metadata.gz: 52e186e3600569868cb0d81df87fca5c07ca228f7f167f1ea1678ffb51d35d10b573e313ac31ab906ecd8d685fc23177d03b4a0f149ec87793c180317bd1faa2
-  data.tar.gz: 7b313077919931919e36539d471fd4d783d32e33fd5e487161b30a2a153cd371aed45127b633b46939eb5f22901511a5cae93812269b1c1c543dd2b029004adc
+  metadata.gz: 348952bfb3fa0fc9fdd08e9e27e66678bcb54832458361fd69ec553207f23f3c031bb042d45deead4dc0a000f05766c2a9f11dcc0b9043bd0ce039290e29ff2f
+  data.tar.gz: 467a0d3fecf09f34da2c85ecc8fd387f18970b529dcae44d20fa57055d68685b67973ccf36f7215b9d41a84f0398053b8c59c0a813d325942a34c230142b3325

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 *.swp
+.DS_Store

data/Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in miq_dev_util.gemspec
 gemspec
+gem 'simplecov', :require => false, :group => :test

data/README.md

@@ -4,13 +4,87 @@ This is a set of helper classes to make developing in the ManageIQ automate
 model less cumbersome. By putting helper code and commonly used methods in this
 gem we can reduce the amount of code copied and pasted between methods.
 
+
 ## Installation
 
-    $ gem install miq_dev_util
+```
+$ gem install miq_dev_util
+```
+
 
 ## Usage
 
-    require 'miq_dev_util'
+```ruby
+# Pull the gem in to we can use it
+require 'miq_dev_util'
+```
+
+### Logging ###
+
+```ruby
+@logger = MiqDevUtil::Logger.new($evm, 'my_method_name')
+@logger.log(:info, 'Hello World')
+
+@logger.dump_root
+
+@logger.dump_attributes($evm.root['vm'], 'root vm')
+@logger.dump_associations($evm.root['vm'], 'root vm')
+@logger.dump_virtual_columns($evm.root['vm'], 'root vm')
+
+@logger.dump_info($evm.root['vm'], 'root vm') # dumps attributes,
+                                              #       associations and
+                                              #       virtual_columns
+```
+
+### EMS Credentials ###
+
+```ruby
+vm = $evm.root['vm']
+credentials = MiqDevUtil::EMS.get_credentials(vm.ext_management_system)
+vim = RbVmomi::VIM.connect credentials
+```
+
+### Automate Model ###
+
+```ruby
+automate_helper = MiqDevUtil::Automate.new($evm)
+
+# Instantiate an automate instance at path or raise an exception with the
+# message provided if the instantiation returns nil (not found).
+automate_helper.instantiate_or_raise(path, message)
+
+# This is a hacky workaround used to get an instance without executing the
+# methods on it. It fails if a message is passed in the path or if the
+# message field on the any of the methods are *.
+automate_helper.get_instance_with_attributes(path)
+
+
+# Condense multiple types of VM lookups into one call. This is useful when
+# making an Automate method generic enough to be used during provisioning,
+# with a custom button, or as a catalog item.
+#
+# Lookup methods used and their order can be overridden by specifying
+# :lookup_order. The default is [:rootvm, :dialog_id, :provision]
+#
+#   * :rootvm    = $evm.root['vm']
+#   * :dialog_id = look up the VM in vmdb using the VMDB ID from a dialog
+#   * :provision = $evm.root['miq_provision'].vm
+#
+#
+# The dialog name that may hold the miq ID is specified via :dialog_name
+#
+
+vm = resolve_vm
+vm = resolve_vm(lookup_order: [:dialog_id], dialog_name: 'dialog_vm_id')
+```
+
+### Generic Code ###
+
+```ruby
+# Perform a deep copy on objects that support marshalling.
+MiqDevUtil::Code.deep_copy(object)
+```
+
 
 ## Development
 
@@ -18,6 +92,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ewannema/miq_dev_util.

data/lib/miq_dev_util/automate.rb

@@ -1,34 +1,77 @@
-# The Automate class is intended to hold methods that are useful when
-# interacting with the ManageIQ automate system directly.
+module MiqDevUtil
+  # The Automate class is intended to hold methods that are useful when
+  # interacting with the ManageIQ automate system directly.
+  class Automate
+    def initialize(evm)
+      @evm = evm
+    end
 
-class MiqDevUtil::Automate
+    # Instantiate an automate instance at path or raise an exception with the
+    # message provided if the instantiation returns nil (not found).
+    def instantiate_or_raise(path, message)
+      object = @evm.instantiate(path)
+      if object.nil?
+        raise message
+      end
 
-  def initialize(evm)
-    @evm = evm
-  end
+      object
+    end
 
-  # Instantiate an automate instance at path or raise an exception with the
-  # message provided if the instantiation returns nil (not found).
-  def instantiate_or_raise(path, message)
-    object = @evm.instantiate(path)
-    if object.nil?
-      raise message
+    # This is a hacky workaround used to get an instance without executing the
+    # methods on it. It fails if a message is passed in the path or if the
+    # message field on the any of the methods are *.
+    def get_instance_with_attributes(path)
+      if path =~ /#/
+        raise "Does not work with messages in the path."
+      end
+      fake_message = "callingWithAFakeMessage"
+      empty_instance = @evm.instantiate("#{path}##{fake_message}")
+      instance_name = empty_instance.name
+      @evm.instance_get(instance_name)
     end
 
-    object
-  end
+    # Condense multiple types of VM lookups into one call. This is useful when
+    # making an Automate method generic enough to be used during provisioning,
+    # with a custom button, or as a catalog item.
+    #
+    # Lookup methods used and their order can be overridden by specifying
+    # :lookup_order
+    #
+    # The dialog name that may hold the miq ID is specified via :dialog_name
+    def resolve_vm(lookup_order: [:rootvm, :dialog_id, :provision],
+                   dialog_name: 'dialog_target_server')
+
+      vm = nil
+      lookup_order.each do |lu_method|
+        vm = vm_lookup_by(lu_method, dialog_name)
+
+        # If we found a VM we can stop looking
+        break unless vm.nil?
+      end
+
+      vm
+    end
+
+    private
+
+    def vm_lookup_by(lu_method, dialog_name = nil)
+      case lu_method
+      when :rootvm    then @evm.root['vm']
+      when :dialog_id then vm_by_id(@evm.root[dialog_name])
+      when :provision then provision_vm
+      else fail "unknown lookup method #{lu_method}"
+      end
+    end
 
-  # This is a hacky workaround used to get an instance without executing the
-  # methods on it. It fails if a message is passed in the path or if the
-  # message field on the any of the methods are *.
-  def get_instance_with_attributes(path)
-    if path =~ /#/
-      raise "Does not work with messages in the path."
+    def vm_by_id(vm_id)
+      @evm.vmdb('vm_or_template', vm_id)
+    rescue StandardError
+      nil
+    end
+
+    def provision_vm
+      return nil unless @evm.root['miq_provision'].respond_to?('vm')
+      @evm.root['miq_provision'].vm
     end
-    fake_message = "callingWithAFakeMessage"
-    empty_instance = @evm.instantiate("#{path}##{fake_message}")
-    instance_name = empty_instance.name
-    @evm.instance_get(instance_name)
   end
 end
-

data/lib/miq_dev_util/version.rb

@@ -1,3 +1,3 @@
 module MiqDevUtil
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: miq_dev_util
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Eric Wannemacher
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-30 00:00:00.000000000 Z
+date: 2015-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler