foreman_remote_execution 4.3.0 → 4.5.1

data/app/services/renderer_methods.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# macros to fetch information about invoked jobs
+module RendererMethods
+  extend ActiveSupport::Concern
+
+  def find_job_invocation_by_id(job_id, preload: nil)
+    JobInvocation.preload(preload).find_by(id: job_id)
+  rescue ActiveRecord::NotFound => _e
+    raise ::Foreman::Exception.new(N_("Can't find Job Invocation for an id %s"), job_id)
+  end
+end

data/app/views/job_invocations/_form.html.erb

@@ -74,6 +74,14 @@
                     <% end %>
 
                     <div class="advanced hidden">
+                      <%= job_template_fields.fields_for :provider_input_values do |provider_input_fields| %>
+                        <% job_template.provider.provider_inputs.each do |input| %>
+                            <%= provider_input_fields.fields_for input.name, input do |input_fields| %>
+                              <%= template_input_f(input_fields) %>
+                            <% end %>
+                        <% end %>
+                      <% end %>
+
                       <% if job_template.effective_user.overridable? %>
                         <%= text_f job_template_fields, :effective_user, :value => @composer.template_invocation(job_template).try(:effective_user), :label => _('Effective user'), :label_help => N_("A user to be used for executing the script. If it differs from the SSH user, su or sudo is used to switch the accounts.") %>
                       <% end %>

data/app/views/job_invocations/index.html.erb

@@ -21,7 +21,7 @@
     <% @job_invocations.each do |invocation| %>
       <tr>
         <td class="text_warp"><%= link_to_if_authorized invocation_description(invocation), hash_for_job_invocation_path(invocation).merge(:auth_object => invocation, :permission => :view_job_invocations, :authorizer => authorizer) %></td>
-        <td><%= trunc_with_tooltip(invocation&.targeting&.search_query, 15) %></td>
+        <td><%= trunc_with_tooltip(invocation.targeting.search_query, 15) %></td>
         <td><%= link_to_invocation_task_if_authorized(invocation) %></td>
         <td><%= invocation_result(invocation, :success_count) %></td>
         <td><%= invocation_result(invocation, :failed_count) %></td>

data/config/routes.rb

@@ -44,6 +44,7 @@ Rails.application.routes.draw do
   end
   get 'cockpit/redirect', to: 'cockpit#redirect'
   get 'ui_job_wizard/categories', to: 'ui_job_wizard#categories'
+  get 'ui_job_wizard/template/:id', to: 'ui_job_wizard#template'
 
   match '/experimental/job_wizard', to: 'react#index', :via => [:get]
 

data/db/migrate/20180110104432_rename_template_invocation_permission.rb

@@ -16,7 +16,7 @@ class RenameTemplateInvocationPermission < ActiveRecord::Migration[4.2]
     return if old_permission.nil?
 
     new_permission = Permission.find_or_create_by(:name => new,
-                                                  :resource_type => 'TemplateInvocation')
+      :resource_type => 'TemplateInvocation')
     old_permission.filterings.each do |filtering|
       filtering.permission_id = new_permission.id
       filtering.save!

data/db/migrate/20190111153330_remove_remote_execution_without_proxy_setting.rb

@@ -5,9 +5,9 @@ class RemoveRemoteExecutionWithoutProxySetting < ActiveRecord::Migration[5.2]
 
   def down
     Setting.create!(:name => 'remote_execution_without_proxy',
-                    :description => N_('When enabled, the remote execution will try to run '\
-                                       'the commands directly, when no proxy with remote execution '\
-                                       'feature is configured for the host.'),
-                    :default => false, :full_name => N_('Fallback Without Proxy'))
+      :description => N_('When enabled, the remote execution will try to run '\
+                         'the commands directly, when no proxy with remote execution '\
+                         'feature is configured for the host.'),
+      :default => false, :full_name => N_('Fallback Without Proxy'))
   end
 end

data/db/migrate/20210312074713_add_provider_inputs.rb

