Skip to content

Disable ttyrec recording by default in tests to avoid polluting the directory in which tests are run #105

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.

Sign up for GitHub

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

Open
jbcoe wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Disable ttyrec recording by default in tests to avoid polluting the directory in which tests are run #105

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions nle/tests/test_nethack.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,20 @@
]


@pytest.fixture(autouse=True)
def disable_ttyrec_by_default(monkeypatch):
"""Monkeypatches Nethack to disable ttyrec recording unless specified."""
original_init = nethack.Nethack.__init__

def new_init(self, *args, **kwargs):
# If ttyrec is not explicitly passed, disable it.
if "ttyrec" not in kwargs:
kwargs["ttyrec"] = None
original_init(self, *args, **kwargs)

monkeypatch.setattr(nethack.Nethack, "__init__", new_init)


class TestNetHack:
@pytest.fixture
def game(self): # Make sure we close even on test failure.
Expand Down Expand Up @@ -141,9 +155,11 @@ def test_set_seed_after_reset(self, game):


class TestNetHackFurther:
def test_run(self):
def test_run(self, tmpdir):
ttyrec_path = os.path.join(tmpdir, "nle.ttyrec%i.bz2" % nethack.TTYREC_VERSION)
game = nethack.Nethack(
observation_keys=("glyphs", "chars", "colors", "blstats", "program_state")
ttyrec=ttyrec_path,
observation_keys=("glyphs", "chars", "colors", "blstats", "program_state"),
)
_, _, _, _, program_state = game.reset()
actions = [
Expand Down Expand Up @@ -186,9 +202,7 @@ def test_run(self):
assert class_sym.explain == "human or elf"

game.close()
assert os.path.isfile(
os.path.join(os.getcwd(), "nle.ttyrec%i.bz2" % nethack.TTYREC_VERSION)
)
assert os.path.isfile(ttyrec_path)

def test_illegal_filename(self):
with pytest.raises(IOError):
Expand Down
Loading