Make changes to support HitL testing. #69

haydenroche5 · 2023-08-01T23:10:24Z

Rename all examples so that they have underscores instead of hyphens. .py files with hyphens in their names can't be imported.
Add a test/hitl/ directory with one test (so far): cpy_test.py. This test makes sure that cpy_example.py runs successfully on a CircuitPython host connected to a Notecard. I tested using a Notecarrier F and a Swan.
cpy_test.py relies on pyboard.py from MicroPython. I have added that file from MicroPython's master branch here.

Mat's Notes:

I piggy-backed this PR rather than add a separate one.
Added HIL workflows for MicroPython and CircuitPython (pretty heavy lift.)
Added pre-commit hook to catch all the petty things.
We can add a pre-commit hook to check if pyboard.py has changed from the latest version on github. (I have not done this, left as an exercise for the reader ;-P)

haydenroche5 · 2023-08-01T23:11:32Z

test/hitl/pyboard.py

Not sure how we want to support this dependency. Single file submodule? It really is a great tool, and it works well with both MicroPython and CircuitPython.

examples/notecard-basics/cpy_example.py

…locally.

m-mcgowan · 2023-08-10T17:39:31Z

initial HIL tests for note-python

…ort can still remain locked, causing the next test to fail.

…he main example. This allows different boards to be easily targeted.

… tests only when key files changed, so they don't run unnecessarily.

haydenroche5

Good stuff @m-mcgowan!

haydenroche5 · 2023-08-11T17:56:54Z

test/scripts/check_cpy_runner_config.sh

+    exit 1
+fi
+
+exit 0


Missing newline at end of file.

added pre-commit checks to catch this.

haydenroche5 · 2023-08-11T18:02:10Z

.github/workflows/hil-circuitpython.yml

+      - name: Make CircuitPython filesystem writeable to pyboard
+        if: ${{ matrix.lock_cpy_filesystem }}
+        run: |
+          timeout $USB_MSD_ATTACH_TIME bash test/scripts/wait_for_file.sh "$CPY_FS_CIRCUITPY"


Is this redundant since we already waited for the file to exist at line 104?

The previous step may not have run since it's conditional. But I want the check in the previous step to keep the check close to the behavior that affects it.

haydenroche5 · 2023-08-11T18:03:07Z

.github/workflows/hil-circuitpython.yml

+
+          # only copy if it's changed or not present. After the device has reset, no further changes can be made
+          # until the filesystem is erased. This allows the workflow to be rerun flash_device=false
+          diff test/hitl/boot.py "$CPY_FS_CIRCUITPY/boot.py" || test/hitl/boot.py "$CPY_FS_CIRCUITPY"


Should test/hitl/boot.py "$CPY_FS_CIRCUITPY" be cp test/hitl/boot.py "$CPY_FS_CIRCUITPY"?

haydenroche5 · 2023-08-11T18:06:51Z

.github/workflows/hil-micropython.yml

+        default: true
+
+jobs:
+  huzzah32:


Should this be called test instead, to mirror hil-circuitpython.yml?

Yes, I had the same thought when I renamed it. The matrix parameters show up in the job run so no need to name it specifically.

haydenroche5 · 2023-08-11T18:07:37Z

test/scripts/check_mpy_runner_config.sh

+    exit 1
+fi
+
+exit 0


Missing newline at EOF.

haydenroche5 · 2023-08-11T18:10:25Z

examples/notecard-basics/board.py

+UART=2
+
+"""
+The SCL pin of the I2C bus connected to Notecard


This comment seems slightly misplaced.

Fixed it up when making a pep8 pass through.

examples/notecard-basics/mpy_example.py

mpy_board/espressif_esp32.py

mpy_board/huzzah32.py

mpy_board/espressif_esp32.py

``` b'Performing initial setup\r\nMicroPython v1.20.0 on 2023-04-26; ESP32 module with ESP32\r\nType "help()" for more information.\r\n>>> ' INTERNALERROR> pyb.enter_raw_repl() INTERNALERROR> File "/home/mat/runners/notecard-nbgl-carr_f-huzzah32-serial/_work/note-python/note-python/test/hitl/deps/pyboard.py", line 367, in enter_raw_repl INTERNALERROR> raise PyboardError("could not enter raw repl") INTERNALERROR> pyboard.PyboardError: could not enter raw repl ```

m-mcgowan

I'll leave it to you to approve the final review.

m-mcgowan · 2023-08-11T19:03:40Z

test/scripts/check_cpy_runner_config.sh

+    exit 1
+fi
+
+exit 0


added pre-commit checks to catch this.

m-mcgowan · 2023-08-11T19:04:42Z

.github/workflows/hil-circuitpython.yml

+      - name: Make CircuitPython filesystem writeable to pyboard
+        if: ${{ matrix.lock_cpy_filesystem }}
+        run: |
+          timeout $USB_MSD_ATTACH_TIME bash test/scripts/wait_for_file.sh "$CPY_FS_CIRCUITPY"


The previous step may not have run since it's conditional. But I want the check in the previous step to keep the check close to the behavior that affects it.

m-mcgowan · 2023-08-11T19:07:50Z

.github/workflows/hil-micropython.yml

+        default: true
+
+jobs:
+  huzzah32:


Yes, I had the same thought when I renamed it. The matrix parameters show up in the job run so no need to name it specifically.

m-mcgowan · 2023-08-11T19:09:00Z

examples/notecard-basics/board.py

+UART=2
+
+"""
+The SCL pin of the I2C bus connected to Notecard


