update instructions for running tests (#1045)

aio-libs · Oct 20, 2023 · 9d92ef2 · 9d92ef2
1 parent b06b958
commit 9d92ef2
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 3 deletions.
diff --git 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
@@ -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 <https://github.com/getmoto/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