Merge pull request #1204 from pguyot/w25/eunit

Add support for eunit module Add a simplified implementation of eunit interface, with an output compatible with unity test as parsed by Python dut module for qemu-based eunit testing. Eunit can be used on rebar3 projects on generic_unix on both BEAM and AtomVM with: ```shell rebar3 eunit rebar3 as test atomvm packbeam atomvm ${ATOMVMDIR}/build/libs/etest/src/beams/eunit.beam \ ${ATOMVMDIR}/build/libs/atomvmlib.avm \ _build/test/lib/*.avm ``` These changes are made under both the "Apache 2.0" and the "GNU Lesser General Public License 2.1 or later" license terms (dual license). SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later
atomvm · Jun 29, 2024 · 98a0412 · 98a0412
2 parents d760e3a + 15cd68e
commit 98a0412
Show file tree

Hide file tree

Showing 16 changed files with 451 additions and 7 deletions.
diff --git a/.github/workflows/build-and-test-macos.yaml b/.github/workflows/build-and-test-macos.yaml
@@ -106,6 +106,12 @@ jobs:
       run: |
         ./tests/test-structs
 
+    - name: "Test: test_etest.avm"
+      timeout-minutes: 5
+      working-directory: build
+      run: |
+        ./src/AtomVM ./tests/libs/etest/test_etest.avm
+
     - name: "Test: test_estdlib.avm"
       timeout-minutes: 10
       working-directory: build

diff --git a/.github/workflows/build-and-test-on-freebsd.yaml b/.github/workflows/build-and-test-on-freebsd.yaml
@@ -105,6 +105,11 @@ jobs:
           echo "%%"
           ./tests/test-structs
 
+          echo "%%"
+          echo "%% Running etest tests ..."
+          echo "%%"
+          ./src/AtomVM tests/libs/etest/test_etest.avm
+
           echo "%%"
           echo "%% Running estdlib tests ..."
           echo "%%"

diff --git a/.github/workflows/build-and-test-other.yaml b/.github/workflows/build-and-test-other.yaml
@@ -49,7 +49,7 @@ jobs:
         mkdir build_tests
         cd build_tests
         cmake .. -G Ninja -DAVM_WARNINGS_ARE_ERRORS=ON
-        ninja erlang_test_modules test_estdlib test_eavmlib test_alisp
+        ninja erlang_test_modules test_etest test_estdlib test_eavmlib test_alisp
 
     - name: Upload test modules
       uses: actions/upload-artifact@v4
