[TEST] Add back necessary tests for deprecated settings that are replaced during applying inclusive naming #2825

tlfeng · 2022-04-11T07:11:02Z

Description

Add some unit tests for validating the backwards compatibility of deprecated master node role and cluster.initial_master_nodes setting.
All the added tests are modified copies of existing tests.
The old node role/setting name in tests were replaced by new node role/setting name in PR #2424 and #2451, and in this PR I added some duplicate tests for the deprecated node role/setting name.

Reason:
To avoid the backwards compatibility of the deprecated setting is broken by mistake during the process of replacing non-inclusive terminology.
There was an issue #2769 that shown a fault caused by PR #2463 (Deprecate setting 'cluster.initial_master_nodes' and introduce the alternative setting 'cluster.initial_cluster_manager_nodes' ).

Issues Resolved

Resolve #2805

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.

…aster role in node.roles setting Signed-off-by: Tianli Feng <[email protected]>

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

tlfeng · 2022-04-11T07:12:31Z

server/src/test/java/org/opensearch/cluster/coordination/ClusterBootstrapServiceTests.java

-            )
-        );
-    }
-


Note: These 2 tests in this class (ClusterBootstrapServiceTests) are moved to the new class ClusterBootstrapServiceDeprecatedMasterTests

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

opensearch-ci-bot · 2022-04-11T07:32:00Z

❌ Gradle Check failure c64878f
Log 4321

Reports 4321

opensearch-ci-bot · 2022-04-11T07:50:08Z

✅ Gradle Check success 76a20eb
Log 4322

Reports 4322

tlfeng · 2022-04-11T22:32:49Z

I'm not sure if it's necessary to backport to 2.0 branch, because there is no fault found during adding the tests.
Probably backporting to 2.x branch is enough.

kartg · 2022-04-19T21:25:04Z

...r/src/internalClusterTest/java/org/opensearch/action/admin/cluster/stats/ClusterStatsIT.java

@@ -144,6 +145,28 @@ public void testNodeCounts() {
        }
    }

+    // Validate assigning value "master" to setting "node.roles" can get correct count in Node Stats response after MASTER_ROLE deprecated.
+    // TODO: Remove the test after removing MASTER_ROLE.


Nitpick - I don't think we need these TODOs alongside all of the tests. When we remove DiscoveryNodeRole.MASTER_ROLE these tests would automatically break, so we would anyway resolve them then

Hi @kartg Thanks for your review! 👍 I will remove the unnecessary TODOs.
The reason I added them is to giving a clear mind that it definitely can be removed. 😂

Removed all the TODO in this PR, and I believe the comment of every newly added test is enough to make people understand they are only used to test the deprecated "master" role setting.

kartg · 2022-04-19T21:26:40Z

...org/opensearch/action/admin/cluster/configuration/AddVotingConfigExclusionsRequestTests.java

+            .build();
+
+        assertThat(makeRequestWithNodeDescriptions("_local").resolveVotingConfigExclusions(clusterState), contains(localNodeExclusion));
+        assertWarnings(AddVotingConfigExclusionsRequest.DEPRECATION_MESSAGE);


This assertion seems unnecessary for this test case - you can probably remove it

👏 You are so careful that notice such detail! Good catch, I will try to replace with exceptWarnings(), removing is not feasible, because any warnings can fail the test.

dblock

@tlfeng let us know when this is ready

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

…ing() Signed-off-by: Tianli Feng <[email protected]>

opensearch-ci-bot · 2022-04-26T21:54:03Z

✅ Gradle Check success 5722253
Log 4816

Reports 4816

tlfeng · 2022-04-26T22:47:02Z

@kartg and @dblock , thank you for your review! I have resolved the above comments, could you please have a look at again?

Resolved all above comments.

