foreman_patch 1.1.5 → 1.1.6.alpha4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4f015d44bd2d66ad47969d4894d91c310490016878d97b3813116f5f98d1905
-  data.tar.gz: f806ef4db3bb2063fe5351647b1ad3afbc62a4123cec77e7e6cde19841d9afce
+  metadata.gz: 4a0c418f7823f9284b25ba359c284ac4eb6f090e1826b32759ff11c4c9930a20
+  data.tar.gz: 52f7f32b37f8ab528b6946d17023ed613cf874ba913efc8b42b3c38dc13974bb
 SHA512:
-  metadata.gz: 77525bb51ccca12bb7c6ca53b116d3617078a9aad0b8d1541e0e5800496e47cdc612a188adbe206290fa4bb0e66902b1b33e6dd60c686466d9579775b75970ba
-  data.tar.gz: 676e249138262bd3c3016b59abc49dd909332212fe9cd72c7be1d12092c8b48852acea23e6e52155de7a0d36688b88d0d7ebee71c8328ebde8d6cfba197c195c
+  metadata.gz: fcddad96ea62cb31521ca728b418fc2f33fbbc9a167d06270fc4a8d45a5bb6d23915b9686af28c86203d9c4fdd48e62f2c8cf3afdb8c1695da49c8818df89cbb
+  data.tar.gz: 81d7bf80181451853b12c593cfac3bca9e662da2db237e7f54ce780a3b1a41e03a112a34b4fc81ad7bf5cd54096c85d22f7bbfa72b7c602603ca120f910ceb97

data/app/controllers/foreman_patch/concerns/hosts_controller_extensions.rb

@@ -3,58 +3,52 @@ module ForemanPatch
     module HostsControllerExtensions
       extend ActiveSupport::Concern
 
-      module Overrides
-        def action_permission
-          case params[:action]
-          when 'select_multiple_patch_group', 'update_multiple_patch_group'
-            :edit
-          else
-            super
-          end
-        end
-      end
+      MULTIPLE_EDIT_ACTIONS = %w[select_multiple_patch_group, update_multiple_patch_group].freeze
 
       included do
-        prepend Overrides
-
+        before_action :find_multiple_for_foreman_patch_extensions, only: MULTIPLE_EDIT_ACTIONS
         after_action :reschedule_patching, only: :update
 
-        def select_multiple_patch_group
-          find_multiple
-        end
+        define_action_permission MULTIPLE_EDIT_ACTIONS, :edit
 
-        def update_multiple_patch_group
-          find_multiple
-
-          if (params['patch_group']['id'].blank?)
-            @hosts.each do |host|
-              group_facet = host.group_facet
-              group_facet.group = nil unless group_facet.blank?
-              host.save!
-            end
-          else
-            patch_group = ForemanPatch::Group.find(params['patch_group']['id'])
-
-            @hosts.each do |host|
-              group_facet = host.group_facet || host.build_group_facet
-              group_facet.group = patch_group
-              host.save!
-            end
-          end
+        helper ForemanPatch::HostsHelper
+      end
+
+      def select_multiple_patch_group
+      end
 
-          ForemanTasks.async_task(Actions::ForemanPatch::Host::Reschedule, @hosts, include_active: params['patch_group']['include_active'])
+      def update_multiple_patch_group
+        if (params['patch_group']['id'].blank?)
+          @hosts.each do |host|
+            group_facet = host.group_facet
+            group_facet.group = nil unless group_facet.blank?
+            host.save!
+          end
+        else
+          patch_group = ForemanPatch::Group.find(params['patch_group']['id'])
 
-          success _('Updated hosts: changed patch group')
-          redirect_back_or_to hosts_path
+          @hosts.each do |host|
+            group_facet = host.group_facet || host.build_group_facet
+            group_facet.group = patch_group
+            host.save!
+          end
         end
 
-        def reschedule_patching
-          return if @host.group_facet.nil?
-          return unless @host.group_facet.saved_change_to_attribute?(:group_id)
+        ForemanTasks.async_task(Actions::ForemanPatch::Host::Reschedule, @hosts, include_active: params['patch_group']['include_active'])
 
