foreman_remote_execution 3.2.1 → 3.3.3

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">

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

@@ -1,3 +1,4 @@
+<% stylesheet 'foreman_remote_execution/foreman_remote_execution' %>
 <% title _('Job invocations') %>
 
 <% title_actions(job_invocations_buttons) %>
@@ -19,7 +20,7 @@
   <tbody>
     <% @job_invocations.each do |invocation| %>
       <tr>
-        <td><%= 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 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><%= link_to_invocation_task_if_authorized(invocation) %></td>
         <td><%= invocation_result(invocation, :success_count) %></td>

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

@@ -41,9 +41,3 @@
   <% end %>
   <%= render_tab_content_for(:main_tabs, subject: @job_invocation) %>
 </div>
-
-<script id="job_invocation_refresh" data-refresh-url="<%= job_invocation_path(@job_invocation) %>">
-<% if @auto_refresh %>
-  delayed_refresh($('script#job_invocation_refresh').data('refresh-url'), job_invocation_refresh_data());
-<% end %>
-</script>

data/app/views/job_invocations/show.json.erb

@@ -0,0 +1,4 @@
+{
+  "autoRefresh": "<%= @auto_refresh %>",
+  "hosts": <%= targeting_hosts(@job_invocation, @hosts).to_json.html_safe %>
+}

data/app/views/templates/ssh/package_action.erb

