cisagov / tpt-reports

Process to build and distribute Technical Phishing Test (TPT) reports
Creative Commons Zero v1.0 Universal
4 stars 0 forks source link

Convert OUTPUT_DIRECTORY to optional argument with default value #54

Closed nickviola closed 11 months ago

nickviola commented 11 months ago

🗣 Description

Resolves #27 and converts OUTPUT_DIRECTORY argument to optional "-o --output-dir" with default value decided by team. The default output directory has been set to "~/" (root of users home directory). This PR also patches generate_reports function in test_tpt_reports.py so that it doesn't actually generate pdfs in unit testing.

💭 Motivation and context

Closes #27, the result of planning discussions with the team to add versatility to the script and simplicity for users.

🧪 Testing

Run the command line tool without any output directory supplied to use the default "~/" or pass another directory with --output-dir=.

✅ Pre-approval checklist

coveralls commented 11 months ago

Pull Request Test Coverage Report for Build 6358242208


Totals Coverage Status
Change from base Build 6357232685: 0.0%
Covered Lines: 0
Relevant Lines: 0

💛 - Coveralls
nickviola commented 11 months ago

Since this PR has already been approved, I will put the versioning changes in my next PR per discussions here: https://github.com/cisagov/tpt-reports/pull/51#issuecomment-1737566932