-          ForemanTasks.async_task(Actions::ForemanPatch::Host::Reschedule, @host)
-        end
+        success _('Updated hosts: changed patch group')
+        redirect_back_or_to hosts_path
+      end
+
+      def reschedule_patching
+        return if @host.group_facet.nil?
+        return unless @host.group_facet.saved_change_to_attribute?(:group_id)
+
+        ForemanTasks.async_task(Actions::ForemanPatch::Host::Reschedule, @host)
+      end
 
+      def find_multiple_for_foreman_patch_extensions
+        find_multiple
       end
     end
   end

data/app/controllers/foreman_patch/react_controller.rb

@@ -0,0 +1,12 @@
+module ForemanPatch
+  class ReactController < ::ApplicationController
+    skip_before_action :authorize
+    
+    include Rails.application.routes.url_helpers
+    
+    def index
+      render 'foreman_patch/layouts/react', layout: false
+    end
+  end
+end
+

data/app/lib/actions/foreman_patch/cycle/create.rb

@@ -49,7 +49,11 @@ module Actions
         end
 
         def humanized_name
-          _('Create cycle: %s') % input[:plan][:name]
+          _('Create cycle:')
+        end
+
+        def humanized_input
+        input.dig(:plan, :name)
         end
 
         private

data/app/lib/actions/foreman_patch/cycle/initiate.rb

@@ -40,7 +40,11 @@ module Actions
         end
 
         def humanized_name
-          _('Initiating patch cycle: %s') % cycle.name
+          _('Initiating patch cycle:')
+        end
+
+        def humanized_input
+          cycle.name
         end
 
         def cycle

data/app/lib/actions/foreman_patch/invocation/action.rb

@@ -46,7 +46,7 @@ module Actions
           provider = template.provider
           proxy_selector = provider.required_proxy_selector_for(template) || ::RemoteExecutionProxySelector.new
 
-          proxy = proxy_selector.determine_proxy(host, template.provider_type.to_s)
+          proxy = determine_proxy!(proxy_selector, template.provider_type.to_s, host)
 
           renderer = InputTemplateRenderer.new(template, host, invocation)
           script = renderer.render
@@ -61,7 +61,7 @@ module Actions
           action_options = provider.proxy_command_options(invocation, host).merge(additional_options)
 
           sequence do
-            plan_delegated_action(proxy, provider.proxy_action_class, action_options)
+            plan_action(::Actions::ForemanPatch::Invocation::ProxyAction, proxy, provider.proxy_action_class, action_options)
             plan_self
           end
         end
@@ -87,37 +87,10 @@ module Actions
           @template ||= feature.job_template
         end
 
-        def live_output
-          continuous_output.sort!
-          continuous_output.raw_outputs
-        end
-
-        def continuous_output_providers
-          super << self
-        end
-
-        def fill_continuous_output(continuous_output)
-          delegated_output.fetch('result', []).each do |raw_output|
-            continuous_output.add_raw_output(raw_output)
-          end
-
-          final_timestamp = (continuous_output.last_timestamp || task.ended_at).to_f + 1
-
-          fill_planning_errors_to_continuous_output(continuous_output) unless exit_status
-            
-          continuous_output.add_output(_('Exit status: %s') % exit_status, 'stdout', final_timestamp) if exit_status
-        rescue => e
-          continuous_output.add_exception(_('Error loading data from proxy'), e)
-        end
-
         def required?
           input.fetch(:required, true)
         end
 
-        def humanized_name
-          input[:feature_name].titleize
-        end
-
         def rescue_strategy_for_self
           required? ? ::Dynflow::Action::Rescue::Fail : ::Dynflow::Action::Rescue::Skip
         end
@@ -128,6 +101,27 @@ module Actions
           @host ||= ::Host.find(input[:host][:id])
         end
 
+        def determine_proxy!(proxy_selector, provider, host)
+          proxy = proxy_selector.determine_proxy(host, provider)
+          if proxy == :not_available
+            offline_proxies = proxy_selector.offline
+            settings = { count: offline_proxies.count, proxy_names: offline_proxies.map(&:name).join(', ') }
+            raise n_('The only applicable proxy %{proxy_names} is down',
+                     'All %{count} applicable proxies are down. Tried %{proxy_names}',
+                     offline_proxies.count) % settings
+          elsif proxy == :not_defined
+            settings = {
+              global_proxy: 'remote_execution_global_proxy',
+              fallback_proxy: 'remote_execution_fallback_proxy',
+              provider: provider,
+            }
+
+            raise _('Could not use any proxy for the %{provider} job. Consider configuring %{global_proxy}, ' +
+                    '%{fallback_proxy} in settings') % settings
+          end
+          proxy
+        end
+
       end
     end
   end

