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

Reporter: convert to class implementation (issue 166) #342

Merged
merged 1 commit into from
Aug 14, 2024

Conversation

rlxdev
Copy link
Collaborator

@rlxdev rlxdev commented Aug 7, 2024

🗣 Description

I converted the reporter module to a class. It’s instantiated by the Orchestrator class in the run_reporter() method. There are a few methods in the reporter that format HTML independent of the instance, so these are implemented as static methods.

If you’re reviewing the changes, it’ll be easier to compare this class implementation with the non-class module while ignoring whitespace and empty lines.

💭 Motivation and context

closes #166

🧪 Testing

I've tested these changes by running several different variations of ScubaGoggles runs. All runs I've done were successful. Nearly all changes were associated with converting the reporter functions to class methods, so there weren't any functional changes to the code that would cause any problems.

✅ 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 Roy. Generated a few scubagoggles reports via service account with no issue.

@snarve snarve added this to the Coast milestone Aug 7, 2024
@adhilto adhilto merged commit 9eec6e8 into main Aug 14, 2024
6 checks passed
@adhilto adhilto deleted the 166-reporter-class-implementation branch August 14, 2024 18:21
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.

Convert the ScubaGoggles Reporter to a Class
5 participants