tests for append

Author: dwhswenson

paths_cli/cli.py

@@ -118,14 +118,14 @@ def format_commands(self, ctx, formatter):
     openpathsampling strip-snapshots --help
 """
 
+OPS_CLI = OpenPathSamplingCLI(
+    name="openpathsampling",
+    help=_MAIN_HELP,
+    context_settings=CONTEXT_SETTINGS
+)
 
 def main():  # no-cov
-    cli = OpenPathSamplingCLI(
-        name="openpathsampling",
-        help=_MAIN_HELP,
-        context_settings=CONTEXT_SETTINGS
-    )
-    cli()
+    OPS_CLI()
 
 
 if __name__ == '__main__':  # no-cov

paths_cli/commands/append.py

@@ -20,7 +20,7 @@
               help=("save object to a tag; requires that only one "
                     + "object be specfied. Can also be used to rename "
                     + "tagged objects. To append a tagged object without "
-                    + "a tag, use --add-tag \"\""))
+                    + "a tag, use --save-tag \"\""))
 def append(input_file, append_file, engine, cv, volume, network, scheme,
            tag, save_tag):
     """Append objects from INPUT_FILE to another file.
@@ -42,17 +42,14 @@ def append(input_file, append_file, engine, cv, volume, network, scheme,
     for obj in to_save:
         output_storage.save(obj)
 
-    if tag and save_tag is None:
-        save_tag = tag
+    if tag and len(tag) == 1 and save_tag is None:
+        save_tag = tag[0]
 
     if save_tag:
         output_storage.tags[save_tag] = to_save[0]
 
     # TO TEST
-    # 1. append a tag in a new file: its tag comes with it
-    # 2. rename a tagged object
     # 3. "untag" an object by not associating a tag in the new storage
-    # 4. tag a previously untagged object
 
     output_storage.close()
 

paths_cli/tests/commands/test_append.py

@@ -0,0 +1,99 @@
+import os
+
+import pytest
+from click.testing import CliRunner
+
+from paths_cli.commands.append import *
+
+import openpathsampling as paths
+
+def make_input_file(tps_network_and_traj):
+    input_file = paths.Storage("setup.py", mode='w')
+    for obj in tps_network_and_traj:
+        input_file.save(obj)
+
+    input_file.tags['template'] = input_file.snapshots[0]
+    input_file.close()
+    return "setup.py"
+
+def test_append(tps_network_and_traj):
+    runner = CliRunner()
+    with runner.isolated_filesystem():
+        in_file = make_input_file(tps_network_and_traj)
+        result = runner.invoke(append, [in_file, '-a', 'output.nc',
+                                        '--volume', 'A', '--volume', 'B'])
+        assert result.exit_code == 0
+        assert result.exception is None
+        storage = paths.Storage('output.nc', mode='r')
+        assert len(storage.volumes) == 2
+        assert len(storage.snapshots) == 0
+        storage.volumes['A']  # smoke tests that we can load
+        storage.volumes['B']
+        storage.close()
+
+        result = runner.invoke(append, [in_file, '-a', 'output.nc',
+                                        '--tag', 'template'])
+        storage = paths.Storage('output.nc', mode='r')
+        assert len(storage.volumes) == 2
+        assert len(storage.snapshots) == 2  # one snapshot + reverse
+
+@pytest.mark.parametrize('n_objects', [0, 2])
+def test_append_tag_error(tps_network_and_traj, n_objects):
+    objs = {2: ['--volume', "A", '--volume', "B"], 0: []}[n_objects]
+    runner = CliRunner()
+    with runner.isolated_filesystem():
+        in_file = make_input_file(tps_network_and_traj)
+        result = runner.invoke(append,
+                               [in_file, '-a', "output.nc"] + objs
+                               + ["--save-tag", "foo"])
+        assert isinstance(result.exception, RuntimeError)
+        assert "Can't identify the object to tag" in str(result.exception)
+
+def test_append_tag(tps_network_and_traj):
+    runner = CliRunner()
+    with runner.isolated_filesystem():
+        in_file = make_input_file(tps_network_and_traj)
+        result = runner.invoke(append,
+                               [in_file, '-a', "output.nc",
+                                '--tag', 'template', '--save-tag', 'foo'])
+        assert result.exit_code == 0
+        assert result.exception is None
+
+        storage = paths.Storage("output.nc", mode='r')
+        assert len(storage.snapshots) == 2
+        assert len(storage.tags) == 1
+        assert storage.tags['foo'] is not None
+        storage.close()
+
+def test_append_same_tag(tps_network_and_traj):
+    runner = CliRunner()
+    with runner.isolated_filesystem():
+        in_file = make_input_file(tps_network_and_traj)
+        result = runner.invoke(append,
+                               [in_file, '-a', "output.nc",
+                                '--tag', 'template'])
+        assert result.exit_code == 0
+        assert result.exception is None
+
+        storage = paths.Storage("output.nc", mode='r')
+        assert len(storage.snapshots) == 2
+        assert len(storage.tags) == 1
+        assert storage.tags['template'] is not None
+        storage.close()
+
+def test_append_remove_tag(tps_network_and_traj):
+    runner = CliRunner()
+    with runner.isolated_filesystem():
+        in_file = make_input_file(tps_network_and_traj)
+        result = runner.invoke(append,
+                               [in_file, '-a', "output.nc",
+                                "--tag", 'template', '--save-tag', ''])
+        print(result.output)
+        assert result.exception is None
+        assert result.exit_code == 0
+
+        storage = paths.Storage("output.nc", mode='r')
+        assert len(storage.snapshots) == 2
+        assert len(storage.tags) == 0
+        storage.close()
+