foreman_remote_execution 4.2.1 → 4.4.0

data/test/unit/job_invocation_report_template_test.rb

@@ -0,0 +1,57 @@
+require 'test_plugin_helper'
+
+class JobReportTemplateTest < ActiveSupport::TestCase
+  class FakeTask < OpenStruct
+    class Jail < Safemode::Jail
+      allow :action_continuous_output, :result, :ended_at
+    end
+  end
+
+  context 'with valid job invocation report template' do
+    let(:job_invocation_template) do
+      file_path = File.read(File.expand_path(Rails.root + "app/views/unattended/report_templates/jobs_-_invocation_report_template.erb"))
+      template = ReportTemplate.import_without_save("Job Invocation Report Template", file_path)
+      template.save!
+      template
+    end
+
+    describe 'template setting' do
+      it 'in settings includes only report templates with job_id input' do
+        FactoryBot.create(:report_template, name: 'Template 1')
+        job_invocation_template
+        templates = Setting::RemoteExecution.job_invocation_report_templates_select
+
+        assert_include templates, 'Job Invocation Report Template'
+      end
+    end
+
+    describe 'task reporting' do
+      let(:fake_outputs) do
+        [
+          { 'output_type' => 'stderr', 'output' => "error", 'timestamp' => Time.new(2020, 12, 1, 0, 0, 0).utc },
+          { 'output_type' => 'stdout', 'output' => "output", 'timestamp' => Time.new(2020, 12, 1, 0, 0, 0).utc },
+          { 'output_type' => 'stdebug', 'output' => "debug", 'timestamp' => Time.new(2020, 12, 1, 0, 0, 0).utc },
+        ]
+      end
+      let(:fake_task) { FakeTask.new(result: 'success', action_continuous_output: fake_outputs) }
+
+      it 'should render task outputs' do
+        job_invocation = FactoryBot.create(:job_invocation, :with_task)
+        JobInvocation.any_instance.expects(:sub_task_for_host).returns(fake_task)
+
+        input = job_invocation_template.template_inputs.first
+        composer_params = { template_id: job_invocation_template.id, input_values: { input.id.to_s => { value: job_invocation.id.to_s } } }
+        result = ReportComposer.new(composer_params).render
+
+        # parsing the CSV result
+        CSV.parse(result.strip, headers: true).each_with_index do |row, i|
+          row_hash = row.to_h
+          assert_equal 'success', row_hash['result']
+          assert_equal fake_outputs[i]['output_type'], row_hash['type']
+          assert_equal fake_outputs[i]['output'], row_hash['message']
+          assert_kind_of Time, Time.zone.parse(row_hash['time']), 'Parsing of time column failed'
+        end
+      end
+    end
+  end
+end

data/webpack/JobWizard/JobWizard.js

@@ -0,0 +1,55 @@
+import React, { useState } from 'react';
+import { Wizard } from '@patternfly/react-core';
+import { translate as __ } from 'foremanReact/common/I18n';
+import history from 'foremanReact/history';
+import CategoryAndTemplate from './steps/CategoryAndTemplate/';
+import './JobWizard.scss';
+
+export const JobWizard = () => {
+  const [jobTemplate, setJobTemplate] = useState(null);
+  const [category, setCategory] = useState('');
+  const steps = [
+    {
+      name: __('Category and template'),
+      component: (
+        <CategoryAndTemplate
+          jobTemplate={jobTemplate}
+          setJobTemplate={setJobTemplate}
+          category={category}
+          setCategory={setCategory}
+        />
+      ),
+    },
+    {
+      name: __('Target hosts'),
+      component: <p>TargetHosts </p>,
+      canJumpTo: !!jobTemplate,
+    },
+    {
+      name: __('Advanced fields'),
+      component: <p> AdvancedFields </p>,
+      canJumpTo: !!jobTemplate,
+    },
+    {
+      name: __('Schedule'),
+      component: <p>Schedule</p>,
+      canJumpTo: !!jobTemplate,
+    },
+    {
+      name: __('Review details'),
+      component: <p>ReviewDetails</p>,
+      nextButtonText: 'Run',
+      canJumpTo: !!jobTemplate,
+    },
+  ];
+  const title = __('Run Job');
+  return (
+    <Wizard
+      onClose={() => history.goBack()}
+      navAriaLabel={`${title} steps`}
+      steps={steps}
+      height="70vh"
+      className="job-wizard"
+    />
+  );
+};

data/webpack/JobWizard/JobWizard.scss

@@ -0,0 +1,12 @@
+.job-wizard {
+  .pf-c-wizard__main {
+    overflow: visible;
+    z-index: calc(
+      var(--pf-c-wizard__footer--ZIndex) + 1
+    ); // So the select box can be shown above the wizard footer
+  }
+
+  .pf-c-wizard__main-body {
+    max-width: 500px;
+  }
+}

data/webpack/JobWizard/JobWizardConstants.js

@@ -0,0 +1,5 @@
+import { foremanUrl } from 'foremanReact/common/helpers';
+
+export const JOB_TEMPLATES = 'JOB_TEMPLATES';
+export const JOB_CATEGORIES = 'JOB_CATEGORIES';
+export const templatesUrl = foremanUrl('/api/v2/job_templates');

