miq_utilities 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38443c65cffa17096f599e60fc8ec410bdbfc2681a441aa2edbcb0fddc8cd4e7
-  data.tar.gz: 87d89ffb19b71ffc72450d30802f95ef73ec01af90b0e9283567acb08766cf77
+  metadata.gz: f69b2aecab6ae7d25b391d9244cd67fd62612b7be714dfe27c2e20358c50f483
+  data.tar.gz: ff8ce2ff4a17f63855f97c6d9571ff0b21bf7f87a298294df866d82237dd2df0
 SHA512:
-  metadata.gz: fa02bb0c15c9669fe33c794eb3d343e91cea6c97ffb64107892b0cb8429892c35f2b2031162a7f681ff70c5abbd374bf908295f2bc47a34d8fb386689d6f2e41
-  data.tar.gz: 98223d6a3dcd8c53a0467bd9a957abd518f78e1f9a898c5055d6b433a688d2a1de5c8e892af976ffec2f2ef90f08fd7696b436e17f19549d34a2d19b4865cd31
+  metadata.gz: 86eeb522972b75989b5a3a3ea5bb17335901aa9ef29c4335e91b96b6645e49fc953aacbdc5604e4dc801cff5fcbf2a2cf7b30f0e18c3a6dbeab1d012fd38828f
+  data.tar.gz: 0cbb9dfacd7b597e3b407aa1f38fcc7de44a05328fb5f0212fa49d7083829c820c42bbb841466da9e9bd3d10245882a9b6b845a2464a37ada428858d76fb78cf

data/lib/miq_utilities/chef.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
+# .SYNOPSIS
+# This Class is used as a wrapper class for the chef interactions
+#
+# Methods Summary:
+#  > Name  > Description/Params
 #
-# This Class is used wrap the chef methods used
 #
 
 require_relative 'logging.rb'
@@ -33,6 +37,8 @@ class ChefClass
     rescue => timeout
       @logger.log(level: 'error', message: "Error executing chef: #{timeout.class} #{timeout} #{timeout.backtrace.join("\n")}")
       return false
+    rescue => err
+      raise("\n    Class:<#{self.class}>\n    Method:<#{__method__}>\n    Error:<#{err} - #{err.backtrace.join("\n")}>")
     end
   end
 

data/lib/miq_utilities/general.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
-#
+# .SYNOPSIS
 # This Class is used to hold general methods used within this GEM
 #
 # Methods Summary:
-#  > Name         > Description/Params
+#  > Name  > Description/Params
 #
-
 require_relative 'logging.rb'
 
 # Wrapper class to interact with linux machines via ssh

data/lib/miq_utilities/infoblox.rb

@@ -4,37 +4,11 @@
 # This Class utilises the rest-client (version => 1.8.0 x64-mingw32) & json (version => 2.0.4) Ruby Gems
 #
 # Methods Summary:
-#  > Name          > Description/Params
-# process_args   - Process Arguments
-#                 inargs - Hash   : Hash Table of key value pairs of arguments to process i.e. { 'name' => some_fdqn }
-#                 inurl  - String : The url to append to
-#
-# process_extattrs  - Process extra attributes
-#                 inargextattrs - Hash    : Hash table of key value pairs of the extra attributes to process i.e. { 'Country' => 'UK' }
-#                 inurl         - String  : The url to append to
-#                 args          - Boolean : Identifies if arguments were processed, if so an ampersand needs to be appended
-#
-# process_returnfields  - Process return fields
-#                 inurl        - String : The url to append to
-#                 returnfields - String : A string listing the return fields, delimited by commas (CSV)
-#                 args         - Boolean (Default:Flase): Identifies if arguments were processed, if so an ampersand needs to be appended
-#
-# call_infoblox  - Process the inputs and make the API call to infoblox
-#                 action     - String : The Action being preformed i.e. GET, DELETE
-#                 resource   - String : The resource being used i.e. record:host
-#                 ibobj      - Object : Custom object created to hold the extra attributes, arguments and return fields.
-#                                       Examples: * vars are suffixed with @ *
-#  infobloxobj = { 'args' => nil, 'returnfields' => nil, 'argextattrs' => { 'Country' => @ib_cmdb_country, '*VLAN Number' => @ib_cmdb_vlan, '*Site' => @ib_site } } or;
-#  infobloxobj = { 'args' => { 'name' => @ib_fdqn }, 'returnfields' => nil, 'argextattrs' => nil } or;
-#  infobloxobj = { 'args' => { 'name' => @ib_fdqn }, 'returnfields' => 'ipv4addrs', 'argextattrs' => nil }......
-#
-#                 body_type  - String (Default json) : The body type
-#                 body       - String : The body to use in the call, if there is one
-#                 servername - String : The server name to connect to
-#                 username   - String : The username to connect with
-#                 password   - String : The password for the user
-#                 baseurl    - String (Default: https://[SERVERNAME]/wapi/v2.3.1/): the base URL to use
-#
+#  > Name              > Description/Params
+# process_args         - Process Arguments
+# process_extattrs     - Process extra attributes
+# process_returnfields - Process return fields
+# call_infoblox        - Process the inputs and make the API call to infoblox
 #
 require 'rest-client'
 require 'json'
