foreman_remote_execution 14.0.2 → 14.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a73b13cdd10e99e44456d4b8dc1bbf8fe654dd6b83eb929e657df49d44b75078
-  data.tar.gz: a09d30bd37238e0dadd1e8bb8b32d41292df56aea1a03f19fdd2ab6386664ab3
+  metadata.gz: e0b4dd4f17f6d245a627cf09e014206e0392de844821d35cef065a9af835b399
+  data.tar.gz: 4b60be78f70b3791c02f57c08060cc771aeb33f5cfd985335f26f25f1db030c7
 SHA512:
-  metadata.gz: 6633435cacf5d2e835d8391bf2d035844d87db9be34c9fbd134d140a10559779b0f940109ba6feb8dfb0f35ab5b08accc5bec75c94e28ec12accc837c10c795c
-  data.tar.gz: 0e0417551e20786be7c7c87d1e694596ef8f118dbf303fece462810a6d4577f7bd99208dc6f8555cfb91b87a73914fc96a20185d9d7e2a3f6e76103cca5db31a
+  metadata.gz: 9f87b034acd048bf1a5fe968a418a3b03cd76880342e9aeec52303b19e8bfb097013f877c9a43a34ffc23cb8b5cc9614c30dba16188c8dbfa101fc0c94d18d52
+  data.tar.gz: a90d5d70bc9bf9a0480202699c62d48f7e78ad1f518d6421fbf478c866a29fe265a3a7a7a9ac9e4a9a15177212877ea3dbb2101696384faef7fc7eb9a0c27650

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

@@ -3,10 +3,11 @@ module Api
     class JobInvocationsController < ::Api::V2::BaseController
       include ::Api::Version2
       include ::Foreman::Renderer
+      include RemoteExecutionHelper
 
       before_action :find_optional_nested_object, :only => %w{output raw_output}
       before_action :find_host, :only => %w{output raw_output}
-      before_action :find_resource, :only => %w{show update destroy clone cancel rerun outputs}
+      before_action :find_resource, :only => %w{show update destroy clone cancel rerun outputs hosts}
 
       wrap_parameters JobInvocation, :include => (JobInvocation.attribute_names + [:ssh])
 
@@ -20,14 +21,9 @@ module Api
       param :id, :identifier, :required => true
       param :host_status, :bool, required: false, desc: N_('Show Job status for the hosts')
       def show
-        @hosts = @job_invocation.targeting.hosts.authorized(:view_hosts, Host)
-        @template_invocations = @job_invocation.template_invocations
-                                               .where(host: @hosts)
-                                               .includes(:input_values)
-
+        set_hosts_and_template_invocations
         if params[:host_status] == 'true'
-          template_invocations = @template_invocations.includes(:run_host_job_task).to_a
-          @host_statuses = Hash[template_invocations.map { |ti| [ti.host_id, template_invocation_status(ti)] }]
+          set_statuses_and_smart_proxies
         end
       end
 
@@ -111,6 +107,19 @@ module Api
         render :json => host_output(@nested_obj, @host, :default => [], :since => params[:since])
       end
 
+      api :GET, '/job_invocations/:id/hosts', N_('List hosts belonging to job invocation')
+      param_group :search_and_pagination, ::Api::V2::BaseController
+      add_scoped_search_description_for(JobInvocation)
+      param :id, :identifier, :required => true
+      def hosts
+        set_hosts_and_template_invocations
+        set_statuses_and_smart_proxies
+        @total = @job_invocation.targeting.hosts.size
+        @hosts = @hosts.search_for(params[:search], :order => params[:order]).paginate(:page => params[:page], :per_page => params[:per_page])
+        @subtotal = @hosts.respond_to?(:total_entries) ? @hosts.total_entries : @hosts.sizes
+        render :hosts, :layout => 'api/v2/layouts/index_layout'
+      end
+
       api :GET, '/job_invocations/:id/hosts/:host_id/raw', N_('Get raw output for a host')
       param :id, :identifier, :required => true
       param :host_id, :identifier, :required => true
