smart_proxy_ansible 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 420694bc9e01ed41e40bfccadba84b8457956c26
-  data.tar.gz: fef11955d696cb2419a2946399d461bbe1a37d5c
+SHA256:
+  metadata.gz: 23fef38e05c69af60a7c0d04af33bd49412e60507e869836ff2febcba0bfbad9
+  data.tar.gz: b42a49e027b08e77ebf55098b59f8a627ece791c8200d9e3c63eb68f6597002f
 SHA512:
-  metadata.gz: 0b9063f73310b470484dfb5d7bcafd9cbc29ede72df76ab3ba8de46e680622ead09f5209d2d5d735e3b2f81e859a779e317b5bb4159d9e7a2ec09d0a805ab2e1
-  data.tar.gz: 332a065c6ae3a3f150a50f281ea1a5e15a9d693351933690974583dd58159fddc4acd007bcd1fc80345cf3f28278aa9e8e54bcd5a42bc92ff43c694e338769b8
+  metadata.gz: b30a91e5065922bb76c0f71e5b3be3762738442848bcbaad9f49ff1cd8ec4cb957fe23db7f6606d98be55019ef909c9a2ab87cca1efc611d6582252356894e20
+  data.tar.gz: f6be9a1240b73ac6dc9872fb32a4ffbe24769a54d57d566e4697ab4d81bf6060c34544972d9699de482e67c68aa5d15de1ec8296b3400bdfee929fda8b39d065

data/lib/foreman_ansible_core.rb

@@ -0,0 +1,37 @@
+begin
+  require 'foreman_tasks_core'
+  require 'foreman_remote_execution_core'
+rescue LoadError
+  # These gems are not available in a proxy SCLed context
+  puts 'Running Foreman Ansible Core in non-SCL context'
+end
+
+# Core actions for Foreman Ansible, used by both Foreman and Foreman proxy
+# This comprises running playbooks for the moment
+module ForemanAnsibleCore
+  require 'foreman_ansible_core/exception'
+  require 'foreman_ansible_core/roles_reader'
+  require 'foreman_ansible_core/version'
+
+  if defined? ForemanTasksCore
+    extend ForemanTasksCore::SettingsLoader
+    register_settings(:ansible, :ansible_dir => '/etc/ansible',
+                                :working_dir => nil)
+
+    if ForemanTasksCore.dynflow_present?
+      require 'foreman_tasks_core/runner'
+      require 'foreman_ansible_core/playbook_runner'
+      require 'foreman_ansible_core/actions'
+    end
+  end
+
+  if defined? ForemanTasksCore
+    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
+end

data/lib/foreman_ansible_core/actions.rb

@@ -0,0 +1,17 @@
+require 'foreman_tasks_core/shareable_action'
+
+module ForemanAnsibleCore
+  module Actions
+    # Action that can be run both on Foreman or Foreman proxy side
+    # to execute the playbook run
+    class RunPlaybook < ForemanTasksCore::Runner::Action
+      def initiate_runner
+        ForemanAnsibleCore::PlaybookRunner.new(
+          input[:inventory],
+          input[:playbook],
+          input[:options]
+        )
+      end
+    end
+  end
+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

@@ -0,0 +1,35 @@
+module ForemanAnsibleCore
+  # Taken from Foreman core, this class creates an error code for any exception
+  class Exception < ::StandardError
+    def initialize(message, *params)
+      @message = message
+      @params = params
+    end
+
+    def self.calculate_error_code(classname, message)
+      return 'ERF00-0000' if classname.nil? || message.nil?
+      basename = classname.split(':').last
+      class_hash = Zlib.crc32(basename) % 100
+      msg_hash = Zlib.crc32(message) % 10_000
+      format 'ERF%02d-%04d', class_hash, msg_hash
+    end
+
+    def code
+      @code ||= Exception.calculate_error_code(self.class.name, @message)
+      @code
+    end
+
+    def message
+      # make sure it works without gettext too
+      translated_msg = @message % @params
+      "#{code} [#{self.class.name}]: #{translated_msg}"
+    end
+
+    def to_s
+      message
+    end
+  end
+
+  class ReadConfigFileException < ForemanAnsibleCore::Exception; end
+  class ReadRolesException < ForemanAnsibleCore::Exception; end
+end

data/lib/foreman_ansible_core/playbook_runner.rb

