tools/ci.sh: Add helper script to run CI tasks.

The aim is for this script to be used on any CI platform, as well as run
locally.

Signed-off-by: Damien George <damien@micropython.org>

1 files changed, 461 insertions, 0 deletions

diff --git a/tools/ci.sh b/tools/ci.sh
new file mode 100755
index 000000000..3b906b449
--- /dev/null
+++ b/tools/ci.sh
@@ -0,0 +1,461 @@
+#!/bin/bash
+
+if which nproc > /dev/null; then
+    MAKEOPTS="-j$(nproc)"
+else
+    MAKEOPTS="-j$(sysctl -n hw.ncpu)"
+fi
+
+########################################################################################
+# general helper functions
+
+function ci_gcc_arm_setup {
+    sudo apt-get install gcc-arm-none-eabi libnewlib-arm-none-eabi
+    arm-none-eabi-gcc --version
+}
+
+########################################################################################
+# code formatting
+
+function ci_code_formatting_setup {
+    sudo apt-add-repository --yes --update ppa:pybricks/ppa
+    sudo apt-get install uncrustify
+    pip3 install black
+    uncrustify --version
+    black --version
+}
+
+function ci_code_formatting_run {
+    tools/codeformat.py -v
+}
+
+########################################################################################
+# code size
+
+function ci_code_size_setup {
+    sudo apt-get install gcc-multilib
+    gcc --version
+    ci_gcc_arm_setup
+}
+
+function ci_code_size_build {
+    # starts off at either the ref/pull/N/merge FETCH_HEAD, or the current branch HEAD
+    git checkout -b pull_request # save the current location
+    git remote add upstream https://github.com/micropython/micropython.git
+    git fetch --depth=100 upstream
+    # build reference, save to size0
+    # ignore any errors with this build, in case master is failing
+    git checkout `git merge-base --fork-point upstream/master pull_request`
+    git show -s
+    tools/metrics.py clean bm
+    tools/metrics.py build bm | tee ~/size0 || true
+    # build PR/branch, save to size1
+    git checkout pull_request
+    git log upstream/master..HEAD
+    tools/metrics.py clean bm
+    tools/metrics.py build bm | tee ~/size1
+}
+
+########################################################################################
+# ports/cc3200
+
+function ci_cc3200_setup {
+    ci_gcc_arm_setup
+}
+
+function ci_cc3200_build {
+    make ${MAKEOPTS} -C ports/cc3200 BTARGET=application BTYPE=release
+    make ${MAKEOPTS} -C ports/cc3200 BTARGET=bootloader  BTYPE=release
+}
+
+########################################################################################
+# ports/esp32
+
+function ci_esp32_idf3_setup {
+    sudo pip3 install pyserial 'pyparsing<2.4'
+    curl -L https://dl.espressif.com/dl/xtensa-esp32-elf-linux64-1.22.0-80-g6c4433a-5.2.0.tar.gz | tar zxf -
+    git clone https://github.com/espressif/esp-idf.git
+    echo $(pwd)/xtensa-esp32-elf/bin
+}
+
+function ci_esp32_idf3_build {
+    make ${MAKEOPTS} -C mpy-cross
+    git -C esp-idf checkout $(grep "ESPIDF_SUPHASH_V3 :=" ports/esp32/Makefile | cut -d " " -f 3)
+    git -C esp-idf submodule update --init components/json/cJSON components/esp32/lib components/esptool_py/esptool components/expat/expat components/lwip/lwip components/mbedtls/mbedtls components/micro-ecc/micro-ecc components/nghttp/nghttp2 components/nimble components/bt
+    make ${MAKEOPTS} -C ports/esp32 submodules
+    make ${MAKEOPTS} -C ports/esp32
+}
+
+function ci_esp32_idf4_setup {
+    sudo pip3 install pyserial 'pyparsing<2.4'
+    curl -L https://dl.espressif.com/dl/xtensa-esp32-elf-gcc8_2_0-esp-2019r2-linux-amd64.tar.gz | tar zxf -
+    git clone https://github.com/espressif/esp-idf.git
+    echo $(pwd)/xtensa-esp32-elf/bin
+}
+
+function ci_esp32_idf4_build {
+    make ${MAKEOPTS} -C mpy-cross
+    git -C esp-idf checkout $(grep "ESPIDF_SUPHASH_V4 :=" ports/esp32/Makefile | cut -d " " -f 3)
+    git -C esp-idf submodule update --init components/bt/controller/lib components/bt/host/nimble/nimble components/esp_wifi/lib_esp32 components/esptool_py/esptool components/lwip/lwip components/mbedtls/mbedtls
+    make ${MAKEOPTS} -C ports/esp32 submodules
+    make ${MAKEOPTS} -C ports/esp32
+}
+
+########################################################################################
+# ports/esp8266
+
+function ci_esp8266_setup {
+    sudo pip install pyserial
+    wget https://github.com/jepler/esp-open-sdk/releases/download/2018-06-10/xtensa-lx106-elf-standalone.tar.gz
+    zcat xtensa-lx106-elf-standalone.tar.gz | tar x
+    echo $(pwd)/xtensa-lx106-elf/bin
+}
+
+function ci_esp8266_build {
+    make ${MAKEOPTS} -C mpy-cross
+    make ${MAKEOPTS} -C ports/esp8266 submodules
+    make ${MAKEOPTS} -C ports/esp8266
+    make ${MAKEOPTS} -C ports/esp8266 BOARD=GENERIC_512K
+    make ${MAKEOPTS} -C ports/esp8266 BOARD=GENERIC_1M
+}
+
+########################################################################################
+# ports/nrf
+
+function ci_nrf_setup {
+    ci_gcc_arm_setup
+}
+
+function ci_nrf_build {
+    ports/nrf/drivers/bluetooth/download_ble_stack.sh s140_nrf52_6_1_1
+    make ${MAKEOPTS} -C ports/nrf submodules
+    make ${MAKEOPTS} -C ports/nrf BOARD=pca10040
+    make ${MAKEOPTS} -C ports/nrf BOARD=microbit
+    make ${MAKEOPTS} -C ports/nrf BOARD=pca10056 SD=s140
+    make ${MAKEOPTS} -C ports/nrf BOARD=pca10090
+}
+
+########################################################################################
+# ports/powerpc
+
+function ci_powerpc_setup {
+    sudo apt-get install gcc-powerpc64le-linux-gnu libc6-dev-ppc64el-cross
+}
+
+function ci_powerpc_build {
+    make ${MAKEOPTS} -C ports/powerpc UART=potato
+    make ${MAKEOPTS} -C ports/powerpc UART=lpc_serial
+}
+
+########################################################################################
+# ports/qemu-arm
+
+function ci_qemu_arm_setup {
+    ci_gcc_arm_setup
+    sudo apt-get update
+    sudo apt-get install qemu-system
+    qemu-system-arm --version
+}
+
+function ci_qemu_arm_build {
+    make ${MAKEOPTS} -C mpy-cross
+    make ${MAKEOPTS} -C ports/qemu-arm CFLAGS_EXTRA=-DMP_ENDIANNESS_BIG=1
+    make ${MAKEOPTS} -C ports/qemu-arm clean
+    make ${MAKEOPTS} -C ports/qemu-arm -f Makefile.test test
+}
+
+########################################################################################
+# ports/samd
+
+function ci_samd_setup {
+    ci_gcc_arm_setup
+}
+
+function ci_samd_build {
+    make ${MAKEOPTS} -C ports/samd submodules
+    make ${MAKEOPTS} -C ports/samd
+}
+
+########################################################################################
+# ports/stm32
+
+function ci_stm32_setup {
+    ci_gcc_arm_setup
+}
+
+function ci_stm32_pyb_build {
+    make ${MAKEOPTS} -C mpy-cross
+    make ${MAKEOPTS} -C ports/stm32 submodules
+    git submodule update --init lib/btstack
+    make ${MAKEOPTS} -C ports/stm32 BOARD=PYBV11 MICROPY_PY_WIZNET5K=5200 MICROPY_PY_CC3K=1 USER_C_MODULES=../../examples/usercmodule CFLAGS_EXTRA="-DMODULE_CEXAMPLE_ENABLED=1 -DMODULE_CPPEXAMPLE_ENABLED=1"
+    make ${MAKEOPTS} -C ports/stm32 BOARD=PYBD_SF2
+    make ${MAKEOPTS} -C ports/stm32 BOARD=PYBD_SF6 NANBOX=1 MICROPY_BLUETOOTH_NIMBLE=0 MICROPY_BLUETOOTH_BTSTACK=1
+    make ${MAKEOPTS} -C ports/stm32/mboot BOARD=PYBV10 CFLAGS_EXTRA='-DMBOOT_FSLOAD=1 -DMBOOT_VFS_LFS2=1'
+    make ${MAKEOPTS} -C ports/stm32/mboot BOARD=PYBD_SF6
+}
+
+function ci_stm32_nucleo_build {
+    make ${MAKEOPTS} -C mpy-cross
+    make ${MAKEOPTS} -C ports/stm32 submodules
+    make ${MAKEOPTS} -C ports/stm32 BOARD=NUCLEO_F091RC
+    make ${MAKEOPTS} -C ports/stm32 BOARD=NUCLEO_H743ZI CFLAGS_EXTRA='-DMICROPY_PY_THREAD=1'
+    make ${MAKEOPTS} -C ports/stm32 BOARD=NUCLEO_L073RZ
+    make ${MAKEOPTS} -C ports/stm32 BOARD=NUCLEO_L476RG
+    make ${MAKEOPTS} -C ports/stm32 BOARD=NUCLEO_WB55
+    make ${MAKEOPTS} -C ports/stm32/mboot BOARD=NUCLEO_WB55
+}
+
+########################################################################################
+# ports/teensy
+
+function ci_teensy_setup {
+    ci_gcc_arm_setup
+}
+
+function ci_teensy_build {
+    make ${MAKEOPTS} -C ports/teensy
+}
+
+########################################################################################
+# ports/unix
+
+CI_UNIX_OPTS_SYS_SETTRACE=(
+    MICROPY_PY_BTREE=0
+    MICROPY_PY_FFI=0
+    MICROPY_PY_USSL=0
+    CFLAGS_EXTRA="-DMICROPY_PY_SYS_SETTRACE=1"
+)
+
+CI_UNIX_OPTS_SYS_SETTRACE_STACKLESS=(
+    MICROPY_PY_BTREE=0
+    MICROPY_PY_FFI=0
+    MICROPY_PY_USSL=0
+    CFLAGS_EXTRA="-DMICROPY_STACKLESS=1 -DMICROPY_STACKLESS_STRICT=1 -DMICROPY_PY_SYS_SETTRACE=1"
+)
+
+function ci_unix_build_helper {
+    make ${MAKEOPTS} -C mpy-cross
+    make ${MAKEOPTS} -C ports/unix "$@" submodules
+    make ${MAKEOPTS} -C ports/unix "$@" deplibs
+    make ${MAKEOPTS} -C ports/unix "$@"
+}
+
+function ci_unix_run_tests_helper {
+    make -C ports/unix "$@" test
+}
+
+function ci_unix_run_tests_full_helper {
+    variant=$1
+    shift
+    if [ $variant = standard ]; then
+        micropython=micropython
+    else
+        micropython=micropython-$variant
+    fi
+    make -C ports/unix VARIANT=$variant "$@" test_full
+    (cd tests && MICROPY_CPYTHON3=python3 MICROPY_MICROPYTHON=../ports/unix/$micropython ./run-multitests.py multi_net/*.py)
+}
+
+function ci_native_mpy_modules_build {
+    if [ "$1" = "" ]; then
+        arch=x64
+    else
+        arch=$1
+    fi
+    make -C examples/natmod/features1 ARCH=$arch
+    make -C examples/natmod/features2 ARCH=$arch
+    make -C examples/natmod/btree ARCH=$arch
+    make -C examples/natmod/framebuf ARCH=$arch
+    make -C examples/natmod/uheapq ARCH=$arch
+    make -C examples/natmod/urandom ARCH=$arch
+    make -C examples/natmod/ure ARCH=$arch
+    make -C examples/natmod/uzlib ARCH=$arch
+}
+
+function ci_native_mpy_modules_32bit_build {
+    ci_native_mpy_modules_build x86
+}
+
+function ci_unix_minimal_build {
+    make ${MAKEOPTS} -C ports/unix VARIANT=minimal
+}
+
+function ci_unix_minimal_run_tests {
+    (cd tests && MICROPY_CPYTHON3=python3 MICROPY_MICROPYTHON=../ports/unix/micropython-minimal ./run-tests -e exception_chain -e self_type_check -e subclass_native_init -d basics)
+}
+
+function ci_unix_standard_build {
+    ci_unix_build_helper VARIANT=standard
+}
+
+function ci_unix_standard_run_tests {
+    ci_unix_run_tests_full_helper standard
+}
+
+function ci_unix_standard_run_perfbench {
+    (cd tests && MICROPY_CPYTHON3=python3 MICROPY_MICROPYTHON=../ports/unix/micropython ./run-perfbench.py 1000 1000)
+}
+
+function ci_unix_coverage_setup {
+    sudo apt-get install lcov
+    sudo pip3 install setuptools
+    sudo pip3 install pyelftools
+    gcc --version
+    python3 --version
+}
+
+function ci_unix_coverage_build {
+    ci_unix_build_helper VARIANT=coverage
+}
+
+function ci_unix_coverage_run_tests {
+    ci_unix_run_tests_full_helper coverage
+}
+
+function ci_unix_coverage_run_native_mpy_tests {
+    MICROPYPATH=examples/natmod/features2 ./ports/unix/micropython-coverage -m features2
+    (cd tests && ./run-natmodtests.py "$@" extmod/{btree*,framebuf*,uheapq*,ure*,uzlib*}.py)
+}
+
+function ci_unix_32bit_setup {
+    sudo dpkg --add-architecture i386
+    sudo apt-get update
+    sudo apt-get install gcc-multilib g++-multilib libffi-dev:i386
+    sudo pip3 install setuptools
+    sudo pip3 install pyelftools
+    gcc --version
+    python2 --version
+    python3 --version
+}
+
+function ci_unix_coverage_32bit_build {
+    ci_unix_build_helper VARIANT=coverage MICROPY_FORCE_32BIT=1
+}
+
+function ci_unix_coverage_32bit_run_tests {
+    ci_unix_run_tests_full_helper coverage MICROPY_FORCE_32BIT=1
+}
+
+function ci_unix_coverage_32bit_run_native_mpy_tests {
+    ci_unix_coverage_run_native_mpy_tests --arch x86
+}
+
+function ci_unix_nanbox_build {
+    # Use Python 2 to check that it can run the build scripts
+    ci_unix_build_helper PYTHON=python2 VARIANT=nanbox
+}
+
+function ci_unix_nanbox_run_tests {
+    ci_unix_run_tests_full_helper nanbox PYTHON=python2
+}
+
+function ci_unix_float_build {
+    ci_unix_build_helper VARIANT=standard CFLAGS_EXTRA="-DMICROPY_FLOAT_IMPL=MICROPY_FLOAT_IMPL_FLOAT"
+}
+
+function ci_unix_float_run_tests {
+    # TODO get this working: ci_unix_run_tests_full_helper standard CFLAGS_EXTRA="-DMICROPY_FLOAT_IMPL=MICROPY_FLOAT_IMPL_FLOAT"
+    ci_unix_run_tests_helper CFLAGS_EXTRA="-DMICROPY_FLOAT_IMPL=MICROPY_FLOAT_IMPL_FLOAT"
+}
+
+function ci_unix_clang_setup {
+    sudo apt-get install clang
+    clang --version
+}
+
+function ci_unix_stackless_clang_build {
+    make ${MAKEOPTS} -C mpy-cross CC=clang
+    make ${MAKEOPTS} -C ports/unix submodules
+    make ${MAKEOPTS} -C ports/unix CC=clang CFLAGS_EXTRA="-DMICROPY_STACKLESS=1 -DMICROPY_STACKLESS_STRICT=1"
+}
+
+function ci_unix_stackless_clang_run_tests {
+    ci_unix_run_tests_helper CC=clang
+}
+
+function ci_unix_float_clang_build {
+    make ${MAKEOPTS} -C mpy-cross CC=clang
+    make ${MAKEOPTS} -C ports/unix submodules
+    make ${MAKEOPTS} -C ports/unix CC=clang CFLAGS_EXTRA="-DMICROPY_FLOAT_IMPL=MICROPY_FLOAT_IMPL_FLOAT"
+}
+
+function ci_unix_float_clang_run_tests {
+    ci_unix_run_tests_helper CC=clang
+}
+
+function ci_unix_settrace_build {
+    make ${MAKEOPTS} -C mpy-cross
+    make ${MAKEOPTS} -C ports/unix "${CI_UNIX_OPTS_SYS_SETTRACE[@]}"
+}
+
+function ci_unix_settrace_run_tests {
+    ci_unix_run_tests_helper "${CI_UNIX_OPTS_SYS_SETTRACE[@]}"
+}
+
+function ci_unix_settrace_stackless_build {
+    make ${MAKEOPTS} -C mpy-cross
+    make ${MAKEOPTS} -C ports/unix "${CI_UNIX_OPTS_SYS_SETTRACE_STACKLESS[@]}"
+}
+
+function ci_unix_settrace_stackless_run_tests {
+    ci_unix_run_tests_helper "${CI_UNIX_OPTS_SYS_SETTRACE_STACKLESS[@]}"
+}
+
+function ci_unix_macos_build {
+    make ${MAKEOPTS} -C mpy-cross
+    make ${MAKEOPTS} -C ports/unix submodules
+    #make ${MAKEOPTS} -C ports/unix deplibs
+    make ${MAKEOPTS} -C ports/unix
+    # check for additional compiler errors/warnings
+    make ${MAKEOPTS} -C ports/unix VARIANT=coverage submodules
+    make ${MAKEOPTS} -C ports/unix VARIANT=coverage
+}
+
+function ci_unix_macos_run_tests {
+    # Issues with macOS tests:
+    # - OSX has poor time resolution and these uasyncio tests do not have correct output
+    # - import_pkg7 has a problem with relative imports
+    # - urandom_basic has a problem with getrandbits(0)
+    (cd tests && ./run-tests --exclude 'uasyncio_(basic|heaplock|lock|wait_task)' --exclude 'import_pkg7.py' --exclude 'urandom_basic.py')
+}
+
+########################################################################################
+# ports/windows
+
+function ci_windows_setup {
+    sudo apt-get install gcc-mingw-w64
+}
+
+function ci_windows_build {
+    make ${MAKEOPTS} -C mpy-cross
+    make ${MAKEOPTS} -C ports/windows CROSS_COMPILE=i686-w64-mingw32-
+}
+
+########################################################################################
+# ports/zephyr
+
+function ci_zephyr_setup {
+    docker pull zephyrprojectrtos/ci:v0.11.8
+    docker run --name zephyr-ci -d -it \
+      -v "$(pwd)":/micropython \
+      -e ZEPHYR_SDK_INSTALL_DIR=/opt/sdk/zephyr-sdk-0.11.3 \
+      -e ZEPHYR_TOOLCHAIN_VARIANT=zephyr \
+      -w /micropython/ports/zephyr \
+      zephyrprojectrtos/ci:v0.11.8
+    docker ps -a
+}
+
+function ci_zephyr_install {
+    docker exec zephyr-ci west init --mr v2.4.0 /zephyrproject
+    docker exec -w /zephyrproject zephyr-ci west update
+    docker exec -w /zephyrproject zephyr-ci west zephyr-export
+}
+
+function ci_zephyr_build {
+    docker exec zephyr-ci bash -c "make clean; ./make-minimal ${MAKEOPTS}"
+    docker exec zephyr-ci bash -c "make clean; ./make-minimal ${MAKEOPTS} BOARD=frdm_k64f"
+    docker exec zephyr-ci bash -c "make clean; make ${MAKEOPTS}"
+    docker exec zephyr-ci bash -c "make clean; make ${MAKEOPTS} BOARD=frdm_k64f"
+    docker exec zephyr-ci bash -c "make clean; make ${MAKEOPTS} BOARD=mimxrt1050_evk"
+    docker exec zephyr-ci bash -c "make clean; make ${MAKEOPTS} BOARD=reel_board"
+}