data/app/lib/actions/foreman_patch/invocation/patch.rb

@@ -3,6 +3,7 @@ module Actions
     module Invocation
       class Patch < Actions::EntryAction
         include ::Actions::Helpers::WithContinuousOutput
+        include ::Actions::ForemanPatch::Invocation::ProcessLogging
 
         execution_plan_hooks.use :update_status, on: ::Dynflow::ExecutionPlan.states
 
@@ -52,8 +53,16 @@ module Actions
         end
 
         def continuous_output_providers
-          planned_actions.select do |action|
-            action.respond_to?(:fill_continuous_output)
+          super << self
+        end
+
+        def fill_continuous_output(continuous_output)
+          invocation.events.order(:sequence).find_each do |output|
+            if output.event_type == 'exit'
+              continuous_output.add_output(_('Exit status: %s') % output.event, 'stdout', output.timestamp)
+            else
+              continuous_output.add_raw_output(output.as_raw_continuous_output)
+            end
           end
         end
 
@@ -71,7 +80,11 @@ module Actions
         end
 
         def humanized_name
-          _('Patch %s') % host.name
+          _('Patch:')
+        end
+
+        def humanized_input
+          host.name
         end
 
         private
@@ -80,10 +93,6 @@ module Actions
           @host ||= ::Host.find(input[:host][:id])
         end
 
-        def invocation
-          @invocation ||= ::ForemanPatch::Invocation.find(input[:invocation_id])
-        end
-
         def failed_action
           planned_actions.find do |action|
             action.steps.compact.any? { |step| [:error, :skipped].include? step.state }

data/app/lib/actions/foreman_patch/invocation/process_logging.rb

@@ -0,0 +1,44 @@
+module Actions
+  module ForemanPatch
+    module Invocation
+      module ProcessLogging
+
+        def invocation
+          @invocation ||= ::ForemanPatch::Invocation.find_by(task_id: task.id)
+        end
+
+        def log_invocation_event(event, type = 'debug', timestamp = Time.zone.now)
+          last = invocation.events.order(:sequence).last
+          sequence = last ? last.sequence + 1 : 0
+          invocation.events.create!(
+            event_type: type,
+            event: event,
+            timestamp: timestamp,
+            sequence: sequence
+          )
+        end
+
+        def log_invocation_exception(exception)
+          last = invocation.events.order(:sequence).last
+          sequence = last ? last.sequence + 1 : 0
+          invocation.events.create!(
+            event_type: 'debug',
+            event: "#{exception.class}: #{exception.message}",
+            timestamp: Time.zone.now,
+            sequence: sequence
+          )
+        end
+
+        def with_invocation_error_logging
+          unless catch(::Dynflow::Action::ERROR) { yield || true }
+            log_invocation_exception(error.exception)
+            throw ::Dynflow::Action::ERROR
+          end
+        rescue => e
+          log_invocation_exception(e)
+          raise e
+        end
+      end
+    end
+  end
+end

data/app/lib/actions/foreman_patch/invocation/proxy_action.rb

@@ -0,0 +1,52 @@
+module Actions
+  module ForemanPatch
+    module Invocation
+      class ProxyAction < ::Actions::ProxyAction
+        include Actions::ForemanPatch::Invocation::ProcessLogging
+
+        def on_data(data, meta = {})
+          super
+          process_proxy_data(output[:proxy_output])
+        end
+
+        def run(event = nil)
+          with_invocation_error_logging { super }
+        end
+
+        private
+
+        def get_proxy_data(response)
+          data = super
+          process_proxy_data(data)
+          data
+        end
+
+        def process_proxy_data(data)
+          events = data['result'].each_with_index.map do |update, idx|
+            {
+              sequence: update['sequence'] || idx,
+              invocation_id: invocation.id,
+              event: update['output'],
+              timestamp: Time.at(update['timestamp']).getlocal,
+              event_type: update['output_type'],
+            }
+          end
+          if data['exit_status']
+            last = events.last || { sequence: -1, timestamp: Time.zone.now }
+            events << {
+              sequence: last[:sequence] + 1,
+              invocation_id: invocation.id,
+              event: data['exit_status'],
+              timestamp: last[:timestamp],
+              event_type: 'exit',
+            }
+          end
+          events.each_slice(1000) do |batch|
+            ::ForemanPatch::Event.upsert_all(batch, unique_by: [:invocation_id, :sequence])
+          end
+        end
+
+      end
+    end
+  end
+end

