VorTECHsa / VorTECHsa/python-sdk

Create endpoint testing suite

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

Nobody has claimed this yet.

Dominant language
Python
Stars
25
Forks
12
Avg merge
20h 47m
Merged PRs (30d)
2

Description

Problem
Currently. there's a lot of duplicated code when testing endpoints, and the tests aren't complete. We often test the same things- that the endpoint can be called, that the to_df() method works, the columns are the right datatype etc.

Solution
Test suite than runs generic tests against all the relevant endpoints.

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 locating the existing tests for the SDK's endpoints and the endpoint entry points that expose to_df(). Compare the repeated checks for calling endpoints, converting results, and validating column data types. Done means a generic suite runs these checks across all relevant endpoints and replaces the duplicated test logic.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.