feat(bitbucket-server): CODEOWNERS support and stacktrace linking

jianyuan · jianyuan · commit f0f7151a20c5 · 2025-03-10T21:48:57.000Z
diff --git a/src/sentry/integrations/bitbucket_server/client.py b/src/sentry/integrations/bitbucket_server/client.py
@@ -6,7 +6,6 @@
 from requests_oauthlib import OAuth1
 
 from sentry.identity.services.identity.model import RpcIdentity
-from sentry.integrations.base import IntegrationFeatureNotImplementedError
 from sentry.integrations.client import ApiClient
 from sentry.integrations.models.integration import Integration
 from sentry.integrations.services.integration.model import RpcIntegration
@@ -30,6 +29,9 @@ class BitbucketServerAPIPath:
     repository_commits = "/rest/api/1.0/projects/{project}/repos/{repo}/commits"
     commit_changes = "/rest/api/1.0/projects/{project}/repos/{repo}/commits/{commit}/changes"
 
+    raw = "/projects/{project}/repos/{repo}/raw/{path}?at={sha}"
+    source = "/rest/api/1.0/projects/{project}/repos/{repo}/browse/{path}?at={sha}"
+
 
 class BitbucketServerSetupClient(ApiClient):
     """
@@ -256,9 +258,25 @@ def _get_values(self, uri, params, max_pages=1000000):
         return values
 
     def check_file(self, repo: Repository, path: str, version: str | None) -> object | None:
-        raise IntegrationFeatureNotImplementedError
+        return self.head_cached(
+            path=BitbucketServerAPIPath.source.format(
+                project=repo.config["project"],
+                repo=repo.config["repo"],
+                path=path,
+                sha=version,
+            ),
+        )
 
     def get_file(
         self, repo: Repository, path: str, ref: str | None, codeowners: bool = False
     ) -> str:
-        raise IntegrationFeatureNotImplementedError
+        response = self.get_cached(
+            path=BitbucketServerAPIPath.raw.format(
+                project=repo.config["project"],
+                repo=repo.config["repo"],
+                path=path,
+                sha=ref,
+            ),
+            raw_response=True,
+        )
+        return response.text
diff --git a/src/sentry/integrations/bitbucket_server/integration.py b/src/sentry/integrations/bitbucket_server/integration.py
@@ -2,7 +2,7 @@
 
 from collections.abc import Mapping
 from typing import Any
-from urllib.parse import urlparse
+from urllib.parse import parse_qs, quote, urlencode, urlparse
 
 from cryptography.hazmat.backends import default_backend
 from cryptography.hazmat.primitives.serialization import load_pem_private_key
@@ -19,7 +19,6 @@
     FeatureDescription,
     IntegrationData,
     IntegrationDomain,
-    IntegrationFeatureNotImplementedError,
     IntegrationFeatures,
     IntegrationMetadata,
     IntegrationProvider,
@@ -62,6 +61,19 @@
         """,
         IntegrationFeatures.COMMITS,
     ),
