foreman_ansible 6.0.2 → 6.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f071261ab8d77b0963a3ee7a82e198139cf095391a9140efb6a7d954778a5fa
-  data.tar.gz: 0355abc8c57df2c8af562546353d76b663d4a4634fb7b16f937a59eb13c3c4e8
+  metadata.gz: 05c975cb77fe5add41b7281dfa1c2451bb22a09ab5dc6251ab06fd4d00b834e2
+  data.tar.gz: 86613f4be767b5af80a06f83b9e13f8f030cd80bc362d866323111b61a0b23a9
 SHA512:
-  metadata.gz: dfe1e9afb9fb2be9ec55bb2df53c132daa25f8ede8918734bcc6992fc4a75b687bebb32b382abdb5ddb8bd842c890f13e583c932f250e700a2237c1ccf7eda6b
-  data.tar.gz: 2c065cb05f42b4bcf52003a64e8466542ebc6eec5e6fcda5332f8f0f6a0a6f4f9f5c031cda9ae82c306402f6820c15c9a7194d9a2a776aa054276d4dfee2b044
+  metadata.gz: dc27695cef374e8b709ddc3c3882056587cbf975ac7d497c1fec5aaa1885f85bcb3677c2c7fd3f2602f529cba0a6736017703f6d7ca413eb5f2ed7a6de112a94
+  data.tar.gz: ba0c5f9b94a51b7328cc0df73bfcc0f47831b1004b275be935fa73a83ae9c6f12b81086071ebe69292c8aa5ad436c5389a6a6f1ac457720bcefe034b456c0ec8

data/app/controllers/ansible_roles_controller.rb

@@ -4,7 +4,7 @@
 class AnsibleRolesController < ::ApplicationController
   include Foreman::Controller::AutoCompleteSearch
   include ForemanAnsible::Concerns::ImportControllerHelper
-
+  include ::ForemanAnsible::AnsibleRolesDataPreparations
   def index
     @ansible_roles = resource_base.search_for(params[:search],
                                               :order => params[:order]).
@@ -22,18 +22,21 @@ class AnsibleRolesController < ::ApplicationController
 
   def import
     changed = @importer.import!
-    if changed.values.all?(&:empty?)
+    @rows = prepare_ansible_import_rows(changed, @variables_importer)
+    if @rows.empty?
       success no_changed_roles_message
       redirect_to ansible_roles_path
     else
-      render :locals => { :changed => changed }
+      render
     end
   end
 
   def confirm_import
-    @importer.finish_import(params[:changed]&.to_unsafe_h)
-    success _('Import of roles successfully finished.')
-    redirect_to ansible_roles_path
+    job = SyncRolesAndVariables.perform_later(params['changed'].to_unsafe_h, @proxy)
+    task = ForemanTasks::Task.find_by(external_id: job.provider_job_id)
+    render json: {
+      task: task
+    }, status: :ok
   end
 
   private
@@ -44,10 +47,11 @@ class AnsibleRolesController < ::ApplicationController
 
   def create_importer
     @importer = ForemanAnsible::UiRolesImporter.new(@proxy)
+    @variables_importer = ForemanAnsible::VariablesImporter.new(@proxy)
   end
 
   def no_changed_roles_message
-    return _('No changes in roles detected.') if @proxy.blank?
-    _('No changes in roles detected on %s.') % @proxy.name
+    return _('No added or removed roles nor variables.') if @proxy.blank?
+    _('No added or removed roles nor variables detected on %s.') % @proxy.name
   end
 end

data/app/controllers/ansible_variables_controller.rb

@@ -104,4 +104,8 @@ class AnsibleVariablesController < ::LookupKeysController
     end
     @smart_proxy
   end
+
+  def controller_permission
+    'ansible_variables'
+  end
 end

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

@@ -72,8 +72,8 @@ module Api
           process_resource_error(:resource => @ansible_inventory)
         end
       rescue StandardError => e
