miq_utilities 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2b19bb0fcf6f8850ddd88cb84f111b7f638b2b2caa8947d2dbd8ca0d0ea4384
-  data.tar.gz: 0ca998eb10a330141f7b21d50d9310276c7b002d6fc2f5fe9961577406620502
+  metadata.gz: 85f2ae04d311c596c5309f1f79bf31a8b407b02e754dc756dabb016c557b4572
+  data.tar.gz: 498e1d8d0c3ad8dfa112791d937d99aad1a259e2ce411ba15b00e5823522553c
 SHA512:
-  metadata.gz: a1a4dafef4451c2224f9645abfb58064cf6a825449ef45f218c0806de8707bc3e41f7d4f29646b70f6324db73f05be12f22d0d78f7745217fc191ec6b7bb1eea
-  data.tar.gz: e5a4b01286f9d45a6e6b8bba0c26ea9d4abe1984a98170d247a39146678135cb8202b9e97f0907afbc7710649b2b1f2ba07ba5d22775211f8a63445bd4bdfd09
+  metadata.gz: 1a239b30ffc757799835233191fd57c9533838a9a637c0a0a8d9f6d0f2ca804e55132b53ce6496efecb250ec60d52cfaa1b9d5250a3dae8da52b88085dc03594
+  data.tar.gz: d95c06245eddba23773ac1164e701c0b5efd3a1975113a973a657ae71f1b222cf43bfc7440b37cfdc138c394186575a68bc2402dd2c64b153c48862780acd3fd

data/.gitignore

@@ -1,10 +1,21 @@
 /.bundle/
+.bundle
 /.yardoc
 /_yardoc/
+.yardoc
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
 /tmp/
+.config
 *.iml
 .idea
+.idea
+.idea/*
+*/.idea
+*/.idea/*
+**/.idea
+**/.idea/*
+$evm
+

data/.rubocop.yml

@@ -0,0 +1,29 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  Exclude:
+    - vendor/**/*
+    - Guardfile
+
+ClassLength:
+  Enabled: false
+CyclomaticComplexity:
+  Enabled: false
+GlobalVars:
+  AllowedVariables:
+    - $evm
+LineLength:
+  Enabled: false
+MethodLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Style/RescueStandardError:
+  Enabled: false

data/Gemfile

@@ -4,11 +4,11 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in miq_utilities.gemspec
 gemspec
-gem 'slack-ruby-client'
+gem 'slack-notifier'
 gem 'eventmachine'
 gem 'faye-websocket'
 gem 'rbvmomi'
 gem 'tiny_tds'
 gem 'winrm'
 gem 'rest-client'
-gem 'json'
+gem 'json'

data/Gemfile.lock

@@ -1,41 +1,27 @@
 PATH
   remote: .
   specs:
-    miq_utilities (0.2.1)
+    miq_utilities (0.2.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.0)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
     builder (3.2.3)
-    concurrent-ruby (1.0.5)
     domain_name (0.5.20180417)
       unf (>= 0.0.5, < 1.0.0)
     erubis (2.7.0)
     eventmachine (1.2.6-x64-mingw32)
-    faraday (0.15.0)
-      multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.12.2)
-      faraday (>= 0.7.4, < 1.0)
     faye-websocket (0.10.7)
       eventmachine (>= 0.12.0)
       websocket-driver (>= 0.5.1)
     ffi (1.9.23-x64-mingw32)
-    gli (2.17.1)
     gssapi (1.2.0)
       ffi (>= 1.0.1)
     gyoku (1.3.1)
       builder (>= 2.1.2)
-    hashie (3.5.7)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
     httpclient (2.8.3)
-    i18n (1.0.1)
-      concurrent-ruby (~> 1.0)
     json (2.1.0)
     little-plugger (1.1.4)
     logging (2.2.2)
@@ -45,9 +31,7 @@ GEM
       mime-types-data (~> 3.2015)
     mime-types-data (3.2016.0521)
     mini_portile2 (2.3.0)
-    minitest (5.11.3)
     multi_json (1.13.1)