@@ -159,6 +159,7 @@ jobs:
         cp ../build_tests/tests/erlang_tests/code_load/*.{avm,beam,hrl} tests/erlang_tests/code_load/ &&
         mkdir -p tests/erlang_tests/code_load/beams/ &&
         cp ../build_tests/tests/erlang_tests/code_load/beams/*.beam tests/erlang_tests/code_load/beams/ &&
+        cp ../build_tests/tests/libs/etest/*.avm tests/libs/etest/  &&
         cp ../build_tests/tests/libs/estdlib/*.avm tests/libs/estdlib/  &&
         cp ../build_tests/tests/libs/eavmlib/*.avm tests/libs/eavmlib/ &&
         cp ../build_tests/tests/libs/alisp/*.avm tests/libs/alisp/ &&
@@ -176,6 +177,7 @@ jobs:
         file ./tests/test-structs &&
         ./tests/test-structs &&
         file ./src/AtomVM &&
+        ./src/AtomVM tests/libs/etest/test_etest.avm &&
         ./src/AtomVM tests/libs/estdlib/test_estdlib.avm &&
         ./src/AtomVM tests/libs/eavmlib/test_eavmlib.avm &&
         ./src/AtomVM tests/libs/alisp/test_alisp.avm

diff --git a/.github/workflows/build-and-test.yaml b/.github/workflows/build-and-test.yaml
@@ -351,6 +351,13 @@ jobs:
         ./tests/test-structs
         valgrind ./tests/test-structs
 
+    - name: "Test: test_etest.avm"
+      timeout-minutes: 5
+      working-directory: build
+      run: |
+        ./src/AtomVM ./tests/libs/etest/test_etest.avm
+        valgrind ./src/AtomVM ./tests/libs/etest/test_etest.avm
+
     - name: "Test: test_estdlib.avm"
       timeout-minutes: 5
       working-directory: build

diff --git a/.github/workflows/build-libraries.yaml b/.github/workflows/build-libraries.yaml
@@ -67,6 +67,20 @@ jobs:
       working-directory: build
       run: make dialyzer
 
+    - name: "Test: test_alisp.avm"
+      timeout-minutes: 5
+      working-directory: build
+      run: |
+        ./src/AtomVM ./tests/libs/etest/test_alisp.avm
+        valgrind ./src/AtomVM ./tests/libs/etest/test_alisp.avm
+
+    - name: "Test: test_etest.avm"
+      timeout-minutes: 5
+      working-directory: build
+      run: |
+        ./src/AtomVM ./tests/libs/etest/test_etest.avm
+        valgrind ./src/AtomVM ./tests/libs/etest/test_etest.avm
+
     - name: "Test: test_estdlib.avm"
       timeout-minutes: 10
       working-directory: build

diff --git a/.github/workflows/build-linux-artifacts.yaml b/.github/workflows/build-linux-artifacts.yaml
@@ -34,7 +34,7 @@ jobs:
         mkdir build_tests
         cd build_tests
         cmake .. -G Ninja -DAVM_WARNINGS_ARE_ERRORS=ON
-        ninja erlang_test_modules test_estdlib test_eavmlib test_alisp
+        ninja erlang_test_modules test_etest test_estdlib test_eavmlib test_alisp
 
     - name: Upload test modules
       uses: actions/upload-artifact@v4
@@ -226,6 +226,7 @@ jobs:
         file ./tests/test-structs &&
         ./tests/test-structs &&
         file ./src/AtomVM &&
+        ./src/AtomVM tests/libs/etest/test_etest.avm &&
         ./src/AtomVM tests/libs/estdlib/test_estdlib.avm &&
         ./src/AtomVM tests/libs/eavmlib/test_eavmlib.avm &&
         ./src/AtomVM tests/libs/alisp/test_alisp.avm &&

diff --git a/.github/workflows/esp32-build.yaml b/.github/workflows/esp32-build.yaml
@@ -74,7 +74,7 @@ jobs:
         set -eu
         apt update
         DEBIAN_FRONTEND=noninteractive apt install -y -q \
-            doxygen erlang-base erlang-dialyzer \
+            doxygen erlang-base erlang-dev erlang-dialyzer erlang-eunit \
             libglib2.0-0 libpixman-1-0 \
             gcc g++ zlib1g-dev libsdl2-2.0-0 libslirp0 libmbedtls-dev
 

diff --git a/.github/workflows/pico-build.yaml b/.github/workflows/pico-build.yaml
@@ -46,7 +46,11 @@ jobs:
       run: sudo apt update
 
     - name: "Install deps"
-      run: sudo apt install -y cmake gperf ninja-build gcc-arm-none-eabi libnewlib-arm-none-eabi libstdc++-arm-none-eabi-newlib erlang-base erlang-dialyzer
+      run: |
+        sudo apt install -y \
+            cmake gperf ninja-build gcc-arm-none-eabi \
+            libnewlib-arm-none-eabi libstdc++-arm-none-eabi-newlib \
+            erlang-base erlang-dev erlang-dialyzer erlang-eunit
 
     - name: Build
       shell: bash

diff --git a/.github/workflows/run-tests-with-beam.yaml b/.github/workflows/run-tests-with-beam.yaml
@@ -143,3 +143,11 @@ jobs:
       run: |
         export PATH="${{ matrix.path_prefix }}$PATH"
         erl -pa tests/libs/estdlib/ -pa tests/libs/estdlib/beams/ -pa libs/etest/src/beams -s tests -s init stop -noshell
+
+    # Test
+    - name: "Run tests/libs/etest/test_eunit with OTP eunit"
+      timeout-minutes: 10
+      working-directory: build
+      run: |
+        export PATH="${{ matrix.path_prefix }}$PATH"
+        erl -pa tests/libs/etest/beams -s test_eunit test -s init stop -noshell
diff --git a/.github/workflows/wasm-build.yaml b/.github/workflows/wasm-build.yaml
@@ -47,7 +47,7 @@ jobs:
         cd build
         cmake .. -G Ninja -DAVM_WARNINGS_ARE_ERRORS=ON
         # test_eavmlib does not work with wasm due to http + ssl test
-        ninja AtomVM atomvmlib test_alisp hello_world run_script call_cast html5_events wasm_webserver
+        ninja AtomVM atomvmlib test_etest test_alisp hello_world run_script call_cast html5_events wasm_webserver
 
     - name: Upload AtomVM and test modules
       uses: actions/upload-artifact@v4
@@ -114,6 +114,7 @@ jobs:
         node src/AtomVM.js ../../../../build/tests/libs/alisp/test_alisp.avm
         # test_eavmlib does not work with wasm due to http + ssl test
         # node src/AtomVM.js ../../../../build/tests/libs/eavmlib/test_eavmlib.avm
+        node src/AtomVM.js ../../../../build/tests/libs/etest/test_etest.avm
 
     - name: "Rename and write sha256sum (node)"
       if: startsWith(github.ref, 'refs/tags/')

diff --git a/CMakeModules/BuildErlang.cmake b/CMakeModules/BuildErlang.cmake
@@ -20,10 +20,13 @@
 
 macro(pack_archive avm_name)
 
-    foreach(module_name ${ARGN})
+    set(multiValueArgs ERLC_FLAGS MODULES)
+    cmake_parse_arguments(PACK_ARCHIVE "" "" "${multiValueArgs}" ${ARGN})
+    list(JOIN PACK_ARCHIVE_ERLC_FLAGS " " PACK_ARCHIVE_ERLC_FLAGS)
+    foreach(module_name IN LISTS ${PACK_ARCHIVE_MODULES} PACK_ARCHIVE_MODULES PACK_ARCHIVE_UNPARSED_ARGUMENTS)
         add_custom_command(
             OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/beams/${module_name}.beam
-            COMMAND mkdir -p ${CMAKE_CURRENT_BINARY_DIR}/beams && erlc +debug_info -o ${CMAKE_CURRENT_BINARY_DIR}/beams -I ${CMAKE_SOURCE_DIR}/libs/include ${CMAKE_CURRENT_SOURCE_DIR}/${module_name}.erl
+            COMMAND mkdir -p ${CMAKE_CURRENT_BINARY_DIR}/beams && erlc +debug_info ${PACK_ARCHIVE_ERLC_FLAGS} -o ${CMAKE_CURRENT_BINARY_DIR}/beams -I ${CMAKE_SOURCE_DIR}/libs/include ${CMAKE_CURRENT_SOURCE_DIR}/${module_name}.erl
             DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/${module_name}.erl
             COMMENT "Compiling ${module_name}.erl"
             VERBATIM
@@ -174,6 +177,32 @@ macro(pack_test test_avm_name)
 
 endmacro()
 
+macro(pack_eunit test_avm_name)
+
+    set(pack_eunit_${test_avm_name}_archives ${CMAKE_CURRENT_BINARY_DIR}/${test_avm_name}_lib.avm)
+    set(pack_eunit_${test_avm_name}_archive_targets ${test_avm_name}_lib)
+    foreach(archive_name ${ARGN})
+        set(pack_eunit_${test_avm_name}_archives ${pack_eunit_${test_avm_name}_archives} ${CMAKE_BINARY_DIR}/libs/${archive_name}/src/${archive_name}.avm)
+        set(pack_eunit_${test_avm_name}_archive_targets ${pack_eunit_${test_avm_name}_archive_targets} ${archive_name})
+    endforeach()
+
+    if(AVM_RELEASE)
+        set(INCLUDE_LINES "")
+    else()
+        set(INCLUDE_LINES "-i")
+    endif()
+
+    add_custom_target(
+        ${test_avm_name} ALL
+        COMMAND ${CMAKE_BINARY_DIR}/tools/packbeam/PackBEAM ${INCLUDE_LINES} ${CMAKE_CURRENT_BINARY_DIR}/${test_avm_name}.avm ${CMAKE_BINARY_DIR}/libs/etest/src/beams/eunit.beam ${pack_eunit_${test_avm_name}_archives}
+        DEPENDS ${CMAKE_BINARY_DIR}/libs/etest/src/beams/eunit.beam
+        COMMENT "Packing runnable ${test_avm_name}.avm"
+        VERBATIM
+    )
+    add_dependencies(${test_avm_name} ${pack_eunit_${test_avm_name}_archive_targets} PackBEAM)
+
+endmacro()
+
 macro(pack_uf2 avm_name main)
 
     add_custom_command(

diff --git a/libs/etest/src/CMakeLists.txt b/libs/etest/src/CMakeLists.txt
@@ -24,6 +24,7 @@ include(BuildErlang)
 
 set(ERLANG_MODULES
     etest
+    eunit
 )
 
 pack_archive(etest ${ERLANG_MODULES})