foreman_acd 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 809d34cc7063d66a26a1c0c913cd95287a6329cce55a75c1684046bb47b1afe1
-  data.tar.gz: d32aa387545b3fac503996354baae6704c30118a923d95706668895cad6440f5
+  metadata.gz: 7b616c7ba21eea339af8509f618585dcd949ddead6ecdec57278a62c751e4fd2
+  data.tar.gz: 75c7d2e2c07d306dee127bc50c6b300934f90066bc4a491e49f17f65ac6b7c24
 SHA512:
-  metadata.gz: 996b0c911e71e045b232b3d6b27776eaa9c7e6c52f23f78d29c911f899d4a60024990fa8866e2f401e2d91f1c2a0c06a7264f16ffc2e4bd0b97c0e794a0a7c63
-  data.tar.gz: 445dc99ec810e7fbbdf33d2c1e69b3a60942c58938212105033e472981bee85e626ce51d7e2f36359bbfb9148dca240fff134d183481d1d8312a3e9f933f4815
+  metadata.gz: bba62637508bbbd4e35772a55ad1126fea7a8cb3c1658c6f734b02ccf03d44048db40fa621bb51e796220668e7a49e8b03c3169a77b818f6dbbde117d09edfe2
+  data.tar.gz: a6e4ba1bb97250e8bcebe6180abcf4755859b73828febda64353b47021acadcc33fd99e2ab4b45ac965e5d643c368bbfb47aee421a80979c7a4c69354a18b297

data/app/controllers/foreman_acd/ansible_playbooks_controller.rb

@@ -7,6 +7,7 @@ module ForemanAcd
     include ::ForemanAcd::Concerns::AnsiblePlaybookParameters
 
     before_action :find_resource, :only => [:edit, :update, :destroy, :import_vars]
+    after_action :delete_synced_repo, :only => [:new, :edit, :create, :update, :destroy, :index]
 
     def index
       @ansible_playbooks = resource_base.search_for(params[:search], :order => params[:order]).paginate(:page => params[:page])
@@ -18,6 +19,11 @@ module ForemanAcd
 
     def create
       @ansible_playbook = AnsiblePlaybook.new(ansible_playbook_params)
