foreman_remote_execution 11.1.1 → 12.0.0

data/app/assets/javascripts/foreman_remote_execution/locale/ko/foreman_remote_execution.js

@@ -383,6 +383,12 @@
       "Try to abort the job without waiting for the results from the remote hosts": [
         ""
       ],
+      "New UI": [
+        ""
+      ],
+      "Switch to the new job invocation detail UI": [
+        ""
+      ],
       "Task Details": [
         "작업 자세히"
       ],
@@ -1095,6 +1101,9 @@
       "Job templates": [
         "작업 템플릿"
       ],
+      "Job invocations detail": [
+        ""
+      ],
       "Run Puppet Once": [
         ""
       ],
@@ -1107,6 +1116,21 @@
       "Run a script": [
         ""
       ],
+      "Not yet": [
+        ""
+      ],
+      "Effective user:": [
+        ""
+      ],
+      "Started at:": [
+        ""
+      ],
+      "SSH user:": [
+        ""
+      ],
+      "Template:": [
+        ""
+      ],
       "Submit": [
         ""
       ],
@@ -1545,29 +1569,17 @@
       "Active Filters:": [
         ""
       ],
+      "A plugin bringing remote execution to the Foreman, completing the config management functionality with remote management functionality.": [
+        "Foreman으로 원격 실행을 가져오는 플러그인입니다. 원격 관리 기능으로 구성 관리 기능을 완료합니다."
+      ],
       "Action with sub plans": [
         "하위 계획이 있는 작업"
       ],
-      "Check for long running tasks": [
-        ""
-      ],
-      "Deliver notifications about long running tasks": [
-        ""
-      ],
       "Import Puppet classes": [
         "Puppet 클래스 가져오기"
       ],
       "Import facts": [
         "팩트 불러오기"
-      ],
-      "A plugin bringing remote execution to the Foreman, completing the config management functionality with remote management functionality.": [
-        "Foreman으로 원격 실행을 가져오는 플러그인입니다. 원격 관리 기능으로 구성 관리 기능을 완료합니다."
-      ],
-      "Distribute tasks over N seconds": [
-        "N초에 걸쳐 태스크 배분"
-      ],
-      "Time span": [
-        "기간"
       ]
     }
   }

data/app/assets/javascripts/foreman_remote_execution/locale/pt_BR/foreman_remote_execution.js

@@ -383,6 +383,12 @@
       "Try to abort the job without waiting for the results from the remote hosts": [
         "Tente anular o trabalho sem esperar os resultados dos hosts remotos"
       ],
+      "New UI": [
+        ""
+      ],
+      "Switch to the new job invocation detail UI": [
+        ""
+      ],
       "Task Details": [
         "Detalhes da tarefa"
       ],
@@ -1097,6 +1103,9 @@
       "Job templates": [
         "Modelos de trabalho"
       ],
+      "Job invocations detail": [
+        ""
+      ],
       "Run Puppet Once": [
         "Executar Puppet"
       ],
@@ -1109,6 +1118,21 @@
       "Run a script": [
         ""
       ],
+      "Not yet": [
+        ""
+      ],
+      "Effective user:": [
+        ""
+      ],
+      "Started at:": [
+        ""
+      ],
+      "SSH user:": [
+        ""
+      ],
+      "Template:": [
+        ""
+      ],
       "Submit": [
         ""
       ],
@@ -1547,38 +1571,17 @@
       "Active Filters:": [
         ""
       ],
+      "A plugin bringing remote execution to the Foreman, completing the config management functionality with remote management functionality.": [
+        "Um plugin trazendo execução remota ao Foreman, completando a funcionalidade de gerenciamento de configuração com a funcionalidade de gerenciamento remoto. "
+      ],
       "Action with sub plans": [
         "Ação com subplanos "
       ],