@@ -78,7 +52,7 @@ class InfobloxClass
   end
 
   def call_infoblox(action:, resource:, ibobj:, body_type: :json, body: nil, servername: nil, username: nil, password: nil, baseurl: 'https://[SERVERNAME]/wapi/v2.3.1/')
-    @logger = LoggingClass.new('Infoblox')
+    @logger = LoggingClass.new("#{self.class}:(#{__method__})")
 
     servername ||= $evm.object['InfobloxServername']
     username   ||= $evm.object['InfobloxUsername']

data/lib/miq_utilities/logging.rb

@@ -39,6 +39,6 @@ class LoggingClass
     # Notify - Only if flag (notify) is set to TRUE
     @notification.notify(event_level: level, event_message: message, email_to: email_to, email_from: email_from, signature: signature, webhookurl: webhookurl, subjecttype: subjecttype) if notify
   rescue => err
-    raise("Oopps! Something went wrong.\nError:<#{err}>")
+    raise("Oopps! Something went wrong.\nDetails:<#{err}>")
   end
 end

data/lib/miq_utilities/notification.rb

@@ -4,100 +4,72 @@
 # This Class utilises the slack-notifier Ruby Gem (version => 2.3.2).
 #
 # Methods Summary:
-#  > Name                   > Description/Params
+# > Name             > Description/Params
 # notify             - based on the params passed, process through and notify in the appropriate ways
-#                     event_level    - String  : info, warn, error, debug, note
-#                     event_message  - String  : The message to be used
-#                     email_to       - String  : Who to send an email to
-#                     email_from     - String  : Sent from which email address
-#                     signature      - String  : Who the emails from
-#                     webhookurl     - String  : The slcak channel to send the message to
-#
 # send_email         - Sends an email to the specified user
-#                     message    - String : The message to be used
-#                     subject    - String : The Subject to be used
-#                     from_email - String : Sender email
-#                     signature  - String : Who the emails from
-#                     to_email   - String : Recipient email
-#
 # send_slack_message - Sends a Slcak message
-#                     message    - String : The message to be used
-#                     webhookurl - String : The webhook to be used
-#
 # on_screen_message  - Sends an on-screen notification
-#                     level   - String : info, warn, error
-#                     message - String : The message to be used
-#                     subject - String : The Subject to be used
-# WIP
+#
+#
+#
 require 'slack-notifier'
 
 # Wrapper class to notify stakeholders
 class NotificationClass
   def notify(event_level:, event_message:, email_to: nil, email_from: nil, signature: nil, webhookurl: nil, subjecttype: nil)
-    @logger = LoggingClass.new('NotifyCLass')
+    @logger = LoggingClass.new(self.class.to_s)
     signature ||= 'ManageIQ'
-    @logger.log(level: 'info', message: 'Notify Class started.....')
-    @logger.log(level: 'info', message: "case = #{event_level.upcase}")
     case event_level.upcase
     when 'WARN', 'WARNING'
-      @logger.log(level: 'info', message: 'Hit Case WARNING')
       subject = 'ManageIQ Warning'
-      send_email(message: event_message, subject: subject, from_email: email_from, signature: signature, to_email: email_to)
       send_slack_message(message: event_message, webhookurl: webhookurl)
+      if $evm.nil?
+        @logger.log(level: 'warn', message: 'The $evm object is null. Unable to send email notification.')
+      else
+        send_email(message: event_message, subject: subject, from_email: email_from, signature: signature, to_email: email_to)
+      end
     when 'ERR', 'ERROR'
-      @logger.log(level: 'info', message: 'Hit Case ERROR')
       subject = 'ManageIQ Error'
-      send_email(message: event_message, subject: subject, from_email: email_from, signature: signature, to_email: email_to)
       send_slack_message(message: event_message, webhookurl: webhookurl)
-      on_screen_message(level: event_level, message: event_message, type: subjecttype)
+      if $evm.nil?
+        @logger.log(level: 'warn', message: 'The $evm object is null. Unable to send email or on-screen notifications.')
+      else
+        on_screen_message(level: event_level, message: event_message, type: subjecttype)
+        send_email(message: event_message, subject: subject, from_email: email_from, signature: signature, to_email: email_to)
+      end
     when 'NOTE'
