foreman_salt 14.0.0 → 14.1.0

data/app/models/foreman_salt/concerns/host_managed_extensions.rb

@@ -10,7 +10,7 @@ module ForemanSalt
 
         def params
           params = super
-          params['salt_master'] = salt_master unless salt_master.blank?
+          params['salt_master'] = salt_master if salt_master.present?
           params
         end
 
@@ -23,31 +23,31 @@ module ForemanSalt
         end
 
         def inherited_attributes
-          super + %w(salt_proxy_id salt_environment_id)
+          super + %w[salt_proxy_id salt_environment_id]
         end
       end
 
       included do
-        has_many :host_salt_modules, :foreign_key => :host_id, :class_name => '::ForemanSalt::HostSaltModule'
-        has_many :salt_modules, :through => :host_salt_modules, :class_name => '::ForemanSalt::SaltModule'
+        has_many :host_salt_modules, foreign_key: :host_id, class_name: '::ForemanSalt::HostSaltModule'
+        has_many :salt_modules, through: :host_salt_modules, class_name: '::ForemanSalt::SaltModule'
 
-        belongs_to :salt_proxy, :class_name => 'SmartProxy'
-        belongs_to :salt_environment, :class_name => 'ForemanSalt::SaltEnvironment'
+        belongs_to :salt_proxy, class_name: 'SmartProxy'
+        belongs_to :salt_environment, class_name: 'ForemanSalt::SaltEnvironment'
 
         prepend Overrides
 
-        scoped_search :relation => :salt_modules, :on => :name, :complete_value => true, :rename => :salt_state
-        scoped_search :relation => :salt_environment, :on => :name, :complete_value => true, :rename => :salt_environment
-        scoped_search :relation => :salt_proxy, :on => :name, :complete_value => true, :rename => :saltmaster
+        scoped_search relation: :salt_modules, on: :name, complete_value: true, rename: :salt_state
+        scoped_search relation: :salt_environment, on: :name, complete_value: true, rename: :salt_environment
+        scoped_search relation: :salt_proxy, on: :name, complete_value: true, rename: :saltmaster
 
         validate :salt_modules_in_host_environment
 
-        after_build :ensure_salt_autosign, :if => ->(host) { host.salt_proxy }
-        before_destroy :remove_salt_minion, :if => ->(host) { host.salt_proxy }
+        after_build :ensure_salt_autosign, if: ->(host) { host.salt_proxy }
+        before_destroy :remove_salt_minion, if: ->(host) { host.salt_proxy }
       end
 
       def salt_params
-        variables = ForemanSalt::SaltVariable.where(:salt_module_id => all_salt_modules.pluck(:id), :override => true)
+        variables = ForemanSalt::SaltVariable.where(salt_module_id: all_salt_modules.pluck(:id), override: true)
         values = variables.values_hash(self)
 
         variables.each_with_object({}) do |var, memo|
@@ -58,11 +58,11 @@ module ForemanSalt
       end
 
       def host_params_grains_name
-        "salt_grains"
+        'salt_grains'
       end
 
       def autosign_grain_name
-        "autosign_key"
+        'autosign_key'
       end
 
       def salt_modules_for_enc
@@ -73,7 +73,7 @@ module ForemanSalt
         return [] unless salt_environment
 
         modules = salt_modules + (hostgroup ? hostgroup.all_salt_modules : [])
-        ForemanSalt::SaltModule.in_environment(salt_environment).where(:id => modules)
+        ForemanSalt::SaltModule.in_environment(salt_environment).where(id: modules)
       end
 
       def salt_master
@@ -81,22 +81,22 @@ module ForemanSalt
       end
 
       def saltrun!
-        unless salt_proxy.present?
+        if salt_proxy.blank?
           errors.add(:base, _("No Salt master defined - can't continue"))
           logger.warn 'Unable to execute salt run, no salt proxies defined'
           return false
         end
-        ProxyAPI::Salt.new(:url => salt_proxy.url).highstate name
-      rescue => e
+        ProxyAPI::Salt.new(url: salt_proxy.url).highstate name
+      rescue StandardError => e
         errors.add(:base, _('Failed to execute state.highstate: %s') % e)
         false
       end
 
       def salt_modules_in_host_environment