…aced during applying inclusive naming (#2825) Signed-off-by: Tianli Feng <[email protected]> (cherry picked from commit 00c0bf2)

…aced during applying inclusive naming (#2825) (#3353) Signed-off-by: Tianli Feng <[email protected]> (cherry picked from commit 00c0bf2)

tlfeng · 2022-05-25T20:39:33Z

There is a test failure in log 4816:

> Task :server:test

REPRODUCE WITH: ./gradlew ':server:test' --tests "org.opensearch.cluster.node.DiscoveryNodeTests.testSetAdditionalRolesCanAddDeprecatedMasterRole" -Dtests.seed=ABC0D0B450403D5F -Dtests.security.manager=true -Dtests.jvm.argline="-XX:TieredStopAtLevel=1 -XX:ReservedCodeCacheSize=64m" -Dtests.locale=und -Dtests.timezone=Asia/Ujung_Pandang -Druntime.java=17

org.opensearch.cluster.node.DiscoveryNodeTests > testSetAdditionalRolesCanAddDeprecatedMasterRole FAILED
    java.lang.AssertionError
        at __randomizedtesting.SeedInfo.seed([ABC0D0B450403D5F:BC544B5D2E9D0B2A]:0)
        at org.junit.Assert.fail(Assert.java:87)
        at org.junit.Assert.assertTrue(Assert.java:42)
        at org.junit.Assert.assertFalse(Assert.java:65)
        at org.junit.Assert.assertFalse(Assert.java:75)
        at org.opensearch.cluster.node.DiscoveryNodeTests.testSetAdditionalRolesCanAddDeprecatedMasterRole(DiscoveryNodeTests.java:183)

The assertion failed:

OpenSearch/server/src/test/java/org/opensearch/cluster/node/DiscoveryNodeTests.java

Line 183 in 00c0bf2

    
           assertFalse(DiscoveryNode.getPossibleRoleNames().contains(DiscoveryNodeRole.MASTER_ROLE.roleName()));

I will resolve the issue in PR #3441

Tianli Feng added 11 commits April 6, 2022 16:10

Add unit tests back to test backwards compatitability of deprecated m…

334c59d

…aster role in node.roles setting Signed-off-by: Tianli Feng <[email protected]>

Adjust format by spotlessApply task

c57b695

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

Revert unexpected change

90cc894

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

Add unit test in add voting config exclusions request

69b5757

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

Add tests for master role in TransportActions

b15a558

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

Add tests for master role in ClusterChangedEventTests

1a6e3f3

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

Add tests for master role in ClusterBootsteapServiceTests

f9eefb7

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

Add tests for master role in TransportMasterNodeAction

e5d730a

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

Add tests for master role in ClusterBootstrapService

9bc46f4

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

Add tests for master role in NodeJoinTests

eb54608

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

Add more test for deprecated setting initial master nodes

c64878f

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

tlfeng added :test Adding or fixing a test v2.0.0 Version 2.0.0 v2.1.0 Issues and PRs related to version 2.1.0 backport 2.x Backport to 2.x branch backport 2.0 Backport to 2.0 branch labels Apr 11, 2022

tlfeng commented Apr 11, 2022

View reviewed changes

Remove some unnecessary TransportActionTests

76a20eb

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

tlfeng marked this pull request as ready for review April 11, 2022 17:34

tlfeng requested a review from a team as a code owner April 11, 2022 17:34

dblock approved these changes Apr 11, 2022

View reviewed changes

dblock requested a review from kartg April 11, 2022 18:55

tlfeng removed v2.0.0 Version 2.0.0 backport 2.0 Backport to 2.0 branch labels Apr 11, 2022

kartg approved these changes Apr 19, 2022

View reviewed changes

dblock previously requested changes Apr 21, 2022

View reviewed changes

Merge remote-tracking branch 'upstream/main' into add-test-master-rol…

5fe6e1a

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

Remove unnecessary TODOs and change an assertWarning() to allowedWarn…

5722253

…ing() Signed-off-by: Tianli Feng <[email protected]>

tlfeng requested a review from reta as a code owner April 26, 2022 21:23

tlfeng merged commit 00c0bf2 into opensearch-project:main May 17, 2022

opensearch-trigger-bot bot mentioned this pull request May 17, 2022

[Backport 2.x] [TEST] Add back necessary tests for deprecated settings that are replaced during applying inclusive naming #3353

Merged

tlfeng pushed a commit that referenced this pull request May 17, 2022

[TEST] Add back necessary tests for deprecated settings that are repl…

671feeb

…aced during applying inclusive naming (#2825) (#3353) Signed-off-by: Tianli Feng <[email protected]> (cherry picked from commit 00c0bf2)

tlfeng mentioned this pull request May 25, 2022

[TEST] Fix testSetAdditionalRolesCanAddDeprecatedMasterRole() by removing the initial assertion #3441

Merged

5 tasks

tlfeng deleted the add-test-master-role-deprecation branch June 6, 2022 21:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TEST] Add back necessary tests for deprecated settings that are replaced during applying inclusive naming #2825

[TEST] Add back necessary tests for deprecated settings that are replaced during applying inclusive naming #2825

tlfeng commented Apr 11, 2022 •

edited

Loading

tlfeng Apr 11, 2022 •

edited

Loading

opensearch-ci-bot commented Apr 11, 2022

opensearch-ci-bot commented Apr 11, 2022

tlfeng commented Apr 11, 2022 •

edited

Loading

kartg Apr 19, 2022

tlfeng Apr 21, 2022

tlfeng Apr 26, 2022

kartg Apr 19, 2022

tlfeng Apr 21, 2022

dblock left a comment

opensearch-ci-bot commented Apr 26, 2022

tlfeng commented Apr 26, 2022

tlfeng commented May 25, 2022

[TEST] Add back necessary tests for deprecated settings that are replaced during applying inclusive naming #2825

[TEST] Add back necessary tests for deprecated settings that are replaced during applying inclusive naming #2825

Conversation

tlfeng commented Apr 11, 2022 • edited Loading

Description

Issues Resolved

Check List

tlfeng Apr 11, 2022 • edited Loading

Choose a reason for hiding this comment

opensearch-ci-bot commented Apr 11, 2022

opensearch-ci-bot commented Apr 11, 2022

tlfeng commented Apr 11, 2022 • edited Loading

kartg Apr 19, 2022

Choose a reason for hiding this comment

tlfeng Apr 21, 2022

Choose a reason for hiding this comment

tlfeng Apr 26, 2022

Choose a reason for hiding this comment

kartg Apr 19, 2022

Choose a reason for hiding this comment

tlfeng Apr 21, 2022

Choose a reason for hiding this comment

dblock left a comment

Choose a reason for hiding this comment

opensearch-ci-bot commented Apr 26, 2022

tlfeng commented Apr 26, 2022

tlfeng commented May 25, 2022

tlfeng commented Apr 11, 2022 •

edited

Loading

tlfeng Apr 11, 2022 •

edited

Loading

tlfeng commented Apr 11, 2022 •

edited

Loading