+    FeatureDescription(
+        """
+        Link your Sentry stack traces back to your Bitbucket source code with stack
+        trace linking.
+        """,
+        IntegrationFeatures.STACKTRACE_LINK,
+    ),
+    FeatureDescription(
+        """
+        Import your Bitbucket [CODEOWNERS file](https://support.atlassian.com/bitbucket-cloud/docs/set-up-and-use-code-owners/) and use it alongside your ownership rules to assign Sentry issues.
+        """,
+        IntegrationFeatures.CODEOWNERS,
+    ),
 ]
 
 setup_alert = {
@@ -246,6 +258,8 @@ class BitbucketServerIntegration(RepositoryIntegration):
 
     default_identity = None
 
+    codeowners_locations = [".bitbucket/CODEOWNERS"]
+
     @property
     def integration_name(self) -> str:
         return "bitbucket_server"
@@ -312,16 +326,38 @@ def get_unmigratable_repositories(self):
         return list(filter(lambda repo: repo.name not in accessible_repos, repos))
 
     def source_url_matches(self, url: str) -> bool:
-        raise IntegrationFeatureNotImplementedError
+        return url.startswith(self.model.metadata["base_url"])
 
     def format_source_url(self, repo: Repository, filepath: str, branch: str | None) -> str:
-        raise IntegrationFeatureNotImplementedError
+        project = quote(repo.config["project"])
+        repo_name = quote(repo.config["repo"])
+        source_url = f"{self.model.metadata["base_url"]}/projects/{project}/repos/{repo_name}/browse/{filepath}"
+
+        if branch:
+            source_url += "?" + urlencode({"at": branch})
+
+        return source_url
 
     def extract_branch_from_source_url(self, repo: Repository, url: str) -> str:
-        raise IntegrationFeatureNotImplementedError
+        parsed_url = urlparse(url)
+        qs = parse_qs(parsed_url.query)
+
+        if "at" in qs and len(qs["at"]) == 1:
+            branch = qs["at"][0]
+
+            # branch name may be prefixed with refs/heads/, so we strip that
+            refs_prefix = "refs/heads/"
+            if branch.startswith(refs_prefix):
+                branch = branch[len(refs_prefix) :]
+
+            return branch
+
+        return ""
 
     def extract_source_path_from_source_url(self, repo: Repository, url: str) -> str:
-        raise IntegrationFeatureNotImplementedError
+        parsed_repo_url = urlparse(repo.url)
+        parsed_url = urlparse(url)
+        return parsed_url.path.replace(parsed_repo_url.path + "/", "")
 
     # Bitbucket Server only methods
 
@@ -336,7 +372,13 @@ class BitbucketServerIntegrationProvider(IntegrationProvider):
     metadata = metadata
     integration_cls = BitbucketServerIntegration
     needs_default_identity = True
-    features = frozenset([IntegrationFeatures.COMMITS])
+    features = frozenset(
+        [
+            IntegrationFeatures.COMMITS,
+            IntegrationFeatures.STACKTRACE_LINK,
+            IntegrationFeatures.CODEOWNERS,
+        ]
+    )
     setup_dialog_config = {"width": 1030, "height": 1000}
 
     def get_pipeline_views(self) -> list[PipelineView]:
diff --git a/src/sentry/models/commitfilechange.py b/src/sentry/models/commitfilechange.py
@@ -48,13 +48,16 @@ def is_valid_type(value: str) -> bool:
 
 
 def process_resource_change(instance, **kwargs):
+    from sentry.integrations.bitbucket_server.integration import BitbucketServerIntegration
     from sentry.integrations.github.integration import GitHubIntegration
     from sentry.integrations.gitlab.integration import GitlabIntegration
     from sentry.tasks.codeowners import code_owners_auto_sync
 
     def _spawn_task():
-        filepaths = set(GitHubIntegration.codeowners_locations) | set(
-            GitlabIntegration.codeowners_locations
+        filepaths = (
+            set(GitHubIntegration.codeowners_locations)
+            | set(GitlabIntegration.codeowners_locations)
+            | set(BitbucketServerIntegration.codeowners_locations)
         )
 
         # CODEOWNERS file added or modified, trigger auto-sync
diff --git a/tests/sentry/integrations/bitbucket_server/test_client.py b/tests/sentry/integrations/bitbucket_server/test_client.py
@@ -1,20 +1,30 @@
 import orjson
+import pytest
 import responses
 from django.test import override_settings
 from requests import Request
 
 from fixtures.bitbucket_server import REPO
-from sentry.integrations.bitbucket_server.client import (
-    BitbucketServerAPIPath,
-    BitbucketServerClient,
-)
+from sentry.integrations.bitbucket_server.client import BitbucketServerAPIPath
+from sentry.integrations.bitbucket_server.integration import BitbucketServerIntegration
+from sentry.models.repository import Repository
+from sentry.shared_integrations.exceptions import ApiError
+from sentry.shared_integrations.response.base import BaseApiResponse
+from sentry.silo.base import SiloMode
 from sentry.testutils.cases import BaseTestCase, TestCase
-from sentry.testutils.silo import control_silo_test
+from sentry.testutils.helpers.integrations import get_installation_of_type
+from sentry.testutils.silo import assume_test_silo_mode, control_silo_test
 from tests.sentry.integrations.jira_server import EXAMPLE_PRIVATE_KEY
 
 control_address = "http://controlserver"
 secret = "hush-hush-im-invisible"
 
+BITBUCKET_SERVER_CODEOWNERS = {
+    "filepath": ".bitbucket/CODEOWNERS",
+    "html_url": "https://bitbucket.example.com/projects/PROJ/repos/repository-name/browse/.bitbucket/CODEOWNERS?at=master",
+    "raw": "docs/* @jianyuan @getsentry/ecosystem\n* @jianyuan\n",
+}
+
 
 @override_settings(
     SENTRY_SUBNET_SECRET=secret,
@@ -44,8 +54,23 @@ def setUp(self):
         self.integration.add_organization(
             self.organization, self.user, default_auth_id=self.identity.id
         )
-        self.install = self.integration.get_installation(self.organization.id)
-        self.bb_server_client: BitbucketServerClient = self.install.get_client()
+        self.install = get_installation_of_type(
+            BitbucketServerIntegration, self.integration, self.organization.id
+        )
+        self.bb_server_client = self.install.get_client()
+
+        with assume_test_silo_mode(SiloMode.REGION):
+            self.repo = Repository.objects.create(
+                provider=self.integration.provider,
+                name="PROJ/repository-name",
+                organization_id=self.organization.id,
+                config={
+                    "name": "TEST/repository-name",
+                    "project": "PROJ",
+                    "repo": "repository-name",
+                },
+                integration_id=self.integration.id,
+            )
 
     def test_authorize_request(self):
         method = "GET"
@@ -81,3 +106,126 @@ def test_get_repo_authentication(self):
 
         assert len(responses.calls) == 1
         assert "oauth_consumer_key" in responses.calls[0].request.headers["Authorization"]
+
+    @responses.activate
+    def test_check_file(self):
+        path = "src/sentry/integrations/bitbucket_server/client.py"
+        version = "master"
+        url = self.bb_server_client.base_url + BitbucketServerAPIPath.source.format(
+            project=self.repo.config["project"],
+            repo=self.repo.config["repo"],
+            path=path,
+            sha=version,
+        )
+
+        responses.add(
+            responses.HEAD,
+            url=url,
+            status=200,
+        )
+
+        resp = self.bb_server_client.check_file(self.repo, path, version)
+        assert isinstance(resp, BaseApiResponse)
+        assert resp.status_code == 200
+
+    @responses.activate
+    def test_check_no_file(self):
+        path = "src/santry/integrations/bitbucket_server/client.py"
+        version = "master"
+        url = self.bb_server_client.base_url + BitbucketServerAPIPath.source.format(
+            project=self.repo.config["project"],
+            repo=self.repo.config["repo"],
+            path=path,
+            sha=version,
+        )
+
+        responses.add(
+            responses.HEAD,
+            url=url,
+            status=404,
+        )
+
+        with pytest.raises(ApiError):
+            self.bb_server_client.check_file(self.repo, path, version)
+
+    @responses.activate
+    def test_get_file(self):
+        path = "src/sentry/integrations/bitbucket_server/client.py"
+        version = "master"
+        url = self.bb_server_client.base_url + BitbucketServerAPIPath.raw.format(
+            project=self.repo.config["project"],
+            repo=self.repo.config["repo"],
+            path=path,
+            sha=version,
+        )
+
+        responses.add(
+            responses.GET,
+            url=url,
+            body="Hello, world!",
+            status=200,
+        )
+
+        resp = self.bb_server_client.get_file(self.repo, path, version)
+        assert resp == "Hello, world!"
+
+    @responses.activate
+    def test_get_stacktrace_link(self):
+        path = "src/sentry/integrations/bitbucket/client.py"
+        version = "master"
+        url = self.bb_server_client.base_url + BitbucketServerAPIPath.source.format(
+            project=self.repo.config["project"],
+            repo=self.repo.config["repo"],
+            path=path,
+            sha=version,
+        )
+
+        responses.add(
+            method=responses.HEAD,
+            url=url,
+            status=200,
+        )
+
+        source_url = self.install.get_stacktrace_link(self.repo, path, "master", version)
+        assert (
+            source_url
+            == "https://bitbucket.example.com/projects/PROJ/repos/repository-name/browse/src/sentry/integrations/bitbucket/client.py?at=master"
+        )
+
+    @responses.activate
+    def test_get_codeowner_file(self):
+        self.config = self.create_code_mapping(
+            repo=self.repo,
+            project=self.project,
+        )
+
+        path = ".bitbucket/CODEOWNERS"
+        source_url = self.bb_server_client.base_url + BitbucketServerAPIPath.source.format(
+            project=self.repo.config["project"],
+            repo=self.repo.config["repo"],
+            path=path,
+            sha=self.config.default_branch,
+        )
+        raw_url = self.bb_server_client.base_url + BitbucketServerAPIPath.raw.format(
+            project=self.repo.config["project"],
+            repo=self.repo.config["repo"],
+            path=path,
+            sha=self.config.default_branch,
+        )
+
+        responses.add(
+            method=responses.HEAD,
+            url=source_url,
+            status=200,
+        )
+        responses.add(
+            method=responses.GET,
+            url=raw_url,
+            content_type="text/plain",
+            body=BITBUCKET_SERVER_CODEOWNERS["raw"],
+        )
+
+        result = self.install.get_codeowner_file(
+            self.config.repository, ref=self.config.default_branch
+        )
+        assert result == BITBUCKET_SERVER_CODEOWNERS
diff --git a/tests/sentry/integrations/bitbucket_server/test_integration.py b/tests/sentry/integrations/bitbucket_server/test_integration.py
