Increase cli test coverage (#533)

* fix typo, add test_install_command_value_error

* fix typo, parametrize to test correct behaviour when atlas name is None for multiple commands

* add test_cli_incorrect_command

* add test_cli_list

* fix test_update_command

* add docstring

Author: stellaprins

brainglobe_atlasapi/cli.py

@@ -41,15 +41,15 @@ def bg_cli(
         if atlas_name is None:
             raise ValueError(
                 'No atlas named passed with command "install". Use the "-a"\
-                                argument to pass an atls name'
+                                argument to pass an atlas name'
             )
         return install_atlas(atlas_name=atlas_name)
 
     elif command == "update":  # update installed atlas
         if atlas_name is None:
             raise ValueError(
                 'No atlas named passed with command "update". Use the "-a"\
-                                argument to pass an atls name'
+                                argument to pass an atlas name'
             )
         return update_atlas(atlas_name, force=force)
 

tests/atlasapi/test_cli.py

@@ -1,3 +1,4 @@
+import pytest
 from click.testing import CliRunner
 
 from brainglobe_atlasapi import cli, config
@@ -22,10 +23,12 @@ def test_config_cli():
 
 
 def test_update_command():
-    runner = CliRunner()
-
-    # Test printing of config file:
-    runner.invoke(cli.bg_cli, ["config", "-a", "example_mouse_100um", "-f"])
+    """Test update command."""
+    update_atlas = CliRunner().invoke(
+        cli.bg_cli, ["update", "-a", "example_mouse_100um", "-f"]
+    )
+    expected_output = "updating example_mouse_100um\nDownloading..."
+    assert expected_output in update_atlas.output
 
 
 def test_install_command():
@@ -35,8 +38,35 @@ def test_install_command():
     runner.invoke(cli.bg_cli, ["install", "-a", "example_mouse_100um"])
 
 
-def test_list_command():
-    runner = CliRunner()
+def test_cli_list():
+    """Test list command."""
+    atlases_table = CliRunner().invoke(cli.bg_cli, ["list", "--show"])
+    assert atlases_table.exit_code == 0
+    assert "nadkarni_mri_mouselemur_91um" in atlases_table.output
 
-    # Test printing of config file:
-    runner.invoke(cli.bg_cli, ["list", "s"])
+
+@pytest.mark.parametrize(
+    ["command"], [pytest.param("install"), pytest.param("update")]
+)
+def test_atlas_name_is_none_value_error(command):
+    """Test whether command without atlas name raises ValueError."""
+    with pytest.raises(
+        ValueError,
+        match=(
+            f'No atlas named passed with command "{command}". Use the "-a"'
+            r"\s+argument to pass an atlas name"
+        ),
+    ):
+        CliRunner().invoke(
+            cli.bg_cli, [command, "-a", None], catch_exceptions=False
+        )
+
+
+def test_cli_incorrect_command():
+    """Test whether incorrect "flibble" command raises ValueError."""
+    command = "flibble"
+    with pytest.raises(
+        ValueError,
+        match=f'Invalid command {command}. use "brainglobe -h for more info."',
+    ):
+        CliRunner().invoke(cli.bg_cli, [command], catch_exceptions=False)