goldie 0.1.1__tar.gz

goldie-0.1.1/.github/workflows/release.yml

@@ -0,0 +1,134 @@
+name: release
+run-name: Release ${{ inputs.VERSION }} (pre-release=${{ inputs.IS_PRE_RELEASE }}) by @${{ github.actor }} from ${{ github.ref_name }}
+
+on:
+  workflow_dispatch:
+    inputs:
+      VERSION:
+        description: "The version to release"
+        required: true
+      IS_PRE_RELEASE:
+        description: "It IS a pre-release"
+        required: true
+        default: true
+        type: boolean
+
+env:
+  PYTHON_VERSION: "3.13"
+
+jobs:
+  bump: # This job is used to bump the version and create a release
+    runs-on: ubuntu-latest
+    env:
+      VERSION: ${{ inputs.VERSION }}
+      GH_TOKEN: ${{ github.token }}
+      SSH_AUTH_SOCK: /tmp/ssh_agent.sock
+    permissions:
+      contents: write
+    steps:
+      - name: set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install build hatch
+
+      - name: configure git with the bot credentials
+        run: |
+          mkdir -p ~/.ssh
+          ssh-keyscan github.com >> ~/.ssh/known_hosts
+          ssh-agent -a $SSH_AUTH_SOCK > /dev/null
+          ssh-add - <<< "${{ secrets.BOT_SSH_KEY }}"
+
+          echo "${{ secrets.BOT_SIGNING_KEY }}" > ~/.ssh/signing.key
+          chmod 600 ~/.ssh/signing.key
+
+          git config --global user.name "Merschbotmann"
+          git config --global user.email "bot.merschformann@gmail.com"
+          git config --global gpg.format ssh
+          git config --global user.signingkey ~/.ssh/signing.key
+
+          git clone git@github.com:merschformann/goldie.git
+          cd goldie
+          git switch ${{ github.ref_name }}
+
+      - name: upgrade version with hatch
+        run: hatch version ${{ env.VERSION }}
+        working-directory: ./goldie
+
+      - name: commit new version
+        run: |
+          git add goldie/__about__.py
+          git commit -S -m "Bump goldie version to ${{ env.VERSION }}"
+          git push
+          git tag ${{ env.VERSION }}
+          git push origin ${{ env.VERSION }}
+        working-directory: ./goldie
+
+      - name: create release
+        run: |
+          PRERELEASE_FLAG=""
+          if [ ${{ inputs.IS_PRE_RELEASE }} = true ]; then
+            PRERELEASE_FLAG="--prerelease"
+          fi
+
+          gh release create ${{ env.VERSION }} \
+          --verify-tag \
+          --generate-notes \
+          --title "goldie ${{ env.VERSION }}" $PRERELEASE_FLAG
+        working-directory: ./goldie
+
+      - name: ensure passing build
+        run: python -m build
+        working-directory: ./goldie
+
+  release: # This job is used to publish the release to PyPI/TestPyPI
+    runs-on: ubuntu-latest
+    needs: bump
+    strategy:
+      matrix:
+        include:
+          - target-env: pypi
+            target-url: https://pypi.org/p/goldie
+          - target-env: testpypi
+            target-url: https://test.pypi.org/p/goldie
+    environment:
+      name: ${{ matrix.target-env }}
+      url: ${{ matrix.target-url }}
+    permissions:
+      contents: read
+      id-token: write # This is required for trusted publishing to PyPI
+    steps:
+      - name: git clone ${{ github.ref_name }}
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref_name }}
+
+      - name: set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install build hatch
+
+      - name: build binary wheel and source tarball
+        run: python -m build
+
+      - name: Publish package distributions to PyPI
+        if: ${{ matrix.target-env == 'pypi' }}
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: ./dist
+
+      - name: Publish package distributions to TestPyPI
+        if: ${{ matrix.target-env == 'testpypi' }}
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          packages-dir: ./dist

goldie-0.1.1/.gitignore

