Use Hamcrest matchers and assertThat() in ReindexRenamedSettingTests to improve readability #2503

tlfeng · 2022-03-18T06:07:53Z

Description

Use Hamcrest matchers and assertThat() in ReindexRenamedSettingTests to improve the readability.

Reason:
The order of the assertEquals() arguments in ReindexRenamedSettingTests class is reversed.

The unit test class ReindexRenamedSettingTests were added in PR #2221 / commit 63c75d1

According to the comment in #2463 (comment):

The first argument of the assert is the expected value, and the second is the actual value.

Issues Resolved

Related to issue #1547

Check List

New functionality includes testing.
- All tests pass
New functionality has been documented.
- New functionality has javadoc added
Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Tianli Feng <[email protected]>

opensearch-ci-bot · 2022-03-18T06:35:51Z

❌ Gradle Check failure 29ffc42
Log 3509

Reports 3509

Signed-off-by: Tianli Feng <[email protected]>

tlfeng · 2022-03-18T17:13:00Z

in log 3509:

> Task :server:internalClusterTest

REPRODUCE WITH: ./gradlew ':server:internalClusterTest' --tests "org.opensearch.search.SearchCancellationIT.testMSearchChildRequestCancellationWithClusterLevelTimeout" -Dtests.seed=E7E590B85679E426 -Dtests.security.manager=true -Dtests.jvm.argline="-XX:TieredStopAtLevel=1 -XX:ReservedCodeCacheSize=64m" -Dtests.locale=no -Dtests.timezone=Australia/South -Druntime.java=17

org.opensearch.search.SearchCancellationIT > testMSearchChildRequestCancellationWithClusterLevelTimeout FAILED
    java.lang.AssertionError: Actual child request with cancellation failure is different that expected expected:<[0, 1]> but was:<[]>
        at __randomizedtesting.SeedInfo.seed([E7E590B85679E426:59585B5DC76F0451]:0)
        at org.junit.Assert.fail(Assert.java:89)
        at org.junit.Assert.failNotEquals(Assert.java:835)
        at org.junit.Assert.assertEquals(Assert.java:120)
        at org.opensearch.search.SearchCancellationIT.ensureMSearchWasCancelled(SearchCancellationIT.java:194)
        at org.opensearch.search.SearchCancellationIT.testMSearchChildRequestCancellationWithClusterLevelTimeout(SearchCancellationIT.java:537)

It's reported in issue #2242

opensearch-ci-bot · 2022-03-18T17:44:31Z

❌ Gradle Check failure 4b0abf6
Log 3518

Reports 3518

andrross

The first argument of the assert is the expected value, and the second is the actual value.

FYI, this is one reason to prefer the Hamcrest matcher style of assertThat(actualValue, equalTo(expectedValue)) because it reads more naturally and you don't have know the ordering.

tlfeng · 2022-03-18T18:07:58Z

@andrross Thank you for sharing the knowledge! Now I know assertThat() should be preferred to use.

Hamcrest strives to make your tests as readable as possible.

p.s. the advantages of assertThat() are shown in the release notes of junit 4.4: http://junit.sourceforge.net/doc/ReleaseNotes4.4.html

tlfeng · 2022-03-18T18:39:11Z

In Log 3518:

> Task :qa:remote-clusters:integTest FAILED

REPRODUCE WITH: ./gradlew ':qa:remote-clusters:integTest' --tests "org.opensearch.cluster.remote.test.RemoteClustersIT.testHAProxyModeConnectionWorks" -Dtests.seed=DB46B9E87253F055 -Dtests.security.manager=true -Dtests.jvm.argline="-XX:TieredStopAtLevel=1 -XX:ReservedCodeCacheSize=64m" -Dtests.locale=no -Dtests.timezone=America/Argentina/San_Juan -Druntime.java=17

WARNING: A terminally deprecated method in java.lang.System has been called
WARNING: System::setSecurityManager has been called by org.gradle.api.internal.tasks.testing.worker.TestWorker (file:/home/ubuntu/.gradle/wrapper/dists/gradle-7.3.3-all/4295vidhdd9hd3gbjyw1xqxpo/gradle-7.3.3/lib/plugins/gradle-testing-base-7.3.3.jar)
WARNING: Please consider reporting this to the maintainers of org.gradle.api.internal.tasks.testing.worker.TestWorker
WARNING: System::setSecurityManager will be removed in a future release
org.opensearch.cluster.remote.test.RemoteClustersIT > testHAProxyModeConnectionWorks FAILED
    java.lang.AssertionError
        at __randomizedtesting.SeedInfo.seed([DB46B9E87253F055:DC306C2349D58608]:0)
        at org.junit.Assert.fail(Assert.java:87)
        at org.junit.Assert.assertTrue(Assert.java:42)
        at org.junit.Assert.assertTrue(Assert.java:53)
        at org.opensearch.cluster.remote.test.RemoteClustersIT.testHAProxyModeConnectionWorks(RemoteClustersIT.java:125)