-        return unless self.salt_modules.any?
+        return unless salt_modules.any?
 
-        if self.salt_environment
-          errors.add(:base, _('Salt states must be in the environment of the host')) unless (self.salt_modules - self.salt_environment.salt_modules).empty?
+        if salt_environment
+          errors.add(:base, _('Salt states must be in the environment of the host')) unless (salt_modules - salt_environment.salt_modules).empty?
         else
           errors.add(:base, _('Host must have an environment in order to set salt states'))
         end
@@ -105,10 +105,10 @@ module ForemanSalt
       def derive_salt_grains(use_autosign: False)
         grains = {}
         begin
-          Rails.logger.info("Derive Salt Grains from host_params and autosign_key")
+          Rails.logger.info('Derive Salt Grains from host_params and autosign_key')
           grains[autosign_grain_name] = salt_autosign_key if use_autosign && !salt_autosign_key.nil?
           unless host_params[host_params_grains_name].nil? ||
-              host_params[host_params_grains_name].class != Hash
+                 host_params[host_params_grains_name].class != Hash
             grains.merge!(host_params[host_params_grains_name])
           end
         rescue Foreman::Exception => e
@@ -131,43 +131,44 @@ module ForemanSalt
 
       def remove_salt_key
         Rails.logger.info("Remove salt key for host #{fqdn}")
-        api = ProxyAPI::Salt.new(:url => salt_proxy.url)
+        api = ProxyAPI::Salt.new(url: salt_proxy.url)
         api.key_delete(name)
       end
 
       def remove_salt_autosign
-        key = self.salt_autosign_key
-        unless key.nil?
-          Rails.logger.info("Remove salt autosign key for host #{fqdn}")
-          begin
-            api = ProxyAPI::Salt.new(:url => salt_proxy.url)
-            api.autosign_remove_key(key)
-          rescue Foreman::Exception => e
-            Rails.logger.warn("Unable to remove salt autosign for #{fqdn}: #{e}")
-          end
+        key = salt_autosign_key
+        return if key.nil?
+        Rails.logger.info("Remove salt autosign key for host #{fqdn}")
+        begin
+          api = ProxyAPI::Salt.new(url: salt_proxy.url)
+          api.autosign_remove_key(key)
+        rescue Foreman::Exception => e
+          Rails.logger.warn("Unable to remove salt autosign for #{fqdn}: #{e}")
         end
       end
 
       def generate_provisioning_key
-          SecureRandom.hex(10)
+        SecureRandom.hex(10)
       end
 
       def create_salt_autosign
-        begin
-          Rails.logger.info("Create salt autosign key for host #{fqdn}")
-          api = ProxyAPI::Salt.new(:url => salt_proxy.url)
-          key = generate_provisioning_key
-          api.autosign_create_key(key)
-          update(:salt_autosign_key => key)
-          update(:salt_status => ForemanSalt::SaltStatus.minion_auth_waiting)
-        rescue Foreman::Exception => e
-          Rails.logger.warn("Unable to create salt autosign for #{fqdn}: #{e}")
-        end
+        Rails.logger.info("Create salt autosign key for host #{fqdn}")
+        api = ProxyAPI::Salt.new(url: salt_proxy.url)
+        key = generate_provisioning_key
+        api.autosign_create_key(key)
+        update(salt_autosign_key: key)
+        update(salt_status: ForemanSalt::SaltStatus.minion_auth_waiting)
+      rescue Foreman::Exception => e
+        Rails.logger.warn("Unable to create salt autosign for #{fqdn}: #{e}")
       end
     end
   end
 end
 
-class ::Host::Managed::Jail < Safemode::Jail
-  allow :salt_environment, :salt_master, :derive_salt_grains
+# rubocop:disable Style/ClassAndModuleChildren
+class Host::Managed
+  class Jail < ::Safemode::Jail
+    allow :salt_environment, :salt_master, :derive_salt_grains
+  end
 end
+# rubocop:enable Style/ClassAndModuleChildren