-        render_error 'standard_error', :status => :internal_error,
-                                       :locals => { :exception => e }
+        render_error :custom_error, :status => :unprocessable_entity,
+                                    :locals => { :message => _("Scheduling Report template failed for: #{e.message}") }
       end
 
       def action_permission

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

@@ -5,6 +5,7 @@ module Api
     # API controller for Ansible Roles
     class AnsibleRolesController < ::Api::V2::BaseController
       include ::Api::Version2
+      include ::ForemanAnsible::AnsibleRolesDataPreparations
 
       resource_description do
         api_version 'v2'
@@ -12,8 +13,8 @@ module Api
       end
 
       before_action :find_resource, :only => [:show, :destroy]
-      before_action :find_proxy, :only => [:import, :obsolete, :fetch]
-      before_action :create_importer, :only => [:import, :obsolete, :fetch]
+      before_action :find_proxy, :only => [:import, :obsolete, :fetch, :sync]
+      before_action :create_importer, :only => [:import, :obsolete, :fetch, :sync]
 
       api :GET, '/ansible_roles/:id', N_('Show role')
       param :id, :identifier, :required => true
@@ -32,28 +33,46 @@ module Api
         process_response @ansible_role.destroy
       end
 
-      api :PUT, '/ansible_roles/import', N_('Import Ansible roles')
+      api :PUT, '/ansible_roles/import', N_('DEPRECATED: Import Ansible roles'), deprecated: true
       param :proxy_id, :identifier, :required => true, :desc => N_('Smart Proxy to import from')
-      param :role_names, Array, N_('Ansible role names to import')
+      param :role_names, Array, N_('Ansible role names to be imported')
       def import
-        @imported = @importer.import!(role_names)
+        Foreman::Deprecation.api_deprecation_warning(_('Use sync instead, to sync roles from Smart Proxy with Ansible feature enabled'))
+        new_roles = @roles_importer.import_role_names['new']
+        if role_names.present?
+          new_roles.select! do |role|
+            role_names.include?(role.name)
+          end
+        end
+        new_roles.map(&:save)
+        @imported = new_roles
+      end
+
+      api :PUT, '/ansible_roles/sync', N_('Sync Ansible roles')
+      param :proxy_id, :identifier, :required => true, :desc => N_('Smart Proxy to sync from')
+      param :role_names, Array, N_('Ansible role names to be synced')
+      def sync
+        params = @importer.import!(role_names)
+        if params['changed'].present?
+          @task = @importer.confirm_sync(params)
+        else
+          render_message _('No changes detected in specified Ansible Roles and their variables')
+        end
       end
 
-      api :PUT, '/ansible_roles/obsolete', N_('Obsolete Ansible roles')
+      api :PUT, '/ansible_roles/obsolete', N_('DEPRECATED: Obsolete Ansible roles'), deprecated: true
       param :proxy_id, :identifier, N_('Smart Proxy to import from')
       def obsolete
+        Foreman::Deprecation.api_deprecation_warning(_('Use sync instead, to sync roles from Smart Proxy with Ansible feature enabled'))
         @obsoleted = @importer.obsolete!
       end
 
       api :GET, '/ansible_roles/fetch',
-          N_('Fetch Ansible roles available to be imported')
+          N_('Fetch Ansible roles available to be synced')
       param :proxy_id, :identifier, N_('Smart Proxy to fetch from'),
             :required => true
       def fetch
-        fetched = []
-        @importer.fetch!.each do |role_name|
-          fetched << { :name => role_name }
-        end
+        fetched =  prepare_ansible_import_rows(@roles_importer.import!, @variables_importer, false)
         respond_to do |format|
           format.json do
             render :json => { :results => { :ansible_roles => fetched } }
@@ -79,6 +98,8 @@ module Api
       # rubocop:enable Layout/DotPosition
 
       def create_importer
+        @roles_importer = ForemanAnsible::UiRolesImporter.new(@proxy)
+        @variables_importer = ForemanAnsible::VariablesImporter.new(@proxy)
         @importer = ForemanAnsible::ApiRolesImporter.new(@proxy)
       end
     end

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

