foreman_discovery 11.0.0 → 12.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 221ad5eb42c9d10c313e6e827beb5d0156a56275
-  data.tar.gz: 6b6df98bf5b4611aeb3734152b5463c2edef7453
+SHA256:
+  metadata.gz: 057e3a38102117de8da88c00a3cb4f7d7bcf56c73264bec062b6c5b0a26d879b
+  data.tar.gz: 3fa992f91692c8ff8ead22f5fe1dd1f68c53f68ec50d4226cfc7d13ea43e2f00
 SHA512:
-  metadata.gz: 4a67ce08394ba37b05dba6947d2bfc2ccd0de5ab13ded18dc208ce29b7ec069634ba68a42611b17a7987c90f013540d94e136b06a553764192df9b07e29bd237
-  data.tar.gz: 8f57149cce4c007f15858483c9aaf3bb9dac723c2e5a544aef8a94662e1b7f064c777442e9f69596d39152ace62a9a92fd8ca4c097448283bf5f57bbbafbad2c
+  metadata.gz: 2a1b935890e1563516cbb65aaa0f69bc35509a0f379fb0bfe7f9c4e221c26663573c22a6bcab5efdaf3c239f228c846d6465b5d8b5380f5a9f70b69f24c337f2
+  data.tar.gz: 2a0c18633011f2d16f5ac91985e2ed10e3fab325e143cd029258fb710c9cd6db3398a8160105584ff47f5a7f4e6c18f7e79e3756c9de607d112c905ecc72d4ae

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

@@ -109,8 +109,7 @@ module Api
         end
         process_response state
       rescue Exception => e
-        logger.warn "Host discovery failed, facts: #{facts}"
-        logger.debug e.message + "\n" + e.backtrace.join("\n")
+        Foreman::Logging.exception("Host discovery failed, facts: #{facts}", e)
         render :json => {'message'=>e.to_s}, :status => :unprocessable_entity
       end
 

data/app/controllers/concerns/foreman/controller/discovered_extensions.rb

@@ -6,7 +6,7 @@ module Foreman::Controller::DiscoveredExtensions
     raise(::Foreman::Exception.new(N_("Unable to find a discovery rule, no host provided (check permissions)"))) if host.nil?
     Rails.logger.debug "Finding auto discovery rule for host #{host.name} (#{host.id})"
     # rule with *lower* priority wins (older wins for same priority)
-    DiscoveryRule.where(:enabled => true).reorder(:priority, :created_at).each do |rule|
+    DiscoveryRule.where(:enabled => true).reorder(:priority).each do |rule|
       max = rule.max_count
       usage = rule.hosts.size
       Rails.logger.debug "Found rule #{rule.name} (#{rule.id}) [#{usage}/#{max}]"

data/app/controllers/discovered_hosts_controller.rb

@@ -7,7 +7,7 @@ class DiscoveredHostsController < ::ApplicationController
 
   before_action :find_by_name, :only => %w[edit update destroy refresh_facts convert reboot auto_provision]
   before_action :find_by_name_incl_subnet, :only => [:show]
-  before_action :find_multiple, :only => [:multiple_destroy, :submit_multiple_destroy]
+  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]
 
   around_action :skip_bullet, :only => [:edit]
@@ -21,12 +21,12 @@ class DiscoveredHostsController < ::ApplicationController
   end
 
   def index
-    @hosts = resource_base.search_for(params[:search], :order => params[:order]).includes([
+    @hosts = resource_base_search_and_page.includes([
       :location,
       :organization,
       :model,
       :discovery_attribute_set
-    ], {:interfaces => :subnet}).paginate(:page => params[:page])
+    ], {:interfaces => :subnet})
     fact_array = @hosts.collect do |host|
       [host.id, Hash[host.fact_values.joins(:fact_name).where('fact_names.name' => Setting::Discovered.discovery_fact_column_array).pluck(:name, :value)]]
     end
@@ -54,10 +54,12 @@ class DiscoveredHostsController < ::ApplicationController
   end
 
   def edit
