saltstack / saltstack/salt

[TECH DEBT] sdb functional api tests

Open
#61,260 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
15.7k
Forks
5.6k
Avg merge
2d 44m
Merged PRs (30d)
80

Description

Similar to #61081, the SDB API also (apparently) lacks functional tests to
ensure that each of the sdb backends adheres to the sdb API. A related issue
#60273 mentions that the sdb redis_cache will probably need to be updated in
order to fix a bytes vs text bug. The functional tests should quickly expose
such an issue.

These are the existing sdb modules that will need to be covered:

  • - cache.py
  • - confidant.py
  • - consul.py
  • - couchdb.py
  • - env.py
  • - etcd_db.py
  • - keyring_db.py
  • - memcached.py
  • - redis_sdb.py
  • - rest.py
  • - sqlite3.py
  • - tism.py
  • - vault.py
  • - yaml.py

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 comparing the functional tests from similar issue #61081 with the completed etcd_db.py coverage, then review the unchecked SDB modules listed in this issue. Add functional coverage for each remaining backend and use the tests to expose API inconsistencies such as the noted redis_cache bytes-versus-text problem.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.