Make GitHub app installation optional during init

Author: mohamedashrraf222

codeflash/cli_cmds/init_auth.py

@@ -147,7 +147,17 @@ def enter_api_key_and_save_to_rc() -> None:
     os.environ["CODEFLASH_API_KEY"] = api_key
 
 
+def _skip_github_app_installation(owner: str, repo: str) -> None:
+    click.echo(
+        f"Skipping Codeflash GitHub app installation for {owner}/{repo}.{LF}"
+        "Codeflash setup will continue, but PR creation will stay disabled until you install the app later."
+        f"{LF}In the meantime you can make local only optimizations by using the '--no-pr' flag with codeflash.{LF}"
+    )
+
+
 def install_github_app(git_remote: str) -> None:
+    from rich.prompt import Confirm
+
     try:
         git_repo = git.Repo(search_parent_directories=True)
     except git.InvalidGitRepositoryError:
@@ -167,6 +177,17 @@ def install_github_app(git_remote: str) -> None:
 
     else:
         try:
+            should_install = Confirm.ask(
+                "Do you want to install the Codeflash GitHub app now? You can skip this and continue setup, "
+                "but Codeflash won't be able to create PRs until the app is installed.",
+                default=True,
+                show_default=True,
+                console=console,
+            )
+            if not should_install:
+                _skip_github_app_installation(owner, repo)
+                return
+
             click.prompt(
                 f"Finally, you'll need to install the Codeflash GitHub app by choosing the repository you want to install Codeflash on.{LF}"
                 f"I will attempt to open the github app page - https://github.com/apps/codeflash-ai/installations/select_target {LF}"
@@ -188,11 +209,7 @@ def install_github_app(git_remote: str) -> None:
             count = 2
             while not is_github_app_installed_on_repo(owner, repo, suppress_errors=True):
                 if count == 0:
-                    click.echo(
-                        f"❌ It looks like the Codeflash GitHub App is not installed on the repository {owner}/{repo}.{LF}"
-                        f"You won't be able to create PRs with Codeflash until you install the app.{LF}"
-                        f"In the meantime you can make local only optimizations by using the '--no-pr' flag with codeflash.{LF}"
-                    )
+                    _skip_github_app_installation(owner, repo)
                     break
                 click.prompt(
                     f"❌ It looks like the Codeflash GitHub App is not installed on the repository {owner}/{repo}.{LF}"
@@ -207,3 +224,4 @@ def install_github_app(git_remote: str) -> None:
         except (KeyboardInterrupt, EOFError, click.exceptions.Abort):
             # leave empty line for the next prompt to be properly rendered
             click.echo()
+            _skip_github_app_installation(owner, repo)

tests/test_init_auth.py

@@ -0,0 +1,74 @@
+from __future__ import annotations
+
+from unittest.mock import Mock, patch
+
+from codeflash.cli_cmds.init_auth import install_github_app
+
+
+def _echo_messages(mock: Mock) -> list[str]:
+    return [str(call.args[0]) for call in mock.call_args_list if call.args]
+
+
+def _mock_repo_context(monkeypatch) -> None:
+    git_repo = object()
+    monkeypatch.setattr("codeflash.cli_cmds.init_auth.git.Repo", Mock(return_value=git_repo))
+    monkeypatch.setattr("codeflash.cli_cmds.init_auth.get_git_remotes", Mock(return_value=["origin"]))
+    monkeypatch.setattr("codeflash.cli_cmds.init_auth.get_repo_owner_and_name", Mock(return_value=("octocat", "demo")))
+
+
+def test_install_github_app_allows_user_to_skip(monkeypatch) -> None:
+    _mock_repo_context(monkeypatch)
+    monkeypatch.setattr("codeflash.cli_cmds.init_auth.is_github_app_installed_on_repo", Mock(return_value=False))
+    echo = Mock()
+    prompt = Mock()
+    launch = Mock()
+    monkeypatch.setattr("codeflash.cli_cmds.init_auth.click.echo", echo)
+    monkeypatch.setattr("codeflash.cli_cmds.init_auth.click.prompt", prompt)
+    monkeypatch.setattr("codeflash.cli_cmds.init_auth.click.launch", launch)
+
+    with patch("rich.prompt.Confirm.ask", return_value=False) as confirm_ask:
+        install_github_app("origin")
+
+    confirm_ask.assert_called_once()
+    prompt.assert_not_called()
+    launch.assert_not_called()
+    assert any("Skipping Codeflash GitHub app installation for octocat/demo." in message for message in _echo_messages(echo))
+
+
+def test_install_github_app_skips_on_noninteractive_abort(monkeypatch) -> None:
+    _mock_repo_context(monkeypatch)
+    monkeypatch.setattr("codeflash.cli_cmds.init_auth.is_github_app_installed_on_repo", Mock(return_value=False))
+    echo = Mock()
+    prompt = Mock()
+    launch = Mock()
+    monkeypatch.setattr("codeflash.cli_cmds.init_auth.click.echo", echo)
+    monkeypatch.setattr("codeflash.cli_cmds.init_auth.click.prompt", prompt)
+    monkeypatch.setattr("codeflash.cli_cmds.init_auth.click.launch", launch)
+
+    with patch("rich.prompt.Confirm.ask", side_effect=EOFError):
+        install_github_app("origin")
+
+    prompt.assert_not_called()
+    launch.assert_not_called()
+    assert any("Skipping Codeflash GitHub app installation for octocat/demo." in message for message in _echo_messages(echo))
+
+
+def test_install_github_app_still_runs_install_flow_when_confirmed(monkeypatch) -> None:
+    _mock_repo_context(monkeypatch)
+    monkeypatch.setattr(
+        "codeflash.cli_cmds.init_auth.is_github_app_installed_on_repo",
+        Mock(side_effect=[False, True]),
+    )
+    echo = Mock()
+    prompt = Mock(return_value="")
+    launch = Mock()
+    monkeypatch.setattr("codeflash.cli_cmds.init_auth.click.echo", echo)
+    monkeypatch.setattr("codeflash.cli_cmds.init_auth.click.prompt", prompt)
+    monkeypatch.setattr("codeflash.cli_cmds.init_auth.click.launch", launch)
+
+    with patch("rich.prompt.Confirm.ask", return_value=True) as confirm_ask:
+        install_github_app("origin")
+
+    confirm_ask.assert_called_once()
+    launch.assert_called_once_with("https://github.com/apps/codeflash-ai/installations/select_target")
+    assert prompt.call_count == 2