Sanitize BuildCommand.output by removing NULL characters #4552
Conversation
This file contains 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
PostgreSQL doesn't support NULL (\x00) characters on TextFields. Django 2.0 introduces a new validator that doesn't allow NULL characters to reach the database: https://code.djangoproject.com/ticket/28201 This commit just replaces the NULL characters of the stdout and stder from the command ran by '' (empty string) to avoid conflicts when saving them into the database.
|
I didn't find an easy way to test this. I wrote a test like this def test_null_output(self):
"""Include NULL (\x00) characters on command output."""
cmd = BuildCommand(['/bin/bash', '-c', 'echo -n H\0i'])
cmd.run()
self.assertEqual(cmd.output, 'Hi')but it fails with an exception like |
|
hmm, what about wrapping the clean step in a function like |
|
@stsewd thanks for the suggestion! I added a method into the BuildCommand class, update a test to check the amount of calls to it when running a command, and another test to check that method in particular. What do you think? |
humitos
force-pushed
the
humitos/cmd/sanitize-output
branch
from
628af29 to
7ba297e
Compare
humitos
force-pushed
the
humitos/cmd/sanitize-output
branch
from
7ba297e to
0939caf
Compare
stsewd
approved these changes
Aug 23, 2018
| # Mock BuildCommand.sanitized_output just to count the amount of calls, | ||
| # but use the original method to behaves as real | ||
| original_sanitized_output = cmd.sanitize_output | ||
| with patch('readthedocs.doc_builder.environments.BuildCommand.sanitize_output') as sanitize_output: # noqa |
There was a problem hiding this comment.
We don't run the linter on tests files, so, it doesn't matter having a # noqa comment p:
humitos
added a commit
that referenced
this pull request
Aug 30, 2018
In #4552 I fixed this for LocalBuildEnvironment but I forget to do exactly the same for Docker. This is what this commit does.
agjohnson
pushed a commit
that referenced
this pull request
Aug 30, 2018
) In #4552 I fixed this for LocalBuildEnvironment but I forget to do exactly the same for Docker. This is what this commit does.
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.
PostgreSQL doesn't support NULL (\x00) characters on TextFields.
Django 2.0 introduces a new validator that doesn't allow NULL characters to reach the database:
https://code.djangoproject.com/ticket/28201
This commit just replaces the NULL characters of the stdout and stder from the command ran by '' (empty string) to avoid conflicts when saving them into the database.
Closes #3900