Ensure that ddev does not treat worktrees as extra packages

Author: AAraKKe

ddev/changelog.d/20444.added

@@ -0,0 +1 @@
+Add support for worktrees. Ddev now understand and differentiate worktrees from other packages

ddev/src/ddev/repo/core.py

@@ -43,6 +43,10 @@ def git(self) -> GitRepository:
     def integrations(self) -> IntegrationRegistry:
         return self.__integrations
 
+    @cached_property
+    def worktrees(self) -> list[str]:
+        return self.git.worktrees
+
     @cached_property
     def config(self) -> RepositoryConfig:
         from ddev.repo.config import RepositoryConfig
@@ -80,7 +84,7 @@ def get(self, name: str) -> Integration:
             return self.__cache[name]
 
         path = self.repo.path / name
-        if not path.is_dir():
+        if not (path.is_dir() and path.name not in self.repo.worktrees):
             raise OSError(f'Integration does not exist: {Path(self.repo.path.name, name)}')
 
         integration = Integration(path, self.repo.path, self.repo.config)
@@ -176,6 +180,10 @@ def __iter_filtered(self, selection: Iterable[str] = ()) -> Iterable[Integration
             return
 
         for path in sorted(self.repo.path.iterdir()):
+            # Ignore any directory that is a worktree
+            if path.name in self.repo.worktrees:
+                continue
+
             integration = self.__get_from_path(path)
             if selected and integration.name not in selected:
                 continue

ddev/src/ddev/utils/git.py

@@ -33,6 +33,21 @@ def __init__(self, repo_root: Path):
     def repo_root(self) -> Path:
         return self.__repo_root
 
+    @property
+    def worktrees(self) -> list[str]:
+        from ddev.utils.fs import Path
+
+        worktree_output = self.capture('worktree', 'list', '--porcelain')
+        worktrees = [
+            Path(line.split()[1]).relative_to(self.repo_root.resolve()).name
+            for line in worktree_output.splitlines()
+            if line.startswith('worktree')
+        ]
+
+        # Avoid returning empty strings. The root of the repo is always a worktree and
+        # the name of "." (the root of the repo relative to itself) is ""
+        return [worktree for worktree in worktrees if worktree]
+
     def current_branch(self) -> str:
         return self.capture('rev-parse', '--abbrev-ref', 'HEAD').strip()
 
@@ -87,7 +102,12 @@ def changed_files(self) -> list[str]:
                 changed_files.add(line)
 
         # Untracked
-        changed_files.update(self.capture('ls-files', '--others', '--exclude-standard').splitlines())
+        # Remove worktrees as they can be untracked and should not be taken into account
+        changed_files.update(
+            untracked_file
+            for untracked_file in self.capture('ls-files', '--others', '--exclude-standard').splitlines()
+            if not any(untracked_file.startswith(worktree) for worktree in self.worktrees)
+        )
 
         return sorted(changed_files, key=lambda relative_path: (-relative_path.count('/'), relative_path))
 

ddev/tests/cli/env/conftest.py

@@ -36,3 +36,12 @@ def _write(*args, **kwargs):
         return _write
 
     return _write_result_file
+
+
+@pytest.fixture(autouse=True)
+def mock_repo_worktrees(mocker):
+    from ddev.repo.core import Repository
+
+    # Patch the cached_property 'worktrees' on the Repository class
+    # For all instances, it will now return an empty list, bypassing the git call.
+    mocker.patch.object(Repository, "worktrees", new_callable=mocker.PropertyMock, return_value=[])

ddev/tests/cli/meta/scripts/conftest.py

@@ -12,11 +12,13 @@
 
 
 @pytest.fixture
-def fake_repo(tmp_path_factory, config_file, ddev):
+def fake_repo(tmp_path_factory, config_file, ddev, mocker):
     repo_path = tmp_path_factory.mktemp('integrations-core')
     repo = Repository('integrations-core', str(repo_path))
 
-    config_file.model.repos['core'] = str(repo.path)
+    mocker.patch.object(Repository, 'worktrees', new_callable=mocker.PropertyMock, return_value=[])
+
+    config_file.model.repos["core"] = str(repo.path)
     config_file.save()
 
     write_file(

ddev/tests/cli/release/test_changelog.py

@@ -261,6 +261,7 @@ def fragments_dir(self, repo_with_towncrier, network_replay, mocker):
                 'M ddev/pyproject.toml',
                 '',
                 '',
+                '',
                 'M ddev/pyproject.toml',
                 '',
                 '',

ddev/tests/cli/test/test_test.py

@@ -11,6 +11,13 @@
 from ddev.utils.structures import EnvVars
 
 
+@pytest.fixture(autouse=True)
+def mock_worktrees(mocker):
+    # Mock the access to worktrees because these tests mock the global subprocess run
+    # Should be refactored to avoid such a broad mock
+    mocker.patch('ddev.utils.git.GitRepository.worktrees', return_value=[])
+
+
 class TestInputValidation:
     @pytest.mark.parametrize('flag', ('--lint', '--fmt', '--bench', '--latest'))
     def test_specific_environment_and_functionality(self, ddev, helpers, flag):

ddev/tests/cli/test_dep.py

@@ -291,14 +291,17 @@ def add_mock(url, response_value):
 
 
 @pytest.fixture
-def fake_repo(tmp_path, config_file):
+def fake_repo(tmp_path, config_file, mocker):
     data_folder = tmp_path / 'datadog_checks_base' / 'datadog_checks' / 'base' / 'data'
     data_folder.mkdir(parents=True)
 
     # Set this as core repo in the config
     config_file.model.repos['core'] = str(tmp_path)
     config_file.save()
 
+    # Mock the access to worktrees because this is a fake repo
+    mocker.patch('ddev.utils.git.GitRepository.worktrees', return_value=[])
+
     yield tmp_path
 
 

ddev/tests/cli/validate/conftest.py

@@ -5,43 +5,32 @@
 from datadog_checks.dev.tooling.constants import set_root
 
 from ddev.repo.core import Repository
+from tests.helpers.api import write_file
 
-
-def _fake_repo(tmp_path_factory, config_file, name):
-    set_root('')  # for dcd compatibility running the tests
-    repo_path = tmp_path_factory.mktemp(name)
-    repo = Repository(name, str(repo_path))
-
-    config_file.model.repos[name] = str(repo.path)
-    config_file.model.repo = name
-    config_file.save()
-
-    write_file(
-        repo.path / '.github',
+FILES_IN_FAKE_REPO = [
+    # Codeowners file
+    (
+        '.github',
         'CODEOWNERS',
         """
 /dummy/                                 @DataDog/agent-integrations
 /dummy2/                                 @DataDog/agent-integrations
 """,
-    )
-
-    write_file(
-        repo_path / ".ddev",
+    ),
+    # Ddev config file
+    (
+        '.ddev',
         'config.toml',
         """[overrides.validate.labeler]
 include = ["datadog_checks_tests_helper"]
 """,
-    )
-
-    for integration in ('dummy', 'dummy2'):
-        write_file(
-            repo_path / integration,
-            'manifest.json',
-            """We don't need the content for this test, we just need the file""",
-        )
-
-    write_file(
-        repo_path / '.github' / 'workflows' / 'config',
+    ),
+    # Dummy manifest files
+    ('dummy', 'manifest.json', """We don't need the content for this test, we just need the file"""),
+    ('dummy2', 'manifest.json', """We don't need the content for this test, we just need the file"""),
+    # Labeler config file
+    (
+        '.github/workflows/config',
         'labeler.yml',
         """changelog/no-changelog:
 - any:
@@ -60,30 +49,68 @@ def _fake_repo(tmp_path_factory, config_file, name):
 release:
 - '*/__about__.py'
 """,
-    )
+    ),
+]
+
+
+def _fake_repo(tmp_path_factory, config_file, name, files_to_write):
+    set_root('')  # for dcd compatibility running the tests
+    repo_path = tmp_path_factory.mktemp(name)
+    repo = Repository(name, str(repo_path))
+
+    config_file.model.repos[name] = str(repo.path)
+    config_file.model.repo = name
+    config_file.save()
+    for file_path, file_name, content in files_to_write:
+        write_file(repo_path / file_path, file_name, content)
 
     return repo
 
 
 @pytest.fixture
 def fake_repo(
+    request,
     tmp_path_factory,
     config_file,
+    mocker,
 ):
-    yield _fake_repo(tmp_path_factory, config_file, 'core')
-
+    mocker.patch('ddev.utils.git.GitRepository.worktrees', return_value=[])
 
-@pytest.fixture
-def fake_extras_repo(tmp_path_factory, config_file):
-    yield _fake_repo(tmp_path_factory, config_file, 'extras')
+    yield _fake_repo(
+        tmp_path_factory,
+        config_file,
+        'core',
+        request.param if hasattr(request, 'param') else FILES_IN_FAKE_REPO,
+    )
 
 
 @pytest.fixture
-def fake_marketplace_repo(tmp_path_factory, config_file):
-    yield _fake_repo(tmp_path_factory, config_file, 'marketplace')
+def fake_extras_repo(
+    request,
+    tmp_path_factory,
+    config_file,
+    mocker,
+):
+    mocker.patch('ddev.utils.git.GitRepository.worktrees', return_value=[])
+    yield _fake_repo(
+        tmp_path_factory,
+        config_file,
+        'extras',
+        request.param if hasattr(request, 'param') else FILES_IN_FAKE_REPO,
+    )
 
 
-def write_file(folder, file, content):
-    folder.mkdir(exist_ok=True, parents=True)
-    file_path = folder / file
-    file_path.write_text(content)
+@pytest.fixture
+def fake_marketplace_repo(
+    request,
+    tmp_path_factory,
+    config_file,
+    mocker,
+):
+    mocker.patch('ddev.utils.git.GitRepository.worktrees', return_value=[])
+    yield _fake_repo(
+        tmp_path_factory,
+        config_file,
+        'marketplace',
+        request.param if hasattr(request, 'param') else FILES_IN_FAKE_REPO,
+    )

ddev/tests/cli/validate/test_codeowners.py

@@ -1,7 +1,7 @@
 # (C) Datadog, Inc. 2024-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
-from .conftest import write_file
+from tests.helpers.api import write_file
 
 
 def test_codeowners_integrations_core(fake_repo, ddev):