foreman_remote_execution 16.6.5 → 16.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 803af8d6f1617172c150d68158d14d6fa9df2e5cc431226c1c0522f679420c7b
-  data.tar.gz: 43b21d05688e374f58999c890d0ed3fedcf8e98d978be053bc52f83701e89292
+  metadata.gz: 87f61f660cc9bb15e87453747aca6cef5d600d4fd3994d090c5af8a4e48f1b8a
+  data.tar.gz: 16e86afd877b2c2dec48daba1ff05c98822208a9c777d5351a9bf04edbd21322
 SHA512:
-  metadata.gz: 9fed722946268e04461455cffe63c27add5a23a5a0e2bbdd698a2d7bd7c94017deb0342650ecaadf92426d64db8e40682f8871ab4a43a7e60e24c1096c230bb0
-  data.tar.gz: c11bfa8d9b1e72d2bb35d11829509923b6fb7babffd98a7782d5c8718adc9628def8739d388be1f5de07c239ba8b852c9de907c8e1b77383c573f460813ccff7
+  metadata.gz: 16a08a5afdbab46351b5fe9eb4fcf55c82ad0a56160585dbedbec48a32e2d47c9f595a8562505d5c97f69141d5e6174c0fcbb6e3fd0df481dd692b6c2b811b91
+  data.tar.gz: f1e886b6f85fc08820986b812d2d959b65c42e49ab411a42df47da1ec5ad077842f472f58e78f635fd71712fdf15a7bf2541d6921fc1d3788ebec9be1bcad995

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

@@ -19,13 +19,16 @@ module Api
 
       api :GET, '/job_invocations/:id', N_('Show job invocation')
       param :id, :identifier, :required => true
-      param :host_status, :bool, required: false, desc: N_('Show Job status for the hosts')
+      param :include_hosts, :bool, :required => false, :default_value => true, :desc => N_('Include hosts and template invocations in the response. Defaults to true for backwards compatibility. Pass false to skip serializing all hosts.')
+      param :host_status, :bool, :required => false, :default_value => false, :desc => N_('Show job status for each host, only applicable when include_hosts is true')
       def show
-        set_hosts_and_template_invocations
+        @pattern_template_invocations = @job_invocation.pattern_template_invocations.includes(:input_values)
         @job_organization = Taxonomy.find_by(id: @job_invocation.task.input[:current_organization_id])
         @job_location = Taxonomy.find_by(id: @job_invocation.task.input[:current_location_id])
-        if params[:host_status] == 'true'
-          set_statuses_and_smart_proxies
+
+        if include_hosts?
+          set_hosts_and_template_invocations
+          set_statuses_and_smart_proxies if Foreman::Cast.to_bool(params[:host_status])
         end
       end
 
@@ -84,13 +87,14 @@ module Api
 
       api :POST, '/job_invocations/', N_('Create a job invocation')
       param_group :job_invocation, :as => :create
+      param :include_hosts, :bool, :required => false, :default_value => true, :desc => N_('Include hosts and template invocations in the response. Defaults to true for backwards compatibility. Pass false to skip serializing all hosts.')
       def create
         composer = JobInvocationComposer.from_api_params(
           job_invocation_params
         )
         composer.trigger!
         @job_invocation = composer.job_invocation
-        @hosts = @job_invocation.targeting.hosts
+        set_hosts_and_template_invocations if include_hosts?
         process_response @job_invocation
       rescue JobInvocationComposer::JobTemplateNotFound, JobInvocationComposer::FeatureNotFound => e
         not_found(error: { message: e.message })
@@ -115,10 +119,10 @@ module Api
       param :id, :identifier, :required => true
       def hosts
         set_hosts_and_template_invocations
-        set_statuses_and_smart_proxies
         @total = @hosts.size
         @hosts = @hosts.search_for(params[:search], :order => params[:order]).paginate(:page => params[:page], :per_page => params[:per_page])
         @subtotal = @hosts.total_entries
+        set_statuses_and_smart_proxies
         if params[:awaiting]
           @hosts = @hosts.select { |host| @host_statuses[host.id] == 'N/A' }
         end
