foreman_remote_execution 16.5.2 → 16.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffbf84ca570a940e3062ae1116e4125f4917c297fb1f9123f4237dc98b8fe883
-  data.tar.gz: f98d79b128655e08cf36257c002d55b54c74213d4b90c3abd98d0a22f6e69790
+  metadata.gz: 4d4a947b587075d0d60662d365b36c3fab8006b958a363c39354b1f67f771c69
+  data.tar.gz: 16bc29adc59c2a3bf1605902aece3e9d0f2bbd67749f4bc1a429ae52507165c8
 SHA512:
-  metadata.gz: d10fc19094f9473ba0c16e19205e7b45c33c156fe90fcdd774249d319eb5140ce9d4fb627ed071f45c3885178bd7a81cf606e7fa68f87dc09910422f012b1c5f
-  data.tar.gz: 0c88bca591e83c4a7590ab018eb52a1b8e7110f20ec6cb5a0d8b8dab9ffab69eef5a943b223d33cbf6ed70c2cf12b4bfe93f105a84c0747dc3b226dfcdf51749
+  metadata.gz: 3766b56254d55dd3f520ca16cca021d558362db4a34ccb15fb6833124a14f5900deefc78fc4125b4128c28f8eafd6d41f9c97d5526702a66ff32eb28665cde6f
+  data.tar.gz: 1cb89677b91f21c07296af85bd5b18c993572965e701d8b8e55d0880ff5e5fc81b7d7a56a6a053a916309825489c3ec90d929092382f5dd1630fb44fd599a6fc

data/app/models/concerns/foreman_remote_execution/host_extensions.rb

@@ -109,11 +109,11 @@ module ForemanRemoteExecution
 
     def remote_execution_ssh_keys
       # only include public keys from SSH proxies that don't have SSH cert verification configured
-      remote_execution_proxies(%w(SSH Script), false).values.flatten.uniq.map { |proxy| proxy.pubkey if proxy.ca_pubkey.blank? }.compact.uniq
+      remote_execution_proxies(%w(SSH Script), false).values.flatten.uniq.map { |proxy| proxy.pubkey(refresh: false) if proxy.ca_pubkey(refresh: false).blank? }.compact.uniq
     end
 
     def remote_execution_ssh_ca_keys
-      remote_execution_proxies(%w(SSH Script), false).values.flatten.uniq.map { |proxy| proxy.ca_pubkey }.compact.uniq
+      remote_execution_proxies(%w(SSH Script), false).values.flatten.uniq.map { |proxy| proxy.ca_pubkey(refresh: false) }.compact.uniq
     end
 
     def drop_execution_interface_cache

data/app/models/concerns/foreman_remote_execution/smart_proxy_extensions.rb

@@ -7,12 +7,12 @@ module ForemanRemoteExecution
       end
     end
 
-    def pubkey
-      self[:pubkey] || update_pubkey
+    def pubkey(refresh: true)
+      self[:pubkey] || (refresh && update_pubkey || nil)
     end
 
-    def ca_pubkey
-      self[:ca_pubkey] || update_ca_pubkey
+    def ca_pubkey(refresh: true)
+      self[:ca_pubkey] || (refresh && update_ca_pubkey || nil)
     end
 
     def update_pubkey

data/app/views/api/v2/smart_proxies/ca_pubkey.json.rabl

@@ -1 +1 @@
-attribute :ca_pubkey => :remote_execution_ca_pubkey
+node(:remote_execution_ca_pubkey) { |p| p.ca_pubkey(refresh: false) }

data/app/views/api/v2/smart_proxies/pubkey.json.rabl

@@ -1 +1 @@
-attribute :pubkey => :remote_execution_pubkey
+node(:remote_execution_pubkey) { |p| p.pubkey(refresh: false) }

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '16.5.2'.freeze
+  VERSION = '16.5.3'.freeze
 end

data/test/unit/concerns/host_extensions_test.rb

@@ -11,8 +11,9 @@ class ForemanRemoteExecutionHostExtensionsTest < ActiveSupport::TestCase
     let(:sshkey) { 'ssh-rsa AAAAB3NzaC1yc2EAAAABJQ foo@example.com' }
 
     before do
-      SmartProxy.any_instance.stubs(:pubkey).returns(sshkey)
-      SmartProxy.any_instance.stubs(:ca_pubkey).returns(nil)
+      host.subnet.remote_execution_proxies.each do |proxy|
+        proxy.update(pubkey: sshkey, ca_pubkey: nil)
+      end
       Setting[:remote_execution_ssh_user] = 'root'
       Setting[:remote_execution_effective_user_method] = 'sudo'
     end
