foreman_remote_execution 4.3.1 → 4.4.0

data/locale/zh_TW/foreman_remote_execution.po

@@ -26,6 +26,11 @@ msgstr "%s 之前"
 msgid "%{description} on %{host}"
 msgstr "%{description} 於 %{host} 之上"
 
+msgid "...and %{count} more"
+msgid_plural "...and %{count} more"
+msgstr[0] ""
+msgstr[1] ""
+
 msgid "A comma separated list of input names to be excluded from the foreign template."
 msgstr "從外部範本排除的輸入名稱清單，以逗號隔開。"
 
@@ -53,6 +58,12 @@ msgstr "動作"
 msgid "Add Foreign Input Set"
 msgstr "新增外部輸入集"
 
+msgid "Advanced fields"
+msgstr ""
+
+msgid "All fields are required."
+msgstr ""
+
 msgid "Alphabetical"
 msgstr ""
 
@@ -95,6 +106,12 @@ msgstr "無法指定 bookmark_id 和 search_query"
 msgid "Cannot specify both recurrence and scheduling"
 msgstr "無法指定 recurrence 和 scheduling"
 
+msgid "Category And Template"
+msgstr ""
+
+msgid "Category and template"
+msgstr ""
+
 msgid "Choose a job template that is pre-selected in job invocation form"
 msgstr ""
 
@@ -125,6 +142,9 @@ msgstr ""
 msgid "Control concurrency level and distribution over time"
 msgstr "隨時間控制週期等級並散佈"
 
+msgid "Could not display data for job invocation."
+msgstr ""
+
 msgid "Could not find any suitable interface for execution"
 msgstr ""
 
@@ -227,6 +247,12 @@ msgstr "有效使用者方法 \"%{current_value}\" 並非 %{valid_methods} 之
 msgid "Effective user options"
 msgstr "有效的使用者選項"
 
+msgid "Effective user password"
+msgstr ""
+
+msgid "Effective user password is only applicable for SSH provider. Other providers ignore this field. <br> Password is stored encrypted in DB until the job finishes. For future or recurring executions, it is removed after the last execution."
+msgstr ""
+
 msgid "Enable Global Proxy"
 msgstr ""
 
@@ -263,18 +289,12 @@ msgstr "已失敗"
 msgid "Failed rendering template: %s"
 msgstr "無法生成範本：%s"
 
-msgid "Fallback Without Proxy"
-msgstr ""
-
 msgid "Fallback to Any Proxy"
 msgstr ""
 
 msgid "Feature input %{input_name} not defined in template %{template_name}"
 msgstr "未知的輸入 %{input_name} 未定義於範本 %{template_name}"
 
-msgid "Filter"
-msgstr "篩選器"
-
 msgid "Foreign input set"
 msgstr "外部輸入集"
 
@@ -287,6 +307,9 @@ msgstr ""
 msgid "Get output for a host"
 msgstr "取得主機輸出"
 
+msgid "Get outputs of hosts in a job"
+msgstr ""
+
 msgid "Get raw output for a host"
 msgstr ""
 
@@ -305,9 +328,15 @@ msgstr ""
 msgid "Host with id '%{id}' was not found"
 msgstr "找不到 ID 為 '%{id}' 的主機"
 
+msgid "Hosts gone missing"
+msgstr ""
+
 msgid "How often the job should occur, in the cron format"
 msgstr "工作多常發生，格式同 cron"
 
+msgid "Identifier of the Host interface for Remote execution"
+msgstr ""
+
 msgid "Import"
 msgstr "匯入"
 
@@ -335,6 +364,12 @@ msgstr "輸入集的描述"
 msgid "Inputs to use"
 msgstr "要使用的輸入"
 
+msgid "Interface with the '%s' identifier was specified as a remote execution interface, however the interface was not found on the host. If the interface exists, it needs to be created in Foreman during the registration."
+msgstr ""
+
+msgid "Internal proxy selector can only be used if Katello is enabled"
+msgstr ""
+
 msgid "Invocation type, one of %s"
 msgstr "祈願類型，%s 之一"
 