data/app/models/foreman_salt/concerns/hostgroup_extensions.rb

@@ -4,23 +4,26 @@ module ForemanSalt
       extend ActiveSupport::Concern
 
       included do
-        has_many :hostgroup_salt_modules, :class_name => '::ForemanSalt::HostgroupSaltModule'
-        has_many :salt_modules, :through => :hostgroup_salt_modules, :class_name => '::ForemanSalt::SaltModule'
+        has_many :hostgroup_salt_modules, class_name: '::ForemanSalt::HostgroupSaltModule'
+        has_many :salt_modules, through: :hostgroup_salt_modules, class_name: '::ForemanSalt::SaltModule'
 
-        belongs_to :salt_proxy, :class_name => 'SmartProxy'
-        belongs_to :salt_environment, :class_name => 'ForemanSalt::SaltEnvironment'
+        belongs_to :salt_proxy, class_name: 'SmartProxy'
+        belongs_to :salt_environment, class_name: 'ForemanSalt::SaltEnvironment'
 
-        scoped_search :relation => :salt_modules, :on => :name, :complete_value => true, :rename => :salt_state
-        scoped_search :relation => :salt_environment, :on => :name, :complete_value => true, :rename => :salt_environment
-        scoped_search :relation => :salt_proxy, :on => :name, :complete_value => true, :rename => :saltmaster
+        scoped_search relation: :salt_modules, on: :name, complete_value: true, rename: :salt_state
+        scoped_search relation: :salt_environment, on: :name, complete_value: true, rename: :salt_environment
+        scoped_search relation: :salt_proxy, on: :name, complete_value: true, rename: :saltmaster
+
+        validates :salt_proxy, presence: true, unless: -> { salt_proxy_id.blank? }
+        validates :salt_environment, presence: true, unless: -> { salt_environment_id.blank? }
       end
 
       def all_salt_modules
-        ForemanSalt::SaltModule.in_environment(salt_environment).where(:id => salt_module_ids + inherited_salt_module_ids)
+        ForemanSalt::SaltModule.in_environment(salt_environment).where(id: salt_module_ids + inherited_salt_module_ids)
       end
 
       def inherited_salt_modules
-        ForemanSalt::SaltModule.where(:id => inherited_salt_module_ids)
+        ForemanSalt::SaltModule.where(id: inherited_salt_module_ids)
       end
 
       def inherited_salt_module_ids
@@ -29,7 +32,7 @@ module ForemanSalt
 
       def salt_proxy
         if ancestry.present?
-          SmartProxy.with_features('Salt').find_by_id(inherited_salt_proxy_id)
+          SmartProxy.with_features('Salt').find_by(id: inherited_salt_proxy_id)
         else
           super
         end
@@ -41,7 +44,7 @@ module ForemanSalt
 
       def salt_environment
         if ancestry.present?
-          ForemanSalt::SaltEnvironment.find_by_id(inherited_salt_environment_id)
+          ForemanSalt::SaltEnvironment.find_by(id: inherited_salt_environment_id)
         else
           super
         end

data/app/models/foreman_salt/host_salt_module.rb

@@ -1,6 +1,6 @@
 module ForemanSalt
   class HostSaltModule < ApplicationRecord
-    belongs_to :host, :class_name => 'Host::Managed', :foreign_key => :host_id
+    belongs_to :host, class_name: 'Host::Managed'
     belongs_to :salt_module
   end
 end

data/app/models/foreman_salt/salt_environment.rb

@@ -5,17 +5,17 @@ module ForemanSalt
     friendly_id :name
     include Parameterizable::ByIdName
 
-    has_many :hosts, :class_name => '::Host::Managed'
-    has_many :hostgroups, :class_name => '::Hostgroup'
+    has_many :hosts, class_name: '::Host::Managed'
+    has_many :hostgroups, class_name: '::Hostgroup'
 
     has_many :salt_module_environments
-    has_many :salt_modules, :through => :salt_module_environments, :before_remove => :remove_from_hosts
+    has_many :salt_modules, through: :salt_module_environments, before_remove: :remove_from_hosts
 
