foreman_remote_execution 10.0.3 → 10.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6cbb748f9c9d67aba38a2fa62ad4e82306d665bd9ad0021c2125926207fd95f
-  data.tar.gz: 435f4a1aee85997d3ef430abf68a24da459bd55a09832a130e51c405638dbfd0
+  metadata.gz: afb4ca6a8728877e0e6447afaa11603a53932025e3eeecfeedb32b7f7dcf9b03
+  data.tar.gz: daf0a3e69e8a1202ac718995a294a8072f02d34abbf56c58c665d8c3dcd7e71f
 SHA512:
-  metadata.gz: 2b3b8b5d63dfc60911069228a9f0ff136ccfe536331bb53bf348b902ee4e0cbb1fb2e26ca3d209a409a5d78a03530d5e490460a6d024baf7a584ae755bbe88d3
-  data.tar.gz: e54b93592be98be9c6577f662d6a6e3298c36c9e7576b9325f4b1f981f94ff560865e37aaec4a87a8fe06ed933e433e66420326b9c7b5f6e72e13503b8ff4671
+  metadata.gz: 538a79f73bd6284f220f1203395255a5e36af2de580c99a9e17135e22206b2ac1cdcf5f363e1c2d207569b0a8323d22cb84b59b910be09806bf8b6991a684c98
+  data.tar.gz: 97ff7054e8a90c82c676cbe093b8977c589a8df2a7c14207e43103097c3827b7a0cc639e79ce8a929c0f634c93f7030e48a72f85f102531781ab1a06150f92f5

data/.eslintrc

