Use MIRSG `molecule-test` #5

p-j-smith · 2023-11-28T11:40:23Z

Reduce duplication in workflows by:

using our molecule-test GitHub Action
adding a reusable workflow for running the action
use this reusable workflow for running tests on the provision and firewalld roles (more workflows can be added in a separate pr)
run the tests for a given role when either the role itself changes or the workflow changes

Note, this depends on UCL-MIRSG/.github#80 being merged first.
And linting is broken will fix in a different pr

This workflow uses the mirsg molecule-test action (requires version 0.37+)

Requires version 0.38+ of the molecule-test action

paddyroddy

Seems a bit odd to use a reusable workflow to call a composite workflow? Perfectly valid, but is it needed?

paddyroddy · 2023-11-28T14:26:29Z

.github/workflows/linting.yml

@@ -11,7 +11,7 @@ jobs:
  linting:
    runs-on: ubuntu-latest
    steps:
-      - uses: UCL-MIRSG/.github/actions/linting@v0.36.0
+      - uses: UCL-MIRSG/.github/actions/linting@v0.38.0


One day Renovate will come back 😆

we can only dream

Dreams do come true - I just reenabled it...

I put it on the shared calendar to reenable, but I still forgot...

I was scared to re-enable it haha

paddyroddy · 2023-11-28T14:26:56Z

.github/workflows/molecule.yml

+          scenario: ${{ matrix.scenario }}
+          checkout_path: ansible_collections/mirsg/infrastructure
+          tests_path: ansible_collections/mirsg/infrastructure/tests
+


missing new line at the end

I think new line was there but it wasn't empty 😬

Ah, just saw the dreaded 🚫

paddyroddy · 2023-11-28T14:27:59Z

.github/workflows/molecule.yml

+      fail-fast: true
+      matrix:
+        scenario:
+          - centos7


Only centos7?

yeah for now, I'll add Rocky 9 in a separate pr

paddyroddy · 2023-11-28T14:28:25Z

.github/workflows/molecule.yml

+on:
+  workflow_call:
+    inputs:
+      run_tags:


Generally people use run-tags rather than run_tags

I've renamed it now

p-j-smith · 2023-11-28T14:51:45Z

Seems a bit odd to use a reusable workflow to call a composite workflow? Perfectly valid, but is it needed?

Yeah it is a little convoluted. The molecule-test action that's in our .github repo can be used both for testing this collection as well as for testing standalone roles. When testing the roles within this collection there's a bit of boilerplate that's needed (and that we'd use for each role we want to test). So I put this boilerplate into a reusable workflow. We could have a workflow molecule-test-collection but that would duplicate a lot of what's in the existing molecule-test action. Roundabout way of saying it's not really necessary, just seemed like a sensible way of doing things. Happy to change though!

paddyroddy · 2023-11-28T15:15:11Z

Roundabout way of saying it's not really necessary, just seemed like a sensible way of doing things. Happy to change though!

Happy with whatever you decide. If it's a duplication concern, I assume one composite action can depend on another (maybe)?

…eusable workflow

p-j-smith · 2023-11-28T15:40:01Z

Happy with whatever you decide. If it's a duplication concern, I assume one composite action can depend on another (maybe)?

Yeah we could have another action molecule-test-collection that uses the existing molecule-test action, and have each workflow use that molecule-test-collection. That new action would look like this:

ansible-collection-infra/.github/actions/molecule-test-collection/action.yml

Lines 1 to 19 in 0ca6652

	---
	name: Molecule Test Collection
	description: Run `molecule test` on this Ansible Collection

	inputs:
	scenario:
	description: Name of the scenario to run the tests on
	required: false
	default: default

	runs:
	using: composite
	steps:
	- name: Run `molecule test`
	uses: UCL-MIRSG/.github/actions/[email protected]
	with:
	scenario: ${{ inputs.scenario }}
	checkout_path: ansible_collections/mirsg/infrastructure
	tests_path: ansible_collections/mirsg/infrastructure/tests

And using it in a workflow:

ansible-collection-infra/.github/workflows/molecule-firewalld-with-action.yml

