foreman_ansible 1.5.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cdb2243734dd64231cdbefae5b464c67f33c9607
-  data.tar.gz: aa058575b4eb578fdb19be3da7c289f90e4d3b58
+  metadata.gz: 3b4137a958734d1507b19751c33bc1c5e91bc321
+  data.tar.gz: c2c57f2e7c31865609c7ba1a0e843edae1dc694e
 SHA512:
-  metadata.gz: 5bb05ca2370bc1157b1e9ccb1be811847504d98dff0233d993f2ca3908c7d5e271d64e3f73669f77b64cd5b45f931ea6a9323e9ea815a91628a40195170e3d5d
-  data.tar.gz: 5218a4406ea854950be3679140c8300d670e407a7d51d9302736844b7ecafbbe5897b94a31f2b7a8dcbf0844947446e5a7c226d93405dd0bd6b4e8c4dbe7d53e
+  metadata.gz: 96aadc541d8c7870a7ad14b8c5ea7a491ea793b4506aafbcf2d148d64c0fd8762d824499f05c484e8d727298e347735bff7a414a1d739713157345923b7f0728
+  data.tar.gz: 04a3d2a65993f39c4a0fedabd0cf08c9bc4fea720edebc7452085effb22d12d020619d318accee167f7e37ffb4ea7037dfd100d00bc5397ea6155b3634b6c005

data/Rakefile

@@ -17,7 +17,7 @@ end
 begin
   require 'rubocop/rake_task'
   RuboCop::RakeTask.new
-rescue => _
+rescue StandardError => _
   puts 'Rubocop not loaded.'
 end
 

data/app/controllers/foreman_ansible/api/v2/hostgroups_controller_extensions.rb

@@ -5,10 +5,10 @@ module ForemanAnsible
       module HostgroupsControllerExtensions
         extend ActiveSupport::Concern
         include ForemanTasks::Triggers
+        include ::ForemanAnsible::Concerns::JobInvocationHelper
 
         # Included blocks shouldn't be bound by length, as otherwise concerns
         # cannot extend the method properly.
-        # rubocop:disable BlockLength
         included do
           api :POST, '/hostgroups/:id/play_roles',
               N_('Plays Ansible roles on a hostgroup')
@@ -16,14 +16,8 @@ module ForemanAnsible
 
           def play_roles
             find_resource
-
-            @result = {
-              :hostgroup => @hostgroup, :foreman_tasks => async_task(
-                ::Actions::ForemanAnsible::PlayHostgroupRoles, @hostgroup
-              )
-            }
-
-            render_message @result
+            composer = job_composer(:ansible_run_host, @hostgroup.hosts)
+            process_response composer.trigger!, composer.job_invocation
           end
 
           api :POST, '/hostgroups/play_roles',
@@ -32,18 +26,9 @@ module ForemanAnsible
 
           def multiple_play_roles
             find_multiple
-
-            @result = []
-
-            @hostgroups.uniq.each do |hostgroup|
-              @result.append(
-                :hostgroup => hostgroup, :foreman_tasks => async_task(
-                  ::Actions::ForemanAnsible::PlayHostgroupRoles, hostgroup
-                )
-              )
-            end
-
-            render_message @result
+            composer = job_composer(:ansible_run_host,
+                                    @hostgroups.map(&:hosts).flatten.uniq)
+            process_response composer.trigger!, composer.job_invocation
           end
         end
 

data/app/controllers/foreman_ansible/api/v2/hosts_controller_extensions.rb

@@ -5,6 +5,7 @@ module ForemanAnsible
       module HostsControllerExtensions
         extend ActiveSupport::Concern
         include ForemanTasks::Triggers
+        include ::ForemanAnsible::Concerns::JobInvocationHelper
 
         included do
           api :POST, '/hosts/:id/play_roles',
@@ -12,30 +13,16 @@ module ForemanAnsible
           param :id, String, :required => true
 
           def play_roles
-            @result = {
-              :host => @host, :foreman_tasks => async_task(
-                ::Actions::ForemanAnsible::PlayHostRoles, @host
-              )
-            }
-
-            render_message @result
+            composer = job_composer(:ansible_run_host, @host)
+            process_response composer.trigger!, composer.job_invocation
           end
 
           api :POST, '/hosts/play_roles', N_('Plays Ansible roles on hosts')
           param :id, Array, :required => true
 
           def multiple_play_roles
-            @result = []
-
-            @host.each do |item|
-              @result.append(
-                :host => item, :foreman_tasks => async_task(
-                  ::Actions::ForemanAnsible::PlayHostRoles, item
-                )
-              )
-            end
-
-            render_message @result
+            composer = job_composer(:ansible_run_host, @host)
+            process_response composer.trigger!, composer.job_invocation
           end
         end
 

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

@@ -4,14 +4,14 @@ module ForemanAnsible
     module HostgroupsControllerExtensions
       extend ActiveSupport::Concern
       include ForemanTasks::Triggers
+      include ::ForemanAnsible::Concerns::JobInvocationHelper
 
       def play_roles
         find_resource