-      "Check for long running tasks": [
-        ""
-      ],
-      "Deliver notifications about long running tasks": [
-        ""
-      ],
       "Import Puppet classes": [
         "Importar classes de Puppet"
       ],
       "Import facts": [
         "Importar fatos"
-      ],
-      "A plugin bringing remote execution to the Foreman, completing the config management functionality with remote management functionality.": [
-        "Um plugin trazendo execução remota ao Foreman, completando a funcionalidade de gerenciamento de configuração com a funcionalidade de gerenciamento remoto. "
-      ],
-      "Cron line format 'a b c d e', where:": [
-        "Cron line format 'a b c d e', onde:"
-      ],
-      "#~ \"Distribute execution over N seconds. If this is set and proxy batch triggering\"#~ \" is enabled, then tasks are triggered on the smart proxy in batches of size 1.\"": [
-        "#~ \"Distribuir a execução ao longo de N segundos. Se essa opção estiver definida, \"#~ \"e o acionamento em lote de proxy estiver desabilitado, então, as tarefas serão\"#~ \" acionadas no proxy inteligente em lotes de tamanho 1.\""
-      ],
-      "Distribute tasks over N seconds": [
-        "Distribuir tarefas em N segundos "
-      ],
-      "Set to distribute over": [
-        "Definir para distribuir em"
-      ],
-      "Time span": [
-        "Período de tempo"
       ]
     }
   }

data/app/assets/javascripts/foreman_remote_execution/locale/ru/foreman_remote_execution.js

@@ -383,6 +383,12 @@
       "Try to abort the job without waiting for the results from the remote hosts": [
         ""
       ],
+      "New UI": [
+        ""
+      ],
+      "Switch to the new job invocation detail UI": [
+        ""
+      ],
       "Task Details": [
         "Описание задачи"
       ],
@@ -1098,6 +1104,9 @@
       "Job templates": [
         "Шаблоны заданий"
       ],
+      "Job invocations detail": [
+        ""
+      ],
       "Run Puppet Once": [
         ""
       ],
@@ -1110,6 +1119,21 @@
       "Run a script": [
         ""
       ],
+      "Not yet": [
+        ""
+      ],
+      "Effective user:": [
+        ""
+      ],
+      "Started at:": [
+        ""
+      ],
+      "SSH user:": [
+        ""
+      ],
+      "Template:": [
+        ""
+      ],
       "Submit": [
         ""
       ],
@@ -1548,29 +1572,17 @@
       "Active Filters:": [
         ""
       ],
+      "A plugin bringing remote execution to the Foreman, completing the config management functionality with remote management functionality.": [
+        "Дополнительный модуль Foreman для удаленного выполнения заданий, объединяющий функции управления конфигурацией и удаленного контроля."
+      ],
       "Action with sub plans": [
         "Действия с подпланами"
       ],
-      "Check for long running tasks": [
-        ""
-      ],
-      "Deliver notifications about long running tasks": [
-        ""
-      ],
       "Import Puppet classes": [
         "Импорт классов Puppet"
       ],
       "Import facts": [
         "Импорт фактов"
-      ],
-      "A plugin bringing remote execution to the Foreman, completing the config management functionality with remote management functionality.": [
-        "Дополнительный модуль Foreman для удаленного выполнения заданий, объединяющий функции управления конфигурацией и удаленного контроля."
-      ],
-      "Distribute tasks over N seconds": [
-        "Распределить задачи в пределах заданного периода времени (в секундах)"
-      ],
-      "Time span": [
-        "Интервал"
       ]
     }
   }

data/app/assets/javascripts/foreman_remote_execution/locale/zh_CN/foreman_remote_execution.js

@@ -383,6 +383,12 @@
       "Try to abort the job without waiting for the results from the remote hosts": [
         "尝试在不等待远程主机的结果情况下终止作业"
       ],
+      "New UI": [
+        ""
+      ],
+      "Switch to the new job invocation detail UI": [
+        ""
+      ],
       "Task Details": [
         "任务详情"
       ],
@@ -1094,6 +1100,9 @@
       "Job templates": [
         "作业模板"
       ],
+      "Job invocations detail": [
+        ""
+      ],
       "Run Puppet Once": [
         "运行 Puppet 一次"
       ],
@@ -1106,6 +1115,21 @@
       "Run a script": [
         ""
       ],
+      "Not yet": [
+        ""
+      ],
+      "Effective user:": [
+        ""
+      ],
+      "Started at:": [
+        ""
+      ],
+      "SSH user:": [
+        ""
+      ],
+      "Template:": [
+        ""
+      ],
       "Submit": [
         ""
       ],
