Initial implementation of util script & tests

Author: PeterJCLaw

.github/workflows/main.yml

@@ -0,0 +1,48 @@
+name: main
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  run-checks:
+    strategy:
+      matrix:
+        python-version: ['3.8', '3.9', '3.10', '3.11']
+        test-os: [ubuntu-latest]
+
+    runs-on: ${{ matrix.test-os }}
+    defaults:
+      run:
+        shell: bash
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Check dependency-free runtime
+        run: |
+          base=$PWD
+          cd $(mktemp --directory)
+          echo foo > foo.out
+          python3 $base/validate-generated-files.py --files foo.out -- bash -c 'echo foo > foo.out'
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+          cache-dependency-path: '**/requirements.txt'
+
+      - name: Install test dependencies
+        run: pip install -r script/requirements-dev.txt
+
+      - name: Lint
+        run: ./script/linting/lint
+
+      - name: Typecheck
+        run: ./script/typing/check
+
+      - name: Test
+        run: ./run-tests

README.md

@@ -1,2 +1,9 @@
 # validate-generated-files
-Action to validate generated files stored in a repository
+
+A GitHub Action to validate generated files stored in a repository.
+
+This is typically useful in contexts where, for one reason or another, generated
+files are stored in a version control repository alongside their inputs.
+
+This Action is implemented in Python 3, which must be available within the
+runner environment.

run-tests

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+python3 $(dirname $0)/tests.py "$@"

script/check

@@ -0,0 +1,14 @@
+#!/bin/sh
+
+cd $(dirname $0)/..
+
+./run-tests
+result=$?
+
+./script/linting/lint
+result=$((result | $?))
+
+./script/typing/check
+result=$((result | $?))
+
+exit $result

script/linting/lint

@@ -0,0 +1,5 @@
+#!/bin/bash
+if [ -z "$FLAKE8" ]; then
+    FLAKE8=flake8
+fi
+exec "$FLAKE8" validate-generated-files.py tests.py "$@"

script/linting/requirements.txt

@@ -0,0 +1,16 @@
+# Need 3.8 for fixes around typing comments
+flake8>=3.8
+flake8-bugbear
+flake8-builtins
+flake8-commas
+flake8-comprehensions
+flake8-debugger
+flake8-fixme
+flake8-isort
+flake8-noqa
+flake8-tuple
+
+isort
+
+# flake8-commas has an implicit dependency on pkg_resources
+setuptools

script/requirements-dev.txt

@@ -0,0 +1,2 @@
+-r linting/requirements.txt
+-r typing/requirements.txt

script/typing/check

@@ -0,0 +1,5 @@
+#!/bin/bash
+if [ -z "$MYPY" ]; then
+    MYPY=mypy
+fi
+exec "$MYPY" validate-generated-files.py tests.py

script/typing/requirements.txt

@@ -0,0 +1,2 @@
+# Version for enable_error_code = ignore-without-code
+mypy>=0.940

setup.cfg

@@ -0,0 +1,60 @@
+[flake8]
+exclude =
+    .eggs,
+    .git,
+    .pybuild,
+    __pycache__,
+    build,
+    script
+ignore =
+    # Don't require set comprehensions
+    C401
+    # W503 and W504 conflict; ignore the one that disagrees with recent PEP8.
+    W503
+
+# try to keep it below 85, but this allows us to push it a bit when needed.
+max_line_length = 95
+
+noqa-require-code = true
+
+
+[isort]
+atomic = True
+balanced_wrapping = True
+combine_as_imports = True
+include_trailing_comma = True
+length_sort = True
+multi_line_output = 3
+order_by_type = False
+
+default_section = THIRDPARTY
+sections = FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
+
+
+[mypy]
+strict = True
+
+disallow_any_explicit = True
+disallow_any_generics = True
+disallow_subclassing_any = True
+
+disallow_untyped_defs = True
+check_untyped_defs = True
+disallow_untyped_decorators = True
+
+no_implicit_optional = True
+strict_optional = True
+
+warn_redundant_casts = True
+warn_unused_ignores = True
+warn_return_any = True
+warn_unreachable = True
+
+implicit_reexport = False
+strict_equality = True
+
+scripts_are_modules = True
+warn_unused_configs = True
+
+show_error_codes = True
+enable_error_code = ignore-without-code