-    multipart-post (2.0.0)
     netrc (0.11.0)
     nokogiri (1.8.2-x64-mingw32)
       mini_portile2 (~> 2.3.0)
@@ -64,18 +48,9 @@ GEM
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
     rubyntlm (0.6.2)
-    slack-ruby-client (0.11.1)
-      activesupport
-      faraday (>= 0.9)
-      faraday_middleware
-      gli
-      hashie
-      websocket-driver
-    thread_safe (0.3.6)
+    slack-notifier (2.3.2)
     tiny_tds (2.1.1-x64-mingw32)
     trollop (2.1.2)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.5-x64-mingw32)
@@ -104,7 +79,7 @@ DEPENDENCIES
   rake (~> 10.0)
   rbvmomi
   rest-client
-  slack-ruby-client
+  slack-notifier
   tiny_tds
   winrm
 

data/README.md

@@ -2,7 +2,7 @@
 
 ## Installation
 
-     $ gem install miq_utilities
+     $ bundle install 
      
 ## Usage
 
@@ -15,7 +15,7 @@
 3. rbvmomi ~> 1.11.3
 4. tiny_tds ~> 2.1.0
 5. winrm ~> 2.2.3
-6. slack-ruby-client ~> 0.11.1
+6. slack-notifier ~> 2.3.2
 7. rest-client ~> 1.8.0 x64-mingw32
 8. json ~> 2.0.4
 
@@ -214,7 +214,7 @@ password  ¦ String  ¦ The users password
 
 ## Notification (NotificationClass)
 
-This Class is used to notify users and log messages accordingly. This Class utilises the `slack-ruby-client` Ruby Gem (version => 0.11.1). 
+This Class is used to notify users and log messages accordingly. This Class utilises the slack-notifier Ruby Gem (version => 2.3.2). 
 
 ### Class Method Summary
 
@@ -229,8 +229,8 @@ event_level   ¦ String  ¦ info, warn, error
 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
-from          ¦ String  ¦ From who
-slack_channel ¦ Boolean ¦ The slcak channel to send the message to
+signature     ¦ String  ¦ Who the emails from
+webhookURL    ¦ String  ¦ The webhook to be used
 ```
 
 ##### Method usage
@@ -240,7 +240,7 @@ slack_channel ¦ Boolean ¦ The slcak channel to send the message to
   logger.log('error', 'An error occured!', false, true)
 ```
 
-#### Levels
+#### Levels (event_level)
 ```
 Level | Action
 ----------------------------------------------------------------------------------------------
@@ -260,7 +260,7 @@ message    ¦ String ¦ The message to be used
 subject    ¦ String ¦ The Subject to be used
 to_email   ¦ String ¦ Recipient email
 from_email ¦ String ¦ Sender email
-from       ¦ String ¦ Sent from
+signature  ¦ String ¦ Who the emails from
 ```
 ##### Method usage
 
@@ -275,11 +275,10 @@ from       ¦ String ¦ Sent from
 _Sends a Slcak message_
 ##### Parameters
 ```
-Name    | Type    | Description
+Name       | Type    | Description
 --------------------------------------------------------------
-message ¦ String  ¦ The message to be used
-channel ¦ String  ¦ The channel in which to post the message
-token   ¦ String  ¦ The API token used to authenticate
+message    ¦ String  ¦ The message to be used
+webhookURL ¦ String  ¦ The webhook to be used
 ```
 
 ##### Method usage
@@ -287,7 +286,7 @@ token   ¦ String  ¦ The API token used to authenticate
 ```$xslt
   require 'miq_utilities'
   notify = NotificationCLass.new
-  notify.send_slack_message('This a Slack post!', '#MIQ-CHANNEL', 'token-to-use')
+  notify.send_slack_message('This a Slack post!', 'https://hooks.slack.com/services/token')
 ```
 
 #### **on_screen_message**     

