feat(cli): add delete commands and use them in the tests

Author: deveaud-m

fossology/foss_cli.py

@@ -136,7 +136,7 @@ def check_get_access_level(level: str):
 
 
 def needs_later_initialization_of_foss_instance(ctx):
-    """Check if lateron a Fossology Instance will be created.
+    """Check if later on a Fossology Instance will be created.
 
     :param ctx: click context
     :type ctx: click.core.Context
@@ -580,6 +580,7 @@ def upload_file(
             file=upload_file,
             description=description if description else "upload via foss-cli",
             access_level=the_access_level,
+            wait_time=10,
         )
 
     ctx.obj["UPLOAD"] = the_upload
@@ -602,6 +603,56 @@ def upload_file(
             )
 
 
+@cli.command("delete_folder")
+@click.argument("folder_name")
+@click.pass_context
+def delete_folder(
+    ctx: click.core.Context,
+    folder_name: str,
+):
+    """The foss_cli delete_folder command."""
+
+    logger.debug(f"Try to delete folder {folder_name}")
+    foss = ctx.obj["FOSS"]
+
+    folder = None
+    for f in foss.list_folders():
+        if f.name == folder_name:
+            folder = f
+            logger.debug(f"Found folder to delete: {folder}")
+            break
+
+    if not folder:
+        logger.fatal(f"Unable to find folder {folder_name}.")
+        ctx.exit(1)
+
+    foss.delete_folder(folder)
+    logger.debug(f"Delete command was send to {foss.host} for folder {folder}")
+
+
+@cli.command("delete_upload")
+@click.argument("upload_name")
+@click.pass_context
+def delete_upload(
+    ctx: click.core.Context,
+    upload_name: str,
+):
+    """The foss_cli folder_id command."""
+
+    logger.debug(f"Try to delete upload {upload_name}")
+    foss = ctx.obj["FOSS"]
+
+    upload = None
+    for u in foss.list_uploads(all_pages=True)[0]:
+        if u.uploadname == upload_name:
+            upload = u
+            logger.debug(f"Found upload to delete: {upload}")
+            break
+
+    foss.delete_upload(upload)
+    logger.debug(f"Delete command was send to {foss.host} for upload {upload}")
+
+
 @cli.command("start_workflow")
 @click.argument(
     "file_name",
@@ -695,6 +746,7 @@ def start_workflow(  # noqa: C901
                 file=file_name,
                 description=file_description,
                 access_level=the_access_level,
+                wait_time=10,
             )
             logger.debug(f"Finished upload for {file_name}")
 

tests/test_foss_cli_create_cmds.py

@@ -1,5 +1,7 @@
 __doc__ = """Test 'create_*' sub commands of foss_cli"""
 
+import time
+
 from fossology import foss_cli
 
 
@@ -20,6 +22,19 @@ def test_create_folder(runner, click_test_dict):
     )
     assert result.exit_code == 0
     assert d["VERBOSE"] == 2
+    time.sleep(2)
+    # cleanup
+    result = runner.invoke(
+        foss_cli.cli,
+        [
+            "-vv",
+            "delete_folder",
+            "FossFolder",
+        ],
+        obj=d,
+        catch_exceptions=False,
+    )
+    assert result.exit_code == 0
 
 
 def test_create_group(runner, click_test_dict):

tests/test_foss_cli_flow_cmds.py

@@ -1,6 +1,7 @@
 __doc__ = """Test the "workflow" sub commands of foss_cli"""
 import configparser
 import os
+import time
 from pathlib import PurePath
 
 from fossology import foss_cli
@@ -28,6 +29,18 @@ def test_upload_file(runner, click_test_file_path, click_test_file, click_test_d
     assert d["DEBUG"]
     assert d["UPLOAD"].uploadname == click_test_file
     assert "Summary of upload" in result.output
+    time.sleep(2)
+    result = runner.invoke(
+        foss_cli.cli,
+        [
+            "-vv",
+            "delete_upload",
+            click_test_file,
+        ],
+        obj=d,
+        catch_exceptions=False,
+    )
+    assert result.exit_code == 0
 
 
 def test_create_config_file_with_wrong_token_scope_uses_default_read(

tests/test_foss_cli_start_workflow.py

@@ -61,7 +61,7 @@ def test_start_workflow_reuse_newest_job(
     runner, click_test_file_path, click_test_file, click_test_dict
 ):
     d = click_test_dict
-    # first upload  is the initial one
+    # first upload is the initial one
     #  - it uploads
     #  - it triggers a job on the upload
     q_path = PurePath(click_test_file_path, click_test_file)
@@ -109,3 +109,15 @@ def test_start_workflow_reuse_newest_job(
     assert "Report downloaded" in result.output
     assert "Report written to file: " in result.output
     assert result.exit_code == 0
+    # cleanup
+    result = runner.invoke(
+        foss_cli.cli,
+        [
+            "-vv",
+            "delete_upload",
+            click_test_file,
+        ],
+        obj=d,
+        catch_exceptions=False,
+    )
+    assert result.exit_code == 0