@@ -1,5 +1,8 @@
 {
-  "plugins": ["@theforeman/foreman"],
+  "plugins": [
+    "@theforeman/foreman",
+    "@theforeman/rules"
+  ],
   "extends": [
     "plugin:@theforeman/foreman/core",
     "plugin:@theforeman/foreman/plugins"

data/.github/workflows/js_ci.yml

@@ -24,6 +24,9 @@ jobs:
       - name: Run plugin linter
         run: |
           npm run lint
+      - name: Run custom plugin linter
+        run: |
+          npm run lint:custom
       - name: Run plugin tests
         run: |
           npm run test

data/app/controllers/ui_job_wizard_controller.rb

@@ -1,7 +1,7 @@
 class UiJobWizardController < ApplicationController
   include FiltersHelper
   def categories
-    job_categories = resource_scope
+    job_categories = resource_scope(permission: action_permission)
                      .search_for("job_category ~ \"#{params[:search]}\"")
                      .where(:snippet => false)
                      .select(:job_category).distinct

data/app/models/job_template.rb

@@ -192,7 +192,7 @@ class JobTemplate < ::Template
     self.default = options[:default] unless options[:default].nil?
 
     # job templates have too long metadata, we remove them on parsing until it's stored in separate attribute
-    self.template = self.template.gsub(/<%\#.+?.-?%>\n?/m, '').strip
+    self.template = self.template.sub(/<%\#.+?.-?%>\n?/m, '').strip
   end
 
   def default_input_values(ignore_keys)

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

@@ -24,6 +24,10 @@
       <% end %>
       <% if job_invocation.execution_timeout_interval.present? %>
         <li><b><%= _("Timeout to kill after") %></b>: <%= job_invocation.execution_timeout_interval %> <%= _('seconds') %><br></li>
+        <% end %>
+      <% if job_invocation.time_to_pickup.present? %>
+        <li><b><%= _("Time to pickup") %></b>: <%= job_invocation.time_to_pickup %> <%= _('seconds') %><br>
+        </li>
       <% end %>
     </ul>
     </p>

data/app/views/job_templates/_custom_tabs.html.erb

@@ -1,7 +1,7 @@
 <div class="tab-pane" id="template_job">
 
   <%= autocomplete_f(f, :job_category,
-        :search_query => '',
+        :search_query => @template.job_category,
         :placeholder => _("Job category") + ' ...',
         :disabled => @template.locked?) %>
   <%= text_f f, :description_format,

data/extra/cockpit/foreman-cockpit-session

@@ -170,24 +170,41 @@ class Relay
   def initialize(proxy, params)
     @proxy = proxy
     @params = params
+    @inject_authorization = @params['ssh_user'] != 'root' && @params['effective_user_password']
   end
 
   def proxy_loop
     proxy1 = ProxyBuffer.new($stdin, @sock)
     proxy2 = ProxyBuffer.new(@sock, $stdout)
     proxy2.on_data do |data|
-      message = Cockpit.read_control(StringIO.new(data))
-      if message.is_a?(Hash) && message['command'] == 'authorize'
-        response = {
-          'command' => 'authorize',
-          'cookie' => message['cookie'],
-          'response' => @params['effective_user_password'],
-        }
-        proxy1.enqueue(Cockpit.encode_message(response))
-        ''
-      else
-        data
+      if @inject_authorization
+        sio = StringIO.new(data)
+        begin
+          message = Cockpit.read_control(sio)
+        rescue StandardError
+          # We're looking for one specific message, but the expectation that one
+          # invocation of this callback processes one message doesn't really
+          # hold. The message we're looking for is sent quite early in the
+          # communication, if at all, so the chance that it will be aligned with
+          # the beginning of the buffer is quite high. If we somehow fail to
+          # process the contents of the buffer, we should just carry on.
+          #
+          # With the authorization injection check in place, this is more of a
+          # precaution so that unexpectedly big message won't bring the entire
+          # thing down.
+        end
+        if message.is_a?(Hash) && message['command'] == 'authorize'
+          response = {
+            'command' => 'authorize',
+            'cookie' => message['cookie'],
+            'response' => @params['effective_user_password'],
+          }
+          proxy1.enqueue(Cockpit.encode_message(response))
+          @inject_authorization = false
+          data = sio.read # Return whatever was left unread after read_control
+        end
       end
+      data
     end
 
     proxies = [proxy1, proxy2]
@@ -271,7 +288,7 @@ class Relay
                 end
       raise AccessDeniedError, message
     else
-      raise CockpitError, "Error talking to smart proxy: #{response}"
+      raise CockpitError, "Error talking to smart proxy: #{body}"
     end
   end
 end

data/lib/foreman_remote_execution/engine.rb

@@ -158,7 +158,7 @@ module ForemanRemoteExecution
               collection: proc { ForemanRemoteExecution.job_invocation_report_templates_select }
             setting 'remote_execution_time_to_pickup',
               type: :integer,
-              description: N_('Time in seconds within which the host has to pick up a job. If the job is not picked up within this limit, the job will be cancelled. Defaults to 1 day.'),
+              description: N_('Time in seconds within which the host has to pick up a job. If the job is not picked up within this limit, the job will be cancelled. Defaults to 1 day. Applies only to pull-mqtt based jobs.'),
               default: 24 * 60 * 60,
               full_name: N_('Time to pickup')
           end

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '10.0.3'.freeze
+  VERSION = '10.0.5'.freeze
 end

data/package.json

@@ -4,6 +4,7 @@
   "license": "GPL-3.0",
   "scripts": {
     "lint": "tfm-lint --plugin -d /webpack",
+    "lint:custom": "eslint ./webpack",
     "test": "tfm-test --plugin",
     "test:watch": "tfm-test --plugin --watchAll",
     "test:current": "tfm-test --plugin --watch",
@@ -23,6 +24,7 @@
     "@babel/core": "^7.7.0",
     "@theforeman/builder": "^12.0.1",
     "@theforeman/eslint-plugin-foreman": "^12.0.1",
+    "@theforeman/eslint-plugin-rules": "^12.0.2",
     "@theforeman/test": "^12.0.1",
     "@theforeman/vendor-dev": "^12.0.1",
     "babel-eslint": "^10.0.0",

data/test/unit/job_template_test.rb

@@ -94,6 +94,8 @@ class JobTemplateTest < ActiveSupport::TestCase
       %>
 
       service <%= input("service_name") %> restart
+
+      <%# test comment %>
       END_TEMPLATE
 
       JobTemplate.import_raw!(template, :default => true)
@@ -122,7 +124,7 @@ class JobTemplateTest < ActiveSupport::TestCase
     end
 
     it 'has a template' do
-      _(template.template.squish).must_equal 'service <%= input("service_name") %> restart'
+      _(template.template.squish).must_equal 'service <%= input("service_name") %> restart <%# test comment %>'
     end
 
     it 'imports inputs' do

data/webpack/JobWizard/steps/AdvancedFields/Fields.js

@@ -59,7 +59,7 @@ export const TimeToPickupField = ({ value, setValue }) => (
       label: __('Time to pickup'),
       labelIcon: helpLabel(
         __(
-          'Interval in seconds, if the job is not picked up by a client within this interval it will be cancelled.'
+          'Interval in seconds, if the job is not picked up by a client within this interval it will be cancelled. Applies only to pull-mqtt based jobs'
         ),
         'time-to-pickup'
       ),

data/webpack/JobWizard/steps/ReviewDetails/helpers.js

@@ -23,9 +23,8 @@ export const parseRepeat = (repeatType, repeatData) => {
       const daysKeys = Object.keys(repeatData.daysOfWeek).filter(
         k => repeatData.daysOfWeek[k]
       );
-      const days = getWeekDays()
-        .filter((d, index) => index in daysKeys)
-        .join(', ');
+      const dayNames = getWeekDays();
+      const days = daysKeys.map(day => dayNames[day]).join(', ');
       return sprintf(__('Every week on %s at %s'), days, repeatData.at);
     }
     case repeatTypes.monthly:

data/webpack/JobWizard/steps/ReviewDetails/index.js

@@ -30,6 +30,9 @@ import { WizardTitle } from '../form/WizardTitle';
 import { parseEnd, parseRepeat } from './helpers';
 import { HostPreviewModal } from '../HostsAndInputs/HostPreviewModal';
 
+const maskValue = (isHidden, value) =>
+  isHidden ? '*'.repeat(value.length) : value;
+
 const ReviewDetails = ({
   jobCategory,
   jobTemplateID,
@@ -122,11 +125,11 @@ const ReviewDetails = ({
       ),
       value: stringHosts(),
     },
-    ...templateInputs.map(({ name }) => ({
+    ...templateInputs.map(({ name, hidden_value: isHidden }) => ({
       label: (
         <StepButton stepName={WIZARD_TITLES.hostsAndInputs}>{name}</StepButton>
       ),
-      value: templateValues[name],
+      value: maskValue(isHidden, templateValues[name]),
     })),
     {
       label: (
@@ -272,9 +275,9 @@ const ReviewDetails = ({
         ? __('Randomized')
         : __('Alphabetical'),
     },
-    ...advancedTemplateInputs.map(({ name }) => ({
+    ...advancedTemplateInputs.map(({ name, hidden_value: isHidden }) => ({
       label: name,
-      value: advancedValues.templateValues[name],
+      value: maskValue(isHidden, advancedValues.templateValues[name]),
     })),
   ];
 

data/webpack/JobWizard/steps/Schedule/RepeatCron.js

@@ -1,6 +1,14 @@
 import React, { useEffect } from 'react';
 import PropTypes from 'prop-types';
-import { TextInput, FormGroup, ValidatedOptions } from '@patternfly/react-core';
+import {
+  List,
+  ListItem,
+  ListComponent,
+  OrderType,
+  TextInput,
+  FormGroup,
+  ValidatedOptions,
+} from '@patternfly/react-core';
 import { translate as __ } from 'foremanReact/common/I18n';
 import { helpLabel } from '../form/FormHelpers';
 
@@ -19,15 +27,15 @@ export const RepeatCron = ({ repeatData, setRepeatData, setValid }) => {
       label={__('Cron line')}
       labelIcon={helpLabel(
         <div>
-          {__("Cron line format 'a b c d e', where:")}
+          {__("Cron line format '1 2 3 4 5', where:")}
           <br />
-          <ol>
-            <li>{__('is minute (range: 0-59)')}</li>
-            <li>{__('is hour (range: 0-23)')}</li>
-            <li>{__('is day of month (range: 1-31)')}</li>
-            <li>{__('is month (range: 1-12)')}</li>
-            <li>{__('is day of week (range: 0-6)')}</li>
-          </ol>
+          <List component={ListComponent.ol} type={OrderType.number}>
+            <ListItem>{__('is minute (range: 0-59)')}</ListItem>
+            <ListItem>{__('is hour (range: 0-23)')}</ListItem>
+            <ListItem>{__('is day of month (range: 1-31)')}</ListItem>
+            <ListItem>{__('is month (range: 1-12)')}</ListItem>
+            <ListItem>{__('is day of week (range: 0-6)')}</ListItem>
+          </List>
         </div>
       )}
       isRequired

data/webpack/JobWizard/steps/Schedule/RepeatWeek.js

@@ -9,11 +9,12 @@ export const getWeekDays = () => {
   const locale = documentLocale().replace(/-/g, '_');
   const baseDate = new Date(Date.UTC(2017, 0, 1)); // just a Sunday
   const weekDays = [];
+  const formatOptions = { weekday: 'short', timeZone: 'UTC' };
   for (let i = 0; i < 7; i++) {
     try {
-      weekDays.push(baseDate.toLocaleDateString(locale, { weekday: 'short' }));
+      weekDays.push(baseDate.toLocaleDateString(locale, formatOptions));
     } catch {
-      weekDays.push(baseDate.toLocaleDateString('en', { weekday: 'short' }));
+      weekDays.push(baseDate.toLocaleDateString('en', formatOptions));
     }
     baseDate.setDate(baseDate.getDate() + 1);
   }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_remote_execution
 version: !ruby/object:Gem::Version
-  version: 10.0.3
+  version: 10.0.5
 platform: ruby
 authors:
 - Foreman Remote Execution team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-20 00:00:00.000000000 Z
+date: 2023-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -576,7 +576,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.4.17
 signing_key:
 specification_version: 4
 summary: A plugin bringing remote execution to the Foreman, completing the config