-    validates :name, :uniqueness => true, :presence => true, :format => { :with => /\A[\w\d\.]+\z/, :message => N_('is alphanumeric and cannot contain spaces') }
+    validates :name, uniqueness: true, presence: true, format: { with: /\A[\w\d.]+\z/, message: N_('is alphanumeric and cannot contain spaces') }
 
-    scoped_search :on => :name, :complete_value => true
-    scoped_search :relation => :hostgroups, :on => :name, :complete_value => true, :rename => :hostgroup
-    scoped_search :relation => :hosts, :on => :name, :complete_value => true, :rename => :host
+    scoped_search on: :name, complete_value: true
+    scoped_search relation: :hostgroups, on: :name, complete_value: true, rename: :hostgroup
+    scoped_search relation: :hosts, on: :name, complete_value: true, rename: :host
 
     def self.humanize_class_name(_name = nil)
       _('Salt environment')
@@ -28,7 +28,7 @@ module ForemanSalt
     private
 
     def remove_from_hosts(state)
-      HostSaltModule.joins(:host).where(:hosts => { :salt_environment_id => id }, :salt_module_id => state).destroy
+      HostSaltModule.joins(:host).where(hosts: { salt_environment_id: id }, salt_module_id: state).destroy
     end
   end
 end

data/app/models/foreman_salt/salt_module.rb

@@ -7,19 +7,21 @@ module ForemanSalt
     friendly_id :name
     include Parameterizable::ByIdName
 
-    has_many :host_salt_modules, :foreign_key => :salt_module_id
-    has_many :hosts, :through => :host_salt_modules, :class_name => '::Host::Managed'
+    has_many :host_salt_modules
+    has_many :hosts, through: :host_salt_modules, class_name: '::Host::Managed'
 
-    has_many :hostgroup_salt_modules, :foreign_key => :salt_module_id
-    has_many :hostgroups, :through => :hostgroup_salt_modules
+    has_many :hostgroup_salt_modules
+    has_many :hostgroups, through: :hostgroup_salt_modules
 
-    has_many :salt_variables, :inverse_of => :salt_module,
-                              :dependent => :destroy
+    has_many :salt_variables, inverse_of: :salt_module,
+                              dependent: :destroy
 
     has_many :salt_module_environments
-    has_many :salt_environments, :through => :salt_module_environments
+    has_many :salt_environments, through: :salt_module_environments
 
