foreman_ansible_core 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f416c282ff17d92a2c756375ecd3332b6781a8c9
-  data.tar.gz: 07cb920eb62b34aa9d96683e81d0b7918262d77e
+  metadata.gz: 7fdc186ce16d241d9cd97689ce7e3b75171b3d21
+  data.tar.gz: 41d0830a8eba1bc7074c0e623d6188bfbf48485a
 SHA512:
-  metadata.gz: 014b581ee8de8afcb3842f501ab72a950374cd536dc83f419c1d4c119d9a11156d84021136354b150e0df8e7b2b44cdbb6d3bf8024819c67a08ef0810688ab55
-  data.tar.gz: 88f4a747f66b93186c7a73ee91fdd8923b93fb246efd1e304d4a0e8bafa0636eabc1150ab61a4068a3437f30559aaca7e1a114e6af973fbd201edb9cb87c84b2
+  metadata.gz: a7fe6f8c44ac273b5587097e967920a38724140926a4738d220f0b12926858378a4f3b282d3e924736f13e7bcd2076ac27bd009cc0be0fb78e80b306529dd390
+  data.tar.gz: e5c89340ddae000a582667216a453546b92c1c9ad3e1f7eba063dc8f655ead6986553f3a99535553a3eed7ae2a6501af8b1607fece85b7b5165e80a98ca02223

data/lib/foreman_ansible_core.rb

@@ -14,6 +14,16 @@ module ForemanAnsibleCore
     require 'foreman_ansible_core/actions'
   end
 
+  if defined? ForemanRemoteExecutionCore
+    require 'foreman_remote_execution_core/actions'
+    require 'foreman_ansible_core/remote_execution_core/ansible_runner'
+    require 'foreman_ansible_core/remote_execution_core/settings_override'
+    ForemanRemoteExecutionCore::Actions::RunScript.send(
+      :prepend,
+      ForemanAnsibleCore::RemoteExecutionCore::SettingsOverride
+    )
+  end
+
   require 'foreman_ansible_core/roles_reader'
   require 'foreman_ansible_core/version'
 end

data/lib/foreman_ansible_core/command_creator.rb

@@ -0,0 +1,44 @@
+module ForemanAnsibleCore
+  # Creates the actual command to be passed to foreman_tasks_core to run
+  class CommandCreator
+    attr_reader :command
+
+    def initialize(inventory_file, playbook_file, options = {})
+      @options = options
+      @command = [{ 'JSON_INVENTORY_FILE' => inventory_file }]
+      @command << 'ansible-playbook'
+      @command = command_options(@command)
+      @command << playbook_file
+    end
+
+    private
+
+    def command_options(command)
+      command.concat(['-i', json_inventory_script])
+      command.concat([setup_verbosity]) if verbose?
+      command.concat(['-T', @options[:timeout]]) unless @options[:timeout].nil?
+      command
+    end
+
+    def json_inventory_script
+      File.expand_path('../../bin/json_inventory.sh', File.dirname(__FILE__))
+    end
+
+    def setup_verbosity
+      verbosity_level = @options[:verbosity_level].to_i
+      verbosity = '-'
+      verbosity_level.times do
+        verbosity += 'v'
+      end
+      verbosity
+    end
+
+    def verbose?
+      verbosity_level = @options[:verbosity_level]
+      # rubocop:disable Rails/Present
+      !verbosity_level.nil? && !verbosity_level.empty? &&
+        verbosity_level.to_i > 0
+      # rubocop:enable Rails/Present
+    end
+  end
+end

data/lib/foreman_ansible_core/exception.rb

@@ -30,6 +30,6 @@ module ForemanAnsibleCore
     end
   end
 
-  class ReadConfigFileException < ForemanAnsibleCore::Exception
-  end
+  class ReadConfigFileException < ForemanAnsibleCore::Exception; end
+  class ReadRolesException < ForemanAnsibleCore::Exception; end
 end

data/lib/foreman_ansible_core/playbook_runner.rb

@@ -1,10 +1,13 @@
 require 'foreman_tasks_core/runner/command_runner'
+require_relative 'command_creator'
 require 'tmpdir'
 
 module ForemanAnsibleCore
   # Implements ForemanTasksCore::Runner::Base interface for running
   # Ansible playbooks, used by the Foreman Ansible plugin and Ansible proxy
   class PlaybookRunner < ForemanTasksCore::Runner::CommandRunner
+    attr_reader :command_out, :command_in, :command_pid
+
     def initialize(inventory, playbook, options = {})
       super
       @inventory = inventory
@@ -16,25 +19,16 @@ module ForemanAnsibleCore
     def start
       write_inventory
       write_playbook
