Add test case for OptionalDependenciesPlugin (com.netflix.nebula:gradle-extra-configurations-plugin plugin migration)

[reta]

Description

Add test case for OptionalDependenciesPlugin (com.netflix.nebula:gradle-extra-configurations-plugin plugin migration)

Related Issues

N/A

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
• Commit changes are listed out in CHANGELOG.md file (See: Changelog)

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.

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: UNSTABLE ❕
• TEST FAILURES:

      1 org.opensearch.search.backpressure.SearchBackpressureIT.testSearchTaskCancellationWithHighCpu
      1 org.opensearch.action.admin.cluster.node.tasks.ResourceAwareTasksTests.testTaskResourceTrackingDuringTaskCancellation

• URL: https://build.ci.opensearch.org/job/gradle-check/17255/
• CommitID: f41c6e0
  Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

[codecov]

Codecov Report

Merging #7995 (64b9344) into main (28d5948) will decrease coverage by 0.52%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##               main    #7995      +/-   ##
============================================
- Coverage     71.44%   70.92%   -0.52%     
+ Complexity    56913    56562     -351     
============================================
  Files          4715     4715              
  Lines        267246   267246              
  Branches      39186    39186              
============================================
- Hits         190930   189549    -1381     
- Misses        60492    61678    +1186     
- Partials      15824    16019     +195     

see 430 files with indirect coverage changes

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: UNSTABLE ❕
• TEST FAILURES:

      1 org.opensearch.remotestore.SegmentReplicationUsingRemoteStoreIT.testDropPrimaryDuringReplication
      1 org.opensearch.remotestore.RemoteStoreRefreshListenerIT.testRemoteRefreshRetryOnFailure

• URL: https://build.ci.opensearch.org/job/gradle-check/17256/
• CommitID: 64b9344
  Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

[kotwanikunal]

Thanks @reta!

[gaiksaya]

Hi @reta ,

Just curious, Any particular reason why we added the test cases for
buildSrc/src/main/groovy/org/opensearch/gradle/plugin/OptionalDependenciesPlugin.groovy under
buildSrc/src/test/java/org/opensearch/gradle/plugin/OptionalDependenciesPluginTests.java?
Gradle has some examples here https://docs.gradle.org/current/userguide/test_kit.html that uses spockframework (bot fancy and easy to use). Wondering if can explore that in future?

Also for my understanding does the codecoverage tool recognize what we are testing? (from this comment looks like it showed codecov as decreased)
Thanks!

[reta]

Thanks @gaiksaya !

Just curious, Any particular reason why we added the test cases for
buildSrc/src/main/groovy/org/opensearch/gradle/plugin/OptionalDependenciesPlugin.groovy under
buildSrc/src/test/java/org/opensearch/gradle/plugin/OptionalDependenciesPluginTests.java?

Yes, so the plugin is written in Groovy (OptionalDependenciesPlugin.groovy) so it is under src/main/groovy by convention, the OptionalDependenciesPluginTests is written in Java, so it is under src/test/java by convention, does it help or you were asking about different thing?

Gradle has some examples here https://docs.gradle.org/current/userguide/test_kit.html that uses spockframework (bot fancy and easy to use). Wondering if can explore that in future?

I think in general there is no constraints on test framework to use, as far as it brings tangible benefits. Our tests for this module are currently written in Java, as all other tests for OpenSearch core.

Also for my understanding does the codecoverage tool recognize what we are testing? (from #7995 (comment) comment looks like it showed codecov as decreased)

That is a good question, it believe it does not recognize what we are testing in this particular case.

[gaiksaya]

Thanks!

does it help or you were asking about different thing?

It helps. Was just curious why we didn't add groovy tests under buildSrc/src/test/groovy for those components. Looks like anything works and there are no constraints?

[reta]

It helps. Was just curious why we didn't add groovy tests under buildSrc/src/test/groovy for those components. Looks like anything works and there are no constraints?

What are the benefits? And what is the cost to maintain the new framework? Who in the community is familiar with it? Groovy is on severe decline, the only reason I've added the Groovy based plugin is to preserve the original license and source code.

[gaiksaya]

Looks like the above framework is already being used in OpenSearch https://github.com/opensearch-project/OpenSearch/blob/main/buildSrc/src/integTest/groovy/org/opensearch/gradle/fixtures/AbstractGradleFuncTest.groovy
https://github.com/search?q=repo%3Aopensearch-project%2FOpenSearch%20AbstractGradleFuncTest&type=code

[reta]

Indeed, thanks! Wanna give it a try by refactoring the OptionalDependenciesPluginTests to use Spock? No objections from my side, if you are curious to do that :)

[prudhvigodithi]

Here is the gradle functional unit tests example from opensearch.pluginzip plugin.

Also for CodeCov coverage the buildSrc folder is included, assume its coming from code-coverage.gradle, @reta am I right here?
@bbarani @peterzhuamazon

[gaiksaya]

Indeed, thanks! Wanna give it a try by refactoring the OptionalDependenciesPluginTests to use Spock? No objections from my side, if you are curious to do that :)

Will add to my queue for sure. Thanks!

[reta]

Also for CodeCov coverage the buildSrc folder is included, assume its coming from code-coverage.gradle, @reta am I right here?

The pluginzip/Publish is Java, not Groovy, right?