Skip to content
This repository has been archived by the owner on Feb 14, 2024. It is now read-only.

Add report generator page to UI #282

Merged
merged 49 commits into from
Oct 25, 2022

Conversation

DJensen94
Copy link
Contributor

@DJensen94 DJensen94 commented Sep 27, 2022

🗣 Description

Add report generator page to UI. This page will be used to generate biweekly reports and bulletins for cybersixgill alerts and credential breaches when we identify a critical issue that needs to be sent to stakeholders immediately.
Fixes #241

💭 Motivation and context

In the past reports were generated through a command line program that isn't super user friendly. This is designed to ensure that any P&E team member can generate the reports without any technical knowledge of the process.

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • Changes are limited to a single goal - eschew scope creep!
  • I have read the CONTRIBUTING 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.

DJensen94 and others added 5 commits September 27, 2022 16:37
Add report generator page to UI to generate biweekly reports and bulletins for cybersix alerts and credential breaches
add helpers folder to package data to be able to reference helpers from app
Moved bulletin folder to the correct helpers folder
@lgtm-com
Copy link

lgtm-com bot commented Sep 27, 2022

This pull request introduces 1 alert when merging 0ee5ef4 into 78ccbfd - view on LGTM.com

new alerts:

  • 1 for Module is imported with 'import' and 'import from'

add pdfkit to the modules in setup file
@lgtm-com
Copy link

lgtm-com bot commented Sep 27, 2022

This pull request introduces 1 alert when merging ed5d8cc into 78ccbfd - view on LGTM.com

new alerts:

  • 1 for Module is imported with 'import' and 'import from'

Update the logging declaration in the config file in pe-source folder
@lgtm-com
Copy link

lgtm-com bot commented Sep 28, 2022

This pull request introduces 1 alert when merging fe2dd83 into 78ccbfd - view on LGTM.com

new alerts:

  • 1 for Module is imported with 'import' and 'import from'

@cduhn17 cduhn17 added this to In progress in Sprint 17 Oct 18, 2022
@cduhn17 cduhn17 added the High Priority Issue is key to completion of Sprint label Oct 18, 2022
Renamed filename and references to avoid issue with duplicated names
update the call to add central logging
Update the form label instructions to clarify what day should be used to generate the report.
@coveralls
Copy link

coveralls commented Oct 18, 2022

Coverage Status

Coverage increased (+5.5%) to 24.486% when pulling 1f9e056 on DJ-add_report_and_bulletin_generator-WIP into 78ccbfd on develop.

@lgtm-com
Copy link

lgtm-com bot commented Oct 18, 2022

This pull request introduces 1 alert when merging 1cb092c into 78ccbfd - view on LGTM.com

new alerts:

  • 1 for Module is imported with 'import' and 'import from'

@lgtm-com
Copy link

lgtm-com bot commented Oct 20, 2022

This pull request introduces 1 alert when merging 7d57e76 into 78ccbfd - view on LGTM.com

new alerts:

  • 1 for Module is imported with 'import' and 'import from'

@lgtm-com
Copy link

lgtm-com bot commented Oct 20, 2022

This pull request introduces 1 alert when merging 1596da2 into 78ccbfd - view on LGTM.com

new alerts:

  • 1 for Module is imported with 'import' and 'import from'

Copy link
Contributor

@aloftus23 aloftus23 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 just a couple notes:

.flake8 Outdated Show resolved Hide resolved
src/pe_reports/report_gen/views.py Show resolved Hide resolved
Fix text for cybersixgill to be one word instead of two

Co-authored-by: aloftus23 <79927030+aloftus23@users.noreply.github.com>
@lgtm-com
Copy link

lgtm-com bot commented Oct 21, 2022

This pull request introduces 1 alert when merging ea8a1b1 into 78ccbfd - view on LGTM.com

new alerts:

  • 1 for Module is imported with 'import' and 'import from'

change print statements to logging statements
.flake8 Outdated Show resolved Hide resolved
DJensen94 and others added 17 commits October 24, 2022 17:07
Fix the root domain query functions docstring to be clear.

Co-authored-by: dav3r <david.redmin@trio.dhs.gov>
Update log statement to not use f-strings and clarify meaning

Co-authored-by: dav3r <david.redmin@trio.dhs.gov>
Remove unused today's date variable

Co-authored-by: dav3r <david.redmin@trio.dhs.gov>
Remove camel case to keep consistency

Co-authored-by: dav3r <david.redmin@trio.dhs.gov>
Remove camel case to keep consistency

Co-authored-by: dav3r <david.redmin@trio.dhs.gov>
Remove camel case to keep consistency

Co-authored-by: dav3r <david.redmin@trio.dhs.gov>
Simplify the method for checking if a provided date is the last day of the month

Co-authored-by: dav3r <david.redmin@trio.dhs.gov>
Test if a leap year occurs on the user provided date

Co-authored-by: dav3r <david.redmin@trio.dhs.gov>
Remove f-string from log message

Co-authored-by: dav3r <david.redmin@trio.dhs.gov>
remove unnecessary spaces from url_for call

Co-authored-by: dav3r <david.redmin@trio.dhs.gov>
Implement snake case into the naming of all the form variables
Fix spelling issue and remove confusing part of error message.

Co-authored-by: dav3r <david.redmin@trio.dhs.gov>
Target flake8 exception to specific instance that needs to be overruled instead of opening up the whole repo
When a date does not meet the standards return False
Fix the spelling of an updated variable
Explain why we are using a different logger call in this file, which is to avoid circular references
Explaining why we are adding numbers after the variable names to distinguish between them
DJensen94 and others added 5 commits October 25, 2022 11:24
Explain why we are calling the logger differently in the config file
Capitalize HTML in html_builder function's docstring

Co-authored-by: dav3r <david.redmin@trio.dhs.gov>
Remove space after variable in the html file to keep consistency.

Co-authored-by: dav3r <david.redmin@trio.dhs.gov>
Fix the typo in the comment explaining the logger connection
Copy link
Member

@dav3r dav3r left a comment

Choose a reason for hiding this comment

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

Thanks for the swift turnaround on my feedback - nice work! 🌪️ 🚀

@cduhn17 cduhn17 merged commit dd5a870 into develop Oct 25, 2022
Sprint 17 automation moved this from In progress to Done Oct 25, 2022
@cduhn17 cduhn17 deleted the DJ-add_report_and_bulletin_generator-WIP branch October 25, 2022 18:58
@aloftus23 aloftus23 added the duplicate This issue or pull request already exists or is covered in another issue or pull request label Oct 26, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
duplicate This issue or pull request already exists or is covered in another issue or pull request High Priority Issue is key to completion of Sprint
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Add functionality to the UI to support PE Bullitens
5 participants