testing workflow mode

Author: IPvSean

.github/workflows/main.yml

@@ -23,7 +23,7 @@ jobs:
     steps:
       - name: Load the ansible-cloud action
         id: controller_job
-        uses: ansible-cloud/[email protected].6
+        uses: ansible-cloud/[email protected].7
         with:
           controller_host: ${{ secrets.CONTROLLER_HOST }}
           controller_username: ${{ secrets.CONTROLLER_USERNAME }}

README.md

@@ -72,6 +72,37 @@ For the Github Pull Request method to work, you need to make sure your specified
    * **Source Control Branch** (which requires the **PROJECT** to have Allow Branch Override checked)
    * **Variables**
 
+### Example of working with a Pull Request Methodology WORKFLOW
+
+This is also known as Roger Lopez mode. In this example we will only initiate the Github Action if there is a Pull Request on our Github repository.  We need to have a `workflow_template` and `controller_project` specified.  This will make sure that any in-bound pull requests (PRs) are tested on a workflow rather than your existing project.  This will allow people contributing to your Github repo to test their changes before you merge into your downstream repoistory.
+
+Example of `.github/workflows/main.yml`
+
+```
+on:
+  pull_request_target:
+
+jobs:
+  automation_controller_job:
+    runs-on: ubuntu-latest
+    name: Kick off Automation controller job
+    steps:
+      - name: Load the ansible-cloud action
+        id: controller_job
+        uses: ansible-cloud/[email protected]
+        with:
+          controller_host: ${{ secrets.CONTROLLER_HOST }}
+          controller_username: ${{ secrets.CONTROLLER_USERNAME }}
+          controller_password: ${{ secrets.CONTROLLER_PASSWORD }}
+          workflow_template: "test workflow"
+          controller_project: "test project"
+          extra_vars: "your_region=us-west-1"
+          validate_certs: false
+        env:
+          pull_request_event: ${{ github.event.pull_request.number }}
+```
+
+
 ## Setting up your repo to work with this action
 
 You need to setup 3 (three) secrets:

action.yml

@@ -21,8 +21,11 @@ inputs:
     required: false
     default: "true"
   job_template:
-    description: "Name or ID of project, job_template or workflow_job_template."
-    required: true
+    description: "Name or ID of job_template"
+    required: false
+  workflow_template:
+    description: "Name or ID of workflow_template"
+    required: false
   extra_vars:
     description: "Pass extra command line variables to the playbook."
     required: false
@@ -36,4 +39,5 @@ runs:
     CONTROLLER_VERIFY_SSL: ${{ inputs.validate_certs }}
     CONTROLLER_PROJECT: ${{ inputs.controller_project }}
     JOB_TEMPLATE: ${{ inputs.job_template }}
+    WORKFLOW_TEMPLATE: ${{ inputs.job_template }}
     EXTRA_VARS: ${{ inputs.extra_vars }}

entrypoint.sh

@@ -37,8 +37,8 @@ echo "GITHUB_REF is $GITHUB_REF"
 echo "GITHUB_REPOSITORY is $GITHUB_REPOSITORY"
 echo "pull_request_event is $pull_request_event"
 echo "---------------"
-
-pull/1/head
+echo "WORKFLOW_TEMPLATE is $WORKFLOW_TEMPLATE"
+echo "---------------"
 
 # scm_url e.g. https://github.com/ansible-cloud/aap_controller_action
 # scm_branch e.g. pull/1/head (for PR #1)
@@ -66,7 +66,7 @@ EOF
 
 tee playbook.yml << EOF
 ---
-- name: execute autmation job
+- name: execute automation job
   hosts: localhost
   gather_facts: no
 
@@ -85,6 +85,7 @@ tee playbook.yml << EOF
           - "extra vars are {{ extra_vars }}"
 
     - name: project update and sync
+      when: workflow_template_var|length == 0
       block:
       - name: retrieve info on existing specified project in Automation controller
         set_fact:
@@ -225,43 +226,62 @@ tee playbook.yml << EOF
 
       when: project_var|length > 0
 
