foreman_remote_execution 4.1.0 → 4.3.0

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

@@ -98,6 +98,7 @@ handle_zypp_res_codes () {
     end
   -%>
   [ -x "$(command -v subscription-manager)" ] && subscription-manager refresh
+  export DEBIAN_FRONTEND=noninteractive
   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/config/routes.rb

@@ -43,6 +43,9 @@ Rails.application.routes.draw do
     get 'cockpit/host_ssh_params/:id', to: 'cockpit#host_ssh_params'
   end
   get 'cockpit/redirect', to: 'cockpit#redirect'
+  get 'ui_job_wizard/categories', to: 'ui_job_wizard#categories'
+
+  match '/experimental/job_wizard', to: 'react#index', :via => [:get]
 
   namespace :api, :defaults => {:format => 'json'} do
     scope '(:apiv)', :module => :v2, :defaults => {:apiv => 'v2'}, :apiv => /v1|v2/, :constraints => ApiConstraints.new(:version => 2, :default => true) do
@@ -55,6 +58,8 @@ Rails.application.routes.draw do
           post 'cancel'
           post 'rerun'
           get  'template_invocations', :to => 'template_invocations#template_invocations'
+          get 'outputs'
+          post 'outputs'
         end
       end
 

data/db/migrate/20200820122057_add_proxy_selector_override_to_remote_execution_feature.rb

@@ -0,0 +1,5 @@
+class AddProxySelectorOverrideToRemoteExecutionFeature < ActiveRecord::Migration[4.2]
+  def change
+    add_column :remote_execution_features, :proxy_selector_override, :string
+  end
+end

data/foreman_remote_execution.gemspec

@@ -26,9 +26,8 @@ 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', '>= 0.15.1'
+  s.add_dependency 'foreman-tasks', '>= 4.0.0'
 
   s.add_development_dependency 'factory_bot_rails', '~> 4.8.0'
-  s.add_development_dependency 'rubocop', '~> 0.80.0'
   s.add_development_dependency 'rdoc'
 end

data/lib/foreman_remote_execution/engine.rb

@@ -53,6 +53,7 @@ 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'
 
         apipie_documented_controllers ["#{ForemanRemoteExecution::Engine.root}/app/controllers/api/v2/*.rb"]
@@ -68,7 +69,8 @@ module ForemanRemoteExecution
           permission :view_job_templates, { :job_templates => [:index, :show, :revision, :auto_complete_search, :auto_complete_job_category, :preview, :export],
                                             :'api/v2/job_templates' => [:index, :show, :revision, :export],
                                             :'api/v2/template_inputs' => [:index, :show],
-                                            :'api/v2/foreign_input_sets' => [:index, :show]}, :resource_type => 'JobTemplate'
+                                            :'api/v2/foreign_input_sets' => [:index, :show],
+                                            :ui_job_wizard => [:categories]}, :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],
@@ -83,7 +85,7 @@ module ForemanRemoteExecution
           permission :create_job_invocations, { :job_invocations => [:new, :create, :refresh, :rerun, :preview_hosts],
                                                 'api/v2/job_invocations' => [:create, :rerun] }, :resource_type => 'JobInvocation'
           permission :view_job_invocations, { :job_invocations => [:index, :chart, :show, :auto_complete_search], :template_invocations => [:show],
-                                              'api/v2/job_invocations' => [:index, :show, :output, :raw_output] }, :resource_type => 'JobInvocation'
+                                              'api/v2/job_invocations' => [:index, :show, :output, :raw_output, :outputs] }, :resource_type => 'JobInvocation'
           permission :view_template_invocations, { :template_invocations => [:show],
                                                    'api/v2/template_invocations' => [:template_invocations] }, :resource_type => 'TemplateInvocation'
           permission :create_template_invocations, {}, :resource_type => 'TemplateInvocation'
@@ -137,6 +139,13 @@ module ForemanRemoteExecution
           parent: :monitor_menu,
           after: :audits
 
+        menu :labs_menu, :job_wizard,
+          url_hash: { controller: 'job_wizard', action: :index },
+          caption: N_('Job wizard'),
+          parent: :lab_features_menu,
+          url: 'experimental/job_wizard',
+          after: :host_wizard
+
         register_custom_status HostStatus::ExecutionStatus
         # add dashboard widget
         # widget 'foreman_remote_execution_widget', name: N_('Foreman plugin template widget'), sizex: 4, sizey: 1
