Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Instructions for running tests in README.rst are outdated #1040

Open
jakkdl opened this issue Sep 16, 2023 · 2 comments
Open

Instructions for running tests in README.rst are outdated #1040

jakkdl opened this issue Sep 16, 2023 · 2 comments

Comments

@jakkdl
Copy link
Contributor

jakkdl commented Sep 16, 2023

Describe the bug
Trying to follow the instructions in README.rst for running tests was .. not very helpful, and it ended up being easier to read python-package.yml. So here's some suggestions for fixing stuff that tripped me up

    $ cd aiobotocore
    $ export AWS_ACCESS_KEY_ID=xxx
    $ export AWS_SECRET_ACCESS_KEY=xxx
    $ pip-sync requirements-dev.txt
  1. This seems to assume that you start in a directory above the actual repo root (??), or it wants you to go into the https://github.com/aio-libs/aiobotocore/tree/master/aiobotocore directory (???). I think the first line should be removed entirely.
  2. requirements-dev.txt does not exist, unless you first run pip install pip-tools; pip-compile requirements-dev.in. So a line with this should probably be added.
    $ pytest -v tests
  1. When giving examples I think it's good manner to use the long form of flags to be maximally helpful, so imo this should be pytest --verbose tests to be extra clear that it's not a required flag.
@jakkdl
Copy link
Contributor Author

jakkdl commented Sep 19, 2023

Oh, pytest -v tests doesn't seem standard either. It should probably be make mototest and mention that docker is a thing. And that doesn't seem to require AWS credentials too??

make vtest or other bare pytest invocations gives me several failing tests, even with AWS credentials, but at least one of them is a straight-up incorrect testcase I'll open a separate issue for (#1041).

@thehesiod
Copy link
Collaborator

yea, the docs are all probably outdated. the regular tests don't require aws credentials because they use moto. The non moto tests are those not supported by moto that need to be run with someone's personal AWS creds

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants