foreman_discovery 16.3.1 → 17.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 633d9a0f20147b982f23bbcc7fe02eb210bdbb060ac2f304b098620981502899
-  data.tar.gz: e80520e5eacd123161aa6da427e8185ff0d52dd44d8925319391563ba2634372
+  metadata.gz: c10e2168999d13dfeaaa1f57007249da014b4fab8ec7159e98b87aeb19c77cc9
+  data.tar.gz: 84f8506b80d84fddfbf29e34a97d7cc1a007d2e7596528ed950c7f7963cc64a9
 SHA512:
-  metadata.gz: 36a6ab1d08a10291ba5fa6665649fbaa2b23779305b83826b86a62c1644d9f4545e069c1eba6d13cac27789c50faa2093058de9396d60a06d36f212d995f17c4
-  data.tar.gz: 8c2e52c9eee44e6bd3f22098059395e10b4250d193b331b787bb87ffc7f222911510e650645e6d9ff26bd46245680060e7f033fde62bc8bdf0c13d8f39e7aea0
+  metadata.gz: f7a35666497e0c0a3545dcc689c546a0d8ae46f2abf2482a1ddb93658d24574c4f6defc11efb9da83db7fed28dc3317c0317a10286b8e09cbc4aa82526703d29
+  data.tar.gz: 1eea37925391c28bb2ec93d4423f5d1178795fe390c71a6e94df9c481935188bb94059a42f6a60007cc7100b2ecc4581f9f764ddaa2bc6d82bf543523098c175

data/app/controllers/api/v2/discovered_hosts_controller.rb

@@ -122,6 +122,7 @@ module Api
         end
         process_response state
       rescue Exception => e
+        ForemanDiscovery::UINotifications::FailedDiscovery.new(e).deliver!
         Foreman::Logging.exception("Host discovery failed, facts: #{facts}", e)
         render :json => {'message'=>e.to_s}, :status => :unprocessable_entity
       end

data/app/controllers/discovered_hosts_controller.rb

@@ -9,6 +9,7 @@ class DiscoveredHostsController < ::ApplicationController
   before_action :find_by_name_incl_subnet, :only => [:show]
   before_action :find_multiple, :only => [:multiple_destroy, :submit_multiple_destroy, :multiple_reboot, :submit_multiple_reboot, :multiple_auto_provision, :submit_multiple_auto_provision]
   before_action :taxonomy_scope, :only => [:edit]
+  before_action :check_for_subnet, :only => [:reboot, :auto_provision, :submit_multiple_reboot, :submit_multiple_auto_provision]
 
   around_action :skip_bullet, :only => [:edit]
 
@@ -38,14 +39,10 @@ class DiscoveredHostsController < ::ApplicationController
     @range = nil
     # summary report text
     @report_summary = nil
-    init_regex_and_categories
-    @interfaces = []
-    get_interfaces
-    @host.facts_hash.each do |key, value|
-      value = number_to_human_size(value) if /size$/.match(key)
-      assign_fact_to_category(key, value)
-    end
-    add_custom_facts
+    resolver = ForemanDiscovery::FactToCategoryResolver.new(@host)
+    @categories_names = ForemanDiscovery::FactToCategoryResolver::CATEGORIES_NAMES
+    @categories = resolver.categories
+    @interfaces = resolver.interfaces
   end
 
   def destroy
@@ -214,33 +211,6 @@ class DiscoveredHostsController < ::ApplicationController
     end
   end
 