@@ -151,6 +160,14 @@ module ForemanRemoteExecution
         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 }
+
+        # 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))
       end
     end
 
@@ -207,6 +224,8 @@ module ForemanRemoteExecution
       ForemanRemoteExecution.register_rex_feature
 
       ::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
     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.1.0'.freeze
+  VERSION = '4.3.0'.freeze
 end

data/package.json

@@ -21,16 +21,16 @@
   },
   "devDependencies": {
     "@babel/core": "^7.7.0",
-    "@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",
+    "@theforeman/builder": "^4.14.0",
+    "@theforeman/eslint-plugin-foreman": "^4.14.0",
+    "@theforeman/stories": "^4.14.0",
+    "@theforeman/test": "^4.14.0",
+    "@theforeman/vendor-dev": "^4.14.0",
     "babel-eslint": "^10.0.0",
     "eslint": "^6.8.0",
     "prettier": "^1.19.1"
   },
   "peerDependencies": {
-    "@theforeman/vendor": ">= 4.2.1"
+    "@theforeman/vendor": ">= 4.14.0"
   }
 }

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

@@ -137,6 +137,7 @@ module Api
 
         test 'should provide empty output for host which does not have a task yet' do
           JobInvocation.any_instance.expects(:sub_task_for_host).returns(nil)
+          JobInvocation.any_instance.expects(:finished?).returns(false)
           get :output, params: { :job_invocation_id => @invocation.id, :host_id => host.id }
           result = ActiveSupport::JSON.decode(@response.body)
           assert_equal result['refresh'], true
@@ -144,6 +145,15 @@ module Api
           assert_response :success
         end
 
+        test 'should provide empty output marked as done for host which does not have a task when the job is finished' do
+          JobInvocation.any_instance.expects(:sub_task_for_host).returns(nil)
+          get :output, params: { :job_invocation_id => @invocation.id, :host_id => host.id }
+          result = ActiveSupport::JSON.decode(@response.body)
+          assert_equal result['refresh'], false
+          assert_equal result['output'], []
+          assert_response :success
+        end
+
         test 'should fail with 404 for non-existing job invocation' do
           invocation_id = @invocation.id + 1
           assert_empty JobInvocation.where(:id => invocation_id)
@@ -160,6 +170,35 @@ module Api
         end
       end
 
+      describe '#outputs' do
+        test 'should provide outputs for hosts in the job' do
+          get :outputs, params: { :id => @invocation.id }
+          result = ActiveSupport::JSON.decode(@response.body)
+          host_output = result['outputs'].first
+          assert_equal host_output['host_id'], @invocation.targeting.host_ids.first
+          assert_equal host_output['refresh'], false
+          assert_equal host_output['output'], []
+          assert_response :success
+        end
+
+        test 'should provide outputs for selected hosts in the job' do
+          post :outputs, params: { :id => @invocation.id, :search_query => "id = #{@invocation.targeting.host_ids.first}" }, as: :json
+          result = ActiveSupport::JSON.decode(@response.body)
+          host_output = result['outputs'].first
+          assert_equal host_output['host_id'], @invocation.targeting.host_ids.first
+          assert_equal host_output['refresh'], false
+          assert_equal host_output['output'], []
+          assert_response :success
+        end
+
+        test 'should provide outputs for hosts in the job matching a search query' do
+          get :outputs, params: { :id => @invocation.id, :search_query => "name = definitely_not_in_the_job" }
+          result = ActiveSupport::JSON.decode(@response.body)
+          assert_equal result['outputs'], []
+          assert_response :success
+        end
+      end
+
       describe 'raw output' do
         let(:fake_output) do
           (1..5).map do |i|
@@ -172,7 +211,7 @@ module Api
         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))
+          JobInvocation.any_instance.expects(:task).times(3).returns(OpenStruct.new(:scheduled? => false, :pending? => false))
           JobInvocation.any_instance.expects(:sub_task_for_host).returns(fake_task)
           get :raw_output, params: { :job_invocation_id => @invocation.id, :host_id => host.id }
           result = ActiveSupport::JSON.decode(@response.body)
@@ -185,7 +224,7 @@ module Api
           start_time = Time.now
           JobInvocation.any_instance
                        .expects(:task).twice
