diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 861eaedb..9e622441 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -31,7 +31,25 @@ Install pre-commit hooks:: $ pre-commit install -Congratulations, you are ready to run the test suite:: +Congratulations, you are ready to run the test suite. + +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 your amazon key and secret accessible via environment variables:: + + $ export AWS_ACCESS_KEY_ID=xxx + $ export AWS_SECRET_ACCESS_KEY=xxx + $ export AWS_DEFAULT_REGION=xxx # e.g. us-west-2 + +Execute full tests suite:: + + $ make test + +Execute full tests suite with coverage:: $ make cov diff --git a/README.rst b/README.rst index 0b9426a9..50ec757c 100644 --- a/README.rst +++ b/README.rst @@ -163,39 +163,6 @@ stick ``await`` in front of methods to make them async, e.g. ``await client.list If a service is not listed here and you could do with some tests or examples feel free to raise an issue. -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: - -:: - - $ pip install pip-tools - $ pip-compile --all-extras pyproject.toml - $ pip-sync - $ pip install -e ".[awscli,boto3]" - $ export AWS_ACCESS_KEY_ID=xxx - $ export AWS_SECRET_ACCESS_KEY=xxx - $ export AWS_DEFAULT_REGION=xxx # e.g. us-west-2 - -Execute tests suite: - -:: - - $ make test - - Enable type checking and code completion ----------------------------------------