data/lib/miq_utilities/chef.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+#
+# This Class is used wrap the chef methods used
+#
+
+require_relative 'logging.rb'
+
+# Wrapper class to interact with chef
+class ChefClass
+  # rubocop:disable Naming/AccessorMethodName
+  def initialize(name)
+    @logger = LoggingClass.new(name)
+  end
+
+  def call_chef(cmd, timeout = 20, pre_cmd = nil)
+    # unset the variables for knife
+    pre_cmd ||= 'unset GEM_HOME GEM_PATH IRBRC MY_RUBY_HOME'
+
+    require 'linux_admin'
+    require 'timeout'
+
+    begin
+      Timeout.timeout(timeout) do
+        @logger.log(level: 'info', message: "Executing [#{cmd}] with timeout of #{timeout} seconds")
+        result = LinuxAdmin::Common.run("#{pre_cmd};#{cmd}")
+        @logger.log(level: 'info', message: "success?: #{result.success?}")
+        @logger.log(level: 'info', message: "exit_status: #{result.exit_status}") unless result.exit_status.blank?
+        @logger.log(level: 'info', message: "output: #{result.output}")
+        @logger.log(level: 'info', message: "error: #{result.error}") unless result.error.blank?
+        return result
+      end
+    rescue => timeout
+      @logger.log(level: 'error', message: "Error executing chef: #{timeout.class} #{timeout} #{timeout.backtrace.join("\n")}")
+      return false
+    end
+  end
+
+  def get_chef_environment_name(ws_values = {})
+    chef_environment = $evm.object['chef_environment']
+    chef_environment ||= $evm.root['dialog_chef_environment']
+    if @task
+      env = @task.get_tags[:environment]
+      region = @task.get_option(:cmdb)[:ProvisionCMDBDetails]['CountryCode'].downcase
+      chef_environment = @task.get_tags[:chef_environment] || ws_values[:chef_environment] || @task.get_option(:chef_environment)
+      chef_environment ||= case env
+                           when 'production'
+                             "#{region}_prod"
+                           when 'quality_excellence'
+                             "#{region}_qe"
+                           when 'development'
+                             "#{region}_dev"
+                           else
+                             '_default'
+                           end
+    end
+    chef_environment ||= '_default'
+    @logger.log(level: 'info', message: "chef_environment: #{chef_environment}")
+    chef_environment
+  end
+
+  def get_chef_type
+    chef_type = $evm.object['chef_type']
+    chef_type ||= $evm.root['dialog_chef_type']
+    chef_type ||= 'role'
+    @logger.log(level: 'info', message: "chef_type: #{chef_type}")
+    chef_type
+  end
+
+  def get_chef_node_name
+    chef_node_name = begin
+      @vm.hostnames.first
+    rescue
+      nil
+    end
+    domain_suffix = get_domain_suffix
+    chef_node_name ||= @task.get_option(:vm_target_hostname) if @task
+    chef_node_name ||= @vm.name.to_s
+    chef_node_name = "#{chef_node_name}.#{domain_suffix}" unless domain_suffix.nil? || chef_node_name.include?(domain_suffix)
+
+    @logger.log(level: 'info', message: "chef_node_name: #{chef_node_name}")
+    chef_node_name.downcase
+  end
+
+  def get_chef_role(ws_values = {})
+    chef_role = $evm.object['chef_role']
+    chef_role ||= $evm.root['dialog_chef_role']
+    if @task
+      chef_role = @task.get_tags[:chef_role] || ws_values[:chef_role] || @task.get_option(:chef_role)
+    end
+
+    chef_role ||= ''
+    @logger.log(level: 'info', message: "chef_role: #{chef_role}")
+    chef_role
+  end
+
+  def get_domain_suffix
+    domain_suffix   = nil
+    domain_suffix ||= $evm.object['domain_suffix']
+    domain_suffix ||= $evm.root['dialog_domain_suffix']
+    domain_suffix ||= @task.get_tags[:domain_suffix] if @task
+    @logger.log(level: 'info', message: "domain_suffix: #{domain_suffix}")
+    domain_suffix
+  end
+
+  def get_chef_version(chef_version = nil)
+    chef_version ||= $evm.object['chef_version']
+    @logger.log(level: 'info', message: "chef_version: #{chef_version}")
+    chef_version
+  end
+  # rubocop:enable Naming/AccessorMethodName
+end