+    quick = params.delete(:quick_submit)
     @host = ::ForemanDiscovery::HostConverter.to_managed(@host, true, false, discovered_host_params_host) unless @host.nil?
     setup_host_class_variables
     @override_taxonomy = true
-    if params[:quick_submit]
+    # need to permit this one but don't know how
+    if quick
       perform_update(@host, _('Successfully provisioned %s') % @host.name)
     else
       @host.build = true
@@ -69,6 +71,7 @@ class DiscoveredHostsController < ::ApplicationController
     @host = ::ForemanDiscovery::HostConverter.to_managed(@host, true, true, managed_host_params_host)
     forward_url_options
 
+    @override_taxonomy = true
     perform_update(@host)
   end
 
@@ -116,8 +119,8 @@ class DiscoveredHostsController < ::ApplicationController
     process_error :error_msg => exception.message, :redirect => :back
   end
 
-  def reboot_all
-    error_message = perform_reboot_all
+  def submit_multiple_reboot
+    error_message = perform_reboot_all(@hosts)
 
     if error_message
       process_error :error_msg => error_message, :redirect => :back
@@ -133,11 +136,17 @@ class DiscoveredHostsController < ::ApplicationController
   def multiple_destroy
   end
 
+  def multiple_reboot
+  end
+
+  def multiple_auto_provision
+  end
+
   def submit_multiple_destroy
     # keep all the ones that were not deleted for notification.
     missed_hosts = @hosts.select {|host| !host.destroy }
     if missed_hosts
-      notice _("Destroyed selected hosts")
+      success _("Destroyed selected hosts")
     else
       error _("The following hosts were not deleted: %s") % missed_hosts
     end
@@ -158,7 +167,7 @@ class DiscoveredHostsController < ::ApplicationController
     end
   end
 
-  def auto_provision_all
+  def submit_multiple_auto_provision
     result = true
     error_message = _("Errors during auto provisioning: %s")
 
@@ -168,7 +177,7 @@ class DiscoveredHostsController < ::ApplicationController
     end
 
     overall_errors = ""
-    Host::Discovered.all.each do |discovered_host|
+    @hosts.each do |discovered_host|
       if rule = find_discovery_rule(discovered_host)
         result &= perform_auto_provision(discovered_host, rule)
         unless discovered_host.errors.empty?
@@ -259,11 +268,12 @@ class DiscoveredHostsController < ::ApplicationController
 
   def action_permission
     case params[:action]
-      when 'refresh_facts', 'reboot', 'reboot_all', 'update_multiple_location', 'select_multiple_organization', 'update_multiple_organization', 'select_multiple_location'
+      when 'refresh_facts', 'reboot', 'multiple_reboot', 'update_multiple_location',
+        'select_multiple_organization', 'update_multiple_organization', 'select_multiple_location', 'submit_multiple_reboot'
         :edit
       when 'submit_multiple_destroy', 'multiple_destroy'
         :destroy
-      when 'auto_provision', 'auto_provision_all'
+      when 'auto_provision', 'multiple_auto_provision', 'submit_multiple_auto_provision'
         :auto_provision
       else
         super

data/app/controllers/foreman_discovery/concerns/hosts_controller_extensions.rb

@@ -11,7 +11,7 @@ module ForemanDiscovery
       # etc.. expect a params[:host] to work.
       def set_discovered_params
         return if params[:discovered_host].nil?
-        params[:host] ||= params[:discovered_host]
+        params[:host] ||= params.delete(:discovered_host)
       end
     end
   end

data/app/helpers/discovered_hosts_helper.rb

@@ -19,10 +19,6 @@ module DiscoveredHostsHelper
             link_to(_("Back"), :back, :class => "btn btn-default")
         ),
         select_action_button( _("Select Action"), {}, provision_button(host, hash_for_edit_discovered_host_path(:id => host)), actions.map { |action| display_link_if_authorized(action[0] , action[1], action[2] || {}) }.flatten ),