-    - name: Launch a job template with extra_vars on remote controller instance when project is set
-      when: job_template_var|length > 0
-      awx.awx.job_launch:
-        job_template: "{{ job_template_var }}"
-        extra_vars: "$EXTRA_VARS"
-        validate_certs: "$CONTROLLER_VERIFY_SSL"
-        scm_branch: "{{ scm_branch |  default(omit, true) }}"
-      register: job_output
-
-    - name: Wait for job
-      when: job_template_var|length > 0 or workflow_template_var|length > 0
-      awx.awx.job_wait:
-        job_id: "{{ job_output.id }}"
-        timeout: 3600
-        validate_certs: "$CONTROLLER_VERIFY_SSL"
-
-    - name: retrieve job info
-      when: job_template_var|length > 0 or workflow_template_var|length > 0
-      uri:
-        url: https://$CONTROLLER_HOST/api/v2/jobs/{{ job_output.id }}/stdout/?format=json
-        method: GET
-        user: "$CONTROLLER_USERNAME"
-        password: "$CONTROLLER_PASSWORD"
-        validate_certs: "$CONTROLLER_VERIFY_SSL"
-        force_basic_auth: yes
-      register: playbook_output
-
-    - name: display Automation controller job output
-      when: job_template_var|length > 0 or workflow_template_var|length > 0
-      debug:
-        var: playbook_output.json.content
-
-    - name: copy playbook output from Automation controller to file
-      when: job_template_var|length > 0 or workflow_template_var|length > 0
-      ansible.builtin.copy:
-        content: "{{ playbook_output.json.content }}"
-        dest: job_output.txt
+    - name: launch a job and wait for the job
+      when: job_template_var | length > 0
+      block:
+        - name: Launch a job template with extra_vars on remote controller instance when project is set
+          awx.awx.job_launch:
+            job_template: "{{ job_template_var }}"
+            extra_vars: "{{ extra_vars |  default(omit, true) }}"
+            validate_certs: "$CONTROLLER_VERIFY_SSL"
+            scm_branch: "{{ scm_branch |  default(omit, true) }}"
+          register: job_output
+
+        - name: Wait for job
+          awx.awx.job_wait:
+            job_id: "{{ job_output.id }}"
+            timeout: 3600
+            validate_certs: "$CONTROLLER_VERIFY_SSL"
+
+        - name: retrieve job info
+          when: job_template_var|length > 0
+          uri:
+            url: https://$CONTROLLER_HOST/api/v2/jobs/{{ job_output.id }}/stdout/?format=json
+            method: GET
+            user: "$CONTROLLER_USERNAME"
+            password: "$CONTROLLER_PASSWORD"
+            validate_certs: "$CONTROLLER_VERIFY_SSL"
+            force_basic_auth: yes
+          register: playbook_output
+
+        - name: display Automation controller job output
+          when: job_template_var|length > 0 or workflow_template_var|length > 0
+          debug:
+            var: playbook_output.json.content
+
+        - name: copy playbook output from Automation controller to file
+          when: job_template_var|length > 0 or workflow_template_var|length > 0
+          ansible.builtin.copy:
+            content: "{{ playbook_output.json.content }}"
+            dest: job_output.txt
+
+    - name: launch a workflow and wait for the workflow to finish
+      when: workflow_template_var | length > 0
+      block:
+        - name: Launch a job template with extra_vars on remote controller instance when project is set
+          awx.awx.workflow_launch:
+            workflow_template: "{{ job_template_var }}"
+            extra_vars: "{{ extra_vars |  default(omit, true) }}"
+            validate_certs: "$CONTROLLER_VERIFY_SSL"
+            scm_branch: "{{ scm_branch |  default(omit, true) }}"
+          register: job_output
+
+        - name: Wait for workflow
+          awx.awx.job_wait:
+            job_id: "{{ job_output.id }}"
+            job_type: workflow_jobs
+            timeout: 3600
+            validate_certs: "$CONTROLLER_VERIFY_SSL"
 
 EOF