@@ -0,0 +1,171 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# PyPI configuration file
+.pypirc

goldie-0.1.1/.prettierrc.yml

@@ -0,0 +1 @@
+tabWidth: 2

goldie-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Marius Merschformann
+
+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.

goldie-0.1.1/PKG-INFO

@@ -0,0 +1,43 @@
+Metadata-Version: 2.4
+Name: goldie
+Version: 0.1.1
+Summary: A humble library greasing the gears of golden file tests
+Project-URL: Homepage, https://github.com/merschformann/goldie
+Project-URL: Repository, https://github.com/merschformann/goldie
+Author-email: Marius Merschformann <merschformann@proton.me>
+Maintainer-email: Marius Merschformann <merschformann@proton.me>
+License: MIT License
+        
+        Copyright (c) 2025 Marius Merschformann
+        
+        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.
+License-File: LICENSE
+Keywords: golden file,integration test,test,testing
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# goldie
+
+A humble library greasing the gears of golden file tests.

goldie-0.1.1/README.md

@@ -0,0 +1,3 @@
+# goldie
+
+A humble library greasing the gears of golden file tests.

goldie-0.1.1/example/data/input.json

@@ -0,0 +1,3 @@
+{
+    "message": "Hello, goldie!"
+}

goldie-0.1.1/example/data/input.json.golden

@@ -0,0 +1,3 @@
+{
+    "message": "Hello, goldie!"
+}

goldie-0.1.1/example/golden_directory_test.py

@@ -0,0 +1,29 @@
+import unittest
+
+import goldie.comparison
+import goldie.directory
+import goldie.execution
+
+
+class TestExample(unittest.TestCase):
+    def test_addition(self):
+        config = goldie.directory.ConfigDirectoryTest(
+            file_filter="data/*.json",
+            run_configuration=goldie.execution.ConfigRun(
+                cmd="cat",
+                args=["{input}"],
+                input_mode=goldie.execution.InputMode.NONE,
+                output_mode=goldie.execution.OutputMode.STDOUT,
+            ),
+            run_validation_configuration=goldie.execution.ConfigRunValidation(),
+            comparison_configuration=goldie.comparison.ConfigComparison(
+                comparison_type=goldie.comparison.ComparisonType.JSON,
+                json_processing_config=goldie.comparison.ConfigProcessJson(),
+                json_comparison_config=goldie.comparison.ConfigCompareJson(),
+            ),
+        )
+        goldie.directory.run_unittest(self, config)
+
+
+if __name__ == "__main__":
+    unittest.main()

goldie-0.1.1/goldie/__about__.py

@@ -0,0 +1 @@
+__version__ = "v0.1.1"

goldie-0.1.1/goldie/__init__.py

@@ -0,0 +1,14 @@
+from .__about__ import __version__
+from .comparison import (
+    ConfigCompareJson,
+    ConfigCompareString,
+    ConfigComparison,
+    ConfigProcessJson,
+    ConfigProcessString,
+    compare,
+)
+from .diff import Difference, DiffStyle
+from .directory import ConfigDirectoryTest, run_unittest
+from .execution import ConfigRun, ConfigRunValidation, InputMode, OutputMode, execute
+
+VERSION = __version__

goldie-0.1.1/goldie/comparison.py