@@ -386,6 +421,9 @@ msgstr ""
 msgid "Job templates"
 msgstr "工作範本"
 
+msgid "Job wizard"
+msgstr ""
+
 msgid "JobTemplate|Locked"
 msgstr "JobTemplate|Locked"
 
@@ -431,6 +469,9 @@ msgstr "列出各個位置上的工作範本"
 msgid "List job templates per organization"
 msgstr "列出各個組織的工作範本"
 
+msgid "List of proxy IDs to be used for remote execution"
+msgstr ""
+
 msgid "List remote execution features"
 msgstr "列出遠端執行功能"
 
@@ -458,6 +499,9 @@ msgstr "新工作範本"
 msgid "No execution finished yet"
 msgstr "尚無執行完成"
 
+msgid "No hosts found."
+msgstr ""
+
 msgid "No template mapped to feature %{feature_name}"
 msgstr "沒有範本定義至功能 %{feature_name}"
 
@@ -500,6 +544,9 @@ msgstr "此時間之後不再進行任何執行"
 msgid "Port to use for SSH communication. Default port 22. You may override per host by setting a parameter called remote_execution_ssh_port."
 msgstr ""
 
+msgid "Preupgrade job"
+msgstr ""
+
 msgid "Preview"
 msgstr "預覽"
 
@@ -539,6 +586,9 @@ msgstr "遠端執行"
 msgid "Remote Execution Features"
 msgstr "遠端執行功能"
 
+msgid "Remote Execution Interface"
+msgstr ""
+
 msgid "Remote action:"
 msgstr "遠端動作："
 
@@ -578,6 +628,9 @@ msgstr "解析至"
 msgid "Results"
 msgstr ""
 
+msgid "Review details"
+msgstr ""
+
 msgid "Run"
 msgstr "執行"
 
@@ -593,6 +646,9 @@ msgstr "一次最多執行 N 個任務"
 msgid "Run at most N tasks at a time. If this is set and proxy batch triggering is enabled, then tasks are triggered on the smart proxy in batches of size 1."
 msgstr ""
 
+msgid "Run job"
+msgstr ""
+
 msgid "SSH"
 msgstr "SSH"
 
@@ -629,9 +685,6 @@ msgstr "捲動至底端"
 msgid "Scroll to top"
 msgstr "捲動至頂端"
 
-msgid "Search"
-msgstr "搜尋"
-
 msgid "Search Query"
 msgstr ""
 
@@ -659,6 +712,12 @@ msgstr ""
 msgid "Should the ip addresses on host interfaces be preferred over the fqdn? It is useful when DNS not resolving the fqdns properly. You may override this per host by setting a parameter called remote_execution_connect_by_ip. This setting only applies to IPv4. When the host has only an IPv6 address on the interface used for remote execution, hostname will be used even if this setting is set to true."
 msgstr ""
 
+msgid "Should this interface be used for remote execution?"
+msgstr ""
+
+msgid "Show Job status for the hosts"
+msgstr ""
+
 msgid "Show foreign input set details"
 msgstr "顯示外部輸入集的詳細資料"
 
@@ -689,12 +748,6 @@ msgstr "已成功"
 msgid "Success"
 msgstr "成功"
 
-msgid "Sudo password"
-msgstr ""
-
-msgid "Sudo password is only applicable for SSH provider. Other providers ignore this field. <br> Password is stored encrypted in DB until the job finishes. For future or recurring executions, it is removed after the last execution."
-msgstr ""
-
 msgid "Sync Job Templates"
 msgstr ""
 
@@ -760,6 +813,9 @@ msgstr "使用者無法存取範本 %{template_name} 對應至功能 %{feature_n
 msgid "There was an error while updating the status, try refreshing the page."
 msgstr "更新狀態時發生錯誤，請更新此頁面。"
 