It's reported in #1703, this one fails very often recently.

Signed-off-by: Tianli Feng <[email protected]>

tlfeng · 2022-03-18T18:43:26Z

modules/reindex/src/test/java/org/opensearch/index/reindex/ReindexRenamedSettingTests.java

 import org.opensearch.common.settings.Setting;
 import org.opensearch.common.settings.Settings;
 import org.opensearch.test.OpenSearchTestCase;

 import java.util.Arrays;
 import java.util.List;

+import static org.hamcrest.Matchers.equalTo;


According to suggestion from @andrross , I updated all the assertions to use assertThat() and Matchers API from Hamcrest, in this file.

opensearch-ci-bot · 2022-03-18T19:07:41Z

❌ Gradle Check failure 755f677ecc3d9dd91a0a4b8aa57f74fa528b5c8e
Log 3522

Reports 3522

opensearch-ci-bot · 2022-03-18T19:31:37Z

✅ Gradle Check success eccb012
Log 3523

Reports 3523

tlfeng · 2022-03-18T19:59:29Z

In log 3522:

REPRODUCE WITH: ./gradlew ':server:internalClusterTest' --tests "org.opensearch.gateway.RecoveryFromGatewayIT.testReuseInFileBasedPeerRecovery" -Dtests.seed=678B15424FD7EBE5 -Dtests.security.manager=true -Dtests.jvm.argline="-XX:TieredStopAtLevel=1 -XX:ReservedCodeCacheSize=64m" -Dtests.locale=sr-RS -Dtests.timezone=Pacific/Midway -Druntime.java=17

org.opensearch.gateway.RecoveryFromGatewayIT > testReuseInFileBasedPeerRecovery FAILED
    java.lang.AssertionError: shard [test][0] on node [node_t1] has pending operations:
     --> RetentionLeaseBackgroundSyncAction.Request{retentionLeases=RetentionLeases{primaryTerm=1, version=1480, leases={peer_recovery/awjm15faRpeBMJiOvn_QMQ=RetentionLease{id='peer_recovery/awjm15faRpeBMJiOvn_QMQ', retainingSequenceNumber=786, timestamp=1647629686105, source='peer recovery'}, peer_recovery/7LnHvaeSRV6f3UsOaIJARg=RetentionLease{id='peer_recovery/7LnHvaeSRV6f3UsOaIJARg', retainingSequenceNumber=786, timestamp=1647629686105, source='peer recovery'}}}, shardId=[test][0], timeout=1m, index='test', waitForActiveShards=0}
    	at org.opensearch.index.shard.IndexShardOperationPermits.acquire(IndexShardOperationPermits.java:248)
    	at org.opensearch.index.shard.IndexShard.acquirePrimaryOperationPermit(IndexShard.java:3146)

It's reported in issue #1746, this one also fails frequently recently.

Signed-off-by: Tianli Feng <[email protected]>

opensearch-ci-bot · 2022-03-18T21:41:12Z

❌ Gradle Check failure ce4adbb
Log 3527

Reports 3527

…lowlist-setting Signed-off-by: Tianli Feng <[email protected]>

opensearch-ci-bot · 2022-03-18T22:21:59Z

❌ Gradle Check failure 5d77f8d
Log 3529

Reports 3529

Signed-off-by: Tianli Feng <[email protected]>

opensearch-ci-bot · 2022-03-19T07:17:38Z

❌ Gradle Check failure 37d6fe4
Log 3535

Reports 3535

tlfeng · 2022-03-19T07:28:12Z

In report 3535:
failed test:
org.opensearch.index.ShardIndexingPressureConcurrentExecutionTests.html#testCoordinatingPrimaryThreadedUpdateToShardLimitsAndRejections

start gradle check

opensearch-ci-bot · 2022-03-19T08:20:44Z

✅ Gradle Check success 37d6fe4
Log 3540

Reports 3540

Flip arguments in assertEquals() in ReindexRenamedSettingTests

29ffc42