data/webpack/JobWizard/JobWizardSelectors.js

@@ -0,0 +1,21 @@
+import {
+  selectAPIResponse,
+  selectAPIStatus,
+} from 'foremanReact/redux/API/APISelectors';
+
+import { JOB_TEMPLATES, JOB_CATEGORIES } from './JobWizardConstants';
+
+export const selectJobTemplatesStatus = state =>
+  selectAPIStatus(state, JOB_TEMPLATES);
+
+export const filterJobTemplates = templates =>
+  templates?.filter(template => !template.snippet) || [];
+
+export const selectJobTemplates = state =>
+  filterJobTemplates(selectAPIResponse(state, JOB_TEMPLATES)?.results);
+
+export const selectJobCategories = state =>
+  selectAPIResponse(state, JOB_CATEGORIES).job_categories || [];
+
+export const selectJobCategoriesStatus = state =>
+  selectAPIStatus(state, JOB_CATEGORIES);

data/webpack/JobWizard/__tests__/JobWizard.test.js

@@ -0,0 +1,20 @@
+import React from 'react';
+import * as patternfly from '@patternfly/react-core';
+import { testComponentSnapshotsWithFixtures } from '@theforeman/test';
+import JobWizardPage from '../index';
+import { JobWizard } from '../JobWizard';
+
+jest.spyOn(patternfly, 'Wizard');
+patternfly.Wizard.mockImplementation(props => <div>{props}</div>);
+const fixtures = {
+  'renders ': {},
+};
+describe('JobWizardPage', () => {
+  describe('rendering', () =>
+    testComponentSnapshotsWithFixtures(JobWizardPage, fixtures));
+});
+
+describe('JobWizard', () => {
+  describe('rendering', () =>
+    testComponentSnapshotsWithFixtures(JobWizard, fixtures));
+});

data/webpack/JobWizard/__tests__/__snapshots__/JobWizard.test.js.snap

@@ -0,0 +1,83 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`JobWizard rendering renders  1`] = `
+<mockConstructor
+  className="job-wizard"
+  height="70vh"
+  navAriaLabel="Run Job steps"
+  onClose={[Function]}
+  steps={
+    Array [
+      Object {
+        "component": <ConnectedCategoryAndTemplate
+          category=""
+          jobTemplate={null}
+          setCategory={[Function]}
+          setJobTemplate={[Function]}
+        />,
+        "name": "Category and template",
+      },
+      Object {
+        "canJumpTo": false,
+        "component": <p>
+          TargetHosts 
+        </p>,
+        "name": "Target hosts",
+      },
+      Object {
+        "canJumpTo": false,
+        "component": <p>
+           AdvancedFields 
+        </p>,
+        "name": "Advanced fields",
+      },
+      Object {
+        "canJumpTo": false,
+        "component": <p>
+          Schedule
+        </p>,
+        "name": "Schedule",
+      },
+      Object {
+        "canJumpTo": false,
+        "component": <p>
+          ReviewDetails
+        </p>,
+        "name": "Review details",
+        "nextButtonText": "Run",
+      },
+    ]
+  }
+/>
+`;
+
+exports[`JobWizardPage rendering renders  1`] = `
+<PageLayout
+  breadcrumbOptions={
+    Object {
+      "breadcrumbItems": Array [
+        Object {
+          "caption": "Jobs",
+          "url": "/jobs",
+        },
+        Object {
+          "caption": "Run job",
+        },
+      ],
+    }
+  }
+  header="Run job"
+  searchable={false}
+>
+  <Title
+    headingLevel="h2"
+    size="2xl"
+  >
+    Run job
+  </Title>
+  <Divider
+    component="div"
+  />
+  <JobWizard />
+</PageLayout>
+`;

data/webpack/JobWizard/index.js

@@ -0,0 +1,32 @@
+import React from 'react';
+import { Title, Divider } from '@patternfly/react-core';
+import { translate as __ } from 'foremanReact/common/I18n';
+import PageLayout from 'foremanReact/routes/common/PageLayout/PageLayout';
+import { JobWizard } from './JobWizard';
+
+const JobWizardPage = () => {
+  const title = __('Run job');
+  const breadcrumbOptions = {
+    breadcrumbItems: [
+      { caption: __('Jobs'), url: `/jobs` },
+      { caption: title },
+    ],
+  };
+  return (
+    <PageLayout
+      header={title}
+      breadcrumbOptions={breadcrumbOptions}
+      searchable={false}
+    >
+      <React.Fragment>
+        <Title headingLevel="h2" size="2xl">
+          {title}
+        </Title>
+        <Divider component="div" />
+        <JobWizard />
+      </React.Fragment>
+    </PageLayout>
+  );
+};
+
+export default JobWizardPage;

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

