opensearch-project / opensearch-project/flow-framework

[CI] Improve BWC Tests and coverage

Open
#710 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Is your feature request related to a problem?

Our BWC tests are limited and essentially were the minimum required for the feature they were added with. We need to increase coverage and capability of the tests.

What solution would you like?
  • Currently the old version is fixed to 2.12 (for the single feature we test). We need to test a range of previous versions.
  • Currently rolling upgrades are disabled on major version changes. We need to test "latest 2.x" vs. 3.x rolling upgrade.
  • Currently tests run without security plugin. This makes it impossible to use that plugin API to register a User to accurately test BWC on indices related to the User field (I'm looking at you, #705). Tests should run with and without security.
What alternatives have you considered?

Manually performing one-time BWC checks when introducing a new feature and hoping you covered all the situations (which you probably didn't.)

Do you have any additional context?

It may be useful to work on #555 at the same time as this issue.

See this commit for a failed attempt to fix some of the above issues existing tests.

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 with the existing BWC tests and review the failed attempt in commit d071e3162e181703d50db9c5742610a11c18fa0e, then inspect the related work in #555. Done means covering a range of previous versions, testing latest 2.x to 3.x rolling upgrades, and running coverage with and without the security plugin.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
ci-cd, testing-qa
Issue type
Feature
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.