@@ -0,0 +1,399 @@
+import json
+import re
+from dataclasses import dataclass, field
+from enum import Enum
+
+from jflat import flatten, unflatten
+
+from .diff import Difference, DiffStyle, diff_color_code_full, diff_color_code_unified
+
+
+class ComparisonType(Enum):
+    """The type of comparison."""
+
+    STRING = "string"
+    """Comparison based on strings."""
+    JSON = "json"
+    """Comparison based on JSON."""
+    BINARY = "binary"
+    """Comparison based on binary files."""
+
+
+@dataclass
+class RegexReplacement:
+    """Defines a regex replacement."""
+
+    pattern: str
+    """The pattern to be replaced in Python 're' regex format."""
+    replacement: str
+    """The replacement string."""
+
+
+@dataclass
+class JsonReplacement:
+    """Defines a JSON replacement."""
+
+    path: str
+    """The JSON path to be replaced."""
+    value: any
+    """The value to put in place of the path."""
+
+
+@dataclass
+class JsonRounding:
+    """Defines rounding for a specific JSON path."""
+
+    path: str
+    """The JSON path to be rounded before comparing."""
+    precision: int
+    """The precision to round to."""
+
+
+@dataclass
+class ConfigProcessJson:
+    """Configuration for comparing dictionaries based on JSON."""
+
+    replacements: list[JsonReplacement] = field(default_factory=list)
+    """List of paths to replace."""
+    roundings: list[JsonRounding] = field(default_factory=list)
+    """List of paths to round before comparing."""
+    precision: int = 6
+    """The precision to round to."""
+
+
+@dataclass
+class ConfigCompareJson:
+    """Configuration for comparing dictionaries based on JSON."""
+
+    ignores: list[str] = field(default_factory=list)
+    """List of paths to ignore."""
+    allow_additional_keys: bool = False
+    """Whether additional keys in the actual JSON are allowed."""
+    allow_missing_keys: bool = False
+    """Whether missing keys in the actual JSON are allowed."""
+
+
+@dataclass
+class ConfigProcessString:
+    """Configuration for processing strings."""
+
+    regex_replacements: list[RegexReplacement] = field(default_factory=list)
+    """List of regex replacements."""
+
+
+@dataclass
+class ConfigCompareString:
+    """Configuration for comparing strings."""
+
+    diff_style: DiffStyle = DiffStyle.FULL
+    """The diff style to use."""
+
+
+@dataclass
+class ConfigComparison:
+    """Configuration for comparing actual and expected."""
+
+    comparison_type: ComparisonType
+    """The type of comparison."""
+
+    string_processing_config: ConfigProcessString = None
+    """The configuration for processing strings."""
+    string_comparison_config: ConfigCompareString = None
+    """The configuration for comparing strings."""
+    json_processing_config: ConfigProcessJson = None
+    """The configuration for processing JSON."""
+    json_comparison_config: ConfigCompareJson = None
+    """The configuration for comparing JSON."""
+
+
+def process_string(
+    actual: str,
+    configuration: ConfigProcessString,
+) -> str:
+    """
+    Processes a string according to the processing configuration.
+
+    Parameters
+    ----------
+    actual : str
+        The actual string.
+    configuration : ConfigProcessString
+        The processing configuration.
+
+    Returns
+    -------
+    str
+        The processed string.
+    """
+
+    # Apply regex replacements
+    for replacement in configuration.regex_replacements:
+        actual = re.sub(replacement.pattern, replacement.replacement, actual)
+
+    return actual
+
+
+def compare_string(
+    actual: str,
+    expected: str,
+    configuration: ConfigCompareString,
+) -> tuple[bool, str]:
+    """
+    Compares two strings according to the comparison configuration."
+
+    Parameters
+    ----------
+    actual : str
+        The actual string.
+    expected : str
+        The expected string.
+    configuration : ConfigCompareString
+        The comparison configuration.
+
+    Returns
+    -------
+    tuple[bool, str]
+        A tuple with a boolean indicating if the strings are equal and the diff.
+    """
+
+    if configuration.diff_style == DiffStyle.FULL:
+        return actual == expected, diff_color_code_full(actual, expected)
+    return actual == expected, diff_color_code_unified(actual, expected)
+
+
+def process_json(
+    actual: dict,
+    configuration: ConfigProcessJson,
+) -> dict:
+    """
+    Processes a dictionary according to the processing configuration.
+
+    Parameters
+    ----------
+    actual : dict
+        The actual dictionary.
+    configuration : ConfigProcessJson
+        The processing configuration.
+
+    Returns
+    -------
+    dict
+        The processed dictionary.
+    """
+
+    # Flatten the dictionaries
+    actual_flat = flatten(actual)
+
+    # Apply replacements
+    for replacement in configuration.replacements:
+        actual_flat[replacement.path] = replacement.value
+
+    # Apply explicit roundings
+    for rounding in configuration.roundings:
+        if not isinstance(actual_flat[rounding.path], (int, float)):
+            return (
+                False,
+                f"Expected number at rounding path '{rounding.path}' "
+                + f"but got '{type(actual_flat[rounding.path])}' (actual: {actual_flat[rounding.path]})",
+            )
+        actual_flat[rounding.path] = round(actual_flat[rounding.path], rounding.precision)
+
+    # Apply rounding to all numbers
+    for path, value in actual_flat.items():
+        if isinstance(value, (int, float)):
+            actual_flat[path] = round(value, configuration.precision)
+
+    # Unflatten and return
+    return unflatten(actual_flat)
+
+
+def compare_json(
+    actual: dict,
+    expected: dict,
+    configuration: ConfigCompareJson,
+) -> tuple[bool, list[Difference]]:
+    """
+    Compares two dictionaries according to the comparison configuration."
+
+    Parameters
+    ----------
+    actual : dict
+        The actual dictionary.
+    expected : dict
+        The expected dictionary.
+    configuration : ConfigCompareJson
+        The comparison configuration.
+
+    Returns
+    -------
+    tuple[bool, list[Difference]]
+        A tuple with a boolean indicating if the dictionaries are equal and a list of differences.
+    """
+
+    # Flatten the dictionaries
+    actual_flat = flatten(actual)
+    expected_flat = flatten(expected)
+
+    # Collect all differences
+    differences = []
+    for path in set(actual_flat.keys()) | set(expected_flat.keys()):
+        if path in configuration.ignores:
+            continue
+        if path not in actual_flat and not configuration.allow_missing_keys:
+            # MISSING KEY
+            differences.append(
+                Difference(
+                    expected=expected_flat[path],
+                    actual="",
+                    location=path,
+                    message="Missing key.",
+                )
+            )
+        elif path not in expected_flat and not configuration.allow_additional_keys:
+            # ADDITIONAL KEY
+            differences.append(
+                Difference(
+                    expected="",
+                    actual=actual_flat[path],
+                    location=path,
+                    message="Additional key.",
+                )
+            )
+        elif isinstance(expected_flat[path], (int, float)):
+            # NUMBER
+            if not isinstance(actual_flat[path], (int, float)):
+                differences.append(
+                    Difference(
+                        expected=expected_flat[path],
+                        actual=actual_flat[path],
+                        location=path,
+                        message="Expected number.",
+                    )
+                )
+            elif path in configuration.roundings:
+                if actual_flat[path] != expected_flat[path]:
+                    differences.append(
+                        Difference(
+                            expected=expected_flat[path],
+                            actual=actual_flat[path],
+                            location=path,
+                            message="Difference in value after explicit rounding.",
+                        )
+                    )
+            else:
+                if actual_flat[path] != expected_flat[path]:
+                    differences.append(
+                        Difference(
+                            expected=expected_flat[path],
+                            actual=actual_flat[path],
+                            location=path,
+                            message="Difference in value.",
+                        )
+                    )
+        elif actual_flat[path] != expected_flat[path]:
+            # SIMPLE EQUALITY
+            differences.append(
+                Difference(
+                    expected=expected_flat[path],
+                    actual=actual_flat[path],
+                    location=path,
+                    message="Difference in value.",
+                )
+            )
+
+    # Return the result
+    return not differences, differences
+
+
+def process(
+    actual_file: str,
+    configuration: ConfigComparison,
+    json_decoder: any = None,
+    json_encoder: any = None,
+):
+    """
+    Processes a file in place according to the processing configuration."
+    """
+
+    # Handle binary processing
+    if configuration.comparison_type == ComparisonType.BINARY:
+        return
+
+    # Read the file
+    with open(actual_file, "r") as f:
+        actual = f.read()
+
+    # Process the actual string
+    if configuration.string_processing_config:
+        actual = process_string(actual, configuration.string_processing_config)
+        if configuration.comparison_type == ComparisonType.STRING:
+            with open(actual_file, "w") as f:
+                f.write(actual)
+            return
+
+    # Decode the JSON
+    if json_decoder:
+        actual = json_decoder(actual)
+    else:
+        actual = json.loads(actual)
+
+    # Process the actual JSON
+    if configuration.json_processing_config:
+        actual = process_json(actual, configuration.json_processing_config)
+
+    # Write the processed JSON
+    if json_encoder:
+        actual = json_encoder(actual)
+    else:
+        actual = json.dumps(actual, indent=4)
+
+
+def compare(
+    actual_file: str,
+    golden_file: str,
+    configuration: ConfigComparison,
+    json_decoder: any = None,
+) -> tuple[bool, str, list[Difference]]:
+    """
+    Compares two files according to the comparison configuration."
+    """
+
+    # Handle binary comparison
+    if configuration.comparison_type == ComparisonType.BINARY:
+        with open(actual_file, "rb") as f:
+            actual = f.read()
+        with open(golden_file, "rb") as f:
+            expected = f.read()
+        equal = actual == expected
+        return equal, "Content is equal." if equal else "Content is not equal.", []
+
+    # Read the files
+    with open(actual_file, "r") as f:
+        actual = f.read()
+    with open(golden_file, "r") as f:
+        expected = f.read()
+
+    # Process the actual string
+    if configuration.string_processing_config:
+        actual = process_string(actual, configuration.string_processing_config)
+
+    # Handle string comparison
+    if configuration.comparison_type == ComparisonType.STRING:
+        equal, diff = compare_string(actual, expected, configuration.string_comparison_config)
+        return equal, diff, []
+
+    # Decode the JSON
+    if json_decoder:
+        actual = json_decoder(actual)
+        expected = json_decoder(expected)
+    else:
+        actual = json.loads(actual)
+        expected = json.loads(expected)
+
+    # Process the actual JSON
+    if configuration.json_processing_config:
+        actual = process_json(actual, configuration.json_processing_config)
+
+    # Handle JSON comparison
+    equal, differences = compare_json(actual, expected, configuration.json_comparison_config)
+    return equal, "Content is equal." if equal else "Content is not equal.", differences

