opensearch-project / opensearch-project/opensearch-ruby

Clean up the test framework

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

Nobody has claimed this yet.

Dominant language
Ruby
Stars
114
Forks
60
PR merge metrics
No merged PRs in 30d

Description

This repo has received 2 major overhauls in the past 2 years (Merging gems, and refactoring API code along with a new API codegen) but the test framework has not been cleaned up to removed artifacts that are not longer relevant. A few things that we can do right now:

  • remove unused gems in gemfile
  • a better strategy to test different combinations of faraday and its adapters.
  • remove tests that are no longer relevant (and adding new ones if necessary)

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 auditing the gemfile and the existing test framework for artifacts left by the API and codegen overhauls. Review how Faraday and its adapters are currently tested, then identify tests that no longer reflect the client. Done means unused gems and irrelevant tests are removed, and coverage for the supported Faraday/adapter combinations is clearly defined.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
testing-qa
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.