Remove default value "main" for branch parameter from all Infrahub CTL commands (#270)

* Remove default value main for branch parameter

* Changelog

* Remove branch parameter from repository commands as node is branch agnostic

* Add None for username

* Remove branch parameter from tests

* Remove branch parameter from test

* Add option to list repository by branch

* Adjust parameter help

Author: BaptisteGi

changelog/264.fixed.md

@@ -0,0 +1 @@
+Remove default value "main" for branch parameter from all Infrahub CTL commands.

infrahub_sdk/ctl/cli_commands.py

@@ -129,7 +129,7 @@ async def run(
     method: str = "run",
     debug: bool = False,
     _: str = CONFIG_PARAM,
-    branch: str = typer.Option("main", help="Branch on which to run the script."),  # TODO: Replace main by None
+    branch: str = typer.Option(None, help="Branch on which to run the script."),
     concurrent: int | None = typer.Option(
         None,
         help="Maximum number of requests to execute at the same time.",

infrahub_sdk/ctl/exporter.py

@@ -22,7 +22,7 @@ def dump(
     directory: Path = typer.Option(directory_name_with_timestamp, help="Directory path to store export"),
     quiet: bool = typer.Option(False, help="No console output"),
     _: str = CONFIG_PARAM,
-    branch: str = typer.Option("main", help="Branch from which to export"),  # TODO: Replace main by None
+    branch: str = typer.Option(None, help="Branch from which to export"),
     concurrent: int = typer.Option(
         4,
         help="Maximum number of requests to execute at the same time.",

infrahub_sdk/ctl/importer.py

@@ -25,7 +25,7 @@ def load(
     ),
     quiet: bool = typer.Option(False, help="No console output"),
     _: str = CONFIG_PARAM,
-    branch: str = typer.Option("main", help="Branch from which to export"),  # TODO: Replace main by None
+    branch: str = typer.Option(None, help="Branch from which to export"),
     concurrent: int | None = typer.Option(
         None,
         help="Maximum number of requests to execute at the same time.",

infrahub_sdk/ctl/menu.py

@@ -27,7 +27,7 @@ def callback() -> None:
 async def load(
     menus: list[Path],
     debug: bool = False,
-    branch: str = typer.Option("main", help="Branch on which to load the menu."),  # TODO: Replace main by None
+    branch: str = typer.Option(None, help="Branch on which to load the menu."),
     _: str = CONFIG_PARAM,
 ) -> None:
     """Load one or multiple menu files into Infrahub."""

infrahub_sdk/ctl/object.py

@@ -27,7 +27,7 @@ def callback() -> None:
 async def load(
     paths: list[Path],
     debug: bool = False,
-    branch: str = typer.Option("main", help="Branch on which to load the objects."),  # TODO: Replace main by None
+    branch: str = typer.Option(None, help="Branch on which to load the objects."),
     _: str = CONFIG_PARAM,
 ) -> None:
     """Load one or multiple objects files into Infrahub."""

infrahub_sdk/ctl/repository.py

@@ -73,7 +73,6 @@ async def add(
     ref: str = "",
     read_only: bool = False,
     debug: bool = False,
-    branch: str = typer.Option("main", help="Branch on which to add the repository."),  # TODO: Replace main by None
     _: str = CONFIG_PARAM,
 ) -> None:
     """Add a new repository."""
@@ -110,18 +109,18 @@ async def add(
         query={"ok": None},
     )
 
-    await client.execute_graphql(query=query.render(), branch_name=branch, tracker="mutation-repository-create")
+    await client.execute_graphql(query=query.render(), tracker="mutation-repository-create")
 
 
 @app.command()
 async def list(
-    branch: str | None = None,
+    branch: str = typer.Option(None, help="Branch on which to list repositories."),
     debug: bool = False,
     _: str = CONFIG_PARAM,
 ) -> None:
     init_logging(debug=debug)
 
-    client = initialize_client(branch=branch)
+    client = initialize_client()
 
     repo_status_query = {
         "CoreGenericRepository": {

infrahub_sdk/ctl/schema.py

@@ -108,7 +108,7 @@ def get_node(schemas_data: list[dict], schema_index: int, node_index: int) -> di
 async def load(
     schemas: list[Path],
     debug: bool = False,
-    branch: str = typer.Option("main", help="Branch on which to load the schema."),  # TODO: Replace main by None
+    branch: str = typer.Option(None, help="Branch on which to load the schema."),
     wait: int = typer.Option(0, help="Time in seconds to wait until the schema has converged across all workers"),
     _: str = CONFIG_PARAM,
 ) -> None:
@@ -159,7 +159,7 @@ async def load(
 async def check(
     schemas: list[Path],
     debug: bool = False,
-    branch: str = typer.Option("main", help="Branch on which to check the schema."),  # TODO: Replace main by None
+    branch: str = typer.Option(None, help="Branch on which to check the schema."),
     _: str = CONFIG_PARAM,
 ) -> None:
     """Check if schema files are valid and what would be the impact of loading them with Infrahub."""

tests/unit/ctl/test_repository_app.py

@@ -74,7 +74,6 @@ def test_repo_no_username_or_password(self, mock_init_client, mock_client) -> No
     }
 }
 """,
-            branch_name="main",
             tracker="mutation-repository-create",
         )
 
@@ -135,7 +134,6 @@ def test_repo_no_username(self, mock_init_client, mock_client) -> None:
     }
 }
 """,
-            branch_name="main",
             tracker="mutation-repository-create",
         )
 
@@ -198,7 +196,6 @@ def test_repo_username(self, mock_init_client, mock_client) -> None:
     }
 }
 """,
-            branch_name="main",
             tracker="mutation-repository-create",
         )
 
@@ -260,7 +257,6 @@ def test_repo_readonly_true(self, mock_init_client, mock_client) -> None:
     }
 }
 """,
-            branch_name="main",
             tracker="mutation-repository-create",
         )
 
@@ -288,8 +284,6 @@ def test_repo_description_commit_branch(self, mock_init_client, mock_client) ->
                 "This is a test description",
                 "--ref",
                 "my-custom-branch",
-                "--branch",
-                "develop",
             ],
         )
         assert output.exit_code == 0
@@ -329,11 +323,10 @@ def test_repo_description_commit_branch(self, mock_init_client, mock_client) ->
     }
 }
 """,
-            branch_name="develop",
             tracker="mutation-repository-create",
         )
 
     def test_repo_list(self, mock_repositories_list) -> None:
-        result = runner.invoke(app, ["repository", "list", "--branch", "main"])
+        result = runner.invoke(app, ["repository", "list"])
         assert result.exit_code == 0
         assert strip_color(result.stdout) == read_fixture("output.txt", "integration/test_infrahubctl/repository_list")