Fix/tf include tf extra params for install (#2779)

Fix/tf include tf extra params for install

TODO:

 Write new tests or update the old ones to cover new functionality.
 Update doc-strings where appropriate.
 Update or write new documentation in packit/packit.dev.
 ‹fill in›



RELEASE NOTES BEGIN
tf_extra_params should now be included when submitting the automatic upstream installability check to the Testing Farm.
RELEASE NOTES END

Reviewed-by: Laura Barcziová

Author: softwarefactory-project-zuul[bot]

packit_service/worker/helpers/testing_farm.py

@@ -446,6 +446,26 @@ def is_final(v):
             for payload_el, params_el in zip(payload, params):
                 cls._merge_payload_with_extra_params(payload_el, params_el)
 
+    def _inject_extra_params(self, payload: dict) -> dict:
+        if not hasattr(self.job_config, "tf_extra_params"):
+            return payload
+
+        extra_params = self.job_config.tf_extra_params
+        # Merge only some subtrees, we do not want the user to override notification or api_key!
+        for subtree in TESTING_FARM_EXTRA_PARAM_MERGED_SUBTREES:
+            if subtree not in extra_params:
+                continue
+
+            if subtree not in payload:
+                payload[subtree] = extra_params[subtree]
+            else:
+                self._merge_payload_with_extra_params(
+                    payload[subtree],
+                    extra_params[subtree],
+                )
+
+        return payload
+
     @classmethod
     def _handle_extra_artifacts(cls, payload: Any, extra_params_artifacts: Any):
         """
@@ -599,23 +619,7 @@ def _payload(
             },
         }
 
-        if hasattr(self.job_config, "tf_extra_params"):
-            extra_params = self.job_config.tf_extra_params
-        else:
-            extra_params = {}
-        # Merge only some subtrees, we do not want the user to override notification or api_key!
-        for subtree in TESTING_FARM_EXTRA_PARAM_MERGED_SUBTREES:
-            if subtree not in extra_params:
-                continue
-            if subtree not in payload:
-                payload[subtree] = extra_params[subtree]
-            else:
-                self._merge_payload_with_extra_params(
-                    payload[subtree],
-                    extra_params[subtree],
-                )
-
-        return payload
+        return self._inject_extra_params(payload)
 
     def _payload_install_test(self, build_id: int, target: str, compose: str) -> dict:
         """
@@ -625,31 +629,41 @@ def _payload_install_test(self, build_id: int, target: str, compose: str) -> dic
         """
         copr_build = CoprBuildTargetModel.get_by_build_id(build_id)
         distro, arch = target.rsplit("-", 1)
-        return {
-            "api_key": self.service_config.testing_farm_secret,
-            "test": {
-                "tmt": {
-                    "url": TESTING_FARM_INSTALLABILITY_TEST_URL,
-                    "ref": TESTING_FARM_INSTALLABILITY_TEST_REF,
-                    "name": "/packit/installation",
-                },
-            },
-            "environments": [
-                {
-                    "arch": arch,
-                    "os": {"compose": compose},
-                    "variables": {
-                        "REPOSITORY": f"{copr_build.owner}/{copr_build.project_name}",
+        return self._inject_extra_params(
+            {
+                "api_key": self.service_config.testing_farm_secret,
+                "test": {
+                    "tmt": {
+                        "url": TESTING_FARM_INSTALLABILITY_TEST_URL,
+                        "ref": TESTING_FARM_INSTALLABILITY_TEST_REF,
+                        "name": "/packit/installation",
                     },
                 },
-            ],
-            "notification": {
-                "webhook": {
-                    "url": f"{self.api_url}/testing-farm/results",
-                    "token": self.service_config.testing_farm_secret,
+                "environments": [
+                    {
+                        "arch": arch,
+                        "os": {"compose": compose},
+                        "variables": {
+                            "REPOSITORY": f"{copr_build.owner}/{copr_build.project_name}",
+                        },
+                        "tmt": {
+                            "context": {
+                                "distro": distro,
+                                "arch": arch,
+                                "trigger": "commit",
+                                "initiator": "packit",
+                            },
+                        },
+                    },
+                ],
+                "notification": {
+                    "webhook": {
+                        "url": f"{self.api_url}/testing-farm/results",
+                        "token": self.service_config.testing_farm_secret,
+                    },
                 },
-            },
-        }
+            }
+        )
 
     def check_comment_pr_argument_and_report(self) -> bool:
         """

tests/unit/test_testing_farm.py

@@ -30,6 +30,7 @@
 )
 from packit_service.models import (
     BuildStatus,
+    CoprBuildTargetModel,
     PipelineModel,
     ProjectEventModel,
     ProjectEventModelType,
@@ -1002,7 +1003,7 @@ def test_merge_payload_with_extra_params(payload, params, result):
     assert payload == result
 
 
-def test_merge_extra_params_with_install():
+def test_merge_extra_params():
     tf_settings = {"provisioning": {"tags": {"BusinessUnit": "sst_upgrades"}}}
 
     service_config = flexmock(
@@ -1058,6 +1059,63 @@ def test_merge_extra_params_with_install():
     )
 
 
+def test_merge_extra_params_with_install():
+    tf_settings = {"provisioning": {"tags": {"BusinessUnit": "sst_upgrades"}}}
+
+    service_config = flexmock(
+        testing_farm_secret="secret token",
+        deployment="prod",
+        comment_command_prefix="/packit-dev",
+    )
+    package_config = flexmock()
+    project = flexmock(full_repo_name="test/merge")
+    metadata = flexmock(
+        commit_sha="0000000",
+        pr_id=None,
+        tag_name=None,
+        event_dict={"comment": ""},
+    )
+    db_project_event = (
+        flexmock().should_receive("get_project_event_object").and_return(flexmock()).mock()
+    )
+    flexmock(CoprBuildTargetModel).should_receive("get_by_build_id").with_args(1234).and_return(
+        flexmock(
+            owner="packit",
+            project_name="packit",
+        )
+    )
+    job_config = flexmock(
+        fmf_url="https://github.com/fmf/",
+        fmf_ref="main",
+        fmf_path="/",
+        tmt_plan=None,
+        upstream_package_name="test",
+        upstream_project_url="https://github.com/test",
+        downstream_package_name="test",
+        downstream_project_url="https://src.fedoraproject.org/test",
+        use_internal_tf=False,
+        tf_extra_params={
+            "environments": [
+                {"tmt": {"context": {"distro": "rhel-7.9"}}, "settings": tf_settings},
+            ],
+        },
+    )
+    helper = TFJobHelper(
+        service_config,
+        package_config,
+        project,
+        metadata,
+        db_project_event,
+        job_config,
+    )
+
+    payload = helper._payload_install_test(1234, "rhel-7.9", "rhel-7.9")
+    assert (
+        payload["environments"][0]["settings"]["provisioning"]["tags"]["BusinessUnit"]
+        == "sst_upgrades"
+    )
+
+
 @pytest.mark.parametrize(
     (
         "fmf_url",