add bump-recipe command

conda_recipe_manager/commands/bump_recipe.py

@@ -0,0 +1,59 @@
+"""
+:Description: CLI for bumping build number in recipe files.
+"""
+
+from __future__ import annotations
+
+import sys
+from pathlib import Path
+from typing import 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.parser.recipe_parser import RecipeParser
+from conda_recipe_manager.types import JsonPatchType
+
+
+@click.command(short_help="Bump recipe build version.")
+@click.argument("recipe_file_path", type=click.Path(exists=True, path_type=str))
+@click.option(
+    "--build-num",
+    is_flag=True,
+    help="bump the build number by 1.",
+)
+def bump_recipe(recipe_file_path: str, build_num: bool) -> None:
+    """
+    Bump recipe version.
+
+    RECIPE_FILE_PATH: Path to the target recipe file
+    """
+    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}")
+        sys.exit(ExitCode.IO_ERROR)  # untested
+
+    try:
+        recipe_parser = RecipeParser(contents_recipe)
+        error_code = ExitCode.SUCCESS
+    except Exception:  # pylint: disable=broad-except
+        print_err("An error occurred while parsing the recipe file contents.")
+        sys.exit(ExitCode.PARSE_EXCEPTION)  # untested
+
+    if build_num:
+        error_code = ExitCode.SUCCESS
+        try:
+            build_number = recipe_parser.get_value("/build/number")
+        except KeyError:
+            print_err("`/build/number` key could not be found in the recipe.")
+            sys.exit(ExitCode.ILLEGAL_OPERATION)
+
+        if not isinstance(build_number, int):
+            print_err("Build number is not an integer.")
+            sys.exit(ExitCode.ILLEGAL_OPERATION)
+        required_patch_blob = cast(JsonPatchType, {"op": "replace", "path": "/build/number", "value": build_number + 1})
+        recipe_parser.patch(required_patch_blob)
+        Path(recipe_file_path).write_text(recipe_parser.render(), encoding="utf-8")
+        sys.exit(error_code)

conda_recipe_manager/commands/conda_recipe_manager.py

@@ -6,6 +6,7 @@
 
 import click
 
+from conda_recipe_manager.commands.bump_recipe import bump_recipe
 from conda_recipe_manager.commands.convert import convert
 from conda_recipe_manager.commands.graph import graph
 from conda_recipe_manager.commands.patch import patch
@@ -24,6 +25,7 @@ def conda_recipe_manager() -> None:
 conda_recipe_manager.add_command(graph)
 conda_recipe_manager.add_command(rattler_bulk_build)
 conda_recipe_manager.add_command(patch)
+conda_recipe_manager.add_command(bump_recipe)
 
 
 if __name__ == "__main__":

tests/commands/test_bump_recipe.py

@@ -0,0 +1,59 @@
+"""
+:Description: Tests the `bump-recipe` CLI
+"""
+
+from click.testing import CliRunner
+from pyfakefs.fake_filesystem import FakeFilesystem
+
+from conda_recipe_manager.commands import bump_recipe
+from conda_recipe_manager.commands.utils.types import ExitCode
+from tests.file_loading import get_test_path
+from tests.smoke_testing import assert_cli_usage
+
+
+def test_usage() -> None:
+    """
+    Smoke test that ensures rendering of the help menu
+    """
+    assert_cli_usage(bump_recipe.bump_recipe)
+
+
+def test_bump_recipe_cli(fs: FakeFilesystem) -> None:
+    """
+    Test for the case when build number is successfully incremented by 1.
+    :param fs: pyfakefs fixture used to replace the file system
+    """
+    runner = CliRunner()
+    fs.add_real_directory(get_test_path(), read_only=False)
+
+    recipe_file_path = get_test_path() / "simple-recipe.yaml"
+
+    result = runner.invoke(bump_recipe.bump_recipe, ["--build-num", str(recipe_file_path)])
+    assert result.exit_code == ExitCode.SUCCESS
+
+
+def test_bump_recipe_cli_fails(fs: FakeFilesystem) -> None:
+    """
+    Test for the case when build number is not an integer
+    """
+
+    runner = CliRunner()
+    fs.add_real_directory(get_test_path(), read_only=False)
+
+    recipe_file_path = get_test_path() / "bump_recipe/non-int-build-num.yaml"
+
+    result = runner.invoke(bump_recipe.bump_recipe, ["--build-num", str(recipe_file_path)])
+    assert result.exit_code == ExitCode.ILLEGAL_OPERATION
+
+
+def test_build_num_key_not_found(fs: FakeFilesystem) -> None:
+    """
+    Test for the case when build number key is not found in the recipe file.
+    """
+
+    runner = CliRunner()
+    fs.add_real_directory(get_test_path(), read_only=False)
+
+    recipe_file_path = get_test_path() / "bump_recipe/no-build-num.yaml"
+    result = runner.invoke(bump_recipe.bump_recipe, ["--build-num", str(recipe_file_path)])
+    assert result.exit_code == ExitCode.ILLEGAL_OPERATION

tests/test_aux_files/bump_recipe/no-build-num.yaml

@@ -0,0 +1,10 @@
+{% set zz_non_alpha_first = 42 %}
+{% set name = "types-toml" %}
+{% set version = "0.10.8.6" %}
+
+package:
+  name: {{ name|lower }}  # [unix]
+
+build:
+  skip: true  # [py<37]
+  is_true: true

tests/test_aux_files/bump_recipe/non-int-build-num.yaml

@@ -0,0 +1,11 @@
+{% set zz_non_alpha_first = 42 %}
+{% set name = "types-toml" %}
+{% set version = "0.10.8.6" %}
+
+package:
+  name: {{ name|lower }}  # [unix]
+
+build:
+  number: []
+  skip: true  # [py<37]
+  is_true: true