@@ -187,7 +196,7 @@ module Api
 
       def action_permission
         case params[:action]
-        when 'output', 'raw_output', 'outputs'
+        when 'output', 'raw_output', 'outputs', 'hosts'
           :view
         when 'cancel'
           :cancel
@@ -256,15 +265,23 @@ module Api
         resource_class.where(nil)
       end
 
-      def template_invocation_status(template_invocation)
-        task = template_invocation.try(:run_host_job_task)
-        parent_task = @job_invocation.task
-
-        return(parent_task.result == 'cancelled' ? 'cancelled' : 'N/A') if task.nil?
-        return task.state if task.state == 'running' || task.state == 'planned'
-        return 'error' if task.result == 'warning'
+      def set_hosts_and_template_invocations
+        @hosts = @job_invocation.targeting.hosts.authorized(:view_hosts, Host)
+        @template_invocations = @job_invocation.template_invocations
+                                               .where(host: @hosts)
+                                               .includes(:input_values)
+      end
 
-        task.result
+      def set_statuses_and_smart_proxies
+        template_invocations = @template_invocations.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 }
+          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
     end
   end

data/app/helpers/remote_execution_helper.rb

@@ -18,9 +18,9 @@ module RemoteExecutionHelper
   end
 
   def template_invocation_status(task, parent_task)
-    return(parent_task.result == 'cancelled' ? _('cancelled') : _('Awaiting start')) if task.nil?
+    return(parent_task.result == 'cancelled' ? 'cancelled' : 'N/A') if task.nil?
     return task.state if task.state == 'running' || task.state == 'planned'
-    return _('error') if task.result == 'warning'
+    return 'error' if task.result == 'warning'
 
     task.result
   end

data/app/lib/actions/remote_execution/proxy_action.rb

@@ -33,7 +33,7 @@ module Actions
           {
             # For N-1 compatibility, we assume that the output provided here is
             # complete
-            sequence_id: update['sequence_id'] || seq_id,
+            external_id: update['id'] || seq_id,
             template_invocation_id: template_invocation.id,
             event: update['output'],
             timestamp: Time.at(update['timestamp']).getlocal,
@@ -41,17 +41,22 @@ module Actions
           }
         end
         if data['exit_status']
-          last = events.last || {:sequence_id => -1, :timestamp => Time.zone.now}
+          last = events.last || {:timestamp => Time.zone.now}
+          exit_timestamp = if data['exit_status_timestamp']
+                             Time.at(data['exit_status_timestamp']).getlocal
+                           else
+                             last[:timestamp] + 1
+                           end
           events << {
-            sequence_id: last[:sequence_id] + 1,
+            external_id: 'exit',
             template_invocation_id: template_invocation.id,
             event: data['exit_status'],
-            timestamp: last[:timestamp],
+            timestamp: exit_timestamp,
             event_type: 'exit',
           }
         end
         events.each_slice(1000) do |batch|
-          TemplateInvocationEvent.insert_all(batch, unique_by: [:template_invocation_id, :sequence_id]) # rubocop:disable Rails/SkipsModelValidations
+          TemplateInvocationEvent.insert_all(batch, unique_by: [:template_invocation_id, :external_id]) # rubocop:disable Rails/SkipsModelValidations
         end
       end
     end

data/app/lib/actions/remote_execution/run_host_job.rb

@@ -160,7 +160,7 @@ module Actions
           # This is enough, the error will get shown using add_exception at the end of the method
         end
 
-        task.template_invocation.template_invocation_events.order(:sequence_id).find_each do |output|
+        task.template_invocation.template_invocation_events.order(:timestamp).find_each do |output|
           if output.event_type == 'exit'
             continuous_output.add_output(_('Exit status: %s') % output.event, 'stdout', output.timestamp)
           else

data/app/lib/actions/remote_execution/template_invocation_progress_logging.rb

@@ -6,13 +6,12 @@ module Actions
       end
 
       def log_template_invocation_exception(exception)
