foreman_ansible 6.0.2 → 6.4.0

data/app/jobs/sync_roles_and_variables.rb

@@ -0,0 +1,20 @@
+class SyncRolesAndVariables < ::ApplicationJob
+  queue_as :default
+
+  def perform(changed, proxy)
+    roles_importer = ForemanAnsible::UiRolesImporter.new(proxy)
+    variables_importer = ForemanAnsible::VariablesImporter.new(proxy)
+    roles_importer.finish_import(changed)
+    variables_importer.import_variables_roles(changed) if changed['new'] || changed['old']
+    task = ForemanTasks::Task.where(:external_id => @provider_job_id)[0]
+    ForemanAnsible::ImportRolesAndVariablesSuccessNotification.deliver!(task)
+  rescue StandardError => e
+    task = ForemanTasks::Task.where(:external_id => @provider_job_id)[0]
+    notification = ForemanAnsible::ImportRolesAndVariablesErrorNotification.new(e, task)
+    notification.deliver!
+  end
+
+  def humanized_name
+    _('Import roles And Variables')
+  end
+end

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

@@ -8,9 +8,12 @@ module ForemanAnsible
       base.instance_eval do
         include ::ForemanAnsible::Concerns::JobInvocationHelper
 
-        has_many :host_ansible_roles, :foreign_key => :host_id
-        has_many :ansible_roles, :through => :host_ansible_roles,
-                                 :dependent => :destroy
+        has_many :host_ansible_roles, -> { order('host_ansible_roles.position ASC') }, :foreign_key => :host_id
+        accepts_nested_attributes_for :host_ansible_roles, :allow_destroy => true
+        has_many :ansible_roles,
+                 -> { order('host_ansible_roles.position ASC') },
+                 :through => :host_ansible_roles,
+                 :dependent => :destroy
         scoped_search :relation => :ansible_roles, :on => :name,
                       :complete_value => true, :rename => :ansible_role,
                       :only_explicit => true
@@ -47,7 +50,7 @@ module ForemanAnsible
     end
 
     def all_ansible_roles
-      (ansible_roles + inherited_ansible_roles).uniq
+      (inherited_ansible_roles + ansible_roles).uniq
     end
 
     # Class methods we may need to override or add
@@ -68,9 +71,9 @@ end
 module Host
   class Managed
     apipie :class do
-      property :all_ansible_roles, array_of: 'AnsibleRole', desc: 'Returns all ansible roles assigned to the host, both its own and inherited'
-      property :ansible_roles, array_of: 'AnsibleRole', desc: 'Returns ansible roles assigned to the host'
-      property :inherited_ansible_roles, array_of: 'AnsibleRole', desc: 'Returns inherited ansible roles assigned to the host'
+      property :all_ansible_roles, array_of: 'AnsibleRole', desc: 'Returns all ansible roles assigned to the host, both its own and inherited from the host group and its parents'
+      property :ansible_roles, array_of: 'AnsibleRole', desc: 'Returns ansible roles directly assigned to the host'
+      property :inherited_ansible_roles, array_of: 'AnsibleRole', desc: 'Returns only ansible roles assigned to the host\'s host group and its parents'
     end
     # Methods to be allowed in any template with safemode enabled
     class Jail < Safemode::Jail

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

@@ -7,8 +7,11 @@ module ForemanAnsible
 
     included do
       has_many :hostgroup_ansible_roles, :foreign_key => :hostgroup_id
-      has_many :ansible_roles, :through => :hostgroup_ansible_roles,
-                               :dependent => :destroy
+      has_many :ansible_roles,
+               -> { order('hostgroup_ansible_roles.position ASC') },
+               :through => :hostgroup_ansible_roles,
+               :dependent => :destroy
+      accepts_nested_attributes_for :hostgroup_ansible_roles, :allow_destroy => true
       audit_associations :ansible_roles
 
       def inherited_ansible_roles
@@ -24,15 +27,27 @@ module ForemanAnsible
       end
 
       def host_ansible_roles
-        hosts.all.includes(:ansible_roles).flat_map(&:ansible_roles)
+        hosts.includes(:host_ansible_roles).flat_map(&:ansible_roles)
       end
 
       # includes also roles of all assigned hosts, useful to determine if
       # at least one host in this hostgroup has some ansible role assigned
       # either directly or through hostgroup
       def all_ansible_roles