goldie-0.1.1/goldie/diff.py

@@ -0,0 +1,120 @@
+import difflib
+from dataclasses import dataclass
+from enum import Enum
+
+
+@dataclass
+class Difference:
+    """
+    Represents a difference between expectation and actual.
+    """
+
+    expected: any
+    """The expected value."""
+    actual: any
+    """The actual value."""
+    location: str = None
+    """The location of the difference, if applicable."""
+    message: str = None
+    """The message of the difference, if applicable."""
+
+
+class DiffStyle(Enum):
+    FULL = "full"
+    UNIFIED = "unified"
+
+
+def _red(text):
+    return f"\x1b[38;2;255;0;0m{text}\x1b[38;2;255;255;255m"
+
+
+def _green(text):
+    return f"\x1b[38;2;0;255;0m{text}\x1b[38;2;255;255;255m"
+
+
+def _blue(text):
+    return f"\x1b[38;2;0;0;255m{text}\x1b[38;2;255;255;255m"
+
+
+def _cyan(text):
+    return f"\x1b[38;2;0;255;255m{text}\x1b[38;2;255;255;255m"
+
+
+def _white(text):
+    return f"\x1b[38;2;255;255;255m{text}\x1b[38;2;255;255;255m"
+
+
+def diff_color_code_full(old: str, new: str) -> str:
+    """
+    Returns a colored diff between two strings.
+
+    Parameters
+    ----------
+    old : str
+        The old string.
+    new : str
+        The new string.
+
+    Returns
+    -------
+    str
+        The colored diff.
+    """
+    result = ""
+    codes = difflib.SequenceMatcher(a=old, b=new).get_opcodes()
+    for code in codes:
+        if code[0] == "equal":
+            result += _white(new[code[3] : code[4]])
+        elif code[0] == "delete":
+            result += _red(old[code[1] : code[2]])
+        elif code[0] == "insert":
+            result += _green(new[code[3] : code[4]])
+        elif code[0] == "replace":
+            result += _red(old[code[1] : code[2]]) + _green(new[code[3] : code[4]])
+    return result
+
+
+def diff_color_code_unified(old: str, new: str, n: int = 3, line_sep: str = "\n") -> str:
+    """
+    Returns a colored diff between two strings based on lines.
+
+    Parameters
+    ----------
+    old : str
+        The old string.
+    new : str
+        The new string.
+    n : int, optional
+        The number of lines to show around the change, by default 3.
+    line_sep : str, optional
+        The line separator, by default "\n".
+
+    Returns
+    -------
+    str
+        The colored diff.
+    """
+    # Split the strings into lines using the provided line separator
+    old_lines = old.split(line_sep)
+    new_lines = new.split(line_sep)
+
+    # Use difflib to compare lines instead of characters
+    diff = difflib.unified_diff(old_lines, new_lines, n=n, lineterm="")
+    result = []
+
+    for line in diff:
+        if line.startswith("+"):
+            # New line (green)
+            result.append(_green(line))
+        elif line.startswith("-"):
+            # Removed line (red)
+            result.append(_red(line))
+        elif line.startswith("@@"):
+            # Hunk header (cyan or some other highlighting)
+            result.append(_cyan(line))
+        else:
+            # Context line or other lines (white)
+            result.append(_white(line))
+
+    # Join all lines with the provided line separator
+    return line_sep.join(result)

