add test_package_with_include_symbolic_links inside test_complete

Author: lucasiscovici2

src/poetry/core/masonry/builders/sdist.py

@@ -316,7 +316,9 @@ def find_nearest_pkg(rel_path: str) -> tuple[str, str]:
 
         return pkgdir, sorted(packages), pkg_data
 
-    def find_files_to_add(self, exclude_build: bool = False) -> set[BuildIncludeFile]:
+    def find_files_to_add(
+        self, exclude_build: bool = False, resolve_symlinks: bool = True
+    ) -> set[BuildIncludeFile]:
         to_add = super().find_files_to_add(exclude_build)
 
         # add any additional files, starting with all LICENSE files
@@ -334,7 +336,10 @@ def find_files_to_add(self, exclude_build: bool = False) -> set[BuildIncludeFile
 
         for additional_file in additional_files:
             file = BuildIncludeFile(
-                path=additional_file, project_root=self._path, source_root=self._path
+                path=additional_file,
+                project_root=self._path,
+                source_root=self._path,
+                resolve_symlinks=resolve_symlinks,
             )
             if file.path.exists():
                 logger.debug(f"Adding: {file.relative_to_source_root()}")

tests/masonry/builders/fixtures/with-include-symbolic/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2018 Sébastien Eustace
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

tests/masonry/builders/fixtures/with-include-symbolic/README.rst

@@ -0,0 +1,2 @@
+My Package
+==========

tests/masonry/builders/fixtures/with-include-symbolic/data/1/35/2/blabla.txt

@@ -0,0 +1 @@
+__version__ = "1.2.3"

tests/masonry/builders/fixtures/with-include-symbolic/data/2/4/5/nd.txt

@@ -0,0 +1,56 @@
+[tool.poetry]
+name = "with-include-symbolic"
+version = "1.2.3"
+description = "Some description."
+authors = [
+    "Sébastien Eustace <[email protected]>"
+]
+license = "MIT"
+
+readme = "README.rst"
+
+homepage = "https://python-poetry.org/"
+repository = "https://github.com/python-poetry/poetry"
+documentation = "https://python-poetry.org/docs"
+
+keywords = ["packaging", "dependency", "poetry"]
+
+classifiers = [
+    "Topic :: Software Development :: Build Tools",
+    "Topic :: Software Development :: Libraries :: Python Modules"
+]
+
+packages = [
+    { include = "extra_dir/**/*.py" },
+    { include = "extra_dir/**/*.py" },
+    { include = "my_module.py" },
+    { include = "package_with_include" },
+    { include = "tests", format = "sdist" },
+    { include = "for_wheel_only", format = ["wheel"] },
+    { include = "src_package", from = "src", format = ["wheel","sdist"] },
+]
+
+include = [
+    "extra_dir/vcs_excluded.txt",
+    { path = "src/src_package/data", format = ["wheel","sdist"] },
+    "notes.txt"
+]
+
+
+# Requirements
+[tool.poetry.dependencies]
+python = "^3.6"
+cleo = "^0.6"
+cachy = { version = "^0.2.0", extras = ["msgpack"] }
+
+pendulum = { version = "^1.4", optional = true }
+
+[tool.poetry.dev-dependencies]
+pytest = "~3.4"
+
+[tool.poetry.extras]
+time = ["pendulum"]
+
+[tool.poetry.scripts]
+my-script = "my_package:main"
+my-2nd-script = "my_package:main2"

tests/masonry/builders/fixtures/with-include-symbolic/data/3/3/3/je.txt

@@ -0,0 +1 @@
+../../data

tests/masonry/builders/fixtures/with-include-symbolic/data/4/1/2/erric.txt

@@ -582,6 +582,109 @@ def test_package_with_include(mocker: MockerFixture) -> None:
         assert "src_package/__init__.py" in names
 
 
+def test_package_with_include_symbolic_links(mocker: MockerFixture) -> None:
+    module_path = fixtures_dir / "with-include-symbolic"
+
+    # Patch git module to return specific excluded files
+    p = mocker.patch("poetry.core.vcs.git.Git.get_ignored_files")
+    p.return_value = [
+        str(
+            Path(__file__).parent
+            / "fixtures"
+            / "with-include-symbolic"
+            / "extra_dir"
+            / "vcs_excluded.txt"
+        ),
+        str(
+            Path(__file__).parent
+            / "fixtures"
+            / "with-include-symbolic"
+            / "extra_dir"
+            / "sub_pkg"
+            / "vcs_excluded.txt"
+        ),
+    ]
+    builder = Builder(Factory().create_poetry(module_path))
+    builder.build(fmt="all")
+
+    sdist = (
+        fixtures_dir
+        / "with-include-symbolic"
+        / "dist"
+        / "with-include-symbolic-1.2.3.tar.gz"
+    )
+
+    assert sdist.exists()
+
+    with tarfile.open(str(sdist), "r") as tar:
+        names = tar.getnames()
+        assert len(names) == len(set(names))
+        assert "with-include-symbolic-1.2.3/LICENSE" in names
+        assert "with-include-symbolic-1.2.3/README.rst" in names
+        assert "with-include-symbolic-1.2.3/extra_dir/__init__.py" in names
+        assert "with-include-symbolic-1.2.3/extra_dir/vcs_excluded.txt" in names
+        assert "with-include-symbolic-1.2.3/extra_dir/sub_pkg/__init__.py" in names
+        assert (
+            "with-include-symbolic-1.2.3/extra_dir/sub_pkg/vcs_excluded.txt"
+            not in names
+        )
+        assert "with-include-symbolic-1.2.3/my_module.py" in names
+        assert "with-include-symbolic-1.2.3/notes.txt" in names
+        assert "with-include-symbolic-1.2.3/package_with_include/__init__.py" in names
+        assert "with-include-symbolic-1.2.3/tests/__init__.py" in names
+        assert "with-include-symbolic-1.2.3/pyproject.toml" in names
+        assert "with-include-symbolic-1.2.3/setup.py" in names
+        assert "with-include-symbolic-1.2.3/PKG-INFO" in names
+        assert "with-include-symbolic-1.2.3/for_wheel_only/__init__.py" not in names
+        assert "with-include-symbolic-1.2.3/src/src_package/__init__.py" in names
+        assert "with-include-symbolic-1.2.3/data/1/35/2/blabla.txt" in names
+        assert "with-include-symbolic-1.2.3/data/2/4/5/nd.txt" in names
+        assert "with-include-symbolic-1.2.3/data/3/3/3/je.txt" in names
+        assert "with-include-symbolic-1.2.3/data/4/1/2/erric.txt" in names
+
+        file = tar.extractfile("with-include-symbolic-1.2.3/setup.py")
+        assert file
+        setup = file.read()
+        setup_ast = ast.parse(setup)
+
+        setup_ast.body = [n for n in setup_ast.body if isinstance(n, ast.Assign)]
+        ns: dict[str, Any] = {}
+        exec(compile(setup_ast, filename="setup.py", mode="exec"), ns)
+        assert ns["package_dir"] == {"": "src"}
+        assert ns["packages"] == [
+            "extra_dir",
+            "extra_dir.sub_pkg",
+            "package_with_include",
+            "src_package",
+            "tests",
+        ]
+        assert ns["package_data"] == {"": ["*"]}
+        assert ns["modules"] == ["my_module"]
+
+    whl = module_path / "dist" / "with_include_symbolic-1.2.3-py3-none-any.whl"
+
+    assert whl.exists()
+
+    with zipfile.ZipFile(str(whl)) as z:
+        names = z.namelist()
+        assert len(names) == len(set(names))
+        assert "with_include_symbolic-1.2.3.dist-info/LICENSE" in names
+        assert "extra_dir/__init__.py" in names
+        assert "extra_dir/vcs_excluded.txt" in names
+        assert "extra_dir/sub_pkg/__init__.py" in names
+        assert "extra_dir/sub_pkg/vcs_excluded.txt" not in names
+        assert "for_wheel_only/__init__.py" in names
+        assert "my_module.py" in names
+        assert "notes.txt" in names
+        assert "package_with_include/__init__.py" in names
+        assert "tests/__init__.py" not in names
+        assert "src_package/__init__.py" in names
+        assert "src_package/data/1/35/2/blabla.txt" in names
+        assert "src_package/data/2/4/5/nd.txt" in names
+        assert "src_package/data/3/3/3/je.txt" in names
+        assert "src_package/data/4/1/2/erric.txt" in names
+
+
 def test_respect_format_for_explicit_included_files() -> None:
     module_path = fixtures_dir / "exclude-whl-include-sdist"
     builder = Builder(Factory().create_poetry(module_path))