From 9d92ef2fe3182239ed8c5a6145bae064e9ccb633 Mon Sep 17 00:00:00 2001 From: John Litborn <11260241+jakkdl@users.noreply.github.com> Date: Fri, 20 Oct 2023 18:23:30 +0200 Subject: [PATCH] update instructions for running tests (#1045) --- .gitignore | 3 +++ README.rst | 17 ++++++++++++++--- 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index fe206141..189d3141 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ +# generated by users and intentionally not pushed to the repo +requirements-dev.txt + # Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] diff --git a/README.rst b/README.rst index 223375dc..def757ba 100644 --- a/README.rst +++ b/README.rst @@ -151,21 +151,32 @@ If a service is not listed here and you could do with some tests or examples fee Run Tests --------- +There are two set of tests, those that can be mocked through `moto `_ running in docker, and those that require running against a personal amazon key. The CI only runs the moto tests. + +To run the moto tests: + +:: + + $ make mototest + +To run the non-moto tests: + Make sure you have development requirements installed and your amazon key and secret accessible via environment variables: :: - $ cd aiobotocore + $ pip install pip-tools + $ pip-compile requirements-dev.txt + $ pip-sync requirements-dev.txt $ export AWS_ACCESS_KEY_ID=xxx $ export AWS_SECRET_ACCESS_KEY=xxx - $ pip-sync requirements-dev.txt Execute tests suite: :: - $ pytest -v tests + $ make test