foreman_remote_execution 12.0.5 → 13.1.0

data/test/unit/renderer_scope_input_test.rb

@@ -13,15 +13,15 @@ class RendererScopeInputTest < ActiveSupport::TestCase
     it 'caches the value under given key' do
       i = 1
       result = input.cached('some_key') { i }
-      _(result).must_equal 1
+      assert_equal 1, result
 
       i += 1
       result = input.cached('some_key') { i }
-      _(result).must_equal 1
+      assert_equal 1, result
 
       i += 1
       result = input.cached('different_key') { i }
-      _(result).must_equal 3
+      assert_equal 3, result
     end
   end
 
@@ -35,15 +35,15 @@ class RendererScopeInputTest < ActiveSupport::TestCase
     it 'does not cache the value' do
       i = 1
       result = input.cached('some_key') { i }
-      _(result).must_equal 1
+      assert_equal 1, result
 
       i += 1
       result = input.cached('some_key') { i }
-      _(result).must_equal 2
+      assert_equal 2, result
 
       i += 1
       result = input.cached('different_key') { i }
-      _(result).must_equal 3
+      assert_equal 3, result
     end
   end
 end

data/test/unit/targeting_test.rb

@@ -51,7 +51,7 @@ class TargetingTest < ActiveSupport::TestCase
       targeting.resolve_hosts!
     end
 
-    it { _(targeting.hosts).must_include(host) }
+    it { assert_includes targeting.hosts, host }
   end
 
   context 'can delete a user' do
@@ -63,7 +63,7 @@ class TargetingTest < ActiveSupport::TestCase
 
     it { assert_nil targeting.reload.user }
     it do
-      -> { targeting.resolve_hosts! }.must_raise(Foreman::Exception)
+      assert_raises(Foreman::Exception) { targeting.resolve_hosts! }
     end
   end
 
@@ -74,7 +74,7 @@ class TargetingTest < ActiveSupport::TestCase
       host.destroy
     end
 
-    it { _(targeting.reload.hosts).must_be_empty }
+    it { assert_empty targeting.reload.hosts }
   end
 
   describe '#resolve_hosts!' do
@@ -100,9 +100,9 @@ class TargetingTest < ActiveSupport::TestCase
         targeting.user = User.current
         targeting.resolve_hosts!
 
-        targeting.hosts.must_include host
-        targeting.hosts.must_include second_host
-        targeting.hosts.must_include infra_host
+        assert_includes targeting.hosts, host
+        assert_includes targeting.hosts, second_host
+        assert_includes targeting.hosts, infra_host
       end
     end
 
@@ -115,9 +115,9 @@ class TargetingTest < ActiveSupport::TestCase
         targeting.user = User.current
         targeting.resolve_hosts!
 
-        targeting.hosts.must_include host
-        targeting.hosts.must_include second_host
-        targeting.hosts.wont_include infra_host
+        assert_includes targeting.hosts, host
+        assert_includes targeting.hosts, second_host
+        refute_includes targeting.hosts, infra_host
       end
     end
   end
@@ -136,14 +136,14 @@ class TargetingTest < ActiveSupport::TestCase
       let(:query) { Targeting.build_query_from_hosts([ host.id, second_host.id, infra_host.id ]) }
 
       it 'builds query using host names joining inside ^' do
-        _(query).must_include host.name
-        _(query).must_include second_host.name
-        _(query).must_include infra_host.name
-        _(query).must_include 'name ^'
-
-        Host.search_for(query).must_include host
-        Host.search_for(query).must_include second_host
-        Host.search_for(query).must_include infra_host
+        assert_includes query, host.name
+        assert_includes query, second_host.name
+        assert_includes query, infra_host.name
+        assert_includes query, 'name ^'
+
+        assert_includes Host.search_for(query), host
+        assert_includes Host.search_for(query), second_host
+        assert_includes Host.search_for(query), infra_host
       end
     end
 
