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.

Sign up for GitHub

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

Jump to bottom

Fix/report naming #3666

Merged
merged 19 commits into from
Oct 17, 2024
Merged

Fix/report naming #3666

merged 19 commits into from
Oct 17, 2024

Conversation

Donnype
Copy link
Contributor

@Donnype Donnype commented Oct 10, 2024 •
edited
Loading

Changes

  • Adds the right naming logic in the report runner.
  • Introduces a first integration test for the report runner.
  • Some typing fixes.

Issue link

Closes #3632

Demo

See the template and outputted names in the integration test: this is what we expect now (@Rieven right?).

QA notes

Please go through the generate report flow and verify that the names appear as expected. Also see the issue for what we want to avoid.

  • All the commits in this PR are properly PGP-signed and verified.
  • This PR only contains functionality relevant to the issue.
  • I have written unit tests for the changes or fixes I made.
  • I have checked the documentation and made changes where necessary.
  • I have performed a self-review of my code and refactored it to the best of my abilities.
  • Tickets have been created for newly discovered issues.
  • For any non-trivial functionality, I have added integration and/or end-to-end tests.
  • I have included comments in the code to elaborate on what is not self-evident from the code itself, including references to issues and discussions online, or implicit behavior of an interface.

Checklist for code reviewers:

Copy-paste the checklist from the docs/source/templates folder into your comment.

Checklist for QA:

Copy-paste the checklist from the docs/source/templates folder into your comment.

@Donnype Donnype requested a review from a team as a code owner October 10, 2024 11:09
ammar92
ammar92 previously approved these changes Oct 11, 2024
View reviewed changes
Copy link
Contributor

@ammar92 ammar92 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 to me. I left a tiny suggestion for the clients for a next iteration

rocky/onboarding/views.py Show resolved Hide resolved
rocky/reports/runner/local.py Outdated Show resolved Hide resolved
@Donnype
Copy link
Contributor Author

Donnype commented Oct 16, 2024

@Rieven Could you test this one again?

@Donnype Donnype mentioned this pull request Oct 16, 2024
Open
@stephanie0x00
Copy link
Contributor

Checklist for QA:

  • I have checked out this branch, and successfully ran a fresh make reset.
  • I confirmed that there are no unintended functional regressions in this branch:
    • I have managed to pass the onboarding flow
    • Objects and Findings are created properly
    • Tasks are created and completed properly
  • I confirmed that the PR's advertised feature or hotfix works as intended.
  • I checked the logs for errors and/or warnings and made issues where necessary

What works:

Looks good. Requires one small addition as described below.

What doesn't work:

By changing the format for the "Report name format" (first textbox) the corresponding explanation text is now outdated. This should be updated to explain the usage of the {oois_count}.

image

Bug or feature?:

n/a

@Donnype
Copy link
Contributor Author

Donnype commented Oct 16, 2024

Thanks @stephanie0x00! Done

@stephanie0x00
Copy link
Contributor

Looks good 👍

@Donnype Donnype mentioned this pull request Oct 17, 2024
Closed
@sonarcloud SonarCloud
Copy link

sonarcloud bot commented Oct 17, 2024

Quality Gate Failed Quality Gate failed

Failed conditions
19.1% Coverage on New Code (required ≥ 80%)

See analysis details on SonarCloud

@underdarknl underdarknl merged commit 7bc231b into main Oct 17, 2024
32 of 33 checks passed
@underdarknl underdarknl deleted the fix/report-naming branch October 17, 2024 11:57
jpbruinsslot added a commit that referenced this pull request Oct 24, 2024
@jpbruinsslot
Merge branch 'main' into chore/mula/documentation
63b2ad4 
* main: (25 commits)
  Add sterr to output list (#3649)
  feat: ✨ add Shodan InternetDB boefje (#2615)
  Add search endpoint for schedules for scheduler (#3695)
  Fix/report naming (#3666)
  Add delete schedule functionality for schedules in the scheduler (#3678)
  Fix javascript and component template in prod environments (#3672)
  Fix first order dangling affirmation delete (#3682)
  Do not run dh_strip_nondeterminism in Debian packaging (#3674)
  Github action should trigger if workflow definition changes (#3680)
  Updated packages (#3694)
  Silence KATFindingType not found error in JobHandler (#3686)
  Add docs for xtdb analyze bits. (#3688)
  Fix empty vulnerability reports (#3662)
  Fix jsonb 'contained by' query (#3643)
  Add plugins to findings report (#3657)
  Translations update from Hosted Weblate (#3673)
  Update upload_raw.py (#3645)
  Add rocky worker service to debian packages (#3619)
  Fix/yielded objects (#3669)
  make some things look better (#3661)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Rieven Rieven Rieven left review comments

@underdarknl underdarknl underdarknl approved these changes

@ammar92 ammar92 ammar92 left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

The naming of reports is not working yet
5 participants
@Donnype @stephanie0x00 @underdarknl @ammar92 @Rieven