-      @logger.log(level: 'info', message: 'Hit Case NOTE')
-      on_screen_message(level: event_level, message: event_message, type: subjecttype)
+      if $evm.nil?
+        @logger.log(level: 'warn', message: 'The $evm object is null. Unable to on-screen notification.')
+      else
+        on_screen_message(level: event_level, message: event_message, type: subjecttype)
+      end
     end
   rescue => err
-    raise("Oopps! Something went wrong trying to notify. Error:<#{err}>")
+    raise("<#{err}>")
   end
 
   def send_email(message:, subject:, from_email:, signature:, to_email: nil)
-    @logger.log(level: 'info', message: 'Sending mail....')
-    # Look in the current object for a VM
-    vm = $evm.object['vm']
-    if vm.nil?
-      vm_id = $evm.object['vm_id'].to_i
-      vm = $evm.vmdb('vm', vm_id) unless vm_id.zero?
-    end
-
-    # Look in the Root Object for a VM
-    if vm.nil?
-      vm = $evm.root['vm']
-      if vm.nil?
-        vm_id = $evm.root['vm_id'].to_i
-        vm = $evm.vmdb('vm', vm_id) unless vm_id.zero?
-      end
+    to = nil
+    if to_email.nil?
+      vm = nil
+      owner = nil
+      # Look in the Root Object for a Provision/Request
+      prov = $evm.root['miq_provision_request'] || $evm.root['miq_provision']
+      vm = prov.vm if prov && vm.nil?
+      # Get VM Owner ID and then Email
+      evm_owner_id = vm.attributes['evm_owner_id']
+      owner = $evm.vmdb('user', evm_owner_id) unless evm_owner_id.nil?
+      # to_email_address from owner.email then from model if nil
+      to = if owner
+             owner.email.to_s.strip
+           else
+             $evm.object['to_email_address'].to_s.strip unless $evm.nil?
+           end
+      # Look at the Event Type in the Current Object or in the Root Object
+      event_type = $evm.object['event'] || $evm.root['event_type']
     end
-
-    # Look in the Root Object for a Provision/Request
-    prov = $evm.root['miq_provision_request'] || $evm.root['miq_provision']
-    vm = prov.vm if prov && vm.nil?
-
-    raise 'VM details not found!' if vm.nil?
-
-    # Look at the Event Type in the Current Object or in the Root Object
-    event_type = $evm.object['event'] || $evm.root['event_type']
-
-    # Get VM Owner Name and Email
-    evm_owner_id = vm.attributes['evm_owner_id']
-    owner = nil
-    owner = $evm.vmdb('user', evm_owner_id) unless evm_owner_id.nil?
-
-    # to_email_address from owner.email then from model if nil
-    to = if owner
-           owner.email.to_s.strip
-         else
-           $evm.object['to_email_address'].to_s.strip
-         end
-
-    to ||= to_email unless to_email.nil?
+    event_type ||= 'MIQ Event'
+    to ||= to_email
 
     subject += " - #{event_type}"
     body = 'Hello, '
@@ -107,14 +79,14 @@ class NotificationClass
 
     $evm.execute(:send_email, to, from_email, subject, body)
   rescue => err
-    raise("Oopps! Something went wrong trying to send an email to:<#{to}>. Error:<#{err}>")
+    raise("\n    Class:<#{self.class}>\n    Method:<#{__method__}>\n    Error:<#{err} - #{err.backtrace.join("\n")}>")
   end
 
   def send_slack_message(message:, webhookurl:)
     notifier = Slack::Notifier.new webhookurl
     notifier.ping message
   rescue => err
-    raise("Oopps! Something went wrong trying to send a Slack notification. Error:<#{err}>")
+    raise("\n    Class:<#{self.class}>\n    Method:<#{__method__}>\n    Error:<#{err} - #{err.backtrace.join("\n")}>")
   end
 
   def on_screen_message(level:, message:, subject: nil, type: nil)
@@ -136,7 +108,7 @@ class NotificationClass
         $evm.create_notification(type: type, subject: subject)
       end
     rescue => err
-      raise("Oopps! Something went wrong trying to display on-screen notification. Error:<#{err}>")
+      raise("\n    Class:<#{self.class}>\n    Method:<#{__method__}>\n    Error:<#{err} - #{err.backtrace.join("\n")}>")
     end
   end
 end

data/lib/miq_utilities/sql.rb

@@ -6,18 +6,8 @@
 # Methods Summary:
 #  > Name                   > Description/Params
 # initialize       - Create the connection to the client
-#                     user      - String  : Username
-#                     password  - String  : Password
-#                     host      - String  : The host name to connect to
-#                     database  - String  : The database name to connect to
-#                     azure     - Boolean : Set to true when connecting to Azure
-#                     port      - String  : The port to use, default (nil) 1433
-#
 # get_client       - returns the client to utilise the tiny_tds functionality