goldie-0.1.1/goldie/directory.py

@@ -0,0 +1,111 @@
+import glob
+import inspect
+import os.path
+import tempfile
+import unittest
+from dataclasses import dataclass
+
+from goldie.comparison import ConfigComparison, compare
+from goldie.execution import ConfigRun, ConfigRunValidation, execute
+from goldie.update import UPDATE
+
+
+@dataclass
+class ConfigDirectoryTest:
+    """Configuration for directory based golden file testing."""
+
+    file_filter: str
+    """The file filter to use to find test files."""
+    run_configuration: ConfigRun
+    """The run configuration to use to run the command."""
+    run_validation_configuration: ConfigRunValidation
+    """The run validation configuration to use to validate the command."""
+    comparison_configuration: ConfigComparison
+    """The configuration for comparing the actual and golden files."""
+
+
+def _get_golden_filename(path: str) -> str:
+    """
+    Get the golden filename from a path.
+
+    Parameters
+    ----------
+    path : str
+        The path to get the golden filename from.
+
+    Returns
+    -------
+    str
+        The golden filename.
+    """
+    return path + ".golden"
+
+
+def _get_caller_directory() -> str:
+    """
+    Get the directory of the caller's caller.
+
+    Returns
+    -------
+    str
+        The directory.
+    """
+    abs_path = os.path.abspath((inspect.stack()[2])[1])
+    directory_of_1py = os.path.dirname(abs_path)
+    return directory_of_1py
+
+
+def run_unittest(
+    test: unittest.TestCase,
+    configuration: ConfigDirectoryTest,
+):
+    """
+    Run the golden file test.
+
+    Parameters
+    ----------
+    test : unittest.TestCase
+        The test case to run.
+    configuration : ConfigDirectoryTest
+        The configuration for the golden file test.
+    """
+
+    # Find all relevant files in the directory
+    root_directory = _get_caller_directory()
+    test_files = glob.glob(os.path.join(root_directory, configuration.file_filter))
+
+    # Remove any golden files
+    test_files = [f for f in test_files if not f.endswith(".golden")]
+
+    # Iterate over the test cases
+    for i, (input_file) in enumerate(test_files):
+        with test.subTest(file=input_file), tempfile.NamedTemporaryFile("w+") as output_file:
+            # Get the golden file
+            golden_file = _get_golden_filename(input_file)
+
+            # Run the command
+            exit_code = execute(input_file, output_file.name, configuration.run_configuration)
+
+            # Assert the exit code
+            if configuration.run_validation_configuration.validate_exit_code:
+                test.assertEqual(
+                    exit_code,
+                    configuration.run_validation_configuration.expected_exit_code,
+                    f"Expected exit code {configuration.run_validation_configuration.expected_exit_code}, but got {exit_code}.",
+                )
+
+            # Update the golden file if necessary
+            if UPDATE:
+                with open(golden_file, "w") as f:
+                    f.write(output_file.read())
+                continue
+
+            # Compare the actual and golden files
+            equal, message, differences = compare(output_file.name, golden_file, configuration.comparison_configuration)
+            # Prepare the message
+            if differences:
+                message += "\n" + "\n".join(
+                    [f"{d.location}: {d.message} ({d.expected} != {d.actual})" for d in differences]
+                )
+            # Assert the comparison
+            test.assertTrue(equal, message)