@@ -0,0 +1,98 @@
+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
+      @playbook  = playbook
+      @options   = options
+      initialize_dirs
+    end
+
+    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 kill
+      publish_data('== TASK ABORTED BY USER ==', 'stdout')
+      publish_exit_status(1)
+      ::Process.kill('SIGTERM', @command_pid)
+      close
+    end
+
+    def close
+      super
+      FileUtils.remove_entry(@working_dir) if @tmp_working_dir
+    end
+
+    private
+
+    def write_inventory
+      ensure_directory(File.dirname(inventory_file))
+      File.write(inventory_file, @inventory)
+    end
+
+    def write_playbook
+      ensure_directory(File.dirname(playbook_file))
+      File.write(playbook_file, @playbook)
+    end
+
+    def inventory_file
+      File.join(@working_dir, 'foreman-inventories', id)
+    end
+
+    def playbook_file
+      File.join(@working_dir, "foreman-playbook-#{id}.yml")
+    end
+
+    def events_dir
+      File.join(@working_dir, 'events', id.to_s)
+    end
+
+    def ensure_directory(path)
+      if File.exist?(path)
+        raise "#{path} expected to be a directory" unless File.directory?(path)
+      else
+        FileUtils.mkdir_p(path)
+      end
+      path
+    end
+
+    def initialize_dirs
+      settings = ForemanAnsibleCore.settings
+      initialize_working_dir(settings[:working_dir])
+      initialize_ansible_dir(settings[:ansible_dir])
+    end
+
+    def initialize_working_dir(working_dir)
+      if working_dir.nil?
+        @working_dir = Dir.mktmpdir
+        @tmp_working_dir = true
+      else
+        @working_dir = File.expand_path(working_dir)
+      end
+    end
+
+    def initialize_ansible_dir(ansible_dir)
+      raise "Ansible dir #{ansible_dir} does not exist" unless
+        !ansible_dir.nil? && File.exist?(ansible_dir)
+      @ansible_dir = ansible_dir
+    end
+  end
+end

data/lib/foreman_ansible_core/remote_execution_core/ansible_runner.rb

@@ -0,0 +1,42 @@
+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

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

@@ -0,0 +1,61 @@
+module ForemanAnsibleCore
+  # Implements the logic needed to read the roles and associated information
+  class RolesReader
+    class << self
+      DEFAULT_CONFIG_FILE = '/etc/ansible/ansible.cfg'.freeze
+      DEFAULT_ROLES_PATH = '/etc/ansible/roles'.freeze
+
+      def list_roles
+        roles_path.split(':').map { |path| read_roles(path) }.flatten
+      end
+
+      def roles_path(roles_line = roles_path_from_config)
+        # Default to /etc/ansible/roles if none found
+        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_ROLES_PATH unless roles_path_key == 'roles_path'
+        roles_line.first.split('=').last.strip
+      end
+
+      def logger
+        # Return a different logger depending on where ForemanAnsibleCore is
+        # running from
+        if defined?(::Foreman::Logging)
+          ::Foreman::Logging.logger('foreman_ansible')
+        else
+          ::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

@@ -0,0 +1,3 @@
+module ForemanAnsibleCore
+  VERSION = '2.0.2'.freeze
+end

data/lib/smart_proxy_ansible/api.rb

@@ -1,14 +1,16 @@
+require 'foreman_ansible_core'
+
 module Proxy
   module Ansible
     class Api < Sinatra::Base
       get '/roles' do
-        ForemanAnsibleCore::RolesReader.list_roles.to_json
+        ::ForemanAnsibleCore::RolesReader.list_roles.to_json
       end
 
       get '/roles/:role_name/variables' do |role_name|
         # not anything matching item, }}, {{, ansible_hostname or 'if'
         ansible_config = '/etc/ansible/ansible.cfg'
-        roles_path = ForemanAnsibleCore::RolesReader.roles_path(ansible_config)
+        roles_path = ::ForemanAnsibleCore::RolesReader.roles_path(ansible_config)
         role_files = Dir.glob("#{roles_path}/#{role_name}/**/*.yml")
         variables = role_files.map do |role_file|
           File.read(role_file).scan(/{{(.*?)}}/).select do |param|

data/lib/smart_proxy_ansible/version.rb

@@ -1,5 +1,5 @@
 module Proxy
   module Ansible
-    VERSION = '2.0.1'
+    VERSION = '2.0.2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smart_proxy_ansible
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Ivan Nečas
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-12 00:00:00.000000000 Z
+date: 2018-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,6 +136,15 @@ files:
 - LICENSE
 - README.md
 - bundler.plugins.d/smart_proxy_ansible.rb
+- 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
 - lib/smart_proxy_ansible.rb
 - lib/smart_proxy_ansible/api.rb
 - lib/smart_proxy_ansible/http_config.ru
@@ -162,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Smart-Proxy Ansible plugin