smart_proxy_acd 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee781c1809e07078b77575c2a7276462859ca133fcb7206e0cf75d611f1151d4
-  data.tar.gz: 937f4a477377b425127f44fb7690e2c59479a6f8c8a66b412e986f5a5980cba6
+  metadata.gz: 881bee215ecdb92ddd19b7b60397274f9e5eb72911660a289d235b5ab09aa8bc
+  data.tar.gz: 25abeb5af5ca858c7a18fbce66b4727a8bfe7d8b120089a7ecfd370792a75931
 SHA512:
-  metadata.gz: fd2c0a61f8a4dfc53124deb0f17303ae9250babc12671b60ff96645547f5b0b0ecd4b173e4f0fb18cf6248c776e96d27b52386a30f1760129f1affb2db70fe6d
-  data.tar.gz: dee25ae9c01bbe7de4577790f3772ad613fba257e7a8b7c32ccca9da2a65d9de82071195fa560282cb21a6de91fa562b32fc0e47ef1ee7d9d9f6effaabebd763
+  metadata.gz: 05a4fa40b1df875b7526b584b2ac5a2a544abd3d2248aa04dc31bc8b4592f094163929e6790d3abd826f5d7c9d0401a2add3476b5dc813aae027e5cd0354ffa1
+  data.tar.gz: ae1ad0260d9c7c95c3ae78be4bcc05e68a679ff6c3d453311598dcf2c51c4428c8e03056b2293ae4fcc85480566da7e48a5576e8473783f5816668b388d05f0c

data/lib/smart_proxy_acd/acd.rb

@@ -5,8 +5,17 @@ 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
+
+      load_dependency_injection_wirings do |_container_instance, _settings|
+        Proxy::Dynflow::TaskLauncherRegistry.register('acd', AcdTaskLauncher)
+      end
     end
   end
 end

data/lib/smart_proxy_acd/acd_runner.rb

@@ -0,0 +1,190 @@
+require 'smart_proxy_dynflow/runner/command_runner'
+require 'tempfile'
+require 'rest-client'
+require 'tmpdir'
+require 'socket'
+
+# 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
+
+      class << self
+        def parse_dynflow_settings(path)
+          return @dynflow_settings if defined? @dynflow_settings
+          if File.exist?(path)
+            @dynflow_settings = {}
+            YAML.load_file(path).each do |key, value|
+              @dynflow_settings[key.to_s] = value
+            end
+          end
+          @dynflow_settings
+        end
+
+        def parse_ssl_options
+          return @ssl_options if defined? @ssl_options
+
+          @ssl_options = {}
+          return @ssl_options unless URI.parse(@dynflow_settings['foreman_url']).scheme == 'https'
+
+          @ssl_options[:verify_ssl] = OpenSSL::SSL::VERIFY_PEER
+
+          private_key_file = @dynflow_settings['foreman_ssl_key'] || @dynflow_settings['ssl_private_key']
+          if private_key_file
+            private_key = File.read(private_key_file)
+            @ssl_options[:ssl_client_key] = OpenSSL::PKey::RSA.new(private_key)
+          end
+          certificate_file = @dynflow_settings['foreman_ssl_cert'] || @dynflow_settings['ssl_certificate']
+          if certificate_file
+            certificate = File.read(certificate_file)
+            @ssl_options[:ssl_client_cert] = OpenSSL::X509::Certificate.new(certificate)
+          end
+          ca_file = @dynflow_settings['foreman_ssl_ca'] || @dynflow_settings['ssl_ca_file']
+          @ssl_options[:ssl_ca_file] = ca_file if ca_file
+          @ssl_options
+        end
+      end
+
+      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).get
+        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)
+        @playbook_tmp_base64_file = tmp_file
+      end
+
+      def playbook_resource(playbook_id)
+        dynflow_settings = self.class.parse_dynflow_settings('/etc/foreman-proxy/settings.yml')
+        playbook_url = dynflow_settings['foreman_url'] + "/acd/api/v2/ansible_playbooks/#{playbook_id}/grab"
+        @resource ||= RestClient::Resource.new(playbook_url, self.class.parse_ssl_options)
+      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]
+
+        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,25 @@
+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.2.0'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_proxy_acd
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Markus Bucher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-31 00:00:00.000000000 Z
+date: 2021-11-16 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