-                       .returns(OpenStruct.new(:scheduled? => true, :start_at => start_time))
+                       .returns(OpenStruct.new(:scheduled? => true, :start_at => start_time, :pending? => true))
           JobInvocation.any_instance.expects(:sub_task_for_host).never
           get :raw_output, params: { :job_invocation_id => @invocation.id, :host_id => host.id }
           result = ActiveSupport::JSON.decode(@response.body)
@@ -197,7 +236,7 @@ module Api
         end
 
         test 'should provide raw output for host without task' do
-          JobInvocation.any_instance.expects(:task).returns(OpenStruct.new(:scheduled? => false))
+          JobInvocation.any_instance.expects(:task).times(3).returns(OpenStruct.new(:scheduled? => false, :pending? => true))
           JobInvocation.any_instance.expects(:sub_task_for_host)
           get :raw_output, params: { :job_invocation_id => @invocation.id, :host_id => host.id }
           result = ActiveSupport::JSON.decode(@response.body)

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

@@ -0,0 +1,73 @@
+require 'test_plugin_helper'
+
+module Api
+  module V2
+    # Tests for the extra methods to play roles on a Host
+    class RegistrationControllerTest < ActionController::TestCase
+      describe 'host registration' do
+        let(:organization) { FactoryBot.create(:organization) }
+        let(:tax_location) { FactoryBot.create(:location) }
+        let(:template) do
+          FactoryBot.create(
+            :provisioning_template,
+            template_kind: template_kinds(:host_init_config),
+            template: 'template content <%= @host.name %>',
+            locations: [tax_location],
+            organizations: [organization]
+          )
+        end
+        let(:os) do
+          FactoryBot.create(
+            :operatingsystem,
+            :with_associations,
+            family: 'Redhat',
+            provisioning_templates: [
+              template,
+            ]
+          )
+        end
+
+        let(:host_params) do
+          { host: { name: 'centos-test.example.com',
+                    managed: false, build: false,
+                    organization_id: organization.id,
+                    location_id: tax_location.id,
+                    operatingsystem_id: os.id } }
+        end
+
+        describe 'remote_execution_interface' do
+          setup do
+            Setting[:default_host_init_config_template] = template.name
+            @host = Host.create(host_params[:host])
+            @interface0 = FactoryBot.create(:nic_managed, host: @host, identifier: 'dummy0', execution: false)
+          end
+
+          test 'with existing interface' do
+            params = host_params.merge(remote_execution_interface: @interface0.identifier)
+
+            post :host, params: params, session: set_session_user
+            assert_response :success
+            assert @interface0.reload.execution
+          end
+
+          test 'with not-existing interface' do
+            params = host_params.merge(remote_execution_interface: 'dummy999')
+
+            post :host, params: params, session: set_session_user
+            assert_response :not_found
+          end
+
+          test 'with multiple interfaces' do
+            interface1 = FactoryBot.create(:nic_managed, host: @host, identifier: 'dummy1', execution: false)
+            params = host_params.merge(remote_execution_interface: interface1.identifier)
+
+            post :host, params: params, session: set_session_user
+            assert_response :success
+            refute @interface0.reload.execution
+            assert interface1.reload.execution
+          end
+        end
+      end
+    end
+  end
+end

data/test/functional/ui_job_wizard_controller_test.rb

@@ -0,0 +1,16 @@
+require 'test_plugin_helper'
+
+class UiJobWizardControllerTest < ActionController::TestCase
+  def setup
+    FactoryBot.create(:job_template, :job_category => 'cat1')
+    FactoryBot.create(:job_template, :job_category => 'cat2')
+    FactoryBot.create(:job_template, :job_category => 'cat2')
+  end
+
+  test 'should respond with categories' do
+    get :categories, :params => {}, :session => set_session_user
+    assert_response :success
+    res = JSON.parse @response.body
+    assert_equal ['cat1','cat2'], res['job_categories']
+  end
+end

data/test/unit/actions/run_hosts_job_test.rb

@@ -24,6 +24,7 @@ module ForemanRemoteExecution
       OpenStruct.new(:id => uuid).tap do |o|
         o.stubs(:add_missing_task_groups)
         o.stubs(:task_groups).returns([])
+        o.stubs(:pending?).returns(true)
       end
     end
     let(:action) do

data/webpack/JobWizard/JobWizard.js

