Non-fatal errors at exit of tests

[felixonmars]

I'm not sure what caused these, although they are not fatal and not treated as errors to fail the tests:

======================= 928 passed, 2 skipped in 11.14s ========================
Error in atexit._run_exitfuncs:
Traceback (most recent call last):
  File "/build/python-cmd2/src/cmd2-2.0.0/cmd2/cmd2.py", line 4530, in _persist_history
    pickle.dump(self.history, fobj)
_pickle.PicklingError: Can't pickle <class 'cmd2.history.History'>: it's not the same object as cmd2.history.History
Error in atexit._run_exitfuncs:
Traceback (most recent call last):
  File "/build/python-cmd2/src/cmd2-2.0.0/cmd2/cmd2.py", line 4530, in _persist_history
    pickle.dump(self.history, fobj)
_pickle.PicklingError: Can't pickle <class 'cmd2.history.History'>: it's not the same object as cmd2.history.History
Error in atexit._run_exitfuncs:
Traceback (most recent call last):
  File "/build/python-cmd2/src/cmd2-2.0.0/cmd2/cmd2.py", line 4530, in _persist_history
    pickle.dump(self.history, fobj)
_pickle.PicklingError: Can't pickle <class 'cmd2.history.History'>: it's not the same object as cmd2.history.History
Error in atexit._run_exitfuncs:
Traceback (most recent call last):
  File "/build/python-cmd2/src/cmd2-2.0.0/cmd2/cmd2.py", line 4530, in _persist_history
    pickle.dump(self.history, fobj)
_pickle.PicklingError: Can't pickle <class 'cmd2.history.History'>: it's not the same object as cmd2.history.History
Error in atexit._run_exitfuncs:
Traceback (most recent call last):
  File "/build/python-cmd2/src/cmd2-2.0.0/cmd2/cmd2.py", line 4530, in _persist_history
    pickle.dump(self.history, fobj)
_pickle.PicklingError: Can't pickle <class 'cmd2.history.History'>: it's not the same object as cmd2.history.History

[kmvanbrunt]

The cmd2.history classes changed between versions 1.5.0 and 2.0.0. Delete any persistent history files created with 1.5.0 and rerun the tests.

[tleonhardt]

@felixonmars can you please provide some more info to help reproduce?

Things like:

• What OS and version are you running tests on?
• What version of Python is it using?
• What terminal and shell?

[tleonhardt]

@kmvanbrunt We don't have anything in the CHANGELOG about the persistent history file format changing. We should update that ASAP to make it clear this is backwards incompatible.

[kmvanbrunt]

@tleonhardt Done

[felixonmars]

@felixonmars can you please provide some more info to help reproduce?

Things like:

* What OS and version are you running tests on?

* What version of Python is it using?

* What terminal and shell?

Arch Linux x86_64 and Python 3.9.5, bash/konsole. The tests are running in a clean environment, from github tag tarballs, so I think no persistent history files are involved here.

[tleonhardt]

I tested on my Mac in a freshly built pipenv virtualenv and everything passes with latest master using these versions:
platform darwin -- Python 3.9.5, pytest-6.2.2, py-1.10.0, pluggy-0.13.1
plugins: cov-2.11.1, mock-3.5.1

[kmvanbrunt]

Does the Arch Linux environment have an older version of cmd2 installed?

[felixonmars]

No, but I think I find the difference. The errors are present when running the test suite with python setup.py pytest, but not present with a plain pytest.

There are other errors when invoking the test suite with plain pytest without cmd2 installed though, that's why we are using pytest-runner here.

[tleonhardt]

These errors appear to be related to the fact that we also run tests for a couple plugins as part of that extended suite. PR #1114 is up to try to fix this.

[felixonmars]

I have tried to apply the change in #1114, but the errors are still present here.

[felixonmars]

It seems related to capsys failing to empty stderr from pytest if running with pytest-runner.

[tleonhardt]

PR #1115 modifies the manifest to exclude the plugins directory from a cmd2 release tarball as published to PyPI. A cmd2 release should not include any plugins or tests for plugins.

[felixonmars]

I have tried to delete the whole plugins folder, but still getting the same (non-fatal) error. A specific test can trigger it here:

$ python setup.py pytest --addopts tests/test_history.py::test_persist_history_permission_error
...
1 passed in 1.30s
Error in atexit._run_exitfuncs:
Traceback (most recent call last):
  File "/home/felix/projects/arch/community/python-cmd2/trunk/src/cmd2-2.0.0/cmd2/cmd2.py", line 4531, in _persist_history
    pickle.dump(self.history, fobj)
_pickle.PicklingError: Can't pickle <class 'cmd2.history.History'>: it's not the same object as cmd2.history.History
$ pytest tests/test_history.py::test_persist_history_permission_error
...
1 passed in 1.30s
<no error>

[tleonhardt]

@felixonmars Please try deleting the tests_isolated folder and re-running tests