Exit exception #3144

Activity

1. pytestbot

   added

   plugin: xdistrelated to the xdist external pluginrelated to the xdist external plugin

   type: bugproblem that needs to be addressedproblem that needs to be addressed

   on Jan 23, 2018
2. nicoddemus commented on Jan 23, 2018

   

   nicoddemus

   on Jan 23, 2018

   Member

   More actions

   Hi @feuillemorte thanks for looking into this.

   This is somewhat more complicated than I expected because we have some moving parts to deal with.

   We need to make _pytest.main.py catch _pytest.outcomes.Exit explicitly and in that case return a new error code: EXIT_PYTEST_EXIT=6, meaning that an explicit call to pytest.exit(msg) has been made.

   Together with the new exit code, I suggest we add a new reason argument to pytest_sessionfinish stating how the session ended. In case of a pytest.exit exception, we would pass its msg argument as reason to pytest_sessionfinish.

   pytest-xdist will then need to understand the new exit status 6 and exit gracefully, using the new reason argument in its implementation of pytest_sessionfinish in pytest-xdist/xdist/remote.py.

   This is my take on this problem. @RonnyPfannschmidt what do you think?

   @feuillemorte I suggest to keep this on hold until we nail down the actual details.
3. nicoddemus

   added

   type: enhancementnew feature or API change, should be merged into features branchnew feature or API change, should be merged into features branch

   and removed

   type: bugproblem that needs to be addressedproblem that needs to be addressed

   on Jan 23, 2018
4. blueyed commented on Nov 21, 2019

   

   blueyed

   on Nov 21, 2019

   Last edited by blueyed

   Contributor

   More actions

   The code is different in this regard already:

   pytest/src/_pytest/main.py

   Lines 202 to 213 in 8bf343d

   	except (KeyboardInterrupt, exit.Exception):
   	excinfo = _pytest._code.ExceptionInfo.from_current()
   	exitstatus = ExitCode.INTERRUPTED
   	if isinstance(excinfo.value, exit.Exception):
   	if excinfo.value.returncode is not None:
   	exitstatus = excinfo.value.returncode
   	if initstate < 2:
   	sys.stderr.write(
   	"{}: {}\n".format(excinfo.typename, excinfo.value.msg)
   	)
   	config.hook.pytest_keyboard_interrupt(excinfo=excinfo)
   	session.exitstatus = exitstatus

   
   (via fc4aa27)

   So this might be improved/changed? (came here via #6257)
5. vkomarov-r7 commented on Jun 8, 2021

   

   vkomarov-r7

   on Jun 8, 2021

   More actions

   Any more progress on this one? Just hit it in a separate instance. We have an autouse=True, scope='session' fixture that sets some stuff up before any test runs (in our case, it runs database migrations before our e2e tests). If the setup of the fixture fails, no tests will pass, so we want to bomb early. I just tried changing the exit from sys.exit() to pytest.exit(), and received a similar message to the above indicating a worker process crash.

   In the meantime, is there a good workaround to the above? Specifically, is there a good way to gracefully fail the entire test suite when using xdist?
6. nicoddemus commented on Jun 10, 2021

   

   nicoddemus

   on Jun 10, 2021

   Member

   More actions

   Hi @vkomarov-r7,

   Any more progress on this one?

   Unfortunately it doesn't seem nobody got the time to sit down and work on this one yet.

   In the meantime, is there a good workaround to the above? Specifically, is there a good way to gracefully fail the entire test suite when using xdist?

   I did spend some time now thinking about a possible workaround, but unfortunately couldn't think of any. 😕

   I think the outline in #3144 (comment) is what would solve this correctly.