Signed-off-by: Tianli Feng <[email protected]>

tlfeng added :test Adding or fixing a test v2.0.0 Version 2.0.0 non-issue bugs / unexpected behaviors that end up non issues; audit trail simple changes that aren't issues labels Mar 18, 2022

tlfeng requested a review from a team as a code owner March 18, 2022 06:07

VachaShah approved these changes Mar 18, 2022

View reviewed changes

Merge branch 'main' into flip-assertequal-allowlist-setting

4b0abf6

Signed-off-by: Tianli Feng <[email protected]>

owaiskazi19 approved these changes Mar 18, 2022

View reviewed changes

andrross approved these changes Mar 18, 2022

View reviewed changes

Use Hamcrest assertThat and matchers instead of junit methods

eccb012

Signed-off-by: Tianli Feng <[email protected]>

tlfeng force-pushed the flip-assertequal-allowlist-setting branch from 755f677 to eccb012 Compare March 18, 2022 18:40

tlfeng commented Mar 18, 2022

View reviewed changes

Use assertThat() and Hamcrest matchers instead of junit navtive methods

ce4adbb

Signed-off-by: Tianli Feng <[email protected]>

tlfeng changed the title ~~Flip assertEquals() arguments in ReindexRenamedSettingTests~~ Use Hamcrest matchers and assertThat() in ReindexRenamedSettingTests Mar 18, 2022

Merge remote-tracking branch 'upstream/main' into flip-assertequal-al…

5d77f8d

…lowlist-setting Signed-off-by: Tianli Feng <[email protected]>

Merge branch 'main' into flip-assertequal-allowlist-setting

37d6fe4

Signed-off-by: Tianli Feng <[email protected]>

tlfeng merged commit a853253 into opensearch-project:main Mar 19, 2022

tlfeng changed the title ~~Use Hamcrest matchers and assertThat() in ReindexRenamedSettingTests~~ Use Hamcrest matchers and assertThat() in ReindexRenamedSettingTests to improve readability Mar 19, 2022

tlfeng deleted the flip-assertequal-allowlist-setting branch March 19, 2022 08:26

xuezhou25 mentioned this pull request Feb 23, 2023

Disallow multiple data paths for search nodes #6427

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use Hamcrest matchers and assertThat() in ReindexRenamedSettingTests to improve readability #2503

Use Hamcrest matchers and assertThat() in ReindexRenamedSettingTests to improve readability #2503

tlfeng commented Mar 18, 2022 •

edited

Loading

opensearch-ci-bot commented Mar 18, 2022

tlfeng commented Mar 18, 2022

opensearch-ci-bot commented Mar 18, 2022

andrross left a comment

tlfeng commented Mar 18, 2022

tlfeng commented Mar 18, 2022

tlfeng Mar 18, 2022 •

edited

Loading

opensearch-ci-bot commented Mar 18, 2022

opensearch-ci-bot commented Mar 18, 2022

tlfeng commented Mar 18, 2022

opensearch-ci-bot commented Mar 18, 2022

opensearch-ci-bot commented Mar 18, 2022

opensearch-ci-bot commented Mar 19, 2022

tlfeng commented Mar 19, 2022

opensearch-ci-bot commented Mar 19, 2022

Use Hamcrest matchers and assertThat() in ReindexRenamedSettingTests to improve readability #2503

Use Hamcrest matchers and assertThat() in ReindexRenamedSettingTests to improve readability #2503

Conversation

tlfeng commented Mar 18, 2022 • edited Loading

Description

Issues Resolved

Check List

opensearch-ci-bot commented Mar 18, 2022

tlfeng commented Mar 18, 2022

opensearch-ci-bot commented Mar 18, 2022

andrross left a comment

Choose a reason for hiding this comment

tlfeng commented Mar 18, 2022

tlfeng commented Mar 18, 2022

tlfeng Mar 18, 2022 • edited Loading

Choose a reason for hiding this comment

opensearch-ci-bot commented Mar 18, 2022

opensearch-ci-bot commented Mar 18, 2022

tlfeng commented Mar 18, 2022

opensearch-ci-bot commented Mar 18, 2022

opensearch-ci-bot commented Mar 18, 2022

opensearch-ci-bot commented Mar 19, 2022

tlfeng commented Mar 19, 2022

opensearch-ci-bot commented Mar 19, 2022

tlfeng commented Mar 18, 2022 •

edited

Loading

tlfeng Mar 18, 2022 •

edited

Loading