@@ -69,20 +69,22 @@ module Api
       end
 
       api :PUT, '/ansible_variables/import',
-          N_('Import Ansible variables. This will only import variables '\
-             'for already existing roles, it will not import any new roles')
+          N_('DEPRECATED: Import Ansible variables. This will only import variables '\
+             'for already existing roles, it will not import any new roles'), deprecated: true
       param :proxy_id, :identifier, N_('Smart Proxy to import from'), :required => true
       def import
+        Foreman::Deprecation.api_deprecation_warning(_('Use sync instead, to sync roles from Smart Proxy with Ansible feature enabled'))
         new_variables = @importer.import_variable_names([])[:new]
         new_variables.map(&:save)
         @imported = new_variables
       end
 
       api :PUT, '/ansible_variables/obsolete',
-          N_('Obsolete Ansible variables. This will only obsolete variables '\
-             'for already existing roles, it will not delete any old roles')
+          N_('DEPRECATED: Obsolete Ansible variables. This will only obsolete variables '\
+             'for already existing roles, it will not delete any old roles'), deprecated: true
       param :proxy_id, :identifier, N_('Smart Proxy to import from'), :required => true
       def obsolete
+        Foreman::Deprecation.api_deprecation_warning(_('Use sync instead, to sync roles from Smart Proxy with Ansible feature enabled'))
         old_variables = @importer.import_variable_names([])[:obsolete]
         old_variables.map(&:destroy)
         @obsoleted = old_variables

data/app/controllers/foreman_ansible/concerns/import_controller_helper.rb

@@ -9,15 +9,15 @@ module ForemanAnsible
       included do
         # rubocop:disable Rails/LexicallyScopedActionFilter
         before_action :find_resource, :only => [:destroy]
-        before_action :find_proxy, :only => [:import]
-        before_action :create_importer, :only => [:import, :confirm_import]
+        before_action :find_proxy, :only => [:import, :import_variables, :confirm_import]
+        before_action :create_importer, :only => [:import, :confirm_import, :import_variables, :confirm_import]
         before_action :default_order, :only => [:index]
         # rubocop:enable Rails/LexicallyScopedActionFilter
       end
 
       def find_proxy
         return nil unless params[:proxy]
-        @proxy = SmartProxy.authorized(:view_smart_proxies).find(params[:proxy])
+        @proxy = SmartProxy.find(params[:proxy])
       end
     end
   end

data/app/helpers/foreman_ansible/ansible_reports_helper.rb

@@ -4,27 +4,57 @@ module ForemanAnsible
   # This module takes the config reports stored in Foreman for Ansible and
   # modifies them to be properly presented in views
   module AnsibleReportsHelper
-    ANSIBLE_META_KEYS = %w[
-      _ansible_parsed _ansible_no_log _ansible_item_result
-      _ansible_ignore_errors _ansible_verbose_always _ansible_verbose_override
-    ].freeze
-    ANSIBLE_HIDDEN_KEYS = %w[
-      invocation module_args results ansible_facts
-      stdout stderr
-    ].freeze
-
     def ansible_module_name(log)
       source_value = log.source&.value
       name = source_value.split(':')[0].strip if source_value&.include?(':')
       name
     end
 
-    def ansible_module_args(log)
-      report_json_viewer module_invocations parsed_message_json(log)
+    def ansible_task_name(log)
+      source_value = log.source&.value
+      return source_value || no_data_message unless source_value.include? ':'
+      name = source_value.split(':')[1].strip if source_value.include?(':')
+      name || no_data_message
+    end
+
+    def ansible_run_in_check_mode?(log)
+      log.message&.value == 'check_mode_enabled' if check_mode_log?(log)
+    end
+
+    def check_mode_log?(log)
+      log.source&.value == 'check_mode'
     end
 
     def ansible_module_message(log)