@@ -0,0 +1,77 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { Title, Text, TextVariants, Form } from '@patternfly/react-core';
+import { translate as __ } from 'foremanReact/common/I18n';
+import { SelectField } from '../form/SelectField';
+import { GroupedSelectField } from '../form/GroupedSelectField';
+
+export const CategoryAndTemplate = ({
+  jobCategories,
+  jobTemplates,
+  setJobTemplate,
+  selectedTemplateID,
+  selectedCategory,
+  setCategory,
+}) => {
+  const templatesGroups = {};
+  jobTemplates.forEach(template => {
+    if (templatesGroups[template.provider_type]?.options)
+      templatesGroups[template.provider_type].options.push({
+        label: template.name,
+        value: template.id,
+      });
+    else
+      templatesGroups[template.provider_type] = {
+        options: [{ label: template.name, value: template.id }],
+        groupLabel: template.provider_type,
+      };
+  });
+
+  const selectedTemplate = jobTemplates.find(
+    template => template.id === selectedTemplateID
+  )?.name;
+
+  const onSelectCategory = newCategory => {
+    setCategory(newCategory);
+    setJobTemplate(null);
+  };
+  return (
+    <>
+      <Title headingLevel="h2">{__('Category And Template')}</Title>
+      <Text component={TextVariants.p}>{__('All fields are required.')}</Text>
+      <Form>
+        <SelectField
+          label={__('Job category')}
+          fieldId="job_category"
+          options={jobCategories}
+          setValue={onSelectCategory}
+          value={selectedCategory}
+        />
+        <GroupedSelectField
+          label={__('Job template')}
+          fieldId="job_template"
+          groups={Object.values(templatesGroups)}
+          setSelected={setJobTemplate}
+          selected={selectedTemplate}
+        />
+      </Form>
+    </>
+  );
+};
+
+CategoryAndTemplate.propTypes = {
+  jobCategories: PropTypes.array,
+  jobTemplates: PropTypes.array,
+  setJobTemplate: PropTypes.func.isRequired,
+  selectedTemplateID: PropTypes.number,
+  setCategory: PropTypes.func.isRequired,
+  selectedCategory: PropTypes.string,
+};
+CategoryAndTemplate.defaultProps = {
+  jobCategories: [],
+  jobTemplates: [],
+  selectedTemplateID: null,
+  selectedCategory: null,
+};
+
+export default CategoryAndTemplate;

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

@@ -0,0 +1,45 @@
+import { testComponentSnapshotsWithFixtures } from '@theforeman/test';
+import { CategoryAndTemplate } from './CategoryAndTemplate';
+
+const fixtures = {
+  'renders with props': {
+    jobCategories: [
+      'Commands',
+      'Ansible Playbook',
+      'Ansible Galaxy',
+      'Ansible Roles Installation',
+    ],
+    jobTemplates: [
+      {
+        id: 190,
+        name: 'ab Run Command - SSH Default clone',
+        job_category: 'Commands',
+        provider_type: 'SSH',
+        snippet: false,
+      },
+      {
+        id: 168,
+        name: 'Ansible Roles - Ansible Default',
+        job_category: 'Ansible Playbook',
+        provider_type: 'Ansible',
+        snippet: false,
+      },
+      {
+        id: 170,
+        name: 'Ansible Roles - Install from git',
+        job_category: 'Ansible Roles Installation',
+        provider_type: 'Ansible',
+        snippet: false,
+      },
+    ],
+    setJobTemplate: jest.fn(),
+    selectedTemplateID: 190,
+    setCategory: jest.fn(),
+    selectedCategory: 'I am a category',
+  },
+};
+
+describe('CategoryAndTemplate', () => {
+  describe('rendering', () =>
+    testComponentSnapshotsWithFixtures(CategoryAndTemplate, fixtures));
+});

data/webpack/JobWizard/steps/CategoryAndTemplate/__snapshots__/CategoryAndTemplate.test.js.snap

@@ -0,0 +1,64 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`CategoryAndTemplate rendering renders with props 1`] = `
+<Fragment>
+  <Title
+    headingLevel="h2"
+  >
+    Category And Template
+  </Title>
+  <Text
+    component="p"
+  >
+    All fields are required.
+  </Text>
+  <Form>
+    <SelectField
+      fieldId="job_category"
+      label="Job category"
+      options={
+        Array [
+          "Commands",
+          "Ansible Playbook",
+          "Ansible Galaxy",
+          "Ansible Roles Installation",
+        ]
+      }
+      setValue={[Function]}
+      value="I am a category"
+    />
+    <GroupedSelectField
+      fieldId="job_template"
+      groups={
+        Array [
+          Object {
+            "groupLabel": "SSH",
+            "options": Array [
+              Object {
+                "label": "ab Run Command - SSH Default clone",
+                "value": 190,
+              },
+            ],
+          },
+          Object {
+            "groupLabel": "Ansible",
+            "options": Array [
+              Object {
+                "label": "Ansible Roles - Ansible Default",
+                "value": 168,
+              },
+              Object {
+                "label": "Ansible Roles - Install from git",
+                "value": 170,
+              },
+            ],
+          },
+        ]
+      }
+      label="Job template"
+      selected="ab Run Command - SSH Default clone"
+      setSelected={[MockFunction]}
+    />
+  </Form>
+</Fragment>
+`;