-        task = async_task(
-          ::Actions::ForemanAnsible::PlayHostgroupRoles,
-          @hostgroup
-        )
-        redirect_to task
+        check_hostgroup
+        composer = job_composer(:ansible_run_host, @hostgroup.hosts)
+        composer.trigger
+        redirect_to job_invocation_path(composer.job_invocation)
       rescue Foreman::Exception => e
         error e.message
         redirect_to hostgroups_path
@@ -19,6 +19,13 @@ module ForemanAnsible
 
       private
 
+      def check_hostgroup
+        return unless @hostgroup.hosts.empty?
+        raise ::Foreman::Exception.new(
+          N_('Host group has no associated hosts')
+        )
+      end
+
       def action_permission
         case params[:action]
         when 'play_roles'

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

@@ -4,15 +4,29 @@ module ForemanAnsible
     module HostsControllerExtensions
       extend ActiveSupport::Concern
       include ForemanTasks::Triggers
+      include JobInvocationHelper
+
+      # Overrides to methods in the original hosts controller
+      module Overrides
+        def action_permission
+          case params[:action]
+          when 'multiple_play_roles', 'play_roles'
+            :view
+          else
+            super
+          end
+        end
+      end
 
       included do
-        alias_method_chain :action_permission, :ansible
+        prepend Overrides
       end
 
       def play_roles
         find_resource
-        task = async_task(::Actions::ForemanAnsible::PlayHostRoles, @host)
-        redirect_to task
+        composer = job_composer(:ansible_run_host, @host)
+        composer.trigger
+        redirect_to job_invocation_path(composer.job_invocation)
       rescue Foreman::Exception => e
         error e.message
         redirect_to host_path(@host)
@@ -20,23 +34,13 @@ module ForemanAnsible
 
       def multiple_play_roles
         find_multiple
-        task = async_task(::Actions::ForemanAnsible::PlayHostsRoles, @hosts)
-        redirect_to task
+        composer = job_composer(:ansible_run_host, @hosts)
+        composer.trigger
+        redirect_to job_invocation_path(composer.job_invocation)
       rescue Foreman::Exception => e
         error e.message
         redirect_to hosts_path
       end
-
-      private
-
-      def action_permission_with_ansible
-        case params[:action]
-        when 'multiple_play_roles', 'play_roles'
-          :view
-        else
-          action_permission_without_ansible
-        end
-      end
     end
   end
 end

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

@@ -0,0 +1,17 @@
+module ForemanAnsible
+  module Concerns
+    # Helpers to compose the JobInvocation in other controllers
+    module JobInvocationHelper
+      extend ActiveSupport::Concern
+
+      def job_composer(feature_name, target)
+        composer = ::JobInvocationComposer.for_feature(feature_name, target)
+        return composer if composer.save
+        raise ::Foreman::Exception.new(
+          format(N_('Could not run Ansible roles for %{host}'),
+                 :host => target)
+        )
+      end
+    end
+  end
+end

data/app/helpers/foreman_ansible/ansible_plugin_helper.rb

@@ -1,12 +1,8 @@
-require "#{ForemanAnsible::Engine.root}/lib/foreman_ansible/version"
-
 module ForemanAnsible
   # General helper for foreman_ansible
   module AnsiblePluginHelper
     def ansible_doc_url
-      major_version = ::ForemanAnsible::VERSION.split('.')[0]
-      'https://theforeman.org/plugins/foreman_ansible/'\
-        "#{major_version}.x/index.html"
+      'http://theforeman.org/plugins/foreman_ansible/1.x/index.html'
     end
   end
 end

data/app/helpers/foreman_ansible/ansible_reports_helper.rb

@@ -22,7 +22,8 @@ module ForemanAnsible
 
     def ansible_report?(log)
       module_name(log).present?
-    rescue # Failures when parsing the log indicates it's not an Ansible report
+      # Failures when parsing the log indicates it's not an Ansible report
+    rescue StandardError
       false
     end
   end

data/app/helpers/foreman_ansible/hosts_helper_extensions.rb

@@ -3,9 +3,26 @@ module ForemanAnsible
   module HostsHelperExtensions
     extend ActiveSupport::Concern
 
+    module Overrides
+      def host_title_actions(*args)
+        host = args.first
+        if ansible_roles_present?(host)
+          button = ansible_roles_button(host)
+          title_actions(button_group(button))
+        end
+        super(*args)
+      end
+
+      def multiple_actions
+        super +
+          [[_('Play Ansible roles'),
+            multiple_play_roles_hosts_path,
+            false]]
+      end
+    end
+
     included do
-      alias_method_chain(:host_title_actions, :run_ansible_roles)
-      alias_method_chain(:multiple_actions, :run_ansible_roles)
+      prepend Overrides
     end
 
     def ansible_roles_present?(host)
@@ -22,21 +39,5 @@ module ForemanAnsible
         :'data-no-turbolink' => true
       )
     end
