dvc-utils 0.3.0__tar.gz → 0.3.1__tar.gz

dvc_utils-0.3.1/.github/workflows/ci.yml

@@ -0,0 +1,74 @@
+name: Verify README examples, release to PyPI
+on:
+  push:
+    branches: [ "main" ]
+    tags: [ "v**" ]
+  pull_request:
+    branches: [ "main" ]
+  workflow_dispatch:
+env:
+  AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+  AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+jobs:
+  test:
+    name: Verify README examples
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          submodules: true
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - name: Set up Python 3.11
+        run: uv python install 3.11
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@v2
+      - run: cargo install parquet2json
+      - name: Install dependencies
+        run: uv sync --extra ci --extra test
+      - name: Run pytest
+        run: |
+          source .venv/bin/activate
+          pytest
+      - name: '`dvc pull` test/data'
+        working-directory: test/data
+        run: |
+          source ../../.venv/bin/activate
+          dvc pull -r s3 -R -A
+      - name: Set up parquet-helpers
+        uses: actions/checkout@v4
+        with:
+          repository: ryan-williams/parquet-helpers
+          path: pqt
+      - name: Verify README examples
+        env:
+          # Evaluate README examples from within the `test/data` submodule
+          BMDF_WORKDIR: test/data
+        run: |
+          source .venv/bin/activate
+          export PATH="$PWD/pqt:$PATH"
+          . pqt/.pqt-rc
+          export SHELL
+          mdcmd
+          git diff --exit-code
+  release:
+    name: Release to PyPI
+    if: startsWith(github.ref, 'refs/tags/')
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - name: Build package
+        run: uv build
+      - name: Publish to PyPI
+        run: uv publish --username __token__ --password ${{ secrets.PYPI_TOKEN }}
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          gh release create ${{ github.ref_name }} \
+            --title "${{ github.ref_name }}" \
+            --generate-notes

dvc_utils-0.3.1/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "test/data"]
+	path = test/data
+	url = https://github.com/ryan-williams/dvc-helpers

{dvc_utils-0.3.0/src/dvc_utils.egg-info → dvc_utils-0.3.1}/PKG-INFO

@@ -1,22 +1,23 @@
 Metadata-Version: 2.4
 Name: dvc-utils
-Version: 0.3.0
+Version: 0.3.1
 Summary: CLI for diffing DVC-tracked files at two commits (or one commit vs. current worktree), optionally passing both through another command first
-Author-email: Ryan Williams <ryan@runsascoded.com>
-License: MIT
 Project-URL: Homepage, https://github.com/runsascoded/dvc-utils
 Project-URL: Author URL, https://github.com/ryan-williams
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
+Author-email: Ryan Williams <ryan@runsascoded.com>
+License: MIT
 License-File: LICENSE
+Requires-Python: >=3.9
 Requires-Dist: click
-Requires-Dist: dffs>=0.0.5
+Requires-Dist: dffs>=0.0.6
 Requires-Dist: pyyaml
 Requires-Dist: utz>=0.20.0
 Provides-Extra: ci
-Requires-Dist: bmdf==0.5.2; extra == "ci"
-Requires-Dist: dvc-s3; extra == "ci"
-Dynamic: license-file
+Requires-Dist: bmdf==0.5.2; extra == 'ci'
+Requires-Dist: dvc-s3; extra == 'ci'
+Provides-Extra: test
+Requires-Dist: pytest>=7.0.0; extra == 'test'
+Description-Content-Type: text/markdown
 
 # dvc-utils
 Diff [DVC] files, optionally piping through other commands first.

{dvc_utils-0.3.0 → dvc_utils-0.3.1}/pyproject.toml

@@ -1,10 +1,10 @@
 [build-system]
-requires = ["setuptools>=75"]
-build-backend = "setuptools.build_meta"
+requires = ["hatchling"]
+build-backend = "hatchling.build"
 
 [project]
 name = "dvc-utils"
-version = "0.3.0"
+version = "0.3.1"
 description = "CLI for diffing DVC-tracked files at two commits (or one commit vs. current worktree), optionally passing both through another command first"
 readme = "README.md"
 license = {text = "MIT"}