@@ -151,10 +151,10 @@ class TargetingTest < ActiveSupport::TestCase
       let(:query) { Targeting.build_query_from_hosts([ host.id ]) }
 
       it 'builds query using host name' do
-        _(query).must_equal "name ^ (#{host.name})"
-        Host.search_for(query).must_include host
-        Host.search_for(query).wont_include second_host
-        Host.search_for(query).wont_include infra_host
+        assert_equal "name ^ (#{host.name})", query
+        assert_includes Host.search_for(query), host
+        refute_includes Host.search_for(query), second_host
+        refute_includes Host.search_for(query), infra_host
       end
     end
 
@@ -162,9 +162,9 @@ class TargetingTest < ActiveSupport::TestCase
       let(:query) { Targeting.build_query_from_hosts([]) }
 
       it 'builds query to find all hosts' do
-        Host.search_for(query).must_include host
-        Host.search_for(query).must_include second_host
-        Host.search_for(query).must_include infra_host
+        assert_includes Host.search_for(query), host
+        assert_includes Host.search_for(query), second_host
+        assert_includes Host.search_for(query), infra_host
       end
     end
 
@@ -173,14 +173,14 @@ class TargetingTest < ActiveSupport::TestCase
 
       it 'ignores the infrastructure host' do
         query = Targeting.build_query_from_hosts([host.id, second_host.id, infra_host.id])
-        _(query).must_include host.name
-        _(query).must_include second_host.name
-        _(query).wont_include infra_host.name
-        _(query).must_include 'name ^'
-
-        Host.search_for(query).must_include host
-        Host.search_for(query).must_include second_host
-        Host.search_for(query).wont_include infra_host
+        assert_includes query, host.name
+        assert_includes query, second_host.name
+        refute_includes query, infra_host.name
+        assert_includes query, 'name ^'
+
+        assert_includes Host.search_for(query), host
+        assert_includes Host.search_for(query), second_host
+        refute_includes Host.search_for(query), infra_host
       end
     end
   end

data/webpack/JobInvocationDetail/JobInvocationConstants.js

@@ -5,3 +5,13 @@ export const STATUS = {
   SUCCEEDED: 'succeeded',
   FAILED: 'failed',
 };
+
+export const DATE_OPTIONS = {
+  day: 'numeric',
+  month: 'short',
+  year: 'numeric',
+  hour: '2-digit',
+  minute: '2-digit',
+  hour12: false,
+  timeZoneName: 'short',
+};

data/webpack/JobInvocationDetail/JobInvocationDetail.scss

@@ -0,0 +1,38 @@
+.job-invocation-detail-page-section {
+  $chart_size: 105px;
+  
+  .chart-donut {
+    height: $chart_size;
+    width: $chart_size;
+    margin-bottom: 10px;
+  }
+
+  .chart-legend {
+    height: $chart_size;
+    min-width: 270px;
+
+    .legend-title {
+      font-weight: bold;
+      font-size: var(--pf-global--FontSize--sm);
+      margin-left: 8px;
+      margin-bottom: 0;
+    }
+
+    .pf-c-description-list {
+      margin-left: 8px;
+      margin-top: 8px;
+
+      .pf-c-description-list__term .pf-c-description-list__text {
+        font-weight: normal;
+      }
+    }
+  }
+
+  .pf-c-divider {
+    max-height: $chart_size;
+  }
+
+  .job-overview {
+    height: $chart_size;
+  }
+}

data/webpack/JobInvocationDetail/JobInvocationOverview.js

@@ -7,12 +7,15 @@ import {
   DescriptionListGroup,
   DescriptionListDescription,
 } from '@patternfly/react-core';
+import { translate as __ } from 'foremanReact/common/I18n';
 import DefaultLoaderEmptyState from 'foremanReact/components/HostDetails/DetailsCard/DefaultLoaderEmptyState';
-import { translate as __, documentLocale } from 'foremanReact/common/I18n';
 
