Merge pull request #42 from jams2/feature/snapshot-tests

Use snapshot tests instead of HTML fixtures

.github/workflows/test.yml

@@ -32,6 +32,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v2
+        id: setup-python
         with:
           python-version: ${{ env.PYTHON_VERSION }}
       - uses: snok/install-poetry@v1
@@ -43,11 +44,15 @@ jobs:
         uses: actions/cache@v2
         with:
           path: .venv
-          key: ${{ runner.os }}-python-${{ env.PYTHON_VERSION }}-${{ hashFiles('**/poetry.lock') }}
+          key: ${{ runner.os }}-python-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
       - if: steps.poetry-cache.outputs.cache-hit != 'true'
         run: poetry install --no-interaction --no-root
       - run: poetry run flake8 tbxforms tests
       - run: poetry run isort tbxforms tests --check-only --diff
       - run: poetry run black tbxforms tests --check
+      # Enforce strict formatting on the snapshots
+      - run: poetry run djlint --check tests
+      # Lint the project's templates
+      - run: poetry run djlint tbxforms
       - run: poetry run pytest
       - run: poetry build

.pre-commit-config.yaml

@@ -16,7 +16,7 @@ repos:
       - id: debug-statements
       - id: detect-private-key
   - repo: https://github.com/timothycrosley/isort
-    rev: 5.10.1
+    rev: 5.12.0
     hooks:
       - id: isort
   - repo: https://gitlab.com/pycqa/flake8
@@ -35,3 +35,15 @@ repos:
     rev: v2.3.2
     hooks:
       - id: prettier
+  - repo: local
+    hooks:
+      - id: djlint-templates
+        name: Lint project templates
+        language: python
+        files: tbxforms/.*\.html$
+        entry: djlint
+      - id: djlint-snapshots
+        name: Check snapshot formatting
+        language: python
+        files: tests/.*\.html$
+        entry: djlint --check

.prettierignore

@@ -2,4 +2,5 @@ node_modules
 .tox
 *.html
 dist
-tests
+tests
+.mypy_cache

CHANGELOG.md

@@ -4,16 +4,12 @@
 
 ## Unreleased
 
----
-
-## [vx.y.z](https://github.com/torchbox/tbxforms/releases/tag/x.y.z) (Template: https://keepachangelog.com/en/1.0.0/)
-
-### Added
-
 ### Changed
 
-### Fixed
+-   Use snapshot testing plugin (syrupy) for component rendering tests instead of HTML fixtures
 
-### Removed
+### Added
 
-### How to upgrade
+-   Template linting to CI using `djlint`
+-   Snapshot formatting check to CI using `djlint`
+-   Autoformatting of snapshots using `djlint`

CONTRIBUTING.md

@@ -19,6 +19,12 @@ pre-commit install
 npm install
 ```
 
+### Python testing
+
+Run the Python tests with `poetry run pytest`.
+
+If your changes cause snapshot tests to fail, verify that the changes you have caused are expected. Update the snapshots with `poetry run pytest --snapshot-update`.
+
 ### Publishing
 
 1. `pre-commit` - run linters