-        (ansible_roles + inherited_ansible_roles + host_ansible_roles).uniq
+        (inherited_ansible_roles + ansible_roles + host_ansible_roles).uniq
       end
     end
   end
 end
+
+class Hostgroup
+  apipie :class do
+    property :all_ansible_roles, array_of: 'AnsibleRole', desc: 'Returns all ansible roles assigned to the host group, both its own and inherited from parent host groups'
+    property :ansible_roles, array_of: 'AnsibleRole', desc: 'Returns ansible roles directly assigned to the host group'
+    property :inherited_ansible_roles, array_of: 'AnsibleRole', desc: 'Returns only the inherited ansible roles assigned to the host group\'s parents'
+  end
+  # Methods to be allowed in any template with safemode enabled
+  class Jail < Safemode::Jail
+    allow :all_ansible_roles, :ansible_roles, :inherited_ansible_roles
+  end
+end

data/app/models/foreman_ansible/ansible_provider.rb

@@ -18,6 +18,10 @@ if defined? ForemanRemoteExecution
           'Ansible'
         end
 
+        def provider_input_namespace
+          :ansible
+        end
+
         def proxy_command_options(template_invocation, host)
           super(template_invocation, host).merge(
             'ansible_inventory' => ::ForemanAnsible::InventoryCreator.new(
@@ -27,7 +31,8 @@ if defined? ForemanRemoteExecution
             :remote_execution_command => ansible_command?(
               template_invocation.template
             ),
-            :name => host.name
+            :name => host.name,
+            :check_mode => host.host_param('ansible_roles_check_mode')
           )
         end
 
@@ -58,12 +63,57 @@ if defined? ForemanRemoteExecution
           true
         end
 
+        def provider_inputs
+          [
+            ForemanRemoteExecution::ProviderInput.new(
+              name: 'tags',
+              label: _('Tags'),
+              value: '',
+              value_type: 'plain',
+              description: 'Tags used for Ansible execution'
+            ),
+            ForemanRemoteExecution::ProviderInput.new(
+              name: 'tags_flag',
+              label: _('Include/Exclude Tags'),
+              value: 'include',
+              description: 'Option whether to include or exclude tags',
+              options: "include\nexclude"
+            )
+          ]
+        end
+
+        def provider_inputs_doc
+          opts = provider_inputs.find { |input| input.name == 'tags_flag' }.options.split("\n")
+          {
+            :namespace => provider_input_namespace,
+            :opts => { :desc => N_('Ansible provider specific inputs') },
+            :children => [
+              {
+                :name => :tags,
+                :type => Array,
+                :opts => { :required => false, :desc => N_('A comma separated list of tags to use for Ansible run') }
+              },
+              {
+                :name => :tags_flag,
+                :type => opts,
+                :opts => { :required => false, :desc => N_('Include\Exclude tags for Ansible run') }
+              }
+            ]
+          }
+        end
+
+        def proxy_command_provider_inputs(template_invocation)
+          tags = template_invocation.provider_input_values.find_by(:name => 'tags')&.value || ''
+          tags_flag = template_invocation.provider_input_values.find_by(:name => 'tags_flag')&.value || ''
+          { :tags => tags, :tags_flag => tags_flag }
+        end
+
         def proxy_operation_name
           'ansible-runner'
         end
 
         def proxy_action_class
-          'ForemanAnsibleCore::TaskLauncher::Playbook::PlaybookRunnerAction'
+          'Proxy::Ansible::TaskLauncher::Playbook::PlaybookRunnerAction'
         end
 
         private

data/app/models/host_ansible_role.rb

@@ -4,6 +4,7 @@
 class HostAnsibleRole < ApplicationRecord
   belongs_to_host
   belongs_to :ansible_role
+  acts_as_list scope: :host
 
   validates :ansible_role_id, :presence => true,
                               :uniqueness => { :scope => :host_id }

data/app/models/hostgroup_ansible_role.rb

@@ -4,6 +4,7 @@
 class HostgroupAnsibleRole < ApplicationRecord
   belongs_to :hostgroup
   belongs_to :ansible_role
+  acts_as_list scope: :hostgroup
 
   validates :ansible_role_id, :presence => true,
                               :uniqueness => { :scope => :hostgroup_id }

data/app/models/setting/ansible.rb

@@ -3,6 +3,7 @@
 class Setting
   # Provide settings related with Ansible
   class Ansible < ::Setting
+    ::Setting::BLANK_ATTRS.concat %w[ansible_roles_to_ignore]
     class << self
       # It would be more disadvantages than advantages to split up
       # default_settings into multiple methods, this way it's already very
@@ -80,6 +81,14 @@ class Setting
                'with Ansible inventory'),
             'Ansible - Ansible Inventory',
             N_('Default Ansible inventory report template')