data/lib/miq_utilities/general.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+#
+# This Class is used to hold general methods used within this GEM
+#
+# Methods Summary:
+#  > Name         > Description/Params
+#
+
+require_relative 'logging.rb'
+
+# Wrapper class to interact with linux machines via ssh
+class GeneralClass
+  def initialize(name)
+    @logger = LoggingClass.new(name)
+  end
+
+  # basic retry logic
+  def retry_method(retry_time = 1.minute)
+    @logger.log(level: 'info', message: "Sleeping for #{retry_time} seconds")
+    $evm.root['ae_result'] = 'retry'
+    $evm.root['ae_retry_interval'] = retry_time
+    exit(MIQ_OK)
+  end
+
+  # process tags
+  def process_tags(category, category_description, single_value, tag, tag_description)
+    # Convert to lower case and replace all non-word characters with underscores
+    category_name = category.to_s.downcase.gsub(/\W/, '_')
+    tag_name = tag.to_s.downcase.gsub(/\W|:/, '_')
+    @logger.log(level: 'info', message: "Converted category name:<#{category_name}> Converted tag name: <#{tag_name}>")
+    # if the category exists else create it
+    unless $evm.execute('category_exists?', category_name)
+      @logger.log(level: 'info', message: "Category <#{category_name}> doesn't exist, creating category")
+      $evm.execute('category_create', name: category_name, single_value: single_value, description: category_description.to_s)
+    end
+    # if the tag exists else create it
+    @logger.log(level: 'info', message: "Adding new tag <#{tag_name}> description <#{tag_description}> in Category <#{category_name}>") unless $evm.execute('tag_exists?', category_name, tag_name)
+    $evm.execute('tag_create', category_name, name: tag_name, description: tag_description.to_s) unless $evm.execute('tag_exists?', category_name, tag_name)
+  end
+
+  def update_vm_custom_attributes(key, value)
+    @logger.log(level: 'debug', message: "#{key} #{value}")
+    @vm.custom_set(key, value)
+  end
+end

data/lib/miq_utilities/infoblox.rb

@@ -40,7 +40,7 @@ require 'rest-client'
 require 'json'
 require_relative 'logging.rb'
 
-# Class to interact with Infoblox
+# Wrapper class to interact with Infoblox
 class InfobloxClass
   private def process_args(inargs, inurl)
     loops = 1
@@ -106,7 +106,7 @@ class InfobloxClass
             url
           end
 
-    @logger.log('info', "URL: \"#{url}\"")
+    @logger.log(level: 'info', message: "URL: \"#{url}\"")
 
     params = {
       method: action,
@@ -119,18 +119,18 @@ class InfobloxClass
 
     if body_type == :json
       params[:payload] = JSON.generate(body) if body
-      @logger.log('info', "Calling -> Infoblox:<#{url}> action:<#{action}> payload:<#{params[:payload]}>") if body
+      @logger.log(level: 'info', message: "Calling -> Infoblox:<#{url}> action:<#{action}> payload:<#{params[:payload]}>") if body
     elsif body
       params[:payload] = body
     end
 
     response = RestClient::Request.new(params).execute
     if response.code == 200 || response.code == 201
-      @logger.log('info', "Success <- Infoblox Response:<#{response.code}>")
+      @logger.log(level: 'info', message: "Success <- Infoblox Response:<#{response.code}>")
     else
       err_msg = "Error calling infoblox. <#{response.inspect}>"
-      @logger.log('error', err_msg, false, true)
+      @logger.log(level: 'error', message: err_msg, notify: true)
     end
     response
   end
-end
+end

data/lib/miq_utilities/logging.rb

@@ -16,7 +16,7 @@
 #
 require_relative 'notification.rb'
 
-# logging class
+# Wrapper class for logging
 class LoggingClass
   # initialize class
   def initialize(name)
@@ -24,18 +24,21 @@ class LoggingClass
     @notification = NotificationClass.new
   end
 
-  def log(level, message, logtoscreenonly = false, notify = false)
-    levelvalid = %w[info warn error].any? { |msglevel| level.upcase.include? msglevel.to_s.upcase }
+  def log(level:, message:, logtoscreenonly: false, notify: false, email_to: nil, email_from: nil, signature: nil, webhookurl: nil, subjecttype: nil, update_message: false)
+    levelvalid = %w[info warn error debug].any? { |msglevel| level.upcase.include? msglevel.to_s.upcase }
 
     if $evm.nil? || logtoscreenonly
       puts "#{level}: #{@initializer} - #{message}"
     elsif levelvalid
       $evm.log(level, "#{@initializer} - #{message}")
+      @task.message = message if @task && (level.casecmp('ERROR').zero? || update_message)
     else
       $evm.log('info', "#{@initializer} - #{message}")
     end
 
     # Notify - Only if flag (notify) is set to TRUE
-    @notification.notify(level, message) if notify
+    @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}>")
   end
 end

