miq_dev_util 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2483591e6af4106bc28390033ee7eb5e2777a69
-  data.tar.gz: ed101b6f73c32ce124b2ce6da506959a9e79dde8
+  metadata.gz: e8a90e284793baf979cfe5c906008182dd3f9c51
+  data.tar.gz: f6ee7f7670c173d08c69815b56b33119e69b4052
 SHA512:
-  metadata.gz: 348952bfb3fa0fc9fdd08e9e27e66678bcb54832458361fd69ec553207f23f3c031bb042d45deead4dc0a000f05766c2a9f11dcc0b9043bd0ce039290e29ff2f
-  data.tar.gz: 467a0d3fecf09f34da2c85ecc8fd387f18970b529dcae44d20fa57055d68685b67973ccf36f7215b9d41a84f0398053b8c59c0a813d325942a34c230142b3325
+  metadata.gz: 61d09ccfe9ba091900db987e2fb093f67cc9ee0e6259b4e26735b945dbf9148ab9ed584309087b06ac47d4820a6bbe5d4353ddb85f1b79e25eb3186fa1b83e94
+  data.tar.gz: 06d86d98fbbeedfa6c01e098f9f0685e60b2c8cb2409ee3931ed36301074dd1dcad36827f0b36f9a8cfd3616e1acdb70113dffc1e981ef2c07c7cdf8904fae50

data/README.md

@@ -4,6 +4,9 @@ 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.
 
+The master branch and version 1.x are being targeted for CloudForms 4.1. If you
+want support for CloudForms 3.2, please use the 0.x releases based upon the 3.2
+branch.
 
 ## Installation
 
@@ -25,6 +28,11 @@ require 'miq_dev_util'
 @logger = MiqDevUtil::Logger.new($evm, 'my_method_name')
 @logger.log(:info, 'Hello World')
 
+# There are also shortcuts for different log levels.
+@logger.info('Hello info')
+@logger.warn('Uh oh')
+@logger.error('Something went really wrong.')
+
 @logger.dump_root
 
 @logger.dump_attributes($evm.root['vm'], 'root vm')
@@ -74,8 +82,49 @@ automate_helper.get_instance_with_attributes(path)
 # 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')
+vm = automate_helper.resolve_vm
+vm = automate_helper.resolve_vm(lookup_order: [:dialog_id],
+                                dialog_name: 'dialog_vm_id')
+```
+
+Issuing automate requests within Automate.
+
+```ruby
+# Options that are used in the various methods below.
+options = {}
+options[:namespace] = 'MyCustomCode'
+options[:class_name] = 'Methods'
+options[:instance_name] = 'do_something'
+options[:user_id] = $evm.vmdb(:user).find_by_userid('admin').id
+
+ah = MiqDevUtil::Automate.new($evm)
+
+# This uses an existing version of $evm.execute(create_automation_request) if it
+# already exists (MIQ 5.5+), otherwise it backports a version to use.
+
+request = ah.create_automation_request(options)
+# or to specify user and approval
+request = ah.create_automation_request(options, userid = 'admin', auto_approve = true))
+
+#
+# To run the automate request in the same zone as the VM.
+#
+ah.zone_aware_vm_automation_request(vm, options)
+
+# or to specify user and approval
+request = ah.zone_aware_vm_automation(vm, options, userid = 'admin', auto_approve = true))
+
+
+#
+# To synchronously wait for an automate request to finish.
+#
+updated_request = ah.wait_for_automation_request(request)
+
+# Optional parameters
+# Wait at most max_wait seconds.
+# Check the status ever poll_interval seconds.
+updated_request = ah.wait_for_automation_request(request, max_wait: 600,
+                                                          poll_interval: 5)
 ```
 
 ### Generic Code ###

data/lib/miq_dev_util/automate.rb

@@ -52,8 +52,67 @@ module MiqDevUtil
       vm
     end
 
+    # A wrapper to handle MIQ 5.4 which does not have this built in and 5.5+
+    # which does.
+    def create_automation_request(options, userid = 'admin', auto_approve = false)
+      unless service_method_defined?(:create_automation_request)
+        backport_create_automation_request
+      end
+
+      @evm.execute('create_automation_request', options, userid, auto_approve)
+    end
+
+    # Wait until the automation request shows as finished.
+    # Wait at most max_wait seconds.
+    # Check the status ever poll_interval seconds.
+    def wait_for_automation_request(request, options = {})
+      max_wait = options['max_wait'] || 600
+      poll_interval = options['poll_interval'] || 15
+
+      start_time = Time.now
+
+      while (Time.now - start_time) < max_wait
+        request = $evm.vmdb(:automation_request).find(request.id)
+        return request if request['request_state'] == 'finished'
+        sleep(poll_interval)
+      end
+
+      raise 'Automation request wait time exceeded.'
+    end
+
+    # Create an automation request that will run in the same zone as the VM's
+    # EMS. Also set some values to make this have similar data to that which
+    # a method responding to a button press would have.
+    def zone_aware_vm_automation_request(vm, options, userid = 'admin',
+                                         auto_approve = false)
+      options[:miq_zone] = vm.ext_management_system.zone_name
+      options[:attrs] = {} if options[:attrs].nil?
+      options[:attrs][:vm] = vm
+      options[:attrs][:vm_id] = vm.id
+
+      create_automation_request(options, userid, auto_approve)
+    end
+
     private
 
+    def service_method_defined?(method)
+      @evm.execute(:instance_eval, "respond_to?(:#{method})")
+    end
+
+    def backport_create_automation_request
+      @evm.execute(:class_eval, create_automation_request_definition)
+    end
+
+    # This is based on the MIQ 5.5 method, but changed regarding the user/userid
+    # since the code in 5.4 uses a different value.
+    def create_automation_request_definition
+      <<-eos
+        def self.create_automation_request(options, userid = "admin", auto_approve = false)
+          MiqAeServiceModelBase.wrap_results(AutomationRequest.create_request(options, userid, auto_approve))
+        end
+      eos
+    end
+
     def vm_lookup_by(lu_method, dialog_name = nil)
       case lu_method
       when :rootvm    then @evm.root['vm']

data/lib/miq_dev_util/ems.rb

@@ -10,7 +10,7 @@ class MiqDevUtil::EMS
   # * :insecure
   def self.get_credentials(ems, insecure=true)
     {
-      host: ems['hostname'],
+      host: ems.hostname,
       user: ems.authentication_userid,
       password: ems.authentication_password,
       insecure: insecure

data/lib/miq_dev_util/logger.rb

@@ -12,6 +12,22 @@ class MiqDevUtil::Logger
     @evm.log(level, "#{@method_name} - #{message}")
   end
 
+  def debug(message)
+    log(:debug, message)
+  end
+
+  def error(message)
+    log(:error, message)
+  end
+
+  def info(message)
+    log(:info, message)
+  end
+
+  def warn(message)
+    log(:warn, message)
+  end
+
   # Write the attributes of the given object to the log with a prefix of
   # my_object_name to make finding the entries a little easier.
   def dump_attributes(my_object, my_object_name)

data/lib/miq_dev_util/version.rb

@@ -1,3 +1,3 @@
 module MiqDevUtil
-  VERSION = "0.2.0"
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: miq_dev_util
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Eric Wannemacher
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-01 00:00:00.000000000 Z
+date: 2017-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -59,9 +59,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -85,17 +85,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: A set of helper classes to make ManageIQ automate development easier and