+msgid "This can happen if the host is removed or moved to another organization or location after the job was started"
+msgstr ""
+
 msgid "This template is locked for editing."
 msgstr "此範本已鎖定，因此無法編輯。"
 
@@ -886,9 +942,6 @@ msgstr "哪位使用者該用來執行此 script（使用類似 sudo 機制）"
 msgid "What user should be used to run the script (using sudo-like mechanisms). Defaults to a template parameter or global setting."
 msgstr "哪位使用者該用來執行此 script（使用類似 sudo 機制）。預設值設為範本參數或全域設定。"
 
-msgid "When enabled, the remote execution will try to run the commands directly, when no proxy with remote execution feature is configured for the host."
-msgstr ""
-
 msgid "When enabled, working directories will be removed after task completion. You may override this per host by setting a parameter called remote_execution_cleanup_working_dirs."
 msgstr ""
 
@@ -922,9 +975,15 @@ msgstr "為此範本新增輸入集，以參照至不同的範本輸入"
 msgid "cancelled"
 msgstr "已取消"
 
+msgid "default_capsule method missing from SmartProxy"
+msgstr ""
+
 msgid "effective user"
 msgstr ""
 
+msgid "error"
+msgstr ""
+
 msgid "error during rendering: %s"
 msgstr "處理時發生錯誤：%s"
 
@@ -949,9 +1008,6 @@ msgstr "找不到包含的範本 '%s'"
 msgid "input macro with name '%s' used, but no input with such name defined for this template"
 msgstr "使用了名為 '%s' 的輸入巨集，但此範本並未輸入這樣的名稱"
 
-msgid "planned"
-msgstr ""
-
 msgid "queued"
 msgstr "已排程"
 
@@ -961,9 +1017,6 @@ msgstr ""
 msgid "remove template input set"
 msgstr "移除範本輸入集"
 
-msgid "running"
-msgstr "執行中"
-
 msgid "running %{percent}%%"
 msgstr ""
 
@@ -973,9 +1026,6 @@ msgstr "秒"
 msgid "succeeded"
 msgstr "已成功"
 
-msgid "success"
-msgstr "成功"
-
 msgid "tasks at a time"
 msgstr ""
 

data/package.json

@@ -28,9 +28,10 @@
     "@theforeman/vendor-dev": "^4.14.0",
     "babel-eslint": "^10.0.0",
     "eslint": "^6.8.0",
-    "prettier": "^1.19.1"
+    "prettier": "^1.19.1",
+    "@patternfly/react-catalog-view-extension": "^4.8.126"
   },
   "peerDependencies": {
-    "@theforeman/vendor": ">= 4.14.0"
+    "@theforeman/vendor": "^8.3.0"
   }
 }

data/test/helpers/remote_execution_helper_test.rb

@@ -23,4 +23,20 @@ class RemoteExecutionHelperTest < ActionView::TestCase
                                                         "Exit status: 0"])
     end
   end
+
+  describe 'test correct setting' do
+    it 'should found correct template from setting' do
+      Setting::RemoteExecution.load_defaults
+      template_name = 'Job Invocation Report Template'
+      setting_key = 'remote_execution_job_invocation_report_template'
+      template = FactoryBot.create(:report_template, name: template_name)
+      input = FactoryBot.create(:template_input, name: 'job_id', input_type: 'user')
+      template.template_inputs << input
+      Setting.expects(:[]).with(setting_key).returns(template_name)
+
+      found_template = job_report_template
+
+      assert_equal template.id, found_template.id
+    end
+  end
 end

data/test/unit/job_invocation_composer_test.rb

@@ -16,16 +16,34 @@ class JobInvocationComposerTest < ActiveSupport::TestCase
     setup_user('create', 'hosts')
   end
 