@@ -60,6 +61,17 @@ class ForemanRemoteExecutionHostExtensionsTest < ActiveSupport::TestCase
       User.current = nil
       assert_includes host.remote_execution_ssh_keys, sshkey
     end
+
+    it 'triggers no calls to the proxy' do
+      host.subnet.remote_execution_proxies.each do |proxy|
+        proxy.update(pubkey: nil)
+      end
+
+      SmartProxy.any_instance.expects(:update_pubkey).never
+      SmartProxy.any_instance.expects(:update_ca_pubkey).never
+
+      host.host_param('remote_execution_ssh_keys')
+    end
   end
 
   describe 'has ssh CA key configured' do
@@ -68,8 +80,9 @@ class ForemanRemoteExecutionHostExtensionsTest < ActiveSupport::TestCase
     let(:ca_sshkey) { 'ssh-rsa AAAAB3NzaC1yc2EAAAABJE bar@example.com' }
 
     before do
-      SmartProxy.any_instance.stubs(:pubkey).returns(sshkey)
-      SmartProxy.any_instance.stubs(:ca_pubkey).returns(ca_sshkey)
+      host.subnet.remote_execution_proxies.each do |proxy|
+        proxy.update(pubkey: sshkey, ca_pubkey: ca_sshkey)
+      end
       Setting[:remote_execution_ssh_user] = 'root'
       Setting[:remote_execution_effective_user_method] = 'sudo'
     end
@@ -102,6 +115,17 @@ class ForemanRemoteExecutionHostExtensionsTest < ActiveSupport::TestCase
       assert_includes host.host_param('remote_execution_ssh_ca_keys'), key
       assert_includes host.host_param('remote_execution_ssh_ca_keys'), ca_sshkey
     end
+
+    it 'triggers no calls to the proxy' do
+      host.subnet.remote_execution_proxies.each do |proxy|
+        proxy.update(ca_pubkey: nil)
+      end
+
+      SmartProxy.any_instance.expects(:update_pubkey).never
+      SmartProxy.any_instance.expects(:update_ca_pubkey).never
+
+      host.host_param('remote_execution_ssh_ca_keys')
+    end
   end
 
   context 'host has multiple nics' do

data/test/unit/concerns/smart_proxy_extensions_test.rb

@@ -0,0 +1,83 @@
+require 'test_plugin_helper'
+
+class ForemanRemoteExecutionSmartProxyExtensionsTest < ActiveSupport::TestCase
+  let(:proxy) { FactoryBot.create(:smart_proxy, :ssh) }
+
+  describe '#pubkey' do
+    context 'when key is cached in the database' do
+      it 'returns the cached key without fetching from proxy' do
+        proxy.expects(:update_pubkey).never
+        assert_equal 'ssh-rsa AAAAB3N...', proxy.pubkey
+        assert_equal 'ssh-rsa AAAAB3N...', proxy.pubkey(refresh: false)
+      end
+    end
+
+    context 'when key is not cached' do
+      before { proxy.update(pubkey: nil) }
+
+      it 'fetches from proxy by default' do
+        proxy.expects(:update_pubkey).returns('ssh-rsa FETCHED...')
+        assert_equal 'ssh-rsa FETCHED...', proxy.pubkey
+      end
+
+      it 'returns nil without fetching when refresh: false' do
+        proxy.expects(:update_pubkey).never
+        assert_nil proxy.pubkey(refresh: false)
+      end
+    end
+  end
+
+  describe '#ca_pubkey' do
+    context 'when key is cached in the database' do
+      before { proxy.update(ca_pubkey: 'ssh-rsa CA_KEY...') }
+
+      it 'returns the cached key without fetching from proxy' do
+        proxy.expects(:update_ca_pubkey).never
+        assert_equal 'ssh-rsa CA_KEY...', proxy.ca_pubkey
+        assert_equal 'ssh-rsa CA_KEY...', proxy.ca_pubkey(refresh: false)
+      end
+    end
+
+    context 'when key is not cached' do
+      before { proxy.update(ca_pubkey: nil) }
+
+      it 'fetches from proxy by default' do
+        proxy.expects(:update_ca_pubkey).returns('ssh-rsa FETCHED_CA...')
+        assert_equal 'ssh-rsa FETCHED_CA...', proxy.ca_pubkey
+      end
+
+      it 'returns nil without fetching when refresh: false' do
+        proxy.expects(:update_ca_pubkey).never
+        assert_nil proxy.ca_pubkey(refresh: false)
+      end
+    end
+  end
+
+  describe '#refresh' do
+    context 'when the key is cached' do
+      before do
+        proxy.update(pubkey: 'ssh-rsa KEY...', ca_pubkey: 'ssh-rsa CA_KEY...')
+      end
+
+      it 'fetches the keys' do
+        proxy.expects(:update_pubkey).once
+        proxy.expects(:update_ca_pubkey).once
+
+        proxy.refresh
+      end
+    end
+
+    context 'when the key is not cached' do
+      before do
+        proxy.update(pubkey: nil, ca_pubkey: nil)
+      end
+
+      it 'fetches the keys' do
+        proxy.expects(:update_pubkey).once
+        proxy.expects(:update_ca_pubkey).once
+
+        proxy.refresh
+      end
+    end
+  end
+end

