Tests & Fixes (#156)

- Added tests for safepull functions
- Added tests for Distribution and Package model methods.
- Updated ruff configuration keys and added pytest dependency.

Author: import-pandas-as-numpy

.github/workflows/release.yml

@@ -4,31 +4,38 @@ on:
     tags:
       - v*
 jobs:
-    build-n-publish:
-      name: Build and Build and publish a Python Distribution.
-      runs-on: ubuntu-latest
-      steps:
-        - uses: actions/checkout@v4
-        - name: Set up Python
-          uses: actions/setup-python@v5
-          with:
-            python-version: "3.x"
-        - name: Install pypa/build
-          run: >-
-            python3 -m
-            pip install
-            build
-            --user
-        - name: Build a binary wheel and a source tarball
-          run: >-
-            python3 -m
-            build
-            --sdist
-            --wheel
-            --outdir dist/
-            .
-        - name: Publish distribution to PyPI
-          if: startsWith(github.ref, 'refs/tags')
-          uses: pypa/gh-action-pypi-publish@release/v1
-          with:
-            password: ${{ secrets.PYPI_API_TOKEN }}
+  build-python-package:
+    name: Build and publish a Python Distribution.
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - name: Install pypa/build
+        run: >-
+          python3 -m
+          pip install
+          build
+          --user
+      - name: Build a binary wheel and a source tarball
+        run: >-
+          python3 -m
+          build
+          --sdist
+          --wheel
+          --outdir dist/
+          .
+  pypi-publish:
+    name: Upload release to PyPI
+    if: startsWith(github.ref, 'refs/tags')
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/safepull
+    permissions:
+      id-token: write
+    steps:
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/tests.yml

@@ -0,0 +1,25 @@
+name: Tests
+
+on: pull_request
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v3
+      with:
+        python-version: "3.11"
+    - name: Install dependencies
+      run: |
+        sudo apt install poppler-utils tesseract-ocr
+        python -m pip install --upgrade pip
+        pip install poetry
+    - name: Setup Project
+      run: |
+            poetry install --with dev
+    - name: Run tests
+      run: poetry run pytest

poetry.lock

@@ -20,12 +20,13 @@ humanize = "^4.9.0"
 [tool.poetry.group.dev.dependencies]
 ruff = ">=0.5.0,<0.8.7"
 pre-commit = ">=3.3.3,<5.0.0"
+pytest = "^8.3.5"
 
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.ruff]
 target-version = "py311"
-select = ["ALL"]
-ignore = ["ANN101", "ANN206", "ANN102", "S202"]
+lint.select = ["ALL"]
+lint.ignore = ["ANN101", "ANN206", "ANN102", "S202"]

pyproject.toml

@@ -0,0 +1 @@
+# noqa: D104

src/safepull/__init__.py

@@ -1,4 +1,4 @@
-from .safepull import run
+from .safepull import run  # noqa: D100
 
 if __name__ == "__main__":
     run()

src/safepull/__main__.py

@@ -0,0 +1 @@
+# noqa: D104

tests/__init__.py

