run in pipenv created venv

[ahonnecke]

apologies I'm missing something (I'm quite new to python), but I cannot figure out how to run this in a pipenv environment. I have done pyenv-workon and selected an environment

I set the pythong pytest executable to "pipenv run py.test"
(I also tried pointing it to the venv)

From the command line

web on  pytest-in-ci [⇡$!] via 🐍 system took 4s
➜ pipenv run py.test --color=no 'server/dad/tests/test_graphql_auth.py::TestGraphQL::test_device_params'
======================================================================================== test session starts ========================================================================================
platform darwin -- Python 3.6.5, pytest-3.5.1, py-1.5.3, pluggy-0.6.0
Django settings: dad.settings (from environment variable)
rootdir: /Users/ahonnecke/Code/repos/web/server, inifile: pytest.ini
plugins: env-0.6.2, django-3.1.2
collected 1 item

server/dad/tests/test_graphql_auth.py .                                                                                                                                                       [100%]

===================================================================================== 1 passed in 1.19 seconds ======================================================================================

web on  pytest-in-ci [⇡$] via 🐍 system took 4s

From the popup:

cwd: /Users/ahonnecke/Code/repos/web/
cmd: pipenv run py.test --color=no 'server/dad/tests/test_graphql_auth.py::TestGraphQL::test_device_params'

Courtesy Notice: Pipenv found itself running within a virtual environment, so it will automatically use that environment, instead of creating its own for any project.
====================================== test session starts =======================================
platform darwin -- Python 3.6.5, pytest-3.5.1, py-1.5.3, pluggy-0.6.0
rootdir: /Users/ahonnecke/Code/repos/web/server, inifile: pytest.ini
collecting 0 items / 1 errors                                                                    
============================================= ERRORS =============================================
________________________ ERROR collecting dad/tests/test_graphql_auth.py _________________________
ImportError while importing test module '/Users/ahonnecke/Code/repos/web/server/dad/tests/test_graphql_auth.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
server/dad/tests/test_graphql_auth.py:6: in <module>
    from dad.schema import schema
server/dad/schema.py:4: in <module>
    from django.utils import timezone
E   ModuleNotFoundError: No module named 'django'
==================================== 1 error in 0.06 seconds =====================================
ERROR: not found: /Users/ahonnecke/Code/repos/web/server/dad/tests/test_graphql_auth.py::TestGraphQL::test_device_params
(no name '/Users/ahonnecke/Code/repos/web/server/dad/tests/test_graphql_auth.py::TestGraphQL::test_device_params' in any of [<Module 'dad/tests/test_graphql_auth.py'>])
¯

I have django installed in the pipenv shell, but not locally

[wbolster]

the output when running from emacs seems to indicate you have an active virtualenv. i suspect your environment setup in emacs itself is somehow broken, since python-pytest.el (by design) does not change the environment.

[wbolster]

closing because no further information has been provided

[Frost]

I had a similar issue, which I solved by setting (setq python-pytest-executable "pyenv exec pytest"). I'm not sure if that will help @ahonnecke, but it might help someone else having similar issues at least.

[m9tdev]

I had the same issue, and inspired by @Frost and this answer on StackOverflow, I fixed it with (setq python-pytest-executable "python -m pytest").

I'm using pipenv which is activated using direnv in GNU Emacs 27.2 configured with Doom Emacs.

[wbolster]

@mathieupost

curious: what does ‘pipenv .... activated using direnv’ mean exactly? what does your envrc look like?

[m9tdev]

@wbolster I'm using the direnv module in doom, which is using envrc to integrate direnv.

My .envrc contains only this (source):

layout pipenv

[wbolster]

okay, that looks straightforward 🙃 what does your $PATH look like? and how is pytest installed? because typically pytest should be available in the path after installation, and this emacs package would then simply pick it up.

[m9tdev]

Hahah maybe not the most natural way of using emacs, but it works for me coming from neovim :)

I've installed pytest by adding it to the [dev-packages] list in the Pipfile of my project. So, it only in the $PATH after pipenv is activated. Could this be the problem? Although the direnv module of doom should take care of that before the python and python-pytest package is loaded I think.