data/webpack/JobInvocationDetail/__tests__/TemplateInvocation.test.js

@@ -11,6 +11,10 @@ import { mockTemplateInvocationResponse } from './fixtures';
 jest.spyOn(api, 'get');
 jest.mock('../JobInvocationSelectors');
 
+jest.mock('foremanReact/components/ToastsList', () => ({
+  addToast: jest.fn(payload => ({ type: 'ADD_TOAST', payload })),
+}));
+
 const mockStore = configureMockStore([]);
 const store = mockStore({
   HOSTS_API: {
@@ -186,4 +190,60 @@ describe('TemplateInvocation', () => {
       await screen.findByText('Successfully copied to clipboard!')
     ).toBeInTheDocument();
   });
+
+  describe('Cancel/Abort task buttons API calls', () => {
+    const responseWithCancellableTask = {
+      ...mockTemplateInvocationResponse,
+      task: { id: 'task-123', cancellable: true },
+      permissions: {
+        view_foreman_tasks: true,
+        cancel_job_invocations: true,
+        execute_jobs: true,
+      },
+    };
+
+    beforeEach(() => {
+      selectors.selectTemplateInvocationStatus.mockImplementation(() => () =>
+        'RESOLVED'
+      );
+      selectors.selectTemplateInvocation.mockImplementation(() => () =>
+        responseWithCancellableTask
+      );
+      jest.spyOn(api.APIActions, 'post').mockReturnValue({ type: 'MOCK_POST' });
+    });
+
+    test('clicking the `Cancel Task` button calls API with cancel param', () => {
+      render(
+        <Provider store={store}>
+          <TemplateInvocation {...mockProps} />
+        </Provider>
+      );
+      fireEvent.click(screen.getByText('Cancel Task'));
+
+      const postCall = api.APIActions.post.mock.calls.find(
+        call => call[0].key === 'CANCEL_TASK'
+      )?.[0];
+      expect(postCall.url).toBe(
+        `/foreman_tasks/tasks/${responseWithCancellableTask.task.id}/cancel`
+      );
+      expect(postCall.key).toBe('CANCEL_TASK');
+    });
+
+    test('clicking the `Abort Task` button calls API with abort param', () => {
+      render(
+        <Provider store={store}>
+          <TemplateInvocation {...mockProps} />
+        </Provider>
+      );
+      fireEvent.click(screen.getByText('Abort task'));
+
+      const postCall = api.APIActions.post.mock.calls.find(
+        call => call[0].key === 'ABORT_TASK'
+      )?.[0];
+      expect(postCall.url).toBe(
+        `/foreman_tasks/tasks/${responseWithCancellableTask.task.id}/abort`
+      );
+      expect(postCall.key).toBe('ABORT_TASK');
+    });
+  });
 });

data/webpack/JobWizard/JobWizard.js

@@ -1,6 +1,6 @@
 /* eslint-disable max-lines */
 /* eslint-disable camelcase */
-import React, { useState, useEffect, useCallback } from 'react';
+import React, { useState, useEffect, useCallback, useRef } from 'react';
 import { useDispatch, useSelector } from 'react-redux';
 import PropTypes from 'prop-types';
 import { Wizard } from '@patternfly/react-core/deprecated';
