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

Improve documentation about how to run tests #207

Open
xphade opened this issue May 13, 2023 · 3 comments
Open

Improve documentation about how to run tests #207

xphade opened this issue May 13, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation tests Tests

Comments

@xphade
Copy link
Collaborator

xphade commented May 13, 2023

Right now there is some important information missing about how to run and pass the tests. Some examples include:

  • TOR=FALSE is documented, but you also have to remove SOCKS_HOST/PORT from the env file
  • tests/test_cli.py::test_nostr_send fails for me if a nostr key is set (not sure if bug or expected)
  • Do any directories have to be cleaned? At least for me the tests are quite flaky, and I'm not sure if that's due to any data that is still in ~/.cashu or ./data

Some of this can be improved by documentation. But maybe we can also set up the tests slightly differently, so that they are not that dependent on the .env file.

@AngusP
Copy link
Collaborator

AngusP commented May 17, 2023

Do any directories have to be cleaned?

I think ~/.cashu/test_wallet does, or at least sometimes 😆

@callebtc
Copy link
Collaborator

Thank you very much for bringing up this point. I also think that LIGHTNING=False needs to be set (on my machine here). I would much rather like to use FakeWallet and get rid of Lightning=False in the entire code base altogether, tbh.

@xphade
Copy link
Collaborator Author

xphade commented May 23, 2023

Thank you very much for bringing up this point. I also think that LIGHTNING=False needs to be set (on my machine here). I would much rather like to use FakeWallet and get rid of Lightning=False in the entire code base altogether, tbh.

Agreed, that would be awesome as well.

When we're working on the tests anyway, we can also incorporate this comment that didn't make it into the merged change.

@callebtc callebtc added tests Tests documentation Improvements or additions to documentation labels May 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation tests Tests
Projects
None yet
Development

No branches or pull requests

3 participants