-      button_group(
-        link_to(_("Expand All"),"#", :id => "expand_all", :class => "btn btn-default"
-        )
-      ),
       button_group(
         display_delete_if_authorized(hash_for_discovered_host_path(:id => host).merge(:auth_object => host, :permission => :destroy_discovered_hosts), :class => "btn btn-default", :data => { :confirm => _('Delete %s?') % host.name })
       )
@@ -30,9 +26,11 @@ module DiscoveredHostsHelper
   end
 
   def multiple_discovered_hosts_actions_select
-    actions = [[_('Delete hosts'), multiple_destroy_discovered_hosts_path, hash_for_multiple_destroy_discovered_hosts_path]]
+    actions = [[_('Auto Provision'), multiple_auto_provision_discovered_hosts_path, hash_for_multiple_auto_provision_discovered_hosts_path]]
+    actions <<  [_('Reboot'), multiple_reboot_discovered_hosts_path, hash_for_multiple_reboot_discovered_hosts_path]
     actions <<  [_('Assign Organization'), select_multiple_organization_discovered_hosts_path,  hash_for_select_multiple_organization_discovered_hosts_path] if SETTINGS[:organizations_enabled]
     actions <<  [_('Assign Location'), select_multiple_location_discovered_hosts_path,  hash_for_select_multiple_location_discovered_hosts_path] if SETTINGS[:locations_enabled]
+    actions <<  [_('Delete'), multiple_destroy_discovered_hosts_path, hash_for_multiple_destroy_discovered_hosts_path]
 
     select_action_button( _("Select Action"), {:id => 'submit_multiple'},
       actions.map do |action|
@@ -56,17 +54,17 @@ module DiscoveredHostsHelper
 
   def discovery_status_icon(host)
     if host.created_at > 1.day.ago
-      status_glyph = 'glyphicon-plus-sign'
+      status_glyph = 'pficon-on-running'
       status_message = _('New in the last 24 hours')
-      status_color = '#89A54E'
+      status_color = '#0088ce'
     elsif host.last_report.present? && host.last_report < 7.days.ago
-      status_glyph = 'glyphicon-exclamation-sign'
+      status_glyph = 'pficon-paused'
       status_message = _('Not reported in more than 7 days')
-      status_color = '#AA4643'
+      status_color = '#ec7a08'
     else
-      status_glyph = 'glyphicon-ok-sign'
+      status_glyph = 'pficon-on'
       status_message = _('Reported in the last 7 days')
-      status_color = '#4572A7'
+      status_color = '#72767b'
     end
 
     "<span class='glyphicon #{status_glyph}' style='color: #{status_color}'

data/app/models/discovery_rule.rb

@@ -1,4 +1,5 @@
 class DiscoveryRule < ApplicationRecord
+  audited :associated_with => :hostgroup
   include Authorizable
   extend FriendlyId
   friendly_id :name
@@ -11,9 +12,11 @@ class DiscoveryRule < ApplicationRecord
   validates :hostname, :format => { :with => /\A[a-zA-Z<]/, :message => N_("must start with a letter or ERB.") },
     :allow_blank => true
   validates :hostgroup_id, :presence => true
+  validates :hostgroup, :presence => {:message => N_("must be present.")}
   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
 

data/app/models/host/discovered.rb

@@ -1,16 +1,19 @@
 class Host::Discovered < ::Host::Base
+  audited :except => [:last_report]
+  has_associated_audits
+  # redefine audits relation because of the type change (by default the relation will look for auditable_type = 'Host::Managed')
+  has_many :audits, -> { where(:auditable_type => 'Host::Base') }, :foreign_key => :auditable_id, :class_name => 'Audited::Audit'
+
   include ScopedSearchExtensions
   include Foreman::Renderer
   include BelongsToProxies
   include ::Hostext::OperatingSystem
 
-  belongs_to :hostgroup
-  has_one    :discovery_attribute_set, :foreign_key => :host_id, :dependent => :destroy
+  has_one :discovery_attribute_set, :foreign_key => :host_id, :dependent => :destroy
 
   validates :discovery_attribute_set, :presence => true
 
-  delegate :memory, :cpu_count, :disk_count, :disks_size, :to => :discovery_attribute_set
-  after_create :create_notification
+  delegate :memory, :cpu_count, :disk_count, :disks_size, :to => :discovery_attribute_set, :allow_nil => true
   after_destroy :delete_notification
 
   scoped_search :on => :name, :complete_value => true
@@ -39,6 +42,11 @@ class Host::Discovered < ::Host::Base
     where(taxonomy_conditions).order("hosts.created_at DESC")
   }
 
