#199 Markdown specification (part 2 of 2) #214
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MackHalliday
reviewed
Mar 7, 2025
notifications_utils/template2.py
Outdated
| Substitute personalization values into markdown, and return the markdown as HTML or plain text. | ||
| """ | ||
|
|
||
| # TODO - Perform substitutions in the markdown. Raise ValueError for missing fields. |
There was a problem hiding this comment.
Do we need a ticket number on this TODO
MackHalliday
reviewed
Mar 7, 2025
notifications_utils/template2.py
Outdated
| if html_content is None and plain_text_content is None: | ||
| raise ValueError('You must supply one of these parameters.') | ||
|
|
||
| # TODO - Perform substitutions in the subject. Raise ValueError for missing fields. |
There was a problem hiding this comment.
More TODOs - Do we need a ticket number
cris-oddball
suggested changes
Mar 7, 2025
cris-oddball
previously approved these changes
Mar 7, 2025
cris-oddball
suggested changes
Mar 10, 2025
k-macmillan
reviewed
Mar 10, 2025
k-macmillan
approved these changes
Mar 10, 2025
cris-oddball
approved these changes
Mar 10, 2025
MackHalliday
approved these changes
Mar 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
These changes add more files to the tests/test_files/ subfolders to codify the expected behavior when rendering markdown as HTML or plain text, and they implement unit tests for all the test_files/ files. The new test files focus on personalization substitutions into links and block quotes, including the substitution of lists into the latter.
Substitutions into URLs of text containing spaces should be URL-safe encoded. The goal isn't that the link is valid (that's on the user); it's that the visual presentation is correct.
The unit tests include a simple happy path test and a test for missing personalization fields, both using markdown for a paragraph. I did not exhaustively test placeholders in all the various markdown permutations we might encounter because I don't think that would add value. When the tests I actually created for the hard cases pass, I am confident the functionality will work for the more straight-forward cases.
You might note that the 3 test classes I created are repetitive. Each class tests one input markdown file. With additional parametrization, I could roll all of these classes into a single test, but I rejected that implementation in favor of only loading the input files once, via a class-scoped fixture.
issue #199
How Has This Been Tested?
I ran the unit tests. The tests I added with this PR all run and fail with NotImplementedError, as is appropriate now. Subsequently, I skipped all these new tests. There are no changes required in notification-api. The next steps are #213, which builds out the implement needed to make these tests pass, and #215, which will integrate the new implementation with notification-api.
Checklist