+      command = CommandCreator.new(inventory_file,
+                                   playbook_file,
+                                   @options).command
       logger.debug('[foreman_ansible] - Initializing Ansible Runner')
       Dir.chdir(@ansible_dir) do
         initialize_command(*command)
+        logger.debug("[foreman_ansible] - Running command #{command}")
       end
     end
 
-    def command
-      command = [{ 'JSON_INVENTORY_FILE' => inventory_file }]
-      command << 'ansible-playbook'
-      command.concat(['-i', json_inventory_script])
-      if verbose?
-        command.concat([setup_verbosity])
-      end
-      command.concat(['-T', @options[:timeout]]) unless @options[:timeout].nil?
-      command << playbook_file
-      logger.debug("[foreman_ansible] - Running command #{command}")
-      command
-    end
-
     def kill
       publish_data('== TASK ABORTED BY USER ==', 'stdout')
       publish_exit_status(1)
@@ -47,10 +41,6 @@ module ForemanAnsibleCore
       FileUtils.remove_entry(@working_dir) if @tmp_working_dir
     end
 
-    def json_inventory_script
-      File.expand_path('../../bin/json_inventory.sh', File.dirname(__FILE__))
-    end
-
     private
 
     def write_inventory
@@ -100,29 +90,9 @@ module ForemanAnsibleCore
     end
 
     def initialize_ansible_dir(ansible_dir)
-      if !ansible_dir.nil? && File.exist?(ansible_dir)
-        @ansible_dir = ansible_dir
-      else
-        raise "Ansible dir #{ansible_dir} does not exist"
-      end
-    end
-
-    def setup_verbosity
-      verbosity_level = @options[:verbosity_level].to_i
-      logger.debug('[foreman_ansible] - Setting Ansible verbosity level to'\
-                   "#{verbosity_level}")
-      verbosity = '-'
-      verbosity_level.times do
-        verbosity += 'v'
-      end
-      verbosity
+      raise "Ansible dir #{ansible_dir} does not exist" unless
+        !ansible_dir.nil? && File.exist?(ansible_dir)
+      @ansible_dir = ansible_dir
     end
-
-    def verbose?
-      verbosity_level = @options[:verbosity_level]
-      !verbosity_level.nil? && !verbosity_level.empty? &&
-        verbosity_level.to_i > 0
-    end
-
   end
 end

data/lib/foreman_ansible_core/remote_execution_core/ansible_runner.rb

@@ -0,0 +1,44 @@
+if defined? ::ForemanRemoteExecutionCore
+  module ForemanAnsibleCore
+    module RemoteExecutionCore
+      # Takes an inventory and runs it through REXCore CommandRunner
+      class AnsibleRunner < ::ForemanTasksCore::Runner::CommandRunner
+        DEFAULT_REFRESH_INTERVAL = 1
+
+        def initialize(options)
+          super(options)
+          @playbook_runner = ForemanAnsibleCore::PlaybookRunner.new(
+            options['ansible_inventory'],
+            options['script'],
+            options
+          )
+        end
+
+        def start
+          @playbook_runner.start
+        rescue StandardError => e
+          logger.error(
+            'error while initalizing command'\
+            " #{e.class} #{e.message}:\n #{e.backtrace.join("\n")}"
+          )
+          publish_exception('Error initializing command', e)
+        end
+
+        def fill_continuous_output(continuous_output)
+          delegated_output.fetch('result', []).each do |raw_output|
+            continuous_output.add_raw_output(raw_output)
+          end
+        rescue StandardError => e
+          continuous_output.add_exception(_('Error loading data from proxy'), e)
+        end
+
+        def refresh
+          @command_out = @playbook_runner.command_out
+          @command_in = @playbook_runner.command_in
+          @command_pid = @playbook_runner.command_pid
+          super
+        end
+      end
+    end
+  end
+end

data/lib/foreman_ansible_core/remote_execution_core/settings_override.rb

@@ -0,0 +1,18 @@
+module ForemanAnsibleCore
+  module RemoteExecutionCore
+    # Ensure the Ansible provider is used whenever a JobTemplate using this
+    # provider is called.
+    module SettingsOverride
+      def initiate_runner
+        return super unless input['ansible_inventory']
+        additional_options = {
+          :step_id => run_step_id,
+          :uuid => execution_plan_id
+        }
+        ::ForemanAnsibleCore::RemoteExecutionCore::AnsibleRunner.new(
+          input.merge(additional_options)
+        )
+      end
+    end
+  end
+end

data/lib/foreman_ansible_core/roles_reader.rb