@@ -97,6 +97,7 @@ handle_zypp_res_codes () {
       end
     end
   -%>
+  [ -x "$(command -v subscription-manager)" ] && subscription-manager refresh
   apt-get -y update
   apt-get -o Dpkg::Options::="--force-confdef" -o Dpkg::Options::="--force-confold" -y <%= action %> <%= input("package") %>
 <% elsif package_manager == 'zypper' -%>

data/app/views/templates/ssh/puppet_agent_disable.erb

@@ -13,4 +13,7 @@ template_inputs:
 provider_type: SSH
 kind: job_template
 -%>
+<% if @host.operatingsystem.family == 'Debian' -%>
+export PATH=/opt/puppetlabs/bin:$PATH
+<% end -%>
 puppet agent --disable "<%= input("comment").present? ? input("comment") : "Disabled using Foreman Remote Execution"  %> - <%= current_user %> - $(date "+%d/%m/%Y %H:%M")"

data/app/views/templates/ssh/puppet_agent_enable.erb

@@ -7,4 +7,7 @@ snippet: false
 provider_type: SSH
 kind: job_template
 -%>
+<% if @host.operatingsystem.family == 'Debian' -%>
+export PATH=/opt/puppetlabs/bin:$PATH
+<% end -%>
 puppet agent --enable

data/app/views/templates/ssh/puppet_install_modules_from_forge.erb

@@ -33,4 +33,7 @@ template_inputs:
 provider_type: SSH
 kind: job_template
 -%>
+<% if @host.operatingsystem.family == 'Debian' -%>
+export PATH=/opt/puppetlabs/bin:$PATH
+<% end -%>
 puppet module install <%= input('puppet_module') %> <%= "--target-dir #{input('target_dir')}" if input('target_dir').present? %> <%= "--version #{input('version')}" if input('version').present? %> <%= "--force" if input('force') == "true" %> <%= "--ignore-dependencies" if input('ignore_dependencies') == "true" %>

data/app/views/templates/ssh/puppet_run_once.erb

@@ -11,4 +11,7 @@ template_inputs:
   input_type: user
   required: false
 %>
+<% if @host.operatingsystem.family == 'Debian' -%>
+export PATH=/opt/puppetlabs/bin:$PATH
+<% end -%>
 puppet agent --onetime --no-usecacheonfailure --no-daemonize <%= input("puppet_options") %>

data/db/seeds.d/70-job_templates.rb

@@ -4,7 +4,7 @@ User.as_anonymous_admin do
   JobTemplate.without_auditing do
     Dir[File.join("#{ForemanRemoteExecution::Engine.root}/app/views/templates/**/*.erb")].each do |template|
       sync = !Rails.env.test? && Setting[:remote_execution_sync_templates]
-      template = JobTemplate.import_raw!(File.read(template), :default => true, :locked => true, :update => sync)
+      template = JobTemplate.import_raw!(File.read(template), :default => true, :lock => true, :update => sync)
       template.organizations = organizations if template.present?
       template.locations = locations if template.present?
     end

data/foreman_remote_execution.gemspec

@@ -15,10 +15,9 @@ Gem::Specification.new do |s|
   s.description = 'A plugin bringing remote execution to the Foreman, completing the config ' +
                   'management functionality with remote management functionality.'
 
-  s.files =            `git ls-files`.split("\n").reject do |file|
-    file =~ /^scripts/ ||
-        file.start_with?('lib/foreman_remote_execution_core') ||
-        file == 'foreman_remote_execution_core.gemspec'
+  s.files = `git ls-files`.split("\n").reject do |file|
+    file.start_with?('scripts', 'lib/foreman_remote_execution_core') ||
+      file == 'foreman_remote_execution_core.gemspec'
   end
 
   s.test_files =       `git ls-files test`.split("\n")
@@ -30,6 +29,6 @@ Gem::Specification.new do |s|
   s.add_dependency 'foreman-tasks', '>= 0.15.1'
 
   s.add_development_dependency 'factory_bot_rails', '~> 4.8.0'
-  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rubocop', '~> 0.80.0'
   s.add_development_dependency 'rdoc'
 end

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '3.2.1'.freeze
+  VERSION = '3.3.3'.freeze
 end

data/locale/action_names.rb

@@ -3,4 +3,3 @@ _("Action with sub plans")
 _("Import facts")
 _("Import Puppet classes")
 _("Remote action:")
-

data/package.json

@@ -3,25 +3,14 @@
   "version": "1.0.0",
   "license": "GPL-3.0",
   "scripts": {
-    "lint": "./node_modules/.bin/eslint -c .eslintrc webpack/ script/",
-    "test": "node node_modules/.bin/jest webpack",
-    "test:watch": "node node_modules/.bin/jest webpack --watchAll",
-    "test:current": "node node_modules/.bin/jest webpack --watch"
-  },
-  "jest": {
-    "verbose": true,
-    "moduleDirectories": [
-      "node_modules",
-      "webpack"
-    ],
-    "setupFiles": [
-      "raf/polyfill",
-      "./webpack/test_setup.js"
-    ],
-    "testPathIgnorePatterns": [
-      "/node_modules/",
-      "<rootDir>/foreman/"
-    ]
+    "lint": "tfm-lint --plugin -d /webpack",
+    "test": "tfm-test --plugin",
+    "test:watch": "tfm-test --plugin --watchAll",
+    "test:current": "tfm-test --plugin --watch",
+    "publish-coverage": "tfm-publish-coverage",
+    "stories": "tfm-stories --plugin",
+    "stories:build": "tfm-build-stories --plugin",
+    "stories:deploy": "surge --project .storybook-dist"
   },
   "repository": {
     "type": "git",
@@ -32,22 +21,16 @@
   },
   "devDependencies": {
     "@babel/core": "^7.7.0",
-    "@theforeman/builder": "^4.0.2",
-    "@theforeman/vendor-dev": "^4.0.2",
+    "@theforeman/builder": "^4.2.1",
+    "@theforeman/eslint-plugin-foreman": "^4.2.1",
+    "@theforeman/stories": "^4.2.1",
+    "@theforeman/test": "^4.2.1",
+    "@theforeman/vendor-dev": "^4.2.1",
     "babel-eslint": "^10.0.0",
-    "babel-jest": "^24.9.0",
-    "enzyme": "^3.2.0",
-    "enzyme-adapter-react-16": "^1.1.0",
-    "enzyme-to-json": "^3.1.2",
-    "eslint": "^4.10.0",
-    "eslint-config-airbnb": "^16.0.0",
-    "eslint-plugin-import": "^2.8.0",
-    "eslint-plugin-jest": "^21.2.0",
-    "eslint-plugin-jsx-a11y": "^6.0.2",
-    "eslint-plugin-react": "^7.4.0",
-    "jest": "^24.9.0"
+    "eslint": "^6.8.0",
+    "prettier": "^1.19.1"
   },
   "peerDependencies": {
-    "@theforeman/vendor": ">= 4.0.2"
+    "@theforeman/vendor": ">= 4.2.1"
   }
 }

data/test/functional/api/v2/job_invocations_controller_test.rb

@@ -4,7 +4,7 @@ module Api
   module V2
     class JobInvocationsControllerTest < ActionController::TestCase
       setup do