-const JobInvocationOverview = ({ data }) => {
+const JobInvocationOverview = ({
+  data,
+  isAlreadyStarted,
+  formattedStartDate,
+}) => {
   const {
-    start_at: startAt,
     ssh_user: sshUser,
     template_id: templateId,
     template_name: templateName,
@@ -22,27 +25,6 @@ const JobInvocationOverview = ({ data }) => {
   const canEditJobTemplates = permissions
     ? permissions.edit_job_templates
     : false;
-  const dateOptions = {
-    day: 'numeric',
-    month: 'short',
-    year: 'numeric',
-    hour: '2-digit',
-    minute: '2-digit',
-    hour12: false,
-    timeZoneName: 'short',
-  };
-  let formattedStartDate = __('Not yet');
-
-  if (startAt) {
-    // Ensures date string compatibility across browsers
-    const convertedDate = new Date(startAt.replace(/[-.]/g, '/'));
-    if (convertedDate.getTime() <= new Date().getTime()) {
-      formattedStartDate = convertedDate.toLocaleString(
-        documentLocale(),
-        dateOptions
-      );
-    }
-  }
 
   return (
     <DescriptionList
@@ -63,7 +45,7 @@ const JobInvocationOverview = ({ data }) => {
       <DescriptionListGroup>
         <DescriptionListTerm>{__('Started at:')}</DescriptionListTerm>
         <DescriptionListDescription>
-          {formattedStartDate}
+          {isAlreadyStarted ? formattedStartDate : __('Not yet')}
         </DescriptionListDescription>
       </DescriptionListGroup>
       <DescriptionListGroup>
@@ -99,6 +81,12 @@ const JobInvocationOverview = ({ data }) => {
 
 JobInvocationOverview.propTypes = {
   data: PropTypes.object.isRequired,
+  isAlreadyStarted: PropTypes.bool.isRequired,
+  formattedStartDate: PropTypes.string,
+};
+
+JobInvocationOverview.defaultProps = {
+  formattedStartDate: undefined,
 };
 
 export default JobInvocationOverview;

data/webpack/JobInvocationDetail/JobInvocationSystemStatusChart.js

@@ -0,0 +1,153 @@
+import React, { useEffect, useState } from 'react';
+import PropTypes from 'prop-types';
+import { translate as __, sprintf } from 'foremanReact/common/I18n';
+import {
+  ChartDonut,
+  ChartLabel,
+  ChartLegend,
+  ChartTooltip,
+} from '@patternfly/react-charts';
+import {
+  DescriptionList,
+  DescriptionListTerm,
+  DescriptionListGroup,
+  DescriptionListDescription,
+  FlexItem,
+  Text,
+} from '@patternfly/react-core';
+import {
+  global_palette_green_500 as successedColor,
+  global_palette_red_100 as failedColor,
+  global_palette_blue_300 as inProgressColor,
+  global_palette_black_600 as canceledColor,
+  global_palette_black_500 as emptyChartDonut,
+} from '@patternfly/react-tokens';
+import DefaultLoaderEmptyState from 'foremanReact/components/HostDetails/DetailsCard/DefaultLoaderEmptyState';
+import './JobInvocationDetail.scss';
+
+const JobInvocationSystemStatusChart = ({
+  data,
+  isAlreadyStarted,
+  formattedStartDate,
+}) => {
+  const {
+    succeeded,
+    failed,
+    pending,
+    cancelled,
+    total,
+    total_hosts: totalHosts, // includes scheduled
+  } = data;
+  const chartData = [
+    { title: __('Succeeded:'), count: succeeded, color: successedColor.value },
+    { title: __('Failed:'), count: failed, color: failedColor.value },
+    { title: __('In Progress:'), count: pending, color: inProgressColor.value },
+    { title: __('Canceled:'), count: cancelled, color: canceledColor.value },
+  ];
+  const chartDonutTitle = () => {
+    if (total > 0) return `${succeeded.toString()}/${total}`;
+    if (totalHosts > 0) return `0/${totalHosts}`;
+    return '0';
+  };
+  const chartSize = 105;
+  const [legendWidth, setLegendWidth] = useState(270);
+
+  // Calculates chart legend width based on its content
+  useEffect(() => {
+    const legendContainer = document.querySelector('.chart-legend');
+    if (legendContainer) {
+      const rectElement = legendContainer.querySelector('rect');
+      if (rectElement) {
+        const rectWidth = parseFloat(rectElement.getAttribute('width'));
+        setLegendWidth(rectWidth);
+      }
+    }
+  }, [isAlreadyStarted, data]);
+
+  return (
+    <>
+      <FlexItem className="chart-donut">
+        <ChartDonut
+          allowTooltip
+          constrainToVisibleArea
+          data={
+            total > 0
+              ? chartData.map(d => ({
+                  label: sprintf(__(`${d.title} ${d.count} hosts`)),
+                  y: d.count,
+                }))
+              : [{ label: sprintf(__(`Scheduled: ${totalHosts} hosts`)), y: 1 }]
+          }
+          colorScale={
+            total > 0 ? chartData.map(d => d.color) : [emptyChartDonut.value]
+          }
+          labelComponent={
+            <ChartTooltip pointerLength={0} constrainToVisibleArea />
+          }
+          title={chartDonutTitle}
+          titleComponent={
+            // inline style overrides PatternFly default styling
+            <ChartLabel style={{ fontSize: '20px' }} />
+          }
+          subTitle={__('Systems')}
+          subTitleComponent={
+            // inline style overrides PatternFly default styling
+            <ChartLabel
+              style={{ fontSize: '12px', fill: canceledColor.value }}
+            />
+          }
+          padding={{
+            bottom: 0,
+            left: 0,
+            right: 0,
+            top: 0,
+          }}
+          width={chartSize}
+          height={chartSize}
+        />
+      </FlexItem>
+      <FlexItem className="chart-legend">
+        <Text ouiaId="legend-title" className="legend-title">
+          {__('System status')}
+        </Text>
+        {isAlreadyStarted ? (
+          <ChartLegend
+            orientation="vertical"
+            itemsPerRow={2}
+            gutter={25}
+            rowGutter={7}
+            padding={{ left: 15 }}
+            data={chartData.map(d => ({
+              name: `${d.title} ${d.count}`,
+              symbol: { type: 'circle' },
+            }))}
+            colorScale={chartData.map(d => d.color)}
+            width={legendWidth}
+            height={chartSize}
+          />
+        ) : (
+          <DescriptionList>
+            <DescriptionListGroup>
+              <DescriptionListTerm>{__('Scheduled at:')}</DescriptionListTerm>
+              <DescriptionListDescription>
+                {formattedStartDate || <DefaultLoaderEmptyState />}
+              </DescriptionListDescription>
+            </DescriptionListGroup>
+          </DescriptionList>
+        )}
+      </FlexItem>
+    </>
+  );
+};
+
+JobInvocationSystemStatusChart.propTypes = {
+  data: PropTypes.object.isRequired,
+  isAlreadyStarted: PropTypes.bool.isRequired,
+  formattedStartDate: PropTypes.string,
+};
+
+JobInvocationSystemStatusChart.defaultProps = {
+  formattedStartDate: undefined,
+};
+
+export default JobInvocationSystemStatusChart;

data/webpack/JobInvocationDetail/index.js

@@ -1,14 +1,20 @@
 import React, { useEffect } from 'react';
 import { useSelector, useDispatch } from 'react-redux';
 import PropTypes from 'prop-types';
-import { Divider, PageSection, Flex, FlexItem } from '@patternfly/react-core';
-import { translate as __ } from 'foremanReact/common/I18n';
+import { Divider, PageSection, Flex } from '@patternfly/react-core';
+import { translate as __, documentLocale } from 'foremanReact/common/I18n';
 import PageLayout from 'foremanReact/routes/common/PageLayout/PageLayout';
 import { stopInterval } from 'foremanReact/redux/middlewares/IntervalMiddleware';
 import { getData } from './JobInvocationActions';
 import { selectItems } from './JobInvocationSelectors';
 import JobInvocationOverview from './JobInvocationOverview';
-import { JOB_INVOCATION_KEY, STATUS } from './JobInvocationConstants';
+import JobInvocationSystemStatusChart from './JobInvocationSystemStatusChart';
+import {
+  JOB_INVOCATION_KEY,
+  STATUS,
+  DATE_OPTIONS,
+} from './JobInvocationConstants';
+import './JobInvocationDetail.scss';
 
 const JobInvocationDetailPage = ({
   match: {
@@ -17,11 +23,28 @@ const JobInvocationDetailPage = ({
 }) => {
   const dispatch = useDispatch();
   const items = useSelector(selectItems);
-  const { description, status_label: statusLabel, task } = items;
+  const {
+    description,
+    status_label: statusLabel,
+    task,
+    start_at: startAt,
+  } = items;
   const finished =
     statusLabel === STATUS.FAILED || statusLabel === STATUS.SUCCEEDED;
   const autoRefresh = task?.state === STATUS.PENDING || false;
 
+  let isAlreadyStarted = false;
+  let formattedStartDate;
+  if (startAt) {
+    // Ensures date string compatibility across browsers
+    const convertedDate = new Date(startAt.replace(/[-.]/g, '/'));
+    isAlreadyStarted = convertedDate.getTime() <= new Date().getTime();
+    formattedStartDate = convertedDate.toLocaleString(
+      documentLocale(),
+      DATE_OPTIONS
+    );
+  }
+
   useEffect(() => {
     dispatch(getData(`/api/job_invocations/${id}`));
     if (finished && !autoRefresh) {
@@ -48,17 +71,32 @@ const JobInvocationDetailPage = ({
       searchable={false}
     >
       <React.Fragment>
-        <PageSection isFilled variant="light">
-          <Flex>
-            <FlexItem> </FlexItem>
+        <PageSection
+          className="job-invocation-detail-page-section"
+          isFilled
+          variant="light"
+        >
+          <Flex alignItems={{ default: 'alignItemsFlexStart' }}>
+            <JobInvocationSystemStatusChart
+              data={items}
+              isAlreadyStarted={isAlreadyStarted}
+              formattedStartDate={formattedStartDate}
+            />
             <Divider
               orientation={{
                 default: 'vertical',
               }}
             />
-            <FlexItem>
-              <JobInvocationOverview data={items} />
-            </FlexItem>
+            <Flex
+              className="job-overview"
+              alignItems={{ default: 'alignItemsCenter' }}
+            >
+              <JobInvocationOverview
+                data={items}
+                isAlreadyStarted={isAlreadyStarted}
+                formattedStartDate={formattedStartDate}
+              />
+            </Flex>
           </Flex>
         </PageSection>
       </React.Fragment>

data/webpack/JobWizard/Footer.js

@@ -26,6 +26,7 @@ export const Footer = ({ canSubmit, onSave }) => {
           return (
             <>
               <Button
+                ouiaId="next-footer"
                 variant="primary"
                 type="submit"
                 onClick={onNext}
@@ -36,6 +37,7 @@ export const Footer = ({ canSubmit, onSave }) => {
                   : __('Next')}
               </Button>
               <Button
+                ouiaId="back-footer"
                 variant="secondary"
                 onClick={onBack}
                 isDisabled={
@@ -54,6 +56,7 @@ export const Footer = ({ canSubmit, onSave }) => {
                 }
               >
                 <Button
+                  ouiaId="run-on-selected-hosts-footer"
                   variant="tertiary"
                   onClick={onSave}
                   isAriaDisabled={!canSubmit}
@@ -74,6 +77,7 @@ export const Footer = ({ canSubmit, onSave }) => {
                 }
               >
                 <Button
+                  ouiaId="skip-to-review-footer"
                   variant="tertiary"
                   onClick={() => goToStepByName(WIZARD_TITLES.review)}
                   isAriaDisabled={!canSubmit}
@@ -82,7 +86,7 @@ export const Footer = ({ canSubmit, onSave }) => {
                   {__('Skip to review')}
                 </Button>
               </Tooltip>
-              <Button variant="link" onClick={onClose}>
+              <Button ouiaId="cancel-footer" variant="link" onClick={onClose}>
                 {__('Cancel')}
               </Button>
               {isSubmitting && (

data/webpack/JobWizard/JobWizardConstants.js

@@ -5,6 +5,10 @@ export const JOB_TEMPLATES = 'JOB_TEMPLATES';
 export const JOB_CATEGORIES = 'JOB_CATEGORIES';
 export const JOB_TEMPLATE = 'JOB_TEMPLATE';
 export const JOB_INVOCATION = 'JOB_INVOCATION';
+export const CURRENT_PERMISSIONS = 'CURRENT_PERMISSIONS';
+export const currentPermissionsUrl = foremanUrl(
+  '/api/v2/permissions/current_permissions'
+);
 export const templatesUrl = foremanUrl('/api/v2/job_templates');
 
 export const repeatTypes = {

data/webpack/JobWizard/JobWizardPageRerun.js

@@ -48,6 +48,7 @@ const JobWizardPageRerun = ({
       searchable={false}
       toolbarButtons={
         <Button
+          ouiaId="job-wizard-rerun-old-form-button"
           variant="link"
           component="a"
           href={`/old/job_invocations/${id}/rerun${search}`}
@@ -71,6 +72,7 @@ const JobWizardPageRerun = ({
           <React.Fragment>
             {jobOrganization?.id !== currentOrganization?.id && (
               <Alert
+                ouiaId="job-wizard-alert-organization"
                 isInline
                 className="job-wizard-alert"
                 variant="warning"
@@ -85,6 +87,7 @@ const JobWizardPageRerun = ({
             )}
             {jobLocation?.id !== currentLocation?.id && (
               <Alert
+                ouiaId="job-wizard-alert-location"
                 isInline
                 className="job-wizard-alert"
                 variant="warning"

data/webpack/JobWizard/JobWizardSelectors.js

@@ -1,4 +1,5 @@
 import URI from 'urijs';
+import { get } from 'lodash';
 import {
   selectAPIResponse,
   selectAPIStatus,
@@ -42,6 +43,18 @@ export const selectJobCategoriesStatus = state =>
 export const selectCategoryError = state =>
   selectAPIErrorMessage(state, JOB_CATEGORIES);
 
+export const selectJobCategoriesMissingPermissions = state => {
+  const jobCategoriesResponse = selectJobCategoriesResponse(state);
+  return (
+    get(jobCategoriesResponse, [
+      'response',
+      'data',
+      'error',
+      'missing_permissions',
+    ]) || []
+  );
+};
+
 export const selectAllTemplatesError = state =>
   selectAPIErrorMessage(state, JOB_TEMPLATES);
 
@@ -60,11 +73,26 @@ export const selectAdvancedTemplateInputs = state =>
 export const selectTemplateInputs = state =>
   selectAPIResponse(state, JOB_TEMPLATE).template_inputs || [];
 
+export const selectHostsResponse = state => selectAPIResponse(state, HOSTS_API);
+
 export const selectHostCount = state =>
-  selectAPIResponse(state, HOSTS_API).subtotal || 0;
+  selectHostsResponse(state).subtotal || 0;
+
+export const selectHosts = state => {
+  const hosts = selectHostsResponse(state).results || [];
+  return hosts.map(host => ({
+    name: host.name,
+    display_name: host.display_name,
+  }));
+};
 
-export const selectHosts = state =>
-  (selectAPIResponse(state, HOSTS_API).results || []).map(host => host.name);
+export const selectHostsMissingPermissions = state => {
+  const hostsResponse = selectHostsResponse(state);
+  return (
+    get(hostsResponse, ['response', 'data', 'error', 'missing_permissions']) ||
+    []
+  );
+};
 
 export const selectIsLoadingHosts = state =>
   !selectAPIStatus(state, HOSTS_API) ||