Lines 1 to 26 in 0ca6652

    
           name: Test firewalld 
        
           on: 
        
             pull_request: 
        
               paths: 
        
                 - "roles/firewalld/**" 
        
                 - ".github/actions/molecule-test-collection/action.yml" 
        
                 - ".github/workflows/molecule-firewalld-with-action.yml" 
        
           jobs: 
        
             molecule: 
        
               runs-on: ubuntu-latest 
        
               strategy: 
        
                 fail-fast: true 
        
                 matrix: 
        
                   scenario: 
        
                     - centos7 
        
               env: 
        
                 MOLECULE_RUN_TAGS: firewalld 
        
                 PY_COLORS: 1 
        
                 ANSIBLE_FORCE_COLOR: 1 
        
               steps: 
        
                 - name: Run `molecule test` 
        
                   uses: ./.github/actions/molecule-test-collection 
        
                   with: 
        
                     scenario: ${{ matrix.scenario }}

Compared to the current workflow for the same role:

ansible-collection-infra/.github/workflows/molecule-firewalld.yml

Lines 1 to 13 in 0ca6652

    
           name: Test firewalld 
        
           on: 
        
             pull_request: 
        
               paths: 
        
                 - "roles/firewalld/**" 
        
                 - ".github/workflows/molecule.yml" 
        
                 - ".github/workflows/molecule-firewalld.yml" 
        
           jobs: 
        
             molecule-firewalld: 
        
               uses: ./.github/workflows/molecule.yml 
        
               with: 
        
                 run-tags: firewalld

So using a reusable workflow allows us to avoid some boilerplate that can't be avoided when using a composite action

paddyroddy · 2023-11-30T10:36:56Z

.github/workflows/molecule.yml

+        required: false
+        type: string
+        default: all


required isn't required if a default is set

well spotted, I've removed it

p-j-smith added 7 commits November 28, 2023 11:26

Add a reusable workflow for running molecule tests

8862621

This workflow uses the mirsg molecule-test action (requires version 0.37+)

Use the reusable molecule workflow for testing the provision role

34c6fe9

Use the reusable molecule workflow for testing the firewalld role

ee43df8

Use the reusable molecule workflow for testing the firewalld role

ad7393a

run molecule tests when the workflow files change

d48f814

Set correct tests_path when using the mirsg molecule-test action

c947b2d

Requires version 0.38+ of the molecule-test action

Use the latests version of all mirsg actions

7399153

p-j-smith requested a review from a team November 28, 2023 13:20

paddyroddy reviewed Nov 28, 2023

View reviewed changes

p-j-smith added 2 commits November 28, 2023 14:40

rename run_tags input to run-tags for the molecule reusable workflow

71e6b5e

remove whitespace from last line of workflow

a73481c

Add example of how using a composite action would work instead of a r…

0ca6652

…eusable workflow

p-j-smith mentioned this pull request Nov 28, 2023

Fix config #7

Merged

remove usage of composite action example

e8dce7e

p-j-smith self-assigned this Nov 28, 2023

p-j-smith requested review from drmatthews and paddyroddy November 30, 2023 08:58

paddyroddy reviewed Nov 30, 2023

View reviewed changes

Remove unnecessary 'required' flag from run-tags input declaration

cb65f5f

p-j-smith requested a review from paddyroddy November 30, 2023 10:47

paddyroddy approved these changes Nov 30, 2023

View reviewed changes

p-j-smith merged commit 1b40cb3 into main Nov 30, 2023
2 of 3 checks passed

p-j-smith deleted the maint/mirsg-molecule-action branch November 30, 2023 11:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use MIRSG `molecule-test` #5

Use MIRSG `molecule-test` #5

p-j-smith commented Nov 28, 2023 •

edited

Loading

paddyroddy left a comment

paddyroddy Nov 28, 2023

p-j-smith Nov 28, 2023

drmatthews Nov 28, 2023

paddyroddy Nov 28, 2023

paddyroddy Nov 28, 2023

p-j-smith Nov 28, 2023

paddyroddy Nov 28, 2023

paddyroddy Nov 28, 2023

p-j-smith Nov 28, 2023

paddyroddy Nov 28, 2023

p-j-smith Nov 28, 2023

p-j-smith commented Nov 28, 2023

paddyroddy commented Nov 28, 2023

p-j-smith commented Nov 28, 2023

paddyroddy Nov 30, 2023

p-j-smith Nov 30, 2023

Use MIRSG molecule-test #5

Use MIRSG molecule-test #5

Conversation

p-j-smith commented Nov 28, 2023 • edited Loading

paddyroddy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

p-j-smith commented Nov 28, 2023

paddyroddy commented Nov 28, 2023

p-j-smith commented Nov 28, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Use MIRSG `molecule-test` #5

Use MIRSG `molecule-test` #5

p-j-smith commented Nov 28, 2023 •

edited

Loading