ref: BitbucketServerAPIPath

Author: jianyuan

src/sentry/integrations/bitbucket_server/client.py

@@ -6,6 +6,7 @@
 from requests_oauthlib import OAuth1
 
 from sentry.identity.services.identity.model import RpcIdentity
+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
@@ -16,23 +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"
-
-    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):
     """
     Client for making requests to Bitbucket Server to follow OAuth1 flow.
@@ -259,7 +243,7 @@ def _get_values(self, uri, params, max_pages=1000000):
 
     def check_file(self, repo: Repository, path: str, version: str | None) -> object | None:
         return self.head_cached(
-            path=BitbucketServerAPIPath.source.format(
+            path=BitbucketServerAPIPath.build_source(
                 project=repo.config["project"],
                 repo=repo.config["repo"],
                 path=path,
@@ -271,7 +255,7 @@ def get_file(
         self, repo: Repository, path: str, ref: str | None, codeowners: bool = False
     ) -> str:
         response = self.get_cached(
-            path=BitbucketServerAPIPath.raw.format(
+            path=BitbucketServerAPIPath.build_raw(
                 project=repo.config["project"],
                 repo=repo.config["repo"],
                 path=path,

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) -> 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) -> 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)}"

tests/sentry/integrations/bitbucket_server/test_client.py

@@ -5,8 +5,8 @@
 from requests import Request
 
 from fixtures.bitbucket_server import REPO
-from sentry.integrations.bitbucket_server.client import BitbucketServerAPIPath
 from sentry.integrations.bitbucket_server.integration import BitbucketServerIntegration
+from sentry.integrations.bitbucket_server.utils import BitbucketServerAPIPath
 from sentry.models.repository import Repository
 from sentry.shared_integrations.exceptions import ApiError
 from sentry.shared_integrations.response.base import BaseApiResponse
@@ -111,7 +111,7 @@ def test_get_repo_authentication(self):
     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(
+        url = self.bb_server_client.base_url + BitbucketServerAPIPath.build_source(
             project=self.repo.config["project"],
             repo=self.repo.config["repo"],
             path=path,
@@ -132,7 +132,7 @@ def test_check_file(self):
     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(
+        url = self.bb_server_client.base_url + BitbucketServerAPIPath.build_source(
             project=self.repo.config["project"],
             repo=self.repo.config["repo"],
             path=path,
@@ -152,7 +152,7 @@ def test_check_no_file(self):
     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(
+        url = self.bb_server_client.base_url + BitbucketServerAPIPath.build_raw(
             project=self.repo.config["project"],
             repo=self.repo.config["repo"],
             path=path,
@@ -173,7 +173,7 @@ def test_get_file(self):
     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(
+        url = self.bb_server_client.base_url + BitbucketServerAPIPath.build_source(
             project=self.repo.config["project"],
             repo=self.repo.config["repo"],
             path=path,
@@ -200,13 +200,13 @@ def test_get_codeowner_file(self):
         )
 
         path = ".bitbucket/CODEOWNERS"
-        source_url = self.bb_server_client.base_url + BitbucketServerAPIPath.source.format(
+        source_url = self.bb_server_client.base_url + BitbucketServerAPIPath.build_source(
             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(
+        raw_url = self.bb_server_client.base_url + BitbucketServerAPIPath.build_raw(
             project=self.repo.config["project"],
             repo=self.repo.config["repo"],
             path=path,