adjusted logging a bit

Author: notactuallyfinn

src/hermes/commands/cli.py

@@ -76,15 +76,20 @@ def main() -> None:
 
         log.info("Run subcommand %s", args.command.command_name)
         args.command(args)
-    except HermesPluginRunError as e:
-        log.error("An error occurred during the execution of a plugin %s (Find details in './hermes.log')",
-                  args.command.command_name)
-        log.debug("Original exception was: %s", e)
+    except HermesPluginRunError:
+        log.critical(
+            "An error occurred during the execution of the %s command (Find details in './hermes.log')",
+            args.command.command_name,
+            exc_info=1
+        )
         sys.exit(2)
-    except Exception as e:
-        log.error("An error occurred during execution of %s (Find details in './hermes.log')",
-                  args.command.command_name)
-        log.debug("Original exception was: %s", e)
+    except Exception:
+        log.critical(
+            "An error occurred during execution of the %s command (Find details in './hermes.log')",
+            args.command.command_name,
+            exc_info=1
+        )
         sys.exit(1)
 
+    log.info("Finished run of %s command successfully.", args.command.command_name)
     sys.exit(0)

src/hermes/commands/curate/base.py

@@ -47,7 +47,10 @@ def __call__(self, args: argparse.Namespace) -> None:
         try:
             metadata = SoftwareMetadata.load_from_cache(ctx, "result")
         except Exception as e:
-            self.log.error("The data from the process step could not be loaded or is invalid for some reason.")
+            self.log.critical(
+                "## The data from the process step could not be loaded or is invalid for some reason.",
+                exc_info=1
+            )
             raise HermesValidationError("The results of the process step are invalid.") from e
         ctx.finalize_step("process")
 
@@ -56,15 +59,15 @@ def __call__(self, args: argparse.Namespace) -> None:
         try:
             plugin_func = self.plugins[plugin_name]()
         except KeyError:
-            self.log.error(f"Plugin {plugin_name} not found.")
+            self.log.error(f"## Curate plugin {plugin_name} not found.")
             raise MisconfigurationError(f"Curate plugin {plugin_name} not found.")
 
         self.log.info(f"## Run curation plugin {plugin_name}")
         # run plugin
         try:
             curated_metadata = plugin_func(self, metadata)
         except Exception as e:
-            self.log.error(f"Unknown error while executing the {plugin_name} plugin.")
+            self.log.critical(f"## Unknown error while executing the {plugin_name} plugin.", exc_info=1)
             raise HermesPluginRunError(f"Something went wrong while running the curate plugin {plugin_name}") from e
 
         self.log.info("## Store curated data")

src/hermes/commands/deposit/base.py

@@ -144,15 +144,15 @@ def __call__(self, args: argparse.Namespace) -> None:
         try:
             plugin_func = self.plugins[plugin_name]()
         except KeyError:
-            self.log.error(f"Plugin {plugin_name} not found.")
+            self.log.critical(f"## Deposit plugin {plugin_name} not found.")
             raise MisconfigurationError(f"Deposit plugin {self.settings.plugin} not found.")
 
         self.log.info(f"## Run deposit plugin {plugin_name}")
         # run plugin
         try:
             plugin_func(self)
         except HermesValidationError as e:
-            self.log.error(f"Error while executing {plugin_name}: {e}")
+            self.log.critical(f"## Error while executing {plugin_name} plugin.", exc_info=1)
             raise HermesPluginRunError(
                 f"Something went wrong while running the deposit plugin {self.settings.plugin}"
             ) from e

src/hermes/commands/harvest/base.py

@@ -9,6 +9,7 @@
 from pydantic import BaseModel
 
 from hermes.commands.base import HermesCommand, HermesPlugin
+from hermes.error import HermesPluginRunError, MisconfigurationError
 from hermes.model.context_manager import HermesContext
 from hermes.model import SoftwareMetadata
 
@@ -40,8 +41,8 @@ def __call__(self, args: argparse.Namespace) -> None:
         self.args = args
 
         if len(self.settings.sources) == 0:
-            self.log.info("# No plugin was configured to be run and loaded.")
-            return
+            self.log.critical("# No harvest plugin was configured to be run and loaded.")
+            raise MisconfigurationError("No harvest plugin was configured to be run and loaded.")
 
         # Initialize the harvest cache directory here to indicate the step ran
         ctx = HermesContext()
@@ -55,15 +56,15 @@ def __call__(self, args: argparse.Namespace) -> None:
             try:
                 plugin_func = self.plugins[plugin_name]()
             except KeyError:
-                self.log.warning(f"Plugin {plugin_name} not found, skipping it now.")
+                self.log.error(f"### Plugin {plugin_name} not found, skipping it now.")
                 continue
 
             self.log.info(f"### Run {plugin_name} plugin")
             # run plugin
             try:
                 harvested_data = plugin_func(self)
             except Exception:
-                self.log.warning(f"Unknown error while executing the {plugin_name} plugin, skipping it now.")
+                self.log.exception(f"### Unknown error while executing the {plugin_name} plugin, skipping it now.")
                 continue
 
             self.log.info(f"### Store metadata harvested by {plugin_name} plugin")
@@ -73,5 +74,5 @@ def __call__(self, args: argparse.Namespace) -> None:
 
         ctx.finalize_step('harvest')
         if not harvested_any:
-            self.log.error("No harvest plugin ran successfully.")
-            raise RuntimeError("No harvest plugin ran successfully.")
+            self.log.critical("No harvest plugin ran successfully.")
+            raise HermesPluginRunError("No harvest plugin ran successfully.")

src/hermes/commands/postprocess/base.py

@@ -10,6 +10,7 @@
 from pydantic import BaseModel
 
 from hermes.commands.base import HermesCommand, HermesPlugin
+from hermes.error import HermesPluginRunError
 
 
 class HermesPostprocessPlugin(HermesPlugin):
@@ -36,6 +37,10 @@ def __call__(self, args: argparse.Namespace) -> None:
         self.args = args
         plugin_names = self.settings.run
 
+        if not plugin_names:
+            self.log.warning("# No plugin was configured to be run yet the postprocess command was executed.")
+            return
+
         self.log.info("## Load and run the plugins")
         ran_any = False
         for plugin_name in plugin_names:
@@ -44,19 +49,19 @@ def __call__(self, args: argparse.Namespace) -> None:
             try:
                 plugin_func = self.plugins[plugin_name]()
             except KeyError:
-                self.log.error(f"Plugin {plugin_name} not found.")
+                self.log.error(f"### Plugin {plugin_name} not found.")
                 continue
 
             self.log.info(f"### Run {plugin_name} plugin")
             # run plugin
             try:
                 plugin_func(self)
             except Exception:
-                self.log.error(f"Unknown error while executing the {plugin_name} plugin.")
+                self.log.exception(f"### Unknown error while executing the {plugin_name} plugin.")
                 continue
 
             ran_any = True
 
         if not ran_any:
-            self.log.error("No postprocess plugin ran successfully.")
-            raise RuntimeError("No postprocess plugin ran successfully.")
+            self.log.critical("## No postprocess plugin ran successfully.")
+            raise HermesPluginRunError("No postprocess plugin ran successfully.")

src/hermes/commands/process/base.py

@@ -10,7 +10,7 @@
 from pydantic import BaseModel
 
 from hermes.commands.base import HermesCommand, HermesPlugin
-from hermes.error import HermesPluginRunError
+from hermes.error import HermesPluginRunError, MisconfigurationError
 from hermes.model.api import SoftwareMetadata
 from hermes.model.context_manager import HermesContext
 from hermes.model.merge.action import MergeAction
@@ -39,9 +39,21 @@ class HermesProcessCommand(HermesCommand):
 
     def __call__(self, args: argparse.Namespace) -> None:
         self.log.info("# Metadata processing")
-        self.args = args
         merged_doc = ld_merge_dict([{}])
 
