AVRO-4058: [C++] Improve readability of SchemaTests #3167
Merged
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
Gerrit0
reviewed
Sep 23, 2024
lang/c++/test/SchemaTests.cc
Outdated
| @@ -315,11 +436,13 @@ static void testRoundTrip(const char *schema) { | |||
| compiledSchema.toJson(os); | |||
| std::string result = os.str(); | |||
| result.erase(std::remove_if(result.begin(), result.end(), ::isspace), result.end()); // Remove whitespace | |||
| BOOST_CHECK(result == std::string(schema)); | |||
| std::string trimmedSchema = schema; | |||
| trimmedSchema.erase(std::remove_if(trimmedSchema.begin(), trimmedSchema.end(), ::isspace), trimmedSchema.end()); | |||
There was a problem hiding this comment.
Every time I see someone do something like this I worry...
std::isspace
The behavior is undefined if the value of ch is not representable as unsigned char and is not equal to EOF.
In this case it is (mostly) okay as the schemas all have chars which meet these requirements, but if toJson ever has a bug which doesn't meet this requirement, we now have undefined behavior.
std::string trimmedSchema = schema;
boost::algorithm::replace_all(trimmedSchema, " ", "");
boost::algorithm::replace_all(trimmedSchema, "\n", "");... and now that I've written that, I see you just followed the bad example above...
There was a problem hiding this comment.
Thanks for pointing this out, I was not aware of the issues with std::isspace
Gerrit0
approved these changes
Sep 23, 2024
martin-g
approved these changes
Sep 24, 2024
martin-g
changed the title
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.
AVRO-4058 (Preparation)
Migrated the vast majority of json schema definitions to raw string literals to improve their readability. Notable exception are schemas heavily relying on escaped characters that test the json after compilation are compact
What is the purpose of the change
Improve readability of json schemas in SchemaTests.cc (Similar work was already done in CodecTests.cc in PR #2762)
I did this work in preparation of adding some new tests in the context of AVRO-4058
Verifying this change
(Please pick one of the following options)
This change is a trivial rework / code cleanup without any test coverage.
Documentation