Fix/cli arguments (#303)

* fix CLI arguments quiet, output

* fix performed CLI actions

* fix precondition evaluation in CLI

1 files changed, 43 insertions, 38 deletions

diff --git a/src/sec_certs/cli.py b/src/sec_certs/cli.py
index a25b55ee..01072d3f 100644
--- a/src/sec_certs/cli.py
+++ b/src/sec_certs/cli.py
@@ -13,6 +13,7 @@ import click
 from sec_certs import constants
 from sec_certs.config.configuration import config
 from sec_certs.dataset import CCDataset, FIPSDataset
+from sec_certs.dataset.dataset import Dataset
 from sec_certs.utils.helpers import warn_if_missing_poppler, warn_if_missing_tesseract
 
 logger = logging.getLogger(__name__)
@@ -29,6 +30,11 @@ class ProcessingStep:
     precondition_error_msg: str | None = field(default=None)
     pre_callback_func: Callable | None = field(default=None)
 
+    def __post_init__(self) -> None:
+        for condition in self.preconditions:
+            if not hasattr(Dataset.DatasetInternalState, condition):
+                raise ValueError(f"Precondition attribute {condition} is not member of `Dataset.DatasetInternalState`.")
+
     def run(self, dset: CCDataset | FIPSDataset) -> None:
         for condition in self.preconditions:
             if not getattr(dset.state, condition):
@@ -89,6 +95,38 @@ def build_or_load_dataset(
     return dset
 
 
+steps = [
+    ProcessingStep(
+        "process-aux-dsets",
+        "process_auxillary_datasets",
+        preconditions=["meta_sources_parsed"],
+        precondition_error_msg="Error: You want to process the auxillary datasets, but the data from cert. framework website was not parsed. You must use 'build' action first.",
+        pre_callback_func=None,
+    ),
+    ProcessingStep(
+        "download",
+        "download_all_artifacts",
+        preconditions=["meta_sources_parsed"],
+        precondition_error_msg="Error: You want to download all artifacts, but the data from the cert. framework website was not parsed. You must use 'build' action first.",
+        pre_callback_func=None,
+    ),
+    ProcessingStep(
+        "convert",
+        "convert_all_pdfs",
+        preconditions=["artifacts_downloaded"],
+        precondition_error_msg="Error: You want to convert pdfs -> txt, but the pdfs were not downloaded. You must use 'download' action first.",
+        pre_callback_func=warn_missing_libs,
+    ),
+    ProcessingStep(
+        "analyze",
+        "analyze_certificates",
+        preconditions=["pdfs_converted", "auxillary_datasets_processed"],
+        precondition_error_msg="Error: You want to process txt documents of certificates, but pdfs were not converted. You must use 'convert' action first.",
+        pre_callback_func=None,
+    ),
+]
+
+
 @click.command()
 @click.argument(
     "framework",
@@ -105,6 +143,7 @@ def build_or_load_dataset(
 @click.option(
     "-o",
     "--output",
+    "outputpath",
     type=click.Path(file_okay=False, dir_okay=True, writable=True, readable=True, resolve_path=True),
     help="Path where the output of the experiment will be stored. May overwrite existing content.",
     default=Path("./dataset/"),
@@ -132,7 +171,7 @@ def main(
     outputpath: Path,
     configpath: str | None,
     inputpath: Path | None,
-    silent: bool,
+    quiet: bool,
 ):
     try:
         file_handler = logging.FileHandler(config.log_filepath)
@@ -140,7 +179,7 @@ def main(
         formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
         file_handler.setFormatter(formatter)
         stream_handler.setFormatter(formatter)
-        handlers: list[logging.StreamHandler] = [file_handler] if silent else [file_handler, stream_handler]
+        handlers: list[logging.StreamHandler] = [file_handler] if quiet else [file_handler, stream_handler]
         logging.basicConfig(level=logging.INFO, handlers=handlers)
         start = datetime.now()
 
@@ -155,49 +194,15 @@ def main(
                 sys.exit(EXIT_CODE_NOK)
 
         actions_set = (
-            {"build", "process-aux-dsets", "download", "convert", "analyze", "maintenances"}
-            if "all" in actions
-            else set(actions)
+            {"build", "process-aux-dsets", "download", "convert", "analyze"} if "all" in actions else set(actions)
         )
 
         dset = build_or_load_dataset(framework, inputpath, "build" in actions_set, outputpath)
         aux_dsets_to_handle = "PP, Maintenance updates" if framework == "cc" else "Algorithms"
         aux_dsets_to_handle += "CPE, CVE"
-        analysis_pre_callback = None
-
-        steps = [
-            ProcessingStep(
-                "process-aux-dsets",
-                "process_auxillary_datasets",
-                preconditions=["meta_sources_parsed"],
-                precondition_error_msg=f"Error: You want to process the auxillary datasets: {aux_dsets_to_handle} , but the data from cert. framework website was not parsed. You must use 'build' action first.",
-                pre_callback_func=None,
-            ),
-            ProcessingStep(
-                "download",
-                "download_all_artifacts",
-                preconditions=["meta_sources_parsed"],
-                precondition_error_msg="Error: You want to download all artifacts, but the data from the cert. framework website was not parsed. You must use 'build' action first.",
-                pre_callback_func=None,
-            ),
-            ProcessingStep(
-                "convert",
-                "convert_all_pdfs",
-                preconditions=["pdfs_downloaded"],
-                precondition_error_msg="Error: You want to convert pdfs -> txt, but the pdfs were not downloaded. You must use 'download' action first.",
-                pre_callback_func=warn_missing_libs,
-            ),
-            ProcessingStep(
-                "analyze",
-                "analyze_certificates",
-                preconditions=["pdfs_converted", "auxillary_datasets_processed"],
-                precondition_error_msg="Error: You want to process txt documents of certificates, but pdfs were not converted. You must use 'convert' action first.",
-                pre_callback_func=analysis_pre_callback,
-            ),
-        ]
 
         processing_step: ProcessingStep
-        for processing_step in [x for x in steps if x in actions_set]:
+        for processing_step in [x for x in steps if x.name in actions_set]:
             processing_step.run(dset)
 
         end = datetime.now()