@@ -298,7 +302,6 @@ module Api
       end
 
       def set_hosts_and_template_invocations
-        @pattern_template_invocations = @job_invocation.pattern_template_invocations.includes(:input_values)
         @hosts = @job_invocation.targeting.hosts.authorized(:view_hosts, Host)
 
         if params[:search].present?
@@ -310,16 +313,22 @@ module Api
                                                .includes(:input_values)
       end
 
+      def include_hosts?
+        params[:include_hosts].nil? || Foreman::Cast.to_bool(params[:include_hosts])
+      end
+
       def set_statuses_and_smart_proxies
-        template_invocations = @template_invocations.includes(:run_host_job_task).to_a
+        template_invocations = @template_invocations.where(host_id: @hosts.select(:id))
+                                                    .includes(:run_host_job_task).to_a
         hosts = @hosts.to_a
-        @host_statuses = Hash[hosts.map do |host|
-          template_invocation = template_invocations.find { |ti| ti.host_id == host.id }
+        template_invocations_by_host_id = template_invocations.index_by(&:host_id)
+        @host_statuses = hosts.to_h do |host|
+          template_invocation = template_invocations_by_host_id[host.id]
           task = template_invocation.try(:run_host_job_task)
           [host.id, template_invocation_status(task, @job_invocation.task)]
-        end]
-        @smart_proxy_id = Hash[template_invocations.map { |ti| [ti.host_id, ti.smart_proxy_id] }]
-        @smart_proxy_name = Hash[template_invocations.map { |ti| [ti.host_id, ti.smart_proxy_name] }]
+        end
+        @smart_proxy_id = template_invocations.to_h { |ti| [ti.host_id, ti.smart_proxy_id] }
+        @smart_proxy_name = template_invocations.to_h { |ti| [ti.host_id, ti.smart_proxy_name] }
       end
     end
   end

data/app/views/api/v2/job_invocations/main.json.rabl

@@ -19,12 +19,14 @@ child :targeting do
   attributes :bookmark_id, :bookmark_name, :search_query, :targeting_type, :user_id, :status, :status_label,
     :randomized_ordering
 
-  child @hosts => :hosts do
-    extends 'api/v2/hosts/base'
+  if @hosts
+    child @hosts => :hosts do
+      extends 'api/v2/hosts/base'
 
-    if params[:host_status] == 'true'
-      node :job_status do |host|
-        @host_statuses[host.id]
+      if @host_statuses
+        node :job_status do |host|
+          @host_statuses[host.id]
+        end
       end
     end
   end
@@ -34,12 +36,14 @@ child :task do
   attributes :id, :state, :started_at
 end
 
-child @template_invocations do
-  attributes :template_id, :template_name, :host_id
-  child :input_values do
-    attributes :template_input_name, :template_input_id
-    node :value do |iv|
-      iv.template_input.respond_to?(:hidden_value) && iv.template_input.hidden_value? ? '*' * 5 : iv.value
+if @template_invocations
+  child @template_invocations => :template_invocations do
+    attributes :template_id, :template_name, :host_id
+    child :input_values do
+      attributes :template_input_name, :template_input_id
+      node :value do |iv|
+        iv.template_input.respond_to?(:hidden_value) && iv.template_input.hidden_value? ? '*' * 5 : iv.value
+      end
     end
   end
 end

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '16.6.5'.freeze
+  VERSION = '16.7.0'.freeze
 end

data/package.json

@@ -5,9 +5,9 @@
   "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",
