Skip to content
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 config file support for existing parameters #413

Open
wants to merge 19 commits into
base: main
Choose a base branch
from

Conversation

adhilto
Copy link
Collaborator

@adhilto adhilto commented Sep 17, 2024

🗣 Description

Added config file support for the existing ScubaGoggles parameters. See https://github.com/cisagov/ScubaGoggles/blob/403-add-config-file-support-for-existing-parameters/docs/usage/Config.md for usage details.

💭 Motivation and context

Closes #403.

🧪 Testing

Note this adds a new dependency: pyyaml. Be sure to install that before testing.

Manually tested:

  • Ran without config file
  • Tested with config file
  • Tested with parameters in both config file and specified in the command-line
  • Tested with a mix of both full parameter names and aliases (i.e., -b vs --baselines)

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • Changes are limited to a single goal - eschew scope creep!
  • If applicable, All future TODOs are captured in issues, which are referenced in the PR description.
  • The relevant issues PR resolves are linked preferably via closing keywords.
  • All relevant type-of-change labels have been added.
  • I have read and agree to the CONTRIBUTING.md document.
  • These code changes follow cisagov code standards.
  • All relevant repo and/or project documentation has been updated to reflect the changes in this PR.
  • Tests have been added and/or modified to cover the changes in this PR.
  • All new and existing tests pass.

✅ Pre-merge Checklist

  • This PR has been smoke tested to ensure main is in a functional state when this PR is merged.
  • Squash all commits into one PR level commit using the Squash and merge button.

✅ Post-merge Checklist

  • Delete the branch to clean up.
  • Close issues resolved by this PR if the closing keywords did not activate.

Copy link
Collaborator

@mitchelbaker-cisa mitchelbaker-cisa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, Tested with/without a config file when run via scubagoggles gws and scuba.py. Tested with parameters in both config file/command-line, and with a mix of full param names/aliases.

Left one comment for consideration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Config File Support for Existing Parameters
2 participants