-      report_json_viewer hash_with_keys_removed parsed_message_json(log)
+      msg_json = parsed_message_json(log)
+      module_action = msg_json['module']
+      case module_action
+      when 'package'
+        msg_json['results'].empty? ? msg_json['msg'] : msg_json['results']
+      when 'template'
+        module_args = msg_json['invocation']['module_args']
+        _("Rendered template #{module_args['_original_basename']} to #{msg_json['dest']}")
+      when 'service'
+        _("Service #{msg_json['name']} #{msg_json['state']} (enabled: #{msg_json['enabled']})")
+      when 'group'
+        _("User group #{msg_json['name']} #{msg_json['state']}, gid: #{msg_json['gid']}")
+      when 'user'
+        _("User #{msg_json['name']} #{msg_json['state']}, uid: #{msg_json['uid']}")
+      when 'cron'
+        module_args = msg_json['invocation']['module_args']
+        _("Cron job: #{module_args['minute']} #{module_args['hour']} #{module_args['day']} #{module_args['month']} #{module_args['weekday']} #{module_args['job']} (disabled: #{module_args['disabled']})")
+      when 'copy'
+        module_args = msg_json['invocation']['module_args']
+        _("Copy #{module_args['_original_basename']} to #{msg_json['dest']}")
+      when 'command', 'shell'
+        msg_json['stdout_lines']
+      else
+        no_data_message
+      end
+    end
+
+    def no_data_message
+      _('No additional data')
     end
 
     def ansible_report_origin_icon
@@ -41,52 +71,8 @@ module ForemanAnsible
       false
     end
 
-    def report_json_viewer(json)
-      uid = "reportjson-viewer-#{json.object_id}"
-      viewer = content_tag :div, '', :id => uid
-      viewer << mount_react_component('ReportJsonViewer',
-                                      "##{uid}", json.to_json)
-    end
-
     private
 
-    def module_invocations(hash)
-      invocations = []
-      invocations << hash.delete('invocation')
-      results = hash.delete('results')
-      invocations << results
-      invocations = invocations.compact.flatten.map do |ih|
-        ih.is_a?(Hash) ? remove_keys(ih) : ih
-      end
-      invocations
-    end
-
-    def pretty_print_hash(hash)
-      prettyp = JSON.pretty_generate(remove_keys(hash))
-      prettyp.gsub!(/{\n*/, "\n")
-      prettyp.gsub!(/},*\n*/, "\n")
-      prettyp.gsub!(/^(\[|\])/, '')
-      prettyp.gsub!(/^[\s]*$\n/, '')
-      paragraph_style = 'white-space:pre;padding: 2em 0'
-      content_tag(:p, prettyp, :style => paragraph_style)
-    end
-
-    def hash_with_keys_removed(hash)
-      new_hash = remove_keys(hash)
-      remove_keys(new_hash, ANSIBLE_HIDDEN_KEYS)
-    end
-
-    def remove_keys(hash, keys = ANSIBLE_META_KEYS)
-      hash.each do |key, value|
-        if value.is_a? Array
-          value.each { |h| remove_keys(h) if h.is_a? Hash }
-        elsif value.is_a? Hash
-          remove_keys(value)
-        end
-        hash.delete(key) if keys.include? key
-      end
-    end
-
     def parsed_message_json(log)
       JSON.parse(log.message.value)
     rescue StandardError => e

