Fix issue with render ctl command not using branch environment variables (#536)

* Fix branch handling in `_run_transform` and `execute_graphql_query` functions

* Add changelog entry for fixing branch handling in `_run_transform` and `execute_graphql_query` functions

* Remove unused import of `get_branch` from `utils.py`

* Add jinja2 transform and GraphQL query for tags, and implement branch selection test

* Update changelog to specify environment variable usage for branch management in `_run_transform` and `execute_graphql_query` functions.

* Remove unused `get_branch` import and set default branch in `validate_graphql` function

Author: minitriga

changelog/535.fixed.md

@@ -0,0 +1 @@
+Fix branch handling in `_run_transform` and `execute_graphql_query` functions in Infrahubctl to use environment variables for branch management. 

infrahub_sdk/ctl/cli_commands.py

@@ -46,7 +46,7 @@
 from ..schema import MainSchemaTypesAll, SchemaRoot
 from ..template import Jinja2Template
 from ..template.exceptions import JinjaTemplateError
-from ..utils import get_branch, write_to_file
+from ..utils import write_to_file
 from ..yaml import SchemaFile
 from .exporter import dump
 from .importer import load
@@ -208,7 +208,6 @@ async def _run_transform(
         debug: Prints debug info to the command line
         repository_config: Repository config object. This is used to load the graphql query from the repository.
     """
-    branch = get_branch(branch)
 
     try:
         response = execute_graphql_query(

infrahub_sdk/ctl/utils.py

@@ -118,6 +118,10 @@ def execute_graphql_query(
     query_str = query_object.load_query()
 
     client = initialize_client_sync()
+
+    if not branch:
+        branch = client.config.default_infrahub_branch
+
     response = client.execute_graphql(
         query=query_str,
         branch_name=branch,

infrahub_sdk/ctl/validate.py

@@ -14,7 +14,7 @@
 from ..ctl.exceptions import QueryNotFoundError
 from ..ctl.utils import catch_exception, find_graphql_query, parse_cli_vars
 from ..exceptions import GraphQLError
-from ..utils import get_branch, write_to_file
+from ..utils import write_to_file
 from ..yaml import SchemaFile
 from .parameters import CONFIG_PARAM
 from .utils import load_yamlfile_from_disk_and_exit
@@ -68,8 +68,6 @@ def validate_graphql(
 ) -> None:
     """Validate the format of a GraphQL Query stored locally by executing it on a remote GraphQL endpoint"""
 
-    branch = get_branch(branch)
-
     try:
         query_str = find_graphql_query(query)
     except QueryNotFoundError:
@@ -81,6 +79,10 @@ def validate_graphql(
     variables_dict = parse_cli_vars(variables)
 
     client = initialize_client_sync()
+
+    if not branch:
+        branch = client.config.default_infrahub_branch
+
     try:
         response = client.execute_graphql(
             query=query_str,

tests/fixtures/repos/ctl_integration/.infrahub.yml

@@ -26,7 +26,13 @@ generator_definitions:
     parameters:
       name: "name__value"
 
+jinja2_transforms:
+  - name: tags
+    query: "tags_query"
+    template_path: "templates/tags.j2"
 
 queries:
   - name: animal_person
     file_path: queries/animal_person.gql
+  - name: tags_query
+    file_path: templates/tags_query.gql

tests/fixtures/repos/ctl_integration/templates/tags.j2

@@ -0,0 +1 @@
+{{ data['BuiltinTag']['edges'][0]['node']['name']['value'] }}

tests/fixtures/repos/ctl_integration/templates/tags_query.gql

@@ -0,0 +1,11 @@
+query TagsQuery($name: String!) {
+  BuiltinTag(name__value: $name) {
+    edges {
+      node {
+        name {
+          value
+        }
+      }
+    }
+  }
+}

tests/unit/ctl/test_render_app.py

@@ -73,3 +73,44 @@ def test_validate_template_not_found(test_case: RenderAppFailure, httpx_mock: HT
         output = runner.invoke(app, ["render", test_case.template, "name=red"])
         assert test_case.error in strip_color(output.stdout)
         assert output.exit_code == 1
+
+
+@pytest.mark.parametrize(
+    "cli_branch,env_branch,from_git,expected_branch",
+    [
+        ("cli-branch", None, False, "cli-branch"),
+        (None, "env-branch", False, "env-branch"),
+        (None, None, True, "git-branch"),
+    ],
+)
+@requires_python_310
+def test_render_branch_selection(monkeypatch, httpx_mock: HTTPXMock, cli_branch, env_branch, from_git, expected_branch):
+    """Test that the render command uses the correct branch source."""
+
+    if from_git:
+        monkeypatch.setattr("dulwich.porcelain.active_branch", lambda _: b"git-branch")
+
+    httpx_mock.add_response(
+        method="POST",
+        url=f"http://mock/graphql/{expected_branch}",
+        json=json.loads(
+            read_fixture(
+                "red_tag.json",
+                "unit/test_infrahubctl/red_tags_query",
+            )
+        ),
+    )
+
+    with temp_repo_and_cd(source_dir=FIXTURE_BASE_DIR / "ctl_integration"):
+        args = ["render", "tags", "name=red"]
+        env = {}
+        # Add test-specific variables
+        if cli_branch:
+            args.extend(["--branch", cli_branch])
+        if env_branch:
+            env["INFRAHUB_DEFAULT_BRANCH"] = env_branch
+            env["INFRAHUB_DEFAULT_BRANCH_FROM_GIT"] = "false"
+        if from_git:
+            env["INFRAHUB_DEFAULT_BRANCH_FROM_GIT"] = "true"
+        output = runner.invoke(app, args, env=env)
+        assert output.exit_code == 0