242 Use the logger in bump-recipe (#250)

* Adds logger to crm commands and bump-recipe. Logg levels are controlled with a -v flag applied before the command name

* Increases unit test coverage

Makefile

@@ -85,7 +85,7 @@ test:			## Runs test cases
 
 test-cov:		## Checks test coverage requirements
 	$(PYTHON3) -m pytest -n auto --cov-config=.coveragerc --cov=$(SRC_DIR) \
-		$(TEST_DIR) --cov-fail-under=80 --cov-report term-missing
+		$(TEST_DIR) --cov-fail-under=85 --cov-report term-missing
 
 lint:			## Runs the linter against the project
 	pylint --rcfile=.pylintrc $(SRC_DIR) $(TEST_DIR)

conda_recipe_manager/commands/bump_recipe.py

@@ -4,20 +4,22 @@
 
 from __future__ import annotations
 
+import logging
 import sys
 from pathlib import Path
 from typing import Final, Optional, cast
 
 import click
 
-from conda_recipe_manager.commands.utils.print import print_err
 from conda_recipe_manager.commands.utils.types import ExitCode
 from conda_recipe_manager.fetcher.artifact_fetcher import from_recipe as af_from_recipe
 from conda_recipe_manager.fetcher.http_artifact_fetcher import HttpArtifactFetcher
 from conda_recipe_manager.parser.recipe_parser import RecipeParser
 from conda_recipe_manager.parser.recipe_reader import RecipeReader
 from conda_recipe_manager.types import JsonPatchType
 
+log = logging.getLogger(__name__)
+
 
 def _exit_on_failed_patch(recipe_parser: RecipeParser, patch_blob: JsonPatchType) -> None:
     """
@@ -28,9 +30,10 @@ def _exit_on_failed_patch(recipe_parser: RecipeParser, patch_blob: JsonPatchType
     :param patch_blob: Recipe patch to execute.
     """
     if recipe_parser.patch(patch_blob):
+        log.debug("Executed patch: %s", patch_blob)
         return
 
-    print_err(f"Couldn't perform the patch: {patch_blob}.")
+    log.error("Couldn't perform the patch: %s", patch_blob)
     sys.exit(ExitCode.PATCH_ERROR)
 
 
@@ -46,7 +49,7 @@ def _update_build_num(recipe_parser: RecipeParser, increment_build_num: bool) ->
     try:
         recipe_parser.get_value("/build")
     except KeyError:
-        print_err("`/build` key could not be found in the recipe.")
+        log.error("`/build` key could not be found in the recipe.")
         sys.exit(ExitCode.ILLEGAL_OPERATION)
 
     # From the previous check, we know that `/build` exists. If `/build/number` is missing, it'll be added by
@@ -56,7 +59,7 @@ def _update_build_num(recipe_parser: RecipeParser, increment_build_num: bool) ->
         build_number = recipe_parser.get_value("/build/number")
 
         if not isinstance(build_number, int):
-            print_err("Build number is not an integer.")
+            log.error("Build number is not an integer.")
             sys.exit(ExitCode.ILLEGAL_OPERATION)
 
         _exit_on_failed_patch(
@@ -85,8 +88,7 @@ def _update_version(recipe_parser: RecipeParser, target_version: str) -> None:
         # Generate a warning if `version` is not being used in the `/package/version` field. NOTE: This is a linear
         # search on a small list.
         if "/package/version" not in recipe_parser.get_variable_references("version"):
-            # TODO log a warning
-            pass
+            log.warning("`/package/version` does not use the defined JINJA variable `version`.")
         return
 
     op: Final[str] = "replace" if recipe_parser.contains_value("/package/version") else "add"
@@ -105,7 +107,7 @@ def _update_sha256(recipe_parser: RecipeParser) -> None:
     """
     fetcher_lst = af_from_recipe(recipe_parser, True)
     if not fetcher_lst:
-        # TODO log
+        log.warning("`/source` is missing or does not contain a supported source type.")
         return
 
     # TODO handle case where SHA is stored in one or more variables (see cctools-ld64.yaml)
@@ -119,7 +121,7 @@ def _update_sha256(recipe_parser: RecipeParser) -> None:
         if not isinstance(fetcher, HttpArtifactFetcher):
             continue
 
-        # TODO retry mechanism
+        # TODO retry mechanism, and log attempts
         # TODO attempt fetch in the background, especially if multiple fetch() calls are required.
         fetcher.fetch()
         sha = fetcher.get_archive_sha256()
@@ -157,19 +159,19 @@ def bump_recipe(recipe_file_path: str, build_num: bool, target_version: Optional
     """
 
     if not build_num and target_version is None:
-        print_err("The `--target-version` option must be set if `--build-num` is not specified.")
+        log.error("The `--target-version` option must be set if `--build-num` is not specified.")
         sys.exit(ExitCode.CLICK_USAGE)
 
     try:
         contents_recipe = Path(recipe_file_path).read_text(encoding="utf-8")
     except IOError:
-        print_err(f"Couldn't read the given recipe file: {recipe_file_path}")
+        log.error("Couldn't read the given recipe file: %s", recipe_file_path)
         sys.exit(ExitCode.IO_ERROR)
 
     try:
         recipe_parser = RecipeParser(contents_recipe)
     except Exception:  # pylint: disable=broad-except
-        print_err("An error occurred while parsing the recipe file contents.")
+        log.error("An error occurred while parsing the recipe file contents.")
         sys.exit(ExitCode.PARSE_EXCEPTION)
 
     # Attempt to update fields

conda_recipe_manager/commands/conda_recipe_manager.py

@@ -4,6 +4,8 @@
 
 from __future__ import annotations
 
+import logging
+
 import click
 
 from conda_recipe_manager.commands.bump_recipe import bump_recipe
@@ -14,11 +16,23 @@
 
 
 @click.group()
-def conda_recipe_manager() -> None:
+@click.option(
+    "-v",
+    "--verbose",
+    is_flag=True,
+    default=False,
+    show_default=True,
+    help="Enables verbose logging (for commands that use the logger).",
+)
+def conda_recipe_manager(verbose: bool) -> None:
     """
     Command line interface for conda recipe management commands.
     """
-    pass
+    # Initialize the logger, available to all CRM commands.
+    logging.basicConfig(
+        format="[%(levelname)s] [%(name)s]: %(message)s",
+        level=logging.DEBUG if verbose else logging.INFO,
+    )
 
 
 conda_recipe_manager.add_command(convert)
@@ -29,4 +43,4 @@ def conda_recipe_manager() -> None:
 
 
 if __name__ == "__main__":
-    conda_recipe_manager()
+    conda_recipe_manager(False)

tests/commands/test_bump_recipe.py

@@ -135,9 +135,6 @@ def test_bump_recipe_exits_if_target_version_missing() -> None:
     """
     runner = CliRunner()
     result = runner.invoke(bump_recipe.bump_recipe, [str(get_test_path() / "types-toml.yaml")])
-
-    # Ensure the expected error case was hit (as opposed to a different error case).
-    assert result.stdout == "The `--target-version` option must be set if `--build-num` is not specified.\n"
     assert result.exit_code == ExitCode.CLICK_USAGE