+      if session[:git_path]
+        @ansible_playbook.update(:path => ansible_playbook_full_path(ansible_playbook_rename(@ansible_playbook[:name])))
+        FileUtils.mv(session[:git_path], @ansible_playbook[:path])
+        session[:git_path] = nil
+      end
       if @ansible_playbook.save
         process_success :success_msg => _("Successfully created %s. You need to press the \"Import groups\" button
                                            before this ansible playbook can be used in App Definitions!") % @ansible_playbook
@@ -29,6 +35,20 @@ module ForemanAcd
     def edit; end
 
     def update
+      # Move synced repo to new path if ansible_playbook name is changed
+      if !session[:git_path].nil? && ansible_playbook_params[:name] != @ansible_playbook[:name]
+        FileUtils.mv(@ansible_playbook[:path], ansible_playbook_full_path(ansible_playbook_rename(ansible_playbook_params[:name])))
+        @ansible_playbook.update(:path => ansible_playbook_full_path(ansible_playbook_rename(ansible_playbook_params[:name])))
+        session[:git_path] = nil
+
+      # Remove old version and copy new version of synced repository
+      elsif !session[:git_path].nil? && ansible_playbook_params[:name] == @ansible_playbook.name
+        remove_ansible_dir(@ansible_playbook[:path]) if @ansible_playbook.path
+        @ansible_playbook.update(:path => ansible_playbook_full_path(ansible_playbook_rename(@ansible_playbook[:name])))
+        FileUtils.mv(session[:git_path], @ansible_playbook[:path])
+        session[:git_path] = nil
+      end
+
       if @ansible_playbook.update(ansible_playbook_params)
         process_success
       else
@@ -44,10 +64,51 @@ module ForemanAcd
       end
     end
 
+    def sync_git_repo
+      @ansible_playbook = AnsiblePlaybook.new
+      sync_params = params[:ansible_playbook]
+      dir = Dir.mktmpdir
+
+      begin
+        git = Git.init(dir)
+
+        if ForemanAcd.proxy_setting.present?
+          git.config('http.proxy', ForemanAcd.proxy_setting)
+          logger.info("HTTP Proxy used: #{git.config['http.proxy']}")
+        end
+
+        git.add_remote('origin', sync_params[:git_url])
+        git.fetch
+        git.checkout(sync_params[:git_commit])
+
+        session[:git_path] = git.dir.path
+      rescue StandardError => e
+        logger.error("Failed to sync git repository: #{e}")
+        render :json => { :status => 'error', :message => e }, :status => :internal_server_error
+      end
+    end
+
+    # Remove abandoned synced git repositories
+    def delete_synced_repo
+      names = []
+      AnsiblePlaybook.all.each do |ansible_playbook|
+        names.push(ansible_playbook_rename(ansible_playbook.name))
+      end
+      names.push('.', '..')
+      return unless Dir.exist?(ForemanAcd.ansible_playbook_path)
+      Dir.foreach(ForemanAcd.ansible_playbook_path) do |dirname|
+        next if names.include? dirname
+        remove_ansible_dir(ansible_playbook_full_path(dirname))
+        logger.info("Successfully removed #{dirname}")
+      end
+    end
+
     def action_permission
       case params[:action]
       when 'import_vars'
         :import_vars
+      when 'sync_git_repo'
+        :sync_git_repo
       when 'grab'
         :grab
       else
@@ -120,5 +181,19 @@ module ForemanAcd
         process_error :error_msg => _(errors.join(' ')), :redirect => ansible_playbooks_path
       end
     end
+
+    private
+
+    def ansible_playbook_rename(name)
+      name.split(/\W+/).join('_')
+    end
+
+    def remove_ansible_dir(dirpath)
+      FileUtils.remove_dir(dirpath) if Dir.exist?(dirpath)
+    end
+
+    def ansible_playbook_full_path(dirname)
+      File.join(ForemanAcd.ansible_playbook_path, dirname)
+    end
   end
 end

data/app/controllers/foreman_acd/app_instances_controller.rb

@@ -72,10 +72,12 @@ module ForemanAcd
     end
 
     def deploy
+      value = false
       @app_instance.clean_all_hosts if params[:delete_hosts]
-
+      value = safe_deploy? if params[:safe_deploy]
+      session.delete(:remember_hosts)
       logger.info('Run async foreman task to deploy hosts')
-      async_task = ForemanTasks.async_task(::Actions::ForemanAcd::DeployAllHosts, @app_instance)
+      async_task = ForemanTasks.async_task(::Actions::ForemanAcd::DeployAllHosts, @app_instance, value)
       @app_instance.update!(:last_deploy_task => async_task)
       process_success(:success_msg => _('Started task to deploy hosts for %s') % @app_instance)
     rescue StandardError => e
@@ -84,6 +86,11 @@ module ForemanAcd
       process_error :error_msg => error_msg
     end
 
+    def safe_deploy?
+      return false if session[:remember_hosts].empty?
+      session[:remember_hosts]
+    end
+
     def report
       @report_hosts = collect_host_report_data
       logger.debug("app instance host details: #{@report_hosts.inspect}")
@@ -91,14 +98,24 @@ module ForemanAcd
 
     def app_instance_has_foreman_hosts
       hosts = JSON.parse(@app_instance.hosts)
+      session[:remember_hosts] = []
       hosts.each do |h|
         if @app_instance.foreman_hosts.where(:hostname => h['hostname']).exists?
+          old_host = @app_instance.foreman_hosts.find_by(:hostname => h['hostname'])
+
           @app_instance.foreman_hosts.where(:hostname => h['hostname']).
             update(:service => h['service'], :description => h['description'],
                    :foremanParameters => JSON.dump(h['foremanParameters']), :ansibleParameters => JSON.dump(h['ansibleParameters']))
+
+          updated_host = @app_instance.foreman_hosts.find_by(:hostname => h['hostname'])
+
+          # Store hosts if updated for safe deploy
+          session[:remember_hosts] << updated_host.id if updated_host.updated_at != old_host.updated_at
         else
           @app_instance.foreman_hosts.create(:hostname => h['hostname'], :service => h['service'], :description => h['description'],
                                              :foremanParameters => JSON.dump(h['foremanParameters']), :ansibleParameters => JSON.dump(h['ansibleParameters']))
+          # Store new hosts for safe deploy
+          session[:remember_hosts] << @app_instance.foreman_hosts.find_by(:hostname => h['hostname']).id
         end
       end
 

data/app/controllers/foreman_acd/concerns/ansible_playbook_parameters.rb

@@ -9,7 +9,7 @@ module ForemanAcd
       class_methods do
         def ansible_playbook_params_filter
           Foreman::ParameterFilter.new(::ForemanAcd::AnsiblePlaybook).tap do |filter|
-            filter.permit(:name, :description, :scm_type, :path, :playfile, :location_ids => [], :organization_ids => [])
+            filter.permit(:name, :description, :scm_type, :path, :git_commit, :git_url, :playfile, :location_ids => [], :organization_ids => [])
           end
         end
       end

data/app/controllers/foreman_acd/remote_execution_controller.rb

@@ -4,25 +4,40 @@ module ForemanAcd
   # Class to run remote execution jobs
   class RemoteExecutionController < JobInvocationsController
     def new
-      jobs = init_configuration
-      @composer = jobs.first
+      set_app_instance
+      result, job = init_configuration
+
+      if result.success == true
+        @composer = job
+      else
+        redirect_to(app_instances_path, :error => _("Coult not create remote execution job to configure the app '%{app_instance}': %{msg}") % {
+          :app_instance => @app_instance, :msg => result.error
+        })
+      end
     end
 
     def create
       customize_first = params[:customize] || false
-      jobs = init_configuration
-
-      if jobs.count == 1 && customize_first == false
-        @composer = jobs.first
-        @composer.trigger!
-        redirect_to job_invocation_path(@composer.job_invocation)
-      elsif customize_first == false
-        jobs.each(&:trigger)
-        redirect_to job_invocations_path
-      else
-        # redirect to the job itself if we want to customize the job
-        @composer = jobs.first
-        render :action => 'new'
+      begin
+        set_app_instance
+        result, job = init_configuration
+
+        unless result.success == true
+          return redirect_to(app_instances_path, :error => _("Coult not create remote execution job to configure the app '%{app_instance}': %{msg}") % {
+            :app_instance => @app_instance, :msg => result.error
+          })
+        end
+
+        @composer = job
+        if customize_first == false
+          @composer.trigger!
+          redirect_to job_invocation_path(@composer.job_invocation)
+        else
+          # redirect to the job itself if we want to customize the job
+          render :action => 'new'
+        end
+      rescue StandardError => e
+        redirect_to app_instances_path, :error => _("#{job}, #{e}")
       end
     end
 
@@ -34,13 +49,14 @@ module ForemanAcd
 
     private
 
-    def init_configuration
-      app_instance = ForemanAcd::AppInstance.find_by(:id => params[:id])
-      app_configurator = ForemanAcd::AppConfigurator.new(app_instance)
+    def set_app_instance
+      @app_instance = ForemanAcd::AppInstance.find_by(:id => params[:id])
+    end
 
-      jobs = app_configurator.configure
-      logger.debug("Creating #{jobs.count} job(s) to configure the app #{app_instance}. Customize first: #{params[:customize]}")
-      jobs
+    def init_configuration
+      logger.debug("Creating job to configure the app #{@app_instance}. Customize first: #{params[:customize]}")
+      app_configurator = ForemanAcd::AppConfigurator.new(@app_instance)
+      app_configurator.configure
     end
   end
 end

data/app/lib/actions/foreman_acd/deploy_all_hosts.rb

@@ -4,27 +4,32 @@ module Actions
   module ForemanAcd
     # DeployAllHosts implements a Foreman Task EntryAction
     class DeployAllHosts < Actions::EntryAction
-      def plan(app_instance)
-        action_subject(app_instance)
+      def plan(app_instance, safe_deploy)
+        action_subject(app_instance, :safe_deploy => safe_deploy)
         plan_self(:id => app_instance.id)
       end
 
       def run
         output[:status] = 'IN PROGRESS'
         app_instance = ::ForemanAcd::AppInstance.find(input.fetch(:id))
+        safe_deploy = input.fetch(:safe_deploy)
 
-        # Goal: all or nothing
+        # Goal: all, safe_deploy or nothing
         begin
-          ::Foreman::Logging.logger('foreman_acd').info "Start to deploy all hosts of the app #{app_instance}"
+          if safe_deploy
+            ::Foreman::Logging.logger('foreman_acd').info "Start to safe deploy hosts of the app #{app_instance}"
+          else
+            ::Foreman::Logging.logger('foreman_acd').info "Start to deploy all hosts of the app #{app_instance}"
+          end
           app_deployer = ::ForemanAcd::AppDeployer.new(app_instance)
-          output[:data] = app_deployer.deploy
+          output[:data] = app_deployer.deploy(safe_deploy)
           output[:status] = 'SUCCESS'
         rescue StandardError => e
-          ::Foreman::Logging.logger('foreman_acd').error "Error while deploying hosts for application instance. Clean up all other hosts: #{e}"
+          ::Foreman::Logging.logger('foreman_acd').error "Error while deploying hosts for application instance '#{app_instance.name}'. Clean up all other hosts: #{e}"
           app_instance.clean_all_hosts
 
-          output[:error] = e.to_s
           output[:status] = 'FAILURE'
+          raise "Error while deploying hosts for application instance '#{app_instance.name}': (#{e.message})"
         end
       end
 

data/app/lib/actions/foreman_acd/run_configurator.rb

@@ -15,15 +15,18 @@ module Actions
           app_instance = ::ForemanAcd::AppInstance.find(input.fetch(:id))
           app_configurator = ::ForemanAcd::AppConfigurator.new(app_instance)
 
-          jobs = app_configurator.configure
-          ::Foreman::Logging.logger('foreman_acd').info "Creating #{jobs.count} job(s) to configure the app #{app_instance}"
-
-          # TODO: would it be better to create a sub task for each job we need to run?
-          jobs.each(&:trigger)
+          result, job = app_configurator.configure
+          if result.success
+            ::Foreman::Logging.logger('foreman_acd').info "Creating job to configure the app #{app_instance}"
+            job.trigger!
+          else
+            ::Foreman::Logging.logger('foreman_acd').error "Could not create the job to configure the app #{app_instance}: #{result.error}"
+          end
         rescue StandardError => e
-          ::Foreman::Logging.logger('foreman_acd').error "Error while configuring application instance: #{e}"
-          output[:error] = e.to_s
+          ::Foreman::Logging.logger('foreman_acd').error "Error while configuring application instance '#{app_instance.name}': #{e}"
+
           output[:status] = 'FAILURE'
+          raise "Error while configuring hosts via ansible playbook for application instance '#{app_instance.name}': (#{e.message})"
         end
       end
 

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

@@ -13,13 +13,13 @@ module ForemanAcd
       end
     end
 
-    private
-
     def deployed_via_acd?
       find_app_instance_host
       @app_instance_host.present?
     end
 
+    private
+
     def find_app_instance_host
       @app_instance_host = ForemanAcd::ForemanHost.find_by(:host_id => id)
     end

data/app/models/foreman_acd/acd_provider.rb

@@ -2,7 +2,7 @@
 
 module ForemanAcd
   # Implement a RemoteExecutionProvider
-  class AcdProvider < RemoteExecutionProvider
+  class AcdProvider < ::RemoteExecutionProvider
     class << self
       def supports_effective_user?
         true
@@ -25,6 +25,12 @@ module ForemanAcd
       def ssh_key_passphrase(_host); end
 
       def sudo_password(_host); end
+
+      # Workaround till infrastructure jobs on proxies are possible. See
+      # configure in services/foreman_acd/app_configurator.rb for more details.
+      # def required_proxy_selector_for(_template)
+      #   AcdProxyProxySelector.new
+      # end
     end
   end
 end

data/app/models/foreman_acd/ansible_playbook.rb

@@ -12,6 +12,7 @@ module ForemanAcd
     self.table_name = 'acd_ansible_playbooks'
     has_many :app_definitions, :inverse_of => :ansible_playbook, :foreign_key => 'acd_ansible_playbook_id', :dependent => :restrict_with_error
     validates :name, :presence => true, :uniqueness => true
+    validates :scm_type, :presence => true
     scoped_search :on => :name
 
     default_scope do
@@ -44,7 +45,7 @@ module ForemanAcd
 
     def content
       case scm_type
-      when 'directory'
+      when 'directory' || 'git'
         File.read(File.join(path, playfile))
       else
         raise NotImplementedError.new "scm_type #{scm_type.inspect} not supported!"

data/app/models/foreman_acd/app_instance.rb

@@ -54,7 +54,7 @@ module ForemanAcd
       ids.each do |host_id|
         h = ::Host.find(host_id) unless host_id.nil?
         if h
-          Katello::RegistrationManager.unregister_host(h, :unregistering => false) if ForemanAcd::Engine.with_katello?
+          Katello::RegistrationManager.unregister_host(h, :unregistering => false) if ForemanAcd.with_katello?
           h.destroy
         end
       end

data/app/services/foreman_acd/acd_proxy_proxy_selector.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ForemanAcd
+  # AcdProxy Selector implementing a RemoteExecutionProxySelector which
+  # only returns the Smart Proxy of the given host
+  class AcdProxyProxySelector < ::RemoteExecutionProxySelector
+    def determine_proxy(*args)
+      host, _provider = args
+
+      # We already did the determine_proxy in app_configurator. We want that REX
+      # isn't doing the determination of the proxy twice.
+      # Therefore, we will just return the host, which is the proxy!
+
+      ::SmartProxy.find_by(:name => host.name)
+    end
+  end
+end

data/app/services/foreman_acd/app_configurator.rb

@@ -19,12 +19,36 @@ module ForemanAcd
 
       begin
         proxy_hosts = {}
-        jobs = []
+        job = nil
+        result = OpenStruct.new
 
         hosts = @app_instance.foreman_hosts
+
+        # Important: This uses the REX Proxy Selector and not
+        #  the AcdProxySelection because the AcdProxySelector
+        #  does not find the proxy but only return the given
+        #  host. This is required because we want to run the
+        #  ansible playbook for a group of hosts on the smart proxy.
+        #  So the process need to be:
+        #  1. get the proxy which is required to connect to host a,b,c
+        #  2. run the job on the proxy
+        #  In 2. we need to make sure that REX doesn't try to find the
+        #  proxy which is necessary to connect to the proxy
         proxy_selector = RemoteExecutionProxySelector.new
         hosts.each do |h|
-          proxy = proxy_selector.determine_proxy(h.host, 'ACD')
+          begin
+            unless h.host
+              result.success = false
+              result.error = 'App Instance is not deployed'
+              return [result, job]
+            end
+            proxy = proxy_selector.determine_proxy(h.host, 'ACD')
+            result.success = true
+          rescue NoMethodError => e
+            result.success = false
+            result.error = "#{e}, Install/Update smart-proxies for ACD"
+            return [result, job]
+          end
           proxy_hosts[proxy.name] = [] unless proxy_hosts.key?(proxy.name)
           proxy_hosts[proxy.name] << h
         end
@@ -32,23 +56,43 @@ module ForemanAcd
         # TODO: just for testing...
         # proxy_hosts = { Host.first.name => [ Host.first.id] }
 
-        # we need to compose multiple jobs. for each proxy one job.
+        proxy_inventories = {}
+        proxy_host_ids =  []
         proxy_hosts.each do |proxy_name, foreman_hosts|
-          # create the inventory file
-          inventory = ForemanAcd::InventoryCreator.new(@app_instance, foreman_hosts).create_inventory
-          job_input['inventory'] = YAML.dump(inventory)
-
-          composer = JobInvocationComposer.for_feature(
-            :run_acd_ansible_playbook,
-            [Host.find_by(:name => proxy_name).id],
-            job_input.to_hash
-          )
-          jobs << composer
+          proxy_inventories[proxy_name] = ForemanAcd::InventoryCreator.new(@app_instance, foreman_hosts).create_inventory
+
+          # Workaround till infrastructure jobs on proxies are possible. See
+          #     https://community.theforeman.org/t/infrastructure-roles/22001/33
+          #
+          # Why do we use 'foreman_hosts.first.host'? REX is 'host-centric'. During
+          # job execution, REX will try to find the proxy on which the job should be executed.
+          # We throw the first host at REX's feet so that the resolution of the
+          # proxy works (... which we have already done above).
+          # ACD on the smart proxy side will call the ansible-playbook for ALL hosts
+          # which are behind this smart proxy.
+          #
+          # Additionally, we disable that  AcdProxyProxySelector is used.
+          # See required_proxy_selector_for in models/foreman_acd/acd_provider.rb
+          proxy_host_ids << foreman_hosts.first.host.id
+
+          # Actually, we want this:
+          # proxy_host_ids << Host.find_by(:name => proxy_name).id
         end
+
+        job_input['inventory'] = YAML.dump(proxy_inventories)
+        composer = JobInvocationComposer.for_feature(
+          :run_acd_ansible_playbook,
+          proxy_host_ids,
+          job_input.to_hash
+        )
+        job = composer
       rescue StandardError => e
-        logger.error("Failed to configure hosts: #{e.class}: #{e.message}\n#{e.backtrace.join($INPUT_RECORD_SEPARATOR)}")
+        result.success = false
+        result.error = _('Failed to configure hosts: %{err_msg}' % { :err_msg => e.message })
+        logger.error('Failed to configure hosts: %{err_class}: %{err_msg}' % { :err_class => e.class, :err_msg => e.message })
+        job = nil
       end
-      jobs
+      [result, job]
     end
   end
 end