-        @invocation = FactoryBot.create(:job_invocation, :with_template, :with_task)
+        @invocation = FactoryBot.create(:job_invocation, :with_template, :with_task, :with_unplanned_host)
         @template = FactoryBot.create(:job_template, :with_input)
 
         # Without this the template in template_invocations and in pattern_template_invocations
@@ -20,18 +20,32 @@ module Api
         assert_response :success
       end
 
-      test 'should get invocation detail' do
-        get :show, params: { :id => @invocation.id }
-        assert_response :success
-        template = ActiveSupport::JSON.decode(@response.body)
-        assert_not_empty template
-        assert_equal template['job_category'], @invocation.job_category
-      end
+      describe 'show' do
+        test 'should get invocation detail' do
+          get :show, params: { :id => @invocation.id }
+          assert_response :success
+          template = ActiveSupport::JSON.decode(@response.body)
+          assert_not_empty template
+          assert_equal template['job_category'], @invocation.job_category
+          assert_not_empty template['targeting']['hosts']
+        end
 
-      test 'should get invocation detail when taxonomies are set' do
-        taxonomy_params = %w(organization location).reduce({}) { |acc, cur| acc.merge("#{cur}_id" => FactoryBot.create(cur)) }
-        get :show, params: taxonomy_params.merge(:id => @invocation.id)
-        assert_response :success
+        test 'should get invocation detail when taxonomies are set' do
+          taxonomy_params = %w(organization location).reduce({}) { |acc, cur| acc.merge("#{cur}_id" => FactoryBot.create(cur)) }
+          get :show, params: taxonomy_params.merge(:id => @invocation.id)
+          assert_response :success
+        end
+
+        test 'should see only permitted hosts' do
+          @user = FactoryBot.create(:user, admin: false)
+          setup_user('view', 'job_invocations', nil, @user)
+          setup_user('view', 'hosts', 'name ~ nope.example.com', @user)
+
+          get :show, params: { :id => @invocation.id }, session: set_session_user(@user)
+          assert_response :success
+          response = ActiveSupport::JSON.decode(@response.body)
+          assert_empty response['targeting']['hosts']
+        end
       end
 
       context 'creation' do
@@ -108,7 +122,7 @@ module Api
       end
 
       describe '#output' do
-        let(:host) { @invocation.template_invocations_hosts.first }
+        let(:host) { @invocation.targeting.hosts.first }
 
         test 'should provide output for delayed task' do
           ForemanTasks::Task.any_instance.expects(:scheduled?).returns(true)
@@ -137,6 +151,12 @@ module Api
           assert_equal result['message'], "Job invocation not found by id '#{invocation_id}'"
           assert_response :missing
         end
+
+        test 'should get output only for host in job invocation' do
+          get :output, params: { job_invocation_id: @invocation.id,
+                                 host_id: FactoryBot.create(:host).id }
+          assert_response :missing
+        end
       end
 
       describe 'raw output' do
@@ -148,7 +168,7 @@ module Api
         let(:fake_task) do
           OpenStruct.new :pending? => false, :main_action => OpenStruct.new(:live_output => fake_output)
         end
-        let(:host) { @invocation.template_invocations_hosts.first }
+        let(:host) { @invocation.targeting.hosts.first }
 
         test 'should provide raw output for a host' do
           JobInvocation.any_instance.expects(:task).returns(OpenStruct.new(:scheduled? => false))
@@ -184,6 +204,12 @@ module Api
           assert_nil result['output']
           assert_response :success
         end
+
+        test 'should get raw output only for host in job invocation' do
+          get :raw_output, params: { job_invocation_id: @invocation.id,
+                                     host_id: FactoryBot.create(:host).id }
+          assert_response :missing
+        end
       end
 
       test 'should cancel a job' do
@@ -232,11 +258,13 @@ module Api
       end
 
       test 'should not raise an exception when reruning failed has no hosts' do
+        @invocation.targeting.hosts.first.destroy
         JobInvocation.any_instance.expects(:generate_description)
         JobInvocationComposer.any_instance
                              .expects(:validate_job_category)
                              .with(@invocation.job_category)
                              .returns(@invocation.job_category)
+
         post :rerun, params: { :id => @invocation.id, :failed_only => true }
         assert_response :success
         result = ActiveSupport::JSON.decode(@response.body)

data/test/models/orchestration/ssh_test.rb

@@ -15,10 +15,42 @@ class SSHOrchestrationTest < ActiveSupport::TestCase
   end
 
   it 'attempts to drop IP address and hostname from smart proxies on rebuild' do
