foreman_remote_execution 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93860edb8974a0691383b3a199a1a2d079d10401d7780b99aa6275b75125eb58
-  data.tar.gz: d333f8eb85a42b36694dee932447d4364b57ed2c095ad5a055d1e7adf69a9866
+  metadata.gz: 1ed74f64c21956170e95cbab53cd7580205f0620166573980c12efe06e90b960
+  data.tar.gz: 6ca59984908170bc003eb797883bb37c53c5a01a9f5a7bb5a95db2c8242b1fb5
 SHA512:
-  metadata.gz: 70c300e719d6587639719a4d95aa23da2d3f3a16d51692392c789b70cd381b31320789db0f45b57c129e4b90d36bd1a8ddadd29db4f38f2d9e40a39219b1d130
-  data.tar.gz: 1feab0c5cfd3fee6054a004eba812b7257df80a2dce50aa200d15dd20797f24f8a614d802668ac6daf043c189b7caa8e8d5f0d4a997726764c80c91173d9437b
+  metadata.gz: '0588d33348d69b3ecae2b0c50c143f564a8f32fbff548e31b7da2a8b055b2e400784136f4eb98fc4d2d26740d907ced7cb27522856c6fcbf8736cf94fc5e2a93'
+  data.tar.gz: 1069f8025c92c09c3e9c780ae8b5040e8dd15c5a282d76a9195569226b18c0801e5dc533635c804d4f3e377bebcd48501de57abd9141040c6b46b13e7496415b

data/app/controllers/foreman_remote_execution/concerns/api/v2/subnets_controller_extensions.rb

@@ -0,0 +1,21 @@
+module ForemanRemoteExecution
+  module Concerns
+    module Api::V2::SubnetsControllerExtensions
+      module ApiPieExtensions
+        extend ::Apipie::DSL::Concern
+
+        update_api(:create, :update) do
+          param :subnet, Hash do
+            param :remote_execution_proxy_ids, Array, _('List of proxy IDs to be used for remote execution')
+          end
+        end
+      end
+
+      extend ActiveSupport::Concern
+
+      included do
+        include ApiPieExtensions
+      end
+    end
+  end
+end

data/app/helpers/job_invocations_helper.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal:true
 
 module JobInvocationsHelper
-  def minicard(icon, number, text)
+  def minicard(icon, number, text, tooltip: nil)
+    tooltip_options = tooltip ? { :'data-original-title' => tooltip, :rel => 'twipsy' } : {}
     content_tag(:div, :class => 'card-pf card-pf-accented
                 card-pf-aggregate-status card-pf-aggregate-status-mini') do
-      content_tag(:h2, :class => 'card-pf-title', :style => 'line-height: 1.1') do
+      content_tag(:h2, { :class => 'card-pf-title', :style => 'line-height: 1.1' }.merge(tooltip_options)) do
         icon_text(icon, '', :kind => 'pficon') +
         content_tag(:span, number, :class =>'card-pf-aggregate-status-count') +
         text

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

@@ -57,7 +57,8 @@ module Actions
       end
 
       def job_invocation
-        @job_invocation ||= JobInvocation.find(input[:job_invocation_id])
+        id = input[:job_invocation_id] || input.fetch(:job_invocation, {})[:id]
+        @job_invocation ||= JobInvocation.find(id)
       end
 
       def batch(from, size)
@@ -65,7 +66,7 @@ module Actions
       end
 
       def total_count
-        hosts.count
+        output[:total_count] || hosts.count
       end
 
       def hosts

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

@@ -0,0 +1,13 @@
+module Api
+  module V2
+    module InterfacesControllerExtensions
+      extend Apipie::DSL::Concern
+
+      update_api(:create, :update) do
+        param :interface, Hash do
+          param :execution, :bool, :desc => N_('Should this interface be used for remote execution?')
+        end
+      end
+    end
+  end
+end

data/app/models/job_invocation.rb

@@ -173,7 +173,7 @@ class JobInvocation < ApplicationRecord
 
   def total_hosts_count
     if targeting.resolved?
-      targeting.hosts.count
+      task&.main_action&.total_count || targeting.hosts.count
     else
       _('N/A')
     end
@@ -243,6 +243,10 @@ class JobInvocation < ApplicationRecord
     !task.pending?
   end
 
+  def missing_hosts_count
+    targeting.resolved? ? total_hosts_count - targeting.hosts.count : 0
+  end
+
   private
 
   def failed_template_invocations

data/app/views/api/v2/interfaces/execution_flag.json.rabl

@@ -0,0 +1 @@
+attributes :execution

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

@@ -8,6 +8,7 @@ node do |invocation|
     :failed    => invocation_count(invocation, :output_key => :failed_count),
     :pending   => invocation_count(invocation, :output_key => :pending_count),
     :total     => invocation_count(invocation, :output_key => :total_count),
+    :missing   => invocation.missing_hosts_count,
   }
 end
 

data/app/views/api/v2/subnets/remote_execution_proxies.json.rabl

@@ -0,0 +1,3 @@
+child :remote_execution_proxies => :remote_execution_proxies do
+  attributes :name, :id
+end

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

@@ -9,7 +9,19 @@
   <% template_invocations.each do |template_invocation| %>
     <%= minicard('user', template_invocation.effective_user || Setting[:remote_execution_effective_user],
                  template_invocation.template.name + ' ' + _('effective user')) %>
