foreman_ansible 2.2.14 → 2.3.0

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ipaddress'
 module ForemanAnsible
   # Relations to make Host::Managed 'have' ansible roles
@@ -11,7 +13,7 @@ module ForemanAnsible
       has_many :ansible_roles, :through => :host_ansible_roles,
                                :dependent => :destroy
       scoped_search :relation => :ansible_roles, :on => :name,
-                    :complete_value => true, :rename => :ansible_role,
+                    :complete_value => true, :rename => :role,
                     :only_explicit => true
 
       before_provision :play_ansible_roles

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanAnsible
   # Relations to make Hostgroup 'have' ansible roles
   module HostgroupExtensions

data/app/models/foreman_ansible/ansible_provider.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 if defined? ForemanRemoteExecution
   module ForemanAnsible
     # Provider for RemoteExecution that allows to run Ansible playbooks.

data/app/models/foreman_ansible/fact_name.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanAnsible
   # Define the class that fact names that come from Ansible should have
   # It allows us to filter facts by origin, and also to display the origin

data/app/models/host_ansible_role.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Join model that hosts the connection between hosts and ansible_roles
 class HostAnsibleRole < ApplicationRecord
   belongs_to_host

data/app/models/hostgroup_ansible_role.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Join model that hosts the connection between hostgroups and ansible_roles
 class HostgroupAnsibleRole < ApplicationRecord
   belongs_to :hostgroup

data/app/models/setting/ansible.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Setting
   # Provide settings related with Ansible
   class Ansible < ::Setting
@@ -59,8 +61,8 @@ class Setting
               'ansible_post_provision_timeout',
               N_('Timeout (in seconds) to set when Foreman will trigger a '\
                  'play Ansible roles task after a host is fully provisioned. '\
-                 'Set this to the maximum time you expect a host to take until'\
-                 ' it is ready after a reboot.'),
+                 'Set this to the maximum time you expect a host to take '\
+                 'until it is ready after a reboot.'),
               '360',
               N_('Post-provision timeout')
             ),
@@ -68,9 +70,9 @@ class Setting
               'top_level_ansible_vars',
               N_('Whether to put Ansible parameters in the "hostvars" '\
                  'top-level key of the inventory. By default it is true, so '\
-                 'that Host Parameters can be used directly in the playbooks.'\
-                 'When false, Host Parameters can only be accessed through'\
-                 'foreman_params["host_parameter"] in the playbooks.'),
+                 'that Host Parameters can be used directly in the '\
+                 'playbooks. When false, Host Parameters can only be accessed '\
+                 'through foreman_params["host_parameter"] in the playbooks.'),
               true,
               N_('Top level Ansible variables')
             ),