-  def init_regex_and_categories
-    hightlights = Setting[:discovery_facts_highlights].empty? ? /^(productname|memorysize|manufacturer|architecture|macaddress$|processorcount|physicalprocessorcount|discovery_subnet|discovery_boot|ipaddress$)/ : Regexp.new(Setting[:discovery_facts_highlights])
-    storage = Setting[:discovery_facts_storage].empty? ? /^blockdevice/ : Regexp.new(Setting[:discovery_facts_storage])
-    hardware = Setting[:discovery_facts_hardware].empty? ? /^(hardw|manufacturer|memo|process)/ : Regexp.new(Setting[:discovery_facts__hardware])
-    network = Setting[:discovery_facts_network].empty? ? /^(interfaces|dhcp|fqdn|hostname)/ : Regexp.new(Setting[:discovery_facts_network])
-    software = Setting[:discovery_facts_software].empty? ? /^(bios|os|discovery)/ : Regexp.new(Setting[:discovery_facts_software])
-    ipmi = Setting[:discovery_facts_ipmi].empty? ? /^ipmi/ : Regexp.new(Setting[:discovery_facts_ipmi])
-    @regex_array = [hightlights, storage, hardware, network, software, ipmi, false]
-    @categories = Array.new(7) { Hash.new }
-    @categories_names = [N_("Highlights"), N_("Storage"), N_("Hardware"), N_("Network"), N_("Software"), N_("IPMI"), N_("Miscellaneous")]
-  end
-
-  def assign_fact_to_category(key, value)
-    if @interfaces.any? {|interface| key.include? interface[:identifier]}
-      @categories[3][key] = value
-      return
-    end
-    @regex_array.each_with_index do |regex, index|
-      if !regex
-        @categories[index][key] = value
-      elsif regex.match key
-        @categories[index][key] = value
-        break
-      end
-    end
-  end
-
   def resource_base
     @resource_base ||= ::Host::Discovered.authorized(current_permission, ::Host::Discovered)
   end
@@ -292,6 +262,21 @@ class DiscoveredHostsController < ::ApplicationController
     @host
   end
 
+  def check_for_subnet
+    hosts_without_subnet = []
+    case params[:action]
+      when 'reboot', 'auto_provision'
+        if @host.subnet.nil?
+          process_warning :warning_msg => _("Discovered host reported from unknown subnet, communication will not be proxied.")
+        end
+      when 'submit_multiple_reboot', 'submit_multiple_auto_provision'
+        hosts_without_subnet = @hosts.limit(3).select { |host| host.subnet.nil? }.pluck(:name)
+        if hosts_without_subnet.present?
+          process_warning :warning_msg => _("Discovered hosts reported from unknown subnet are %s, communication will not be proxied.") % hosts_without_subnet.join(', ')
+        end
+    end
+  end
+
   def find_by_name_incl_subnet
     find_by_name({:interfaces => :subnet})
   end
@@ -347,4 +332,8 @@ class DiscoveredHostsController < ::ApplicationController
       assign_fact_to_category("discovery_subnet", discovery_subnet)
     end
   end
+
+  def process_warning(hash = {})
+    warning hash[:warning_msg]
+  end
 end

data/app/controllers/discovery_rules_controller.rb

@@ -4,7 +4,11 @@ class DiscoveryRulesController < ApplicationController
 
   include Foreman::Controller::Parameters::DiscoveryRule
 
-  before_action :find_resource, :only => [:edit, :update, :destroy, :enable, :disable, :auto_provision]
+  before_action :find_resource, :only => [:edit, :update, :destroy, :enable, :disable, :auto_provision, :clone]
+
+  def model_of_controller
+    DiscoveryRule
+  end
 
   def index
     base = resource_base.search_for(params[:search], :order => (params[:order]))
@@ -15,6 +19,11 @@ class DiscoveryRulesController < ApplicationController
     @discovery_rule = DiscoveryRule.new(:priority => DiscoveryRule.suggest_priority)
   end
 
+  def clone
+    @discovery_rule = @discovery_rule.deep_clone except: [:name, :priority]
+    @discovery_rule.priority = DiscoveryRule.suggest_priority
+  end
+
   def create
     @discovery_rule = DiscoveryRule.new(discovery_rule_params)
     if @discovery_rule.save
@@ -55,6 +64,8 @@ class DiscoveryRulesController < ApplicationController
 
   def action_permission
     case params[:action]
