Update CopilotBot to use compatible versions of SDK and CLI (#149)

* Update copilotBot to be compatible with latest broken releases of Copilot-SDK and CLI

* Pin copilot-cli and SDK to a compatible versions

* Update copilot tests

* Fix version pinning config line

* Update byok config for CopilotBot testing

* Fix env variable names

* Potential fix for pull request finding

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* Update Test Summary

* Update openai api compatible url for byok

* Update copilotBot byok provider env to just "azure"

* Update wire_api and api_version env variable

* Fix env variable naming

* Run unit tests prior to all other tests

* Bring back the unit tests to the matrix but set the copilot env variables only for ghcp tests

* Set env variable for a particular test case

---------

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Author: 0xba1a

.github/workflows/test.yml

@@ -15,7 +15,7 @@ jobs:
       matrix:
         # Installing ollama model in GitHub Actions runner requires significant disk space.
         # It reduces the space available for browser-based tests
-        test-type: ["unit", "integration", "ollama_local", "slow-browser", "slow-other"]
+        test-type: ["unit", "integration", "ollama_local", "slow-browser", "slow-other", "ghcp"]
         include:
           - test-type: "unit"
             pytest-args: "-m 'unit and not ollama_local'"
@@ -27,6 +27,8 @@ jobs:
             pytest-args: "-m 'slow' test/bot/test_browsing_bot.py"
           - test-type: "slow-other"
             pytest-args: "-m 'slow' --ignore=test/bot/test_browsing_bot.py"
+          - test-type: "ghcp"
+            pytest-args: "-m 'ghcp'"
 
 
     steps:
@@ -87,6 +89,11 @@ jobs:
         run: |
           pip install -e .
 
+      - name: Install GitHub Copilot SDK dependencies for GHCP tests
+        if: matrix.test-type == 'ghcp'
+        run: |
+          pip install "github-copilot-sdk==0.3.0"
+
       - name: Build Docker images for integration tests
         if: matrix.test-type != 'unit'
         run: |
@@ -138,6 +145,15 @@ jobs:
           #Local Model Configuration
           LOCAL_MODEL_NAME: "qwen2.5-coder:latest"
           LOCAL_MODEL_PORT: 11434
+          # CopilotBot Configuration (only populated for ghcp tests)
+          COPILOT_BYOK_API_KEY: ${{ matrix.test-type == 'ghcp' && secrets.AZURE_OPENAI_API_KEY || '' }}
+          COPILOT_BYOK_BASE_URL: ${{ matrix.test-type == 'ghcp' && vars.OPENAI_ENDPOINT || '' }}
+          COPILOT_BYOK_PROVIDER_TYPE: ${{ matrix.test-type == 'ghcp' && 'azure' || '' }}
+          COPILOT_BYOK_MODEL: ${{ matrix.test-type == 'ghcp' && vars.AZURE_OPENAI_DEPLOYMENT_NAME || '' }}
+          COPILOT_BYOK_API_VERSION: ${{ matrix.test-type == 'ghcp' && vars.AZURE_OPENAI_API_VERSION || '' }}
+          COPILOT_BYOK_WIRE_API: ${{ matrix.test-type == 'ghcp' && 'openai' || '' }}
+          # Passing BYOK as arguement. Test: TestCopilotBotBYOKOpenAIIntegration::test_byok_openai_simple_task
+          OPENAI_ENDPOINT: ${{ matrix.test-type == 'ghcp' && vars.OPENAI_ENDPOINT || '' }}
         run: |
           python -m pytest ${{ matrix.pytest-args }} \
             -n auto \
@@ -195,28 +211,30 @@ jobs:
           echo "## Test Results Summary" >> $GITHUB_STEP_SUMMARY
           echo "| Test Type | Status |" >> $GITHUB_STEP_SUMMARY
           echo "|-----------|--------|" >> $GITHUB_STEP_SUMMARY
-          
+
           # Check each test result file and parse for failures
-          for test_type in unit integration ollama_local slow-browser slow-other; do
+          for test_type in unit integration ollama_local slow-browser slow-other ghcp; do
             if [ -f "test-results-${test_type}.xml" ]; then
               failures=$(grep -oP 'failures="\K[0-9]+' "test-results-${test_type}.xml" | head -1)
               errors=$(grep -oP 'errors="\K[0-9]+' "test-results-${test_type}.xml" | head -1)
-              
+
               if [ "${failures:-0}" -eq 0 ] && [ "${errors:-0}" -eq 0 ]; then
                 status="✅ Passed"
               else
                 status="❌ Failed"
               fi
-              
+
               # Format test type name nicely
               case $test_type in
                 unit) name="Unit Tests" ;;
                 integration) name="Integration Tests" ;;
                 ollama_local) name="Ollama Tests" ;;
                 slow-browser) name="Slow Browser Tests" ;;
                 slow-other) name="Slow Other Tests" ;;
