-
Notifications
You must be signed in to change notification settings - Fork 122
Added unit tests for persistent history file #468
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1825,3 +1825,74 @@ def test_onecmd_raw_str_quit(base_app): | |
assert stop | ||
assert out == '' | ||
|
||
|
||
@pytest.fixture(scope="session") | ||
def hist_file(): | ||
fd, filename = tempfile.mkstemp(prefix='hist_file', suffix='.txt') | ||
os.close(fd) | ||
yield filename | ||
# teardown code | ||
try: | ||
os.remove(filename) | ||
except FileNotFoundError: | ||
pass | ||
|
||
def test_existing_history_file(hist_file, capsys): | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thank you for adding some unit tests of this feature! |
||
import atexit | ||
import readline | ||
|
||
# Create the history file before making cmd2 app | ||
with open(hist_file, 'w'): | ||
pass | ||
|
||
# Create a new cmd2 app | ||
app = cmd2.Cmd(persistent_history_file=hist_file) | ||
out, err = capsys.readouterr() | ||
|
||
# Make sure there were no errors | ||
assert err == '' | ||
|
||
# Unregister the call to write_history_file that cmd2 did | ||
atexit.unregister(readline.write_history_file) | ||
|
||
# Remove created history file | ||
os.remove(hist_file) | ||
|
||
|
||
def test_new_history_file(hist_file, capsys): | ||
import atexit | ||
import readline | ||
|
||
# Remove any existing history file | ||
try: | ||
os.remove(hist_file) | ||
except OSError: | ||
pass | ||
|
||
# Create a new cmd2 app | ||
app = cmd2.Cmd(persistent_history_file=hist_file) | ||
out, err = capsys.readouterr() | ||
|
||
# Make sure there were no errors | ||
assert err == '' | ||
|
||
# Unregister the call to write_history_file that cmd2 did | ||
atexit.unregister(readline.write_history_file) | ||
|
||
# Remove created history file | ||
os.remove(hist_file) | ||
|
||
def test_bad_history_file_path(capsys, request): | ||
# Use a directory path as the history file | ||
test_dir = os.path.dirname(request.module.__file__) | ||
|
||
# Create a new cmd2 app | ||
app = cmd2.Cmd(persistent_history_file=test_dir) | ||
out, err = capsys.readouterr() | ||
|
||
if sys.platform == 'win32': | ||
# pyreadline masks the read exception. Therefore the bad path error occurs when trying to write the file. | ||
assert 'readline cannot write' in err | ||
else: | ||
# GNU readline raises an exception upon trying to read the directory as a file | ||
assert 'readline cannot read' in err |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added this fixture to help ensure that the history file always gets deleted no matter what