[$500] [HOLD for payment 2023-12-06] Local testing of GitHub Actions #13604

roryabraham · 2022-12-15T00:10:04Z

Problem

There is no easy way to locally test our GitHub Actions.

Why this is important

When we make changes to GitHub Actions, it's difficult to generate confidence that a PR will work and do what it is intended. This creates headaches:

It's harder to review GitHub Actions PRs and they need to be reviewed more carefully
We need to live-test things which is often disruptive
The best approximation is testing using another repo. We often use https://github.com/Andrew-Test-Org/Public-Test-Repo), but still the workflows you're testing there are not the same as the one's you're testing in E/App, and there may be different constraints in place, etc...
There's a slower feedback loop with simple mistakes in Actions and Workflows, leading to development taking longer

Solution

Implement a local testing framework for GitHub Actions using https://github.com/nektos/act

Issue Owner

Current Issue Owner: @muttmuure

Upwork Automation - Do Not Edit

Upwork Job URL: https://www.upwork.com/jobs/~016c26e8384c322e36
Upwork Job ID: 1734891845984043008
Last Price Increase: 2023-12-13

radoslawkrzemien · 2023-01-26T13:26:28Z

I'd like to have a look at this

MelvinBot · 2023-02-20T20:32:20Z

This issue has not been updated in over 15 days. @radoslawkrzemien eroding to Monthly issue.

P.S. Is everyone reading this sure this is really a near-term priority? Be brave: if you disagree, go ahead and close it out. If someone disagrees, they'll reopen it, and if they don't: one less thing to do!

Prince-Mendiratta · 2023-02-20T20:47:46Z

Is this open for contribution from external contributors? If @radoslawkrzemien is not interested in working on this anymore, I'd like to work on this!

I've worked with Github Actions before and here is a proposal that I made on another issue concerning github actions - #14088 (comment)

cc @mountiny @roryabraham

radoslawkrzemien · 2023-02-21T09:31:24Z

Hi @Prince-Mendiratta , just wanted to confirm that I am indeed working on this issue 🙂

Updated the `.gitignore` file with the temporary folder created by the `Mock-github` package, in case the cleanup was not performed for any reason See: Expensify#13604

Added new packages, most importantly `Mock-github` for creating a local repository for testing (to have better control over which files are accessed by the locally run workflows) and `Act-js` for programatically triggering the workflows with Act (with features added on top of it, like mocking API calls, mocking steps, etc.) See: Expensify#13604

Added `jest` and `ts` config files in a new folder `workflow_tests` for the testing of GitHub Actions workflows See: Expensify#13604

Added the stub of the first proper test, with the more-or-less defined structure, but yet without proper step mocks and result assertions See: Expensify#13604

Updated the mocks/test repo files configuration to be more readable/maintainable. Also added `name` properties to `preDeploy` workflow steps, since using `name` is the easiest and most stable way of referencing the steps for mocking See: Expensify#13604

Updated the step mocks to allow for producing outputs that steer the further workflow execution. Also added run params to the act call See: Expensify#13604

melvin-bot · 2023-12-08T16:32:09Z

Triggered auto assignment to @muttmuure (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details.

melvin-bot · 2023-12-08T16:32:11Z

Bug0 Triage Checklist (Main S/O)

This "bug" occurs on a supported platform (ensure Platforms in OP are ✅)
This bug is not a duplicate report (check E/App issues and #expensify-bugs)
- If it is, comment with a link to the original report, close the issue and add any novel details to the original issue instead
This bug is reproducible using the reproduction steps in the OP. S/O
- If the reproduction steps are clear and you're unable to reproduce the bug, check with the reporter and QA first, then close the issue.
- If the reproduction steps aren't clear and you determine the correct steps, please update the OP.
This issue is filled out as thoroughly and clearly as possible
- Pay special attention to the title, results, platforms where the bug occurs, and if the bug happens on staging/production.
I have reviewed and subscribed to the linked Slack conversation to ensure Slack/Github stay in sync

dangrous · 2023-12-08T16:32:48Z

@muttmuure not a bug, but we're ready for payment for two C+ reviews:

Thank you!

muttmuure · 2023-12-13T11:02:51Z

@sobitneupane - $500
@rushatgabhane - $500

melvin-bot · 2023-12-13T11:03:45Z

Job added to Upwork: https://www.upwork.com/jobs/~016c26e8384c322e36

melvin-bot · 2023-12-13T11:03:51Z

Triggered auto assignment to Contributor-plus team member for initial proposal review - @ArekChr (External)

muttmuure · 2023-12-13T11:05:47Z

both should request payment in NewDot - the summary is above here

sobitneupane · 2023-12-15T09:39:16Z

#13604 (comment)

Requested payment on newDot.

JmillsExpensify · 2023-12-15T23:12:45Z

$500 payment approved for @sobitneupane based on this comment.

JmillsExpensify · 2023-12-26T21:57:43Z

$500 payment approved for @rushatgabhane based on comment above.

roryabraham added Monthly KSv2 NewFeature Something to build that is a new item. labels Dec 15, 2022

melvin-bot bot locked and limited conversation to collaborators Dec 15, 2022

roryabraham mentioned this issue Dec 15, 2022

[Tracking] NewDot Deploy Improvements #12021

Closed

Expensify unlocked this conversation Jan 26, 2023

melvin-bot bot added the Overdue label Jan 26, 2023

mountiny assigned radoslawkrzemien Jan 26, 2023

mountiny changed the title ~~[HOLD] Local testing of GitHub Actions~~ Local testing of GitHub Actions Jan 26, 2023

mountiny added Weekly KSv2 and removed Monthly KSv2 labels Jan 26, 2023

melvin-bot bot removed the Overdue label Jan 26, 2023

mountiny added Engineering Monthly KSv2 Overdue labels Jan 26, 2023

melvin-bot bot removed the Overdue label Jan 26, 2023

mountiny removed the Monthly KSv2 label Jan 26, 2023

melvin-bot bot added Overdue Monthly KSv2 and removed Weekly KSv2 labels Feb 14, 2023

melvin-bot bot removed the Overdue label Feb 20, 2023

radoslawkrzemien added a commit to radoslawkrzemien/App that referenced this issue Feb 21, 2023

Add configs

5f895ca

Added `jest` and `ts` config files in a new folder `workflow_tests` for the testing of GitHub Actions workflows See: Expensify#13604

radoslawkrzemien added a commit to radoslawkrzemien/App that referenced this issue Feb 21, 2023

Fix steps mocks [WiP]

96bbcda

Updated the step mocks to allow for producing outputs that steer the further workflow execution. Also added run params to the act call See: Expensify#13604

dangrous assigned rushatgabhane Dec 8, 2023

melvin-bot bot removed the Overdue label Dec 8, 2023

dangrous added Overdue Bug Something is broken. Auto assigns a BugZero manager. labels Dec 8, 2023

melvin-bot bot assigned muttmuure Dec 8, 2023

melvin-bot bot removed the Overdue label Dec 8, 2023

melvin-bot bot added the Overdue label Dec 13, 2023

melvin-bot bot removed the Overdue label Dec 13, 2023

muttmuure unassigned sobitneupane and rushatgabhane Dec 13, 2023

muttmuure added the External Added to denote the issue can be worked on by a contributor label Dec 13, 2023

melvin-bot bot changed the title ~~[HOLD for payment 2023-12-06] Local testing of GitHub Actions~~ [$500] [HOLD for payment 2023-12-06] Local testing of GitHub Actions Dec 13, 2023

melvin-bot bot added the Help Wanted Apply this label when an issue is open to proposals by contributors label Dec 13, 2023

melvin-bot bot assigned ArekChr Dec 13, 2023

muttmuure assigned sobitneupane and unassigned ArekChr Dec 13, 2023

melvin-bot bot removed the Help Wanted Apply this label when an issue is open to proposals by contributors label Dec 13, 2023

muttmuure assigned rushatgabhane Dec 13, 2023

muttmuure closed this as completed Dec 13, 2023

AndrewGable mentioned this issue Aug 7, 2024

Delete GitHub Actions workflow tests #47010

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[$500] [HOLD for payment 2023-12-06] Local testing of GitHub Actions #13604

[$500] [HOLD for payment 2023-12-06] Local testing of GitHub Actions #13604

roryabraham commented Dec 15, 2022 •

edited by melvin-bot bot

Loading

radoslawkrzemien commented Jan 26, 2023

MelvinBot commented Feb 20, 2023

Prince-Mendiratta commented Feb 20, 2023 •

edited

Loading

radoslawkrzemien commented Feb 21, 2023

melvin-bot bot commented Dec 8, 2023

melvin-bot bot commented Dec 8, 2023

dangrous commented Dec 8, 2023

muttmuure commented Dec 13, 2023

melvin-bot bot commented Dec 13, 2023

melvin-bot bot commented Dec 13, 2023

muttmuure commented Dec 13, 2023 •

edited

Loading

sobitneupane commented Dec 15, 2023

JmillsExpensify commented Dec 15, 2023

JmillsExpensify commented Dec 26, 2023

[$500] [HOLD for payment 2023-12-06] Local testing of GitHub Actions #13604

[$500] [HOLD for payment 2023-12-06] Local testing of GitHub Actions #13604

Comments

roryabraham commented Dec 15, 2022 • edited by melvin-bot bot Loading

Problem

Why this is important

Solution

radoslawkrzemien commented Jan 26, 2023

MelvinBot commented Feb 20, 2023

Prince-Mendiratta commented Feb 20, 2023 • edited Loading

radoslawkrzemien commented Feb 21, 2023

melvin-bot bot commented Dec 8, 2023

melvin-bot bot commented Dec 8, 2023

Bug0 Triage Checklist (Main S/O)

dangrous commented Dec 8, 2023

muttmuure commented Dec 13, 2023

melvin-bot bot commented Dec 13, 2023

melvin-bot bot commented Dec 13, 2023

muttmuure commented Dec 13, 2023 • edited Loading

sobitneupane commented Dec 15, 2023

JmillsExpensify commented Dec 15, 2023

JmillsExpensify commented Dec 26, 2023

roryabraham commented Dec 15, 2022 •

edited by melvin-bot bot

Loading

Prince-Mendiratta commented Feb 20, 2023 •

edited

Loading

muttmuure commented Dec 13, 2023 •

edited

Loading