IMP: Make multiple key removal a thing (#360)

Co-authored-by: Chloe Herman <60228108+cherman2@users.noreply.github.com>

Author: Oddant1

q2cli/builtin/tools.py

@@ -715,21 +715,34 @@ def cache_create(cache):
               type=click.Path(exists=True, file_okay=False, dir_okay=True,
                               readable=True),
               help='Path to an existing cache to remove the key from.')
-@click.option('--key', required=True,
-              help='The key to remove from the cache.')
+@click.option('--key', required=True, multiple=True,
+              help='The key to remove from the cache. Pass `key` parameter '
+                   'multiple times to remove multiple keys.')
 def cache_remove(cache, key):
     from qiime2.core.cache import Cache
     from q2cli.core.config import CONFIG
 
+    # I don't want to instantiate this every time in the loop
     try:
         _cache = Cache(cache)
-        _cache.remove(key)
     except Exception as e:
-        header = "There was a problem removing the key '%s' from the " \
-                 "cache '%s':" % (key, cache)
+        header = f"The path '{cache}' is not a valid QIIME 2 cache."
         q2cli.util.exit_with_error(e, header=header, traceback=None)
 
-    success = "Removed key '%s' from cache '%s'" % (key, cache)
+    for _key in key:
+        try:
+            # TODO: This will run gc after every key removal. Don't need to do
+            # that
+            _cache.remove(_key)
+        except Exception as e:
+            header = f"There was a problem removing the key '{_key}' from "\
+                     f"the cache '{cache}'"
+            q2cli.util.exit_with_error(e, header=header, traceback=None)
+        else:
+            success = f"Removed key '{_key}' from cache '{cache}'"
+            click.echo(CONFIG.cfg_style('success', success))
+
+    success = f"Removed key(s) '{key}' from cache '{cache}'"
     click.echo(CONFIG.cfg_style('success', success))
 
 

q2cli/tests/test_tools.py

@@ -578,10 +578,39 @@ def test_cache_remove(self):
             tools,
             ['cache-remove', '--cache', str(self.cache.path), '--key', 'key'])
 
-        success = "Removed key 'key' from cache '%s'\n" % self.cache.path
+        success = \
+            f"Removed key 'key' from cache '{str(self.cache.path)}'\n" \
+            f"Removed key(s) '('key',)' from cache '{str(self.cache.path)}'\n"
         self.assertEqual(success, result.output)
         self.assertFalse('key' in self.cache.get_keys())
 
+    def test_cache_remove_multiple(self):
+        self.cache.save(self.art1, 'key1')
+        self.cache.save(self.art1, 'key2')
+        self.cache.save(self.art1, 'key3')
+
+        keys = self.cache.get_keys()
+        self.assertEqual(set(['key1', 'key2', 'key3']), keys)
+
+        result = self.runner.invoke(
+            tools,
+            ['cache-remove', '--cache', str(self.cache.path), '--key', 'key1',
+             '--key', 'key2']
+        )
+
+        success = \
+            f"Removed key 'key1' from cache '{str(self.cache.path)}'\n" \
+            f"Removed key 'key2' from cache '{str(self.cache.path)}'\n" \
+            "Removed key(s) '('key1', 'key2')' from cache " \
+            f"'{str(self.cache.path)}'\n"
+
+        new_keys = self.cache.get_keys()
+
+        self.assertEqual(success, result.output)
+        self.assertFalse('key1' in new_keys)
+        self.assertFalse('key2' in new_keys)
+        self.assertTrue('key3' in new_keys)
+
     def test_cache_garbage_collection(self):
         # Data referenced directly by key
         self.cache.save(self.art1, 'foo')