@@ -0,0 +1,10 @@
+class AddProviderInputs < ActiveRecord::Migration[6.0]
+  def change
+    create_table :invocation_provider_input_values do |t|
+      t.references :template_invocation, :null => false, :index => { :name => 'idx_inv_provider_input_values_on_templ_inv_id' }
+      t.string :value, :null => false, :limit => 255
+      t.string :name, :null => false, :limit => 255
+      t.timestamps
+    end
+  end
+end

data/db/migrate/2021051713291621250977_add_host_proxy_invocations.rb

@@ -0,0 +1,12 @@
+class AddHostProxyInvocations < ActiveRecord::Migration[6.0]
+  def change
+    # rubocop:disable Rails/CreateTableWithTimestamps
+    create_table :host_proxy_invocations do |t|
+      t.references :host, :null => false
+      t.references :smart_proxy, :null => false
+    end
+    # rubocop:enable Rails/CreateTableWithTimestamps
+
+    add_index :host_proxy_invocations, [:host_id, :smart_proxy_id], unique: true
+  end
+end

data/extra/cockpit/foreman-cockpit-session

@@ -56,13 +56,13 @@ end
 
 def send_auth_challenge(challenge)
   send_control({ "command" => "authorize",
-                 "cookie" => "1234", # must be present, but value doesn't matter
-                 "challenge" => challenge})
+    "cookie" => "1234", # must be present, but value doesn't matter
+    "challenge" => challenge})
 end
 
 def send_auth_response(response)
   send_control({ "command" => "authorize",
-                 "response" => response})
+    "response" => response})
 end
 
 def read_auth_reply
@@ -76,9 +76,9 @@ end
 def exit_with_problem(problem, message, auth_methods)
   LOG.error("#{problem} - #{message}")
   send_control({ "command" => "init",
-                 "problem" => problem,
-                 "message" => message,
-                 "auth-method-results" => auth_methods})
+    "problem" => problem,
+    "message" => message,
+    "auth-method-results" => auth_methods})
   exit 1
 end
 

data/foreman_remote_execution.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'deface'
   s.add_dependency 'dynflow', '>= 1.0.2', '< 2.0.0'
   s.add_dependency 'foreman_remote_execution_core'
-  s.add_dependency 'foreman-tasks', '>= 4.0.0'
+  s.add_dependency 'foreman-tasks', '>= 4.1.0'
 
   s.add_development_dependency 'factory_bot_rails', '~> 4.8.0'
   s.add_development_dependency 'rdoc'

data/lib/foreman_remote_execution/engine.rb

@@ -1,5 +1,3 @@
-require 'foreman_remote_execution_core'
-
 module ForemanRemoteExecution
   DYNFLOW_QUEUE = :remote_execution
 
@@ -53,14 +51,13 @@ module ForemanRemoteExecution
 
     initializer 'foreman_remote_execution.register_plugin', before: :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_remote_execution do
-        register_global_js_file 'global'
         requires_foreman '>= 2.2'
+        register_global_js_file 'global'
 
         apipie_documented_controllers ["#{ForemanRemoteExecution::Engine.root}/app/controllers/api/v2/*.rb"]
         ApipieDSL.configuration.dsl_classes_matchers += [
           "#{ForemanRemoteExecution::Engine.root}/app/lib/foreman_remote_execution/renderer/**/*.rb",
         ]
-
         automatic_assets(false)
         precompile_assets(*assets_to_precompile)
 
@@ -70,7 +67,7 @@ module ForemanRemoteExecution
                                             :'api/v2/job_templates' => [:index, :show, :revision, :export],
                                             :'api/v2/template_inputs' => [:index, :show],
                                             :'api/v2/foreign_input_sets' => [:index, :show],