+  class AnsibleInputs < RemoteExecutionProvider
+    class << self
+      def provider_input_namespace
+        :ansible
+      end
+
+      def provider_inputs
+        [
+          ForemanRemoteExecution::ProviderInput.new(name: 'tags', label: 'Tags', value: 'fooo', value_type: 'plain'),
+          ForemanRemoteExecution::ProviderInput.new(name: 'tags_flag', label: 'Tags Flag', value: '--tags', options: "--tags\n--skip-tags"),
+        ]
+      end
+    end
+  end
+  RemoteExecutionProvider.register(:AnsibleInputs, AnsibleInputs)
+
   let(:trying_job_template_1) { FactoryBot.create(:job_template, :job_category => 'trying_job_template_1', :name => 'trying1', :provider_type => 'SSH') }
   let(:trying_job_template_2) { FactoryBot.create(:job_template, :job_category => 'trying_job_template_2', :name => 'trying2', :provider_type => 'Mcollective') }
   let(:trying_job_template_3) { FactoryBot.create(:job_template, :job_category => 'trying_job_template_1', :name => 'trying3', :provider_type => 'SSH') }
   let(:unauthorized_job_template_1) { FactoryBot.create(:job_template, :job_category => 'trying_job_template_1', :name => 'unauth1', :provider_type => 'SSH') }
   let(:unauthorized_job_template_2) { FactoryBot.create(:job_template, :job_category => 'unauthorized_job_template_2', :name => 'unauth2', :provider_type => 'Ansible') }
 
+  let(:provider_inputs_job_template) { FactoryBot.create(:job_template, :job_category => 'trying_test_inputs', :name => 'trying provider inputs', :provider_type => 'AnsibleInputs') }
 
   let(:input1) { FactoryBot.create(:template_input, :template => trying_job_template_1, :input_type => 'user') }
   let(:input2) { FactoryBot.create(:template_input, :template => trying_job_template_3, :input_type => 'user') }
   let(:input3) { FactoryBot.create(:template_input, :template => trying_job_template_1, :input_type => 'user', :required => true) }
+  let(:input4) { FactoryBot.create(:template_input, :template => provider_inputs_job_template, :input_type => 'user') }
   let(:unauthorized_input1) { FactoryBot.create(:template_input, :template => unauthorized_job_template_1, :input_type => 'user') }
 
   let(:ansible_params) { { } }
@@ -605,7 +623,9 @@ class JobInvocationComposerTest < ActiveSupport::TestCase
   end
 
   describe '#from_api_params' do
-    let(:composer) { JobInvocationComposer.from_api_params(params) }
+    let(:composer) do
+      JobInvocationComposer.from_api_params(params)
+    end
     let(:bookmark) { bookmarks(:one) }
 
     context 'with targeting from bookmark' do
@@ -659,6 +679,26 @@ class JobInvocationComposerTest < ActiveSupport::TestCase
       end
     end
 
