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

Update individual test commands and add to main README #87

Open
4 tasks done
gaurav opened this issue Jun 5, 2023 · 5 comments
Open
4 tasks done

Update individual test commands and add to main README #87

gaurav opened this issue Jun 5, 2023 · 5 comments
Assignees

Comments

@gaurav
Copy link

gaurav commented Jun 5, 2023

The one-hop README contains instructions on running individual tests at https://github.com/TranslatorSRI/SRI_testing/tree/d034e836bca2c7116778abcb9bd356bb5e36cac6/tests/onehop#running-the-tests.

  • It would be great if those instructions were added to the root README file so that they are easier to find.
  • These instructions refer to e.g. pytest -vv test_onehops.py --kp_id=molepro --ara_id=SKIP, but I've found this command requires two additional instructions to make it work:
    • That test file is actually at tests/onehop/test_onehops.py
    • This attempts to use the system pytest -- to use the Poetry pytest, the command should be run as poetry run pytest -vv test_onehops.py --kp_id=molepro --ara_id=SKIP.
@RichardBruskiewich
Copy link
Collaborator

Hi @gaurav, I've taken a run at resolving your issue above, just now posted into the master branch as commit e9adc4b. Please kindly remove the updated README.md file.

@gaurav
Copy link
Author

gaurav commented Jun 6, 2023

Thanks, Richard! The updated README file looks good. Are you going to update the poetry run instructions in tests/onehop/README.md as well?

@RichardBruskiewich
Copy link
Collaborator

Thanks for the feedback.

The project was originally pip installed. The change to poetry does modify the required commands as you indicated. Sorry about the lag in docs. I'll fix this right away.

Thanks, Richard! The updated README file looks good. Are you going to update the poetry run instructions in tests/onehop/README.md as well?

AH yes.. good point! I'll do that in a few minutes... just putting out another technical fire...

@RichardBruskiewich
Copy link
Collaborator

RichardBruskiewich commented Jun 6, 2023

OK, please see the master again. I've updated the OneHop detailed README now (plus a few refinements elsewhere).

@gaurav please kindly review the final revised documentation. I hope we've gotten there. If you think we have, please close the issue.

@gaurav
Copy link
Author

gaurav commented Jun 7, 2023

This looks great! I have one minor suggestion: after saying "you would type the following from within the tests/onehop project subfolder:", I would change the example code to:

cd tests/onehop
pytest test_onehops.py

Just to make sure nobody misses that. Otherwise, the test commands I tried all worked for me! Feel free to close this issue once you've decided whether or not to incorporate my suggestion above.

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