generated from cisagov/ScubaGear
-
Notifications
You must be signed in to change notification settings - Fork 22
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add support for user input and documentation improvements to smoke testing workflow #416
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…up dep macos/windows
mitchelbaker-cisa
temporarily deployed
to
Development
September 18, 2024 01:15
— with
GitHub Actions
Inactive
mitchelbaker-cisa
temporarily deployed
to
Development
September 18, 2024 01:15
— with
GitHub Actions
Inactive
mitchelbaker-cisa
temporarily deployed
to
Development
September 18, 2024 17:18
— with
GitHub Actions
Inactive
mitchelbaker-cisa
temporarily deployed
to
Development
September 18, 2024 17:18
— with
GitHub Actions
Inactive
…w-size argument to chrome_options to fix failing selenium test
mitchelbaker-cisa
temporarily deployed
to
Development
September 18, 2024 21:20
— with
GitHub Actions
Inactive
mitchelbaker-cisa
temporarily deployed
to
Development
September 18, 2024 21:20
— with
GitHub Actions
Inactive
…documentation references
mitchelbaker-cisa
changed the title
Add support for user input when running smoke test workflow
Add support for user input when running smoke test workflow and documentation improvements
Sep 18, 2024
…remove permissions: read-only since we have to write credentials.json to root of runner
mitchelbaker-cisa
changed the title
Add support for user input when running smoke test workflow and documentation improvements
Add support for user input and documentation improvements to smoke testing workflow
Sep 18, 2024
mitchelbaker-cisa
added
the
bug
This issue or pull request addresses broken functionality
label
Sep 18, 2024
adhilto
approved these changes
Sep 19, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changes look good. I successfully manually triggered the smoke test, all tests passed. I have one minor suggestion for the README, but approving either way.
LaurenBassett
approved these changes
Sep 23, 2024
Everything is good here! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🗣 Description
This PR expands on the smoke testing workflow to be more dynamic, such that it can be triggered on push and pull_request events and manually with custom user input.
Made a couple other quality of life improvements to the workflow as well:
environment: Development
key/value from the workflow which removes thex user deployed to Development 1 hour ago -- with GitHub Actions
messages that cluttered pull request timelines.💭 Motivation and context
The smoke testing workflow is currently hardcoded to run against the following operating systems, python/OPA versions:
['windows-latest', 'macos-latest']
,['3.9', '3.12']
, and v0.59.0. This is because theworkflow_dispatch
event for manual runs is only available after a workflow is committed to the main branch.Closes #340
Closes #341
Closes #415
🧪 Testing
Go to the run_smoke_test.yml workflow in the GitHub Actions tab. Click the "Run workflow" button then set
340-smoketest-add-user-input
as the ref branch.The default values are the following:
['windows-latest', 'macos-latest']
(list of supported GitHub-hosted runners)['3.10']
Feel free to play around with the inputs then click the "Run workflow" button when ready. The workflow will create a matrix strategy for each combination. For example, passing
['windows-latest', 'macos-latest']
,['3.10', '3.11', 3.12']
, and OPA version0.60.0
will create the following:Some factors to consider:
[]
,['']
,['', ]
may also cause the workflow to error out, although this is expected behavior.ubuntu-latest
has not been tested as a value for operating system. Support can be added for this, although its dependent on if this is something we want to test for ScubaGoggles as a whole.The workflow runs successfully when testing push events with default values.
The workflow runs successfully when testing pull_request opened events with default values.
✅ Pre-approval checklist
✅ Pre-merge Checklist
Squash and merge
button.✅ Post-merge Checklist