data/app/lib/actions/foreman_patch/invocation/wait_for_host.rb

@@ -2,8 +2,8 @@ module Actions
   module ForemanPatch
     module Invocation
       class WaitForHost < Actions::EntryAction
-        include Actions::Helpers::WithContinuousOutput
         include Dynflow::Action::Polling
+        include ::Actions::ForemanPatch::Invocation::ProcessLogging
 
         def plan(host)
           action_subject(host)
@@ -31,7 +31,7 @@ module Actions
           status = 'starting'
         ensure
           socket.close if socket
-          add_output("Poll result: #{status}")
+          log_invocation_event("Poll result: #{status}")
         end
 
         def poll_intervals
@@ -46,30 +46,15 @@ module Actions
         end
 
         def on_finish
-          add_output(_('Host is up'), 'stdout') if external_task == 'available'
+          log_invocation_event(_('Host is up'), 'stdout') if external_task == 'available'
         end
 
         def process_timeout
-          add_output(_('Server did not respond withing alloted time after restart.'), 'stderr')
+          log_invocation_event(_('Server did not respond withing alloted time after restart.'), 'stderr')
 
           self.external_task = 'timeout'
         end
 
-        def live_output
-          continuous_output.sort!
-          continuous_output.raw_outputs
-        end
-
-        def continuous_output_providers
-          super << self
-        end
-
-        def fill_continuous_output(continuous_output)
-          output.fetch('result', []).each do |raw_output|
-            continuous_output.add_raw_output(raw_output)
-          end
-        end
-
         private
 
         def host
@@ -80,16 +65,6 @@ module Actions
           external_task == 'starting'
         end
 
-        def add_output(message, type = 'debug', timestamp = Time.now.getlocal)
-          formatted_output = {
-            output_type: type,
-            output: message,
-            timestamp: timestamp.to_f
-          }
-
-          output[:result] = [] if output[:result].nil?
-          output[:result] << formatted_output
-        end
       end
     end
   end

data/app/lib/actions/foreman_patch/round/patch.rb

@@ -72,7 +72,11 @@ module Actions
         end
 
         def humanized_name
-          'Patch Group: %s' % round.name
+          'Patch Group:'
+        end
+
+        def humanized_input
+          round.name
         end
 
       end

data/app/lib/actions/foreman_patch/window/publish.rb

@@ -23,7 +23,11 @@ module Actions
         end
 
         def humanized_name
-          _('Publish ticket for %s') % window.name
+          _('Publish ticket for:')
+        end
+
+        def humanized_input
+          window.name
         end
 
       end

data/app/lib/actions/foreman_patch/window/resolve_hosts.rb

@@ -22,7 +22,11 @@ module Actions
         end
 
         def humanized_name
-          _('Resolve Hosts for %s') % window.name
+          _('Resolve Hosts for:')
+        end
+
+        def humanized_input
+          window.name
         end
 
       end

data/app/models/foreman_patch/event.rb

@@ -0,0 +1,13 @@
+module ForemanPatch
+  class Event < ::ApplicationRecord
+    belongs_to :invocation, class_name: 'ForemanPatch::Invocation'
+
+    def as_raw_continuous_output
+      raw = attibutes
+      raw['output_type'] = raw.delete('event_type')
+      raw['output'] = raw.delete('event')
+      raw['timestamp'] = raw['timestamp'].to_f
+      raw
+    end
+  end
+end

data/app/models/foreman_patch/invocation.rb

@@ -12,6 +12,8 @@ module ForemanPatch
 
     belongs_to :task, class_name: 'ForemanTasks::Task'
 
+    has_many :events, class_name: 'ForemanPatch::Events'
+
     scope :planned, -> { where(status: 'planned') }
     scope :pending, -> { where(status: 'pending') }
     scope :running, -> { where(status: 'running') }
@@ -32,10 +34,6 @@ module ForemanPatch
       task&.main_action&.planned_actions || []
     end
 
-    def events
-      task&.main_action&.live_output || []
-    end
-
     def complete?
       ['success', 'warning', 'failed', 'cancelled'].include? status
     end