+  # Discovery import workflow:
+  # discovered#import_host ->
+  #  discovered#import_facts -> base#import_facts -> base#parse_facts ->
+  #  discovered#populate_fields_from_facts -> base#populate_fields_from_facts -> base#set_interfaces
+  #  discovered#populate_discovery_fields_from_facts
   def self.import_host facts
     raise(::Foreman::Exception.new(N_("Invalid facts, must be a Hash"))) unless facts.is_a?(Hash) || facts.is_a?(ActionController::Parameters)
 
@@ -56,16 +64,25 @@ class Host::Discovered < ::Host::Base
     hostname = normalize_string_for_hostname("#{hostname_prefix}#{name_fact}")
     Rails.logger.warn "Hostname does not start with an alphabetical character" unless hostname.downcase.match(/^[a-z]/)
 
-    # find existing or create new host record
+    # check for existing managed hosts and fail or warn
     bootif_mac = FacterUtils::bootif_mac(facts).try(:downcase)
-    hosts = ::Nic::Managed.where(:mac => bootif_mac, :primary => true)
-    if hosts.empty?
+    existing_managed = Nic::Managed.joins(:host).where(:mac => bootif_mac, :provision => true, :hosts => {:type => "Host::Managed"}).limit(1)
+    if existing_managed.count > 0
+      if Setting[:discovery_error_on_existing]
+        raise ::Foreman::Exception.new("One or more existing managed hosts found: %s", "#{existing_managed.first.name}/#{bootif_mac}")
+      else
+        Rails.logger.warn("One or more existing managed hosts found: #{existing_managed.first.name}/#{bootif_mac}")
+      end
+    end
+
+    # find existing discovered host (pick the oldest if multiple) or create new discovery host record
+    existing_discovery_hosts = Nic::Managed.joins(:host).where(:mac => bootif_mac, :provision => true, :hosts => {:type => "Host::Discovered"}).order('created_at DESC')
+    if existing_discovery_hosts.empty?
       host = Host.new(:name => hostname, :type => "Host::Discovered")
     else
-      Rails.logger.warn "Multiple discovered hosts found with MAC address #{name_fact}, choosing one" if hosts.size > 1
-      host = hosts.first.host
+      Rails.logger.warn "Multiple (#{existing_discovery_hosts.count}) discovery hosts found with MAC address #{name_fact} - picking most recent NIC entry" if existing_discovery_hosts.count > 1
+      host = existing_discovery_hosts.first.host
     end
-    raise ::Foreman::Exception.new("Host already exists as managed: %s", "#{host.name}/#{bootif_mac}") if host.type != "Host::Discovered"
 
     # and save (interfaces are created via puppet parser extension)
     host.save(:validate => false) if host.new_record?
@@ -105,10 +122,14 @@ class Host::Discovered < ::Host::Base
     end
 
     populate_discovery_fields_from_facts(facts)
+    create_notification
     parser
   end
 
   def populate_discovery_fields_from_facts(facts)
+    # set discovery search attributes first
+    self.discovery_attribute_set = DiscoveryAttributeSet.where(:host_id => id).first_or_create
+    self.discovery_attribute_set.update_attributes(import_from_facts)
     # set additional discovery attributes
     primary_ip = self.primary_interface.ip
     unless primary_ip.nil?
