smart_proxy_acd 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80a978c97059f5794f0edf5f62699f12e45a022b3332870159ca4a1c8114576a
-  data.tar.gz: 65b8540e1cdba88109ab89fda19b0f1dd2bc9efb6efa6e463b562b475814642a
+  metadata.gz: 183250a25f2479402b6eb73acd841ec985da00ebe17cb4b836df7b1e3d37ae48
+  data.tar.gz: d9b0c52df1fad8c9a998930252617eb971a8319a3f53fdd0e910b17bcef8b439
 SHA512:
-  metadata.gz: 9631b51f3a5b85eab8fa4312b2a887a7a5907ba5dc5ec52767c307e21502d386051448be42997dc8be24bcf6784ac010bf04d2f56c35d28eff8a96f8b1521e65
-  data.tar.gz: bb80129d8c7111f8e9f28002accbc96f48c3863b71439866d3466baa29f8f4ce0907c6af24972b6b16039a87e8cf29e5d1af950f97dadc544395c0a0ec380f2e
+  metadata.gz: 88664606e79721dc883ee637bf749f54d6bfd3481ba42366abb4c0725a727fad4ec94d1029b25f0142b889b6bcdbde07f6e1142f419a939e8b3d4ae9ccddc5fa
+  data.tar.gz: 23cc133598f5d3888e0298bf5b2c3786d6a429ff6ba3625d673efdc0f61f338e64d749811c8dcbab8ff0cce544d7ec5672c813dbb38492cf2293f16d59c30f33

data/README.md