@@ -0,0 +1,130 @@
+"""Unit tests for the Distribution and Package models in the safepull library."""
+
+from safepull.models import Distribution, Package
+
+# ruff: noqa: D103, S101, PLR2004
+
+
+def test_distribution_from_dict() -> None:
+    data = {
+        "filename": "example.tar.gz",
+        "packagetype": "sdist",
+        "url": "https://example.com/example.tar.gz",
+        "size": 1024,
+    }
+    distribution = Distribution.from_dict(data)
+    assert distribution.filename == "example.tar.gz"
+    assert distribution.packagetype == "sdist"
+    assert distribution.url == "https://example.com/example.tar.gz"
+    assert distribution.size == 1024
+
+
+def test_distribution_get_metadata() -> None:
+    distribution = Distribution(
+        filename="example.tar.gz",
+        packagetype="sdist",
+        url="https://example.com/example.tar.gz",
+        size=1024,
+    )
+    metadata = distribution.get_metadata()
+    assert metadata == (
+        "Filename: example.tar.gz",
+        "Package Type: sdist",
+        "URL: https://example.com/example.tar.gz",
+        "Size: 0MB",
+    )
+
+
+def test_package_from_dict() -> None:
+    data = {
+        "info": {
+            "name": "example-package",
+            "summary": "An example package",
+            "author": "John Doe",
+            "version": "1.0.0",
+        },
+        "urls": [
+            {
+                "filename": "example.tar.gz",
+                "packagetype": "sdist",
+                "url": "https://example.com/example.tar.gz",
+                "size": 1024,
+            },
+        ],
+    }
+    package = Package.from_dict(data)
+    assert package.name == "example-package"
+    assert package.summary == "An example package"
+    assert package.author == "John Doe"
+    assert package.version == "1.0.0"
+    assert len(package.distributions) == 1
+    assert package.distributions[0].filename == "example.tar.gz"
+
+
+def test_package_get_metadata() -> None:
+    package = Package(
+        name="example-package",
+        summary="An example package",
+        author="John Doe",
+        version="1.0.0",
+        distributions=[],
+    )
+    metadata = package.get_metadata()
+    assert metadata == (
+        "example-package 1.0.0",
+        "An example package",
+        "Author: John Doe",
+    )
+
+
+def test_package_get_distributions() -> None:
+    distribution = Distribution(
+        filename="example.tar.gz",
+        packagetype="sdist",
+        url="https://example.com/example.tar.gz",
+        size=1024,
+    )
+    package = Package(
+        name="example-package",
+        summary="An example package",
+        author="John Doe",
+        version="1.0.0",
+        distributions=[distribution],
+    )
+    distributions = package.get_distributions()
+    assert len(distributions) == 1
+    assert distributions[0].filename == "example.tar.gz"
+
+
+def test_package_get_sdist() -> None:
+    sdist = Distribution(
+        filename="example.tar.gz",
+        packagetype="sdist",
+        url="https://example.com/example.tar.gz",
+        size=1024,
+    )
+    wheel = Distribution(
+        filename="example.whl",
+        packagetype="bdist_wheel",
+        url="https://example.com/example.whl",
+        size=2048,
+    )
+    package = Package(
+        name="example-package",
+        summary="An example package",
+        author="John Doe",
+        version="1.0.0",
+        distributions=[sdist, wheel],
+    )
+    result = package.get_sdist()
+    assert result == sdist
+
+    package_no_sdist = Package(
+        name="example-package",
+        summary="An example package",
+        author="John Doe",
+        version="1.0.0",
+        distributions=[wheel],
+    )
+    result = package_no_sdist.get_sdist()
+    assert result is None

tests/test_models.py

