Fix CI: factor out unit tests, skip integration tests if dulwich not installed
CI / build (20.x, 3.13) (push) Failing after 18s
CI / build (20.x, 3.12) (push) Failing after 21s
CI / build (20.x, 3.14) (push) Failing after 17s

This commit is contained in:
Jason Novinger
2026-02-02 11:07:19 -06:00
parent 7eedefb2df
commit 2b6483dd27
2 changed files with 74 additions and 5 deletions
+15 -3
View File
@@ -21,11 +21,24 @@ __all__ = (
'GitBackend', 'GitBackend',
'LocalBackend', 'LocalBackend',
'S3Backend', 'S3Backend',
'url_has_embedded_credentials',
) )
logger = logging.getLogger('netbox.data_backends') logger = logging.getLogger('netbox.data_backends')
def url_has_embedded_credentials(url):
"""
Check if a URL contains embedded credentials (username in the URL).
URLs like 'https://user@bitbucket.org/...' have embedded credentials.
This is used to avoid passing explicit credentials to dulwich when the
URL already contains them, which would cause authentication conflicts.
"""
parsed = urlparse(url)
return bool(parsed.username)
@register_data_backend() @register_data_backend()
class LocalBackend(DataBackend): class LocalBackend(DataBackend):
name = 'local' name = 'local'
@@ -103,9 +116,8 @@ class GitBackend(DataBackend):
if self.url_scheme in ('http', 'https'): if self.url_scheme in ('http', 'https'):
# Only pass explicit credentials if URL doesn't already contain embedded username # Only pass explicit credentials if URL doesn't already contain embedded username
# to avoid credential conflicts # to avoid credential conflicts (see #20902)
parsed_url = urlparse(self.url) if not url_has_embedded_credentials(self.url) and self.params.get('username'):
if not parsed_url.username and self.params.get('username'):
clone_args.update( clone_args.update(
{ {
"username": self.params.get('username'), "username": self.params.get('username'),
+59 -2
View File
@@ -1,13 +1,70 @@
from unittest import skipIf
from unittest.mock import patch from unittest.mock import patch
from django.test import TestCase from django.test import TestCase
from core.data_backends import GitBackend from core.data_backends import url_has_embedded_credentials
try:
import dulwich # noqa: F401
DULWICH_AVAILABLE = True
except ImportError:
DULWICH_AVAILABLE = False
class GitBackendCredentialTests(TestCase): class URLEmbeddedCredentialsTests(TestCase):
def test_url_with_embedded_username(self):
self.assertTrue(url_has_embedded_credentials('https://myuser@bitbucket.org/workspace/repo.git'))
def test_url_without_embedded_username(self):
self.assertFalse(url_has_embedded_credentials('https://bitbucket.org/workspace/repo.git'))
def test_url_with_username_and_password(self):
self.assertTrue(url_has_embedded_credentials('https://user:pass@bitbucket.org/workspace/repo.git'))
def test_various_providers_with_embedded_username(self):
urls = [
'https://user@bitbucket.org/workspace/repo.git',
'https://user@github.com/owner/repo.git',
'https://deploy-key@gitlab.com/group/project.git',
'http://user@internal-git.example.com/repo.git',
]
for url in urls:
with self.subTest(url=url):
self.assertTrue(url_has_embedded_credentials(url))
def test_various_providers_without_embedded_username(self):
"""Various Git providers without embedded usernames."""
urls = [
'https://bitbucket.org/workspace/repo.git',
'https://github.com/owner/repo.git',
'https://gitlab.com/group/project.git',
'http://internal-git.example.com/repo.git',
]
for url in urls:
with self.subTest(url=url):
self.assertFalse(url_has_embedded_credentials(url))
def test_ssh_url(self):
# git@host:path format doesn't parse as having a username in the traditional sense
self.assertFalse(url_has_embedded_credentials('git@github.com:owner/repo.git'))
def test_file_url(self):
self.assertFalse(url_has_embedded_credentials('file:///path/to/repo'))
@skipIf(not DULWICH_AVAILABLE, "dulwich is not installed")
class GitBackendCredentialIntegrationTests(TestCase):
"""
Integration tests that verify GitBackend correctly applies credential logic.
These tests require dulwich to be installed and verify the full integration
of the credential handling in GitBackend.fetch().
"""
def _get_clone_kwargs(self, url, **params): def _get_clone_kwargs(self, url, **params):
from core.data_backends import GitBackend
backend = GitBackend(url=url, **params) backend = GitBackend(url=url, **params)
with patch('dulwich.porcelain.clone') as mock_clone, \ with patch('dulwich.porcelain.clone') as mock_clone, \