@@ -136,12 +157,12 @@ class Host::Discovered < ::Host::Base
         Rails.logger.info "Assigned organization: #{self.organization}"
       end
     else
-      raise(::Foreman::Exception.new(N_("Unable to assign subnet, primary interface is missing IP address")))
+      Rails.logger.warn "Unable to assign subnet - reboot trigger may not be possible, primary interface is missing IP address"
     end
-    self.discovery_attribute_set = DiscoveryAttributeSet.where(:host_id => id).first_or_create
-    self.discovery_attribute_set.update_attributes(import_from_facts)
+
     # lock the host into discovery via PXE, if feature is enabled in settings
     lock_templates if Setting::Discovered.discovery_lock? && self.subnet.tftp?
+  ensure
     self.save!
   end
 
@@ -174,11 +195,6 @@ class Host::Discovered < ::Host::Base
     {:cpu_count => cpu_count, :memory => memory, :disk_count => disk_count, :disks_size => disks_size}
   end
 
-  # no need to store anything in the db if the password is our default
-  def root_pass
-    read_attribute(:root_pass).blank? ? (hostgroup.try(:root_pass) || Setting[:root_pass]) : read_attribute(:root_pass)
-  end
-
   def proxied?
     subnet.present? && subnet.discovery.present?
   end
@@ -196,7 +212,7 @@ class Host::Discovered < ::Host::Base
     raise ::Foreman::WrappedException.new(e, N_("Could not get facts from proxy %{url}: %{error}"), :url => proxy_url, :error => e)
   end
 
-  def reboot 
+  def reboot
     resource = ::ForemanDiscovery::NodeAPI::Power.service(:url => proxy_url)
     resource.reboot
   rescue => e
@@ -247,4 +263,28 @@ class Host::Discovered < ::Host::Base
   def delete_notification
     ForemanDiscovery::UINotifications::DestroyHost.deliver!(self)
   end
+
+  def notification_recipients_ids
+    org_recipients = find_organization_users if Taxonomy.organizations_enabled
+    org_recipients ||= []
+
+    admins = User.unscoped.only_admin.except_hidden.
+      reorder('').distinct.pluck(:id)
+    (org_recipients + admins).uniq
+  end
+
+  private
+
+  def find_organization_users
+    return [] unless organization.present?
+    organization_users = if organization.ignore_types.include? 'User'
+                           User.unscoped.all
+                         else
+                           organization.users
+                         end
+
+    organization_users.find_all do |user|
+      user.can? :create_hosts
+    end.pluck(:id)
+  end
 end

data/app/models/setting/discovered.rb

@@ -34,6 +34,7 @@ class Setting::Discovered < ::Setting
         self.set('discovery_pxegrub_lock_template', N_("PXEGrub template to be used when pinning a host to discovery"), 'pxegrub_discovery', N_("Locked PXEGrub template name"), nil, { :collection => Proc.new {Hash[ProvisioningTemplate.where(:template_kind => TemplateKind.find_by_name(:snippet)).map{|template| [template[:name], template[:name]]}]} }),
         self.set('discovery_pxegrub2_lock_template', N_("PXEGrub2 template to be used when pinning a host to discovery"), 'pxegrub2_discovery', N_("Locked PXEGrub2 template name"), nil, { :collection => Proc.new {Hash[ProvisioningTemplate.where(:template_kind => TemplateKind.find_by_name(:snippet)).map{|template| [template[:name], template[:name]]}]} }),
         self.set('discovery_always_rebuild_dns', N_("Force DNS entries creation when provisioning discovered host"), true, N_("Force DNS")),
+        self.set('discovery_error_on_existing', N_("Do not allow to discover existing managed host matching MAC of a provisioning NIC (errors out early)"), false, N_("Error on existing NIC")),
       ].compact.each { |s| self.create s.update(:category => "Setting::Discovered")}
     end
 

data/app/services/foreman_discovery/fact_parser.rb

@@ -1,12 +1,16 @@
 module ForemanDiscovery
   class FactParser < ::PuppetFactParser
     def suggested_primary_interface(host)