+    "test": "tfm-test --plugin --config jest.config.js",
+    "test:watch": "tfm-test --plugin --config jest.config.js --watchAll",
+    "test:current": "tfm-test --plugin --config jest.config.js --watch",
     "publish-coverage": "tfm-publish-coverage"
   },
   "repository": {

data/test/functional/api/v2/job_invocations_controller_test.rb

@@ -27,7 +27,10 @@ module Api
           template = ActiveSupport::JSON.decode(@response.body)
           assert_not_empty template
           assert_equal template['job_category'], @invocation.job_category
-          assert_not_empty template['targeting']['hosts']
+          assert_not_nil template['targeting']
+          assert_not_empty template['pattern_template_invocations']
+          assert_not_nil template['targeting']['hosts']
+          assert_not_nil template['template_invocations']
         end
 
         test 'should get invocation detail when taxonomies are set' do
@@ -36,9 +39,17 @@ module Api
           assert_response :success
         end
 
+        test 'should exclude hosts when include_hosts=false' do
+          get :show, params: { :id => @invocation.id, :include_hosts => false }
+          assert_response :success
+          result = ActiveSupport::JSON.decode(@response.body)
+          assert_nil result['targeting']['hosts']
+          assert_nil result['template_invocations']
+        end
+
         test 'should see only permitted hosts' do
-          @user = FactoryBot.create(:user, admin: false)
-          @invocation.task.update(user: @user)
+          @user = FactoryBot.create(:user, :admin => false)
+          @invocation.task.update(:user => @user)
           setup_user('view', 'job_invocations', nil, @user)
           setup_user('view', 'hosts', 'name ~ nope.example.com', @user)
 
@@ -47,6 +58,29 @@ module Api
           response = ActiveSupport::JSON.decode(@response.body)
           assert_equal response['targeting']['hosts'], []
         end
+
+        test 'should ignore host_status when include_hosts=false' do
+          get :show, params: { :id => @invocation.id, :include_hosts => false, :host_status => true }
+          assert_response :success
+          result = ActiveSupport::JSON.decode(@response.body)
+          assert_nil result['targeting']['hosts']
+          assert_nil result['template_invocations']
+        end
+
+        test 'should include job_status per host when host_status=true' do
+          invocation = FactoryBot.create(:job_invocation, :with_template, :with_task)
+          invocation.template_invocations << FactoryBot.create(:template_invocation, :with_task, :with_host, :job_invocation => invocation)
+          invocation.job_category = invocation.pattern_template_invocations.first.template.job_category
+          invocation.targeting.hosts = invocation.template_invocations.map(&:host)
+          invocation.save!
+
+          get :show, params: { :id => invocation.id, :include_hosts => true, :host_status => true }
+          assert_response :success
+          result = ActiveSupport::JSON.decode(@response.body)
+          hosts = result['targeting']['hosts']
+          assert_not_empty hosts
+          assert hosts.all? { |h| h.key?('job_status') }, 'Expected job_status to be present on each host'
+        end
       end
 
       context 'creation' do
@@ -66,6 +100,20 @@ module Api
           assert_response :success
         end
 
+        test 'should include hosts in create response by default' do
+          post :create, params: { job_invocation: @attrs }
+          invocation = ActiveSupport::JSON.decode(@response.body)
+          assert_not_nil invocation['targeting']['hosts']
+          assert_response :success
+        end
+
+        test 'should exclude hosts from create response when include_hosts=false' do
+          post :create, params: { job_invocation: @attrs, include_hosts: false }
+          invocation = ActiveSupport::JSON.decode(@response.body)
+          assert_nil invocation['targeting']['hosts']
+          assert_response :success
+        end
+
         test 'should create with description format overridden' do
           @attrs[:description_format] = 'format'
           post :create, params: { job_invocation: @attrs }
@@ -235,6 +283,23 @@ module Api
         end
       end
 
+      describe '#hosts' do
+        test 'should compute job_status for the paginated subset' do
+          invocation = FactoryBot.create(:job_invocation, :with_template, :with_task)
+          2.times { invocation.template_invocations << FactoryBot.create(:template_invocation, :with_task, :with_host, :job_invocation => invocation) }
+          invocation.job_category = invocation.pattern_template_invocations.first.template.job_category
+          invocation.targeting.hosts = invocation.template_invocations.map(&:host)
+          invocation.save!
+
+          get :hosts, params: { :id => invocation.id, :page => 2, :per_page => 1 }
+          assert_response :success
+          result = ActiveSupport::JSON.decode(@response.body)
+          assert_equal 3, result['total']
+          assert_equal 1, result['results'].size
+          assert_equal(['success'], result['results'].map { |r| r['job_status'] })
+        end
+      end
+
       describe 'raw output' do
         let(:fake_output) do
           (1..5).map do |i|

data/webpack/JobInvocationDetail/CheckboxesActions.js

@@ -14,6 +14,7 @@ import {
 } from '@patternfly/react-icons';
 import axios from 'axios';
 import { foremanUrl } from 'foremanReact/common/helpers';
+import { usePermissions } from 'foremanReact/common/hooks/Permissions/permissionHooks';
 import { translate as __, sprintf } from 'foremanReact/common/I18n';
 import { addToast } from 'foremanReact/components/ToastsList';
 import PropTypes from 'prop-types';
@@ -24,10 +25,7 @@ import {
   DIRECT_OPEN_HOST_LIMIT,
   templateInvocationPageUrl,
 } from './JobInvocationConstants';
-import {
-  selectHasPermission,
-  selectTaskCancelable,
-} from './JobInvocationSelectors';
+import { selectTaskCancelable } from './JobInvocationSelectors';
 import OpenAllInvocationsModal from './OpenAllInvocationsModal';
 
 /* eslint-disable camelcase */
@@ -115,12 +113,8 @@ export const CheckboxesActions = ({
   const dispatch = useDispatch();
   const [toBeOpened, setToBeOpened] = useState([]);
 
-  const hasCreatePermission = useSelector(
-    selectHasPermission('create_job_invocations')
-  );
-  const hasCancelPermission = useSelector(
-    selectHasPermission('cancel_job_invocations')
-  );
+  const hasCreatePermission = usePermissions(['create_job_invocations']);
+  const hasCancelPermission = usePermissions(['cancel_job_invocations']);
   const jobSearchQuery = `job_invocation.id = ${jobID}`;
   const filterQuery =
     filter && filter !== 'all_statuses'

data/webpack/JobInvocationDetail/JobInvocationActions.js

@@ -19,7 +19,7 @@ export const getJobInvocation = url => dispatch => {
   const fetchData = withInterval(
     get({
       key: JOB_INVOCATION_KEY,
-      params: { include_permissions: true },
+      params: { include_permissions: true, include_hosts: false },
       url,
       handleError: () => {
         dispatch(stopInterval(JOB_INVOCATION_KEY));
@@ -44,6 +44,7 @@ export const updateJob = jobId => dispatch => {
     APIActions.get({
       url,
       key: UPDATE_JOB,
+      params: { include_hosts: false },
     })
   );
 };

data/webpack/JobInvocationDetail/JobInvocationConstants.js

@@ -6,7 +6,6 @@ import { useForemanHostDetailsPageUrl } from 'foremanReact/Root/Context/ForemanC
 import JobStatusIcon from '../react_app/components/RecentJobsCard/JobStatusIcon';
 
 export const JOB_INVOCATION_KEY = 'JOB_INVOCATION_KEY';
-export const CURRENT_PERMISSIONS = 'CURRENT_PERMISSIONS';
 export const UPDATE_JOB = 'UPDATE_JOB';
 export const CANCEL_JOB = 'CANCEL_JOB';
 export const GET_TASK = 'GET_TASK';
@@ -20,9 +19,6 @@ export const GET_TEMPLATE_INVOCATION = 'GET_TEMPLATE_INVOCATION';
 export const DIRECT_OPEN_HOST_LIMIT = 3;
 export const ALL_JOB_HOSTS = 'ALL_JOB_HOSTS';
 export const AWAITING_STATUS_FILTER = '(job_invocation.result = N/A)';
-export const currentPermissionsUrl = foremanUrl(
-  '/api/v2/permissions/current_permissions'
-);
 
 export const showTemplateInvocationUrl = (hostID, jobID) =>
   `/show_template_invocation_by_host/${hostID}/job_invocation/${jobID}`;
@@ -32,6 +28,10 @@ export const templateInvocationPageUrl = (hostID, jobID) =>
   `/job_invocations_detail/${jobID}/host_invocation/${hostID}`;
 
 export const jobInvocationDetailsUrl = id => `/job_invocations/${id}`;
+export const jobInvocationsIndexPath = '/job_invocations';
+export const jobInvocationsNewPath = '/job_invocations/new';
+export const jobInvocationsIndexUrl = foremanUrl(jobInvocationsIndexPath);
+export const jobInvocationsNewUrl = foremanUrl(jobInvocationsNewPath);
 
 export const STATUS = {
   PENDING: 'pending',

data/webpack/JobInvocationDetail/JobInvocationEmptyState.js

@@ -0,0 +1,52 @@
+import PropTypes from 'prop-types';
+import React from 'react';
+import { PageSection, PageSectionVariants } from '@patternfly/react-core';
+import { translate as __ } from 'foremanReact/common/I18n';
+import ResourceLoadFailedEmptyState from 'foremanReact/components/common/EmptyState/ResourceLoadFailedEmptyState';
+import {
+  jobInvocationsIndexUrl,
+  jobInvocationsNewUrl,
+} from './JobInvocationConstants';
+
+const JobInvocationEmptyState = ({
+  jobInvocationId,
+  httpStatus,
+  errorMessage,
+}) => (
+  <PageSection variant={PageSectionVariants.light}>
+    <ResourceLoadFailedEmptyState
+      resourceLabel={__('job invocation')}
+      resourceId={jobInvocationId}
+      httpStatus={httpStatus}
+      errorMessage={errorMessage}
+      viewPermissions={['view_job_invocations']}
+      requiredPermissions={['view_job_invocations']}
+      primaryAction={{
+        label: __('Go to job invocations'),
+        url: jobInvocationsIndexUrl,
+        ouiaId: 'job-invocation-empty-state-go-to-job-invocations-button',
+      }}
+      secondaryActions={[
+        {
+          label: __('Create a new job invocation'),
+          url: jobInvocationsNewUrl,
+          ouiaId: 'job-invocation-empty-state-create-new-job-invocation-button',
+        },
+      ]}
+      ouiaIdPrefix="job-invocation-empty-state"
+    />
+  </PageSection>
+);
+
+JobInvocationEmptyState.propTypes = {
+  jobInvocationId: PropTypes.string.isRequired,
+  httpStatus: PropTypes.number,
+  errorMessage: PropTypes.string,
+};
+
+JobInvocationEmptyState.defaultProps = {
+  httpStatus: null,
+  errorMessage: null,
+};
+
+export default JobInvocationEmptyState;

data/webpack/JobInvocationDetail/JobInvocationSelectors.js

@@ -3,13 +3,11 @@ import {
   selectAPIResponse,
   selectAPIStatus,
 } from 'foremanReact/redux/API/APISelectors';
-import { STATUS as APIStatus } from 'foremanReact/constants';
 import {
   JOB_INVOCATION_KEY,
   GET_TASK,
   GET_TEMPLATE_INVOCATION,
   LIST_TEMPLATE_INVOCATIONS,
-  CURRENT_PERMISSIONS,
 } from './JobInvocationConstants';
 
 export const selectItems = state =>
@@ -29,16 +27,3 @@ export const selectTemplateInvocationStatus = hostID => state =>
 export const selectTemplateInvocationList = state =>
   selectAPIResponse(state, LIST_TEMPLATE_INVOCATIONS)
     ?.template_invocations_task_by_hosts;
-
-export const selectCurrentPermisions = state =>
-  selectAPIResponse(state, CURRENT_PERMISSIONS);
-
-export const selectHasPermission = permissionRequired => state => {
-  const status = selectAPIStatus(state, CURRENT_PERMISSIONS);
-  const selectCurrentPermissions = selectCurrentPermisions(state)?.results;
-  return status === APIStatus.RESOLVED
-    ? selectCurrentPermissions?.some(
-        permission => permission.name === permissionRequired
-      )
-    : false;
-};