data/app/views/foreman_patch/api/v2/invocations/base.json.rabl

@@ -1,6 +1,6 @@
 object @invocation
 
-attributes :id, :round_id, :task_id, :host_id, :state, :result, :status
+attributes :id, :round_id, :task_id, :host_id, :status
 
 node(:name) { |inv| inv.host.name }
 

data/app/views/foreman_patch/api/v2/invocations/event.json.rabl

@@ -0,0 +1,3 @@
+object @event
+
+attributes :sequence, :event_type, :event, :meta, :timestamp

data/app/views/foreman_patch/api/v2/invocations/show.json.rabl

@@ -2,6 +2,6 @@ object @invocation
 
 extends 'foreman_patch/api/v2/invocations/base'
 
-child phases: :phases do
-  extends 'foreman_patch/api/v2/invocations/phase'
+child events: :events do
+  extends 'foreman_patch/api/v2/invocations/event'
 end

data/app/views/foreman_patch/groups/index.html.erb

@@ -29,7 +29,7 @@
         </td>
         <td>
           <%= action_buttons(
-            display_delete_if_authorized(hash_for_group_path(id: group.id).merge(auth_object: group, authorizer: authorizer), data: { confirm: _("Delete patch group, %s?") % group.name })) %>
+            display_delete_if_authorized(hash_for_group_path(id: group.id).merge(engine: foreman_patch, auth_object: group, authorizer: authorizer), data: { confirm: _("Delete patch group, %s?") % group.name })) %>
         </td>
       </tr>
     <% end %>

data/app/views/foreman_patch/layouts/react.html.erb

@@ -12,6 +12,6 @@
   <div id="user-id" data-id="<%= User.current.id if User.current %>"></div>
   <%= react_component('ForemanPatch') %>
 <% end %>
-<%= render file: "layouts/base" %>
+<%= render template: "layouts/base" %>
 
 

data/config/api_routes.rb

@@ -1,43 +1,41 @@
 ForemanPatch::Engine.routes.draw do
-  scope :foreman_patch, path: '/foreman_patch' do
-    namespace :api do
-      scope '(:apiv)', module: :v2, defaults: { apiv: 'v2' }, apiv: /v1|v2/, constraints: ApiConstraints.new(version: 2, default: true) do
-        resources :plans, only: [:index, :show, :create, :update, :destroy] do
-          resources :window_plans, only: [:index, :create]
-          resources :cycles, only: [:index, :create]
-        end
+  namespace :api, defaults: { format: 'json' } do
+    scope '(:apiv)', module: :v2, defaults: { apiv: 'v2' }, apiv: /v1|v2/, constraints: ApiConstraints.new(version: 2, default: true) do
+      resources :plans, only: [:index, :show, :create, :update, :destroy] do
+        resources :window_plans, only: [:index, :create]
+        resources :cycles, only: [:index, :create]
+      end
 
-        resources :window_plans, only: [:index, :show, :update, :destroy]
+      resources :window_plans, only: [:index, :show, :update, :destroy]
 
-        resources :cycles, only: [:index, :create, :show, :update, :destroy] do
-          resources :windows, only: [:index, :create]
-        end
+      resources :cycles, only: [:index, :create, :show, :update, :destroy] do
+        resources :windows, only: [:index, :create]
+      end
 
-        resources :windows, only: [:show, :update, :destroy] do
-          resources :rounds, only: [:index]
-          member do
-            post :schedule
-          end
+      resources :windows, only: [:show, :update, :destroy] do
+        resources :rounds, only: [:index]
+        member do
+          post :schedule
         end
+      end
 
-        resources :groups, only: [:index, :show, :create, :update, :destroy]
+      resources :groups, only: [:index, :show, :create, :update, :destroy]
 
-        resources :rounds, only: [:show, :create, :update, :destroy] do
-          resources :invocations, only: [:index]
+      resources :rounds, only: [:show, :create, :update, :destroy] do
+        resources :invocations, only: [:index]
 
-          member do
-            get :status
-          end
+        member do
+          get :status
         end
+      end
 
-        resources :invocations, only: [:show] do
-          collection do
-            put 'move'
-            put 'cancel'
-          end
+      resources :invocations, only: [:show] do
+        collection do
+          put 'move'
+          put 'cancel'
         end
-
       end
+
     end
   end
 end