Merge pull request #880 from InfuseAI/feature/sc-32156/base-branch-se…

…lection-improvement

[Feature] Improve base branch selection in compare

piperider_cli/cli.py

@@ -444,7 +444,7 @@ def cloud_compare_reports(**kwargs):
 @add_options([
     dbt_select_option_builder(),
     click.option('--modified', default=False, is_flag=True, help='Only compare the modified models.'),
-    click.option('--base-branch', default='main', type=click.STRING, help='Specify the base branch.',
+    click.option('--base-branch', type=click.STRING, help='Specify the base branch for an auto-generated recipe.',
                  show_default=True),
 ])
 @add_options(dbt_related_options)

piperider_cli/recipe_executor.py

@@ -13,25 +13,26 @@
 class RecipeExecutor:
     @staticmethod
     def exec(recipe_name: str, auto_generate_default_recipe: bool = True, select: tuple = None, modified: bool = False,
-             debug=False, base_branch: str = None, target_branch: str = None):
+             debug=False, base_branch: str = None):
         config = Configuration.instance()
         recipe_path = select_recipe_file(recipe_name)
 
-        if recipe_name and (select or modified is True):
+        if recipe_name and (select or modified or base_branch):
             console.print(
-                "[[bold yellow]Warning[/bold yellow]] The recipe will be ignored when --select or --modified is provided."
+                "[[bold yellow]Warning[/bold yellow]] "
+                "The recipe will be ignored when '--select', '--modified' or '--base-branch' is provided."
             )
         if select:
             console.print(
                 f"[[bold green]Select[/bold green]] Manually select the dbt nodes to run by '{','.join(select)}'")
-        if recipe_path is None or select or modified is True:
+        if recipe_path is None or select or modified or base_branch:
             if auto_generate_default_recipe:
                 dbt_project_path = None
                 if config.dataSources and config.dataSources[0].args.get('dbt'):
                     dbt_project_path = os.path.relpath(config.dataSources[0].args.get('dbt', {}).get('projectDir'))
                 # generate a default recipe
                 console.rule("Recipe executor: generate recipe")
-                options = dict(base_branch=base_branch, target_branch=target_branch)
+                options = dict(base_branch=base_branch)
                 if select:
                     options['select'] = select
                 recipe = generate_default_recipe(overwrite_existing=False,

piperider_cli/recipes/default_recipe_generator.py

@@ -6,6 +6,7 @@
 
 from piperider_cli.configuration import FileSystem
 from piperider_cli.dbtutil import load_dbt_project
+from piperider_cli.error import RecipeException
 from piperider_cli.recipes import (RecipeConfiguration,
                                    RecipeDbtField, RecipeModel,
                                    RecipePiperiderField, tool)
@@ -31,7 +32,22 @@ def _create_base_recipe(dbt_project_path=None, options: dict = None) -> RecipeMo
     base = RecipeModel()
 
     if tool().git_branch() is not None:
-        base.branch = options.get('base_branch', 'main') if options else 'main'
+        if options.get('base_branch') is not None:
+            if tool().git_branch(options.get('base_branch')) is not None:
+                base.branch = options.get('base_branch')
+            else:
+                ex = RecipeException(f"Cannot find specified base branch: {options.get('base_branch')}")
+                ex.hint = f"Please check if the specified branch name '{options.get('base_branch')}' is correct."
+                raise ex
+        else:
+            if tool().git_branch('main') is not None:
+                base.branch = 'main'
+            elif tool().git_branch('master') is not None:
+                base.branch = 'master'
+            else:
+                ex = RecipeException("Cannot find default 'main' or 'master' branch")
+                ex.hint = "Please specify the base branch using the '--base-branch' option."
+                raise ex
 
     dbt_project = _read_dbt_project_file(dbt_project_path)
     if dbt_project:
@@ -48,7 +64,7 @@ def _create_base_recipe(dbt_project_path=None, options: dict = None) -> RecipeMo
     return base
 
 
-def _create_target_recipe(dbt_project_path=None, options: dict = None) -> RecipeModel:
+def _create_target_recipe(dbt_project_path=None) -> RecipeModel:
     """
     Create the target recipe
     """
@@ -81,7 +97,7 @@ def generate_default_recipe(overwrite_existing: bool = False,
             console.print('[bold green]Piperider default recipe already exist[/bold green]')
         return None
     base = _create_base_recipe(dbt_project_path, options)
-    target = _create_target_recipe(dbt_project_path, options)
+    target = _create_target_recipe(dbt_project_path)
     recipe = RecipeConfiguration(base=base, target=target)
 
     try:

piperider_cli/recipes/utils.py

@@ -88,9 +88,9 @@ def dryrun_ignored_execute_command_no_outputs(command_line, env: Dict = None):
 
         return proc.returncode
 
-    def git_branch(self):
+    def git_branch(self, obj_name: str = 'HEAD'):
         outs, errs, exit_code = self.dryrun_ignored_execute_command(
-            "git rev-parse --abbrev-ref HEAD"
+            f"git rev-parse --abbrev-ref {obj_name}"
         )
         if exit_code != 0:
             return None
@@ -117,7 +117,8 @@ def git_merge_base(self, a: str, b: str):
                 matched = re.match(r"fatal: Not a valid object name (.*)", errs)
                 ex.message = f"Invalid git branch: {matched.group(1)}"
                 ex.hint = (
-                    f"Please check is the branch name '{matched.group(1)}' correct?"
+                    f"Please check if the base branch name '{matched.group(1)}' is correct in your recipe, "
+                    f"or use the '--base-branch' option to specify the branch name for a new auto-generated recipe."
                 )
             raise ex
         return outs