-#
 # run_sql_query    - runs the specified sql query against the client when the class was instantiated
-#                     sql       - String  : Sql query to be run
-#
 # close_connection - closes the connection to the client
 #
 require 'tiny_tds'
@@ -28,7 +18,7 @@ class SqlClass
   # Initialize Class
   def initialize(user:, password:, host:, database:, azure:, port: nil)
     # Logging
-    @logger = LoggingClass.new('SQL')
+    @logger = LoggingClass.new(self.class.to_s)
 
     # Default port
     unless port.nil?

data/lib/miq_utilities/ssh.rb

@@ -1,15 +1,11 @@
 # frozen_string_literal: true
 
 #
-# This Class is used to handle the logging for ManageIQ and an IDE
+# This Class is used to handle the running ssh scripts and utilises the net-ssh Ruby Gem (version => 4.2.0)
 #
 # Methods Summary:
 #  > Name         > Description/Params
 #    ssh_run      - Run script via ssh
-#                script         - String  : The script to run
-#                ipaddress      - String  : The message
-#                linux_user     - String  : User to login as
-#                linux_password - String  : password to use
 #
 
 require 'net/ssh'
@@ -18,16 +14,19 @@ require_relative 'logging.rb'
 # This wrapper class is used to run ssh commands on linux machines
 class SshClass
   def ssh_run(ipaddr, script, linux_user = nil, linux_password = nil)
-    @logger = LoggingClass.new('ssh_run')
+    @logger = LoggingClass.new("#{self.class}:(#{__method__})")
     linux_password ||= $evm.object.decrypt('linux_password').to_s
     linux_user ||= 'root'
-
-    Net::SSH.start(ipaddr, linux_user, password: linux_password, paranoid: Net::SSH::Verifiers::Null.new) do |ssh|
-      command = script
-      output = ssh.exec!(command)
-      @logger.log(level: 'info', message: "ssh command being run on #{ipaddr}")
-      @logger.log(level: 'info', message: "ssh script being run is #{script}")
-      @logger.log(level: 'info', message: "SSH output = #{output}")
+    begin
+      Net::SSH.start(ipaddr, linux_user, password: linux_password, paranoid: Net::SSH::Verifiers::Null.new) do |ssh|
+        command = script
+        output = ssh.exec!(command)
+        @logger.log(level: 'info', message: "ssh command being run on #{ipaddr}")
+        @logger.log(level: 'info', message: "ssh script being run is #{script}")
+        @logger.log(level: 'info', message: "SSH output = #{output}")
+      end
+    rescue
+      raise("\n    Class:<#{self.class}>\n    Method:<#{__method__}>\n    Error:<#{err} - #{err.backtrace.join("\n")}>")
     end
   end
 end

data/lib/miq_utilities/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MiqUtilities
-  VERSION = '0.2.7'
+  VERSION = '0.2.8'
 end

data/lib/miq_utilities/vmware.rb

@@ -4,23 +4,13 @@
 # This Class is used to handle some of the heavily used VMWare utilities
 #
 # Methods Summary:
-#  > Name               > Description/Params
-# initialize   - Assign the host name
-#                 host_name      - String  : The name of the host being utilised
-#
-# get_vsphere_connection  - returns the client connection
-#                 user       - String  : The user to connect with
-#                 password   - String  : The users password
-#
+#  > Name                > Description/Params
+# initialize             - Assign the host name
+# get_vsphere_connection - returns the client connection
 # retrieve_data_center   - returns the datacenter based on the connection and datacenter
-#
-#
 # find_vm                - Get the VM details from vmware
-#                 datacenter  - String  : retrieve_data_center return value
-#                 vmname      - String  : The vmname
-#
 # upg_tools              - Get the VM details from vmware
-#                 vmobj  - Object  : find_vm return value
+#
 require 'rbvmomi'
 
 # Wrapper class to interact with vmware

data/lib/miq_utilities/winrm.rb

@@ -4,12 +4,8 @@
 # This Class utilises the winrm Ruby Gem (version => 2.2.3) and is used to handle the running of powershell scripts using winrm
 #
 # Methods Summary:
-#  > Name          > Description/Params
-# winrm_run      - Run a specified PowerShell script
-#           ps_script    - String  : The name of the script to run (including path to the file)
-#           host         - String  : The name of the host to connect to
-#           user         - String  : The user to connect with
-#           password     - String  : The users password
+#  > Name    > Description/Params
+# winrm_run  - Run a specified PowerShell script
 #
 require 'winrm'
 require 'logging.rb'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: miq_utilities
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Aaron McCatty