Update tests and docs for ActiveRecord::Sanitization #44429
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
kmcphillips
commented
Feb 14, 2022
| end | ||
|
|
||
| def test_sanitize_sql_for_order_from_docs | ||
| skip "See https://github.com/rails/rails/issues/44312" |
There was a problem hiding this comment.
This is currently broken #44312 and is what I am working to fix next.
There was a problem hiding this comment.
Best to fix it all in the same PR, I'd be worried the skip may be forgotten otherwise.
kmcphillips
commented
Feb 14, 2022
| assert_equal expected, actual | ||
| end | ||
|
|
||
| def test_sanitize_sql_like_from_docs |
There was a problem hiding this comment.
Technically the like tests do not depend on the connection adapter. But they easily could in future. I always opt for better and proactive test coverage, so added the same tests in all three adapters.
kmcphillips
force-pushed
the
ar-sanitization-docs
branch
2 times, most recently
from
84b6832
to
2c15acf
Compare
byroot
reviewed
Feb 16, 2022
| end | ||
|
|
||
| def test_sanitize_sql_for_order_from_docs | ||
| skip "See https://github.com/rails/rails/issues/44312" |
There was a problem hiding this comment.
Best to fix it all in the same PR, I'd be worried the skip may be forgotten otherwise.
…ss MySQL/SQLite3/PostgreSQL adapters
kmcphillips
force-pushed
the
ar-sanitization-docs
branch
from
2c15acf
to
c3ad4ca
Compare
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.
Summary
In trying to write some failing test cases for #44312, I found that most of
ActiveRecord::Sanitizationis untested. Only a subset of it has test coverage, and much of that coverage is agnostic to the underlying connection adapter.And that last part is the interesting part. The result of all but one of the public sanitization methods in this module depend on the current
ActiveRecord::Base.connectionto decide how to escape the string, and that is not reflected in docs or in tests.I have added comprehensive test coverage local to each adapter. The tests use all the examples in the inline docs, many of which were wrong.
Next, I will use the tests to work on #44404, and they also would have caught the regression in #44312. I updated the docs to reflect the connection dependent behaviour, and updated the cases where the output shown was not what is actually output. I have opted to use the SQLite3/PostgreSQL behaviour in docs as they are both (currently) the same, and presumably SQLite3 is the simplest use case.
I understand that typically PRs of just tests are not merged. Feedback welcome.
@rafaelfranca @byroot