foreman_remote_execution 3.3.0 → 3.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d00f4722f74258ad947432c2d8104522d3fb53749f7bac4e7c52914862af3ecc
-  data.tar.gz: 187645d51578339523b94fb83fe781cba865477a616c2d8c0980255be1fd0377
+  metadata.gz: 6add16b63c650250f993954c92620863d9904055d4b175fa76b04b97dd70ee92
+  data.tar.gz: 7fca35b0b17e7f2ad0f5769fae4f56b0d5e6f0c85b9ebcc8abab29858bf585a5
 SHA512:
-  metadata.gz: 04c6a44e96bb03d75310d7dd48acd249503f04778c62f520d1101bf4719d195c2cd4d11e9a6ae63c97e24d8cbd50884dd090ec56a54aff933ee19f3379bbeec1
-  data.tar.gz: 165ba49b54b18ed4128c7b72a53ef52fea60f6f9a619ee7bd0a22545910cf68997b763e27f3569892b20dd528e70236c44b241c1d1b6c5fcec15a5a21f76af7e
+  metadata.gz: 359e21b88b85d45b1c4faef9a7e841b0c34e008d3e818c111eba4079167683ff6c59e1354f2f2aafc18e7be43c93c00c368eb9d331636d6c3103d6c59f637306
+  data.tar.gz: 17aa0693af9ec50fca1a97e4e685c914a665edfe78cf0d9a87b17a9c683490ad7b151748c36adb9b9bcb50389afaca533065d4590d23f2b7550eddad8017538c

data/.github/workflows/ci.yml