@@ -14,7 +14,6 @@ This plug-in adds support for [Application Centric Deployment](https://github.co
 
 We expect your proxy to also have
 [smart_proxy_dynflow](https://github.com/theforeman/smart_proxy_dynflow)
-and [foreman-tasks-core](https://github.com/theforeman/foreman-tasks) as
 a gem requirement.
 
 ### Get the code

data/lib/smart_proxy_acd/acd.rb

@@ -5,8 +5,19 @@ module Proxy
     # Implement a SmartProxy Plugin
     class Plugin < ::Proxy::Plugin
       plugin 'acd', Proxy::Acd::VERSION
-      http_rackup_path File.expand_path('acd_http_config.ru', File.expand_path('../', __FILE__))
-      https_rackup_path File.expand_path('acd_http_config.ru', File.expand_path('../', __FILE__))
+      rackup_path File.expand_path('acd_http_config.ru', __dir__)
+
+      load_classes do
+        require 'smart_proxy_dynflow'
+        require 'smart_proxy_acd/acd_runner'
+        require 'smart_proxy_acd/acd_task_launcher'
+      end
+
+      default_settings :timeout => 60
+
+      load_dependency_injection_wirings do |_container_instance, _settings|
+        Proxy::Dynflow::TaskLauncherRegistry.register('acd', AcdTaskLauncher)
+      end
     end
   end
 end

data/lib/smart_proxy_acd/acd_main.rb

@@ -5,6 +5,17 @@ module Proxy
     extend ::Proxy::Log
 
     class << self
+      def plugin_settings
+        # rubocop:disable ClassVars
+        @@settings ||= OpenStruct.new(read_settings)
+        # rubocop:enable ClassVars
+      end
+
+      def read_settings
+        ::Proxy::Acd::Plugin.default_settings.merge(
+          YAML.load_file(File.join(::Proxy::SETTINGS.settings_directory, ::Proxy::Acd::Plugin.settings_file))
+        )
+      end
     end
   end
 end

data/lib/smart_proxy_acd/acd_runner.rb

@@ -0,0 +1,164 @@
+require 'smart_proxy_dynflow/runner/base'
+require 'smart_proxy_dynflow/runner/command_runner'
+require 'tempfile'
+require 'rest-client'
+require 'tmpdir'
+require 'socket'
+require 'proxy/request'
+
+# rubocop:disable ClassLength
+
+module Proxy
+  module Acd
+    # Implements the AcdRunner to be used by foreman_remote_execution
+    class AcdRunner < Proxy::Dynflow::Runner::CommandRunner
+      DEFAULT_REFRESH_INTERVAL = 1
+
+      def initialize(options, suspended_action:)
+        super(options, :suspended_action => suspended_action)
+        @options = options
+      end
+
+      def get_playbook(playbook_id)
+        logger.debug("Get playbook with id #{playbook_id}")
+        response = playbook_resource(playbook_id)
+        if response.code.to_s != '200'
+          raise "Failed performing callback to Foreman server: #{response.code} #{response.body}"
+        end
+        tmp_file = Tempfile.new.path
+        File.write(tmp_file, response.body)
+        @playbook_tmp_base64_file = tmp_file
+      end
+
+      def playbook_resource(playbook_id)
+        playbook_download_path = "/acd/api/v2/ansible_playbooks/#{playbook_id}/grab"
+        foreman_request = Proxy::HttpRequest::ForemanRequest.new
+        req = foreman_request.request_factory.create_get(playbook_download_path)
+        foreman_request.http.read_timeout = Proxy::Acd::Plugin.settings.timeout
+        foreman_request.send_request(req)
+      end
+
+      def store_playbook
+        logger.debug('Unpack ansible playbook')
+        dir = Dir.mktmpdir
+        raise 'Could not create temporary directory to run ansible playbook' if dir.nil? || !Dir.exist?(dir)
+        command = "base64 -d #{@playbook_tmp_base64_file} | tar xz -C #{dir}"
+        system(command)
+        @playbook_tmp_dir = dir
+      end
+
+      def cleanup
+        File.unlink(@playbook_tmp_base64_file) if File.exist?(@playbook_tmp_base64_file)
+        FileUtils.rm_rf(@playbook_tmp_dir) if Dir.exist?(@playbook_tmp_dir)
+      end
+
+      def start
+        parse_acd_job
+
+        publish_data("Grab playbook to configure application #{@application_name}...", 'stdout')
+        get_playbook(@playbook_id)
+        store_playbook
+
+        @playbook_path = File.join(@playbook_tmp_dir, @playbook_file)
+        raise "Could not run playbook: playbook file #{@playbook_file} not found in playbook dir #{@playbook_tmp_dir}" unless File.exist?(@playbook_path)
+
+        publish_data('Write temporary inventory', 'stdout')
+        write_inventory
+
+        command = generate_command
+        logger.debug("Running command #{command.join(' ')}")
+        initialize_command(*command)
+      end
+
+      def close
+        logger.debug("Cleanup ansible playbook #{@playbook_tmp_dir} and #{@playbook_tmp_base64_file}")
+        cleanup
+      end
+
+      def kill
+        publish_data('== TASK ABORTED BY USER ==', 'stdout')
+        publish_exit_status(1)
+        ::Process.kill('SIGTERM', @command_pid)
+      end
+
+      private
+
+      def parse_acd_job
+        @acd_job = YAML.safe_load(@options['script'])
+        @application_name = @acd_job['application_name']
+        @playbook_id = @acd_job['playbook_id']
+        @playbook_file = @acd_job['playbook_file']
+
+        raise "'playbook_file' need to be specified" if @playbook_file.nil? || @playbook_file.empty?
+        raise "'playbook_id' need to be specified" if @playbook_id.nil?
+      end
+
+      def proxy_hostname
+        Socket.gethostbyname(Socket.gethostname).first
+      end
+
+      def write_inventory
+        complete_inventory = YAML.safe_load(@acd_job['inventory'])
+        my_inventory = complete_inventory[proxy_hostname]
+
+        my_inventory['all']['children'].each_value do |group|
+          group['hosts'].each_value do |host_vars|
+            host_vars['ansible_ssh_private_key_file'] ||= Proxy::RemoteExecution::Ssh::Plugin.settings[:ssh_identity_key_file]
+          end
+        end
+
+        tmp_inventory_file = Tempfile.new('acd_inventory')
+        tmp_inventory_file << my_inventory.to_yaml
+        tmp_inventory_file << "\n"
+        tmp_inventory_file.close
+        @inventory_path = tmp_inventory_file.path
+      end
+
+      def environment
+        env = {}
+        env['ANSIBLE_CALLBACK_WHITELIST'] = ''
+        env['ANSIBLE_LOAD_CALLBACK_PLUGINS'] = '0'
+        env
+      end
+
+      def setup_verbosity
+        verbosity = ''
+        if @acd_job['verbose']
+          verbosity_level = @acd_job['verbose'].split(' ').first.to_i
+          if verbosity_level.positive?
+            verbosity = '-'
+            verbosity_level.times do
+              verbosity += 'v'
+            end
+          end
+        end
+        verbosity
+      end
+
+      def valid_tags(tag)
+        re = /^\w+(\s*,\s*\w+)*$/
+        return true if @acd_job[tag] && @acd_job[tag].match?(re)
+      end
+
+      def generate_command
+        logger.debug("Generate command with #{@inventory_path} to run #{@playbook_id} with path #{@playbook_path}")
+        command = [environment]
+        command << 'ansible-playbook'
+        command << '-i'
+        command << @inventory_path
+        verbose = setup_verbosity
+        command << verbose unless verbose.empty?
+        command << "--tags '#{@acd_job['tags']}'" if valid_tags('tags')
+        command << "--skip-tags '#{@acd_job['skip_tags']}'" if valid_tags('skip_tags')
+        if @acd_job.key?('extra_vars') && !@acd_job['extra_vars'].nil? && !@acd_job['extra_vars'].empty?
+          command << '--extra-vars'
+          command << "'#{@acd_job['extra_vars']}'"
+        end
+        command << @playbook_path.to_s
+        command
+      end
+    end
+  end
+end
+
+# rubocop:enable ClassLength

data/lib/smart_proxy_acd/acd_task_launcher.rb

@@ -0,0 +1,27 @@
+require 'smart_proxy_dynflow/task_launcher'
+
+module Proxy
+  module Acd
+    # Implements the TaskLauncher::Batch for Acd
+    class AcdTaskLauncher < Proxy::Dynflow::TaskLauncher::Batch
+      # Implements the Runner::Action for Acd
+      class AcdRunnerAction < Proxy::Dynflow::Action::Runner
+        def initiate_runner
+          additional_options = {
+            :step_id => run_step_id,
+            :uuid => execution_plan_id
+          }
+          ::Proxy::Acd::AcdRunner.new(
+            input.merge(additional_options),
+            :suspended_action => suspended_action
+          )
+        end
+      end
+
+      def child_launcher(parent)
+        Proxy::Dynflow::TaskLauncher::Single.new(world, callback, :parent => parent,
+                                                                  :action_class_override => AcdRunnerAction)
+      end
+    end
+  end
+end

data/lib/smart_proxy_acd/version.rb

@@ -1,5 +1,5 @@
 module Proxy
   module Acd
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.4.0'.freeze
   end
 end

data/settings.d/acd.yml.example

@@ -1,2 +1,4 @@
 ---
 :enabled: true
+# The time we wait till the request to download the ansible playbook should be answered by the Foreman, in seconds.
+:timeout: 60

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_proxy_acd
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Markus Bucher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-09 00:00:00.000000000 Z
+date: 2022-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -24,6 +24,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.50.0
+- !ruby/object:Gem::Dependency
+  name: smart_proxy_dynflow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 description: Application Centric Deployment smart proxy plugin
 email: info@atix.de
 executables: []
@@ -40,6 +54,8 @@ files:
 - lib/smart_proxy_acd/acd_api.rb
 - lib/smart_proxy_acd/acd_http_config.ru
 - lib/smart_proxy_acd/acd_main.rb
+- lib/smart_proxy_acd/acd_runner.rb
+- lib/smart_proxy_acd/acd_task_launcher.rb
 - lib/smart_proxy_acd/version.rb
 - settings.d/acd.yml.example
 homepage: http://github.com/ATIX-AG/smart_proxy_acd