Make High-Level-Rest-Client tests allow deprecation warning temporarily, during deprecation of request parameter 'master_timeout'

[tlfeng]

Description

Change:

• Make Rest-High-Rest-Level tests allow deprecation warning temporarily, by changing the argument of setStrictDeprecationMode() to false when building RestClient for tests.

Reason:
Many High-Level-Rest-Client tests are broken due to deprecation warning, during the process of deprecating master_timeout parameter of REST APIs.
The simplest solution is:

1. Set "StrictDeprecationMode" to false to make tests allow deprecation warning.
2. Add alternative parameter cluster_manager_timeout for all applicable REST APIs
3. Change to use cluster_manager_timeout instead of master_timeout in High-Level-Rest-Client RequestConverter class
4. Set "StrictDeprecationMode" back to true

Note:

• The javadoc for WarningFailureException provides the way to allow warnings in the RestClient tests.
• The tests will be fixed by PR Replace parameter 'master_timeout' with 'cluster_manager_tiemout' in RequestConverters of High-Level-Rest-Client #2683, after all the other PRs in issue Add a new request parameter "cluster_manager_timeout" in the REST APIs that accept "master_timeout" parameter, and deprecate "master_timeout" #2511 is merged.
• Those tests are causing failures in PR Add request parameter 'cluster_manager_timeout' and deprecate 'master_timeout' - in Cluster APIs #2658 , Add request parameter 'cluster_manager_timeout' and deprecate 'master_timeout' - in Index APIs except index template APIs #2660 , Add request parameter 'cluster_manager_timeout' and deprecate 'master_timeout' - in Index Template APIs #2678 , Add request parameter 'cluster_manager_timeout' and deprecate 'master_timeout' - in Snapshot APIs #2680 and Add request parameter 'cluster_manager_timeout' and deprecate 'master_timeout' - in Ingest APIs and Script APIs #2682

A Sample test failure

> Task :client:rest-high-level:asyncIntegTest

REPRODUCE WITH: ./gradlew ':client:rest-high-level:asyncIntegTest' --tests "org.opensearch.client.ClusterClientIT.testClusterGetSettings" -Dtests.seed=F5E30873F5E8B3F6 -Dtests.security.manager=true -Dtests.jvm.argline="-XX:TieredStopAtLevel=1 -XX:ReservedCodeCacheSize=64m" -Dtests.locale=sr-Latn-BA -Dtests.timezone=America/Santa_Isabel -Druntime.java=17

org.opensearch.client.ClusterClientIT > testClusterGetSettings FAILED
    org.opensearch.client.WarningFailureException: method [GET], host [http://127.0.0.1:38451], URI [/_cluster/settings?master_timeout=30s], status line [HTTP/1.1 200 OK]
    Warnings: [Deprecated parameter [master_timeout] used. To promote inclusive language, please use [cluster_manager_timeout] instead. It will be unsupported in a future major version.]
    {"persistent":{"cluster":{"routing":{"allocation":{"enable":"NONE"}}}},"transient":{"indices":{"recovery":{"max_bytes_per_sec":"10b"}}}}
        at __randomizedtesting.SeedInfo.seed([F5E30873F5E8B3F6:8CF8FB5CACB76F2B]:0)
        at app//org.opensearch.client.RestClient.convertResponse(RestClient.java:346)

Issues Resolved

A part of issue #2511

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.

[opensearch-ci-bot]

✅   Gradle Check success 3bda2c9
Log 4026

Reports 4026

[dreamer-89]

Thank you for raising this PR.

I have one concern that muting test classes has potential of introducing bugs from other code changes exercising these two test classes. How do we have plan to cover this ?

[tlfeng]

Hi @dreamer-89 thank you for reviewing my PR.
My thought is to hold merging this PR until all the other PRs are ready to be merged in #2511. When getting ready, then merging all those PRs together in a short time. The potential of other code changes merged can be reduced by try to shorten the interval of muting the tests.
This is a good point, I should put up some notice saying not to merge this PR in a hurry. 😄

[dreamer-89]

Thanks @tlfeng for clarifying.

Is it possible we can add OpenSearchRestTestCase.expectWarnings in tests in above two tests files wherever we are adding master_timeout. I think this is how we are tackling other deprecated features on client side.

[tlfeng]

Thank you for your good suggestion!
You are right. 👍 Looks like I should turn off the enableWarningsCheck https://github.com/opensearch-project/OpenSearch/blob/1.3.1/test/framework/src/main/java/org/opensearch/test/OpenSearchTestCase.java#L407 for the affected test classes.
There are 24 classes extends this class OpenSearchRestHighLevelClientTestCase (and one class has turned it off https://github.com/opensearch-project/OpenSearch/blob/1.3.1/client/rest-high-level/src/test/java/org/opensearch/client/BulkProcessorIT.java#L89) so the amount of work is reasonable.
I will apply it to the affected test classes.

[tlfeng]

Updated the code. The enableWarningsCheck doesn't work for this case, but instead, I found using setStrictDeprecationMode(false) to build the RestClient can make the test allow deprecation warnings. This will be a safer way 😄.

[opensearch-ci-bot]

✅   Gradle Check success 673e55b
Log 4064

Reports 4064

[nknize]

LGTM...hopefully this won't stay in flight too long.

[tlfeng]

LGTM...hopefully this won't stay in flight too long.

@nknize Thanks for reviewing my PR! 👍 I will try to merging other PRs in #2511 soon and revert this change in this week.