Fixed it up when making a pep8 pass through.

examples/notecard-basics/mpy_example.py

m-mcgowan · 2023-08-12T16:26:58Z

HIL tests for note-python on MicroPython

m-mcgowan · 2023-08-15T19:49:17Z

Since Hayden is also an author for this PR, he cannot approve a review. Merging with offline approval from him.

haydenroche5 requested a review from m-mcgowan August 1, 2023 23:10

haydenroche5 self-assigned this Aug 1, 2023

haydenroche5 commented Aug 1, 2023

View reviewed changes

haydenroche5 force-pushed the hitl branch from c4f1dc6 to e3b1bb5 Compare August 1, 2023 23:19

haydenroche5 commented Aug 1, 2023

View reviewed changes

examples/notecard-basics/cpy_example.py Show resolved Hide resolved

haydenroche5 force-pushed the hitl branch 3 times, most recently from 25373cc to 9c106bb Compare August 8, 2023 23:39

Make changes to support HitL testing.

8f218a5

haydenroche5 force-pushed the hitl branch from 9c106bb to 8f218a5 Compare August 8, 2023 23:41

m-mcgowan added 2 commits August 10, 2023 02:40

HIL tests for CircuitPython

e6d2ade

fuller definition of runner labels

127f161

m-mcgowan self-assigned this Aug 10, 2023

m-mcgowan added 2 commits August 10, 2023 02:59

missing file

a7002e5

fix: python venv doesn't carry over between steps, but does when run …

2f2d353

…locally.

m-mcgowan added 6 commits August 10, 2023 18:04

fix: close pyboard after running an example. Without it, the serial p…

1077e03

…ort can still remain locked, causing the next test to fail.

feat: added a simple boards mechanism to avoid hard-coded values in t…

73b5998

…he main example. This allows different boards to be easily targeted.

feat: implements HIL tests for micropython

896f97a

chore: misc cleanup [skip ci]

8ba3ee6

feat: allow manual runs to optionally not flash firmware. Trigger HIL…

24cef64

… tests only when key files changed, so they don't run unnecessarily.

Merge branch 'main' into hitl

3a62bda

haydenroche5 commented Aug 11, 2023

View reviewed changes

m-mcgowan added 4 commits August 11, 2023 12:32

chore: added pre-commit configuration. fixed up formatting.

fa6c36b

chore: rename job [skip ci]

219b3a6

fix: missing cp

7587d81

m-mcgowan reviewed Aug 11, 2023

View reviewed changes

m-mcgowan merged commit b50f499 into blues:main Aug 15, 2023
7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make changes to support HitL testing. #69

Make changes to support HitL testing. #69

haydenroche5 commented Aug 1, 2023 •

edited by m-mcgowan

Loading

haydenroche5 Aug 1, 2023

m-mcgowan commented Aug 10, 2023

haydenroche5 left a comment

haydenroche5 Aug 11, 2023

m-mcgowan Aug 11, 2023

haydenroche5 Aug 11, 2023

m-mcgowan Aug 11, 2023

haydenroche5 Aug 11, 2023

haydenroche5 Aug 11, 2023

m-mcgowan Aug 11, 2023

haydenroche5 Aug 11, 2023

haydenroche5 Aug 11, 2023

m-mcgowan Aug 11, 2023

m-mcgowan left a comment

m-mcgowan Aug 11, 2023

m-mcgowan Aug 11, 2023

m-mcgowan Aug 11, 2023

m-mcgowan Aug 11, 2023

m-mcgowan commented Aug 12, 2023

m-mcgowan commented Aug 15, 2023

+                  exit 1
+              fi
+              exit 0

Make changes to support HitL testing. #69

Make changes to support HitL testing. #69

Conversation

haydenroche5 commented Aug 1, 2023 • edited by m-mcgowan Loading

Choose a reason for hiding this comment

m-mcgowan commented Aug 10, 2023

haydenroche5 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

m-mcgowan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

m-mcgowan commented Aug 12, 2023

m-mcgowan commented Aug 15, 2023

haydenroche5 commented Aug 1, 2023 •

edited by m-mcgowan

Loading