-    <%= minicard('cluster', job_invocation.total_hosts_count, _('Total hosts')) %>
+    <div class="row">
+      <% missing = job_invocation.missing_hosts_count %>
+      <% size = missing.zero? ? 12 : 6 %>
+      <div class="col-xs-12 col-sm-<%= size %> col-md-<%= size %>" >
+        <%= minicard('cluster', job_invocation.total_hosts_count, _('Total hosts')) %>
+      </div>
+      <% unless missing.zero? %>
+      <div class="col-xs-12 col-sm-6 col-md-6" >
+          <%= minicard('warning-triangle-o', missing, _('Hosts gone missing'),
+                       :tooltip => _('This can happen if the host is removed or moved to another organization or location after the job was started')) %>
+      </div>
+    <% end %>
+    </div>
     <% if template_invocation.input_values.present? %>
       <%= render :partial => 'card_user_input', :locals => { :template_invocation => template_invocation } %>
     <% end %>

data/lib/foreman_remote_execution/engine.rb

@@ -32,6 +32,15 @@ module ForemanRemoteExecution
       end
     end
 
+    # A workaround for https://projects.theforeman.org/issues/30685
+    initializer 'foreman_remote_execution.rails_loading_workaround' do
+      # Without this, in production environment the module gets prepended too
+      # late and the extensions do not get applied
+      # TODO: Remove this and from config.to_prepare once there is an extension
+      # point in Foreman
+      ProvisioningTemplatesHelper.prepend ForemanRemoteExecution::JobTemplatesExtensions
+    end
+
     initializer 'foreman_remote_execution.apipie' do
       Apipie.configuration.checksum_path += ['/api/']
     end
@@ -138,6 +147,9 @@ module ForemanRemoteExecution
         end
 
         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'
+        parameter_filter ::Subnet, :remote_execution_proxy_ids
         describe_host { overview_buttons_provider :host_overview_buttons }
       end
     end
@@ -184,6 +196,7 @@ module ForemanRemoteExecution
       SmartProxy.prepend ForemanRemoteExecution::SmartProxyExtensions
       Subnet.include ForemanRemoteExecution::SubnetExtensions
 
+      ::Api::V2::InterfacesController.include Api::V2::InterfacesControllerExtensions
       # We need to explicitly force to load the Task model due to Rails loader
       # having issues with resolving it to Rake::Task otherwise
       require_dependency 'foreman_tasks/task'
@@ -192,6 +205,8 @@ module ForemanRemoteExecution
       RemoteExecutionProvider.register(:SSH, SSHExecutionProvider)
 
       ForemanRemoteExecution.register_rex_feature
+
+      ::Api::V2::SubnetsController.include ::ForemanRemoteExecution::Concerns::Api::V2::SubnetsControllerExtensions
     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.0.0'.freeze
+  VERSION = '4.1.0'.freeze
 end

data/test/unit/actions/run_hosts_job_test.rb

@@ -73,7 +73,7 @@ module ForemanRemoteExecution
     end
 
     it 'triggers the RunHostJob actions on the resolved hosts in run phase' do
-      planned.expects(:output).returns(:planned_count => 0)
+      planned.expects(:output).at_most(5).returns(:planned_count => 0)
       planned.expects(:trigger).with { |*args| args[0] == Actions::RemoteExecution::RunHostJob }
       planned.create_sub_plans
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_remote_execution
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Foreman Remote Execution team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-13 00:00:00.000000000 Z
+date: 2020-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -154,6 +154,7 @@ files:
 - app/controllers/concerns/foreman/controller/parameters/job_template.rb
 - app/controllers/concerns/foreman/controller/parameters/remote_execution_feature.rb
 - app/controllers/concerns/foreman/controller/parameters/targeting.rb
+- app/controllers/foreman_remote_execution/concerns/api/v2/subnets_controller_extensions.rb
 - app/controllers/job_invocations_controller.rb
 - app/controllers/job_templates_controller.rb
 - app/controllers/remote_execution_features_controller.rb
@@ -170,6 +171,7 @@ files:
 - app/lib/foreman_remote_execution/renderer/scope/input.rb
 - app/lib/proxy_api/remote_execution_ssh.rb
 - app/mailers/.gitkeep
+- app/models/concerns/api/v2/interfaces_controller_extensions.rb
 - app/models/concerns/foreman_remote_execution/bookmark_extensions.rb
 - app/models/concerns/foreman_remote_execution/errors_flattener.rb
 - app/models/concerns/foreman_remote_execution/foreman_tasks_cleaner_extensions.rb
@@ -212,6 +214,7 @@ files:
 - app/views/api/v2/foreign_input_sets/index.json.rabl
 - app/views/api/v2/foreign_input_sets/main.json.rabl
 - app/views/api/v2/foreign_input_sets/show.json.rabl
+- app/views/api/v2/interfaces/execution_flag.json.rabl
 - app/views/api/v2/job_invocations/base.json.rabl
 - app/views/api/v2/job_invocations/create.json.rabl
 - app/views/api/v2/job_invocations/index.json.rabl
@@ -228,6 +231,7 @@ files:
 - app/views/api/v2/remote_execution_features/main.json.rabl
 - app/views/api/v2/remote_execution_features/show.json.rabl
 - app/views/api/v2/smart_proxies/pubkey.json.rabl
+- app/views/api/v2/subnets/remote_execution_proxies.json.rabl
 - app/views/api/v2/template_invocations/base.json.rabl
 - app/views/api/v2/template_invocations/template_invocations.json.rabl
 - app/views/dashboard/.gitkeep