Can we test the REST samples somehow?

Open
#3 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start by reviewing how the REST samples are organized and the proposed tasks.py approach for running them against a configurable server. Compare the manual runner, CI mocks, and external endpoint-mocking ideas, then define a reproducible test path that detects breakage in both the samples and the libraries.

Written by the indexing model from the issue text.

Description

enhancement

When these were included in the java build system they got run as part of the test suite.

Now that they're in github we need some way to make sure samples don't get broken by changes to the libraries, or changes to the samples themselves.

Ideas:

  1. Manually -- there's some sort of script that runs these all against a configurable server
    • I've been doing this sort of, just without a script, I might be able to whip up a tasks.py or similar
  2. CI system -- build our own mocks of the endpoints somehow
  3. Is there an external service that we can use to mock endpoints?
Dominant language
Python
Stars
436
Forks
280
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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.

More from tableau/rest-api-samples

All issues in tableau/rest-api-samples

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.