@@ -0,0 +1,32 @@
+import React from 'react';
+import { Wizard } from '@patternfly/react-core';
+import { translate as __ } from 'foremanReact/common/I18n';
+import history from 'foremanReact/history';
+
+export const JobWizard = () => {
+  const steps = [
+    {
+      name: __('Category and template'),
+      component: <p>Category and template</p>,
+    },
+    { name: __('Target hosts'), component: <p>TargetHosts </p> },
+    { name: __('Advanced fields'), component: <p> AdvancedFields </p> },
+    { name: __('Schedule'), component: <p>Schedule</p> },
+    {
+      name: __('Review details'),
+      component: <p>ReviewDetails</p>,
+      nextButtonText: 'Run',
+    },
+  ];
+  const title = __('Run Job');
+  return (
+    <Wizard
+      onClose={() => history.goBack()}
+      navAriaLabel={`${title} steps`}
+      steps={steps}
+      height="70vh"
+    />
+  );
+};
+
+export default JobWizard;

data/webpack/JobWizard/index.js

@@ -0,0 +1,32 @@
+import React from 'react';
+import { Title, Divider } from '@patternfly/react-core';
+import { translate as __ } from 'foremanReact/common/I18n';
+import PageLayout from 'foremanReact/routes/common/PageLayout/PageLayout';
+import { JobWizard } from './JobWizard';
+
+const JobWizardPage = () => {
+  const title = __('Run job');
+  const breadcrumbOptions = {
+    breadcrumbItems: [
+      { caption: __('Jobs'), url: `/jobs` },
+      { caption: title },
+    ],
+  };
+  return (
+    <PageLayout
+      header={title}
+      breadcrumbOptions={breadcrumbOptions}
+      searchable={false}
+    >
+      <React.Fragment>
+        <Title headingLevel="h2" size="2xl">
+          {title}
+        </Title>
+        <Divider component="div" />
+        <JobWizard />
+      </React.Fragment>
+    </PageLayout>
+  );
+};
+
+export default JobWizardPage;

data/webpack/Routes/routes.js

@@ -0,0 +1,12 @@
+import React from 'react';
+import JobWizardPage from '../JobWizard';
+
+const ForemanREXRoutes = [
+  {
+    path: '/experimental/job_wizard',
+    exact: true,
+    render: props => <JobWizardPage {...props} />,
+  },
+];
+
+export default ForemanREXRoutes;

data/webpack/__mocks__/foremanReact/history.js

@@ -0,0 +1 @@
+export default { goBack: () => null };

data/webpack/global_index.js

@@ -0,0 +1,4 @@
+import { registerRoutes } from 'foremanReact/routes/RoutingService';
+import routes from './Routes/routes';
+
+registerRoutes('foreman_remote_execution', routes);

data/webpack/react_app/components/TargetingHosts/TargetingHosts.js

@@ -51,8 +51,12 @@ const TargetingHosts = ({ apiStatus, items }) => {
 };
 
 TargetingHosts.propTypes = {
-  apiStatus: PropTypes.string.isRequired,
+  apiStatus: PropTypes.string,
   items: PropTypes.array.isRequired,
 };
 
+TargetingHosts.defaultProps = {
+  apiStatus: null,
+};
+
 export default TargetingHosts;

data/webpack/react_app/components/TargetingHosts/TargetingHostsPage.js

@@ -39,7 +39,7 @@ const TargetingHostsPage = ({
     <br />
     <TargetingHosts apiStatus={apiStatus} items={items} />
     <Pagination
-      viewType="list"
+      viewType="table"
       itemCount={totalHosts}
       pagination={pagination}
       onChange={args => handlePagination(args)}
@@ -52,11 +52,15 @@ const TargetingHostsPage = ({
 TargetingHostsPage.propTypes = {
   handleSearch: PropTypes.func.isRequired,
   searchQuery: PropTypes.string.isRequired,
-  apiStatus: PropTypes.string.isRequired,
+  apiStatus: PropTypes.string,
   items: PropTypes.array.isRequired,
   totalHosts: PropTypes.number.isRequired,
   pagination: PropTypes.object.isRequired,
   handlePagination: PropTypes.func.isRequired,
 };
 
+TargetingHostsPage.defaultProps = {
+  apiStatus: null,
+};
+
 export default TargetingHostsPage;