@@ -0,0 +1,101 @@
+name: CI
+on: [pull_request]
+env:
+  RAILS_ENV: test
+  DATABASE_URL: postgresql://postgres:@localhost/test
+  DATABASE_CLEANER_ALLOW_REMOTE_DATABASE_URL: true
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - name: Setup
+        run: |
+          gem install bundler
+          bundle install --jobs=3 --retry=3
+      - name: Run rubocop
+        run: bundle exec rubocop
+  test_ruby:
+    runs-on: ubuntu-latest
+    needs: rubocop
+    services:
+      postgres:
+        image: postgres:12.1
+        ports: ['5432:5432']
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+    strategy:
+      fail-fast: false
+      matrix:
+        foreman-core-branch: [2.1-stable, develop]
+        ruby-version: [2.5, 2.6]
+        node-version: [12]
+    steps:
+      - run: sudo apt-get update
+      - run: sudo apt-get install build-essential libcurl4-openssl-dev zlib1g-dev libpq-dev
+      - uses: actions/checkout@v2
+        with:
+          repository: theforeman/foreman
+          ref: ${{ matrix.foreman-core-branch }}
+      - uses: actions/checkout@v2
+        with:
+          path: foreman_remote_execution
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version:  ${{ matrix.node-version }}
+      - uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-fgems-${{ matrix.ruby-version }}-${{ hashFiles('Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-fgems-${{ matrix.ruby-version }}-
+      - name: Setup Bundler
+        run: |
+          echo "gem 'foreman_remote_execution', path: './foreman_remote_execution'" > bundler.d/foreman_remote_execution.local.rb
+          gem install bundler
+          bundle config set without journald development console libvirt
+          bundle config set path vendor/bundle
+      - name: Prepare test env
+        run: |
+          bundle install --jobs=3 --retry=3
+          bundle exec rake db:create
+          bundle exec rake db:migrate
+      - name: Run plugin tests
+        run: |
+          bundle exec rake test:foreman_remote_execution
+          bundle exec rake test TEST="test/unit/foreman/access_permissions_test.rb"
+  test_js:
+    runs-on: ubuntu-latest
+    needs: rubocop
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: [2.6]
+        node-version: [10, 12]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version:  ${{ matrix.node-version }}
+      - name: Nmp install
+        run: |
+          npm install
+      - name: Run plugin linter
+        run: |
+          npm run lint
+      - name: Run plugin tests
+        run: |
+          npm run test

data/.rubocop_todo.yml

@@ -6,6 +6,9 @@
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+Minitest/GlobalExpectations:
+  Enabled: false
+
 # Offense count: 2
 # Cop supports --auto-correct.
 # Configuration parameters: TreatCommentsAsGroupSeparators, Include.

data/Gemfile

@@ -2,6 +2,7 @@ source 'http://rubygems.org'
 
 gemspec :name => 'foreman_remote_execution'
 
+gem 'rubocop', '~> 0.80.0'
 gem 'rubocop-minitest'
 gem 'rubocop-performance'
 gem 'rubocop-rails'

data/app/assets/stylesheets/foreman_remote_execution/job_invocations.scss

@@ -1,9 +1,6 @@
-div.infoblock {
-  margin-bottom: 20px;
-  line-height: 2;
-
+.target-hosts-card {
   pre {
-    margin-top: 5px;
+    white-space:pre-line;
   }
 }
 
@@ -29,3 +26,7 @@ div.infoblock {
     }
   }
 }
+
+.text_warp{
+  word-wrap: break-word;
+}

data/app/controllers/api/v2/job_invocations_controller.rb

@@ -18,7 +18,17 @@ module Api
 
       api :GET, '/job_invocations/:id', N_('Show job invocation')
       param :id, :identifier, :required => true
+      param :host_status, :bool, required: false, desc: N_('Show Job status for the hosts')
       def show
+        @hosts = @job_invocation.targeting.hosts.authorized(:view_hosts, Host)
+        @template_invocations = @job_invocation.template_invocations
+                                               .where(host: @hosts)
+                                               .includes(:input_values)
+
+        if params[:host_status] == 'true'
+          template_invocations = @template_invocations.includes(:run_host_job_task).to_a
+          @host_statuses = Hash[template_invocations.map { |ti| [ti.host_id, template_invocation_status(ti)] }]
+        end
       end
 
       def_param_group :job_invocation do
@@ -70,6 +80,7 @@ module Api
         end
         composer.trigger!
         @job_invocation = composer.job_invocation
+        @hosts = @job_invocation.targeting.hosts
         process_response @job_invocation
       end
 
@@ -146,7 +157,7 @@ module Api
       end
 
       def find_host
-        @host = Host.authorized(:view_hosts).find(params['host_id'])
+        @host = @nested_obj.targeting.hosts.authorized(:view_hosts, Host).find(params['host_id'])
       rescue ActiveRecord::RecordNotFound
         not_found({ :error => { :message => (_("Host with id '%{id}' was not found") % { :id => params['host_id'] }) } })
       end
@@ -204,6 +215,17 @@ module Api
       def parent_scope
         resource_class.where(nil)
       end
+
+      def template_invocation_status(template_invocation)
+        task = template_invocation.try(:run_host_job_task)
+        parent_task = @job_invocation.task
+
+        return(parent_task.result == 'cancelled' ? 'cancelled' : 'N/A') if task.nil?
+        return task.state if task.state == 'running' || task.state == 'planned'
+        return 'error' if task.result == 'warning'
+
+        task.result
+      end
     end
   end
 end

data/app/controllers/api/v2/template_invocations_controller.rb

@@ -26,7 +26,10 @@ module Api
       private
 
       def resource_scope_for_template_invocations
-        @job_invocation.template_invocations.search_for(*search_options)
+        @job_invocation.template_invocations
+                       .includes(:host)
+                       .where(host: Host.authorized(:view_hosts, Host))
+                       .search_for(*search_options)
       end
 
       def find_job_invocation

data/app/helpers/job_invocations_helper.rb

@@ -29,7 +29,7 @@ module JobInvocationsHelper
   end
 
   def preview_hosts(template_invocation)
-    hosts = template_invocation.targeting.hosts.take(20)
+    hosts = template_invocation.targeting.hosts.authorized(:view_hosts, Host).take(20)
     hosts.map do |host|
       collapsed_preview(host) +
         render(:partial => 'job_invocations/user_input',

data/app/helpers/remote_execution_helper.rb

@@ -14,43 +14,35 @@ module RemoteExecutionHelper
   end
 
   def template_invocation_status(task, parent_task)
-    if task.nil?
-      if parent_task.result == 'cancelled'
-        icon_text('warning-triangle-o', _('cancelled'), :kind => 'pficon')
-      else
-        icon_text('question', 'N/A', :kind => 'fa')
-      end
-    elsif task.state == 'running'
-      icon_text('running', _('running'), :kind => 'pficon')
-    elsif task.state == 'planned'
-      icon_text('build', _('planned'), :kind => 'pficon')
-    else
-      case task.result
-        when 'warning', 'error'
-          icon_text('error-circle-o', _('failed'), :kind => 'pficon')
-        when 'cancelled'
-          icon_text('warning-triangle-o', _('cancelled'), :kind => 'pficon')
-        when 'success'
-          icon_text('ok', _('success'), :kind => 'pficon')
-        else
-          task.result
-      end
-    end
+    return(parent_task.result == 'cancelled' ? _('cancelled') : 'N/A') if task.nil?
+    return task.state if task.state == 'running' || task.state == 'planned'
+    return _('error') if task.result == 'warning'
+
+    task.result
   end
 
   def template_invocation_actions(task, host, job_invocation, template_invocation)
+    links = []
     host_task = template_invocation.try(:run_host_job_task)
-    [
-      display_link_if_authorized(_('Host detail'), hash_for_host_path(host).merge(:auth_object => host, :permission => :view_hosts, :authorizer => job_hosts_authorizer)),
-      display_link_if_authorized(_('Rerun on %s') % host.name, hash_for_rerun_job_invocation_path(:id => job_invocation, :host_ids => [ host.id ], :authorizer => job_hosts_authorizer)),
-      if host_task.present?
-        display_link_if_authorized(
-          _('Host task'),
-          hash_for_foreman_tasks_task_path(host_task)
-          .merge(:auth_object => host_task, :permission => :view_foreman_tasks)
-        )
-      end,
-    ]
+
+    if authorized_for(hash_for_host_path(host).merge(auth_object: host, permission: :view_hosts, authorizer: job_hosts_authorizer))
+      links << { title: _('Host detail'),
+                 action: { href: host_path(host), 'data-method': 'get', id: "#{host.name}-actions-detail" } }
+    end
+
+    if authorized_for(hash_for_rerun_job_invocation_path(id: job_invocation, host_ids: [ host.id ], authorizer: job_hosts_authorizer))
+      links << { title: (_('Rerun on %s') % host.name),
+                 action: { href: rerun_job_invocation_path(job_invocation, host_ids: [ host.id ]),
+                           'data-method': 'get', id: "#{host.name}-actions-rerun" } }
+    end
+
+    if host_task.present? && authorized_for(hash_for_foreman_tasks_task_path(host_task).merge(auth_object: host_task, permission: :view_foreman_tasks))
+      links << { title: _('Host task'),
+                 action: { href: foreman_tasks_task_path(host_task),
+                           'data-method': 'get', id: "#{host.name}-actions-task" } }
+    end
+
+    links
   end
 
   def remote_execution_provider_for(template_invocation)
@@ -237,4 +229,17 @@ module RemoteExecutionHelper
 
     task.execution_plan.actions[1].try(:input).try(:[], 'script')
   end
+
+  def targeting_hosts(job_invocation, hosts)
+    hosts.map do |host|
+      template_invocation = job_invocation.template_invocations.find { |template_inv| template_inv.host_id == host.id }
+      task = template_invocation.try(:run_host_job_task)
+      link_authorized = !task.nil? && authorized_for(hash_for_template_invocation_path(:id => template_invocation).merge(:auth_object => host, :permission => :view_hosts, :authorizer => job_hosts_authorizer))
+
+      { name: host.name,
+        link: link_authorized ? template_invocation_path(:id => template_invocation) : '',
+        status: template_invocation_status(task, job_invocation.task),
+        actions: template_invocation_actions(task, host, job_invocation, template_invocation) }
+    end
+  end
 end

data/app/models/concerns/foreman_remote_execution/host_extensions.rb

@@ -49,7 +49,7 @@ module ForemanRemoteExecution
       keys = remote_execution_ssh_keys
       source = 'global'
       if keys.present?
-        value, safe_value = params.fetch('remote_execution_ssh_keys', {}).values_at(:value, :safe_value).map { |v| v || [] }
+        value, safe_value = params.fetch('remote_execution_ssh_keys', {}).values_at(:value, :safe_value).map { |v| [v].flatten.compact }
         params['remote_execution_ssh_keys'] = {:value => value + keys, :safe_value => safe_value + keys, :source => source}
       end
       [:remote_execution_ssh_user, :remote_execution_effective_user_method,

data/app/models/concerns/foreman_remote_execution/orchestration/ssh.rb

@@ -8,14 +8,20 @@ module ForemanRemoteExecution
       register_rebuild(:queue_ssh_destroy, N_("SSH_#{self.to_s.split('::').first}"))
     end
 
-    def drop_from_known_hosts(args)
-      proxy_id, target = args
+    def drop_from_known_hosts(proxy_id)
+      _, _, target = host_kind_target
+      return true if target.nil?
+
       proxy = ::SmartProxy.find(proxy_id)
       begin
         proxy.drop_host_from_known_hosts(target)
-      rescue RestClient::ResourceNotFound => e
-        # ignore 404 when known_hosts entry is missing or the module was not enabled
-        Foreman::Logging.exception "Proxy failed to delete SSH known_hosts for #{name}, #{ip}", e, :level => :error
+      rescue ::ProxyAPI::ProxyException => e
+        if e.wrapped_exception.is_a?(RestClient::NotFound)
+          # ignore 404 when known_hosts entry is missing or the module was not enabled
+          Foreman::Logging.exception "Proxy failed to delete SSH known_hosts for #{name}, #{ip}", e, :level => :error
+        else
+          raise e
+        end
       rescue => e
         Rails.logger.warn e.message
         return false
@@ -26,11 +32,14 @@ module ForemanRemoteExecution
     def ssh_destroy
       logger.debug "Scheduling SSH known_hosts cleanup"
 
-      host, _kind, target = host_kind_target
-      proxies = host.remote_execution_proxies('SSH').values
+      host, _kind, _target = host_kind_target
+      # #remote_execution_proxies may not be defined on the host object in some case
+      # for example Host::Discovered does not have it defined, even though these hosts
+      # have Nic::Managed interfaces associated with them
+      proxies = (host.try(:remote_execution_proxies, 'SSH') || {}).values
       proxies.flatten.uniq.each do |proxy|
         queue.create(id: queue_id(proxy.id), name: _("Remove SSH known hosts for %s") % self,
-          priority: 200, action: [self, :drop_from_known_hosts, [proxy.id, target]])
+          priority: 200, action: [self, :drop_from_known_hosts, proxy.id])
       end
     end
 
@@ -40,7 +49,7 @@ module ForemanRemoteExecution
 
     def should_drop_from_known_hosts?
       host, = host_kind_target
-      host&.build && host&.changes&.key?('build')
+      host && !host.new_record? && host.build && host.changes.key?('build')
     end
 
     private

data/app/services/default_proxy_proxy_selector.rb

@@ -10,7 +10,9 @@ class DefaultProxyProxySelector < ::RemoteExecutionProxySelector
   def available_proxies(host, provider)
     # TODO: Once we have a internal proxy marker/feature on the proxy, we can
     # swap the implementation
-    internal_proxy = ::Katello.default_capsule
+    raise _('default_capsule method missing from SmartProxy') unless ::SmartProxy.respond_to?(:default_capsule)
+
+    internal_proxy = ::SmartProxy.default_capsule
     super.reduce({}) do |acc, (key, proxies)|
       acc.merge(key => proxies.select { |proxy| proxy == internal_proxy })
     end

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

@@ -19,8 +19,14 @@ child :targeting do
   attributes :bookmark_id, :search_query, :targeting_type, :user_id, :status, :status_label,
     :randomized_ordering
 
-  child :hosts do
+  child @hosts do
     extends 'api/v2/hosts/base'
+
+    if params[:host_status] == 'true'
+      node :job_status do |host|
+        @host_statuses[host.id]
+      end
+    end
   end
 end
 
@@ -28,7 +34,7 @@ child :task do
   attributes :id, :state
 end
 
-child :template_invocations do
+child @template_invocations do
   attributes :template_id, :template_name
   child :input_values do
     attributes :template_input_name, :template_input_id

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

@@ -1,5 +1,5 @@
 <% template_invocations = job_invocation.pattern_template_invocations %>
-<div class="card-pf card-pf-accented">
+<div class="card-pf card-pf-accented target-hosts-card">
   <div class="card-pf-title">
     <h2 style="height: 18px;" class="card-pf-title">
       <%= _('Target hosts') %>

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

@@ -15,29 +15,9 @@
   <% end %>
   <br>
 
-  <table class="<%= table_css_classes('table-condensed') %>">
-    <thead>
-    <tr>
-      <th><%= sort :name, :as => _('Host') %></th>
-      <th><%= _('Status') %></th>
-      <th><%= _('Actions') %></th>
-    </tr>
-    </thead>
-
-    <tbody>
-    <% hosts.each do |host| %>
-      <% template_invocation = job_invocation.template_invocations.find { |template_invocation| template_invocation.host_id == host.id } %>
-      <% task = template_invocation.try(:run_host_job_task) %>
-      <tr>
-        <% options = { :host => host, :task => task, :job_invocation => job_invocation, :template_invocation => template_invocation } %>
-        <%= render 'host_name_td', options %>
-        <%= render 'host_status_td', options %>
-        <%= render 'host_actions_td', options %>
-      </tr>
-    <% end %>
-    </tbody>
-  </table>
-
+  <div id="targeting_hosts">
+    <%= mount_react_component('TargetingHosts', '#targeting_hosts') %>
+  </div>
   <%= will_paginate_with_info @hosts, :container => true %>
 <% else %>
   <div class="alert alert-warning">