-    validates :name, :uniqueness => true, :presence => true, :format => { :with => /\A(?:[\w\d\-]+\.{0,1})+[^\.]\z/, :message => N_('must be alphanumeric, can contain periods, dashes, underscores and must not contain spaces') }
+    validates :name, uniqueness: true, presence: true,
+                     format: { with: /\A(?:[\w\d\-]+\.{0,1})+[^.]\z/,
+                               message: N_('must be alphanumeric, can contain periods, dashes, underscores and must not contain spaces') }
 
     default_scope lambda {
       order('salt_modules.name')
@@ -27,15 +29,15 @@ module ForemanSalt
 
     scope :in_environment, ->(environment) { joins(:salt_environments).where('salt_module_environments.salt_environment_id' => environment) }
 
-    scoped_search :on => :name, :complete_value => true
-    scoped_search :relation => :salt_environments, :on => :name, :complete_value => true, :rename => :environment
-    scoped_search :relation => :hostgroups, :on => :name, :complete_value => true, :rename => :hostgroup
-    scoped_search :relation => :hosts, :on => :name, :complete_value => true, :rename => :host
+    scoped_search on: :name, complete_value: true
+    scoped_search relation: :salt_environments, on: :name, complete_value: true, rename: :environment
+    scoped_search relation: :hostgroups, on: :name, complete_value: true, rename: :hostgroup
+    scoped_search relation: :hosts, on: :name, complete_value: true, rename: :host
 
     def self.to_hash
       states = {}
 
-      SaltEnvironment.all.each do |environment|
+      SaltEnvironment.all.find_each do |environment|
         states[environment.name] = environment.salt_modules.map(&:name)
       end
 

data/app/models/foreman_salt/salt_module_environment.rb

@@ -8,7 +8,7 @@ module ForemanSalt
     private
 
     def remove_from_hosts
-      HostSaltModule.joins(:host).where(:hosts => { :salt_environment_id => salt_environment_id }, :salt_module_id => salt_module_id).destroy
+      HostSaltModule.joins(:host).where(hosts: { salt_environment_id: salt_environment_id }, salt_module_id: salt_module_id).destroy
     end
   end
 end

data/app/models/foreman_salt/salt_provider.rb

@@ -14,14 +14,17 @@ module ForemanSalt
       end
 
       def proxy_command_options(template_invocation, host)
-        super(template_invocation, host).merge(:name => host.name)
+        super(template_invocation, host).merge(name: host.name)
       end
 
-      def ssh_password(_host); end
+      def ssh_password(_host)
+      end
 
-      def ssh_key_passphrase(_host); end
+      def ssh_key_passphrase(_host)
+      end
 
-      def sudo_password(_host); end
+      def sudo_password(_host)
+      end
     end
   end
 end

data/app/models/foreman_salt/salt_variable.rb

@@ -3,12 +3,12 @@
 module ForemanSalt
   # Represents the variables used in Salt
   class SaltVariable < LookupKey
-    belongs_to :salt_module, :inverse_of => :salt_variables
-    validates :salt_module_id, :presence => true
-    before_validation :cast_default_value, :if => :override?
-    scoped_search :on => :key, :aliases => [:name], :complete_value => true
-    scoped_search :relation => :salt_module, :on => :name,
-                  :complete_value => true, :rename => :salt_module
+    belongs_to :salt_module, inverse_of: :salt_variables
+    validates :salt_module_id, presence: true
+    before_validation :cast_default_value, if: :override?
+    scoped_search on: :key, aliases: [:name], complete_value: true
+    scoped_search relation: :salt_module, on: :name,
+                  complete_value: true, rename: :salt_module
 
     def salt?
       true
@@ -18,12 +18,12 @@ module ForemanSalt
       if options.present?
         super
       else
-        "Salt variable"
+        'Salt variable'
       end
     end
 
     def editable_by_user?
-      SaltVariable.authorized(:edit_external_parameters).where(:id => id).exists?
+      SaltVariable.authorized(:edit_external_parameters).exists?(id: id)
     end
   end
 end

data/app/models/setting/salt.rb

@@ -1,13 +1,15 @@
-class Setting::Salt < Setting
-  def self.default_settings
-    [
-      set('salt_namespace_pillars', N_("Namespace Foreman pillars under 'foreman' key"), false),
-      set('salt_hide_run_salt_button', N_("Hide the Run Salt state.highstate button on the host details page"), false)
-    ]
-  end
+class Setting
+  class Salt < ::Setting
+    def self.default_settings
+      [
+        set('salt_namespace_pillars', N_("Namespace Foreman pillars under 'foreman' key"), false),
+        set('salt_hide_run_salt_button', N_('Hide the Run Salt state.highstate button on the host details page'), false),
+      ]
+    end
 
-  def self.load_defaults
-    super
-    Setting['salt_hide_run_salt_button'] = true if ForemanSalt.with_remote_execution?
+    def self.load_defaults
+      super
+      Setting['salt_hide_run_salt_button'] = true if ForemanSalt.with_remote_execution?
+    end
   end
 end

data/app/overrides/salt_environment_host_selector.rb

@@ -7,8 +7,8 @@ selector_text = "<%= select_f f, :salt_environment_id, ForemanSalt::SaltEnvironm
                                    :help_inline => :indicator} %>"
 
 Deface::Override.new(
-  :virtual_path => 'hosts/_form',
-  :name => 'add_salt_environment_to_host',
-  :insert_bottom => 'div#primary',
-  :text => selector_text
+  virtual_path: 'hosts/_form',
+  name: 'add_salt_environment_to_host',
+  insert_bottom: 'div#primary',
+  text: selector_text
 )

data/app/overrides/salt_environment_hostgroup_selector.rb

