Start to add tests for wizard

dwhswenson · Jul 27, 2021 · Feb 18, 2021 · Feb 19, 2021 · Feb 27, 2021 · Mar 4, 2021
commit 0b60338d67114507c54f0dd0596f7dcd507d059b
diff --git a/paths_cli/tests/wizard/mock_wizard.py b/paths_cli/tests/wizard/mock_wizard.py
@@ -0,0 +1,12 @@
+from paths_cli.wizard.wizard import Wizard
+import mock
+
+def make_mock_wizard(inputs):
+    wizard = Wizard([])
+    wizard.console.input = mock.Mock(return_value=inputs)
+    return wizard
+
+def make_mock_retry_wizard(inputs):
+    wizard = Wizard([])
+    wizard.console.input = mock.Mock(side_effect=inputs)
+    return wizard
diff --git a/paths_cli/tests/wizard/test_core.py b/paths_cli/tests/wizard/test_core.py
@@ -0,0 +1,51 @@
+import pytest
+import mock
+
+from openpathsampling.experimental.storage.collective_variables import \
+        CoordinateFunctionCV
+
+from paths_cli.wizard.core import *
+
+from paths_cli.tests.wizard.mock_wizard import (
+    make_mock_wizard, make_mock_retry_wizard
+)
+
+def test_name():
+    wizard = make_mock_wizard('foo')
+    cv = CoordinateFunctionCV(lambda s: s.xyz[0][0])
+    assert not cv.is_named
+    result = name(wizard, cv, obj_type="CV", store_name="cvs")
+    assert result is cv
+    assert result.is_named
+    assert result.name == 'foo'
+
+def test_name_exists():
+    wizard = make_mock_retry_wizard(['foo', 'bar'])
+    wizard.cvs['foo'] = 'placeholder'
+    cv = CoordinateFunctionCV(lambda s: s.xyz[0][0])
+    assert not cv.is_named
+    result = name(wizard, cv, obj_type="CV", store_name="cvs")
+    assert result is cv
+    assert result.is_named
+    assert result.name == 'bar'
+    assert wizard.console.input.call_count == 2
+
+@pytest.mark.parametrize('req,expected', [
+    (('foo', 2, 2), '2'), (('foo', 2, float('inf')), 'at least 2'),
+    (('foo', 0, 2), 'at most 2'),
+    (('foo', 1, 3), 'at least 1 and at most 3')
+])
+def test_interpret_req(req, expected):
+    assert interpret_req(req) == expected
+
+@pytest.mark.parametrize('length,expected', [
+    (0, 'foo'), (1, 'baz'), (2, 'quux'),
+])
+def test_get_missing_object(length, expected):
+    dct = dict([('bar', 'baz'), ('qux', 'quux')][:length])
+    fallback = lambda x: 'foo'
+    wizard = make_mock_wizard('2')
+    result = get_missing_object(wizard, dct, display_name='string',
+                                fallback_func=fallback)
+    assert result == expected
+    pass
diff --git a/paths_cli/tests/wizard/test_tools.py b/paths_cli/tests/wizard/test_tools.py
@@ -0,0 +1,18 @@
+import pytest
+import mock
+
+from paths_cli.wizard.tools import *
+
+@pytest.mark.parametrize('word,expected', [
+    ('foo', 'a'), ('egg', 'an')
+])
+def test_a_an(word, expected):
+    assert a_an(word) == expected
+
+
+@pytest.mark.parametrize('user_inp,expected', [
+    ('y', True), ('n', False),
+    # ('Y', True), ('N', False), ('yes', True), ('no', False)
+])
+def test_yes_no(user_inp, expected):
+    assert yes_no(user_inp) == expected
diff --git a/paths_cli/wizard/__init__.py b/paths_cli/wizard/__init__.py
diff --git a/paths_cli/wizard/core.py b/paths_cli/wizard/core.py
@@ -1,6 +1,6 @@
 import random
-from joke import name_joke
-from tools import a_an
+from paths_cli.wizard.joke import name_joke
+from paths_cli.wizard.tools import a_an
 
 def name(wizard, obj, obj_type, store_name, default=None):
     wizard.say(f"Now let's name your {obj_type}.")
