foreman_wreckingball 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d61b28b92f7f4ed29367841c4bec7b80ea38cc4610daf6e4ec78f1181ac8b5c9
-  data.tar.gz: 89f264e68c658e9135a07f761584f23e51b543ba8264bb4a0ead2aef132449b5
+  metadata.gz: 76ab3d42565e2f65a0fd36a5e1f54c610793f02d8a520cde857dbdb19c3db0c3
+  data.tar.gz: 8dacc5958e40ecd78d06e28baeaff904ae5f26965d4eed3d3b56deeb924dbad6
 SHA512:
-  metadata.gz: 0e24c4e6c7ad4cd4eb6bb6f6e66a18712bc090fb41f60d0b639448b9763aad0655aa49a4f80206b036b25fc70d9acae8319a5d027becb8f43d6a26263152232a
-  data.tar.gz: 76271354a6bd79fd6263bca07ffdc8cba779b1be3ad9744f0675bc5b80c4498c214c473d2b7825af3af5f73d0f20def793bceeffcecfd784f8e0d78f2e6c8a20
+  metadata.gz: 8eca4ac7802cfdd392505b99e2233f288210246da2b7936a167aa809e26e8696b44a27b6da983fda2548389c88a3dc84c4aaee9cd544e859ff43e2aef6aca41d
+  data.tar.gz: a7e4f716a844d628d29abbbd1443c9010b0f543d32fa047d9e4d566fcc6c8c4a29c9988686656dbc10034a5a1e2bd47ffd33131899ece6b2087719309600b1d3

data/app/assets/javascripts/foreman_wreckingball/status_hosts_table.js

@@ -0,0 +1,49 @@
+$(document).ready(() => {
+  $.fn.dataTable.ext.errMode = 'none';
+  $('.status-row.list-group-item').one('click', (a, b, c) => {
+    $(a.currentTarget).find('table.status-hosts').each((_index, element) => {
+      $(element).dataTable({
+        searching: false,
+        ordering: false,
+        bLengthChange: false,
+        lengthMenu: [100],
+        processing: true,
+        serverSide: true,
+        columnDefs: [
+          { className: 'ellipsis', targets: [0, 1, 2, 3] }
+        ],
+        ajax: {
+          url: $(element).data('hosts-url'),
+          type: 'GET',
+          data: (_, oSettings) => {
+            const { _iDisplayStart: start, _iDisplayLength: perPage } = oSettings;
+            const page = (start / perPage) + 1;
+            return {
+              page: page || 1,
+              per_page: perPage
+            };
+          },
+          dataSrc: (json) => {
+            return json.data.map((e) => {
+              let row = [
+                `<a href="${e.path}">${e.name}</a>`,
+                `<span class="${e.status.icon_class}"></span><span class="${e.status.status_class}">${e.status.label}</span>`,
+                (e.owner || {}).name || '',
+                (e.environment || {}).name || ''
+              ];
+              if(e.remediate) {
+                row.push(`<span class="btn btn-sm btn-default"><a data-title="${e.remediate.title}" data-submit-class="btn-danger" onclick="show_modal(this); return false;" data-id="aid_wreckingball_hosts_${e.name}_schedule_remediate" href="${e.remediate.path}">${e.remediate.label}</a></span>`);
+              } else {
+                row.push(null);
+              }
+              return row;
+            });
+          }
+        }
+      });
+      $(element).on('error.dt', (_, settings) => {
+        $(settings.nTable).closest('.status-hosts-container').addClass('ajax-error');
+      });
+    });
+  });
+});

data/app/assets/stylesheets/foreman_wreckingball/status_hosts_table.css.scss

@@ -0,0 +1,13 @@
+div.status-hosts-container div.alert-danger {
+  display: none;
+}
+
+div.status-hosts-container.ajax-error div.alert-danger {
+  margin-top: 25px;
+  display: block;
+}
+
+div.status-hosts-container.ajax-error div.dataTables_wrapper,
+div.status-hosts-container.ajax-error p {
+  display: none;
+}

data/app/controllers/foreman_wreckingball/hosts_controller.rb

@@ -3,6 +3,15 @@
 module ForemanWreckingball
   class HostsController < ::HostsController
     include ::ForemanTasks::Concerns::Parameters::Triggering