@@ -5,8 +5,8 @@ selector_text = "<%= select_f f, :salt_environment_id, ForemanSalt::SaltEnvironm
                                    :'data-host-id' => (@host || @hostgroup).id, :help_inline => :indicator} %>"
 
 Deface::Override.new(
-  :virtual_path => 'hostgroups/_form',
-  :name => 'add_salt_environment_to_hostgroup',
-  :insert_bottom => 'div#primary',
-  :text => selector_text
+  virtual_path: 'hostgroups/_form',
+  name: 'add_salt_environment_to_hostgroup',
+  insert_bottom: 'div#primary',
+  text: selector_text
 )

data/app/overrides/salt_modules_selector.rb

@@ -1,19 +1,19 @@
-Deface::Override.new(:virtual_path => 'hosts/_form',
-                     :name => 'add_salt_modules_tab_to_host',
-                     :insert_after => 'li.active',
-                     :partial => 'foreman_salt/salt_modules/host_tab')
+Deface::Override.new(virtual_path: 'hosts/_form',
+                     name: 'add_salt_modules_tab_to_host',
+                     insert_after: 'li.active',
+                     partial: 'foreman_salt/salt_modules/host_tab')
 
-Deface::Override.new(:virtual_path => 'hosts/_form',
-                     :name => 'add_salt_modules_tab_pane_to_host',
-                     :insert_before => 'div#primary',
-                     :partial => 'foreman_salt/salt_modules/host_tab_pane')
+Deface::Override.new(virtual_path: 'hosts/_form',
+                     name: 'add_salt_modules_tab_pane_to_host',
+                     insert_before: 'div#primary',
+                     partial: 'foreman_salt/salt_modules/host_tab_pane')
 
-Deface::Override.new(:virtual_path => 'hostgroups/_form',
-                     :name => 'add_salt_modules_tab_to_hg',
-                     :insert_after => 'li.active',
-                     :partial => 'foreman_salt/salt_modules/host_tab')
+Deface::Override.new(virtual_path: 'hostgroups/_form',
+                     name: 'add_salt_modules_tab_to_hg',
+                     insert_after: 'li.active',
+                     partial: 'foreman_salt/salt_modules/host_tab')
 
-Deface::Override.new(:virtual_path => 'hostgroups/_form',
-                     :name => 'add_salt_modules_tab_pane_to_hg',
-                     :insert_before => 'div#primary',
-                     :partial => 'foreman_salt/salt_modules/host_tab_pane')
+Deface::Override.new(virtual_path: 'hostgroups/_form',
+                     name: 'add_salt_modules_tab_pane_to_hg',
+                     insert_before: 'div#primary',
+                     partial: 'foreman_salt/salt_modules/host_tab_pane')

data/app/overrides/salt_proxy_selector.rb

@@ -1,17 +1,19 @@
-selector_text = "<%= select_f f, :salt_proxy_id, SmartProxy.unscoped.with_features('Salt').with_taxonomy_scope(@location,@organization, :path_ids), :id, :name,
+selector_text = "<%= select_f f, :salt_proxy_id,
+                                 SmartProxy.unscoped.with_features('Salt').with_taxonomy_scope(@location,@organization, :path_ids),
+                                 :id, :name,
                                  { :include_blank => blank_or_inherit_f(f, :salt_proxy) },
                                  { :label         => _('Salt Master') } %>"
 
 Deface::Override.new(
-  :virtual_path => 'hosts/_form',
-  :name => 'add_salt_proxy_to_host',
-  :insert_bottom => 'div#primary',
-  :text => selector_text
+  virtual_path: 'hosts/_form',
+  name: 'add_salt_proxy_to_host',
+  insert_bottom: 'div#primary',
+  text: selector_text
 )
 
 Deface::Override.new(
-  :virtual_path => 'hostgroups/_form',
-  :name => 'add_salt_proxy_to_hostgroup',
-  :insert_bottom => 'div#primary',
-  :text => selector_text
+  virtual_path: 'hostgroups/_form',
+  name: 'add_salt_proxy_to_hostgroup',
+  insert_bottom: 'div#primary',
+  text: selector_text
 )