Add testing doc (#618)

* Make some tweaks to tox and support 3.10

* Pass usedevelop to tox

* Add dd_tags mark

* Add testing doc

* Tweaks

* Add 3.10 to CI

Author: therve

.github/workflows/test.yml

@@ -30,14 +30,12 @@ jobs:
   test:
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8]
+        python-version: ["3.6", "3.10"]
         platform: [ubuntu-latest, macos-latest] # windows-latest
         # test only latest version on macos and windows
         exclude:
           - platform: macos-latest
-            python-version: 3.6
-          - platform: macos-latest
-            python-version: 3.7
+            python-version: "3.6"
           # TODO enable once dd-trace-py is updated
           # - platform: windows-latest
           #  python-version: 3.6

TESTING.md

@@ -0,0 +1,36 @@
+Running tests
+=============
+
+The Datadog Python API client is mostly using BDD tests to verify its behaviro.
+They are using recodings to store HTTP interactions, allowing to run the tests without
+talking to the API. We also store the test time to be able to freeze.
+
+You can control the behavior with the `RECORD` environment variable:
+ - `RECORD=false`, the default value, means replaying HTTP requests from recordings.
+ - `RECORD=true` creates or updates recordings. This will need valid credentials in `DD_TEST_CLIENT_API_KEY`
+    and `DD_TEST_CLIENT_APP_KEY`.
+ - `RECORD=none` ignores recordings. This will also runs tests that we call `integration-only`, i.e.
+    tests that we don't record for security reasons. It also needs valid credentials.
+
+Recording and freeze files are stored in the directory `tests/$VERSION/cassettes/test_scenarios/`
+
+To run the tests, it's generally better to use a virtual environment. [tox](https://tox.wiki/) makes it easier to manage them.
+For example to run the tests for Python 3.9:
+
+```shell
+tox -epy39
+```
+
+To pass extra arguments to run the tests, you need to close `tox` arguments with `--`.
+You can get more verbose information with the `-v` flag to `pytest`, filter the tests using the `-k` or
+specifying the test full path. For example:
+
+```shell
+tox -epy39  -- -k test_get_a_list_of_all_incident_teams_returns_ok_response -vvv
+```
+
+`-k` takes a regular expression, so you don't have to specify the whole exact
+string. See https://docs.pytest.org/ for more information.
+
+The first time you run a test that needs recordings, it will fail with:
+`Time file '$PATH/tests/$VERSION/cassettes/test_scenarios/$TEST_NAME.frozen' not found: create one setting 'RECORD=true' or ignore it using 'RECORD=none'`.

pytest.ini

@@ -0,0 +1,3 @@
+[pytest]
+markers =
+    dd_tags

setup.cfg

@@ -26,6 +26,8 @@ classifiers=
     Programming Language :: Python :: 3.6
     Programming Language :: Python :: 3.7
     Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
+    Programming Language :: Python :: 3.10
 project_urls =
     Bug Tracker = https://github.com/DataDog/datadog-api-client-python/issues
     Documentation = https://docs.datadoghq.com/api/

tox.ini

@@ -1,10 +1,12 @@
 [tox]
-envlist = py36, py37, py38, docs
+envlist = py36, py37, py38, py39, py310, docs
 
 [testenv]
-extras= tests
-commands=pytest
-
+extras = tests
+commands = pytest {posargs}
+usedevelop = true
+skip_missing_interpreters = true
+passenv = *
 
 [testenv:docs]
 skip_install = true
@@ -17,4 +19,4 @@ setenv =
     ; See https://reproducible-builds.org/specs/source-date-epoch/
     SOURCE_DATE_EPOCH=1580601600
 commands =
-    python -m mkdocs {posargs}
+    python -m mkdocs {posargs}