+    include ::HostsHelper
+    if Gem::Version.new(SETTINGS[:version].short) < Gem::Version.new('1.20')
+      include ::ApplicationHelper
+    else
+      include ::AuthorizeHelper
+    end
+
+    AJAX_REQUESTS = [:status_hosts].freeze
+    before_action :ajax_request, :only => AJAX_REQUESTS
     before_action :find_resource, :only => [:submit_remediate, :schedule_remediate]
     before_action :find_status, :only => [:submit_remediate, :schedule_remediate]
 
@@ -11,31 +20,62 @@ module ForemanWreckingball
         ToolsStatus,
         OperatingsystemStatus,
         CpuHotAddStatus,
-        SpectreV2Status
+        SpectreV2Status,
+        HardwareVersionStatus
       ]
 
       @newest_data = Host.authorized(:view_hosts, Host).joins(:vmware_facet).maximum('vmware_facets.updated_at')
-
       @data = statuses.map do |status|
         host_association = status.host_association
-        hosts = Host.authorized(:view_hosts, Host)
-                    .joins(host_association)
-                    .includes(host_association)
-                    .joins(:vmware_facet)
-                    .includes(host_association => :host)
-                    .includes(:environment)
-                    .preload(:owner)
-                    .order(:name)
+        counter = Host.authorized(:view_hosts, Host)
+                      .joins(host_association)
+                      .includes(host_association)
+                      .map { |host| host.public_send(host_association).to_global }
+                      .group_by { |global_status| global_status }
+                      .each_with_object({}) { |(global_status, items), hash| hash[global_status] = items.size }
         {
           name: status.status_name,
-          hosts: hosts,
           description: status.description,
-          host_association: host_association,
-          supports_remediate: status.supports_remediate?
+          host_association: status.host_association,
+          supports_remediate: status.supports_remediate?,
+          counter: {
+            ok: counter[HostStatus::Global::OK] || 0,
+            warning: counter[HostStatus::Global::WARN] || 0,
+            critical: counter[HostStatus::Global::ERROR] || 0
+          }
         }
       end
     end
 
+    # ajax method
+    def status_hosts
+      statuses_map = {
+        vmware_tools_status_object: ForemanWreckingball::ToolsStatus,
+        vmware_operatingsystem_status_object: ForemanWreckingball::OperatingsystemStatus,
+        vmware_cpu_hot_add_status_object: ForemanWreckingball::CpuHotAddStatus,
+        vmware_spectre_v2_status_object: ForemanWreckingball::SpectreV2Status,
+        vmware_hardware_version_status_object: ForemanWreckingball::HardwareVersionStatus
+      }
+
+      @status = statuses_map[params[:status].to_sym]
+      all_hosts = Host.authorized(:view_hosts, Host)
+                      .joins(@status.host_association)
+                      .includes(@status.host_association, :vmware_facet, :environment)
+                      .preload(:owner)
+                      .order(:name)
+      @count = all_hosts.count
+      @hosts = all_hosts.reject { |h| h.send(@status.host_association).to_global == HostStatus::Global::OK }
+                        .paginate(page: params.fetch(:page, 1), per_page: params.fetch(:per_page, 100))
+
+      respond_to do |format|
+        format.json do
+          Rabl::Renderer.json(@hosts, 'foreman_wreckingball/hosts/status_hosts',
+                              view_path: "#{ForemanWreckingball::Engine.root}/app/views",
+                              scope: self)
+        end
+      end
+    end
+
     def refresh_status_dashboard
       flash[:success] = _('Refresh Compute Resource data task was successfully scheduled.')
       task = User.as_anonymous_admin do

data/app/helpers/concerns/foreman_wreckingball/hosts_helper_extensions.rb

@@ -9,20 +9,5 @@ module ForemanWreckingball
       return 'pficon-warning-triangle-o list-view-pf-icon-warning' if (counter[:warning] || 0).positive?
       'pficon-ok list-view-pf-icon-success'
     end
-
-    def vmware_status_counter(hosts, status_object)
-      count = hosts.map do |host|
-        host.public_send(status_object).to_global
-      end.group_by do |status|
-        status
-      end.each_with_object({}) do |(status, items), hash|
-        hash[status] = items.size
-      end
-      {
-        :ok => count[HostStatus::Global::OK] || 0,
-        :warning => count[HostStatus::Global::WARN] || 0,
-        :critical => count[HostStatus::Global::ERROR] || 0
-      }
-    end
   end
 end