data/lib/miq_utilities/notification.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # .SYNOPSIS
-# This Class utilises the slack-ruby-client Ruby Gem (version => 0.11.1).
+# This Class utilises the slack-notifier Ruby Gem (version => 2.3.2).
 #
 # Methods Summary:
 #  > Name                   > Description/Params
@@ -10,48 +10,49 @@
 #                     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
-#                     from           - String  : From who
-#                     slack_channel  - Boolean : The slcak channel to send the message to
+#                     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
-#                     to_email   - String : Recipient email
 #                     from_email - String : Sender email
-#                     from       - String : Sent from
+#                     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
-#                     channel - String : The channel in which to post the message
-#                     token   - String : The API token used to authenticate
+#                     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-ruby-client'
+require 'slack-notifier'
 
-# notification class
+# Wrapper class to notify stakeholders
 class NotificationClass
-
-  def notify(event_level, event_message, email_to = nil, email_from = nil, from = nil, slack_channel = nil)
+  def notify(event_level:, event_message:, email_to: nil, email_from: nil, signature: nil, webhookurl: nil, subjecttype: nil)
+    signature ||= 'ManageIQ'
     case event_level.upcase
     when %w[WARN WARNING]
-      send_email(event_message, 'Warning Identified', email_to, email_from, from)
-      send_slack_message(event_message, slack_channel)
+      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)
     when %w[ERR ERROR]
-      send_email(event_message, 'Error Identified', email_to, email_from, from)
-      send_slack_message(event_message, slack_channel)
-      on_screen_message(event_level, event_message)
+      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)
     when 'NOTE'
-      on_screen_message(event_level, event_message)
+      on_screen_message(level: event_level, message: event_message, type: subjecttype)
     end
   rescue => err
     raise("Oopps! Something went wrong trying to notify. Error:<#{err}>")
   end
 
-  def send_email(message, subject, to_email = nil, from_email, from)
+  def send_email(message:, subject:, from_email:, signature:, to_email: nil)
     # Look in the current object for a VM
     vm = $evm.object['vm']
     if vm.nil?
@@ -95,47 +96,38 @@ class NotificationClass
     body = 'Hello, '
     body += message
     body += 'Thank you,'
-    body += from
+    body += signature
 
     $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}>")
   end
 
-  # TBD - awaiting webhook setup
-  def send_slack_message(message, channel, token = nil)
-    # https://github.com/slack-ruby/slack-ruby-client - install required
-    if token.nil?
-      Slack.configure do |config|
-        config.token = ENV['SLACK_API_TOKEN']
-        raise 'Missing ENV[SLACK_API_TOKEN]!' unless config.token
-      end
-    else
-      config.token = token
-    end
-
-    begin
-      client = Slack::Web::Client.new
-      client.auth_test
-      client.chat_postMessage(channel: channel, text: message, as_user: true)
-    rescue => err
-      raise("Oopps! Something went wrong trying to send a Slack notification. Error:<#{err}>")
-    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}>")
   end
 
