opensearch-project / opensearch-project/common-utils
Add ODFERestTestCase to common utils
Nobody has claimed this yet.
- Dominant language
- Kotlin
- Stars
- 30
- Forks
- 117
- Avg merge
- 16h 37m
- Merged PRs (30d)
- 16
Description
Is your feature request related to a problem? Please describe.
It appears that we have several instances of ODFERestTestCase implementations across plugin repos:
- https://github.com/opensearch-project/k-NN/blob/main/src/test/java/org/opensearch/knn/ODFERestTestCase.java
- https://github.com/opensearch-project/anomaly-detection/blob/main/src/test/java/org/opensearch/ad/ODFERestTestCase.java
- https://github.com/opensearch-project/alerting/blob/11aafbe26189a474349d24c161ca956c044c7b63/alerting/src/test/kotlin/org/opensearch/alerting/ODFERestTestCase.kt
This base test class is meant to ensure ODFE compatibility. Each implementations seems slightly different. We had a test failure related to this case here: https://github.com/opensearch-project/k-NN/issues/214. Given all of this, it appears that this class is a good candidate to move to common-utils.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the ODFERestTestCase implementations in k-NN/src/test/java/org/opensearch/knn/ODFERestTestCase.java, anomaly-detection/src/test/java/org/opensearch/ad/ODFERestTestCase.java, and alerting/src/test/kotlin/org/opensearch/alerting/ODFERestTestCase.kt. Start by identifying their shared behavior and differences, then verify the common-utils class supports ODFE compatibility without losing required behavior from the plugin implementations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, kotlin
- Domain
- testing
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100