+          ),
+          set(
+            'ansible_roles_to_ignore',
+            N_('Those roles will be excluded when importing roles from smart proxy, '\
+                'The expected input is comma separated values and you can use * wildcard metacharacters'\
+                'For example: foo*, *b*,*bar'),
+            [],
+            N_('Ansible roles to ignore')
           )
         ]
       end

data/app/services/foreman_ansible/ansible_report_importer.rb

@@ -18,6 +18,10 @@ module ForemanAnsible
         partial_hostname_match(hostname)
       end
 
+      def self.authorized_smart_proxy_features
+        super + ['Ansible']
+      end
+
       def partial_hostname_match(hostname)
         return @host unless @host.new_record?
         hosts = Host.where(Host.arel_table[:name].matches("#{hostname}.%"))

data/app/services/foreman_ansible/ansible_report_scanner.rb

@@ -5,7 +5,21 @@ module ForemanAnsible
   # sets the origin of the report to 'Ansible'
   class AnsibleReportScanner
     class << self
-      def add_reporter_data(report, raw); end
+      def add_reporter_data(_report, raw)
+        check_mode_message = raw['check_mode'] ? 'check_mode_enabled' : 'check_mode_disabled'
+        check_mode_log = {
+          'log': {
+            'sources': {
+              'source': 'check_mode'
+            },
+            'messages': {
+              'message': check_mode_message
+            },
+            'level': 'info'
+          }
+        }
+        raw['logs'].insert(0, check_mode_log.deep_stringify_keys)
+      end
 
       def identify_origin(raw)
         'Ansible' if ansible_report?(raw)

data/app/services/foreman_ansible/api_roles_importer.rb

@@ -3,15 +3,31 @@
 module ForemanAnsible
   # imports Ansible roles through API
   class ApiRolesImporter < RolesImporter
-    def import!(role_names = nil)
-      new_roles = import_role_names[:new]
-      if role_names.present?
-        new_roles.select! do |role|
-          role_names.include?(role.name)
+    include ::ForemanAnsible::AnsibleRolesDataPreparations
+
+    def import!(role_names)
+      @roles_importer = ForemanAnsible::UiRolesImporter.new(@ansible_proxy)
+      @variables_importer = ForemanAnsible::VariablesImporter.new(@ansible_proxy)
+      params = { 'changed' => {} }
+      roles = prepare_ansible_import_rows(@roles_importer.import!, @variables_importer, false)
+      roles.each do |role|
+        if role_names.include? role[:name]
+          params['changed'][role[:kind]] ||= {}
+          params['changed'][role[:kind]][role[:name]] = { 'id' => role[:id], 'name' => role[:name] }
         end
       end
-      new_roles.map(&:save)
-      new_roles
+      params
+    end
+
+    def confirm_import(params)
+      @roles_importer.finish_import(params['changed'])
+      @variables_importer.import_variables_roles(params['changed']) if params['changed']['new'] || params['changed']['old']
+    end
+
+    def confirm_sync(params)
+      job = SyncRolesAndVariables.perform_later(params['changed'], @ansible_proxy)
+      task = ForemanTasks::Task.find_by(external_id: job.provider_job_id)
+      task
     end
 
     def obsolete!
@@ -19,9 +35,5 @@ module ForemanAnsible
       obsolete_roles.map(&:destroy)
       obsolete_roles
     end
-
-    def fetch!
-      fetch_role_names
-    end
   end
 end

data/app/services/foreman_ansible/fact_parser.rb

@@ -72,6 +72,22 @@ module ForemanAnsible
       Time.zone.now.to_i - facts['ansible_uptime_seconds'].to_i
     end
 