@@ -9,7 +9,8 @@ def name(wizard, obj, obj_type, store_name, default=None):
         name = wizard.ask("What do you want to call it?")
         if name in getattr(wizard, store_name):
             wizard.bad_input(f"Sorry, you already have {a_an(obj_type)} "
-                             f"named {name}. Please try another name.")
+                             f"{obj_type} named {name}. Please try another "
+                             "name.")
             name = None
 
     obj = obj.named(name)
@@ -19,7 +20,7 @@ def name(wizard, obj, obj_type, store_name, default=None):
     return obj
 
 def abort_retry_quit(wizard, obj_type):
-    a_an = 'an' if obj_type[0] in 'aeiou' else 'a'
+    a_an = a_an(obj_type)
     retry = wizard.ask(f"Do you want to try again to make {a_an} "
                        f"{obj_type}, do you want to continue without, or "
                        f"do you want to quit?",
@@ -60,6 +61,6 @@ def get_missing_object(wizard, obj_dict, display_name, fallback_func):
         objs = list(obj_dict.keys())
         sel = wizard.ask_enumerate(f"Which {display_name} would you like "
                                    "to use?", options=objs)
-        obj = objs[sel]
+        obj = obj_dict[sel]
     return obj
 
diff --git a/paths_cli/wizard/engines.py b/paths_cli/wizard/engines.py
@@ -1,5 +1,7 @@
 import paths_cli.wizard.openmm as openmm
-from load_from_ops import load_from_ops, LABEL as load_label
+from paths_cli.wizard.load_from_ops import (
+    load_from_ops, LABEL as load_label
+)
 from functools import partial
 
 SUPPORTED_ENGINES = {}

diff --git a/paths_cli/wizard/openmm.py b/paths_cli/wizard/openmm.py
@@ -1,5 +1,4 @@
 from paths_cli.wizard.errors import FILE_LOADING_ERROR_MSG, not_installed
-from paths_cli.wizard.tools import get_int_value
 try:
     from simtk import openmm as mm
     import mdtraj as md
@@ -69,10 +68,12 @@ def openmm(wizard):
 
     n_frames_max = n_steps_per_frame = None
 
-    n_steps_per_frame = get_int_value(wizard,
-                                      "How many MD steps per saved frame?")
-    n_frames_max = get_int_value(wizard, ("How many frames before aborting "
-                                          "a trajectory?"))
+    n_steps_per_frame = wizard.ask_custom_eval(
+        "How many MD steps per saved frame?", type_=int
+    )
+    n_frames_max = wizard.ask_custom_eval(
+        "How many frames before aborting a trajectory?", type_=int
+    )
     # TODO: assemble the OpenMM simulation
     engine = paths.engines.openmm.Engine(
         topology=topology,

diff --git a/paths_cli/wizard/tools.py b/paths_cli/wizard/tools.py
@@ -1,17 +1,5 @@
-
 def a_an(obj):
-    return "an" if obj[0] in "aeiou" else "a"
+    return "an" if obj[0].lower() in "aeiou" else "a"
 
 def yes_no(char):
     return {'y': True, 'n': False}[char]
-
-def get_int_value(wizard, question, default=None, helper=None):
-    as_int = None
-    while as_int is None:
-        evald = wizard.ask_custom_eval(question, default=default,
-                                       helper=helper)
-        try:
-            as_int = int(evald)
-        except Exception as e:
-            wizard.exception("Sorry, I didn't understand that.", e)
-    return as_int
diff --git a/paths_cli/wizard/wizard.py b/paths_cli/wizard/wizard.py
@@ -16,7 +16,7 @@
 
 import shutil
 
-class Console:
+class Console:  # no-cov
     # TODO: add logging so we can output the session
     def print(self, *content):
         print(*content)
@@ -45,15 +45,15 @@ def __init__(self, steps):
         self.default = {}
         self._patched = False  # if we've done the monkey-patching
 
-    def _patch(self):
+    def _patch(self):  # no-cov
         import openpathsampling as paths
         from openpathsampling.experimental.storage import monkey_patch_all
         if not self._patched:
             paths = monkey_patch_all(paths)
             paths.InterfaceSet.simstore = True
             self._patched = True
 
-    def debug(content):
+    def debug(content):  # no-cov
         self.console.print(content)
 
     def _speak(self, content, preface):