data/app/lib/actions/foreman_wreckingball/host/remediate_hardware_version.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Actions
+  module ForemanWreckingball
+    module Host
+      class RemediateHardwareVersion < Actions::EntryAction
+        middleware.use Actions::Middleware::KeepCurrentUser
+
+        def delay(delay_options, host)
+          action_subject(host)
+          super(delay_options, host)
+        end
+
+        def plan(host)
+          action_subject(host)
+          plan_self
+        end
+
+        def run
+          host = ::Host.find(input[:host][:id])
+
+          output[:old_hardware_version] = host.vmware_facet.hardware_version
+
+          initially_powered_on = host.power.ready?
+          output[:initially_powered_on] = initially_powered_on
+
+          vm = host.compute_object
+
+          if initially_powered_on
+            vm.stop
+            vm.wait_for { power_state == 'poweredOff' }
+            fail _('Could not shut down VM.') if vm.ready?
+          end
+
+          vm.vm_upgrade_hardware
+
+          state = host.refresh_vmware_facet!
+          output[:state] = state
+          output[:new_hardware_version] = host.vmware_facet.hardware_version
+        ensure
+          vm.start if vm && initially_powered_on
+        end
+
+        def humanized_name
+          _('Upgrade VM Hardware Version')
+        end
+
+        def humanized_input
+          input[:host] && input[:host][:name]
+        end
+
+        def append_error(message)
+          output[:errors] ||= []
+          output[:errors] << message
+        end
+
+        def rescue_strategy
+          Dynflow::Action::Rescue::Skip
+        end
+      end
+    end
+  end
+end

data/app/lib/fog_extensions/foreman_wreckingball/vsphere/mock.rb

@@ -0,0 +1,13 @@
+module FogExtensions
+  module ForemanWreckingball
+    module Vsphere
+      module Mock
+        extend ActiveSupport::Concern
+
+        def vm_upgrade_hardware(version: nil, instance_uuid:)
+          { 'task_state' => 'success' }
+        end
+      end
+    end
+  end
+end

data/app/lib/fog_extensions/foreman_wreckingball/vsphere/real.rb

@@ -19,6 +19,13 @@ module FogExtensions
         included do
           prepend Overrides
         end
+
+        def vm_upgrade_hardware(version: nil, instance_uuid:)
+          vm_mob_ref = get_vm_ref(instance_uuid)
+          task = vm_mob_ref.UpgradeVM_Task(version: version)
+          task.wait_for_completion
+          { 'task_state' => task.info.state }
+        end
       end
     end
   end

data/app/lib/fog_extensions/foreman_wreckingball/vsphere/server.rb

@@ -0,0 +1,14 @@
+module FogExtensions
+  module ForemanWreckingball
+    module Vsphere
+      module Server
+        extend ActiveSupport::Concern
+
+        def vm_upgrade_hardware(version: nil)
+          requires :instance_uuid
+          service.vm_upgrade_hardware(instance_uuid: instance_uuid, version: version)
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/foreman_wreckingball/host_extensions.rb

@@ -26,6 +26,11 @@ module ForemanWreckingball
               :foreign_key => 'host_id',
               :inverse_of => :host,
               :dependent => :destroy
+      has_one :vmware_hardware_version_status_object,
+              :class_name => 'ForemanWreckingball::HardwareVersionStatus',
+              :foreign_key => 'host_id',
+              :inverse_of => :host,
+              :dependent => :destroy
     end
 
     def action_input_key