[wbolster]

not familiar with doom. (but coming from vim myself originally)

isn't the point of activating that the path is correct? this package simply runs pytest by default, without any path, so it should pick the first match in the path.

can you echo $PATH in your envrc and inspect the direnv buffer in emacs? and also output in shell?

[wbolster]

note that the echo should be the very last line in envrc

[m9tdev]

The bin folder from the virtual environment is added to the beginning of the $PATH in both emacs and the shell, but I think the problem is maybe not with the python-pytest package. Because this is the output when I run pytest in the terminal:

❯ pytest --color=yes 'tests/state/commit_state_test.py::TestCommitState::test_commit_state'
================================================================ test session starts =================================================================
platform darwin -- Python 3.8.9, pytest-7.1.1, pluggy-1.0.0
rootdir: /Users/mathieu/Dev/src/tudelft.nl/stateflow
plugins: anyio-3.5.0, timeout-2.1.0, mock-3.7.0
collected 0 items / 1 error                                                                                                                          

======================================================================= ERRORS =======================================================================
_________________________________________________ ERROR collecting tests/state/commit_state_test.py __________________________________________________
ImportError while importing test module '/Users/mathieu/Dev/src/tudelft.nl/stateflow/tests/state/commit_state_test.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
/Applications/Xcode.app/Contents/Developer/Library/Frameworks/Python3.framework/Versions/3.8/lib/python3.8/importlib/__init__.py:127: in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
tests/state/commit_state_test.py:6: in <module>
    from stateflow.dataflow.address import FunctionAddress, FunctionType
E   ModuleNotFoundError: No module named 'stateflow'
============================================================== short test summary info ===============================================================
ERROR tests/state/commit_state_test.py
================================================================== 1 error in 0.12s ==================================================================
ERROR: not found: /Users/mathieu/Dev/src/tudelft.nl/stateflow/tests/state/commit_state_test.py::TestCommitState::test_commit_state
(no name '/Users/mathieu/Dev/src/tudelft.nl/stateflow/tests/state/commit_state_test.py::TestCommitState::test_commit_state' in any of [<Module tests/state/commit_state_test.py>])

❯ python -m pytest --color=yes 'tests/state/commit_state_test.py::TestCommitState::test_commit_state'
================================================================ test session starts =================================================================
platform darwin -- Python 3.8.9, pytest-7.1.1, pluggy-1.0.0
rootdir: /Users/mathieu/Dev/src/tudelft.nl/stateflow
plugins: anyio-3.5.0, timeout-2.1.0, mock-3.7.0
collected 1 item                                                                                                                                     

tests/state/commit_state_test.py .                                                                                                             [100%]

================================================================= 1 passed in 3.17s ==================================================================

❯ which python
/Users/mathieu/.local/share/virtualenvs/stateflow-kgcsblk2/bin/python

❯ which pytest
/Users/mathieu/.local/share/virtualenvs/stateflow-kgcsblk2/bin/pytest

So for some reason it seems that I always need to prepend the pytest command with python -m . I never noticed this before, since the plugin I used in neovim didn't have this problem for some reason. So, that brings me back to this answer on StackOverflow which states that this is needed to add the project root to the sys.path of python. I think that pyenv exec pytest which @Frost used, also fixes this.

Edit:
After reading some more issues on pytest it seems that setting $PYTHONPATH to the project root works as well.

❯ env PYTHONPATH=$PWD pytest --color=yes 'tests/state/commit_state_test.py::TestCommitState::test_commit_state'
================================================================ test session starts =================================================================
platform darwin -- Python 3.8.9, pytest-7.1.1, pluggy-1.0.0
rootdir: /Users/mathieu/Dev/src/tudelft.nl/stateflow
plugins: anyio-3.5.0, timeout-2.1.0, mock-3.7.0
collected 1 item                                                                                                                                     

tests/state/commit_state_test.py .                                                                                                             [100%]

================================================================= 1 passed in 2.74s ==================================================================

(Can also add export PYTHONPATH=$PWD to .envrc)
Not sure if you want to implement one of these workarounds (I can create a PR if you want), but I thought to just post them if other people run into this as well.