Implement an option to choose a job type on relaunch (issue ansible#1…

…4177) - for all three relaunch scenarios (job list, detail and output) - write js tests
Sasa993 · Feb 2, 2024 · 02f77b5 · 02f77b5
1 parent 2fa5116
commit 02f77b5
Show file tree

Hide file tree

Showing 10 changed files with 206 additions and 29 deletions.
diff --git a/awx/api/serializers.py b/awx/api/serializers.py
@@ -3491,11 +3491,17 @@ class JobRelaunchSerializer(BaseSerializer):
         choices=[('all', _('No change to job limit')), ('failed', _('All failed and unreachable hosts'))],
         write_only=True,
     )
+    job_type = serializers.ChoiceField(
+        required=False,
+        allow_null=True,
+        choices=NEW_JOB_TYPE_CHOICES,
+        write_only=True,
+    )
     credential_passwords = VerbatimField(required=True, write_only=True)
 
     class Meta:
         model = Job
-        fields = ('passwords_needed_to_start', 'retry_counts', 'hosts', 'credential_passwords')
+        fields = ('passwords_needed_to_start', 'retry_counts', 'hosts', 'job_type', 'credential_passwords')
 
     def validate_credential_passwords(self, value):
         pnts = self.instance.passwords_needed_to_start

diff --git a/awx/api/views/__init__.py b/awx/api/views/__init__.py
@@ -3406,6 +3406,7 @@ def post(self, request, *args, **kwargs):
 
         copy_kwargs = {}
         retry_hosts = serializer.validated_data.get('hosts', None)
+        job_type = serializer.validated_data.get('job_type', None)
         if retry_hosts and retry_hosts != 'all':
             if obj.status in ACTIVE_STATES:
                 return Response(
@@ -3426,6 +3427,8 @@ def post(self, request, *args, **kwargs):
                 )
             copy_kwargs['limit'] = ','.join(retry_host_list)
 
+        if job_type:
+            copy_kwargs['job_type'] = job_type
         new_job = obj.copy_unified_job(**copy_kwargs)
         result = new_job.signal_start(**serializer.validated_data['credential_passwords'])
         if not result:

diff --git a/awx/ui/src/components/JobList/JobListItem.js b/awx/ui/src/components/JobList/JobListItem.js
@@ -139,15 +139,24 @@ function JobListItem({
             ) : (
               <LaunchButton resource={job}>
                 {({ handleRelaunch, isLaunching }) => (
-                  <Button
-                    ouiaId={`${job.id}-relaunch-button`}
-                    variant="plain"
-                    onClick={() => handleRelaunch()}
-                    aria-label={t`Relaunch`}
-                    isDisabled={isLaunching}
-                  >
-                    <RocketIcon />
-                  </Button>
+                  (job.type === 'job' && (
+                    <ReLaunchDropDown
+                      handleRelaunch={handleRelaunch}
+                      isLaunching={isLaunching}
+                      id={`relaunch-job-${job.id}`}
+                      isRelaunchJobType
+                    />
+                  )) || (
+                    <Button
+                      ouiaId={`${job.id}-relaunch-button`}
+                      variant="plain"
+                      onClick={() => handleRelaunch()}
+                      aria-label={t`Relaunch`}
+                      isDisabled={isLaunching}
+                    >
+                      <RocketIcon />
+                    </Button>
+                  )
                 )}
               </LaunchButton>
             )}

diff --git a/awx/ui/src/components/JobList/JobListItem.test.js b/awx/ui/src/components/JobList/JobListItem.test.js
@@ -246,6 +246,27 @@ describe('<JobListItem />', () => {
       .at(0);
     expect(credentials_detail.prop('isEmpty')).toEqual(true);
   });
+
+  test('dropdown receives isRelaunchJobType prop for job relaunch', () => {
+    wrapper = mountWithContexts(
+      <table>
+        <tbody>
+          <JobListItem
+            job={{
+              ...mockJob,
+              type: 'job',
+              job_type: 'run'
+            }}
+            onSelect={() => {}}
+            isSelected
+          />
+        </tbody>
+      </table>
+    );
+
+    const relaunchDropDown = wrapper.find('ReLaunchDropDown');
+    expect(relaunchDropDown.prop('isRelaunchJobType')).toBe(true);
+  });
 });
 
 describe('<JobListItem with failed job />', () => {

diff --git a/awx/ui/src/components/LaunchButton/ReLaunchDropDown.js b/awx/ui/src/components/LaunchButton/ReLaunchDropDown.js
@@ -13,6 +13,7 @@ import { RocketIcon } from '@patternfly/react-icons';
 
 function ReLaunchDropDown({
   isPrimary = false,
+  isRelaunchJobType = false,
   handleRelaunch,
   isLaunching,
   id = 'relaunch-job',
@@ -62,14 +63,52 @@ function ReLaunchDropDown({
     </DropdownItem>,
   ];
 
+  const dropdownItemsJobType = [
+    <DropdownItem
+      ouiaId={`${ouiaId}-on`}
+      aria-label={t`Relaunch on`}
+      key="relaunch_on"
+      component="div"
+      isPlainText
+    >
+      {t`Relaunch with job type`}
+    </DropdownItem>,
+    <DropdownSeparator key="separator" />,
+    <DropdownItem
+      ouiaId={`${ouiaId}-run-type`}
+      key="relaunch_run_type"
+      aria-label={t`Relaunch with job type run`}
+      component="button"
+      onClick={() => {
+        handleRelaunch({ job_type: 'run' });
+      }}
+      isDisabled={isLaunching}
+    >
+      {t`Run`}
+    </DropdownItem>,
+
+    <DropdownItem
+      ouiaId={`${ouiaId}-check-type`}
+      key="relaunch_check_type"
+      aria-label={t`Relaunch with job type check`}
+      component="button"
+      onClick={() => {
+        handleRelaunch({ job_type: 'check' });
+      }}
+      isDisabled={isLaunching}
+    >
+      {t`Check`}
+    </DropdownItem>,
+  ];
+
   if (isPrimary) {
     return (
       <Dropdown
         ouiaId={ouiaId}
         position={DropdownPosition.left}
         direction={DropdownDirection.up}
         isOpen={isOpen}
-        dropdownItems={dropdownItems}
+        dropdownItems={isRelaunchJobType ? dropdownItemsJobType : dropdownItems}
         toggle={
           <DropdownToggle
             toggleIndicator={null}
@@ -92,7 +131,7 @@ function ReLaunchDropDown({
       isPlain
       position={DropdownPosition.right}
       isOpen={isOpen}
-      dropdownItems={dropdownItems}
+      dropdownItems={isRelaunchJobType ? dropdownItemsJobType : dropdownItems}
       toggle={
         <DropdownToggle
           toggleIndicator={null}

diff --git a/awx/ui/src/components/LaunchButton/ReLaunchDropDown.test.js b/awx/ui/src/components/LaunchButton/ReLaunchDropDown.test.js
@@ -52,4 +52,24 @@ describe('ReLaunchDropDown', () => {
       .simulate('click');
     expect(handleRelaunch).toHaveBeenCalledWith({ hosts: 'all' });
   });
+
+  test('dropdown with isRelaunchJobType renders job type items', () => {
+    const wrapper = mountWithContexts(
+      <ReLaunchDropDown isRelaunchJobType handleRelaunch={handleRelaunch} />
+    );
+
+    wrapper.find('button').simulate('click');
+    wrapper.update();
+    expect(wrapper.find('DropdownItem')).toHaveLength(3);
+
+    wrapper
+      .find('DropdownItem[aria-label="Relaunch with job type run"]')
+      .simulate('click');
+    expect(handleRelaunch).toHaveBeenCalledWith({ job_type: 'run' });
+
+    wrapper
+      .find('DropdownItem[aria-label="Relaunch with job type check"]')
+      .simulate('click');
+    expect(handleRelaunch).toHaveBeenCalledWith({ job_type: 'check' });
+  });
 });
diff --git a/awx/ui/src/screens/Job/JobDetail/JobDetail.js b/awx/ui/src/screens/Job/JobDetail/JobDetail.js
@@ -579,14 +579,24 @@ function JobDetail({ job, inventorySourceLabels }) {
           ) : (
             <LaunchButton resource={job} aria-label={t`Relaunch`}>
               {({ handleRelaunch, isLaunching }) => (
-                <Button
-                  ouiaId="job-detail-relaunch-button"
-                  type="submit"
-                  onClick={() => handleRelaunch()}
-                  isDisabled={isLaunching}
-                >
-                  {t`Relaunch`}
-                </Button>
+                (job.type === 'job' && (
+                  <ReLaunchDropDown
+                    handleRelaunch={handleRelaunch}
+                    isLaunching={isLaunching}
+                    id={`relaunch-job-${job.id}`}
+                    isRelaunchJobType
+                    isPrimary
+                  />
+                )) || (
+                  <Button
+                    ouiaId="job-detail-relaunch-button"
+                    type="submit"
+                    onClick={() => handleRelaunch()}
+                    isDisabled={isLaunching}
+                  >
+                    {t`Relaunch`}
+                  </Button>
+                )
               )}
             </LaunchButton>
           ))}

diff --git a/awx/ui/src/screens/Job/JobDetail/JobDetail.test.js b/awx/ui/src/screens/Job/JobDetail/JobDetail.test.js
@@ -608,4 +608,32 @@ describe('<JobDetail />', () => {
     );
     expect(wrapper.find('Detail[label="Skip Tags"]').length).toBe(0);
   });
+
+  test('should render ReLaunchDropDown for job type "job"', () => {
+    wrapper = mountWithContexts(
+      <JobDetail
+        job={{
+          ...mockJobData,
+          type: 'job',
+        }}
+      />
+    );
+
+    expect(wrapper.find('ReLaunchDropDown').length).toBe(1);
+    expect(wrapper.find('Button[ouiaId="job-detail-relaunch-button"]').length).toBe(0);
+  });
+
+  test('should render Button for other job types', () => {
+    wrapper = mountWithContexts(
+      <JobDetail
+        job={{
+          ...mockJobData,
+          type: 'project_update',
+        }}
+      />
+    );
+
+    expect(wrapper.find('Button[ouiaId="job-detail-relaunch-button"]').length).toBe(1);
+    expect(wrapper.find('ReLaunchDropDown').length).toBe(0);
+  });
 });
diff --git a/awx/ui/src/screens/Job/JobOutput/shared/OutputToolbar.js b/awx/ui/src/screens/Job/JobOutput/shared/OutputToolbar.js
@@ -181,15 +181,24 @@ const OutputToolbar = ({ job, onDelete, isDeleteDisabled, jobStatus }) => {
           ) : (
             <LaunchButton resource={job}>
               {({ handleRelaunch, isLaunching }) => (
-                <Button
-                  ouiaId="job-output-relaunch-button"
-                  variant="plain"
-                  onClick={() => handleRelaunch()}
-                  aria-label={t`Relaunch`}
-                  isDisabled={isLaunching}
-                >
-                  <RocketIcon />
-                </Button>
+                (job.type === 'job' && (
+                  <ReLaunchDropDown
+                    handleRelaunch={handleRelaunch}
+                    isLaunching={isLaunching}
+                    ouiaId="job-output-relaunch-dropdown"
+                    isRelaunchJobType
+                  />
+                )) || (
+                  <Button
+                    ouiaId="job-output-relaunch-button"
+                    variant="plain"
+                    onClick={() => handleRelaunch()}
+                    aria-label={t`Relaunch`}
+                    isDisabled={isLaunching}
+                  >
+                    <RocketIcon />
+                  </Button>
+                )
               )}
             </LaunchButton>
           )}

diff --git a/awx/ui/src/screens/Job/JobOutput/shared/OutputToolbar.test.js b/awx/ui/src/screens/Job/JobOutput/shared/OutputToolbar.test.js
@@ -120,4 +120,36 @@ describe('<OutputToolbar />', () => {
     );
     expect(wrapper.find('DeleteButton').length).toBe(0);
   });
+
+  test('should render ReLaunchDropDown for job type "job"', () => {
+    wrapper = mountWithContexts(
+      <OutputToolbar
+        job={{
+          ...mockJobData,
+          type: 'job',
+        }}
+        jobStatus="successful"
+        onDelete={() => {}}
+      />
+    );
+
+    expect(wrapper.find('ReLaunchDropDown').length).toBe(1);
+  });
+
+  test('should render original relaunch button for other job types', () => {
+    wrapper = mountWithContexts(
+      <OutputToolbar
+        job={{
+          ...mockJobData,
+          type: 'system_job',
+        }}
+        jobStatus="successful"
+        onDelete={() => {}}
+      />
+    );
+
+    expect(wrapper.find('ReLaunchDropDown').length).toBe(0);
+    expect(wrapper.find('Button[aria-label="Relaunch"]').length).toBe(1);
+    expect(wrapper.find('RocketIcon').length).toBe(1);
+  });
 });