+    when 'clone'
+      :create
     when 'enable', 'disable'
       :edit
     else

data/app/helpers/discovered_hosts_helper.rb

@@ -7,7 +7,7 @@ module DiscoveredHostsHelper
   end
 
   def disc_report_column(record)
-    record.last_report? ? (_("%s ago") % time_ago_in_words(record.last_report.getlocal)) : ""
+    record.last_report? ? date_time_relative(record.last_report.getlocal) : ""
   end
 
   def discovered_hosts_title_actions(host)
@@ -97,4 +97,9 @@ module DiscoveredHostsHelper
     return super unless controller_name == 'discovered_hosts'
     discovered_host_path(host)
   end
+
+  def discovery_doc_url
+    doc_version = Foreman::Plugin.find(:foreman_discovery).version.scan(/\d+\.\d+/).first
+    "https://theforeman.org/plugins/foreman_discovery/#{doc_version}"
+  end
 end

data/app/helpers/discovery_rules_helper.rb

@@ -30,6 +30,7 @@ module DiscoveryRulesHelper
     else
       actions << display_link_if_authorized(_('Enable'), hash_for_enable_discovery_rule_path(:id => rule).merge(:auth_object => rule, :authorizer => authorizer), :data => { :confirm => _("Enable rule '%s'?") % rule })
     end
+    actions << display_link_if_authorized(_("Clone"), hash_for_clone_discovery_rule_path(id: rule).merge(auth_object: rule, authorizer: authorizer))
     actions << display_delete_if_authorized(hash_for_discovery_rule_path(:id => rule).merge(:auth_object => rule, :authorizer => authorizer), :data => { :confirm => _("Delete rule '%s'?") % rule })
   end
 end

data/app/models/discovery_rule.rb

@@ -17,7 +17,6 @@ class DiscoveryRule < ApplicationRecord
   validates :max_count, :numericality => { :only_integer => true, :greater_than_or_equal_to => 0, :less_than => 2**31 }
   validates :priority, :presence => true, :numericality => { :only_integer => true, :greater_than_or_equal_to => 0, :less_than => 2**31 }
   validates_lengths_from_database
-  validates_uniqueness_of :priority
   before_validation :default_int_attributes
   before_validation :enforce_taxonomy
 
@@ -41,19 +40,25 @@ class DiscoveryRule < ApplicationRecord
    self.priority  ||= 0
   end
 
-  def self.suggest_priority
-    self.unscoped.maximum(:priority).to_i + STEP
+  def self.suggest_priority(organization = Organization.current)
+    discovery_rules = DiscoveryRule.unscoped
+    return (discovery_rules.maximum(:priority).to_i + STEP) if organization.nil?
+    discovery_rule_ids = TaxableTaxonomy.where(
+      taxable_type: 'DiscoveryRule',
+      taxonomy_id: organization.id).pluck(:taxable_id)
+    discovery_rules = discovery_rules.where(id: discovery_rule_ids)
+    discovery_rules.maximum(:priority).to_i + STEP
   end
 
   def enforce_taxonomy
     return if hostgroup.nil?
     unless (ms = hostgroup.organizations - organizations).empty?
       names = ms.collect(&:name).to_sentence
-      errors.add(:organizations, n_("Host group organization %s must also be associated to the discovery rule", "Host group organizations %s must also be associated to the discovery rule", ms.size) % names)
+      errors.add(:base, n_("Host group organization %s must also be associated to the discovery rule", "Host group organizations %s must also be associated to the discovery rule", ms.size) % names)
     end
     unless (ms = hostgroup.locations - locations).empty?
       names = ms.collect(&:name).to_sentence
-      errors.add(:locations, n_("Host group location %s must also be associated to the discovery rule", "Host group locations %s must also be associated to the discovery rule", ms.size) % names)
+      errors.add(:base, n_("Host group location %s must also be associated to the discovery rule", "Host group locations %s must also be associated to the discovery rule", ms.size) % names)
     end
   end
 end