@@ -1544,38 +1568,17 @@
       "Active Filters:": [
         ""
       ],
+      "A plugin bringing remote execution to the Foreman, completing the config management functionality with remote management functionality.": [
+        "一个将远程执行带到 Foreman 的插件，通过远程管理功能来完成配置管理功能。"
+      ],
       "Action with sub plans": [
         "有子计划的操作"
       ],
-      "Check for long running tasks": [
-        ""
-      ],
-      "Deliver notifications about long running tasks": [
-        ""
-      ],
       "Import Puppet classes": [
         "导入 Puppet 类"
       ],
       "Import facts": [
         "导入事实"
-      ],
-      "A plugin bringing remote execution to the Foreman, completing the config management functionality with remote management functionality.": [
-        "一个将远程执行带到 Foreman 的插件，通过远程管理功能来完成配置管理功能。"
-      ],
-      "Cron line format 'a b c d e', where:": [
-        "Cron 行格式 'a b c d e', 其中："
-      ],
-      "#~ \"Distribute execution over N seconds. If this is set and proxy batch triggering\"#~ \" is enabled, then tasks are triggered on the smart proxy in batches of size 1.\"": [
-        "在 N 秒内分配执行。如果设置了此选项并启用了代理批处理触发，则将在智能代理上以大小为 1 的批处理触发任务。"
-      ],
-      "Distribute tasks over N seconds": [
-        "在 N 秒内分配任务"
-      ],
-      "Set to distribute over": [
-        "设置为通过...分配"
-      ],
-      "Time span": [
-        "时间跨度"
       ]
     }
   }

data/app/assets/javascripts/foreman_remote_execution/locale/zh_TW/foreman_remote_execution.js

@@ -383,6 +383,12 @@
       "Try to abort the job without waiting for the results from the remote hosts": [
         ""
       ],
+      "New UI": [
+        ""
+      ],
+      "Switch to the new job invocation detail UI": [
+        ""
+      ],
       "Task Details": [
         "工作詳細資料"
       ],
@@ -1096,6 +1102,9 @@
       "Job templates": [
         "工作範本"
       ],
+      "Job invocations detail": [
+        ""
+      ],
       "Run Puppet Once": [
         ""
       ],
@@ -1108,6 +1117,21 @@
       "Run a script": [
         ""
       ],
+      "Not yet": [
+        ""
+      ],
+      "Effective user:": [
+        ""
+      ],
+      "Started at:": [
+        ""
+      ],
+      "SSH user:": [
+        ""
+      ],
+      "Template:": [
+        ""
+      ],
       "Submit": [
         ""
       ],
@@ -1546,29 +1570,17 @@
       "Active Filters:": [
         ""
       ],
+      "A plugin bringing remote execution to the Foreman, completing the config management functionality with remote management functionality.": [
+        "將遠端執行帶入 Foreman 的外掛程式，搭配遠端管理功能來完成配置管理。"
+      ],
       "Action with sub plans": [
         "有子計畫的動作"
       ],
-      "Check for long running tasks": [
-        ""
-      ],
-      "Deliver notifications about long running tasks": [
-        ""
-      ],
       "Import Puppet classes": [
         "匯入 Puppet 類別"
       ],
       "Import facts": [
         "匯入詳情"
-      ],
-      "A plugin bringing remote execution to the Foreman, completing the config management functionality with remote management functionality.": [
-        "將遠端執行帶入 Foreman 的外掛程式，搭配遠端管理功能來完成配置管理。"
-      ],
-      "Distribute tasks over N seconds": [
-        "在幾秒間散佈工作"
-      ],
-      "Time span": [
-        "時間跨度"
       ]
     }
   }

data/app/helpers/remote_execution_helper.rb

@@ -98,6 +98,11 @@ module RemoteExecutionHelper
         :disabled => !task.cancellable?,
         :method => :post)
     end
+    if Setting[:lab_features]
+      buttons << link_to(_('New UI'), new_job_invocation_detail_path(:id => job_invocation.id),
+        class: 'btn btn-default',
+        title: _('Switch to the new job invocation detail UI'))
+    end
     return buttons
   end
 

data/app/lib/actions/remote_execution/event_helpers.rb

