foreman_remote_execution 4.2.3 → 4.3.0

data/Gemfile

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

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

@@ -214,7 +214,7 @@ module Api
       end
 
       def host_output(job_invocation, host, default: nil, since: nil, raw: false)
-        refresh = true
+        refresh = !job_invocation.finished?
 
         if (task = job_invocation.sub_task_for_host(host))
           refresh = task.pending?

data/app/controllers/ui_job_wizard_controller.rb

@@ -0,0 +1,18 @@
+class UiJobWizardController < ::Api::V2::BaseController
+  def categories
+    job_categories = resource_scope
+                     .search_for("job_category ~ \"#{params[:search]}\"")
+                     .select(:job_category).distinct
+                     .reorder(:job_category)
+                     .pluck(:job_category)
+    render :json => {:job_categories =>job_categories}
+  end
+
+  def resource_class
+    JobTemplate
+  end
+
+  def action_permission
+    :view_job_templates
+  end
+end

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

@@ -3,6 +3,7 @@ module Actions
     class RunHostJob < Actions::EntryAction
       include ::Actions::Helpers::WithContinuousOutput
       include ::Actions::Helpers::WithDelegatedAction
+      include ::Actions::ObservableAction
 
       middleware.do_not_use Dynflow::Middleware::Common::Transaction
       middleware.use Actions::Middleware::HideSecrets
@@ -16,7 +17,7 @@ module Actions
       end
 
       def plan(job_invocation, host, template_invocation, proxy_selector = ::RemoteExecutionProxySelector.new, options = {})
-        action_subject(host, :job_category => job_invocation.job_category, :description => job_invocation.description)
+        action_subject(host, :job_category => job_invocation.job_category, :description => job_invocation.description, :job_invocation_id => job_invocation.id)
 
         template_invocation.host_id = host.id
         template_invocation.run_host_job_task_id = task.id
@@ -121,6 +122,26 @@ module Actions
         delegated_output[:exit_status]
       end
 
+      def host_id
+        input['host']['id']
+      end
+
+      def host_name
+        input['host']['name']
+      end
+
+      def job_invocation_id
+        input['job_invocation_id']
+      end
+
+      def job_invocation
+        @job_invocation ||= ::JobInvocation.authorized.find(job_invocation_id)
+      end
+
+      def host
+        @host ||= ::Host.authorized.find(host_id)
+      end
+
       private
 
       def update_host_status
@@ -173,6 +194,22 @@ module Actions
         end
         proxy
       end
+
+      extend ApipieDSL::Class
+      apipie :class, "An action representing execution of a job against a host" do
+        name 'Actions::RemoteExecution::RunHostJob'
+        refs 'Actions::RemoteExecution::RunHostJob'
+        sections only: %w[webhooks]
+        property :task, object_of: 'Task', desc: 'Returns the task to which this action belongs'
+        property :host_name, String, desc: "Returns the name of the host"
+        property :host_id, Integer, desc: "Returns the id of the host"
+        property :host, object_of: 'Host', desc: "Returns the host"
+        property :job_invocation_id, Integer, desc: "Returns the id of the job invocation"
+        property :job_invocation, object_of: 'JobInvocation', desc: "Returns the job invocation"
+      end
+      class Jail < ::Actions::ObservableAction::Jail
+        allow :host_name, :host_id, :host, :job_invocation_id, :job_invocation
+      end
     end
   end
 end

data/app/models/host_status/execution_status.rb

@@ -49,6 +49,13 @@ class HostStatus::ExecutionStatus < HostStatus::Status
     end
   end
 
+  def status_link
+    job_invocation = last_stopped_task.parent_task.job_invocations.first
+    return nil unless User.current.can?(:view_job_invocations, job_invocation)
+
+    Rails.application.routes.url_helpers.job_invocation_path(job_invocation)
+  end
+
   class ExecutionTaskStatusMapper
     attr_accessor :task
 

data/app/models/job_invocation.rb

@@ -241,7 +241,7 @@ class JobInvocation < ApplicationRecord
   end
 
   def finished?
-    !task.pending?
+    !(task.nil? || task.pending?)
   end
 
   def missing_hosts_count

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

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],
@@ -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
@@ -157,6 +166,8 @@ module ForemanRemoteExecution
         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
 

data/lib/foreman_remote_execution/version.rb

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

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)
@@ -166,7 +176,7 @@ module Api
           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'], true
+          assert_equal host_output['refresh'], false
           assert_equal host_output['output'], []
           assert_response :success
         end
@@ -176,7 +186,7 @@ module Api
           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'], true
+          assert_equal host_output['refresh'], false
           assert_equal host_output['output'], []
           assert_response :success
         end
@@ -201,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)
@@ -214,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)
@@ -226,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

@@ -7,11 +7,10 @@ module Api
       describe 'host registration' do
         let(:organization) { FactoryBot.create(:organization) }
         let(:tax_location) { FactoryBot.create(:location) }
-        let(:template_kind) { template_kinds(:registration) }
-        let(:registration_template) do
+        let(:template) do
           FactoryBot.create(
             :provisioning_template,
-            template_kind: template_kind,
+            template_kind: template_kinds(:host_init_config),
             template: 'template content <%= @host.name %>',
             locations: [tax_location],
             organizations: [organization]
@@ -23,7 +22,7 @@ module Api
             :with_associations,
             family: 'Redhat',
             provisioning_templates: [
-              registration_template,
+              template,
             ]
           )
         end
@@ -36,17 +35,9 @@ module Api
                     operatingsystem_id: os.id } }
         end
 
-        setup do
-          FactoryBot.create(
-            :os_default_template,
-            template_kind: template_kind,
-            provisioning_template: registration_template,
-            operatingsystem: os
-          )
-        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

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/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/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)}

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

@@ -1,6 +1,3 @@
-.targeting-hosts-pagination {
-  margin-top: -7px;
-}
 #targeting_hosts {
   min-height: 350px;
 }

data/webpack/react_app/components/TargetingHosts/__tests__/__snapshots__/TargetingHostsPage.test.js.snap

@@ -62,7 +62,7 @@ exports[`TargetingHostsPage renders 1`] = `
         "perPage": 20,
       }
     }
-    viewType="list"
+    viewType="table"
   />
 </div>
 `;