+    def virtual
+      facts['ansible_virtualization_role'] == 'guest'
+    end
+
+    def ram
+      facts['ansible_memtotal_mb'].to_i
+    end
+
+    def sockets
+      facts['ansible_processor_count'].to_i
+    end
+
+    def cores
+      facts['ansible_processor_cores'].to_i
+    end
+
     private
 
     def ansible_interfaces
@@ -85,7 +101,11 @@ module ForemanAnsible
 
     def ip_from_interface(interface)
       return if facts[:"ansible_#{interface}"]['ipv4'].blank?
-      facts[:"ansible_#{interface}"]['ipv4']['address']
+      if facts[:"ansible_#{interface}"]['ipv4'].is_a?(Array)
+        facts[:"ansible_#{interface}"]['ipv4'][0]['address']
+      else
+        facts[:"ansible_#{interface}"]['ipv4']['address']
+      end
     end
 
     def ipv6_from_interface(interface)

data/app/services/foreman_ansible/import_roles_and_variables_error_notification.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ForemanAnsible
+  class ImportRolesAndVariablesErrorNotification < ::UINotifications::Base
+    private
+
+    def initialize(error, task)
+      @job_error = error
+      @subject = task
+    end
+
+    def create
+      ::Notification.create!(
+        :audience => Notification::AUDIENCE_USER,
+        :notification_blueprint => blueprint,
+        :initiator => initiator,
+        :message => message,
+        :subject => subject
+      )
+    end
+
+    def blueprint
+      name = 'Sync_roles_and_variables_failed'
+      @blueprint ||= NotificationBlueprint.unscoped.find_by(:name => name)
+    end
+
+    def message
+      _("Failed to import roles and variables Due to: #{@job_error}")
+    end
+  end
+end

data/app/services/foreman_ansible/import_roles_and_variables_success_notification.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ForemanAnsible
+  class ImportRolesAndVariablesSuccessNotification < ::UINotifications::Base
+    private
+
+    def create
+      ::Notification.create!(
+        :audience => Notification::AUDIENCE_USER,
+        :notification_blueprint => blueprint,
+        :initiator => initiator,
+        :message => message,
+        :subject => subject
+      )
+    end
+
+    def blueprint
+      name = 'Sync_roles_and_variables_successfully'
+      @blueprint ||= NotificationBlueprint.unscoped.find_by(:name => name)
+    end
+
+    def message
+      blueprint.message
+    end
+  end
+end

data/app/services/foreman_ansible/inventory_creator.rb

@@ -99,7 +99,7 @@ module ForemanAnsible
       params = {
         'ansible_user' => host_setting(host, 'remote_execution_ssh_user'),
         'ansible_become_method' => host_setting(host, 'remote_execution_effective_user_method'),
-        'ansible_ssh_private_key_file' => ansible_or_rex_ssh_private_key(host),
+        'ansible_ssh_private_key_file' => ansible_ssh_private_key(host),
         'ansible_port' => host_setting(host, 'remote_execution_ssh_port'),
         'ansible_host' => AnsibleProvider.find_ip_or_hostname(host)
       }
@@ -122,13 +122,9 @@ module ForemanAnsible
       result
     end
 
-    def ansible_or_rex_ssh_private_key(host)
+    def ansible_ssh_private_key(host)
       ansible_private_file = host_setting(host, 'ansible_ssh_private_key_file')
-      if !ansible_private_file.empty?
-        ansible_private_file
-      else
-        ForemanRemoteExecutionCore.settings[:ssh_identity_key_file]
-      end
+      ansible_private_file unless ansible_private_file.empty?
     end
 
     private

data/app/services/foreman_ansible/operating_system_parser.rb

@@ -80,8 +80,14 @@ module ForemanAnsible
         facts[:ansible_os_name].tr(" \n\t", '') ||
           facts[:ansible_distribution].tr(" \n\t", '')
       else
-        facts[:ansible_distribution] ||
-          facts[:ansible_lsb] && facts[:ansible_lsb]['id']
+        distribution = facts[:ansible_lsb].try(:[], 'id') || facts[:ansible_distribution]
+
+        if distribution == 'RedHat' &&
+           facts[:ansible_lsb].try(:[], 'id') == 'RedHatEnterpriseWorkstation'
+          distribution += '_Workstation'
+        end
+
+        distribution
       end
     end