Skip to content

🙌 OpenHands: AI-Driven Development

fix(bitbucket): Replace deprecated/deleted API (#14363)

Chris Bagwell15423fbe4b53
diff --git a/frontend/src/components/features/settings/git-settings/bitbucket-token-help-anchor.tsx b/frontend/src/components/features/settings/git-settings/bitbucket-token-help-anchor.tsx
index 2e2d83351a..e17434eae4 100644
--- a/frontend/src/components/features/settings/git-settings/bitbucket-token-help-anchor.tsx
+++ b/frontend/src/components/features/settings/git-settings/bitbucket-token-help-anchor.tsx
@@ -12,7 +12,7 @@ export function BitbucketTokenHelpAnchor() {
<a
key="bitbucket-token-help-anchor-link"
aria-label={t(I18nKey.GIT$BITBUCKET_TOKEN_HELP_LINK)}
- href="https://bitbucket.org/account/settings/app-passwords/new?scopes=repository:write,pullrequest:write,issue:write"
+ href="https://bitbucket.org/account/settings/api-tokens/"
target="_blank"
className="underline underline-offset-2"
rel="noopener noreferrer"
@@ -20,7 +20,7 @@ export function BitbucketTokenHelpAnchor() {
<a
key="bitbucket-token-help-anchor-link-2"
aria-label={t(I18nKey.GIT$BITBUCKET_TOKEN_SEE_MORE_LINK)}
- href="https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/"
+ href="https://support.atlassian.com/bitbucket-cloud/docs/api-tokens/"
target="_blank"
className="underline underline-offset-2"
rel="noopener noreferrer"
diff --git a/frontend/src/components/features/settings/git-settings/bitbucket-token-input.tsx b/frontend/src/components/features/settings/git-settings/bitbucket-token-input.tsx
index f205ba2ded..32b1ccefcf 100644
--- a/frontend/src/components/features/settings/git-settings/bitbucket-token-input.tsx
+++ b/frontend/src/components/features/settings/git-settings/bitbucket-token-input.tsx
@@ -33,7 +33,7 @@ export function BitbucketTokenInput({
label={t(I18nKey.BITBUCKET$TOKEN_LABEL)}
type="password"
className="w-full max-w-[680px]"
- placeholder={isBitbucketTokenSet ? "<hidden>" : "username:app_password"}
+ placeholder={isBitbucketTokenSet ? "<hidden>" : "email:api_token"}
startContent={
isBitbucketTokenSet && (
<KeyStatusIcon
diff --git a/frontend/src/i18n/translation.json b/frontend/src/i18n/translation.json
index 79344b503e..d84f0457db 100644
--- a/frontend/src/i18n/translation.json
+++ b/frontend/src/i18n/translation.json
@@ -14042,21 +14042,21 @@
"ca": "No s'ha pogut reinstal·lar el webhook"
},
"BITBUCKET$TOKEN_LABEL": {
- "en": "Bitbucket Token",
- "ja": "Bitbucketトークン",
- "zh-CN": "Bitbucket令牌",
- "zh-TW": "Bitbucket權杖",
- "ko-KR": "Bitbucket 토큰",
- "no": "Bitbucket-token",
- "it": "Token Bitbucket",
- "pt": "Token do Bitbucket",
- "es": "Token de Bitbucket",
- "ar": "رمز Bitbucket",
- "fr": "Jeton Bitbucket",
- "tr": "Bitbucket Token",
- "de": "Bitbucket-Token",
- "uk": "Токен Bitbucket",
- "ca": "Token de Bitbucket"
+ "en": "Bitbucket API Token",
+ "ja": "Bitbucket APIトークン",
+ "zh-CN": "Bitbucket API令牌",
+ "zh-TW": "Bitbucket API權杖",
+ "ko-KR": "Bitbucket API 토큰",
+ "no": "Bitbucket API-token",
+ "it": "Token API di Bitbucket",
+ "pt": "Token de API do Bitbucket",
+ "es": "Token de API de Bitbucket",
+ "ar": "رمز API الخاص بـ Bitbucket",
+ "fr": "Jeton API Bitbucket",
+ "tr": "Bitbucket API Token",
+ "de": "Bitbucket API-Token",
+ "uk": "API токен Bitbucket",
+ "ca": "Token API de Bitbucket"
},
"BITBUCKET$HOST_LABEL": {
"en": "Bitbucket Host",
@@ -14076,55 +14076,55 @@
"ca": "Servidor de Bitbucket"
},
"BITBUCKET$GET_TOKEN": {
- "en": "Get a Bitbucket token",
- "ja": "Bitbucketトークンを取得",
- "zh-CN": "获取Bitbucket令牌",
- "zh-TW": "獲取Bitbucket權杖",
- "ko-KR": "Bitbucket 토큰 받기",
- "no": "Få et Bitbucket-token",
- "it": "Ottieni un token Bitbucket",
- "pt": "Obter um token do Bitbucket",
- "es": "Obtener un token de Bitbucket",
- "ar": "الحصول على رمز Bitbucket",
- "fr": "Obtenir un jeton Bitbucket",
- "tr": "Bitbucket token al",
- "de": "Bitbucket-Token erhalten",
- "uk": "Отримати токен Bitbucket",
- "ca": "Obteniu un token de Bitbucket"
+ "en": "Get a Bitbucket API token",
+ "ja": "Bitbucket APIトークンを取得",
+ "zh-CN": "获取Bitbucket API令牌",
+ "zh-TW": "獲取Bitbucket API權杖",
+ "ko-KR": "Bitbucket API 토큰 받기",
+ "no": "Få et Bitbucket API-token",
+ "it": "Ottieni un token API di Bitbucket",
+ "pt": "Obter um token de API do Bitbucket",
+ "es": "Obtener un token de API de Bitbucket",
+ "ar": "الحصول على رمز API الخاص بـ Bitbucket",
+ "fr": "Obtenir un jeton API Bitbucket",
+ "tr": "Bitbucket API token al",
+ "de": "Bitbucket API-Token erhalten",
+ "uk": "Отримати API токен Bitbucket",
+ "ca": "Obteniu un token API de Bitbucket"
},
"BITBUCKET$TOKEN_HELP_TEXT": {
- "en": "Get your <0>Bitbucket app password</0> or <1>click here for instructions</1>. Enter it in the format 'username:app_password'.",
- "ja": "<0>Bitbucketアプリパスワード</0>を取得するか、<1>手順についてはここをクリック</1>。'ユーザー名:アプリパスワード'の形式で入力してください。",
- "zh-CN": "获取您的<0>Bitbucket应用密码</0>或<1>点击此处获取说明</1>。请以'用户名:应用密码'的格式输入。",
- "zh-TW": "取得您的<0>Bitbucket應用密碼</0>或<1>點擊此處獲取說明</1>。請以'用戶名:應用密碼'的格式輸入。",
- "ko-KR": "<0>Bitbucket 앱 비밀번호</0>를 받거나 <1>지침을 보려면 여기를 클릭</1>하세요. '사용자 이름:앱 비밀번호' 형식으로 입력하세요.",
- "no": "Få ditt <0>Bitbucket app-passord</0> eller <1>klikk her for instruksjoner</1>. Skriv det inn i formatet 'brukernavn:app-passord'.",
- "it": "Ottieni la tua <0>password dell'app Bitbucket</0> o <1>clicca qui per istruzioni</1>. Inseriscila nel formato 'nome utente:password dell'app'.",
- "pt": "Obtenha sua <0>senha de aplicativo do Bitbucket</0> ou <1>clique aqui para instruções</1>. Digite-a no formato 'nome de usuário:senha do aplicativo'.",
- "es": "Obtenga su <0>contraseña de aplicación de Bitbucket</0> o <1>haga clic aquí para obtener instrucciones</1>. Ingrésela en el formato 'nombre de usuario:contraseña de aplicación'.",
- "ar": "احصل على <0>كلمة مرور تطبيق Bitbucket</0> الخاصة بك أو <1>انقر هنا للحصول على تعليمات</1>. أدخلها بتنسيق 'اسم المستخدم:كلمة مرور التطبيق'.",
- "fr": "Obtenez votre <0>mot de passe d'application Bitbucket</0> ou <1>cliquez ici pour les instructions</1>. Saisissez-le au format 'nom d'utilisateur:mot de passe d'application'.",
- "tr": "<0>Bitbucket uygulama şifrenizi</0> alın veya <1>talimatlar için buraya tıklayın</1>. 'kullanıcı adı:uygulama şifresi' formatında girin.",
- "de": "Holen Sie sich Ihr <0>Bitbucket App-Passwort</0> oder <1>klicken Sie hier für Anweisungen</1>. Geben Sie es im Format 'Benutzername:App-Passwort' ein.",
- "uk": "Отримайте свій <0>пароль додатка Bitbucket</0> або <1>натисніть тут, щоб отримати інструкції</1>. Введіть його у форматі 'ім'я користувача:пароль додатка'.",
- "ca": "Obteniu la vostra <0>contrasenya d'aplicació de Bitbucket</0> o <1>feu clic aquí per obtenir instruccions</1>. Introduïu-la en el format 'username:app_password'."
+ "en": "Get your <0>Bitbucket API token</0> or <1>click here for instructions</1>. Enter it in the format 'email:api_token'. Note: The token must have at least 'read:user:bitbucket' scope.",
+ "ja": "<0>Bitbucket APIトークン</0>を取得するか、<1>手順についてはここをクリック</1>。'メールアドレス:APIトークン'の形式で入力してください。注意:トークンには少なくとも 'read:user:bitbucket' スコープが必要です。",
+ "zh-CN": "获取您的<0>Bitbucket API令牌</0>或<1>点击此处获取说明</1>。请以'邮箱:API令牌'的格式输入。注意:令牌必须至少具有 'read:user:bitbucket' 权限范围。",
+ "zh-TW": "取得您的<0>Bitbucket API權杖</0>或<1>點擊此處獲取說明</1>。請以'電子郵件:API權杖'的格式輸入。注意:權杖必須至少具有 'read:user:bitbucket' 權限範圍。",
+ "ko-KR": "<0>Bitbucket API 토큰</0>을 받거나 <1>지침을 보려면 여기를 클릭</1>하세요. '이메일:API 토큰' 형식으로 입력하세요. 참고: 토큰에는 최소한 'read:user:bitbucket' 범위가 있어야 합니다.",
+ "no": "Få ditt <0>Bitbucket API-token</0> eller <1>klikk her for instruksjoner</1>. Skriv det inn i formatet 'e-post:api-token'. Merk: Tokenet må ha minst 'read:user:bitbucket'-omfang.",
+ "it": "Ottieni il tuo <0>token API di Bitbucket</0> o <1>clicca qui per istruzioni</1>. Inseriscilo nel formato 'email:token_api'. Nota: il token deve avere almeno l'ambito 'read:user:bitbucket'.",
+ "pt": "Obtenha seu <0>token de API do Bitbucket</0> ou <1>clique aqui para instruções</1>. Digite-a no formato 'e-mail:token_de_api'. Nota: o token deve ter pelo menos o escopo 'read:user:bitbucket'.",
+ "es": "Obtenga su <0>token de API de Bitbucket</0> o <1>haga clic aquí para obtener instrucciones</1>. Ingrésela en el formato 'email:api_token'. Nota: El token debe tener al menos el alcance 'read:user:bitbucket'.",
+ "ar": "احصل على <0>رمز API الخاص بـ Bitbucket</0> أو <1>انقر هنا للحصول على تعليمات</1>. أدخلها بتنسيق 'البريد الإلكتروني:رمز API'. ملاحظة: يجب أن يحتوي الرمز على نطاق 'read:user:bitbucket' على الأقل.",
+ "fr": "Obtenez votre <0>jeton API Bitbucket</0> ou <1>cliquez ici pour les instructions</1>. Saisissez-le au format 'e-mail:jeton_api'. Note : le jeton doit avoir au moins le champ d'application 'read:user:bitbucket'.",
+ "tr": "<0>Bitbucket API token'ınızı</0> alın veya <1>talimatlar için buraya tıklayın</1>. 'email:api_token' formatında girin. Not: Token en az 'read:user:bitbucket' kapsamına sahip olmalıdır.",
+ "de": "Holen Sie sich Ihr <0>Bitbucket API-Token</0> oder <1>klicken Sie hier für Anweisungen</1>. Geben Sie es im Format 'E-Mail:API-Token' ein. Hinweis: Das Token muss mindestens den Bereich 'read:user:bitbucket' haben.",
+ "uk": "Отримайте свій <0>API токен Bitbucket</0> або <1>натисніть тут, щоб отримати інструкції</1>. Введіть його у форматі 'електронна пошта:api_токен'. Примітка: Токен повинен мати принаймні область 'read:user:bitbucket'.",
+ "ca": "Obteniu el vostre <0>token API de Bitbucket</0> o <1>feu clic aquí per obtenir instruccions</1>. Introduïu-lo en el format 'email:api_token'. Nota: El token ha de tenir almenys l'abast 'read:user:bitbucket'."
},
"BITBUCKET$TOKEN_LINK_TEXT": {
- "en": "Bitbucket app password",
- "ja": "Bitbucketアプリパスワード",
- "zh-CN": "Bitbucket应用密码",
- "zh-TW": "Bitbucket應用密碼",
- "ko-KR": "Bitbucket 앱 비밀번호",
- "no": "Bitbucket app-passord",
- "it": "password dell'app Bitbucket",
- "pt": "senha de aplicativo do Bitbucket",
- "es": "contraseña de aplicación de Bitbucket",
- "ar": "كلمة مرور تطبيق Bitbucket",
- "fr": "mot de passe d'application Bitbucket",
- "tr": "Bitbucket uygulama şifresi",
- "de": "Bitbucket App-Passwort",
- "uk": "пароль додатка Bitbucket",
- "ca": "contrasenya d'aplicació de Bitbucket"
+ "en": "Bitbucket API token",
+ "ja": "Bitbucket APIトークン",
+ "zh-CN": "Bitbucket API令牌",
+ "zh-TW": "Bitbucket API權杖",
+ "ko-KR": "Bitbucket API 토큰",
+ "no": "Bitbucket API-token",
+ "it": "token API di Bitbucket",
+ "pt": "token de API do Bitbucket",
+ "es": "token de API de Bitbucket",
+ "ar": "رمز API الخاص بـ Bitbucket",
+ "fr": "jeton API Bitbucket",
+ "tr": "Bitbucket API token",
+ "de": "Bitbucket API-Token",
+ "uk": "API токен Bitbucket",
+ "ca": "token API de Bitbucket"
},
"BITBUCKET$INSTRUCTIONS_LINK_TEXT": {
"en": "click here for instructions",
diff --git a/openhands/app_server/integrations/bitbucket/service/repos.py b/openhands/app_server/integrations/bitbucket/service/repos.py
index 46a64d5919..dee1a95bae 100644
--- a/openhands/app_server/integrations/bitbucket/service/repos.py
+++ b/openhands/app_server/integrations/bitbucket/service/repos.py
@@ -87,14 +87,14 @@ class BitBucketReposMixin(BitBucketMixinBase):
async def _get_user_workspaces(self) -> list[dict[str, Any]]:
"""Get all workspaces the user has access to"""
- url = f'{self.BASE_URL}/workspaces'
+ url = f'{self.BASE_URL}/user/workspaces'
data, _ = await self._make_request(url)
return data.get('values', [])
async def get_installations(
self, query: str | None = None, limit: int = 100
) -> list[str]:
- workspaces_url = f'{self.BASE_URL}/workspaces'
+ workspaces_url = f'{self.BASE_URL}/user/workspaces'
params = {}
if query:
params['q'] = f'name~"{query}"'
@@ -103,7 +103,7 @@ class BitBucketReposMixin(BitBucketMixinBase):
installations: list[str] = []
for workspace in workspaces:
- installations.append(workspace['slug'])
+ installations.append(workspace['workspace']['slug'])
return installations
@@ -204,11 +204,11 @@ class BitBucketReposMixin(BitBucketMixinBase):
repositories: list[Repository] = []
# Get user's workspaces with pagination
- workspaces_url = f'{self.BASE_URL}/workspaces'
+ workspaces_url = f'{self.BASE_URL}/user/workspaces'
workspaces = await self._fetch_paginated_data(workspaces_url, {}, MAX_REPOS)
for workspace in workspaces:
- workspace_slug = workspace.get('slug')
+ workspace_slug = workspace.get('workspace', {}).get('slug')
if not workspace_slug:
continue
diff --git a/openhands/app_server/integrations/provider.py b/openhands/app_server/integrations/provider.py
index cc7f24d41b..191753fa72 100644
--- a/openhands/app_server/integrations/provider.py
+++ b/openhands/app_server/integrations/provider.py
@@ -556,15 +556,18 @@ class ProviderHandler:
f'{protocol}://oauth2:{token_value}@{domain}/{repo_name}.git'
)
elif provider == ProviderType.BITBUCKET:
- # For Bitbucket, handle username:app_password format
+ # For Bitbucket, handle email:api_token format
if ':' in token_value:
- # App token format: username:app_password
+ # API token format: email:api_token
+ # Percent-encode both email and token as email contains '@'
+ user, password = token_value.split(':', 1)
+ url_creds = f'{quote(user, safe="")}:{quote(password, safe="")}'
remote_url = (
- f'{protocol}://{token_value}@{domain}/{repo_name}.git'
+ f'{protocol}://{url_creds}@{domain}/{repo_name}.git'
)
else:
# Access token format: use x-token-auth
- remote_url = f'{protocol}://x-token-auth:{token_value}@{domain}/{repo_name}.git'
+ remote_url = f'{protocol}://x-token-auth:{quote(token_value, safe="")}@{domain}/{repo_name}.git'
elif provider == ProviderType.BITBUCKET_DATA_CENTER:
# DC uses HTTP Basic auth — token must be in username:token format
project, repo_slug = (
diff --git a/tests/unit/integrations/bitbucket/test_bitbucket.py b/tests/unit/integrations/bitbucket/test_bitbucket.py
index b78447bd66..4cabae8f8d 100644
--- a/tests/unit/integrations/bitbucket/test_bitbucket.py
+++ b/tests/unit/integrations/bitbucket/test_bitbucket.py
@@ -52,7 +52,7 @@ async def test_validate_provider_token_with_bitbucket_token():
mock_bitbucket_service.return_value = bitbucket_instance
# Test with a Bitbucket token
- token = SecretStr('username:app_password')
+ token = SecretStr('[email protected]:api_token')
result = await validate_provider_token(token)
# Verify that all services were tried
@@ -74,7 +74,7 @@ async def test_check_provider_tokens_with_only_bitbucket():
# Create provider tokens with only Bitbucket
provider_tokens = {
ProviderType.BITBUCKET: ProviderToken(
- token=SecretStr('username:app_password'), host='bitbucket.org'
+ token=SecretStr('[email protected]:api_token'), host='bitbucket.org'
),
ProviderType.GITHUB: ProviderToken(token=SecretStr(''), host='github.com'),
ProviderType.GITLAB: ProviderToken(token=SecretStr(''), host='gitlab.com'),
@@ -95,7 +95,7 @@ async def test_check_provider_tokens_with_only_bitbucket():
# Verify that the token passed to validate_provider_token was the Bitbucket token
args, kwargs = mock_validate.call_args
- assert args[0].get_secret_value() == 'username:app_password'
+ assert args[0].get_secret_value() == '[email protected]:api_token'
@pytest.mark.asyncio
@@ -109,7 +109,17 @@ async def test_bitbucket_sort_parameter_mapping():
# Mock workspaces response
mock_request.side_effect = [
# First call: workspaces
- ({'values': [{'slug': 'test-workspace', 'name': 'Test Workspace'}]}, {}),
+ (
+ {
+ 'values': [
+ {
+ 'workspace': {'slug': 'test-workspace'},
+ 'name': 'Test Workspace',
+ }
+ ]
+ },
+ {},
+ ),
# Second call: repositories with mapped sort parameter
({'values': []}, {}),
]
@@ -140,7 +150,17 @@ async def test_bitbucket_pagination():
# Mock responses for pagination test
mock_request.side_effect = [
# First call: workspaces
- ({'values': [{'slug': 'test-workspace', 'name': 'Test Workspace'}]}, {}),
+ (
+ {
+ 'values': [
+ {
+ 'workspace': {'slug': 'test-workspace'},
+ 'name': 'Test Workspace',
+ }
+ ]
+ },
+ {},
+ ),
# Second call: first page of repositories
(
{
@@ -263,7 +283,7 @@ async def test_bitbucket_get_repositories_with_user_owner_type():
service = BitBucketService(token=SecretStr('test-token'))
# Mock repository data for user repositories (private workspace)
- mock_workspaces = [{'slug': 'test-user', 'name': 'Test User'}]
+ mock_workspaces = [{'workspace': {'slug': 'test-user'}, 'name': 'Test User'}]
mock_repos = [
{
'uuid': 'repo-1',
@@ -302,7 +322,7 @@ async def test_bitbucket_get_repositories_with_organization_owner_type():
service = BitBucketService(token=SecretStr('test-token'))
# Mock repository data for organization repositories (public workspace)
- mock_workspaces = [{'slug': 'test-org', 'name': 'Test Organization'}]
+ mock_workspaces = [{'workspace': {'slug': 'test-org'}, 'name': 'Test Organization'}]
mock_repos = [
{
'uuid': 'repo-3',
@@ -342,8 +362,8 @@ async def test_bitbucket_get_repositories_mixed_owner_types():
# Mock repository data with mixed workspace types
mock_workspaces = [
- {'slug': 'test-user', 'name': 'Test User'},
- {'slug': 'test-org', 'name': 'Test Organization'},
+ {'workspace': {'slug': 'test-user'}, 'name': 'Test User'},
+ {'workspace': {'slug': 'test-org'}, 'name': 'Test Organization'},
]
# First workspace (user) repositories