-
-    def host_title_actions_with_run_ansible_roles(*args)
-      host = args.first
-      if ansible_roles_present?(host)
-        button = ansible_roles_button(host)
-        title_actions(button_group(button))
-      end
-      host_title_actions_without_run_ansible_roles(*args)
-    end
-
-    def multiple_actions_with_run_ansible_roles
-      multiple_actions_without_run_ansible_roles +
-        [[_('Play Ansible roles'),
-          multiple_play_roles_hosts_path,
-          false]]
-    end
   end
 end

data/app/lib/actions/foreman_ansible/helpers/host_common.rb

@@ -20,15 +20,11 @@ module Actions
           continuous_output.humanize
         end
 
-        def continuous_output_providers
-          super << self
-        end
-
         def fill_continuous_output(continuous_output)
           delegated_output.fetch('result', []).each do |raw_output|
             continuous_output.add_raw_output(raw_output)
           end
-        rescue => e
+        rescue StandardError => e
           continuous_output.add_exception(_('Error loading data from proxy'), e)
         end
 

data/app/models/ansible_role.rb

@@ -12,4 +12,9 @@ class AnsibleRole < ApplicationRecord
 
   scoped_search :on => :name, :complete_value => true
   scoped_search :on => :updated_at
+
+  # Methods to be allowed in any template with safemode enabled
+  class Jail < Safemode::Jail
+    allow :name
+  end
 end

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

@@ -6,9 +6,7 @@ module ForemanAnsible
 
     included do
       def all_ansible_roles
-        result = (ansible_roles + inherited_ansible_roles).uniq
-        result += host_ansible_roles if is_a? Hostgroup
-        result
+        (ansible_roles + inherited_ansible_roles).uniq
       end
     end
   end

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

@@ -33,3 +33,12 @@ module ForemanAnsible
     end
   end
 end
+
+module Host
+  class Managed
+    # 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
+end

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

@@ -14,10 +14,6 @@ module ForemanAnsible
           roles + hostgroup.ansible_roles
         end.uniq
       end
-
-      def host_ansible_roles
-        hosts.all.includes(:ansible_roles).flat_map(&:ansible_roles)
-      end
     end
   end
 end

data/app/models/foreman_ansible/ansible_provider.rb

@@ -0,0 +1,24 @@
+if defined? ForemanRemoteExecution
+  module ForemanAnsible
+    # Provider for RemoteExecution that allows to run Ansible playbooks.
+    # Read the source of other RemoteExecution providers for more.
+    class AnsibleProvider < RemoteExecutionProvider
+      class << self
+        def humanized_name
+          'Ansible'
+        end
+
+        def host_setting(host, setting)
+          host.params[setting.to_s] || Setting[setting]
+        end
+
+        def proxy_command_options(template_invocation, host)
+          super(template_invocation, host).merge(
+            'ansible_inventory' =>
+              ::ForemanAnsible::InventoryCreator.new([host]).to_hash.to_json
+          )
+        end
+      end
+    end
+  end
+end

data/app/models/setting/ansible.rb

@@ -10,7 +10,6 @@ class Setting
       # rubocop:disable BlockLength
       def load_defaults
         return unless super
-        Setting::BLANK_ATTRS.push('ansible_ssh_private_key_file')
         transaction do
           [
             set(
@@ -86,6 +85,7 @@ class Setting
                   '3' => N_('Level 3 (-vvv)'),
                   '4' => N_('Level 4 (-vvvv)') }
               end
+              # rubocop:enable BlockLength
             ),
             set(
               'ansible_post_provision_timeout',
@@ -100,8 +100,11 @@ class Setting
             create(s.update(:category => 'Setting::Ansible'))
           end
         end
+        Setting::BLANK_ATTRS.push('ansible_ssh_private_key_file')
         true
       end
+      # rubocop:enable AbcSize
+      # rubocop:enable MethodLength
 
       def humanized_category
         N_('Ansible')

data/app/services/foreman_ansible/fact_parser.rb

@@ -14,7 +14,8 @@ module ForemanAnsible
         Operatingsystem.create!(args.merge(:description => os_description))
     end
 
-    def environment; end # Don't do anything as there's no env in Ansible
+    # Don't do anything as there's no env in Ansible
+    def environment; end
 
     def architecture
       name = facts[:ansible_architecture] || facts[:facter_architecture]
@@ -43,7 +44,7 @@ module ForemanAnsible
     #
     # This method overrides app/services/fact_parser.rb on Foreman and returns
     # an array of interface names, ['eth0', 'wlan1', etc...]
-    def get_interfaces # rubocop:disable Style/AccessorMethodName
+    def get_interfaces # rubocop:disable Naming/AccessorMethodName
       pref = facts[:ansible_default_ipv4] &&
              facts[:ansible_default_ipv4]['interface']
       if pref.present?
@@ -103,6 +104,7 @@ module ForemanAnsible
           (facts[:version].split('R')[0] if os_name == 'junos')
       end
     end
+    # rubocop:enable AbcSize, CyclomaticComplexity, PerceivedComplexity
 
     def os_release
       facts[:ansible_distribution_version] ||