@@ -51,6 +51,8 @@ export const JobWizard = ({ rerunData }) => {
   const [category, setCategory] = useState(
     rerunData?.job_category || jobCategoriesResponse?.default_category || ''
   );
+  const categoryRef = useRef(category);
+  categoryRef.current = category;
   const [advancedValues, setAdvancedValues] = useState({ templateValues: {} });
   const [templateValues, setTemplateValues] = useState({});
   const [scheduleValue, setScheduleValue] = useState(initialScheduleState);
@@ -89,6 +91,10 @@ export const JobWizard = ({ rerunData }) => {
         concurrency_control = {},
       },
     }) => {
+      if (categoryRef.current !== job_category) {
+        setCategory(job_category);
+      }
+
       const advancedTemplateValues = {};
       const defaultTemplateValues = {};
       const inputs = template_inputs;

data/webpack/JobWizard/JobWizardSelectors.js

@@ -1,5 +1,7 @@
+/* eslint-disable camelcase */
 import URI from 'urijs';
 import { get } from 'lodash';
+import { createSelector } from 'reselect';
 import {
   selectAPIResponse,
   selectAPIStatus,
@@ -17,8 +19,12 @@ import {
   JOB_API_KEY,
 } from './JobWizardConstants';
 
+/** Stable fallbacks so useSelector does not see a new reference every run */
+const EMPTY_ARRAY = [];
+const EMPTY_OBJECT = {};
+
 export const selectRerunJobInvocationResponse = state =>
-  selectAPIResponse(state, JOB_API_KEY) || {};
+  selectAPIResponse(state, JOB_API_KEY) || EMPTY_OBJECT;
 
 export const selectRerunJobInvocationStatus = state =>
   selectAPIStatus(state, JOB_API_KEY);
@@ -27,19 +33,26 @@ export const selectJobTemplatesStatus = state =>
   selectAPIStatus(state, JOB_TEMPLATES);
 
 export const filterJobTemplates = templates =>
-  templates?.filter(template => !template.snippet) || [];
+  templates?.filter(template => !template.snippet) || EMPTY_ARRAY;
+
+const selectJobTemplatesResults = state =>
+  selectAPIResponse(state, JOB_TEMPLATES)?.results;
 
-export const selectJobTemplates = state =>
-  filterJobTemplates(selectAPIResponse(state, JOB_TEMPLATES)?.results);
+export const selectJobTemplates = createSelector(
+  [selectJobTemplatesResults],
+  results => filterJobTemplates(results)
+);
 
 export const selectJobTemplatesSearch = state =>
   selectAPIResponse(state, JOB_TEMPLATES)?.search;
 
 export const selectJobCategoriesResponse = state =>
-  selectAPIResponse(state, JOB_CATEGORIES) || {};
+  selectAPIResponse(state, JOB_CATEGORIES) || EMPTY_OBJECT;
 
-export const selectJobCategories = state =>
-  selectJobCategoriesResponse(state).job_categories || [];
+export const selectJobCategories = state => {
+  const { job_categories: jobCategories } = selectJobCategoriesResponse(state);
+  return jobCategories || EMPTY_ARRAY;
+};
 
 export const selectWithKatello = state =>
   selectJobCategoriesResponse(state).with_katello || false;
@@ -58,7 +71,7 @@ export const selectJobCategoriesMissingPermissions = state => {
       'data',
       'error',
       'missing_permissions',
-    ]) || []
+    ]) || EMPTY_ARRAY
   );
 };
 
@@ -75,29 +88,32 @@ export const selectEffectiveUser = state =>
   selectAPIResponse(state, JOB_TEMPLATE).effective_user;
 
 export const selectAdvancedTemplateInputs = state =>
-  selectAPIResponse(state, JOB_TEMPLATE).advanced_template_inputs || [];
+  selectAPIResponse(state, JOB_TEMPLATE)?.advanced_template_inputs ||
+  EMPTY_ARRAY;
 
 export const selectTemplateInputs = state =>
-  selectAPIResponse(state, JOB_TEMPLATE).template_inputs || [];
+  selectAPIResponse(state, JOB_TEMPLATE)?.template_inputs || EMPTY_ARRAY;
 
 export const selectHostsResponse = state => selectAPIResponse(state, HOSTS_API);
 
 export const selectHostCount = state =>
   selectHostsResponse(state).subtotal || 0;
 
-export const selectHosts = state => {
-  const hosts = selectHostsResponse(state).results || [];
+const selectHostsResults = state => selectHostsResponse(state).results;
+
+export const selectHosts = createSelector([selectHostsResults], results => {
+  const hosts = results || EMPTY_ARRAY;
   return hosts.map(host => ({
     name: host.name,
     display_name: host.display_name,
   }));
-};
+});
 
 export const selectHostsMissingPermissions = state => {
   const hostsResponse = selectHostsResponse(state);
   return (
     get(hostsResponse, ['response', 'data', 'error', 'missing_permissions']) ||
-    []
+    EMPTY_ARRAY
   );
 };
 