-  def on_screen_message(level, message, subject = nil)
+  def on_screen_message(level:, message:, subject: nil, type: nil)
     if subject.nil?
       vm = $evm.root['vm']
       prov = $evm.root['miq_provision']
       subject ||= vm unless vm.nil?
       subject ||= prov.miq_request unless prov.miq_request.nil?
+      prov.message = message unless prov.nil?
     end
 
     levelvalid = %w[info warn error].any? { |msglevel| level.upcase.include? msglevel.to_s.upcase }
     level = 'info' unless levelvalid
 
     begin
-      $evm.create_notification(level: level, subject: subject, message: message)
+      if type.nil?
+        $evm.create_notification(level: level, subject: subject, message: message)
+      else
+        $evm.create_notification(type: type, subject: subject)
+      end
     rescue => err
       raise("Oopps! Something went wrong trying to display on-screen notification. Error:<#{err}>")
     end

data/lib/miq_utilities/sql.rb

@@ -9,9 +9,9 @@
 #                     user      - String  : Username
 #                     password  - String  : Password
 #                     host      - String  : The host name to connect to
-#                     port      - String  : The port to use, default (nil) 1433
 #                     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
 #
@@ -21,17 +21,18 @@
 # close_connection - closes the connection to the client
 #
 require 'tiny_tds'
+require_relative 'logging.rb'
 
-# Sql class
+# Wrapper class to interact with sql server
 class SqlClass
   # Initialize Class
-  def initialize(user, password, host, port = nil, database, azure)
+  def initialize(user, password, host, database, azure, port = nil)
     # Logging
     @logger = LoggingClass.new('SQL')
 
     # Default port
-    unless port.nil? || port.empty?
-      @logger.log('info', 'Using default port 1433')
+    unless port.nil?
+      @logger.log(level: 'info', message: 'Using default port 1433')
       port = '1433'
     end
 
@@ -53,7 +54,7 @@ class SqlClass
   # Run Sql query
   def run_sql_query(sql)
     if @client.nil?
-      @logger.log('warn', 'SQL Server Connection Not Established! Query hasn\'t been run!')
+      @logger.log(level: 'warn', message: 'SQL Server Connection Not Established! Query hasn\'t been run!')
     else
       @client.execute(sql)
     end
@@ -62,6 +63,6 @@ class SqlClass
   # Close the connection to the sql client
   def close_connection
     @client.close unless @client.closed?
-    @logger.log('info', 'Connection to SQL Client Closed Successfully.') if @client.closed?
+    @logger.log(level: 'info', message: 'Connection to SQL Client Closed Successfully.') if @client.closed?
   end
 end

data/lib/miq_utilities/ssh.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+#
+# This Class is used to handle the logging for ManageIQ and an IDE
+#
+# 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'
+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')
+    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}")
+    end
+  end
+end

data/lib/miq_utilities/version.rb

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

data/lib/miq_utilities/vmware.rb

@@ -12,13 +12,18 @@
 #                 user       - String  : The user to connect with
 #                 password   - String  : The users password
 #
-# get_data_center   - returns the datacenter based on the connection and datacenter
-#                 vsphereconn  - connection  : The return of "get_vsphere_connection"
-#                 dcname       - String      : The name of the datacenter
+# 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'
 
-# vmware wrapper class
+# Wrapper class to interact with vmware
 class VmwareClass
   def initialize(host_name)
     @host_name = host_name
@@ -34,10 +39,10 @@ class VmwareClass
     raise("No connection established!\nUse the \"get_vsphere_connection\" method to connect.") if @connection.nil?
   end
 
-  def find_vm(dc, name)
+  def find_vm(datacenter, vmname)
     vm = {}
-    dc.datastoreFolder.childEntity.collect do |datastore|
-      vm[:instance] = datastore.vm.find { |x| x.name == name }
+    datacenter.datastoreFolder.childEntity.collect do |datastore|
+      vm[:instance] = datastore.vm.find { |x| x.name == vmname }
       if vm[:instance]
         vm[:datastore] = datastore.name
         break
