foreman_remote_execution 10.0.4 → 10.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afb55ca9ac902c2d13fa825bb4bf6b2a31cd3729f9f073b98f1add34001fdfa2
-  data.tar.gz: a3155cf9f3c74f9d7588984015dc47ba6b7a81d4bea04bcb3b870c4ad6306405
+  metadata.gz: 0d1dfb7b78f7d6b17a97fe16984983f966bb6f4bb8598601923fabccb31a31ff
+  data.tar.gz: ba03ab056e8d4fd77b61f3dee350c9aa8c029849e1837abe687fd138c5bf8f7a
 SHA512:
-  metadata.gz: d9e34ed092397296e54f100d3a5697ef18ee86e79f5a293e01c0fcf19b33c195d7cfdd1a8046079ab70fce503e2760b93ca616346ab3cd7a21c4df9ef2c10983
-  data.tar.gz: 54cb3b829257039f3f3568544ec3f944e247a966ffd8e06f6f9a4ef1d71c7a3aaf4d0b2b3f5cea78cec32fa0eaa7e67d818e264db5bcf8b63eb0ab0d7b4f1bff
+  metadata.gz: d246ff28f82ce483e189979542a02c7e5e35e850ca61761d73ae11468cfc152593571c5e9aee562b2869b80c3201885812bc779fb82d2138c61725ac203d5c50
+  data.tar.gz: f970e87c94079104ea58f7654559d3bf4b0ca02af756e7ac63201a0608ac3010c6502a68492d635f1daa62690c4e501739c53932c9da2a300aa56d84801e6a55

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/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/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '10.0.4'.freeze
+  VERSION = '10.0.6'.freeze
 end

data/package.json