@@ -3,31 +3,18 @@ module ForemanAnsibleCore
   class RolesReader
     class << self
       DEFAULT_CONFIG_FILE = '/etc/ansible/ansible.cfg'.freeze
+      DEFAULT_ROLES_PATH = '/etc/ansible/roles'.freeze
 
       def list_roles
-        logger.info('[foreman_ansible] - Reading roles from '\
-                    '/etc/ansible/ansible.cfg roles_path')
-        Dir.glob("#{roles_path}/*").map do |path|
-          path.split('/').last
-        end
-      rescue Errno::ENOENT, Errno::EACCES => e
-        logger.debug("[foreman_ansible] - #{e.backtrace}")
-        exception_message = '[foreman_ansible] - Could not read Ansible config'\
-          " file #{DEFAULT_CONFIG_FILE} - #{e.message}"
-        raise ReadConfigFileException.new(exception_message)
+        roles_path.split(':').map { |path| read_roles(path) }.flatten
       end
 
-      def roles_path(ansible_config_file = DEFAULT_CONFIG_FILE)
-        default_path = '/etc/ansible/roles'
-        roles_line = File.readlines(ansible_config_file).select do |line|
-          line =~ /roles_path/
-        end
+      def roles_path(roles_line = roles_path_from_config)
         # Default to /etc/ansible/roles if none found
-        return default_path if roles_line.empty?
+        return DEFAULT_ROLES_PATH if roles_line.empty?
         roles_path_key = roles_line.first.split('=').first.strip
         # In case of commented roles_path key "#roles_path", return default
-        return default_path unless roles_path_key == 'roles_path'
-        # In case roles_path is there, and is not commented, return the value
+        return DEFAULT_ROLES_PATH unless roles_path_key == 'roles_path'
         roles_line.first.split('=').last.strip
       end
 
@@ -40,6 +27,35 @@ module ForemanAnsibleCore
           ::Proxy::LogBuffer::Decorator.instance
         end
       end
+
+      private
+
+      def read_roles(roles_path)
+        rescue_and_raise_file_exception ReadRolesException,
+                                        roles_path, 'roles' do
+          Dir.glob("#{roles_path}/*").map do |path|
+            path.split('/').last
+          end
+        end
+      end
+
+      def roles_path_from_config
+        rescue_and_raise_file_exception ReadConfigFileException,
+                                        DEFAULT_CONFIG_FILE, 'config file' do
+          File.readlines(DEFAULT_CONFIG_FILE).select do |line|
+            line =~ /roles_path/
+          end
+        end
+      end
+
+      def rescue_and_raise_file_exception(exception, path, type)
+        yield
+      rescue Errno::ENOENT, Errno::EACCES => e
+        logger.debug(e.backtrace)
+        exception_message = "Could not read Ansible #{type} "\
+                            "#{path} - #{e.message}"
+        raise exception.new(exception_message)
+      end
     end
   end
 end

data/lib/foreman_ansible_core/version.rb

@@ -1,3 +1,3 @@
 module ForemanAnsibleCore
-  VERSION = '1.1.1'.freeze
+  VERSION = '2.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_ansible_core
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Daniel Lobato Garcia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-30 00:00:00.000000000 Z
+date: 2018-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.42'
+        version: '0.52'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.42'
+        version: '0.52'
 - !ruby/object:Gem::Dependency
   name: foreman-tasks-core
   requirement: !ruby/object:Gem::Requirement
@@ -38,9 +38,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
-description: |
-  Ansible integration with Foreman - core parts for dealing with Ansible concepts,
-  usable by foreman_ansible or smart_proxy_ansible to delegate the execution.
+description: |2
+      Ansible integration with Foreman - core parts for dealing with Ansible concepts,
+      usable by foreman_ansible or smart_proxy_ansible to delegate the execution.
 email:
 - elobatocs@gmail.com
 executables: []
@@ -51,8 +51,11 @@ files:
 - bin/json_inventory.sh
 - lib/foreman_ansible_core.rb
 - lib/foreman_ansible_core/actions.rb
+- lib/foreman_ansible_core/command_creator.rb
 - lib/foreman_ansible_core/exception.rb
 - lib/foreman_ansible_core/playbook_runner.rb
+- lib/foreman_ansible_core/remote_execution_core/ansible_runner.rb
+- lib/foreman_ansible_core/remote_execution_core/settings_override.rb
 - lib/foreman_ansible_core/roles_reader.rb
 - lib/foreman_ansible_core/version.rb
 homepage: https://github.com/theforeman/foreman_ansible
@@ -75,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: 'Ansible integration with Foreman (theforeman.org): core bits'