From b197cb144ad3372322c676fa1d51696ed1d2671a Mon Sep 17 00:00:00 2001
From: Phil Howard <github@gadgetoid.com>
Date: Sun, 16 Jun 2024 14:18:39 +0100
Subject: [PATCH] CI: Test fixtures.

---
 .github/workflows/qa.yml                      |  39 ++++++++++++++++
 .github/workflows/test.yml                    |  40 ++++++++++++++++
 ...validate_data.cpython-312-pytest-8.2.2.pyc | Bin 0 -> 4150 bytes
 tests/test_validate_data.py                   |  43 ++++++++++++++++++
 tox.ini                                       |  25 ++++++++++
 5 files changed, 147 insertions(+)
 create mode 100644 .github/workflows/qa.yml
 create mode 100644 .github/workflows/test.yml
 create mode 100644 tests/__pycache__/test_validate_data.cpython-312-pytest-8.2.2.pyc
 create mode 100644 tests/test_validate_data.py
 create mode 100644 tox.ini

diff --git a/.github/workflows/qa.yml b/.github/workflows/qa.yml
new file mode 100644
index 0000000..54e0ca1
--- /dev/null
+++ b/.github/workflows/qa.yml
@@ -0,0 +1,39 @@
+name: QA
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  test:
+    name: linting & spelling
+    runs-on: ubuntu-latest
+    env:
+      TERM: xterm-256color
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Set up Python '3,11'
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install Dependencies
+        run: |
+          make dev-deps
+
+      - name: Run Quality Assurance
+        run: |
+          make qa
+
+      - name: Run Code Checks
+        run: |
+          make check
+
+      - name: Run Bash Code Checks
+        run: |
+          make shellcheck
\ No newline at end of file
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
new file mode 100644
index 0000000..71bac7f
--- /dev/null
+++ b/.github/workflows/test.yml
@@ -0,0 +1,40 @@
+name: Tests
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  test:
+    name: Python ${{ matrix.python }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: ['3.9', '3.10', '3.11']
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: Install Dependencies
+        run: |
+          make dev-deps
+
+      - name: Run Tests
+        run: |
+          make pytest
+
+      - name: Coverage
+        if: ${{ matrix.python == '3.9' }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          python -m pip install coveralls
+          coveralls --service=github
\ No newline at end of file
diff --git a/tests/__pycache__/test_validate_data.cpython-312-pytest-8.2.2.pyc b/tests/__pycache__/test_validate_data.cpython-312-pytest-8.2.2.pyc
new file mode 100644
index 0000000000000000000000000000000000000000..c21eb4beedf0bc23bfefb3c207b993d161f7dead
GIT binary patch
literal 4150
zcmd5<OK%)S5bmDo*`0m(5$9z)Je<S{9w2t&yogA62nWdmjKt%B1&k)?vAt%!v+ABa
zY-XetaIhr=Mj*vVIfMfT<e$PRGFGC&5|KC{Zs6Q<qN?YyV=zjDe4w>kUEN*XU0u~(
zU(Jsl9c2RL@UM-jah;G~v5^)nVeY>U%niZ`r*$$(RjtkGmo-Y}*rY+@k-}s_jT9$~
zT>Fennp_83;tXh+8$c_(0JJ(!t>W*v^u%SF?0{7f{-6Q5UjTZ81h88lG(#GY*}NR|
zVc{CrR}&3G;6pvo0{x@2FoOk5e(U2}s?4&KYu6lPrYJXX&Xl&ANbrJ>TBtH>rd+#T
zP1vhM?#->QEZCMpF3?sJokd=<x>ahcWP`%~ZLPPH)zejZ@us#=fU_Fh<fXu<QPnE=
zUFi<FmAccub{!PbmD2hX@auINGPL7tPg^qOLdMHsQ6m8his_ut49qGCOF>C~$HBY*
zbL+8G@0@M6vvPL6hsc@fdc1m*Df^cn+5Y8pZd#}I2OkvSZ-%9LVs%VJtl`YL5%cGp
zZbU5lKs$KBq6<AohMM!oEje)T!T_=-Eg6;OJnq^kXlaoS!$?jpbUISH!dGIaK@2)i
zKcFuzOeFmcFCIH%$@0gz7BB<xs-tNaFi98eIqWvLyjJsP%Ha^opR%M?4lO21a942o
zQ6#63oUzK0KJEHZ`K9K(?@HfxM6}Dk?9}VFaGT<?H`jE88&zT0zI3Hl_iGIq73v;H
z$f(zrGv1XtSEBZG-Mi$}ZDo#<EuASBSBN@aR>!M(jf+BfBHC?Fd1B7-ZTEV!?lc@9
zMj|s+*{Vd0JH8|E#S47mQ3dyoZ84f}oQNCoYNzszGkLL-`Nrvd<7|G;bFu=P4YbRH
zH%HzDzsQkkhl7Q@8Xp;Ruex=wIp;R~k!G#oUGa}ypI=DX(c`11M$m>*QTwV>ufb7V
z8_zS`oR4;8Jx<-X@iK@(*wcW&{2oY)+^uvi7naVq#_o3SxnX`~uI#(jv(`P>8vl*;
z-}$e<b=Ln2J9=j)em}9J_d!vz1sBj$3KwD&`WG~y(<DO!8qhKFK?g)ft^I=A5t)+D
zyBLAjrA<Vo)Kt>a1jb2aGD{cz$Ug-nGBXj>0vsp~V|O*PHn>Vy&;=V3i3}JzvG0Lf
zm)5$i*7&_Wk8cuc3@(}*X5Y%tx_S6d9h%|@NN+hT-bi)WcYtmML9Qt{)BqTD#p%E?
z#j$_}+5$K_H2e%IgDl*Ig}?|39}U5HF(@um$=hbx795SB2;it@<-n2dSa_#t(0eF2
zW|9DolxsVt!GD8ijTawTgT9=Nw@DCuaCBTUTjXbK155v$0X8Xe_Q)FL6OnB+YTuWK
zdL_GApaILBa~rMOi3T@s8VV#KVd3S#Oj4H8BSU5>wNzRskZB-f!X0PHqc8irQ`-g^
z%w~_iG7%ZqYTTcR3NvnPdd80`o~S{{jgf-EYnBMJ7Z7I8D}Y0seOlq?34pqR3o$sJ
zO~DbE1RMbg)dYZ9K*UI|yA8|8VDW_L1ib{}0Al0WEy#Q>M&@%?SsX{HT}Utu6L=W0
z2gzO}`;hEM(u)M+ja7-m)ic=fERthLhLIcqk_V+T;z{g2gxv~tV|+V-$pW1GZy*(i
zx~?qL&A1Mrihv}WphogG5Quiw?&bYUZ?rDn?bx+EwDe)?)w@0Wmc!dUM_R9Ckn`J4
z0K|@<OuWc#cJyA?Zj8$Pi~5GSXZh`Qvk#+k|39NLB-(LQ{sNdAq#a{t(@!MmPm7O$
zs|tR?q@a}ES@@iRIEGPsHv7~_#GzVESh&dmM(@Mwp%&^sCRVBh*#`jJ=N<)O`b0!U
zRE#|%EhA#H5;7iE_Z%KEujw`-qvpGFQhCi{5u2*j-T1;FwBj>Br%G&KdJ_A5cjog;
zo+G%8i;9;~1pe{`AT6>{>H6~A(z$QmSsA>ge{HW-j<m+^^**-p-nU(MdXL@iJ+{_6
zf(9N~sxGp{sSR`gN@3l65{*0%8yS|#3hu9<?=4`q7&#MZGho;R=tB5XOddXMhoT@G
z&mO)uvCyH;B1fJc#^XSi%rL1`$AX4|hLPe$*hQjWQ&T*l64!0)VaF3Lf-GhV5(!wP
z+WqDD()hBsRz2Ffc&~den&8kP+b|ETjIEmo@%V?-@vV-?Op{*q%%eU#PLqe@d=ygG
zVc}jA;6KPz(mXdRCVg>`cm;M9&m$Q`f&oFfS{+NEaz7BYopS60^E_mRSL*Hy;x!mT
tBT7gN$R9eT^cO-tBcE1&CY8;CL7&>}W^{0~vqbwhdl?<L-^pmK_+R(v8c+ZL

literal 0
HcmV?d00001

diff --git a/tests/test_validate_data.py b/tests/test_validate_data.py
new file mode 100644
index 0000000..dea8e97
--- /dev/null
+++ b/tests/test_validate_data.py
@@ -0,0 +1,43 @@
+import glob
+import json
+
+
+def validate_alt_mode(data):
+    name = data["name"]
+    mode_type = data.get("type", "")
+
+    assert mode_type != ""
+    assert not mode_type.endswith("?")
+
+
+def validate_pin(data):
+    alt_modes = data.get("alt_modes", [])
+
+    for alt_mode in alt_modes:
+        validate_alt_mode(alt_mode)
+
+
+def validate_header(data):
+    width = data["width"]
+    height = data["height"]
+    orientation = data["orientation"]
+    pins = data["pins"]
+
+    assert width * height == len(pins)
+
+    for pin in pins:
+        validate_pin(pin)
+
+
+def validate_board_json(file):
+    data = json.load(open(file, "r"))
+
+    for name, header in data["headers"].items():
+        validate_header(header)
+
+
+def test_validate_board_json_files():
+    files = glob.glob("boards/*.json")
+
+    for file in files:
+        validate_board_json(file)
\ No newline at end of file
diff --git a/tox.ini b/tox.ini
new file mode 100644
index 0000000..750dd62
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,25 @@
+[tox]
+envlist = py,qa
+skip_missing_interpreters = True
+isolated_build = true
+minversion = 4.0.0
+
+[testenv]
+commands =
+	coverage run -m pytest -v -r wsx
+	coverage report
+deps =
+	mock
+	pytest>=3.1
+	pytest-cov
+	build
+
+[testenv:qa]
+commands =
+	isort --check .
+	ruff check .
+	codespell .
+deps =
+	ruff
+	codespell
+	isort
\ No newline at end of file