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

Author: jianyuan

src/sentry/integrations/bitbucket_server/client.py

@@ -6,7 +6,7 @@
 from requests_oauthlib import OAuth1
 
 from sentry.identity.services.identity.model import RpcIdentity
-from sentry.integrations.base import IntegrationFeatureNotImplementedError
+from sentry.integrations.bitbucket_server.utils import BitbucketServerAPIPath
 from sentry.integrations.client import ApiClient
 from sentry.integrations.models.integration import Integration
 from sentry.integrations.services.integration.model import RpcIntegration
@@ -17,20 +17,6 @@
 logger = logging.getLogger("sentry.integrations.bitbucket_server")
 
 
-class BitbucketServerAPIPath:
-    """
-    project is the short key of the project
-    repo is the fully qualified slug
-    """
-
-    repository = "/rest/api/1.0/projects/{project}/repos/{repo}"
-    repositories = "/rest/api/1.0/repos"
-    repository_hook = "/rest/api/1.0/projects/{project}/repos/{repo}/webhooks/{id}"
-    repository_hooks = "/rest/api/1.0/projects/{project}/repos/{repo}/webhooks"
-    repository_commits = "/rest/api/1.0/projects/{project}/repos/{repo}/commits"
-    commit_changes = "/rest/api/1.0/projects/{project}/repos/{repo}/commits/{commit}/changes"
-
-
 class BitbucketServerSetupClient(ApiClient):
     """
     Client for making requests to Bitbucket Server to follow OAuth1 flow.
@@ -256,9 +242,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.build_source(
+                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.build_raw(
+                project=repo.config["project"],
+                repo=repo.config["repo"],
+                path=path,
+                sha=ref,
+            ),
+            raw_response=True,
+        )
+        return response.text

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 Server source code with stack
+        trace linking.
+        """,
+        IntegrationFeatures.STACKTRACE_LINK,
+    ),
+    FeatureDescription(
+        """
+        Import your Bitbucket Server [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 = {
@@ -244,6 +256,8 @@ class BitbucketServerIntegration(RepositoryIntegration):
     IntegrationInstallation implementation for Bitbucket Server
     """
 
+    codeowners_locations = [".bitbucket/CODEOWNERS"]
+
     @property
     def integration_name(self) -> str:
         return "bitbucket_server"
@@ -307,16 +321,40 @@ 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
+        if repo.url is None:
+            return ""
+        parsed_repo_url = urlparse(repo.url)
+        parsed_url = urlparse(url)
+        return parsed_url.path.replace(parsed_repo_url.path + "/", "")
 
     # Bitbucket Server only methods
 
@@ -331,7 +369,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]:

src/sentry/integrations/bitbucket_server/utils.py

@@ -0,0 +1,37 @@
+from urllib.parse import quote, urlencode
+
+
+class BitbucketServerAPIPath:
+    """
+    project is the short key of the project
+    repo is the fully qualified slug
+    """
+
+    repository = "/rest/api/1.0/projects/{project}/repos/{repo}"
+    repositories = "/rest/api/1.0/repos"
+    repository_hook = "/rest/api/1.0/projects/{project}/repos/{repo}/webhooks/{id}"
+    repository_hooks = "/rest/api/1.0/projects/{project}/repos/{repo}/webhooks"
+    repository_commits = "/rest/api/1.0/projects/{project}/repos/{repo}/commits"
+    commit_changes = "/rest/api/1.0/projects/{project}/repos/{repo}/commits/{commit}/changes"
+
+    @staticmethod
+    def build_raw(project: str, repo: str, path: str, sha: str | None) -> str:
+        project = quote(project)
+        repo = quote(repo)
+
+        params = {}
+        if sha:
+            params["at"] = sha
+
+        return f"/projects/{project}/repos/{repo}/raw/{path}?{urlencode(params)}"
+
+    @staticmethod
+    def build_source(project: str, repo: str, path: str, sha: str | None) -> str:
+        project = quote(project)
+        repo = quote(repo)
+
+        params = {}
+        if sha:
+            params["at"] = sha
+
+        return f"/rest/api/1.0/projects/{project}/repos/{repo}/browse/{path}?{urlencode(params)}"

src/sentry/models/commitfilechange.py

@@ -52,6 +52,7 @@ def is_valid_type(value: str) -> bool:
 
 def process_resource_change(instance, **kwargs):
     from sentry.integrations.bitbucket.integration import BitbucketIntegration
+    from sentry.integrations.bitbucket_server.integration import BitbucketServerIntegration
     from sentry.integrations.github.integration import GitHubIntegration
     from sentry.integrations.gitlab.integration import GitlabIntegration
     from sentry.integrations.vsts.integration import VstsIntegration
@@ -62,6 +63,7 @@ def _spawn_task():
             set(GitHubIntegration.codeowners_locations)
             | set(GitlabIntegration.codeowners_locations)
             | set(BitbucketIntegration.codeowners_locations)
+            | set(BitbucketServerIntegration.codeowners_locations)
             | set(VstsIntegration.codeowners_locations)
         )