goldie-0.1.1/goldie/execution.py

@@ -0,0 +1,92 @@
+import subprocess
+from dataclasses import dataclass
+from enum import Enum
+
+
+class InputMode(Enum):
+    STDIN = "stdin"
+    """Feeds the input file via stdin."""
+    NONE = "none"
+    """Does not feed anything to the stdin."""
+
+
+class OutputMode(Enum):
+    STDOUT = "stdout"
+    """Intercepts only stdout."""
+    STDERR = "stderr"
+    """Intercepts only stderr."""
+    BOTH = "both"
+    """Intercepts both stdout and stderr."""
+    NONE = "none"
+    """Does not intercept anything, i.e., ignores the output."""
+
+
+@dataclass
+class ConfigRun:
+    """Configuration for running a command."""
+
+    cmd: str
+    """The command to run."""
+    args: list[str]
+    """
+    The arguments to pass to the command.
+    If the path to the input file is needed (instead of feeding via stdin), use the string "{input}".
+    If the path to the output file is needed (instead of reading stdout), use the string "{output}".
+    """
+    input_mode: InputMode = InputMode.STDIN
+    """The input mode."""
+    output_mode: OutputMode = OutputMode.STDOUT
+    """The output mode."""
+
+
+@dataclass
+class ConfigRunValidation:
+    """Configuration for validating the command"""
+
+    validate_exit_code: bool = True
+    """Whether to validate the exit code of the command."""
+    expected_exit_code: int = 0
+    """The desired exit code of the command."""
+
+
+def execute(
+    input_file: str,
+    output_file: str,
+    configuration: ConfigRun,
+) -> int:
+    """
+    Run the command with the input file and return the result.
+
+    Parameters
+    ----------
+    input_file : str
+        The file to read the input from.
+    output_file : str
+        The file to write the output to.
+    configuration : ConfigRun
+        The configuration for running the command.
+
+    Returns
+    -------
+    int
+        The exit code of the command.
+    """
+    # Replace the placeholders in the arguments
+    args = [arg.format(input=input_file, output=output_file) for arg in configuration.args]
+
+    # Run the command
+    with open(output_file, "w") as f:
+        input_file = None if configuration.input_mode == InputMode.NONE else open(input_file, "r")
+        process = subprocess.run(
+            [configuration.cmd, *args],
+            stdin=input_file if configuration.input_mode == InputMode.STDIN else None,
+            stdout=f if configuration.output_mode in [OutputMode.STDOUT, OutputMode.BOTH] else None,
+            stderr=f if configuration.output_mode in [OutputMode.STDERR, OutputMode.BOTH] else None,
+        )
+
+    # Close the input file if necessary
+    if input_file is not None:
+        input_file.close()
+
+    # Return the exit code and the path to the output file
+    return process.returncode