-      raise("Discovery fact parser does not work with non-discovery host #{host}") if host.type != "Host::Discovered"
+      raise(::Foreman::Exception.new(N_("Discovery fact parser does not work with non-discovery host '%{host}'") %
+        {:host => host})) if host.type != "Host::Discovered"
+      raise(::Foreman::Exception.new(N_("Discovered host '%{host}' has all NICs filtered out, filter: %{filter}") %
+        {:host => host, :filter => Setting[:ignored_interface_identifiers]})) if interfaces.size == 0
       bootif_mac = FacterUtils::bootif_mac(facts).try(:downcase)
       detected = interfaces.detect { |_, values| values[:macaddress].try(:downcase) == bootif_mac }
       Rails.logger.debug "Discovery fact parser detected primary interface: #{detected}"
       # return the detected interface as array [name, facts]
-      detected || raise(::Foreman::Exception.new(N_("Unable to detect primary interface using MAC '%{mac}' specified by discovery_fact '%{fact}'") % {:mac => bootif_mac, :fact => FacterUtils::bootif_name}))
+      detected || raise(::Foreman::Exception.new(N_("Unable to find primary NIC with %{mac} specified via '%{fact}', NIC filter: %{filter}") %
+        {:mac => bootif_mac, :fact => FacterUtils::bootif_name, :filter => Setting[:ignored_interface_identifiers]}))
     end
 
     def parse_interfaces?

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ForemanDiscovery
   module UINotifications
     # Adds notification upon newly discovered Hosts
@@ -17,7 +18,8 @@ module ForemanDiscovery
       def add_notification
         Notification.create!(
           initiator: initiator,
-          audience: ::Notification::AUDIENCE_ADMIN,
+          audience: ::Notification::AUDIENCE_SUBJECT,
+          subject: subject,
           notification_blueprint: blueprint
         )
       end

data/app/views/dashboard/_discovery_widget_host_list.html.erb

@@ -1,4 +1,4 @@
-<table class="table table-striped table-fixed">
+<table class="<%= table_css_classes('table-fixed') %>">
   <thead>
   <th width="30%"><%= _('Host') %></th>
   <th class="hidden-tablet hidden-xs"><%= _('Model') %></th>

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

@@ -1,6 +1,6 @@
 <%= javascript "host_checkbox" %>
 <% title _('Discovered Hosts') %>
-<table class="table table-bordered table-striped table-condensed" >
+<table class="<%= table_css_classes('table-condensed') %>" >
   <tr>
     <th class="ca"><%= check_box_tag "check_all", "", false, { :onclick => "toggleCheck()", :'check-title' => _("Select all items in this page"), :'uncheck-title'=> _("items selected. Uncheck to Clear") } %></th>
     <th class=''><%= sort :name, :as => _('Name') %></th>
@@ -70,5 +70,4 @@
   </div><!-- /.modal-dialog -->
 </div><!-- /.modal -->
 
-<%= page_entries_info @hosts %>
-<%= will_paginate @hosts %>
+<%= will_paginate_with_info @hosts %>

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

@@ -1,7 +1,7 @@
 <div class="row">
   <div class="col-md-12">
 
-    <table class="table table-bordered table-striped">
+    <table class="<%= table_css_classes %>">
       <thead>
         <tr>
           <th><%= _('Name') %></th>

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

@@ -1,4 +1,2 @@
 <% title_actions multiple_discovered_hosts_actions_select -%>
-<% title_actions display_link_if_authorized(_("Reboot All"), hash_for_reboot_all_discovered_hosts_path, {:class => 'btn btn-default', :method => :put, :disabled => @hosts.empty?}) %>
-<% title_actions display_link_if_authorized(_("Auto Provision All"), hash_for_auto_provision_all_discovered_hosts_path, {:class => 'btn btn-default', :method => :post, :disabled => @hosts.empty?}) %>
 <%= render 'discovered_hosts_list' %>