data/app/services/foreman_discovery/fact_to_category_resolver.rb

@@ -0,0 +1,106 @@
+module ForemanDiscovery
+  class FactToCategoryResolver
+    include ActionView::Helpers::NumberHelper
+
+    attr_reader :categories, :interfaces
+
+    CATEGORIES_NAMES = [N_("Highlights"),
+                        N_("Storage"),
+                        N_("Hardware"),
+                        N_("Network"),
+                        N_("Software"),
+                        N_("IPMI"),
+                        N_("Miscellaneous")].freeze
+
+    def initialize(host)
+      categories = %i[highlights storage hardware network software ipmi]
+
+      @regex_array = categories.map do |category|
+        settings_category = settings_discovery_fact_prefix(category)
+        if settings_category.empty?
+          send(category)
+        else
+          Regexp.new(settings_category)
+        end
+      end
+
+      @regex_array << false
+
+      @categories = []
+
+      @interfaces = host.interfaces.map do |interface|
+        {
+          identifier: interface["identifier"],
+          type: interface["type"],
+          mac: interface["mac"],
+          ip: interface["ip"] || "N/A",
+          primary: interface["primary"],
+          provision: interface["provision"],
+        }
+      end
+
+      assign_facts(host)
+    end
+
+    private
+
+    def assign_facts(host)
+      host.facts_hash.each do |key, value|
+        value = number_to_human_size(value) if /size$/.match(key)
+        assign_fact_to_category(key, value)
+      end
+
+      return if host.primary_interface.subnet.nil?
+
+      discovery_subnet = "#{host.primary_interface.subnet.name} (#{host.primary_interface.subnet.network})"
+      assign_fact_to_category("discovery_subnet", discovery_subnet)
+    end
+
+    def assign_fact_to_category(key, value)
+      if @interfaces.any? { |interface| key.include? interface[:identifier] }
+        @categories[3] = {} if @categories[3].nil?
+        @categories[3][key] = value
+        return
+      end
+
+      @regex_array.each_with_index do |regex, index|
+        @categories[index] = {} if @categories[index].nil?
+        if !regex
+          @categories[index][key] = value
+        elsif regex.match key
+          @categories[index][key] = value
+          break
+        end
+      end
+    end
+
+    def highlights
+      /^(productname|memorysize|manufacturer|architecture|macaddress$|processorcount|physicalprocessorcount|discovery_subnet|discovery_boot|ipaddress$)/
+    end
+
+    def storage
+      /^blockdevice/
+    end
+
+    def hardware
+      /^(hardw|manufacturer|memo|process)/
+    end
+
+    def network
+      /^(interfaces|dhcp|fqdn|hostname)/
+    end
+
+    def software
+      /^(bios|os|discovery)/
+    end
+
+    def ipmi
+      /^ipmi/
+    end
+
+    def settings_discovery_fact_prefix(name)
+      Setting["discovery_facts_#{name}".to_sym]
+    end
+  end
+end
+

data/app/services/foreman_discovery/ui_notifications/failed_discovery.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+module ForemanDiscovery
+  module UINotifications
+    # Adds notification upon failed discovery
+    class FailedDiscovery < ::UINotifications::Base
+      def initialize(message)
+        @message = message
+      end
+
+      private
+
+      def create
+        add_notification if update_notifications.zero?
+      end
+
+      def update_notifications
+        blueprint.mass_update_expiry
+      end
+
+      def add_notification
+        Notification.create!(
+          initiator: initiator,
+          audience: ::Notification::AUDIENCE_ADMIN,
+          message: _("One or more hosts with failed discovery due to error: #{@message}"),
+          notification_blueprint: blueprint,
+        )
+      end
+
+      def blueprint
+        @blueprint ||= NotificationBlueprint.find_by(name: 'failed_discovery')
+      end
+    end
+  end
+end