@@ -0,0 +1,42 @@
+module Actions
+  module RemoteExecution
+    module EventHelpers
+      module ClassEventHelpers
+        def event_states
+          []
+        end
+
+        def event_names
+          event_states.map do |state|
+            event_name_base + '_' + event_name_suffix(state).to_s
+          end
+        end
+
+        def feature_job_event_names(label)
+          event_states.map do |state|
+            ::Foreman::Observable.event_name_for("#{event_name_base}_#{label}_#{event_name_suffix(state)}")
+          end
+        end
+      end
+
+      def self.included(base)
+        base.extend ClassEventHelpers
+      end
+
+      def emit_event(execution_plan, hook)
+        return unless root_action?
+
+        payload = event_payload(execution_plan)
+        base = self.class.event_name_base
+        suffix = self.class.event_name_suffix(hook)
+        if input["job_features"]&.any?
+          input['job_features'].each do |feature|
+            name = "#{base}_#{feature}_#{suffix}"
+            trigger_hook name, payload: payload
+          end
+        end
+        trigger_hook("#{base}_#{suffix}", payload: payload)
+      end
+    end
+  end
+end

data/app/lib/actions/remote_execution/run_host_job.rb

@@ -5,8 +5,7 @@ module Actions
       include ::Actions::Helpers::WithDelegatedAction
       include ::Actions::ObservableAction
       include ::Actions::RemoteExecution::TemplateInvocationProgressLogging
-
-      execution_plan_hooks.use :emit_feature_event, :on => :success
+      include ::Actions::RemoteExecution::EventHelpers
 
       middleware.do_not_use Dynflow::Middleware::Common::Transaction
       middleware.use Actions::Middleware::HideSecrets
@@ -79,20 +78,8 @@ module Actions
         end
       end
 
-      def self.feature_job_event_name(label, suffix = :success)
-        ::Foreman::Observable.event_name_for("#{::Actions::RemoteExecution::RunHostJob.event_name_base}_#{label}_#{::Actions::RemoteExecution::RunHostJob.event_name_suffix(suffix)}")
-      end
-
-      def emit_feature_event(execution_plan, hook = :success)
-        return unless root_action?
-
-        payload = event_payload(execution_plan)
-        if input["job_features"]&.any?
-          input['job_features'].each do |feature|
-            name = "#{self.class.event_name_base}_#{feature}_#{self.class.event_name_suffix(hook)}"
-            trigger_hook name, payload: payload
-          end
-        end
+      def self.event_states
+        [:success, :failure]
       end
 
       def secrets(host, job_invocation, provider)

data/app/lib/actions/remote_execution/run_hosts_job.rb

@@ -3,6 +3,7 @@ module Actions
     class RunHostsJob < Actions::ActionWithSubPlans
       include Actions::RecurringAction
       include Actions::ObservableAction
+      include Actions::RemoteExecution::EventHelpers
 
       middleware.use Actions::Middleware::BindJobInvocation
       middleware.use Actions::Middleware::RecurringLogic
@@ -10,7 +11,7 @@ module Actions
 
       execution_plan_hooks.use :notify_on_success, :on => :success
       execution_plan_hooks.use :notify_on_failure, :on => :failure
-      execution_plan_hooks.use :emit_event_running, :on => :running
+      execution_plan_hooks.use :emit_running_event, :on => :running
 
       class CheckOnProxyActions; end
 
@@ -28,7 +29,8 @@ module Actions
       def plan(job_invocation)
         job_invocation.task_group.save! if job_invocation.task_group.try(:new_record?)
         task.add_missing_task_groups(job_invocation.task_group) if job_invocation.task_group
-        action_subject(job_invocation)
+        features = job_invocation.pattern_templates.flat_map { |t| t.remote_execution_features.pluck(:label) }.uniq
+        action_subject(job_invocation, job_features: features)
         job_invocation.targeting.resolve_hosts! if job_invocation.targeting.dynamic? || !job_invocation.targeting.resolved?
         set_up_concurrency_control job_invocation
         input.update(:job_category => job_invocation.job_category)
@@ -158,11 +160,11 @@ module Actions
         input[:proxy_batch_size]
       end
 
-      def self.event_names
-        super + [event_name_base + '_' + event_name_suffix('running')]
+      def self.event_states
+        [:success, :failure, :running]
       end
 