@@ -14,7 +14,7 @@ authors = [
 requires-python = ">=3.9"
 dependencies = [
     "click",
-    "dffs>=0.0.5",
+    "dffs>=0.0.6",
     "pyyaml",
     "utz>=0.20.0",
 ]
@@ -24,6 +24,9 @@ ci = [
     "bmdf==0.5.2",
     "dvc-s3",
 ]
+test = [
+    "pytest>=7.0.0",
+]
 
 [project.urls]
 Homepage = "https://github.com/runsascoded/dvc-utils"
@@ -33,8 +36,10 @@ Homepage = "https://github.com/runsascoded/dvc-utils"
 dvc-utils = "dvc_utils.main:main"
 dvc-diff = "dvc_utils.diff:dvc_diff"
 
-[tool.setuptools]
-package-dir = {"" = "src"}
+[dependency-groups]
+dev = [
+    "pytest>=7.0.0",
+]
 
-[tool.setuptools.packages.find]
-where = ["src"]
+[tool.hatch.build.targets.wheel]
+packages = ["src/dvc_utils"]

dvc_utils-0.3.1/pytest.ini

@@ -0,0 +1,6 @@
+[pytest]
+testpaths = tests
+python_files = test_*.py
+python_classes = Test*
+python_functions = test_*
+addopts = -v --tb=short

{dvc_utils-0.3.0 → dvc_utils-0.3.1}/src/dvc_utils/diff.py

@@ -111,7 +111,7 @@ def dvc_diff(
                 cmds1 = [ shlex.split(cmd) for cmd in cmds1 ]
                 cmds2 = [ shlex.split(cmd) for cmd in cmds2 ]
 
-            join_pipelines(
+            returncode = join_pipelines(
                 base_cmd=['diff', *diff_args],
                 cmds1=cmds1,
                 cmds2=cmds2,
@@ -119,6 +119,7 @@ def dvc_diff(
                 shell=shell,
                 executable=shell_executable,
             )
+            exit(returncode)
         else:
             res = process.run('diff', *diff_args, path1 or '/dev/null', path2 or '/dev/null', log=log, check=False)
             exit(res.returncode)

dvc_utils-0.3.1/tests/test_diff_exit_codes.py

@@ -0,0 +1,83 @@
+"""Tests for dvc-diff exit code handling."""
+import pytest
+import subprocess
+from pathlib import Path
+import tempfile
+
+
+class TestDiffExitCodes:
+    """Test that dvc-diff properly propagates exit codes from pipeline commands."""
+
+    def test_successful_pipeline_returns_zero(self, tmp_path):
+        """Test that successful identical pipeline returns 0."""
+        # Create test files
+        file1 = tmp_path / "test1.txt"
+        file2 = tmp_path / "test2.txt"
+        file1.write_text("foo\nbar\n")
+        file2.write_text("foo\nbar\n")
+
+        # Run diff-x (not dvc-diff, but tests the same join_pipelines code)
+        result = subprocess.run(
+            ["diff-x", "cat", str(file1), str(file2)],
+            capture_output=True,
+        )
+        assert result.returncode == 0
+
+    def test_diff_found_returns_one(self, tmp_path):
+        """Test that differences found returns 1."""
+        file1 = tmp_path / "test1.txt"
+        file2 = tmp_path / "test2.txt"
+        file1.write_text("foo\n")
+        file2.write_text("bar\n")
+
+        result = subprocess.run(
+            ["diff-x", "cat", str(file1), str(file2)],
+            capture_output=True,
+        )
+        assert result.returncode == 1
+
+    def test_pipeline_error_propagates(self, tmp_path):
+        """Test that pipeline command errors propagate to exit code."""
+        file1 = tmp_path / "test1.txt"
+        file2 = tmp_path / "test2.txt"
+        file1.write_text("foo\n")
+        file2.write_text("bar\n")
+
+        # Use a command that will fail
+        result = subprocess.run(
+            ["diff-x", "cat /nonexistent/file/that/does/not/exist ||", str(file1), str(file2)],
+            capture_output=True,
+            shell=False,
+        )
+        # Should return non-zero due to cat failing
+        assert result.returncode != 0
+
+    def test_false_command_propagates_error(self, tmp_path):
+        """Test that 'false' command in pipeline propagates error."""
+        file1 = tmp_path / "test1.txt"
+        file2 = tmp_path / "test2.txt"
+        file1.write_text("foo\n")
+        file2.write_text("bar\n")
+
+        # Use 'false' which always returns 1
+        result = subprocess.run(
+            ["diff-x", "cat", "false", str(file1), str(file2)],
+            capture_output=True,
+        )
+        # Should return non-zero due to false in pipeline
+        assert result.returncode != 0
+
+    def test_multi_stage_pipeline_error(self, tmp_path):
+        """Test that errors in multi-stage pipelines are detected."""
+        file1 = tmp_path / "test1.txt"
+        file2 = tmp_path / "test2.txt"
+        file1.write_text("foo\nbar\n")
+        file2.write_text("bar\nfoo\n")
+
+        # Pipeline: sort (succeeds) | false (fails)
+        result = subprocess.run(
+            ["diff-x", "-x", "sort", "-x", "false", str(file1), str(file2)],
+            capture_output=True,
+        )
+        # Should return non-zero due to false in pipeline
+        assert result.returncode != 0