@@ -115,6 +131,6 @@ export const selectIsSubmitting = state =>
   selectAPIStatus(state, JOB_INVOCATION) === STATUS.RESOLVED;
 
 export const selectRouterSearch = state => {
-  const { search } = selectRouterLocation(state);
+  const { search } = selectRouterLocation(state) || {};
   return URI.parseQuery(search);
 };

data/webpack/JobWizard/__tests__/fixtures.js

@@ -30,6 +30,12 @@ export const pupptetJobTemplate = {
 
 export const jobTemplates = [jobTemplate];
 
+export const wizardJobTemplatesMockList = [
+  jobTemplate,
+  pupptetJobTemplate,
+  { ...jobTemplate, id: 2, name: 'template2' },
+];
+
 export const jobTemplateResponse = {
   job_template: jobTemplate,
   effective_user: {
@@ -137,11 +143,9 @@ export const testSetup = (selectors, api) => {
     () => jobTemplateResponse.advanced_template_inputs
   );
   selectors.selectJobCategories.mockImplementation(() => jobCategories);
-  selectors.selectJobTemplates.mockImplementation(() => [
-    jobTemplate,
-    pupptetJobTemplate,
-    { ...jobTemplate, id: 2, name: 'template2' },
-  ]);
+  selectors.selectJobTemplates.mockImplementation(
+    () => wizardJobTemplatesMockList
+  );
   selectors.selectJobTemplate.mockImplementation(() => jobTemplateResponse);
 
   selectors.selectEffectiveUser.mockImplementation(
@@ -187,13 +191,25 @@ export const mockApi = api => {
           },
         });
     } else if (action.key === 'JOB_TEMPLATE') {
-      handleSuccess &&
-        handleSuccess({
-          data:
-            action.url === '/ui_job_wizard/template/163'
-              ? { ...jobTemplateResponse, job_template: pupptetJobTemplate }
-              : jobTemplateResponse,
-        });
+      const url = String(action.url);
+      let templatePayload = jobTemplateResponse;
+      if (url.includes('/template/163')) {
+        templatePayload = {
+          ...jobTemplateResponse,
+          job_template: pupptetJobTemplate,
+        };
+      } else if (url.includes('/template/2')) {
+        const jobTemplate2 = { ...jobTemplate, id: 2, name: 'template2' };
+        templatePayload = {
+          ...jobTemplateResponse,
+          job_template: jobTemplate2,
+          effective_user: {
+            ...jobTemplateResponse.effective_user,
+            job_template_id: 2,
+          },
+        };
+      }
+      handleSuccess && handleSuccess({ data: templatePayload });
     } else if (action.key === 'JOB_TEMPLATES') {
       handleSuccess &&
         handleSuccess({
@@ -202,7 +218,7 @@ export const mockApi = api => {
               action.url.search() ===
               '?search=job_category%3D%22Puppet%22&per_page=all'
                 ? [pupptetJobTemplate]
-                : [jobTemplate],
+                : wizardJobTemplatesMockList,
           },
         });
     } else if (action.key === 'HOST_IDS') {

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

@@ -1,4 +1,4 @@
-import React, { useEffect } from 'react';
+import React, { useEffect, memo } from 'react';
 import { useSelector, useDispatch } from 'react-redux';
 import PropTypes from 'prop-types';
 import URI from 'urijs';
@@ -133,4 +133,4 @@ ConnectedCategoryAndTemplate.propTypes = {
 };
 ConnectedCategoryAndTemplate.defaultProps = { jobTemplate: null };
 
-export default ConnectedCategoryAndTemplate;
+export default memo(ConnectedCategoryAndTemplate);

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: foreman_remote_execution
 version: !ruby/object:Gem::Version
-  version: 16.5.2
+  version: 16.5.3
 platform: ruby
 authors:
 - Foreman Remote Execution team
 bindir: bin
 cert_chain: []
-date: 2026-03-17 00:00:00.000000000 Z
+date: 2026-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -390,6 +390,7 @@ files:
 - test/unit/concerns/foreman_tasks_cleaner_extensions_test.rb
 - test/unit/concerns/host_extensions_test.rb
 - test/unit/concerns/nic_extensions_test.rb
+- test/unit/concerns/smart_proxy_extensions_test.rb
 - test/unit/execution_task_status_mapper_test.rb
 - test/unit/input_template_renderer_test.rb
 - test/unit/job_invocation_composer_test.rb