-                                            :ui_job_wizard => [:categories]}, :resource_type => 'JobTemplate'
+                                            :ui_job_wizard => [:categories, :template]}, :resource_type => 'JobTemplate'
           permission :create_job_templates, { :job_templates => [:new, :create, :clone_template, :import],
                                               :'api/v2/job_templates' => [:create, :clone, :import] }, :resource_type => 'JobTemplate'
           permission :edit_job_templates, { :job_templates => [:edit, :update],
@@ -143,7 +140,7 @@ module ForemanRemoteExecution
           url_hash: { controller: 'job_wizard', action: :index },
           caption: N_('Job wizard'),
           parent: :lab_features_menu,
-          url: 'experimental/job_wizard',
+          url: '/experimental/job_wizard',
           after: :host_wizard
 
         register_custom_status HostStatus::ExecutionStatus
@@ -155,6 +152,8 @@ module ForemanRemoteExecution
           ctx.permit :execution
         end
 
+        extend_template_helpers ForemanRemoteExecution::RendererMethods
+
         extend_rabl_template 'api/v2/smart_proxies/main', 'api/v2/smart_proxies/pubkey'
         extend_rabl_template 'api/v2/interfaces/main', 'api/v2/interfaces/execution_flag'
         extend_rabl_template 'api/v2/subnets/show', 'api/v2/subnets/remote_execution_proxies'
@@ -163,11 +162,15 @@ module ForemanRemoteExecution
 
         # Extend Registration module
         extend_allowed_registration_vars :remote_execution_interface
-        extend_page 'registration/_form' do |cx|
-          cx.add_pagelet :global_registration, name: N_('Remote Execution'), partial: 'api/v2/registration/form', priority: 100, id: 'remote_execution_interface'
-        end
         ForemanTasks.dynflow.eager_load_actions!
-        extend_observable_events(::Dynflow::Action.descendants.select { |klass| klass <= ::Actions::ObservableAction }.map(&:namespaced_event_names))
+        extend_observable_events(
+          ::Dynflow::Action.descendants.select do |klass|
+            klass <= ::Actions::ObservableAction
+          end.map(&:namespaced_event_names) +
+          RemoteExecutionFeature.all.pluck(:label).map do |label|
+            ::Actions::RemoteExecution::RunHostJob.feature_job_event_name(label)
+          end
+        )
       end
     end
 
@@ -198,12 +201,10 @@ module ForemanRemoteExecution
 
       Host::Managed.prepend ForemanRemoteExecution::HostExtensions
       Host::Managed.include ForemanTasks::Concerns::HostActionSubject
-      Host::Managed.include ForemanRemoteExecution::Orchestration::SSH
 
       (Nic::Base.descendants + [Nic::Base]).each do |klass|
         klass.send(:include, ForemanRemoteExecution::NicExtensions)
       end
-      Nic::Managed.include ForemanRemoteExecution::Orchestration::SSH
 
       Bookmark.include ForemanRemoteExecution::BookmarkExtensions
       HostsHelper.prepend ForemanRemoteExecution::HostsHelperExtensions
@@ -226,6 +227,7 @@ module ForemanRemoteExecution
       ::Api::V2::SubnetsController.include ::ForemanRemoteExecution::Concerns::Api::V2::SubnetsControllerExtensions
       ::Api::V2::RegistrationController.prepend ::ForemanRemoteExecution::Concerns::Api::V2::RegistrationControllerExtensions
       ::Api::V2::RegistrationController.include ::ForemanRemoteExecution::Concerns::Api::V2::RegistrationControllerExtensions::ApipieExtensions
+      ::Api::V2::RegistrationCommandsController.include ::ForemanRemoteExecution::Concerns::Api::V2::RegistrationCommandsControllerExtensions::ApipieExtensions
     end
 
     initializer 'foreman_remote_execution.register_gettext', after: :load_config_initializers do |_app|

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '4.3.0'.freeze
+  VERSION = '4.5.1'.freeze
 end

data/lib/tasks/foreman_remote_execution_tasks.rake

@@ -20,26 +20,9 @@ namespace :test do
   end
 end
 
-namespace :foreman_remote_execution do
-  task :rubocop do
-    begin
-      require 'rubocop/rake_task'
-      RuboCop::RakeTask.new(:rubocop_foreman_remote_execution) do |task|
-        task.patterns = ["#{ForemanRemoteExecution::Engine.root}/app/**/*.rb",
-                         "#{ForemanRemoteExecution::Engine.root}/lib/**/*.rb",
-                         "#{ForemanRemoteExecution::Engine.root}/test/**/*.rb"]
-      end
-    rescue
-      puts 'Rubocop not loaded.'
-    end
-
-    Rake::Task['rubocop_foreman_remote_execution'].invoke
-  end
-end
-
 Rake::Task[:test].enhance ['test:foreman_remote_execution']
 
 load 'tasks/jenkins.rake'
 if Rake::Task.task_defined?(:'jenkins:unit')
-  Rake::Task['jenkins:unit'].enhance ['test:foreman_remote_execution', 'foreman_remote_execution:rubocop']
+  Rake::Task['jenkins:unit'].enhance ['test:foreman_remote_execution']
 end

data/locale/action_names.rb

@@ -1,4 +1,5 @@
 # Autogenerated!
+_("Preupgrade job")
 _("Action with sub plans")
 _("Import facts")
 _("Import Puppet classes")

data/locale/de/foreman_remote_execution.po

@@ -27,6 +27,11 @@ msgstr "vor %s"
 msgid "%{description} on %{host}"
 msgstr "%{description} auf %{host}"
 
+msgid "...and %{count} more"
+msgid_plural "...and %{count} more"
+msgstr[0] ""
+msgstr[1] ""
+
 msgid "A comma separated list of input names to be excluded from the foreign template."
 msgstr "Kommagetrennte Liste von Eingabenamen, die aus der Fremdvorlage auszuschließen ist"
 
@@ -54,6 +59,12 @@ msgstr "Aktionen"
 msgid "Add Foreign Input Set"
 msgstr "Fremdeingabe-Satz hinzufügen"
 
+msgid "Advanced fields"
+msgstr ""
+
+msgid "All fields are required."
+msgstr ""
+
 msgid "Alphabetical"
 msgstr ""
 
@@ -96,6 +107,12 @@ msgstr "bookmark_id und search_query konnte nicht angegeben werden"
 msgid "Cannot specify both recurrence and scheduling"
 msgstr "Wiederholung und Planung konnten nicht angegeben werden"
 
+msgid "Category And Template"
+msgstr ""
+
+msgid "Category and template"
+msgstr ""
+
 msgid "Choose a job template that is pre-selected in job invocation form"
 msgstr ""
 
@@ -126,6 +143,9 @@ msgstr ""
 msgid "Control concurrency level and distribution over time"
 msgstr "Parallelitätsebene und zeitliche Verteilung steuern"
 
+msgid "Could not display data for job invocation."
+msgstr ""
+
 msgid "Could not find any suitable interface for execution"
 msgstr ""
 
@@ -228,6 +248,12 @@ msgstr " Effektive Benutzer-Methode \"%{current_value}\" ist keine %{valid_metho
 msgid "Effective user options"
 msgstr "Effektive Benutzeroptionen"
 
+msgid "Effective user password"
+msgstr ""
+
+msgid "Effective user password is only applicable for SSH provider. Other providers ignore this field. <br> Password is stored encrypted in DB until the job finishes. For future or recurring executions, it is removed after the last execution."
+msgstr ""
+
 msgid "Enable Global Proxy"
 msgstr ""
 
@@ -264,18 +290,12 @@ msgstr "Fehlgeschlagen"
 msgid "Failed rendering template: %s"
 msgstr "Rendern der Vorlage fehlgeschlagen: %s"
 
-msgid "Fallback Without Proxy"
-msgstr ""
-
 msgid "Fallback to Any Proxy"
 msgstr ""
 
 msgid "Feature input %{input_name} not defined in template %{template_name}"
 msgstr "Funktionseingabe %{input_name} nicht definiert in Vorlage %{template_name}"
 
-msgid "Filter"
-msgstr "Filter"
-
 msgid "Foreign input set"
 msgstr "Fremdeingabe-Satz"
 
@@ -288,6 +308,9 @@ msgstr ""
 msgid "Get output for a host"
 msgstr "Ausgabe für einen Host abfragen"
 
+msgid "Get outputs of hosts in a job"
+msgstr ""
+
 msgid "Get raw output for a host"
 msgstr ""
 
@@ -306,9 +329,15 @@ msgstr ""
 msgid "Host with id '%{id}' was not found"
 msgstr "Host mit ID '%{id}' nicht gefunden"
 
+msgid "Hosts gone missing"
+msgstr ""
+
 msgid "How often the job should occur, in the cron format"
 msgstr "Wie oft der Job auftreten soll, in Cron-Format"
 
+msgid "Identifier of the Host interface for Remote execution"
+msgstr ""
+
 msgid "Import"
 msgstr "Import"
 
@@ -336,6 +365,12 @@ msgstr "Beschreibung des Eingabe-Satzes"
 msgid "Inputs to use"
 msgstr "Zu verwendende Eingaben"
 
+msgid "Interface with the '%s' identifier was specified as a remote execution interface, however the interface was not found on the host. If the interface exists, it needs to be created in Foreman during the registration."
+msgstr ""
+
+msgid "Internal proxy selector can only be used if Katello is enabled"
+msgstr ""
+
 msgid "Invocation type, one of %s"
 msgstr "Jobtyp, einer von %s"
 
@@ -387,6 +422,9 @@ msgstr "Job-Vorlage erfolgreich importiert"
 msgid "Job templates"
 msgstr "Job-Vorlagen"
 
+msgid "Job wizard"
+msgstr ""
+
 msgid "JobTemplate|Locked"
 msgstr "Gesperrt"
 
@@ -432,6 +470,9 @@ msgstr "Job-Vorlagen pro Standort auflisten"
 msgid "List job templates per organization"
 msgstr "Job-Vorlagen pro Organisation auflisten"
 
+msgid "List of proxy IDs to be used for remote execution"
+msgstr ""
+
 msgid "List remote execution features"
 msgstr "Entfernte Ausführungsfunktionen auflisten"
 
@@ -459,6 +500,9 @@ msgstr "Neue Job-Vorlage"
 msgid "No execution finished yet"
 msgstr "Noch keine Ausführung abgeschlossen"
 
+msgid "No hosts found."
+msgstr ""
+
 msgid "No template mapped to feature %{feature_name}"
 msgstr "Der Funktion %{feature_name} wurde keine Vorlage zugewiesen"
 
@@ -503,6 +547,9 @@ msgstr ""
 "Port für die Verwendung von SSH Kommunikation. Standardport 22. \n"
 "Sie können diese Einstellung pro Host mit dem Parameter remote_execution_ssh_port überschreiben."
 
+msgid "Preupgrade job"
+msgstr ""
+
 msgid "Preview"
 msgstr "Vorschau"
 
@@ -542,6 +589,9 @@ msgstr "Entfernte Ausführung"
 msgid "Remote Execution Features"
 msgstr "Entfernte Ausführungsfunktionen "
 
+msgid "Remote Execution Interface"
+msgstr ""
+
 msgid "Remote action:"
 msgstr "Entfernte Aktion"
 
@@ -581,6 +631,9 @@ msgstr "Wird aufgelöst zu"
 msgid "Results"
 msgstr ""
 
+msgid "Review details"
+msgstr ""
+
 msgid "Run"
 msgstr "Ausführen"
 
@@ -596,6 +649,9 @@ msgstr "Höchstens n Aufgaben gleichzeitig ausführen"
 msgid "Run at most N tasks at a time. If this is set and proxy batch triggering is enabled, then tasks are triggered on the smart proxy in batches of size 1."
 msgstr ""
 
+msgid "Run job"
+msgstr ""
+
 msgid "SSH"
 msgstr "SSH"
 
@@ -632,9 +688,6 @@ msgstr "Zum Ende scrollen"
 msgid "Scroll to top"
 msgstr "Zum Anfang scrollen"
 
-msgid "Search"
-msgstr "Suchen"
-
 msgid "Search Query"
 msgstr ""
 
@@ -662,6 +715,12 @@ msgstr ""
 msgid "Should the ip addresses on host interfaces be preferred over the fqdn? It is useful when DNS not resolving the fqdns properly. You may override this per host by setting a parameter called remote_execution_connect_by_ip. This setting only applies to IPv4. When the host has only an IPv6 address on the interface used for remote execution, hostname will be used even if this setting is set to true."
 msgstr ""
 
+msgid "Should this interface be used for remote execution?"
+msgstr ""
+
+msgid "Show Job status for the hosts"
+msgstr ""
+
 msgid "Show foreign input set details"
 msgstr " Details zu Fremdeingabe-Satz anzeigen"
 
@@ -692,12 +751,6 @@ msgstr "Erfolgreich"
 msgid "Success"
 msgstr "Erfolg"
 
-msgid "Sudo password"
-msgstr ""
-
-msgid "Sudo password is only applicable for SSH provider. Other providers ignore this field. <br> Password is stored encrypted in DB until the job finishes. For future or recurring executions, it is removed after the last execution."
-msgstr ""
-
 msgid "Sync Job Templates"
 msgstr ""
 
@@ -763,6 +816,9 @@ msgstr "Der Benutzer kann auf die Vorlage %{template_name}, die der Funktion %{f
 msgid "There was an error while updating the status, try refreshing the page."
 msgstr "Beim Status-Update ist ein Fehler aufgetreten, versuchen Sie die Seite zu aktualisieren."
 
+msgid "This can happen if the host is removed or moved to another organization or location after the job was started"
+msgstr ""
+
 msgid "This template is locked for editing."
 msgstr "Diese Vorlage ist schreibgeschützt."
 
@@ -889,9 +945,6 @@ msgstr "Welcher Benutzer zur Ausführung des Skripts verwendet werden soll (mitt
 msgid "What user should be used to run the script (using sudo-like mechanisms). Defaults to a template parameter or global setting."
 msgstr "Welcher Benutzer zur Ausführung des Skripts (mittels sudo-ähnlichen Mechanismen) verwendet werden soll. Standardmäßig wird ein Vorlagenparameter oder eine allgemeine Einstellung verwendet."
 
-msgid "When enabled, the remote execution will try to run the commands directly, when no proxy with remote execution feature is configured for the host."
-msgstr ""
-
 msgid "When enabled, working directories will be removed after task completion. You may override this per host by setting a parameter called remote_execution_cleanup_working_dirs."
 msgstr ""
 
@@ -925,9 +978,15 @@ msgstr "Eingabe-Satz für diese Vorlage hinzufügen, um auf andere Vorlage-Einga
 msgid "cancelled"
 msgstr "abgebrochen"
 
+msgid "default_capsule method missing from SmartProxy"
+msgstr ""
+
 msgid "effective user"
 msgstr ""
 
+msgid "error"
+msgstr ""
+
 msgid "error during rendering: %s"
 msgstr "Fehler beim Rendern: %s"
 
@@ -952,9 +1011,6 @@ msgstr "enthaltene Vorlage '%s' nicht gefunden"
 msgid "input macro with name '%s' used, but no input with such name defined for this template"
 msgstr "Es wurde ein Eingabe-Macro namens '%s' verwendet, aber es wurde keine Eingabe mit diesem Namen für diese Vorlage definiert"
 
-msgid "planned"
-msgstr "geplant"
-
 msgid "queued"
 msgstr "in der Warteschlange"
 
@@ -964,9 +1020,6 @@ msgstr ""
 msgid "remove template input set"
 msgstr "Vorlageneingabe-Satz entfernen"
 
-msgid "running"
-msgstr "wird ausgeführt"
-
 msgid "running %{percent}%%"
 msgstr "wird ausgeführt %{percent}%%"
 
@@ -976,9 +1029,6 @@ msgstr "Sekunden"
 msgid "succeeded"
 msgstr "erfolgreich"
 
-msgid "success"
-msgstr "erfolgreich"
-
 msgid "tasks at a time"
 msgstr ""