Merge ~pelpsi/lpci:lpcraft-conda-build-plugin-is-overly-aggressive into lpci:main

[Simone Pelosi]

Added new configurable option recipe-folder

Added a new configurable option (default value ./info) called recipe-folder,
to be able to specify the recipe itself, or the recipe search path.
Using this approach the search path for variant config files will be scoped
to the recipe_folder and its parents.
Added test case.

LP: #1978715

[Dan Ryan (techalchemy)]

this looks like an elegant solution to the problem, thanks for tackling it!

review: Approve

[Colin Watson (cjwatson)]

Please rebase on current lpci to deal with the various renamings, and add a `NEWS.rst` entry; but otherwise this looks fine, thanks.

review: Approve

[Simone Pelosi (pelpsi)]

> Please rebase on current lpci to deal with the various renamings, and add a
> `NEWS.rst` entry; but otherwise this looks fine, thanks.

Thank you Colin, I will also add a new entry in the documentation for this new parameter.

diff --git a/NEWS.rst b/NEWS.rst
index 857ac8a..50dd108 100644
--- a/NEWS.rst
+++ b/NEWS.rst
@@ -11,6 +11,10 @@ Version history
 
 - Add a ``--debug-shell`` flag.
 
+- Add a ``recipe_folder`` parameter to specify
+  the recipe itself, or the recipe search path
+  using conda-build-plugin.
+
 0.0.52 (2023-04-06)
 ===================
 - Fix regression from adding support to snap keys
diff --git a/lpci/plugin/tests/test_plugins.py b/lpci/plugin/tests/test_plugins.py
index cddc68a..b0c5844 100644
--- a/lpci/plugin/tests/test_plugins.py
+++ b/lpci/plugin/tests/test_plugins.py
@@ -484,6 +484,42 @@ class TestPlugins(CommandBaseTestCase):
         )
         self.assertEqual(["PYTHON=3.8", "pip"], plugin_match[0].conda_packages)
 
+    def test_conda_build_plugin_settings(self):
+        config = dedent(
+            """
+            pipeline:
+                - build
+
+            jobs:
+                build:
+                    build-target: info/recipe/parent
+                    series: focal
+                    architectures: amd64
+                    plugin: conda-build
+                    run: |
+                        pip install --upgrade pytest
+        """
+        )
+        config_path = Path(".launchpad.yaml")
+        config_path.write_text(config)
+        config_obj = lpci.config.Config.load(config_path)
+        self.assertEqual(config_obj.jobs["build"][0].plugin, "conda-build")
+        pm = get_plugin_manager(config_obj.jobs["build"][0])
+        plugins = pm.get_plugins()
+        plugin_match = [
+            _ for _ in plugins if _.__class__.__name__ == "CondaBuildPlugin"
+        ]
+        self.assertEqual(
+            [
+                "defaults",
+            ],
+            plugin_match[0].conda_channels,
+        )
+        self.assertEqual(
+            ["PYTHON=3.8", "conda-build"], plugin_match[0].conda_packages
+        )
+        self.assertEqual("./info", plugin_match[0].recipe_folder)
+
     @patch("lpci.commands.run.get_provider")
     @patch("lpci.commands.run.get_host_architecture", return_value="amd64")
     def test_conda_build_plugin(
@@ -561,6 +597,7 @@ class TestPlugins(CommandBaseTestCase):
             ),
             execute_run.call_args_list[0],
         )
+
         self.assertEqual(
             call(
                 [
@@ -679,6 +716,56 @@ class TestPlugins(CommandBaseTestCase):
         ]
         self.assertEqual("info/recipe", plugin_match[0].build_target)
 
+    def test_conda_build_plugin_finds_recipe_custom_folder(self):
+        config = dedent(
+            """
+            pipeline:
+                - build
+
+            jobs:
+                build:
+                    series: focal
+                    architectures: amd64
+                    plugin: conda-build
+                    conda-channels:
+                        - conda-forge
+                    conda-packages:
+                        - mamba
+                        - pip
+                    conda-python: 3.8
+                    recipe-folder: custominfo
+                    run: |
+                        pip install --upgrade pytest
+        """
+        )
+        config_path = Path(".launchpad.yaml")
+        config_path.write_text(config)
+        Path("include/fake_subdir").mkdir(parents=True)
+        Path("custominfo").mkdir(parents=True)
+        Path("custominfo/a.txt").touch()
+        Path("custominfo/b.txt").touch()
+
+        config_obj = lpci.config.Config.load(config_path)
+
+        self.assertRaisesRegex(
+            RuntimeError,
+            "No build target found",
+            get_plugin_manager,
+            config_obj.jobs["build"][0],
+        )
+
+        meta_yaml = Path("custominfo/recipe/meta.yaml")
+        meta_yaml.parent.mkdir(parents=True)
+        meta_yaml.touch()
+
+        self.assertEqual(config_obj.jobs["build"][0].plugin, "conda-build")
+        pm = get_plugin_manager(config_obj.jobs["build"][0])
+        plugins = pm.get_plugins()
+        plugin_match = [
+            _ for _ in plugins if _.__class__.__name__ == "CondaBuildPlugin"
+        ]
+        self.assertEqual("custominfo/recipe", plugin_match[0].build_target)
+
     def test_conda_build_plugin_finds_recipe_with_fake_parent(self):
         config = dedent(
             """
diff --git a/lpci/plugins/plugins.py b/lpci/plugins/plugins.py
index 07745d5..6fe88a2 100644
--- a/lpci/plugins/plugins.py
+++ b/lpci/plugins/plugins.py
@@ -264,12 +264,22 @@ class CondaBuildPlugin(MiniCondaPlugin):
         conda_channels: Optional[List[StrictStr]]
         conda_packages: Optional[List[StrictStr]]
         conda_python: Optional[StrictStr]
+        recipe_folder: Optional[StrictStr]
 
     DEFAULT_CONDA_PACKAGES = ("conda-build",)
+    DEFAULT_RECIPE_FOLDER = "./info"
 
     def get_plugin_config(self) -> "CondaBuildPlugin.Config":
         return cast(CondaBuildPlugin.Config, self.config.plugin_config)
 
+    @property
+    def recipe_folder(self) -> str:
+        recipe_folder = self.DEFAULT_RECIPE_FOLDER
+        plugin_config = self.get_plugin_config()
+        if plugin_config.recipe_folder:
+            recipe_folder = plugin_config.recipe_folder
+        return recipe_folder
+
     @staticmethod
     def _has_recipe(dir_: Path) -> bool:
         return dir_.joinpath("meta.yaml").is_file()
@@ -300,7 +310,7 @@ class CondaBuildPlugin(MiniCondaPlugin):
                         continue
             raise FileNotFoundError
 
-        return _find_recipe_dir(Path("."))
+        return _find_recipe_dir(Path(self.recipe_folder))
 
     def find_build_target(self) -> str:
         def find_parents(pth: Path) -> Path: