Update builder

[bjb28]

This PR is focused on the builder.py script and the associated tests. The main effort is to replace the test_assessment_json.py with smaller tests that are now located in test_builder.py. Additionally, the PR addresses uncaught errors that were causing crashes and improves overall formatting. The specific commits address the following:

• Fix the issues that were causing crashes. b1f28a64 ccc2749 5a182cd
• Set review_campaign to draw groups and pages through the appropriate select functions. b1f28a64
• Improve the build page process by adding the ability to set the page name, and cleans the formatting for build_pages. debf70717
• Create tests for build_assessment, build_campaigns, and build_pages. cafb0619 2a4be45 41a0a02e 9eebd9a7
• Add the ability to create an email by loading HTML and text while receiving user input for the other items. 77bc5e6
• Housekeeping on f-strings, docstrings, and formatting. 340d4528 b1f28a64 6060c047 d940c33

This PR also merged elements from a previous attempted to fix the test_assessment_json.py, #12. The commits form these elements are as follows:

• Change to using csv.DictReader and mock to provide email csv data. 536ce8d e001e8a 4fd96c1
• Housekeeping within the group build process inside build.py. 4fd96c1
• Patch docopt to get the initial test to run. 36089bc Removed in 97d750f
• Mock open to prevent the test form looking for the files. 536ce8d Removed in 97d750f
• Mock json.load to load what would have been read from a file. 536ce8d Removed in 97d750f

💭 Motivation and Context

Replacing test_assessment_json.py allows for improved testing of the builder.py script. With the new tests functioning, making future changes to the script will be easier to test. Maintaining these smaller tests is much easier than making edits to the test_assessment_json.py. This PR closes #6.

Several other errors were discovered in additional user testing that caused significant problems when exceptions left uncaught. By handing the crashes, the user will not be required to redo the entire wizard as a result of a crash.

Adding the ability to create an email by importing separate HTML and text files makes building complicated emails easier. The alternative requires the user manual convert the same information into a single line for the JSON import. Keeping the import json function is ideal for previously used templates that come from a database.

🧪 Testing

After adding a significant number of new smaller tests, each was run to ensure proper functionality. Manual tests were also conducted to ensure the output of each test was accurate. Multiple full runs of the builder.py script were conducted to ensure the ending JSON was correctly formatted.

📷 Screenshots (if appropriate)

🚥 Types of Changes

• [x] Bug fix (non-breaking change which fixes an issue)
• [x] New feature (non-breaking change which adds functionality)
• [x] Breaking change (causes existing functionality to change)

✅ Checklist

• [x] My code follows the code style of this project.
• [x] My change requires a change to the documentation.
• [x] I have updated the documentation accordingly.
• [x] I have read the CONTRIBUTING document.
• [x] I have added tests to cover my changes.
• [x] All new and existing tests passed.

[lgtm-com[bot]]

This pull request introduces 1 alert when merging 5a182cda51b73e3687f77536ca0a1cdfdff2e647 into ca2f48087993a731434fd10ca0717555e7b3b00f - view on LGTM.com

new alerts:

• 1 for Variable defined multiple times

[BenBreaksThings]

Created by individual no longer supporting the team or the repository, left unattended and without handoff between development teams. Recommend closing the PR without adopting as the codebase has changed multiple times since PR went dormant and the requirements of the project and the teams supported by the project have evolved. Any future iteration of the intent of this PR to be opened/addressed in a discrete, deliberate PR.