Fixes #37630 - Display basic list of hosts on the new job_invocations…

… page

app/controllers/api/v2/job_invocations_controller.rb

@@ -3,10 +3,11 @@ module V2
     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])
 
@@ -27,7 +28,14 @@ def show
 
         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)] }]
+          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
 
@@ -111,6 +119,35 @@ def output
         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 :include, ['parameters', 'all_parameters'], :desc => N_("Array of extra information types to include")
+      param_group :search_and_pagination, ::Api::V2::BaseController
+      add_scoped_search_description_for(JobInvocation)
+      param :id, :identifier, :required => true
+      def hosts
+        @hosts = @job_invocation.targeting.hosts.authorized(:view_hosts, Host)
+        @total = @job_invocation.targeting.hosts.size
+        @template_invocations = @job_invocation.template_invocations
+                                               .where(host: @hosts)
+                                               .includes(:input_values)
+        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] }]
+
+        if params[:include].present?
+          @parameters = params[:include].include?('parameters')
+          @all_parameters = params[:include].include?('all_parameters')
+        end
+        @hosts = @hosts.search_for(params[:search], :order => params[:order]).paginate(:page => params[:page], :per_page => params[:per_page])
+        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 +224,7 @@ def allowed_nested_id
 
       def action_permission
         case params[:action]
-        when 'output', 'raw_output', 'outputs'
+        when 'output', 'raw_output', 'outputs', 'hosts'
           :view
         when 'cancel'
           :cancel
@@ -255,17 +292,6 @@ def delayed_task_output(task, default: nil)
       def parent_scope
         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'
-
-        task.result
-      end
     end
   end
 end

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

config/routes.rb

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

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,

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,79 @@ export const DATE_OPTIONS = {
   hour12: false,
   timeZoneName: 'short',
 };
+
+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 'Awaiting start':
+      return { title: __('Awaiting start'), status: 5 };
+    default:
+      return { title: hostJobStatus, status: 6 };
+  }
+};
+
+const Columns = () => {
+  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'),
+      tableTitle: ({ job_status }) =>
+        getColumnsStatus({ hostJobStatus: job_status }).title,
+      status: ({ job_status }) =>
+        getColumnsStatus({ hostJobStatus: job_status }).status,
+      wrapper: ({ job_status }) => {
+        const { title, status } = getColumnsStatus({
+          hostJobStatus: job_status,
+        });
+        return (
+          <JobStatusIcon status={status}>
+            {title || __('Unknown')}
+          </JobStatusIcon>
+        );
+      },
+      weight: 5,
+    },
+  };
+};
+
+export default Columns;

webpack/JobInvocationDetail/JobInvocationDetail.scss

@@ -38,4 +38,8 @@
     height: $chart_size;
   }
 }
+
+.job-invocation-host-table-page-section {
+  padding-top: 0px;
+}
 

webpack/JobInvocationDetail/JobInvocationHostTable.js

@@ -0,0 +1,126 @@
+/* eslint-disable camelcase */
+import PropTypes from 'prop-types';
+import React, { useMemo } from 'react';
+import { Tr, Td } from '@patternfly/react-table';
+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 { getControllerSearchProps } from 'foremanReact/constants';
+import Columns, {
+  JOB_INVOCATION_HOSTS,
+  STATUS_UPPERCASE,
+} from './JobInvocationConstants';
+
+const JobInvocationHostTable = ({ id }) => {
+  const columns = Columns();
+  const columnNamesKeys = Object.keys(columns);
+  const apiOptions = { key: JOB_INVOCATION_HOSTS, search: urlSearchQuery };
+  const {
+    search: 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 { setParamsAndAPI, params } = useSetParamsAndApiAndSearch({
+    defaultParams,
+    apiOptions,
+    setAPIOptions,
+  });
+
+  const combinedResponse = {
+    response: {
+      search: '',
+      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 { updateSearchQuery } = useBulkSelect({
+    initialSearchQuery: urlSearchQuery,
+  });
+
+  const controller = 'hosts';
+  const memoDefaultSearchProps = useMemo(
+    () => getControllerSearchProps(controller),
+    [controller]
+  );
+  memoDefaultSearchProps.autocomplete.url = foremanUrl(
+    `/${controller}/auto_complete_search`
+  );
+
+  return (
+    <TableIndexPage
+      apiUrl=""
+      apiOptions={apiOptions}
+      customSearchProps={memoDefaultSearchProps}
+      controller="hosts"
+      creatable={false}
+      replacementResponse={combinedResponse}
+      updateSearchQuery={updateSearchQuery}
+    >
+      <Table
+        ouiaId="job-invocation-hosts-table"
+        columns={columns}
+        params={params}
+        setParams={setParamsAndAPI}
+        itemCount={response?.subtotal}
+        results={response?.results}
+        url=""
+        refreshData={() => {}}
+        emptyMessage={
+          status === STATUS_UPPERCASE.RESOLVED &&
+          (response?.results?.length === 0 ||
+            response?.results?.length === undefined)
+            ? 'No hosts found'
+            : null
+        }
+        errorMessage={
+          status === STATUS_UPPERCASE.ERROR && response?.message
+            ? response.message
+            : null
+        }
+        isPending={status === STATUS_UPPERCASE.PENDING}
+        isDeleteable={false}
+      >
+        {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,
+};
+
+JobInvocationHostTable.defaultProps = {};
+
+export default JobInvocationHostTable;

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;