-        last = template_invocation.template_invocation_events.order(:sequence_id).last
-        id = last ? last.sequence_id + 1 : 0
+        id = 'exception-' + SecureRandom.hex(4)
         template_invocation.template_invocation_events.create!(
           :event_type => 'debug',
           :event => "#{exception.class}: #{exception.message}",
           :timestamp => Time.zone.now,
-          :sequence_id => id
+          :external_id => id
         )
       end
 

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

@@ -0,0 +1,15 @@
+collection @hosts
+
+attribute :name, :operatingsystem_id, :operatingsystem_name, :hostgroup_id, :hostgroup_name
+
+node :job_status do |host|
+  @host_statuses[host.id]
+end
+
+node :smart_proxy_id do |host|
+  @smart_proxy_id[host.id]
+end
+
+node :smart_proxy_name do |host|
+  @smart_proxy_name[host.id]
+end

data/config/routes.rb

@@ -63,6 +63,7 @@ Rails.application.routes.draw do
           get '/raw', :to => 'job_invocations#raw_output'
         end
         member do
+          get 'hosts'
           post 'cancel'
           post 'rerun'
           get  'template_invocations', :to => 'template_invocations#template_invocations'

data/db/migrate/20240312133027_extend_template_invocation_events.rb

@@ -0,0 +1,19 @@
+class ExtendTemplateInvocationEvents < ActiveRecord::Migration[6.1]
+  def up
+    change_table :template_invocation_events do |t|
+      t.string :external_id
+    end
+
+    TemplateInvocationEvent.update_all("external_id = CASE WHEN event_type = 'exit' THEN 'exit' ELSE sequence_id::varchar END")
+
+    remove_index :template_invocation_events, name: :unique_template_invocation_events_index
+    remove_column :template_invocation_events, :sequence_id
+
+    change_table :template_invocation_events do |t|
+      t.index [:template_invocation_id, :external_id],
+        unique: true,
+        name: 'unique_template_invocation_events_index'
+      t.change :external_id, :string, null: false
+    end
+  end
+end

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '14.0.2'.freeze
+  VERSION = '14.1.0'.freeze
 end

data/webpack/JobInvocationDetail/JobInvocationActions.js

@@ -15,7 +15,7 @@ import {
   UPDATE_JOB,
 } from './JobInvocationConstants';
 