@@ -0,0 +1,140 @@
+"""Unit tests for the safepull module."""
+
+import argparse
+from io import BytesIO
+from pathlib import Path
+from unittest.mock import MagicMock, patch
+
+import pytest
+from safepull.models import Package
+from safepull.safepull import query_package, run, unpack
+
+
+@pytest.fixture()
+def mock_package() -> MagicMock:
+    """Fixture to create a mock Package object."""
+    mock_pkg = MagicMock(spec=Package)
+    mock_pkg.name = "example-package"
+    mock_pkg.version = "1.0.0"
+    mock_pkg.get_distributions.return_value = [
+        MagicMock(
+            filename="example-1.0.0.tar.gz",
+            download_package=MagicMock(
+                return_value=(BytesIO(b"data"), "example-1.0.0.tar.gz"),
+            ),
+        ),
+        MagicMock(
+            filename="example-1.0.0.whl",
+            download_package=MagicMock(
+                return_value=(BytesIO(b"data"), "example-1.0.0.whl"),
+            ),
+        ),
+    ]
+    mock_pkg.get_sdist.return_value = mock_pkg.get_distributions()[0]
+    mock_pkg.get_metadata.return_value = ["Metadata line 1", "Metadata line 2"]
+    mock_pkg.table_print.return_value = "Mocked Table"
+    return mock_pkg
+
+
+@patch("safepull.safepull.requests.get")
+def test_query_package(mock_get: MagicMock, mock_package: MagicMock) -> None:
+    """Test the query_package function."""
+    mock_response = MagicMock()
+    mock_response.json.return_value = {"name": "example-package", "version": "1.0.0"}
+    mock_response.raise_for_status = MagicMock()
+    mock_get.return_value = mock_response
+
+    with patch("safepull.safepull.Package.from_dict", return_value=mock_package):
+        result = query_package("example-package")
+        assert result == mock_package  # noqa: S101
+        mock_get.assert_called_once_with(
+            "https://pypi.org/pypi/example-package/json",
+            timeout=60,
+        )
+
+
+@patch("safepull.safepull.tarfile.open")
+@patch("safepull.safepull.ZipFile")
+def test_unpack(mock_zipfile: MagicMock, mock_tarfile: MagicMock) -> None:
+    """Test the unpack function."""
+    # Test .tar.gz file
+    mock_tar = MagicMock()
+    mock_tarfile.return_value.__enter__.return_value = mock_tar
+    byte_object = BytesIO(b"data")
+    unpack(byte_object, "example-1.0.0.tar.gz")
+    mock_tar.extractall.assert_called_once()
+
+    # Test .whl file
+    mock_zip = MagicMock()
+    mock_zipfile.return_value.__enter__.return_value = mock_zip
+    unpack(byte_object, "example-1.0.0.whl")
+    mock_zip.extractall.assert_called_once_with(
+        path=Path.cwd().joinpath("example-1.0.0"),
+    )
+
+
+@patch("safepull.safepull.query_package")
+@patch("safepull.safepull.unpack")
+@patch("safepull.safepull.Path.mkdir")
+@patch("safepull.safepull.chdir")
+@patch("safepull.safepull.Console.print")
+@patch("safepull.safepull.input", side_effect=["0", "y"])
+def test_run(  # noqa: PLR0913
+    mock_input: MagicMock,  # noqa: ARG001
+    mock_console_print: MagicMock,
+    mock_chdir: MagicMock,
+    mock_mkdir: MagicMock,
+    mock_unpack: MagicMock,
+    mock_query_package: MagicMock,
+    mock_package: MagicMock,
+) -> None:
+    """Test the run function."""
+    mock_query_package.return_value = mock_package
+
+    # Test --all flag
+    with patch(
+        "argparse.ArgumentParser.parse_args",
+        return_value=argparse.Namespace(
+            package="example-package",
+            version=None,
+            force=False,
+            metadata=False,
+            all=True,
+        ),
+    ):
+        run()
+        mock_mkdir.assert_called_once_with(exist_ok=True)
+        mock_chdir.assert_called_once()
+        mock_unpack.assert_called()
+
+    # Reset mock_unpack call count
+    mock_unpack.reset_mock()
+
+    # Test --metadata flag
+    with patch(
+        "argparse.ArgumentParser.parse_args",
+        return_value=argparse.Namespace(
+            package="example-package",
+            version=None,
+            force=False,
+            metadata=True,
+            all=False,
+        ),
+    ):
+        run()
+    # Reset mock_unpack call count
+    mock_unpack.reset_mock()
+    # Test interactive selection
+    with patch(
+        "argparse.ArgumentParser.parse_args",
+        return_value=argparse.Namespace(
+            package="example-package",
+            version=None,
+            force=False,
+            metadata=False,
+            all=False,
+        ),
+    ):
+        run()
+        mock_console_print.assert_called_once_with("Mocked Table")
+        mock_unpack.assert_called_once()