goldie-0.1.1/goldie/tests/test_diff.py

@@ -0,0 +1,33 @@
+import os
+import unittest
+
+import goldie.diff
+
+
+def _file_path(relative_path: str) -> str:
+    """
+    Returns the full path to a file relative to the testdata directory.
+
+    Parameters
+    ----------
+    relative_location : str
+        The relative location of the file (e.g.: just the file name).
+
+    Returns
+    -------
+    str
+        The full path to the file.
+    """
+
+    return os.path.join(os.path.dirname(__file__), "testdata", relative_path)
+
+
+class TestDiff(unittest.TestCase):
+    def test_diff(self):
+        with open(_file_path("comparison-1.txt")) as f:
+            comparison_1 = f.read()
+        with open(_file_path("comparison-2.txt")) as f:
+            comparison_2 = f.read()
+
+        diff = goldie.diff.diff_color_code_unified(comparison_1, comparison_2)
+        self.assertEquals(diff, "", diff)

goldie-0.1.1/goldie/tests/testdata/comparison-1.txt

@@ -0,0 +1,10 @@
+In a quiet village, where the sunbeams play, there's a charm that whispers, "Stay, don't stray."
+Beneath the willow, by the babbling brook, secrets shared in shadows, in a well-worn book.
+The baker's oven fills the air so sweet, as children laugh and chase in the cobblestone street.
+A painter captures hues of twilight's glow, while lovers dance in soft, enchanting flow.
+The market bustles with a lively tune, fresh blooms and treasures under the afternoon sun.
+An old man tells tales of days gone by, his eyes alight with memories that never die.
+The village bell rings, echoing so clear, a call to gather, friends both far and near.
+In gardens lush, where roses softly bloom, a sense of peace and calm dispels all gloom.
+As stars above twinkle in the night, the village dreams, bathed in soft moonlight.
+With every dawn, a new day's promise gleams, in this charming haven, where the heart finds dreams.