+    context 'with provider inputs' do
+      let(:params) do
+        { :job_category => provider_inputs_job_template.job_category,
+            :job_template_id => provider_inputs_job_template.id,
+            :targeting_type => 'static_query',
+          :search_query => 'some hosts',
+          :inputs => { input4.name => 'some_value' },
+          :ansible => { 'tags' => 'bar', 'tags_flag' => '--skip-tags' } }
+      end
+
+      it 'detects provider inputs' do
+        assert composer.save!
+        scope = composer.job_invocation.pattern_template_invocations.first.provider_input_values
+        tags = scope.find_by :name => 'tags'
+        flags = scope.find_by :name => 'tags_flag'
+        assert_equal 'bar', tags.value
+        assert_equal '--skip-tags', flags.value
+      end
+    end
+
     context 'with effective user' do
       let(:params) do
         { :job_category => trying_job_template_1.job_category,

data/test/unit/job_invocation_report_template_test.rb

@@ -0,0 +1,57 @@
+require 'test_plugin_helper'
+
+class JobReportTemplateTest < ActiveSupport::TestCase
+  class FakeTask < OpenStruct
+    class Jail < Safemode::Jail
+      allow :action_continuous_output, :result, :ended_at
+    end
+  end
+
+  context 'with valid job invocation report template' do
+    let(:job_invocation_template) do
+      file_path = File.read(File.expand_path(Rails.root + "app/views/unattended/report_templates/jobs_-_invocation_report_template.erb"))
+      template = ReportTemplate.import_without_save("Job Invocation Report Template", file_path)
+      template.save!
+      template
+    end
+
+    describe 'template setting' do
+      it 'in settings includes only report templates with job_id input' do
+        FactoryBot.create(:report_template, name: 'Template 1')
+        job_invocation_template
+        templates = Setting::RemoteExecution.job_invocation_report_templates_select
+
+        assert_include templates, 'Job Invocation Report Template'
+      end
+    end
+
+    describe 'task reporting' do
+      let(:fake_outputs) do
+        [
+          { 'output_type' => 'stderr', 'output' => "error", 'timestamp' => Time.new(2020, 12, 1, 0, 0, 0).utc },
+          { 'output_type' => 'stdout', 'output' => "output", 'timestamp' => Time.new(2020, 12, 1, 0, 0, 0).utc },
+          { 'output_type' => 'stdebug', 'output' => "debug", 'timestamp' => Time.new(2020, 12, 1, 0, 0, 0).utc },
+        ]
+      end
+      let(:fake_task) { FakeTask.new(result: 'success', action_continuous_output: fake_outputs) }
+
+      it 'should render task outputs' do
+        job_invocation = FactoryBot.create(:job_invocation, :with_task)
+        JobInvocation.any_instance.expects(:sub_task_for_host).returns(fake_task)
+
+        input = job_invocation_template.template_inputs.first
+        composer_params = { template_id: job_invocation_template.id, input_values: { input.id.to_s => { value: job_invocation.id.to_s } } }
+        result = ReportComposer.new(composer_params).render
+
+        # parsing the CSV result
+        CSV.parse(result.strip, headers: true).each_with_index do |row, i|
+          row_hash = row.to_h
+          assert_equal 'success', row_hash['result']
+          assert_equal fake_outputs[i]['output_type'], row_hash['type']
+          assert_equal fake_outputs[i]['output'], row_hash['message']
+          assert_kind_of Time, Time.zone.parse(row_hash['time']), 'Parsing of time column failed'
+        end
+      end
+    end
+  end
+end

data/webpack/JobWizard/JobWizard.js

@@ -1,21 +1,45 @@
-import React from 'react';
+import React, { useState } from 'react';
 import { Wizard } from '@patternfly/react-core';
 import { translate as __ } from 'foremanReact/common/I18n';
 import history from 'foremanReact/history';
+import CategoryAndTemplate from './steps/CategoryAndTemplate/';
+import './JobWizard.scss';
 
 export const JobWizard = () => {
+  const [jobTemplate, setJobTemplate] = useState(null);
+  const [category, setCategory] = useState('');
   const steps = [
     {
       name: __('Category and template'),
-      component: <p>Category and template</p>,
+      component: (
+        <CategoryAndTemplate
+          jobTemplate={jobTemplate}
+          setJobTemplate={setJobTemplate}
+          category={category}
+          setCategory={setCategory}
+        />
+      ),
+    },
+    {
+      name: __('Target hosts'),
+      component: <p>TargetHosts </p>,
+      canJumpTo: !!jobTemplate,
+    },
+    {
+      name: __('Advanced fields'),
+      component: <p> AdvancedFields </p>,
+      canJumpTo: !!jobTemplate,
+    },
+    {
+      name: __('Schedule'),
+      component: <p>Schedule</p>,
+      canJumpTo: !!jobTemplate,
     },
-    { 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',
+      canJumpTo: !!jobTemplate,
     },
   ];
   const title = __('Run Job');
@@ -25,8 +49,7 @@ export const JobWizard = () => {
       navAriaLabel={`${title} steps`}
       steps={steps}
       height="70vh"
+      className="job-wizard"
     />
   );
 };
-
-export default JobWizard;