+                ghcp) name="GitHub Copilot Tests" ;;
+                *) name="$test_type" ;;
               esac
-              
+
               echo "| ${name} | ${status} |" >> $GITHUB_STEP_SUMMARY
             fi
           done

pyproject.toml

@@ -22,7 +22,7 @@ classifiers = [
 requires-python = ">=3.11"
 
 [project.optional-dependencies]
-ghcp = ["github-copilot-sdk"]
+ghcp = ["github-copilot-sdk==0.3.0"]
 azure_ad = ["azure-identity>=1.15.0"]
 
 [tool.setuptools.dynamic]

pytest.ini

@@ -2,7 +2,7 @@
 testpaths = test
 python_files = test_*.py
 python_functions = test_*
-addopts = 
+addopts =
     -v
     --tb=short
     --strict-markers
@@ -13,3 +13,4 @@ markers =
     integration: Integration tests
     slow: Slow tests
     docker: marks tests that require a running Docker daemon and pull container images
+    ghcp: marks GitHub Copilot related tests

src/microbots/bot/CopilotBot.py

@@ -71,7 +71,7 @@
 _BYOK_ENV_BASE_URL = "COPILOT_BYOK_BASE_URL"
 _BYOK_ENV_API_KEY = "COPILOT_BYOK_API_KEY"
 _BYOK_ENV_BEARER_TOKEN = "COPILOT_BYOK_BEARER_TOKEN"
-_BYOK_ENV_WIRE_API = "COPILOT_BYOK_WIRE_API"
+_BYOK_ENV_WIRE_API = "COPILOT_BYOK_WIRE_API" # openai / responses
 _BYOK_ENV_AZURE_API_VERSION = "COPILOT_BYOK_AZURE_API_VERSION"
 _BYOK_ENV_MODEL = "COPILOT_BYOK_MODEL"
 
@@ -380,6 +380,7 @@ def __init__(
 
         # ── Connect SDK to in-container CLI ─────────────────────────
         container_ip = self.environment.get_ipv4_address()
+        logger.info("🔌 Connecting Copilot SDK to CLI server at %s:%d", container_ip, _CONTAINER_CLI_PORT)
         self._client = CopilotClient(
             ExternalServerConfig(url=f"{container_ip}:{_CONTAINER_CLI_PORT}")
         )
@@ -514,7 +515,8 @@ def _install_copilot_cli(self):
             "curl -fsSL https://deb.nodesource.com/setup_22.x | bash - > /dev/null 2>&1",
             "apt-get install -y -qq nodejs > /dev/null 2>&1",
             # Install copilot-cli globally
-            "npm install -g @github/copilot > /dev/null 2>&1",
+            # NOTE: Pinning to 1.0.39 which is the latest @github/copilot release compatible with github-copilot-sdk==0.3.0 as of May 2026.
+            "npm install -g @github/copilot@1.0.39 > /dev/null 2>&1",
         ]
 
         for cmd in install_commands:
@@ -555,7 +557,7 @@ def _start_copilot_cli_server(self):
         # Start copilot in headless mode in the background
         # Using nohup + & to run it as a background process inside the container's shell
         start_cmd = (
-            f"nohup copilot --headless --port {_CONTAINER_CLI_PORT} "
+            f"nohup copilot --headless --port {_CONTAINER_CLI_PORT} --host 0.0.0.0 "
             f"> /var/log/copilot-cli.log 2>&1 &"
         )
         result = self.environment.execute(start_cmd)
@@ -579,13 +581,15 @@ def _wait_for_cli_ready(self):
         deadline = time.time() + _CLI_STARTUP_TIMEOUT
         while time.time() < deadline:
             try:
+                self.environment.execute("pgrep -f 'copilot.*--headless' || true")
                 sock = _socket.create_connection(
-                    (container_ip, _CONTAINER_CLI_PORT), timeout=2
+                    (container_ip, _CONTAINER_CLI_PORT), timeout=5
                 )
                 sock.close()
                 return
             except (ConnectionRefusedError, OSError):
                 time.sleep(1)
+        self.environment.execute("cat /var/log/copilot-cli.log || true")
         raise TimeoutError(
             f"copilot-cli did not become ready within {_CLI_STARTUP_TIMEOUT}s "
             f"on {container_ip}:{_CONTAINER_CLI_PORT}"

test/bot/test_copilot_bot.py

@@ -147,10 +147,6 @@ def _swap_copilot_sdk_layout(*, session_has_handler: bool, types_has_handler: bo
 # Helpers
 # ---------------------------------------------------------------------------
 
-def _copilot_cli_available():
-    return shutil.which("copilot") is not None
-
-
 def _copilot_sdk_installed():
     try:
         from importlib.metadata import version
@@ -1599,14 +1595,9 @@ def test_run_with_old_sdk_layout_types(self):
 
 
 # ---------------------------------------------------------------------------
-# Integration tests — require real Docker + copilot-cli + auth
+# Integration tests — require real Docker + copilot-SDK + auth
 # ---------------------------------------------------------------------------
 
-_skip_no_copilot_cli = pytest.mark.skipif(
-    not _copilot_cli_available(),
-    reason="GitHub Copilot CLI not installed (copilot not in PATH)",
-)
-
 _skip_no_copilot_sdk = pytest.mark.skipif(
     not _copilot_sdk_installed(),
     reason="github-copilot-sdk not installed (pip install microbots[ghcp])",
@@ -1618,11 +1609,10 @@ def test_run_with_old_sdk_layout_types(self):
 )
 
 
-@_skip_no_copilot_cli
 @_skip_no_copilot_sdk
-@_skip_no_copilot_auth
 @pytest.mark.integration
 @pytest.mark.slow
+@pytest.mark.ghcp
 class TestCopilotBotIntegration:
     """End-to-end integration tests with real Copilot SDK."""
 
@@ -1631,7 +1621,7 @@ def test_simple_task(self, test_repo, issue_1):
         _restore_real_copilot_modules()
         from microbots.bot.CopilotBot import CopilotBot
 
-        issue_text = issue_1[0]
+        issue_text = issue_1[0] + "\nFix the error in the original file."
         verify_function = issue_1[1]
 
         bot = CopilotBot(
@@ -1658,22 +1648,38 @@ def test_simple_task(self, test_repo, issue_1):
 def _byok_openai_available():
     """Check if OpenAI BYOK credentials are configured via env vars."""
     return bool(
-        os.environ.get("OPEN_AI_KEY")
-        and os.environ.get("OPEN_AI_END_POINT")
+        os.environ.get("AZURE_OPENAI_API_KEY")
+        and os.environ.get("AZURE_OPENAI_ENDPOINT")
     )
 
 
 _skip_no_byok_openai = pytest.mark.skipif(
     not _byok_openai_available(),
-    reason="OpenAI BYOK not configured (set OPEN_AI_KEY and OPEN_AI_END_POINT)",
+    reason="OpenAI BYOK not configured (set env variables AZURE_OPENAI_API_KEY and AZURE_OPENAI_ENDPOINT)",
+)
+
+def _azure_ad_auth_available():
+    """Check if Azure AD auth is available via DefaultAzureCredential."""
+    try:
+        from azure.identity import DefaultAzureCredential
+        credential = DefaultAzureCredential()
+        # Attempt to get a token to verify credentials are working
+        credential.get_token("https://cognitiveservices.azure.com/.default")
+        return True
+    except Exception:
+        return False
+
+_skip_no_azure_ad_auth = pytest.mark.skipif(
+    not _azure_ad_auth_available(),
+    reason="Azure AD auth not available (set up DefaultAzureCredential)",
 )
 
 
-@_skip_no_copilot_cli
 @_skip_no_copilot_sdk
 @_skip_no_byok_openai
 @pytest.mark.integration
 @pytest.mark.slow
+@pytest.mark.ghcp
 class TestCopilotBotBYOKOpenAIIntegration:
     """End-to-end integration tests for CopilotBot with OpenAI BYOK."""
 
@@ -1682,22 +1688,68 @@ def test_byok_openai_simple_task(self, test_repo, issue_1):
         _restore_real_copilot_modules()
         from microbots.bot.CopilotBot import CopilotBot
 
+        issue_text = issue_1[0] + "\nFix the error in the original file."
+        verify_function = issue_1[1]
+
+        api_key = os.environ["AZURE_OPENAI_API_KEY"]
+        base_url = os.environ["OPENAI_ENDPOINT"]
+        model = os.getenv(
+            "AZURE_OPENAI_DEPLOYMENT_NAME", "mini-swe-agent-gpt5"
+        )
+
+        bot = CopilotBot(
+            model=model,
+            folder_to_mount=str(test_repo),
+            permission="READ_WRITE",
+            api_key=api_key,
+            base_url=base_url,
+            provider_type="openai",
+        )
+
+        try:
+            assert bot._provider_config is not None
+            assert bot._provider_config["type"] == "openai"
+            assert bot.github_token is None
+
+            result = bot.run(
+                issue_text,
+                timeout_in_seconds=300,
+            )
+            assert result.status is True, f"CopilotBot BYOK run failed: {result.error}"
+            verify_function(test_repo)
+        finally:
+            bot.stop()
+
+    @_skip_no_azure_ad_auth
+    def test_byok_openai_simple_task_with_token_provider(self, test_repo, issue_1):
+        """CopilotBot can fix a simple syntax error using OpenAI BYOK credentials."""
+        _restore_real_copilot_modules()
+        from microbots.bot.CopilotBot import CopilotBot
+
         issue_text = issue_1[0]
         verify_function = issue_1[1]
 
-        api_key = os.environ["OPEN_AI_KEY"]
-        base_url = os.environ["OPEN_AI_END_POINT"]
+        api_key = os.environ["AZURE_OPENAI_API_KEY"]
+        base_url = os.environ["AZURE_OPENAI_ENDPOINT"]
         model = os.getenv(
             "AZURE_OPENAI_DEPLOYMENT_NAME", "mini-swe-agent-gpt5"
         )
 
+        from azure.identity import DefaultAzureCredential
+        credential = DefaultAzureCredential()
+        def get_token():
+                return credential.get_token(
+                    "https://cognitiveservices.azure.com/.default"
+                ).token
+
         bot = CopilotBot(
             model=model,
             folder_to_mount=str(test_repo),
             permission="READ_WRITE",
             api_key=api_key,
             base_url=base_url,
             provider_type="openai",
+            token_provider=get_token,
         )
 
         try:
@@ -1713,3 +1765,4 @@ def test_byok_openai_simple_task(self, test_repo, issue_1):
             verify_function(test_repo)
         finally:
             bot.stop()
+