This pull request aims to improve the granularity and clarity of testing in the Gson project by splitting the testWriteHtmlSafe test case into two separate tests. This change allows each test to focus on a single scenario: one with HTML escaping enabled and the other with it disabled. Splitting the test enhances the readability and maintainability of the test suite, ensuring that failures in one scenario do not affect the execution of tests in another scenario. This approach facilitates more precise identification of issues and improves the efficiency of debugging and test execution.
Closes #2651
Description
The existing testWriteHtmlSafe combined two scenarios—testing Gson's behavior with HTML escaping both enabled and disabled—into a single test method. This PR proposes splitting this into two distinct test methods:
testWriteHtmlSafeWithEscaping: Tests Gson's default behavior of escaping HTML characters.
testWriteHtmlSafeWithoutEscaping: Tests Gson's behavior when HTML escaping is disabled using GsonBuilder().disableHtmlEscaping().
This separation increases test specificity and ensures that a failure in one part of the test suite does not hinder the execution or identification of issues in another part. The PR includes the addition of these two new test methods to the Gson test suite, providing a clearer, more targeted approach to testing Gson's HTML escaping functionalities.
Checklist
[x] New code follows the Google Java Style Guide\
This is automatically checked by mvn verify, but can also be checked on its own using mvn spotless:check.\
Style violations can be fixed using mvn spotless:apply; this can be done in a separate commit to verify that it did not cause undesired changes.
[ ] If necessary, new public API validates arguments, for example rejects null
[ ] New public API has Javadoc
[ ] Javadoc uses @since $next-version$
($next-version$ is a special placeholder which is automatically replaced during release)
[x] If necessary, new unit tests have been added
[x] Assertions in unit tests use Truth, see existing tests
[x] No JUnit 3 features are used (such as extending class TestCase)
[ ] If this pull request fixes a bug, a new test was added for a situation which failed previously and is now fixed
[x] mvn clean verify javadoc:jar passes without errors
Purpose
This pull request aims to improve the granularity and clarity of testing in the Gson project by splitting the testWriteHtmlSafe test case into two separate tests. This change allows each test to focus on a single scenario: one with HTML escaping enabled and the other with it disabled. Splitting the test enhances the readability and maintainability of the test suite, ensuring that failures in one scenario do not affect the execution of tests in another scenario. This approach facilitates more precise identification of issues and improves the efficiency of debugging and test execution.
Closes #2651
Description
The existing testWriteHtmlSafe combined two scenarios—testing Gson's behavior with HTML escaping both enabled and disabled—into a single test method. This PR proposes splitting this into two distinct test methods:
testWriteHtmlSafeWithEscaping: Tests Gson's default behavior of escaping HTML characters.testWriteHtmlSafeWithoutEscaping: Tests Gson's behavior when HTML escaping is disabled usingGsonBuilder().disableHtmlEscaping().This separation increases test specificity and ensures that a failure in one part of the test suite does not hinder the execution or identification of issues in another part. The PR includes the addition of these two new test methods to the Gson test suite, providing a clearer, more targeted approach to testing Gson's HTML escaping functionalities.
Checklist
mvn verify, but can also be checked on its own usingmvn spotless:check.\ Style violations can be fixed usingmvn spotless:apply; this can be done in a separate commit to verify that it did not cause undesired changes.null@since $next-version$(
$next-version$is a special placeholder which is automatically replaced during release)TestCase)mvn clean verify javadoc:jarpasses without errors