data/app/services/foreman_discovery/ui_notifications/new_host.rb

@@ -8,7 +8,7 @@ module ForemanDiscovery
       private
 
       def create
-        add_notification if update_notifications.zero?
+        add_notification
       end
 
       def update_notifications
@@ -19,6 +19,7 @@ module ForemanDiscovery
         Notification.create!(
           initiator: initiator,
           audience: ::Notification::AUDIENCE_SUBJECT,
+          message: _("Host %s has been dicovered") % subject.name,
           subject: subject,
           notification_blueprint: blueprint
         )

data/app/views/discovered_hosts/_discovered_hosts_list.html.erb

@@ -1,47 +1,51 @@
 <% title _('Discovered Hosts') %>
 <table class="<%= table_css_classes('table-condensed') %>" >
-  <tr>
-    <th class="ca"><%= check_box_tag "check_all", "", false, { :onclick => "tfm.hosts.table.toggleCheck()", :'check-title' => _("Select all items in this page"), :'uncheck-title'=> _("items selected. Uncheck to Clear") } %></th>
-    <th class=''><%= sort :name, :as => _('Name') %></th>
-    <th class="hidden-tablet hidden-xs"><%= sort :model, :as => _('Model') %></th>
-    <th class="hidden-tablet hidden-xs"><%= sort :ip, :as => _('IP Address') %></th>
-    <th class="hidden-tablet hidden-xs"><%= sort :cpu_count, :as => _('CPUs') %></th>
-    <th class="hidden-tablet hidden-xs"><%= sort :memory, :as => _('Memory') %></th>
-    <th class="hidden-tablet hidden-xs"><%= sort :disk_count, :as => _('Disk Count') %></th>
-    <th class="hidden-tablet hidden-xs"><%= sort :disks_size, :as => _('Disks Size') %></th>
-    <% Setting::Discovered.discovery_fact_column_array.each do |fact_column| %>
-      <th class="hidden-tablet hidden-xs"><%= fact_column.capitalize %></th>
-    <% end %>
-    <th class="hidden-tablet hidden-xs"><%= sort :location, :as => _('Location') %></th>
-    <th class="hidden-tablet hidden-xs"><%= sort :organization, :as => _('Organization') %></th>
-    <th class="hidden-tablet hidden-xs"><%= sort :subnet, :as => _("Subnet") %></th>
-    <th class="hidden-tablet hidden-xs"><%= sort :last_report, :as => _("Last Facts Upload") %></th>
-    <th class="hidden-tablet hidden-xs"><%= _("Actions") %></th>
-  </tr>
-  <% @hosts.each do |host| -%>
+  <thead>
     <tr>