goldie-0.1.1/goldie/tests/testdata/comparison-2.txt

@@ -0,0 +1,10 @@
+In a quiet village, where the sunbeams play, there's a charm that whispers, "Stay, don't stray."
+Beneath the willow, by the babbling brook, secrets shared in shadows, in a well-worn book.
+The baker's oven fills the air so sweet, as children laugh and chase in the cobblestone street.
+A painter captures hues of twilight's glow, while lovers dance in soft, enchanting flow.
+The market bustles with a lively tune, fresh blooms and treasures under the afternoon sun.
+An old man tells tales of days gone by, his eyes alight with memories that never die.
+The village bell rings, echoing so clear, a call to gather, friends both far and near.
+In gardens lush, where roses softly bloom, a sense of peace and calm dispels all gloom.
+As stars above twinkle in the night, the village dreams, bathed in soft sunlight.
+With every dawn, a new day's promise gleams, in this charming haven, where the heart finds dreams.

goldie-0.1.1/goldie/update.py

@@ -0,0 +1,6 @@
+import os
+
+UPDATE = os.environ.get("GOLDIE_UPDATE", "false").lower() in ["true", "1"]
+"""
+Whether to update the golden files.
+"""

goldie-0.1.1/pyproject.toml

@@ -0,0 +1,41 @@
+[build-system]
+build-backend = "hatchling.build"
+requires = ["hatchling >= 1.13.0"]
+
+[project]
+authors = [
+    { email = "merschformann@proton.me", name = "Marius Merschformann" }
+]
+classifiers = [
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13"
+]
+dependencies = []
+description = "A humble library greasing the gears of golden file tests"
+dynamic = [
+    "version",
+]
+keywords = [
+    "golden file",
+    "testing",
+    "test",
+    "integration test",
+]
+license = { file = "LICENSE" }
+maintainers = [
+    { email = "merschformann@proton.me", name = "Marius Merschformann" }
+]
+name = "goldie"
+readme = "README.md"
+requires-python = ">=3.11"
+
+[project.urls]
+Homepage = "https://github.com/merschformann/goldie"
+Repository = "https://github.com/merschformann/goldie"
+
+[tool.hatch.version]
+path = "goldie/__about__.py"