-export const getData = url => dispatch => {
+export const getJobInvocation = url => dispatch => {
   const fetchData = withInterval(
     get({
       key: JOB_INVOCATION_KEY,

data/webpack/JobInvocationDetail/JobInvocationConstants.js

@@ -1,14 +1,21 @@
+/* eslint-disable camelcase */
+import React from 'react';
 import { foremanUrl } from 'foremanReact/common/helpers';
+import { translate as __ } from 'foremanReact/common/I18n';
+import { useForemanHostDetailsPageUrl } from 'foremanReact/Root/Context/ForemanContext';
+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';
+export const GET_TEMPLATE_INVOCATIONS = 'GET_TEMPLATE_INVOCATIONS';
 export const CHANGE_ENABLED_RECURRING_LOGIC = 'CHANGE_ENABLED_RECURRING_LOGIC';
 export const CANCEL_RECURRING_LOGIC = 'CANCEL_RECURRING_LOGIC';
 export const GET_REPORT_TEMPLATES = 'GET_REPORT_TEMPLATES';
 export const GET_REPORT_TEMPLATE_INPUTS = 'GET_REPORT_TEMPLATE_INPUTS';
+export const JOB_INVOCATION_HOSTS = 'JOB_INVOCATION_HOSTS';
 export const currentPermissionsUrl = foremanUrl(
   '/api/v2/permissions/current_permissions'
 );
@@ -20,6 +27,12 @@ export const STATUS = {
   CANCELLED: 'cancelled',
 };
 
+export const STATUS_UPPERCASE = {
+  RESOLVED: 'RESOLVED',
+  ERROR: 'ERROR',
+  PENDING: 'PENDING',
+};
+
 export const DATE_OPTIONS = {
   day: 'numeric',
   month: 'short',
@@ -29,3 +42,74 @@ export const DATE_OPTIONS = {
   hour12: false,
   timeZoneName: 'short',
 };
+
+const Columns = () => {
+  const getColumnsStatus = ({ hostJobStatus }) => {
+    switch (hostJobStatus) {
+      case 'success':
+        return { title: __('Succeeded'), status: 0 };
+      case 'error':
+        return { title: __('Failed'), status: 1 };
+      case 'planned':
+        return { title: __('Scheduled'), status: 2 };
+      case 'running':
+        return { title: __('Pending'), status: 3 };
+      case 'cancelled':
+        return { title: __('Cancelled'), status: 4 };
+      case 'N/A':
+        return { title: __('Awaiting start'), status: 5 };
+      default:
+        return { title: hostJobStatus, status: 6 };
+    }
+  };
+  const hostDetailsPageUrl = useForemanHostDetailsPageUrl();
+
+  return {
+    name: {
+      title: __('Name'),
+      wrapper: ({ name }) => (
+        <a href={`${hostDetailsPageUrl}${name}`}>{name}</a>
+      ),
+      weight: 1,
+    },
+    groups: {
+      title: __('Host group'),
+      wrapper: ({ hostgroup_id, hostgroup_name }) => (
+        <a href={`/hostgroups/${hostgroup_id}/edit`}>{hostgroup_name}</a>
+      ),
+      weight: 2,
+    },
+    os: {
+      title: __('OS'),
+      wrapper: ({ operatingsystem_id, operatingsystem_name }) => (
+        <a href={`/operatingsystems/${operatingsystem_id}/edit`}>
+          {operatingsystem_name}
+        </a>
+      ),
+      weight: 3,
+    },
+    smart_proxy: {
+      title: __('Smart proxy'),
+      wrapper: ({ smart_proxy_name, smart_proxy_id }) => (
+        <a href={`/smart_proxies/${smart_proxy_id}`}>{smart_proxy_name}</a>
+      ),
+      weight: 4,
+    },
+    status: {
+      title: __('Status'),
+      wrapper: ({ job_status }) => {
+        const { title, status } = getColumnsStatus({
+          hostJobStatus: job_status,
+        });
+        return (
+          <JobStatusIcon status={status}>
+            {title || __('Unknown')}
+          </JobStatusIcon>
+        );
+      },
+      weight: 5,
+    },
+  };
+};
+
+export default Columns;

data/webpack/JobInvocationDetail/JobInvocationDetail.scss

@@ -38,4 +38,3 @@
     height: $chart_size;
   }
 }
-  

data/webpack/JobInvocationDetail/JobInvocationHostTable.js

@@ -0,0 +1,210 @@
+/* eslint-disable camelcase */
+import PropTypes from 'prop-types';
+import React, { useMemo, useEffect } from 'react';
+import { Icon } from 'patternfly-react';
+import { translate as __ } from 'foremanReact/common/I18n';
+import { FormattedMessage } from 'react-intl';
+import { Tr, Td } from '@patternfly/react-table';
+import {
+  Title,
+  EmptyState,
+  EmptyStateVariant,
+  EmptyStateBody,
+} from '@patternfly/react-core';
+import { foremanUrl } from 'foremanReact/common/helpers';
+import { useAPI } from 'foremanReact/common/hooks/API/APIHooks';
+import { Table } from 'foremanReact/components/PF4/TableIndexPage/Table/Table';
+import TableIndexPage from 'foremanReact/components/PF4/TableIndexPage/TableIndexPage';
+import { useSetParamsAndApiAndSearch } from 'foremanReact/components/PF4/TableIndexPage/Table/TableIndexHooks';
+import {
+  useBulkSelect,
+  useUrlParams,
+} from 'foremanReact/components/PF4/TableIndexPage/Table/TableHooks';
+import Pagination from 'foremanReact/components/Pagination';
+import { getControllerSearchProps } from 'foremanReact/constants';
+import Columns, {
+  JOB_INVOCATION_HOSTS,
+  STATUS_UPPERCASE,
+} from './JobInvocationConstants';
+
+const JobInvocationHostTable = ({ id, targeting, finished, autoRefresh }) => {
+  const columns = Columns();
+  const columnNamesKeys = Object.keys(columns);
+  const apiOptions = { key: JOB_INVOCATION_HOSTS };
+  const {
+    searchParam: urlSearchQuery = '',
+    page: urlPage,
+    per_page: urlPerPage,
+  } = useUrlParams();
+  const defaultParams = { search: urlSearchQuery };
+  if (urlPage) defaultParams.page = Number(urlPage);
+  if (urlPerPage) defaultParams.per_page = Number(urlPerPage);
+  const { response, status, setAPIOptions } = useAPI(
+    'get',
+    `/api/job_invocations/${id}/hosts`,
+    {
+      params: { ...defaultParams, key: JOB_INVOCATION_HOSTS },
+    }
+  );
+
+  const combinedResponse = {
+    response: {
+      search: urlSearchQuery,
+      can_create: false,
+      results: response?.results || [],
+      total: response?.total || 0,
+      per_page: response?.perPage,
+      page: response?.page,
+      subtotal: response?.subtotal || 0,
+      message: response?.message || 'error',
+    },
+    status,
+    setAPIOptions,
+  };
+
+  const { setParamsAndAPI, params } = useSetParamsAndApiAndSearch({
+    defaultParams,
+    apiOptions,
+    setAPIOptions: combinedResponse.setAPIOptions,
+  });
+
+  const { updateSearchQuery } = useBulkSelect({
+    initialSearchQuery: urlSearchQuery,
+  });
+
+  const controller = 'hosts';
+  const memoDefaultSearchProps = useMemo(
+    () => getControllerSearchProps(controller),
+    [controller]
+  );
+  memoDefaultSearchProps.autocomplete.url = foremanUrl(
+    `/${controller}/auto_complete_search`
+  );
+
+  useEffect(() => {
+    const intervalId = setInterval(() => {
+      if (!finished || autoRefresh) {
+        setAPIOptions(prevOptions => ({
+          ...prevOptions,
+          params: {
+            ...prevOptions.params,
+          },
+        }));
+      }
+    }, 5000);
+
+    return () => {
+      clearInterval(intervalId);
+    };
+  }, [finished, autoRefresh, setAPIOptions]);
+
+  const onPagination = newPagination => {
+    setParamsAndAPI({
+      ...params,
+      ...newPagination,
+      search: urlSearchQuery,
+    });
+  };
+
+  const bottomPagination = (
+    <Pagination
+      ouiaId="table-hosts-bottom-pagination"
+      key="table-bottom-pagination"
+      page={params.page}
+      perPage={params.perPage}
+      itemCount={response?.subtotal}
+      onChange={onPagination}
+    />
+  );
+
+  const customEmptyState = (
+    <Tr ouiaId="table-empty">
+      <Td colSpan={100}>
+        <EmptyState variant={EmptyStateVariant.xl}>
+          <span className="empty-state-icon">
+            <Icon name="add-circle-o" type="pf" size="2x" />
+          </span>
+          <Title ouiaId="empty-state-header" headingLevel="h5" size="4xl">
+            {__('No Results')}
+          </Title>
+          <EmptyStateBody>
+            <div className="empty-state-description">
+              {targeting?.targeting_type === 'dynamic_query' ? (
+                <FormattedMessage
+                  id="view-dynamic-hosts"
+                  defaultMessage={__(
+                    'The dynamic query is still being processed. You can {viewTheHosts} targeted by the query.'
+                  )}
+                  values={{
+                    viewTheHosts: (
+                      <a href={`/new/hosts?search=${targeting?.search_query}`}>
+                        {__('view the hosts')}
+                      </a>
+                    ),
+                  }}
+                />
+              ) : (
+                __('No hosts found')
+              )}
+            </div>
+          </EmptyStateBody>
+        </EmptyState>
+      </Td>
+    </Tr>
+  );
+
+  return (
+    <TableIndexPage
+      apiUrl=""
+      apiOptions={apiOptions}
+      customSearchProps={memoDefaultSearchProps}
+      controller="hosts"
+      creatable={false}
+      replacementResponse={combinedResponse}
+      updateSearchQuery={updateSearchQuery}
+    >
+      <Table
+        ouiaId="job-invocation-hosts-table"
+        columns={columns}
+        customEmptyState={
+          status === STATUS_UPPERCASE.RESOLVED && !response?.results?.length
+            ? customEmptyState
+            : null
+        }
+        params={params}
+        setParams={setParamsAndAPI}
+        itemCount={response?.subtotal}
+        results={response?.results}
+        url=""
+        refreshData={() => {}}
+        errorMessage={
+          status === STATUS_UPPERCASE.ERROR && response?.message
+            ? response.message
+            : null
+        }
+        isPending={status === STATUS_UPPERCASE.PENDING}
+        isDeleteable={false}
+        bottomPagination={bottomPagination}
+      >
+        {response?.results?.map((result, rowIndex) => (
+          <Tr key={rowIndex} ouiaId={`table-row-${rowIndex}`}>
+            {columnNamesKeys.map(k => (
+              <Td key={k}>{columns[k].wrapper(result)}</Td>
+            ))}
+          </Tr>
+        ))}
+      </Table>
+    </TableIndexPage>
+  );
+};
+
+JobInvocationHostTable.propTypes = {
+  id: PropTypes.string.isRequired,
+  targeting: PropTypes.object.isRequired,
+  finished: PropTypes.bool.isRequired,
+  autoRefresh: PropTypes.bool.isRequired,
+};
+
+JobInvocationHostTable.defaultProps = {};
+
+export default JobInvocationHostTable;

data/webpack/JobInvocationDetail/JobInvocationSelectors.js

@@ -1,10 +1,10 @@
 import { selectAPIResponse } from 'foremanReact/redux/API/APISelectors';
-import { JOB_INVOCATION_KEY } from './JobInvocationConstants';
+import { JOB_INVOCATION_KEY, GET_TASK } from './JobInvocationConstants';
 
 export const selectItems = state =>
   selectAPIResponse(state, JOB_INVOCATION_KEY);
 
-export const selectTask = state => selectAPIResponse(state, 'GET_TASK');
+export const selectTask = state => selectAPIResponse(state, GET_TASK);
 
 export const selectTaskCancelable = state =>
   selectTask(state).available_actions?.cancellable || false;

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

@@ -76,6 +76,10 @@ api.get.mockImplementation(({ handleSuccess, ...action }) => {
   return { type: 'get', ...action };
 });
 
+jest.mock('../JobInvocationHostTable.js', () => () => (
+  <div data-testid="mock-table">Mock Table</div>
+));
+
 const reportTemplateJobId = mockReportTemplatesResponse.results[0].id;
 
 const mockStore = configureMockStore([thunk]);
@@ -207,7 +211,7 @@ describe('JobInvocationDetailPage', () => {
       { key: GET_REPORT_TEMPLATES, url: '/api/report_templates' },
       {
         key: JOB_INVOCATION_KEY,
-        url: `/api/job_invocations/${jobId}`,
+        url: `/api/job_invocations/${jobId}?host_status=true`,
       },
       {
         key: GET_REPORT_TEMPLATE_INPUTS,

data/webpack/JobInvocationDetail/__tests__/fixtures.js

@@ -1,4 +1,7 @@
 export const jobInvocationData = {
+  search: '',
+  per_page: 20,
+  page: 1,
   id: 123,
   description: 'Description',
   job_category: 'Commands',
@@ -40,6 +43,9 @@ export const jobInvocationData = {
 };
 
 export const jobInvocationDataScheduled = {
+  search: '',
+  per_page: 20,
+  page: 1,
   id: 456,
   description: 'Description',
   job_category: 'Commands',
@@ -62,6 +68,9 @@ export const jobInvocationDataScheduled = {
 };
 
 export const jobInvocationDataRecurring = {
+  search: '',
+  per_page: 20,
+  page: 1,
   id: 789,
   description: 'Description',
   job_category: 'Commands',