search

petermr / pygetpapers

a Python version of getpapers
Apache License 2.0
78 stars 9 forks source link

JOSS Review: test suite #39

Closed khinsen closed 2 years ago

khinsen commented 2 years ago

The repository contains a test suite (directory tests), but I have not been able to find documentation for running the tests.

It isn't difficult to run the tests:

This is not quite standard, because a test suite should not require prior installation, and the test suite should test the version of the code in the repository, not an earlier version that happens to be installed.

Suggestion:

petermr commented 2 years ago

Thanks very much, This makes sense. I assume the tests have to test the main entry point.

P.

On Mon, Jun 13, 2022 at 1:37 PM Konrad Hinsen @.***> wrote:

The repository contains a test suite (directory tests), but I have not been able to find documentation for running the tests.

It isn't difficult to run the tests:

  • install pygetpapers
  • install pytest
  • clone the pygetpapers repository
  • run "pytest" at the top level of the repository

This is not quite standard, because a test suite should not require prior installation, and the test suite should test the version of the code in the repository, not an earlier version that happens to be installed.

Suggestion:

  • If possible, modify the test suite to work like most users would expect it to work. Then add documentation, which becomes "install pytest, run pytest".
  • If for some reason this cannot be done, document the process and point out clearly that the test suite does not test the current state of the source code repository.

— Reply to this email directly, view it on GitHub https://github.com/petermr/pygetpapers/issues/39, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAFTCS7P6ZGLS7CCXQNLZX3VO4TRHANCNFSM5YUCSEIQ . You are receiving this because you are subscribed to this thread.Message ID: @.***>

-- Peter Murray-Rust Founder ContentMine.org and Reader Emeritus in Molecular Informatics Dept. Of Chemistry, University of Cambridge, CB2 1EW, UK

ayush4921 commented 2 years ago

@khinsen Thanks very much for pointing this out. I have added instructions on how to run tests in the readme as well as make the system such that it runs the test on the version of pygetpapers in the current state of the source code repository.

khinsen commented 2 years ago

Great, thanks! This works fine now.