Add tags and skip_tags option to awx.awx.workflow_launch

[Tompage1994]

SUMMARY

The tags and skip_tags options were missing from the workflow_launch module so this PR adds them in.

resolves #15010

ISSUE TYPE

• Bug, Docs Fix or other nominal change

COMPONENT NAME

• Collection

AWX VERSION

awx: 24.0.1.dev10+g8ac9045416

ADDITIONAL INFORMATION

The below snippet should now work where it didn't before.

- name: Kickoff workflow
  awx.awx.workflow_launch:
    name: wf_test
    wait: false
    skip_tags:
      - sometag
    tags:
      - mytag

[chrismeyersfsu]

Do we need ask_skip_jobs_on_launch enabled on a workflow job template for the tags to be "accepted" on workflow job template launch?

[fosterseth]

i see the ask_tags_on_launch here https://github.com/fosterseth/awx/blob/5ce20554316b3db7dc1bffa00849495319b9c7e7/awx_collection/plugins/modules/workflow_job_template.py#L53

[Tompage1994]

Do we need ask_skip_jobs_on_launch enabled on a workflow job template for the tags to be "accepted" on workflow job template launch?

Yes it does, that's the same as other existing options for this module. These are all checked by this bit of code:

awx/awx_collection/plugins/modules/workflow_launch.py

Lines 172 to 178 in 178f64e

	check_vars_to_prompts = {
	'inventory': 'ask_inventory_on_launch',
	'limit': 'ask_limit_on_launch',
	'job_tags': 'ask_tags_on_launch',
	'skip_tags': 'ask_skip_tags_on_launch',
	'scm_branch': 'ask_scm_branch_on_launch',
	}

The ask_tags_on_launch and ask_skip_tags_on_launch are already able to be set on the workflow_job_template module.

[fosterseth]

@Tompage1994 to make this more complete, and to prevent future regression, can you add a test for this?

you can add a new test case in file awx_collection/test/awx/test_workflow_job_template.py

the structure of the test would be similar to a regular job launch, just with workflows instead

https://github.com/fosterseth/awx/blob/8ddc19a927049b84f3f6bcfaae6595032f4a7789/awx_collection/test/awx/test_job_template.py#L110

the test would:

1. use WorkflowJobTemplate.objects.create() to create a workflow template
2. use run_module to launch the workflow, with job_tags and skip_tags specified
3. use WorkflowJobTemplate.objects.get() to grab the newly created workflow job
4. assert that the workflow job has the skip_tags and tags that you provided to the module

if you need some instructions for running the test locally just ping me and I'll provide some more instructions. Or you can just push your changes and let the CI run the test (albeit slow feedback loop)

[Tompage1994]

@Tompage1994 to make this more complete, and to prevent future regression, can you add a test for this?

you can add a new test case in file awx_collection/test/awx/test_workflow_job_template.py

the structure of the test would be similar to a regular job launch, just with workflows instead

https://github.com/fosterseth/awx/blob/8ddc19a927049b84f3f6bcfaae6595032f4a7789/awx_collection/test/awx/test_job_template.py#L110

the test would:

1. use WorkflowJobTemplate.objects.create() to create a workflow template
2. use run_module to launch the workflow, with job_tags and skip_tags specified
3. use WorkflowJobTemplate.objects.get() to grab the newly created workflow job
4. assert that the workflow job has the skip_tags and tags that you provided to the module

if you need some instructions for running the test locally just ping me and I'll provide some more instructions. Or you can just push your changes and let the CI run the test (albeit slow feedback loop)

@fosterseth I have done this now

[fosterseth]

@Tompage1994 thanks for improving the module!