data/app/overrides/ansible_roles_tab.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Displays Ansible roles tab on Host form
 Deface::Override.new(
   :virtual_path => 'hosts/_form',

data/app/overrides/ansible_variables_edit.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+Deface::Override.new(
+  :virtual_path => 'lookup_keys/_fields',
+  :name => 'ansible_variables_edit',
+  :replace => "erb[loud]:contains('show_puppet_class')",
+  :partial => 'ansible_variables/ansible_roles_list'
+)
+
+Deface::Override.new(
+  :virtual_path => 'lookup_keys/_fields',
+  :name => 'ansible_variables_validator_text',
+  :replace => '.out.collapse > h6',
+  :partial => 'ansible_variables/validator_text'
+)

data/app/overrides/hostgroup_ansible_roles_tab.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Displays Ansible roles tab on Hostgroup form
 Deface::Override.new(
   :virtual_path => 'hostgroups/_form',

data/app/overrides/hostgroup_play_roles.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Displays Ansible roles button in host group action buttons
 Deface::Override.new(
   :virtual_path => 'hostgroups/index',

data/app/overrides/report_output.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Deface::Override.new(
   :virtual_path => 'config_reports/_output',
   :name => 'report_output',

data/app/services/foreman_ansible/ansible_report_importer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ipaddress'
 module ForemanAnsible
   # Ensures Ansible reports from hosts where the IP was used, are assigned
@@ -13,6 +15,19 @@ module ForemanAnsible
           @host = Nic::Interface.find_by(:ip => hostname).host
         end
         super
+        partial_hostname_match(hostname)
+      end
+
+      def partial_hostname_match(hostname)
+        return @host unless @host.new_record?
+        hosts = Host.where(Host.arel_table[:name].matches("#{hostname}.%"))
+        if hosts.count > 1
+          msg = "More than 1 host found for name #{hostname}, "
+          msg += 'please use host FQDN when uploading reports'
+          Rails.logger.warn msg
+          return @host
+        end
+        @host = hosts.first || @host
       end
     end
   end

data/app/services/foreman_ansible/ansible_report_scanner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanAnsible
   # Scans ConfigReports after import for indicators of an Ansible report and
   # sets the origin of the report to 'Ansible'

data/app/services/foreman_ansible/api_roles_importer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanAnsible
   # imports Ansible roles through API
   class ApiRolesImporter < RolesImporter

data/app/services/foreman_ansible/fact_importer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanAnsible
   # Override methods from Foreman app/services/fact_importer so that Ansible
   # facts are recognized in Foreman as ForemanAnsible facts. It supports

data/app/services/foreman_ansible/fact_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanAnsible
   # Override methods from Foreman app/services/fact_parser so that facts
   # representing host properties are understood when they come from Ansible.
@@ -53,7 +55,11 @@ module ForemanAnsible
       interface.tr!('-', '_') # virbr1-nic -> virbr1_nic
       interface_facts = facts[:"ansible_#{interface}"]
       ipaddress = ip_from_interface(interface)
-      HashWithIndifferentAccess[interface_facts.merge(:ipaddress => ipaddress)]
+      ipaddress6 = ipv6_from_interface(interface)
+      HashWithIndifferentAccess[
+        interface_facts.merge(:ipaddress => ipaddress,
+                              :ipaddress6 => ipaddress6)
+      ]
     end
 
     def ipmi_interface; end
@@ -70,6 +76,12 @@ module ForemanAnsible
       facts[:"ansible_#{interface}"]['ipv4']['address']
     end
 
+    def ipv6_from_interface(interface)
+      return if facts[:"ansible_#{interface}"]['ipv6'].blank?
+
+      facts[:"ansible_#{interface}"]['ipv6'].first['address']
+    end
+
     # Returns first non-empty fact. Needed to check for empty strings.
     def detect_fact(fact_names)
       facts[

data/app/services/foreman_ansible/fact_sparser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanAnsible
   # See sparse and unsparse documentation
   class FactSparser

data/app/services/foreman_ansible/insights_notification_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanAnsible
   # A class that builds custom notificaton for REX job if it's insights
   # remediation feature

data/app/services/foreman_ansible/insights_plan_runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 if defined?(RedhatAccess)
   module ForemanAnsible
     # Fetch information about a plan from RH Insights and run it
@@ -30,8 +32,7 @@ if defined?(RedhatAccess)
         resource = RestClient::Resource.new(
           "#{insights_api_host}/r/insights/"\
           "v3/maintenance/#{@plan_id}/playbook",
-          get_ssl_options_for_org(@organization, nil).\
-            merge(:proxy => get_portal_http_proxy)
+          get_ssl_options_for_org(@organization, nil)
         )
         @raw_playbook = resource.get.body
         YAML.safe_load(@raw_playbook)

data/app/services/foreman_ansible/inventory_creator.rb

@@ -94,7 +94,6 @@ module ForemanAnsible
         'ansible_become_user' => @template_invocation.effective_user,
         'ansible_user' => host_setting(host, 'remote_execution_ssh_user'),
         'ansible_ssh_pass' => rex_ssh_password(host),
-        'ansible_sudo_pass' => rex_sudo_password(host),
         'ansible_ssh_private_key_file' => ansible_or_rex_ssh_private_key(host),
         'ansible_port' => host_setting(host, 'remote_execution_ssh_port')
       }
@@ -118,11 +117,6 @@ module ForemanAnsible
         host_setting(host, 'remote_execution_ssh_password')
     end
 
-    def rex_sudo_password(host)
-      @template_invocation.job_invocation.sudo_password ||
-        host_setting(host, 'remote_execution_sudo_password')
-    end
-
     def ansible_or_rex_ssh_private_key(host)
       ansible_private_file = host_setting(host, 'ansible_ssh_private_key_file')
       if !ansible_private_file.empty?

data/app/services/foreman_ansible/operating_system_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanAnsible
   # Methods to parse facts related to the OS
   module OperatingSystemParser
@@ -57,7 +59,7 @@ module ForemanAnsible
 
     # rubocop:disable AbcSize
     def os_minor
-      _, minor = (os_release.split('.', 2) unless os_release.nil?) ||
+      _, minor = (os_release&.split('.', 2)) ||
                  (facts[:version].split('R') if os_name == 'junos')
       # Until Foreman supports os.minor as something that's not a number,
       # we should remove the extra dots in the version. E.g:

data/app/services/foreman_ansible/playbook_creator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanAnsible
   # Service to generate a playbook given roles and a list of hosts
   class PlaybookCreator

data/app/services/foreman_ansible/proxy_api.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ForemanAnsible
+  # Helper methods to create a ProxyAPI object for Ansible
+  module ProxyAPI
+    extend ActiveSupport::Concern
+
+    included do
+      attr_reader :ansible_proxy
+
+      def find_proxy_api
+        if ansible_proxy.blank?
+          raise ::Foreman::Exception.new(N_('Proxy not found'))
+        end
+        @proxy_api = ::ProxyAPI::Ansible.new(:url => ansible_proxy.url)
+      end
+
+      def proxy_api
+        return @proxy_api if @proxy_api
+        find_proxy_api
+      end
+    end
+  end
+end

data/app/services/foreman_ansible/renderer_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanAnsible
   # Macro to fetch RH Insights plan playbook
   module RendererMethods

data/app/services/foreman_ansible/roles_importer.rb

@@ -1,15 +1,16 @@
+# frozen_string_literal: true
+
 module ForemanAnsible
   # Imports roles from smart proxy
   class RolesImporter
-    attr_reader :ansible_proxy
+    include ::ForemanAnsible::ProxyAPI
 
     def initialize(proxy = nil)
       @ansible_proxy = proxy
     end
 
     def import_role_names
-      return import_roles remote_roles if ansible_proxy
-      import_roles local_roles
+      import_roles remote_roles if @ansible_proxy.present?
     end
 
     def fetch_role_names
@@ -33,20 +34,6 @@ module ForemanAnsible
 
     private
 
-    def find_proxy_api
-      raise ::Foreman::Exception.new(N_('Proxy not found')) unless ansible_proxy
-      @proxy_api = ::ProxyAPI::Ansible.new(:url => ansible_proxy.url)
-    end
-
-    def proxy_api
-      return @proxy_api if @proxy_api
-      find_proxy_api
-    end
-
-    def local_roles
-      ::ForemanAnsibleCore::RolesReader.list_roles
-    end
-
     def remote_roles
       proxy_api.roles
     end

data/app/services/foreman_ansible/structured_fact_importer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanAnsible
   # On 1.13+ , use the parser for structured facts (like Facter 2) that comes
   # from core

data/app/services/foreman_ansible/ui_roles_importer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanAnsible
   # imports ansible roles through UI
   class UiRolesImporter < RolesImporter

data/app/services/foreman_ansible/variables_importer.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module ForemanAnsible
+  # Methods to transform variable names coming from the proxy into
+  # Foreman AnsibleVariable objects
+  class VariablesImporter
+    include ::ForemanAnsible::ProxyAPI
+
+    def initialize(proxy = nil)
+      @ansible_proxy = proxy
+    end
+
+    def import_variable_names(new_roles)
+      return import_variables(remote_variables, new_roles) if @ansible_proxy
+      import_variables(local_variables, new_roles)
+    end
+
+    def import_variables(role_variables, new_roles)
+      detect_changes(
+        role_variables.map do |role_name, variables|
+          role = import_new_role(role_name, new_roles)
+          next if role.blank?
+          initialize_variables(variables, role)
+        end.select(&:present?).flatten.compact
+      )
+    end
+
+    def import_new_role(role_name, new_roles)
+      role = AnsibleRole.find_by(:name => role_name)
+      if role.blank? && new_roles.map(&:name).include?(role_name)
+        role = new_roles.select { |r| r.name == role_name }.first
+      end
+      role
+    end
+
+    def initialize_variables(variables, role)
+      variables.map do |variable|
+        variable = AnsibleVariable.find_or_initialize_by(
+          :key => variable
+          # :key_type, :default_value, :required
+        )
+        variable.ansible_role = role
+        variable.valid? ? variable : nil
+      end
+    end
+
+    def detect_changes(imported)
+      changes = {}.with_indifferent_access
+      old, changes[:new] = imported.partition { |role| role.id.present? }
+      changes[:obsolete] = AnsibleVariable.where.not(:id => old.map(&:id))
+      changes
+    end
+
+    def finish_import(new, obsolete)
+      results = { :added => [], :obsolete => [] }
+      results[:added] = create_new_variables(new) if new.present?
+      results[:obsolete] = delete_old_variables(obsolete) if obsolete.present?
+      results
+    end
+
+    def create_new_variables(new)
+      added = []
+      new.each do |role, variables|
+        variables.each_value do |variable_properties|
+          variable = AnsibleVariable.new(
+            JSON.parse(variable_properties)['ansible_variable']
+          )
+          variable.ansible_role = ::AnsibleRole.find_by(:name => role)
+          variable.save
+          added << variable.key
+        end
+      end
+      added
+    end
+
+    def delete_old_variables(old)
+      removed = []
+      old.each_value do |variables|
+        variables.each_value do |variable|
+          variable = AnsibleVariable.find(
+            JSON.parse(variable)['ansible_variable']['id']
+          )
+          removed << variable.key
+          variable.destroy
+        end
+      end
+      removed
+    end
+
+    private
+
+    def local_variables
+      ::AnsibleVariable.all
+    end
+
+    def remote_variables
+      proxy_api.all_variables
+    end
+  end
+end