@@ -46,10 +51,10 @@ class VmwareClass
     vm
   end
 
-  def upg_tools(vm)
-    instopts = if vm[:instance][:guest][:guestFamily] == 'windowsGuest'
+  def upg_tools(vmobj)
+    instopts = if vmobj[:instance][:guest][:guestFamily] == 'windowsGuest'
                  '/s /v "/qn REBOOT=ReallySuppress"'
                end
-    vm[:instance].UpgradeTools_Task(installerOptions: instopts).wait_for_completion
+    vmobj[:instance].UpgradeTools_Task(installerOptions: instopts).wait_for_completion
   end
 end

data/lib/miq_utilities/winrm.rb

@@ -14,7 +14,7 @@
 require 'winrm'
 require 'logging.rb'
 
-# WinRM class
+# Wrapper class to interact with winrm
 class WinrmClass
   def winrm_run(ps_script, host, user, password)
     @logger = LoggingClass.new('WinRM')
@@ -31,9 +31,9 @@ class WinrmClass
 
     conn = WinRM::Connection.new(opts)
 
-    @logger.log('info', "WinRM is connecting to #{opts[:endpoint]}")
+    @logger.log(level: 'info', message: "WinRM is connecting to #{opts[:endpoint]}")
     msg = ps1.to_s.gsub(password.to_s, '****')
-    @logger.log('info', "Running PowerShell script: #{msg}")
+    @logger.log(level: 'info', message: "Running PowerShell script: #{msg}")
 
     conn.shell(:powershell) do |shell|
       err = ''
@@ -42,9 +42,9 @@ class WinrmClass
         err = stderr
       end
       if output.exitcode.zero?
-        @logger.log('info', "PS script finished with exit code #{output.exitcode} - Output: <#{value.to_s.strip}>")
+        @logger.log(level: 'info', message: "PS script finished with exit code #{output.exitcode} - Output: <#{value.to_s.strip}>")
       else
-        @logger.log('error', "PS script failed with exit code #{output.exitcode} and error message #{err}. STDOUT: #{value.to_s.strip}")
+        @logger.log(level: 'error', message: "PS script failed with exit code #{output.exitcode} and error message #{err}. STDOUT: #{value.to_s.strip}")
       end
     end
     value.to_s.strip

data/lib/miq_utilities.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 
+# Module to include resources
 module MiqUtilities
   require_relative 'miq_utilities/version'
   require_relative 'miq_utilities/infoblox.rb'
@@ -7,4 +9,6 @@ module MiqUtilities
   require_relative 'miq_utilities/sql.rb'
   require_relative 'miq_utilities/winrm.rb'
   require_relative 'miq_utilities/vmware.rb'
+  require_relative 'miq_utilities/ssh.rb'
+  require_relative 'miq_utilities/chef.rb'
 end

data/miq_utilities.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "winrm", "~> 2.2"
   spec.add_development_dependency "rest-client", "~>1.8"
   spec.add_development_dependency "json", "~> 2.0"
+  spec.add_development_dependency "slack-notifier", "~> 2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: miq_utilities
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - Aaron McCatty
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-09 00:00:00.000000000 Z
+date: 2018-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 description: " This Gem was written to hold utilities commonly used within ManageIQ/Cloudforms. "
 email:
 - aaronmccatty@hotmail.co.uk
@@ -116,6 +130,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -124,10 +139,13 @@ files:
 - bin/console
 - bin/setup
 - lib/miq_utilities.rb
+- lib/miq_utilities/chef.rb
+- lib/miq_utilities/general.rb
 - lib/miq_utilities/infoblox.rb
 - lib/miq_utilities/logging.rb
 - lib/miq_utilities/notification.rb
 - lib/miq_utilities/sql.rb
+- lib/miq_utilities/ssh.rb
 - lib/miq_utilities/version.rb
 - lib/miq_utilities/vmware.rb
 - lib/miq_utilities/winrm.rb