opensearch-project / opensearch-project/flow-framework

[REFACTOR] Move BWC tests to their own gradle build

Open
#555 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Java
Stars
62
Forks
66
Avg merge
3d 20h
Merged PRs (30d)
20

Description

Coming from https://github.com/opensearch-project/flow-framework/pull/551#discussion_r1516911231

Is your feature request related to a problem?

The build.gradle file is getting big and confusing to navigate.

What solution would you like?

Change our BWC setup (derived from AD and ML Commons setup) to the Security repo pattern.

See https://github.com/opensearch-project/security/blob/main/bwc-test/build.gradle

What alternatives have you considered?

Leave it as is, to reduce a lot of the duplication that will be required.

Refactor to a completely different model as some other plugins are doing.

Do you have any additional context?

It took several hours to get this working. I don't expect this will be a trivial exercise to move it.

Other possibilities mentioned in #551 review:

  • try to run on Windows
  • simplify some code in BWC test (and submit similar changes to AD and ML Commons)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the current build.gradle and the BWC setup, then compare it with security/bwc-test/build.gradle referenced in the issue. Check the discussion in pull request #551 for additional context, including the Windows and simplification alternatives. Done means the BWC tests use their own Gradle build without losing the existing setup.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system, testing
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.