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 the report UUID to the ScubaResults.json filename #1426

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

Conversation

adhilto
Copy link
Collaborator

@adhilto adhilto commented Nov 14, 2024

🗣 Description

Add the report UUID to the ScubaResults.json filename.

💭 Motivation and context

Ensures each results file has a unique file name. Closes #1422.

🧪 Testing

  • Ensured PowerShell unit tests pass
  • Added new unit tests to cover the case when there are multiple matching ScubaResults*.json files
  • Manually tested Invoke-Scuba, works as expected
  • Manually tested Invoke-ScubaCached, works as expected
  • Manually tested Invoke-ScubaCached where the input folder has one file matching "ScubaResults*.json", "ScubaResults.json", works as expected
  • Manually tested Invoke-ScubaCached where the input folder has one file matching "ScubaResults*.json", "ScubaResults_{uuid}.json", works as expected
  • Manually tested Invoke-ScubaCached where the input folder has two file matching "ScubaResults*.json", the most recently created file is used, as expected
  • Manually tested Invoke-Scuba and Invoke-ScubaCached with a non-default OutPath parameter
  • Manually tested both Invoke-Scuba and Invoke-ScubaCached with a non-default OutJsonFileName parameter

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • PR targets the correct parent branch (e.g., main or release-name) for merge.
  • Changes are limited to a single goal - eschew scope creep!
  • Changes are sized such that they do not touch excessive number of files.
  • All future TODOs are captured in issues, which are referenced in code comments.
  • These code changes follow the ScubaGear content style guide.
  • Related issues these changes resolve are linked preferably via closing keywords.
  • All relevant type-of-change labels added.
  • All relevant project fields are set.
  • All relevant repo and/or project documentation updated to reflect these changes.
  • Unit tests added/updated to cover PowerShell and Rego changes.
  • Functional tests added/updated to cover PowerShell and Rego changes.
  • All relevant functional tests passed.
  • All automated checks (e.g., linting, static analysis, unit/smoke tests) passed.

✅ Pre-merge checklist

  • PR passed smoke test check.

  • Feature branch has been rebased against changes from parent branch, as needed

    Use Rebase branch button below or use this reference to rebase from the command line.

  • Resolved all merge conflicts on branch

  • Notified merge coordinator that PR is ready for merge via comment mention

  • Demonstrate changes to the team for questions and comments.
    (Note: Only required for issues of size Medium or larger)

✅ Post-merge checklist

  • Feature branch deleted after merge to clean up repository.
  • Verified that all checks pass on parent branch (e.g., main or release-name) after merge.

@adhilto adhilto added the enhancement This issue or pull request will add new or improve existing functionality label Nov 14, 2024
@adhilto adhilto added this to the Jellyfish milestone Nov 14, 2024
@adhilto adhilto self-assigned this Nov 14, 2024
@adhilto adhilto linked an issue Nov 14, 2024 that may be closed by this pull request
@buidav buidav self-assigned this Nov 16, 2024
@buidav buidav removed their request for review November 16, 2024 01:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This issue or pull request will add new or improve existing functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Append UUID to ScubaResults.json by default
2 participants