Merge pull request #19 from adafruit/add-tests

Add tests

Author: tannewt

.github/workflows/build.yml

@@ -50,6 +50,10 @@ jobs:
     - name: Pre-commit hooks
       run: |
         pre-commit run --all-files
+    - name: Run tests
+      run: |
+        cd tests/ && python -m unittest discover
+        cd ..
     - name: Build assets
       run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location .
     - name: Archive bundles

adafruit_pioasm.py

@@ -170,7 +170,7 @@ def assemble(text_program):
                 raise RuntimeError("Set value out of range")
             assembled[-1] |= value
         else:
-            raise RuntimeError("Unknown instruction:" + instruction)
+            raise RuntimeError("Unknown instruction:" + instruction[0])
         assembled[-1] |= delay << 8
     # print(hex(assembled[-1]))
 

tests/testpioasm.py

@@ -0,0 +1,69 @@
+# SPDX-FileCopyrightText: 2021 Jeff Epler, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+# pylint: disable=missing-module-docstring,invalid-name,missing-function-docstring,missing-class-docstring
+
+import pathlib
+import sys
+import unittest
+
+sys.path.insert(0, str(pathlib.Path(__file__).absolute().parent.parent))
+
+import adafruit_pioasm  # pylint: disable=wrong-import-position
+
+
+def nice_opcode(o):
+    o = f"{o:016b}"
+    return o[:3] + "_" + o[3:8] + "_" + o[8:]
+
+
+class TestNop(unittest.TestCase):
+    def assertAssemblesTo(self, source, expected):
+        actual = adafruit_pioasm.assemble(source)
+        expected_bin = [nice_opcode(x) for x in expected]
+        actual_bin = [nice_opcode(x) for x in actual]
+        self.assertEqual(
+            expected_bin,
+            actual_bin,
+            f"Assembling {source!r}: Expected {expected_bin}, got {actual_bin}",
+        )
+
+    def assertAssemblyFails(self, source):
+        self.assertRaises(RuntimeError, adafruit_pioasm.assemble, source)
+
+    def testNonsense(self):
+        self.assertAssemblyFails("nope")
+
+    def testNop(self):
+        self.assertAssemblesTo("nop", [0b101_00000_010_00_010])
+        self.assertAssemblesTo(
+            "nop\nnop", [0b101_00000_010_00_010, 0b101_00000_010_00_010]
+        )
+        self.assertAssemblesTo("nop [1]", [0b101_00001_010_00_010])
+        self.assertAssemblesTo(".side_set 1\nnop side 1", [0b101_10000_010_00_010])
+        self.assertAssemblesTo(".side_set 1\nnop side 1 [1]", [0b101_10001_010_00_010])
+
+    def testJmp(self):
+        self.assertAssemblesTo("l:\njmp l", [0b000_00000_000_00000])
+        self.assertAssemblesTo("l:\njmp 7", [0b000_00000_000_00111])
+        self.assertAssemblesTo("jmp l\nl:", [0b000_00000_000_00001])
+        self.assertAssemblesTo("jmp !x, l\nl:", [0b000_00000_001_00001])
+        self.assertAssemblesTo("jmp x--, l\nl:", [0b000_00000_010_00001])
+        self.assertAssemblesTo("jmp !y, l\nl:", [0b000_00000_011_00001])
+        self.assertAssemblesTo("jmp y--, l\nl:", [0b000_00000_100_00001])
+        self.assertAssemblesTo("jmp x!=y, l\nl:", [0b000_00000_101_00001])
+        self.assertAssemblesTo("jmp pin, l\nl:", [0b000_00000_110_00001])
+        self.assertAssemblesTo("jmp !osre, l\nl:", [0b000_00000_111_00001])
+
+    def testWait(self):
+        self.assertAssemblesTo("wait 0 gpio 0", [0b001_00000_0_00_00000])
+        self.assertAssemblesTo("wait 0 gpio 1", [0b001_00000_0_00_00001])
+        self.assertAssemblesTo("wait 1 gpio 2", [0b001_00000_1_00_00010])
+        self.assertAssemblesTo("wait 0 pin 0", [0b001_00000_0_01_00000])
+        self.assertAssemblesTo("wait 0 pin 1", [0b001_00000_0_01_00001])
+        self.assertAssemblesTo("wait 1 pin 2", [0b001_00000_1_01_00010])
+        self.assertAssemblesTo("wait 0 irq 0", [0b001_00000_0_10_00000])
+        self.assertAssemblesTo("wait 0 irq 0 rel", [0b001_00000_0_10_10000])
+        self.assertAssemblesTo("wait 1 irq 0", [0b001_00000_1_10_00000])
+        self.assertAssemblesTo("wait 0 irq 1 rel", [0b001_00000_0_10_10001])