@@ -21,6 +21,7 @@
     "url": "http://projects.theforeman.org/projects/foreman_remote_execution/issues"
   },
   "devDependencies": {
+    "@adobe/css-tools": "~4.2.0",
     "@babel/core": "^7.7.0",
     "@theforeman/builder": "^12.0.1",
     "@theforeman/eslint-plugin-foreman": "^12.0.1",

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/JobWizard.js

@@ -41,6 +41,8 @@ import { Footer } from './Footer';
 import './JobWizard.scss';
 
 export const JobWizard = ({ rerunData }) => {
+  const routerSearch = useSelector(selectRouterSearch);
+  const [feature, setFeature] = useState(routerSearch.feature);
   const jobCategoriesResponse = useSelector(selectJobCategoriesResponse);
   const [jobTemplateID, setJobTemplateID] = useState(
     rerunData?.template_invocations?.[0]?.template_id ||
@@ -58,7 +60,6 @@ export const JobWizard = ({ rerunData }) => {
     hostGroups: [],
   });
   const [hostsSearchQuery, setHostsSearchQuery] = useState('');
-  const routerSearch = useSelector(selectRouterSearch);
   const [fills, setFills] = useState(
     rerunData
       ? {
@@ -169,8 +170,23 @@ export const JobWizard = ({ rerunData }) => {
                   job_template: { name, description_format },
                 },
               }) => {
+                const allowedInputs = template_inputs
+                  .map(({ name: _name }) => _name)
+                  .concat(
+                    advanced_template_inputs.map(({ name: _name }) => _name)
+                  );
+                const prune = inputs =>
+                  allowedInputs.reduce(
+                    (acc, key) =>
+                      inputs.hasOwnProperty(key)
+                        ? { [key]: inputs[key], ...acc }
+                        : acc,
+                    {}
+                  );
+                setTemplateValues(prune);
                 setAdvancedValues(currentAdvancedValues => ({
                   ...currentAdvancedValues,
+                  templateValues: prune(currentAdvancedValues.templateValues),
                   description:
                     generateDefaultDescription({
                       description_format,
@@ -243,6 +259,7 @@ export const JobWizard = ({ rerunData }) => {
           setJobTemplate={setJobTemplateID}
           category={category}
           setCategory={setCategory}
+          setFeature={setFeature}
           isCategoryPreselected={
             !!rerunData || !!fills.feature || !!fills.template_id
           }
@@ -432,7 +449,7 @@ export const JobWizard = ({ rerunData }) => {
       hostsSearchQuery,
       location,
       organization,
-      feature: routerSearch?.feature,
+      feature,
       provider: templateResponse.provider_name,
       advancedInputs: templateResponse.advanced_template_inputs,
     });

data/webpack/JobWizard/steps/CategoryAndTemplate/CategoryAndTemplate.js

@@ -16,6 +16,7 @@ export const CategoryAndTemplate = ({
   selectedTemplateID,
   selectedCategory,
   setCategory,
+  setFeature,
   errors,
 }) => {
   const templatesGroups = {};
@@ -45,8 +46,16 @@ export const CategoryAndTemplate = ({
     if (selectedCategory !== newCategory) {
       setCategory(newCategory);
       setJobTemplate(null);
+      setFeature(null);
     }
   };
+  const onSelectTemplate = newTemplate => {
+    if (selectedTemplate !== newTemplate) {
+      setJobTemplate(newTemplate);
+      setFeature(null);
+    }
+  };
+
   const { categoryError, allTemplatesError, templateError } = errors;
   const isError = !!(categoryError || allTemplatesError || templateError);
   return (
@@ -68,7 +77,7 @@ export const CategoryAndTemplate = ({
           label={__('Job template')}
           fieldId="job_template"
           groups={Object.values(templatesGroups)}
-          setSelected={setJobTemplate}
+          setSelected={onSelectTemplate}
           selected={isTemplatesLoading ? [] : selectedTemplate}
           isDisabled={
             !!(categoryError || allTemplatesError || isTemplatesLoading)
@@ -103,6 +112,7 @@ CategoryAndTemplate.propTypes = {
   jobCategories: PropTypes.array,
   jobTemplates: PropTypes.array,
   setJobTemplate: PropTypes.func.isRequired,
+  setFeature: PropTypes.func.isRequired,
   selectedTemplateID: PropTypes.number,
   setCategory: PropTypes.func.isRequired,
   selectedCategory: PropTypes.string,

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

@@ -26,6 +26,7 @@ const ConnectedCategoryAndTemplate = ({
   setJobTemplate,
   category,
   setCategory,
+  setFeature,
   isCategoryPreselected,
 }) => {
   const dispatch = useDispatch();
@@ -104,6 +105,7 @@ const ConnectedCategoryAndTemplate = ({
       selectedTemplateID={jobTemplate}
       setCategory={setCategory}
       selectedCategory={category}
+      setFeature={setFeature}
       errors={errors}
     />
   );
@@ -114,6 +116,7 @@ ConnectedCategoryAndTemplate.propTypes = {
   setJobTemplate: PropTypes.func.isRequired,
   category: PropTypes.string.isRequired,
   setCategory: PropTypes.func.isRequired,
+  setFeature: PropTypes.func.isRequired,
   isCategoryPreselected: PropTypes.bool.isRequired,
 };
 ConnectedCategoryAndTemplate.defaultProps = { jobTemplate: null };

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

@@ -1,3 +1,4 @@
+import URI from 'urijs';
 import React, { useEffect } from 'react';
 import PropTypes from 'prop-types';
 import {
@@ -9,10 +10,25 @@ import {
   FormGroup,
   ValidatedOptions,
 } from '@patternfly/react-core';
+import { foremanUrl } from 'foremanReact/common/helpers';
+import { useForemanVersion } from 'foremanReact/Root/Context/ForemanContext';
 import { translate as __ } from 'foremanReact/common/I18n';
 import { helpLabel } from '../form/FormHelpers';
 
+const docUrl = foremanVersion => {
+  const rootUrl = `https://docs.theforeman.org/${foremanVersion}/`;
+  const section =
+    'Managing_Hosts/index-foreman-el.html#using-extended-cron-lines_managing-hosts';
+
+  const url = new URI({
+    path: '/links/manual',
+    query: { root_url: rootUrl, section },
+  });
+  return foremanUrl(url.href());
+};
+
 export const RepeatCron = ({ repeatData, setRepeatData, setValid }) => {
+  const foremanVersion = useForemanVersion();
   const { cronline } = repeatData;
   useEffect(() => {
     if (cronline) {
@@ -24,7 +40,7 @@ export const RepeatCron = ({ repeatData, setRepeatData, setValid }) => {
   }, [setValid, cronline]);
   return (
     <FormGroup
-      label={__('Cron line')}
+      label={__('Cron line (extended)')}
       labelIcon={helpLabel(
         <div>
           {__("Cron line format '1 2 3 4 5', where:")}
@@ -36,6 +52,14 @@ export const RepeatCron = ({ repeatData, setRepeatData, setValid }) => {
             <ListItem>{__('is month (range: 1-12)')}</ListItem>
             <ListItem>{__('is day of week (range: 0-6)')}</ListItem>
           </List>
+          <br />
+          {__(
+            'The cron line supports extended cron line syntax. For details please refer to the '
+          )}
+          <a href={docUrl(foremanVersion)} target="_blank" rel="noreferrer">
+            {__('documentation')}
+          </a>
+          .
         </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);
   }

data/webpack/__mocks__/foremanReact/Root/Context/ForemanContext/index.js

@@ -1,2 +1,3 @@
 export const useForemanOrganization = () => ({ id: 1 });
 export const useForemanLocation = () => ({ id: 2 });
+export const useForemanVersion = () => '3.7';

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_remote_execution
 version: !ruby/object:Gem::Version
-  version: 10.0.4
+  version: 10.0.6
 platform: ruby
 authors:
 - Foreman Remote Execution team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-19 00:00:00.000000000 Z
+date: 2023-08-14 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.16
+rubygems_version: 3.4.17
 signing_key:
 specification_version: 4
 summary: A plugin bringing remote execution to the Foreman, completing the config