ci: add micropython test

Author: urish

.github/workflows/ci-micropython.yml

@@ -0,0 +1,29 @@
+name: Test MicroPython Releases
+on:
+  push:
+  pull_request:
+    branches: [master]
+jobs:
+  test-micropython:
+    name: Test and Lint
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        micropython_version: [20210618-v1.16, 20210902-v1.17, 20220117-v1.18, 20220618-v1.19.1]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.10' 
+      - name: Install packages
+        run: npm ci
+      - name: Install Python requirements
+        run: cd test && pip install -r requirements.txt
+      - name: Download Micropython
+        run: curl -o micropython.uf2 "https://micropython.org/resources/firmware/rp2-pico-${VERSION}.uf2"
+        env:
+          VERSION: ${{ matrix.micropython_version }}
+      - name: Create filesystem
+        run: python test/mklittlefs.py
+      - name: Test Micropython
+        run: timeout 10 npm run start:micropython -- --image micropython.uf2 --expect-text "Hello, MicroPython!"

README.md

@@ -49,6 +49,10 @@ A GDB server on port 3333 can be enabled by specifying the `--gdb` flag:
 npm run start:micropython -- --gdb
 ```
 
+For using the MicroPython demo code in tests, the `--expect-text` can come handy: it will look for the given text in the serial output and exit with code 0 if found, or 1 if not found. You can find an example in [the MicroPython CI test](./github/workflows/ci-micropython.yml).
+
+#### Filesystem support
+
 With MicroPython – and probably also CircuitPython – you can use the filesystem on the Pico. This becomes useful as more than one script file is used in your code. Just put a [LittleFS](https://github.com/littlefs-project/littlefs) formatted filesystem image called `littlefs.img` into the rp2040js root directory, and your `main.py` will be automatically started from there.
 
 A simple way to create a suitable LittleFS image containing your script files is outlined in [create_littlefs_image.py](https://github.com/tomods/GrinderController/blob/358ad3e0f795d8cc0bdf4f21bb35f806871d433f/tools/create_littlefs_image.py).
@@ -77,4 +81,4 @@ Currently, the filesystem is not writeable, as the SSI peripheral required for f
 
 ## License
 
-Released under the MIT licence. Copyright (c) 2021, Uri Shaked.
+Released under the MIT licence. Copyright (c) 2021-2023, Uri Shaked.

demo/micropython-run.ts

@@ -8,9 +8,13 @@ import fs from 'fs';
 import minimist from 'minimist';
 
 const args = minimist(process.argv.slice(2), {
-  string: 'image', // UF2 image to load; defaults to "rp2-pico-20210902-v1.17.uf2"
+  string: [
+    'image', // UF2 image to load; defaults to "rp2-pico-20210902-v1.17.uf2"
+    'expect-text', // Text to expect on the serial console, process will exit with code 0 if found
+  ],
   boolean: 'gdb', // start GDB server on 3333
 });
+const expectText = args['expect-text'];
 
 const mcu = new RP2040();
 mcu.loadBootrom(bootromB1);
@@ -37,8 +41,24 @@ cdc.onDeviceConnected = () => {
   cdc.sendSerialByte('\r'.charCodeAt(0));
   cdc.sendSerialByte('\n'.charCodeAt(0));
 };
+
+let currentLine = '';
 cdc.onSerialData = (value) => {
   process.stdout.write(value);
+
+  for (const byte of value) {
+    const char = String.fromCharCode(byte);
+    if (char === '\n') {
+      if (expectText && currentLine.includes(expectText)) {
+        console.log(`Expected text found: "${expectText}"`);
+        console.log('TEST PASSED.');
+        process.exit(0);
+      }
+      currentLine = '';
+    } else {
+      currentLine += char;
+    }
+  }
 };
 
 if (process.stdin.isTTY) {

test/micropython/main.py

@@ -0,0 +1,9 @@
+import time
+import sys
+
+version = sys.implementation.version
+versionstr = "{}.{}.{}".format(version[0], version[1], version[2])
+
+while True:
+    print("Hello, MicroPython! version: {}".format(versionstr))
+    time.sleep(1)

test/mklittlefs.py

@@ -0,0 +1,17 @@
+# Simple script to create a littlefs image for running the MicroPython test
+
+from littlefs import LittleFS
+from os.path import join
+
+files = ['main.py']
+source_dir = 'test/micropython'
+output_image = 'littlefs.img'
+
+lfs = LittleFS(block_size=4096, block_count=352, prog_size=256)
+for filename in files:
+    with open(join(source_dir, filename), 'r') as src_file, lfs.open(filename, 'w') as lfs_file:
+        lfs_file.write(src_file.read())
+with open(output_image, 'wb') as fh:
+    fh.write(lfs.context.buffer)
+
+print('Created littlefs image: {}'.format(output_image))

test/requirements.txt

@@ -0,0 +1 @@
+littlefs-python==0.4.0