data/app/helpers/foreman_ansible/ansible_roles_data_preparations.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module ForemanAnsible
+  module AnsibleRolesDataPreparations
+    VARIABLE_ACTION_NAMES = { 'new' => N_('Add'), 'obsolete' => N_('Remove'), 'update' => N_('Update') }.freeze
+    ROLE_ACTION_NAMES = { 'new' => N_('Import Role'), 'obsolete' => N_('Remove Role'), 'old' => N_('Update Role Variables') }.freeze
+
+    def get_variable_action(kind)
+      _(VARIABLE_ACTION_NAMES[kind])
+    end
+
+    def get_role_action(kind)
+      _(ROLE_ACTION_NAMES[kind])
+    end
+
+    def get_old_roles_variables(imported_variables, role)
+      variables = { 'Add' => [], 'Remove' => [], 'Update' => [] }
+      imported_variables.each do |kind, temp_variables|
+        temp_variables.each do |temp_variable|
+          variables[get_variable_action(kind)].append(temp_variable.key) if temp_variable.ansible_role_id == role.id
+        end
+      end
+      variables
+    end
+
+    def variables_to_s(variables)
+      str = ''
+      variables.each do |action, temp_variables|
+        str += "#{action}: #{temp_variables.size}, " unless temp_variables.empty?
+      end
+      str[0..-3]
+    end
+
+    def get_roles_variables(imported_variables, variables_importer, kind, role)
+      if kind == 'new'
+        variables = { 'Add' => variables_importer.get_variables_names(role.name) }
+      elsif kind == 'obsolete'
+        variables = { 'Remove' => role.ansible_variables.map(&:key) }
+      elsif kind == 'old'
+        variables = get_old_roles_variables(imported_variables, role)
+      end
+      variables_to_s(variables)
+    end
+
+    def excluded_roles
+      Setting.convert_array_to_regexp(Setting[:ansible_roles_to_ignore])
+    end
+
+    def role_match_excluded_roles(role_name)
+      match = role_name.match(excluded_roles)
+      match.to_s.empty? ? nil : match
+    end
+
+    def prepare_api_row(role, kind, variables, role_action)
+      {
+        name: role.name,
+        id: role.id,
+        role_action: role_action,
+        variables: variables,
+        hosts_count: role_action == 'Remove Role' ? role.hosts.count : '',
+        hostgroup_count: role_action == 'Remove Role' ? role.hostgroups.count : '',
+        kind: kind
+      }
+    end
+
+    def prepare_ui_row(role, kind, variables, role_action)
+      { cells: [
+        role.name,
+        role_action, variables,
+        role_action == 'Remove Role' ? role.hosts.count : '',
+        role_action == 'Remove Role' ? role.hostgroups.count : ''
+      ],
+        role: role, kind: kind, id: role.name }
+    end
+
+    def prepare_ansible_import_rows(changed, variables_importer, is_ui = true)
+      rows = []
+      changed.each do |kind, roles|
+        imported_variables = variables_importer.import_variable_names(roles)
+        roles.each do |role|
+          next if role_match_excluded_roles(role.name)
+          variables = get_roles_variables(imported_variables, variables_importer, kind, role)
+          next if variables.empty? && kind['old']
+          role_action = get_role_action(kind)
+          if is_ui
+            rows.append(prepare_ui_row(role, kind, variables, role_action))
+          else
+            rows.append(prepare_api_row(role, kind, variables, role_action))
+          end
+        end
+      end
+      rows
+    end
+  end
+end

data/app/helpers/foreman_ansible/ansible_roles_helper.rb

@@ -35,8 +35,27 @@ module ForemanAnsible
       _('%s ago') % time_ago_in_words(role.updated_at)
     end
 
+    def role_attributes_for_roles_switcher(form_object)
+      inherited_role_ids = form_object.inherited_ansible_roles.map(&:id)
+      if form_object.is_a?(Hostgroup)
+        assoc_roles = form_object.hostgroup_ansible_roles
+        assoc_key = :hostgroup_ansible_role_id
+      else
+        assoc_roles = form_object.host_ansible_roles
+        assoc_key = :host_ansible_role_id
+      end
+      own_roles_attrs = model_roles_attrs(assoc_roles.reject { |ar| inherited_role_ids.include?(ar.ansible_role_id) }, assoc_key)
+      roles_attrs(form_object.inherited_ansible_roles) + own_roles_attrs
+    end
+
     def roles_attrs(roles)
-      roles.map { |item| { :id => item.id, :name => item.name } }
+      roles.map { |item| { id: item.id, name: item.name } }
+    end
+
+    private
+
+    def model_roles_attrs(associated_roles, assoc_key)
+      associated_roles.map { |item| { id: item.ansible_role_id, name: item.ansible_role.name, position: item.position }.merge(assoc_key => item.id) }
     end
   end
 end