-      def emit_event_running(plan)
+      def emit_running_event(plan)
         emit_event(plan, :running)
       end
 

data/app/models/concerns/api/v2/hosts_controller_extensions.rb

@@ -0,0 +1,12 @@
+module Api
+  module V2
+    module HostsControllerExtensions
+      extend ActiveSupport::Concern
+      def index_node_permissions
+        super.merge({
+          :can_create_job_invocations => authorized_for(:controller => 'job_invocations', :action => 'create'),
+        })
+      end
+    end
+  end
+end

data/app/views/api/v2/job_invocations/base.json.rabl

@@ -3,7 +3,11 @@ object @job_invocation
 attributes :id, :description, :job_category, :targeting_id, :status, :start_at, :status_label, :ssh_user, :time_to_pickup
 
 node do |invocation|
+  pattern_template = invocation.pattern_template_invocations.first
   {
+    :template_id => pattern_template&.template_id,
+    :template_name => pattern_template&.template_name,
+    :effective_user => pattern_template&.effective_user,
     :succeeded => invocation_count(invocation, :output_key => :success_count),
     :failed    => invocation_count(invocation, :output_key => :failed_count),
     :pending   => invocation_count(invocation, :output_key => :pending_count),
@@ -15,3 +19,13 @@ end
 child :task => :dynflow_task do
   attributes :id, :state
 end
+
+if params.key?(:include_permissions)
+  node :permissions do |invocation|
+    authorizer = Authorizer.new(User.current)
+    edit_job_templates_permission = Permission.where(name: "edit_job_templates", resource_type: "JobTemplate").first
+    {
+      "edit_job_templates" => (edit_job_templates_permission && authorizer.can?("edit_job_templates", invocation, false)),
+    }
+  end
+end

data/config/routes.rb

@@ -22,6 +22,8 @@ Rails.application.routes.draw do
   match 'job_invocations/:id/rerun', to: 'react#index', :via => [:get], as: 'rerun_job_invocation'
   match 'old/job_invocations/new', to: 'job_invocations#new', via: [:get], as: 'form_new_job_invocation'
   match 'old/job_invocations/:id/rerun', to: 'job_invocations#rerun', via: [:get, :post], as: 'form_rerun_job_invocation'
+  match 'experimental/job_invocations_detail/:id', to: 'react#index', :via => [:get], as: 'new_job_invocation_detail'
+
   resources :job_invocations, :only => [:create, :show, :index] do
     collection do
       get 'preview_job_invocations_per_host'

data/db/migrate/20151215114631_add_host_id_to_template_invocation.rb

@@ -9,7 +9,7 @@ class AddHostIdToTemplateInvocation < ActiveRecord::Migration[4.2]
     FakeTemplateInvocation.reset_column_information
 
     say 'Migrating existing execution locks to explicit relations, this may take a while'
-    FakeTemplateInvocation.all.each do |template_invocation|
+    FakeTemplateInvocation.all.find_each do |template_invocation|
       task = ForemanTasks::Task.for_action_types('Actions::RemoteExecution::RunHostJob').joins(:locks).where(
         :'foreman_tasks_locks.resource_type' => 'TemplateInvocation',
         :'foreman_tasks_locks.resource_id' => template_invocation.id

data/db/migrate/20151217092555_migrate_to_task_groups.rb

@@ -5,7 +5,7 @@ class MigrateToTaskGroups < ActiveRecord::Migration[4.2]
 
   def up
     say 'Migrating from locks to task groups'
-    FakeJobInvocation.where('task_group_id IS NULL AND task_id IS NOT NULL').each do |job_invocation|
+    FakeJobInvocation.where('task_group_id IS NULL AND task_id IS NOT NULL').find_each do |job_invocation|
       task_group = JobInvocationTaskGroup.new
       task_group.task_ids = [job_invocation.task_id]
       task_group.save!

data/db/migrate/20160113162007_expand_all_template_invocations.rb

@@ -14,7 +14,7 @@ class ExpandAllTemplateInvocations < ActiveRecord::Migration[4.2]
     FakeTemplateInvocation.update_all 'host_id = NULL'
 
     # expand all pattern template invocations and link RunHostJob
-    JobInvocation.joins(:targeting).where("#{Targeting.table_name}.resolved_at IS NOT NULL").includes([:pattern_template_invocations, :targeting]).each do |job_invocation|
+    JobInvocation.joins(:targeting).where("#{Targeting.table_name}.resolved_at IS NOT NULL").includes([:pattern_template_invocations, :targeting]).find_each do |job_invocation|
       job_invocation.pattern_template_invocations.each do |pattern_template_invocation|
         job_invocation.targeting.hosts.each do |host|
           task = job_invocation.sub_tasks.find do |sub_task|
@@ -38,7 +38,7 @@ class ExpandAllTemplateInvocations < ActiveRecord::Migration[4.2]
 
   def down
     # we can't determine the last host for pattern, but keeping template invocations as pattern is safe
-    JobInvocation.joins(:targeting).where("#{Targeting.table_name}.resolved_at IS NOT NULL").includes(:template_invocations).each do |job_invocation|
+    JobInvocation.joins(:targeting).where("#{Targeting.table_name}.resolved_at IS NOT NULL").includes(:template_invocations).find_each do |job_invocation|
       job_invocation.template_invocations.delete_all
     end
   end

data/db/migrate/20160114125628_rename_job_name_to_job_category.rb

@@ -3,13 +3,13 @@ class RenameJobNameToJobCategory < ActiveRecord::Migration[4.2]
     rename_column :templates, :job_name, :job_category
     rename_column :job_invocations, :job_name, :job_category
     JobTemplate.where(:description_format => '%{job_name} %{command}').update_all(:description_format => 'Run %{command}')
-    JobTemplate.where("description_format LIKE '%\%{job_name}%'").each do |template|
+    JobTemplate.where("description_format LIKE '%\%{job_name}%'").find_each do |template|
       JobTemplate.where(:id => template.id).update_all(:description_format => template.description_format.gsub('%{job_name}', '%{job_category}'))
     end
   end
 
   def down
-    JobTemplate.where("description_format LIKE '%\%{job_category}%'").each do |template|
+    JobTemplate.where("description_format LIKE '%\%{job_category}%'").find_each do |template|
       JobTemplate.where(:id => template.id).update_all(:description_format => template.description_format.gsub('%{job_category}', '%{job_name}'))
     end
     JobTemplate.where(:description_format => 'Run %{command}').update_all(:description_format => '%{job_name} %{command}')

data/db/migrate/20200623073022_rename_sudo_password_to_effective_user_password.rb

@@ -2,7 +2,7 @@ class RenameSudoPasswordToEffectiveUserPassword < ActiveRecord::Migration[6.0]
   def up
     rename_column :job_invocations, :sudo_password, :effective_user_password
 
-    Parameter.where(name: 'remote_execution_sudo_password').each do |parameter|
+    Parameter.where(name: 'remote_execution_sudo_password').find_each do |parameter|
       record = Parameter.find_by(type: parameter.type, reference_id: parameter.reference_id, name: "remote_execution_effective_user_password")
       if record.nil?
         parameter.update(name: "remote_execution_effective_user_password")
@@ -19,7 +19,7 @@ class RenameSudoPasswordToEffectiveUserPassword < ActiveRecord::Migration[6.0]
   def down
     rename_column :job_invocations, :effective_user_password, :sudo_password
 
-    Parameter.where(name: 'remote_execution_effective_user_password').each do |parameter|
+    Parameter.where(name: 'remote_execution_effective_user_password').find_each do |parameter|
       record = Parameter.find_by(type: parameter.type, reference_id: parameter.reference_id, name: "remote_execution_sudo_password")
       if record.nil?
         parameter.update(name: "remote_execution_sudo_password")

data/db/migrate/20220321101835_rename_ssh_provider_to_script.rb

@@ -6,7 +6,7 @@ class RenameSshProviderToScript < ActiveRecord::Migration[6.0]
     setting = Setting.find_by(:name => 'remote_execution_form_job_template')
     default_template = nil
 
-    Template.where(:provider_type => from).each do |t|
+    Template.where(:provider_type => from).find_each do |t|
       default_template = t if t.name == setting&.value
       t.provider_type = to
       t.name = t.name.gsub(from_re, new_label)