-      <td class="ca">
-        <%= check_box_tag "host_ids[]", nil, false, :id => "host_ids_#{host.id}", :disabled => !authorized_for_edit_destroy?, :class => 'host_select_boxes', :onclick => 'tfm.hosts.table.hostChecked(this)' -%>
-      </td>
-      <%= render :partial => "discovered_host", :locals => {:host => host} %>
-      <td class="hidden-tablet hidden-xs"><%= host.location.try(:title) %></td>
-      <td class="hidden-tablet hidden-xs"><%= host.organization.try(:title) %></td>
-      <td class="hidden-tablet hidden-xs"><%= host.primary_interface.try(:subnet).try(:to_label) %></td>
-      <td class="hidden-tablet hidden-xs"><%= disc_report_column(host) %></td>
-      <td>
-        <!-- Modal -->
-        <%= render :partial => "discovered_host_modal", :locals => {:host => host} %>
-        </div>
-        <%= action_buttons(
-          provision_button(host, hash_for_edit_discovered_host_path(:id => host)),
-          display_link_if_authorized(_("Auto Provision"), hash_for_auto_provision_discovered_host_path(:id => host), :method => :post),
-          display_link_if_authorized(_("Refresh facts"), hash_for_refresh_facts_discovered_host_path(:id => host)),
-          display_link_if_authorized(_("Reboot"), hash_for_reboot_discovered_host_path(:id => host), :method => :put),
-          display_delete_if_authorized(hash_for_discovered_host_path(:id => host), :data => { :confirm => _("Delete %s?") % host.name }, :action => :destroy)) %>
+      <th class="ca"><%= check_box_tag "check_all", "", false, { :onclick => "tfm.hosts.table.toggleCheck()", :'check-title' => _("Select all items in this page"), :'uncheck-title'=> _("items selected. Uncheck to Clear") } %></th>
+      <th class=''><%= sort :name, :as => _('Name') %></th>
+      <th class="hidden-tablet hidden-xs"><%= sort :model, :as => _('Model') %></th>
+      <th class="hidden-tablet hidden-xs"><%= sort :ip, :as => _('IP Address') %></th>
+      <th class="hidden-tablet hidden-xs"><%= sort :cpu_count, :as => _('CPUs') %></th>
+      <th class="hidden-tablet hidden-xs"><%= sort :memory, :as => _('Memory') %></th>
+      <th class="hidden-tablet hidden-xs"><%= sort :disk_count, :as => _('Disk Count') %></th>
+      <th class="hidden-tablet hidden-xs"><%= sort :disks_size, :as => _('Disks Size') %></th>
+      <% Setting::Discovered.discovery_fact_column_array.each do |fact_column| %>
+        <th class="hidden-tablet hidden-xs"><%= fact_column.capitalize %></th>
+      <% end %>
+      <th class="hidden-tablet hidden-xs"><%= sort :location, :as => _('Location') %></th>
+      <th class="hidden-tablet hidden-xs"><%= sort :organization, :as => _('Organization') %></th>
+      <th class="hidden-tablet hidden-xs"><%= sort :subnet, :as => _("Subnet") %></th>
+      <th class="hidden-tablet hidden-xs"><%= sort :last_report, :as => _("Last Facts Upload") %></th>
+      <th class="hidden-tablet hidden-xs"><%= _("Actions") %></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @hosts.each do |host| -%>
+      <tr>
+        <td class="ca">
+          <%= check_box_tag "host_ids[]", nil, false, :id => "host_ids_#{host.id}", :disabled => !authorized_for_edit_destroy?, :class => 'host_select_boxes', :onclick => 'tfm.hosts.table.hostChecked(this)' -%>
         </td>
-      </tr>
-    <% end -%>
-  </table>
+        <%= render :partial => "discovered_host", :locals => {:host => host} %>
+        <td class="hidden-tablet hidden-xs"><%= host.location.try(:title) %></td>
+        <td class="hidden-tablet hidden-xs"><%= host.organization.try(:title) %></td>
+        <td class="hidden-tablet hidden-xs"><%= host.primary_interface.try(:subnet).try(:to_label) %></td>
+        <td class="hidden-tablet hidden-xs"><%= disc_report_column(host) %></td>
+        <td>
+          <!-- Modal -->
+          <%= render :partial => "discovered_host_modal", :locals => {:host => host} %>
+          </div>
+          <%= action_buttons(
+            provision_button(host, hash_for_edit_discovered_host_path(:id => host)),
+            display_link_if_authorized(_("Auto Provision"), hash_for_auto_provision_discovered_host_path(:id => host), :method => :post),
+            display_link_if_authorized(_("Refresh facts"), hash_for_refresh_facts_discovered_host_path(:id => host)),
+            display_link_if_authorized(_("Reboot"), hash_for_reboot_discovered_host_path(:id => host), :method => :put),
+            display_delete_if_authorized(hash_for_discovered_host_path(:id => host), :data => { :confirm => _("Delete %s?") % host.name }, :action => :destroy)) %>
+          </td>
+        </tr>
+      <% end -%>
+  </tbody>
+</table>
 
 <div id="confirmation-modal" class="modal fade">
   <div class="modal-dialog">