+    host.stubs(:skip_orchestration?).returns false
+    SmartProxy.any_instance.expects(:drop_host_from_known_hosts).with(interface.ip)
+    SmartProxy.any_instance.expects(:drop_host_from_known_hosts).with(host.name)
+
     host.build = true
     host.save!
+
     ids = ["ssh_remove_known_hosts_interface_#{interface.ip}_#{proxy.id}",
            "ssh_remove_known_hosts_host_#{host.name}_#{proxy.id}"]
     _(host.queue.task_ids).must_equal ids
+    _(host.queue.items.map(&:status)).must_equal %w(completed completed)
+  end
+
+  it 'does not fail on 404 from the smart proxy' do
+    host.stubs(:skip_orchestration?).returns false
+    SmartProxy.any_instance.expects(:drop_host_from_known_hosts).raises(RestClient::ResourceNotFound).twice
+    host.build = true
+    host.save!
+    ids = ["ssh_remove_known_hosts_interface_#{interface.ip}_#{proxy.id}",
+           "ssh_remove_known_hosts_host_#{host.name}_#{proxy.id}"]
+    _(host.queue.task_ids).must_equal ids
+    _(host.queue.items.map(&:status)).must_equal %w(completed completed)
+  end
+
+  it 'does not trigger the removal when creating a new host' do
+    SmartProxy.any_instance.expects(:drop_host_from_known_hosts).never
+    host = Host::Managed.new(:name => 'test', :ip => '127.0.0.1')
+    host.stubs(:skip_orchestration?).returns false
+    _(host.queue.task_ids).must_equal []
+  end
+
+  it 'does not call to the proxy when target is nil' do
+    host.stubs(:skip_orchestration?).returns false
+    SmartProxy.any_instance.expects(:drop_host_from_known_hosts).with(host.name)
+    host.interfaces.first.stubs(:ip)
+    host.destroy
+    _(host.queue.items.map(&:status)).must_equal %w(completed completed)
   end
 end

data/test/unit/concerns/host_extensions_test.rb

@@ -48,6 +48,13 @@ class ForemanRemoteExecutionHostExtensionsTest < ActiveSupport::TestCase
       _(host.host_param('remote_execution_ssh_keys')).must_include sshkey
     end
 
+    it 'merges ssh key as a string from host parameters and proxies' do
+      key = 'ssh-rsa not-even-a-key something@somewhere.com'
+      host.host_parameters << FactoryBot.create(:host_parameter, :host => host, :name => 'remote_execution_ssh_keys', :value => key)
+      _(host.host_param('remote_execution_ssh_keys')).must_include key
+      _(host.host_param('remote_execution_ssh_keys')).must_include sshkey
+    end
+
     it 'has ssh keys in the parameters even when no user specified' do
       # this is a case, when using the helper in provisioning templates
       FactoryBot.create(:smart_proxy, :ssh)

data/webpack/__mocks__/foremanReact/common/I18n.js

@@ -0,0 +1 @@
+export const translate = s => s;

data/webpack/__mocks__/foremanReact/components/common/ActionButtons/ActionButtons.js

@@ -0,0 +1,3 @@
+import React from 'react';
+
+export const ActionButtons = () => <div />;

data/webpack/__mocks__/foremanReact/constants.js

@@ -0,0 +1,3 @@
+export const STATUS = {
+  ERROR: 'ERROR',
+};

data/webpack/index.js

@@ -1,14 +1,16 @@
-import URI from 'urijs';
-// eslint-disable-next-line import/no-extraneous-dependencies
-import { mount, registerReducer } from 'foremanReact/common/MountingService';
-// eslint-disable-next-line import/no-extraneous-dependencies
+import { registerReducer } from 'foremanReact/common/MountingService';
 import componentRegistry from 'foremanReact/components/componentRegistry';
 import JobInvocationContainer from './react_app/components/jobInvocations';
+import TargetingHosts from './react_app/components/TargetingHosts';
 import rootReducer from './react_app/redux/reducers';
 
-componentRegistry.register({
-  name: 'JobInvocationContainer',
-  type: JobInvocationContainer,
+const components = [
+  { name: 'JobInvocationContainer', type: JobInvocationContainer },
+  { name: 'TargetingHosts', type: TargetingHosts },
+];
+
+components.forEach(component => {
+  componentRegistry.register(component);
 });
 
 registerReducer('foremanRemoteExecutionReducers', rootReducer);