+        if not self.settings.plugins:
+            self.log.critical(
+                "# It was explicitly configured that no process plugin should be used."
+                " Hint: Do not configure anything to use standard 'codemeta' plugin."
+            )
+            raise MisconfigurationError("Explicit configuration to use no process plugin.")
+
+        # Get all harvesters
+        harvester_names = self.settings.sources if self.settings.sources else self.root_settings.harvest.sources
+        if not harvester_names:
+            self.log.critical("# No harvesters to merge from were configured.")
+            raise MisconfigurationError("No harvesters to merge from were configured.")
+
         self.log.info("## Load and run the plugins")
         any_strategies_loaded = False
         # add the strategies from the plugins
@@ -51,15 +63,15 @@ def __call__(self, args: argparse.Namespace) -> None:
             try:
                 plugin_func = self.plugins[plugin_name]()
             except KeyError:
-                self.log.warning(f"Plugin {plugin_name} not found, skipping it now.")
+                self.log.error(f"### Plugin {plugin_name} not found, skipping it now.")
                 continue
 
             self.log.info(f"### Run {plugin_name} plugin")
             # run plugin
             try:
                 additional_strategies = plugin_func(self)
             except Exception:
-                self.log.warning(f"Unknown error while executing the {plugin_name} plugin, skipping it now.")
+                self.log.exception(f"### Unknown error while executing the {plugin_name} plugin, skipping it now.")
                 continue
 
             self.log.info(f"### Add the strategies to the merge document {plugin_name} plugin")
@@ -68,44 +80,39 @@ def __call__(self, args: argparse.Namespace) -> None:
             any_strategies_loaded = True
 
         if not any_strategies_loaded:
-            self.log.error("No process plugin was ran successfully.")
-            raise RuntimeError("No process plugin was ran successfully.")
+            self.log.critical("## No process plugin was ran successfully.")
+            raise HermesPluginRunError("No process plugin was ran successfully.")
 
         ctx = HermesContext()
         ctx.prepare_step('harvest')
 
+        # merge data from harvesters
         self.log.info("## Merge the metadata of the harvesters")
-        # Get all harvesters
-        harvester_names = self.settings.sources if self.settings.sources else self.root_settings.harvest.sources
         merged_any = False
         for harvester in harvester_names:
-            self.log.info(f"## Load data from {harvester} plugin")
+            self.log.info(f"### Load data from {harvester} plugin")
             # load data from harvester
             try:
                 metadata = SoftwareMetadata.load_from_cache(ctx, harvester)
             except Exception:
                 # skip this harvester when the data is invalid
-                self.log.warning(f"The data from the harvester {harvester} could not be loaded or is invalid.")
-                self.log.info(f"## Aborting merge for {harvester}")
+                self.log.exception(
+                    f"### The data from the harvester {harvester} could not be loaded or is invalid, skipping it now."
+                )
                 continue
 
-            self.log.info(f"## Merge data from {harvester} plugin")
+            self.log.info(f"### Merge data from {harvester} plugin")
             # merge data into the merge dict
             try:
                 merged_doc.update(metadata)
             except Exception as e:
-                self.log.error(f"Merging the data from {harvester} plugin resulted in an error.")
-                raise HermesPluginRunError(f"Merging the data from {harvester} plugin failed.") from e
+                self.log.critical(f"### Merging the data from {harvester} plugin resulted in an error.", exc_info=True)
+                raise RuntimeError(f"Merging the data from {harvester} plugin failed.") from e
             merged_any = True
 
         # error if nothing was merged
-        if harvester_names and not merged_any:
-            self.log.error(
-                f"""No metadata has been merged. {
-                    "No harvesters to merge from were supplied" if not harvester_names else
-                    "The merging failed for all harvesters."
-                }"""
-            )
+        if not merged_any:
+            self.log.critical("No metadata has been merged, the loading of the data failed for all harvesters.")
             raise RuntimeError("No metadata has been merged.")
 
         self.log.info("## Store processed metadata")

src/hermes/logger.py

@@ -69,7 +69,7 @@ def init_logging():
         _loggers[log_name] = logging.getLogger(log_name)
 
 
-def getLogger(log_name):
+def getLogger(log_name) -> logging.Logger:
     init_logging()
     if log_name not in _loggers:
         _loggers[log_name] = logging.getLogger(log_name)