data/app/models/foreman_wreckingball/hardware_version_status.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module ForemanWreckingball
+  class HardwareVersionStatus < ::HostStatus::Status
+    OK = 0
+    OUTOFDATE = 1
+
+    def self.status_name
+      N_('vSphere Hardware Version')
+    end
+
+    def self.host_association
+      :vmware_hardware_version_status_object
+    end
+
+    def self.description
+      N_('In order to use recent vSphere features, the VM must use a recent virtual hardware version.')
+    end
+
+    def self.supports_remediate?
+      true
+    end
+
+    def self.dangerous_remediate?
+      true
+    end
+
+    def self.remediate_action
+      ::Actions::ForemanWreckingball::Host::RemediateHardwareVersion
+    end
+
+    def to_status(_options = {})
+      recent_hw_version? ? OK : OUTOFDATE
+    end
+
+    def to_global(_options = {})
+      case status
+      when OUTOFDATE
+        HostStatus::Global::WARN
+      else
+        HostStatus::Global::OK
+      end
+    end
+
+    def to_label(_options = {})
+      case status
+      when OUTOFDATE
+        N_('Out of date')
+      else
+        N_('OK')
+      end
+    end
+
+    def relevant?(_options = {})
+      host && host&.vmware_facet && host.vmware_facet.hardware_version.present?
+    end
+
+    def recent_hw_version?
+      host.vmware_facet.hardware_version.to_s.gsub(/^vmx-/, '').to_i >= Setting[:min_vsphere_hardware_version]
+    end
+  end
+end

data/app/models/foreman_wreckingball/spectre_v2_status.rb

@@ -44,7 +44,7 @@ module ForemanWreckingball
     end
 
     def relevant?(_options = {})
-      host && host&.vmware_facet && host.vmware_facet.cpu_features.any?
+      host && host&.vmware_facet && host.vmware_facet.hardware_version.present? && host.vmware_facet.cpu_features.any?
     end
 
     def guest_mitigation_enabled?
@@ -52,7 +52,7 @@ module ForemanWreckingball
     end
 
     def recent_hw_version?
-      host.vmware_facet.hardware_version.gsub(/^vmx-/, '').to_i >= 9
+      host.vmware_facet.hardware_version.to_s.gsub(/^vmx-/, '').to_i >= 9
     end
 
     def required_cpu_features_present?

data/app/models/foreman_wreckingball/tools_status.rb

@@ -21,7 +21,7 @@ module ForemanWreckingball
     end
 
     def to_status(_options = {})
-      return POWERDOWN unless host.supports_power_and_running?
+      return POWERDOWN unless host.supports_power? && host.vmware_facet.vm_ready?
       VmwareFacet.tools_states[host.vmware_facet.tools_state]
     end
 

data/app/models/foreman_wreckingball/vmware_facet.rb

@@ -8,6 +8,9 @@ module ForemanWreckingball
 
     enum :tools_state => VALID_GUEST_STATUSES
 
+    VALID_POWER_STATES = [:poweredOff, :poweredOn, :suspended].freeze
+    enum :power_state => VALID_POWER_STATES
+
     belongs_to :vmware_cluster, :class_name => '::ForemanWreckingball::VmwareCluster',
                                 :inverse_of => :vmware_facets
 
@@ -43,6 +46,7 @@ module ForemanWreckingball
         corespersocket: vm.corespersocket,
         memory_mb: vm.memory_mb,
         tools_state: vm.tools_state,
+        power_state: vm.power_state,
         guest_id: vm.guest_id,
         cpu_hot_add: vm.cpuHotAddEnabled,
         hardware_version: vm.hardware_version,
@@ -57,9 +61,14 @@ module ForemanWreckingball
       host.get_status(::ForemanWreckingball::CpuHotAddStatus).refresh!
       host.get_status(::ForemanWreckingball::OperatingsystemStatus).refresh!
       host.get_status(::ForemanWreckingball::SpectreV2Status).refresh!
+      host.get_status(::ForemanWreckingball::HardwareVersionStatus).refresh!
       host.refresh_global_status!
     end
 
+    def vm_ready?
+      power_state == 'poweredOn'
+    end
+
     private
 
     def raw_vm_object

data/app/models/setting/wreckingball.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class Setting
+  class Wreckingball < ::Setting
+    def self.load_defaults
+      return unless ActiveRecord::Base.connection.table_exists?('settings')
+      return unless super
+
+      Setting.transaction do
+        [
+          set('min_vsphere_hardware_version', N_('Minimum required Hardware version for vSphere VMs'), 13, N_('Hardware version'))
+        ].compact.each { |s| Setting::Wreckingball.create s.update(category: 'Setting::Wreckingball') }
+      end
+
+      true
+    end
+
+    def self.humanized_category
+      N_('Wreckingball')
+    end
+  end
+end