refactor(cli): modularise cli.py (DEV-3068) (#673)

Co-authored-by: Johannes Nussbaum <johannes.nussbaum@dasch.swiss>

pyproject.toml

@@ -61,7 +61,7 @@ viztracer = "^0.16.0"
 
 
 [tool.poetry.scripts]
-dsp-tools = "dsp_tools.cli:main"  # definition of the CLI entry point
+dsp-tools = "dsp_tools.cli.entry_point:main"  # definition of the CLI entry point
 
 
 [tool.poetry-exec-plugin.commands]

src/dsp_tools/cli/call_action.py

@@ -0,0 +1,230 @@
+import argparse
+
+from dsp_tools.commands.excel2json.lists import excel2lists, validate_lists_section_with_schema
+from dsp_tools.commands.excel2json.project import excel2json
+from dsp_tools.commands.excel2json.properties import excel2properties
+from dsp_tools.commands.excel2json.resources import excel2resources
+from dsp_tools.commands.excel2xml.excel2xml_cli import excel2xml
+from dsp_tools.commands.fast_xmlupload.process_files import process_files
+from dsp_tools.commands.fast_xmlupload.upload_files import upload_files
+from dsp_tools.commands.fast_xmlupload.upload_xml import fast_xmlupload
+from dsp_tools.commands.id2iri import id2iri
+from dsp_tools.commands.project.create.project_create import create_project
+from dsp_tools.commands.project.create.project_create_lists import create_lists
+from dsp_tools.commands.project.create.project_validate import validate_project
+from dsp_tools.commands.project.get import get_project
+from dsp_tools.commands.rosetta import upload_rosetta
+from dsp_tools.commands.start_stack import StackConfiguration, StackHandler
+from dsp_tools.commands.template import generate_template_repo
+from dsp_tools.commands.xmlupload.upload_config import DiagnosticsConfig, UploadConfig
+from dsp_tools.commands.xmlupload.xmlupload import xmlupload
+from dsp_tools.utils.create_logger import get_logger
+from dsp_tools.utils.shared import validate_xml_against_schema
+
+logger = get_logger(__name__)
+
+
+def call_requested_action(args: argparse.Namespace) -> bool:
+    """
+    Call the appropriate method of DSP-TOOLS.
+
+    Args:
+        args: parsed CLI arguments
+
+    Raises:
+        BaseError from the called methods
+        UserError from the called methods
+        unexpected errors from the called methods and underlying libraries
+
+    Returns:
+        success status
+    """
+    match args.action:
+        case "create":
+            return _call_create(args)
+        case "xmlupload":
+            return _call_xmlupload(args)
+        case "excel2json":
+            return _call_excel2json(args)
+        case "excel2lists":
+            return _call_excel2lists(args)
+        case "excel2resources":
+            return _call_excel2resources(args)
+        case "excel2properties":
+            return _call_excel2properties(args)
+        case "id2iri":
+            return _call_id2iri(args)
+        case "excel2xml":
+            return _call_excel2xml(args)
+        case "start-stack":
+            return _call_start_stack(args)
+        case "stop-stack":
+            return _call_stop_stack()
+        case "get":
+            return _call_get(args)
+        case "process-files":
+            return _call_process_files(args)
+        case "upload-files":
+            return _call_upload_files(args)
+        case "fast-xmlupload":
+            return _call_fast_xmlupload(args)
+        case "template":
+            return generate_template_repo()
+        case "rosetta":
+            return upload_rosetta()
+        case _:
+            print(f"ERROR: Unknown action '{args.action}'")
+            logger.error(f"Unknown action '{args.action}'")
+            return False
+
+
+def _call_stop_stack() -> bool:
+    stack_handler = StackHandler(StackConfiguration())
+    return stack_handler.stop_stack()
+
+
+def _call_start_stack(args: argparse.Namespace) -> bool:
+    stack_handler = StackHandler(
+        StackConfiguration(
+            max_file_size=args.max_file_size,
+            enforce_docker_system_prune=args.prune,
+            suppress_docker_system_prune=args.no_prune,
+            latest_dev_version=args.latest,
+        )
+    )
+    return stack_handler.start_stack()
+
+
+def _call_excel2xml(args: argparse.Namespace) -> bool:
+    success, _ = excel2xml(
+        datafile=args.data_source,
+        shortcode=args.project_shortcode,
+        default_ontology=args.ontology_name,
+    )
+    return success
+
+
+def _call_id2iri(args: argparse.Namespace) -> bool:
+    return id2iri(
+        xml_file=args.xmlfile,
+        json_file=args.mapping,
+        remove_resource_if_id_in_mapping=args.remove_resources,
+    )
+
+
+def _call_excel2properties(args: argparse.Namespace) -> bool:
+    _, success = excel2properties(
+        excelfile=args.excelfile,
+        path_to_output_file=args.properties_section,
+    )
+    return success
+
+
+def _call_excel2resources(args: argparse.Namespace) -> bool:
+    _, success = excel2resources(
+        excelfile=args.excelfile,
+        path_to_output_file=args.resources_section,
+    )
+    return success
+
+
+def _call_excel2lists(args: argparse.Namespace) -> bool:
+    _, success = excel2lists(
+        excelfolder=args.excelfolder,
+        path_to_output_file=args.lists_section,
+        verbose=args.verbose,
+    )
+    return success
+
+
+def _call_excel2json(args: argparse.Namespace) -> bool:
+    return excel2json(
+        data_model_files=args.excelfolder,
+        path_to_output_file=args.project_definition,
+    )
+
+
+def _call_fast_xmlupload(args: argparse.Namespace) -> bool:
+    return fast_xmlupload(
+        xml_file=args.xml_file,
+        user=args.user,
+        password=args.password,
+        dsp_url=args.server,
+        sipi_url=args.sipi_url,
+    )
+
+
+def _call_upload_files(args: argparse.Namespace) -> bool:
+    return upload_files(
+        dir_with_processed_files=args.processed_dir,
+        nthreads=args.nthreads,
+        user=args.user,
+        password=args.password,
+        dsp_url=args.server,
+        sipi_url=args.sipi_url,
+    )
+
+
+def _call_process_files(args: argparse.Namespace) -> bool:
+    return process_files(
+        input_dir=args.input_dir,
+        output_dir=args.output_dir,
+        xml_file=args.xml_file,
+        nthreads=args.nthreads,
+    )
+
+
+def _call_xmlupload(args: argparse.Namespace) -> bool:
+    if args.validate_only:
+        return validate_xml_against_schema(args.xmlfile)
+    else:
+        return xmlupload(
+            input_file=args.xmlfile,
+            server=args.server,
+            user=args.user,
+            password=args.password,
+            imgdir=args.imgdir,
+            sipi=args.sipi_url,
+            config=UploadConfig(diagnostics=DiagnosticsConfig(verbose=args.verbose, dump=args.dump)),
+        )
+
+
+def _call_get(args: argparse.Namespace) -> bool:
+    return get_project(
+        project_identifier=args.project,
+        outfile_path=args.project_definition,
+        server=args.server,
+        user=args.user,
+        password=args.password,
+        verbose=args.verbose,
+        dump=args.dump,
+    )
+
+
+def _call_create(args: argparse.Namespace) -> bool:
+    success = False
+    match args.lists_only, args.validate_only:
+        case True, True:
+            success = validate_lists_section_with_schema(args.project_definition)
+            print("'Lists' section of the JSON project file is syntactically correct and passed validation.")
+        case True, False:
+            _, success = create_lists(
+                project_file_as_path_or_parsed=args.project_definition,
+                server=args.server,
+                user=args.user,
+                password=args.password,
+                dump=args.dump,
+            )
+        case False, True:
+            success = validate_project(args.project_definition)
+            print("JSON project file is syntactically correct and passed validation.")
+        case False, False:
+            success = create_project(
+                project_file_as_path_or_parsed=args.project_definition,
+                server=args.server,
+                user_mail=args.user,
+                password=args.password,
+                verbose=args.verbose,
+                dump=args.dump,
+            )
+    return success