From a82cfc1cf6c33dc2160bf5c120ec051f630272ca Mon Sep 17 00:00:00 2001 From: Rafal Kolucki Date: Fri, 7 Apr 2023 14:28:03 +0200 Subject: [PATCH] Add unit tests to CI Signed-off-by: Rafal Kolucki --- .github/workflows/verification.yml | 113 +++++++++++++++++++++++++++++ verification/requirements.txt | 3 +- verification/test.py | 1 + verification/tests/common.py | 5 +- verification/tests/test-exu-alu.py | 4 +- 5 files changed, 121 insertions(+), 5 deletions(-) create mode 100644 .github/workflows/verification.yml diff --git a/.github/workflows/verification.yml b/.github/workflows/verification.yml new file mode 100644 index 00000000000..85f95869f13 --- /dev/null +++ b/.github/workflows/verification.yml @@ -0,0 +1,113 @@ +name: VeeR-EL2 verification + +on: + push: + pull_request: + +jobs: + + verilator: + name: Build Verilator + runs-on: ubuntu-latest + env: + CCACHE_DIR: "/opt/veer-el2/.cache/" + DEBIAN_FRONTEND: "noninteractive" + + steps: + - name: Install prerequisities + run: | + sudo apt -qqy update && sudo apt -qqy --no-install-recommends install \ + git autoconf automake autotools-dev curl python3 python3-pip \ + libmpc-dev libmpfr-dev libgmp-dev gawk build-essential bison flex \ + texinfo gperf libtool patchutils bc zlib1g zlib1g-dev libexpat-dev \ + ninja-build ccache libfl2 libfl-dev help2man + + - name: Create Cache Timestamp + id: cache_timestamp + uses: nanzm/get-time-action@v1.1 + with: + format: 'YYYY-MM-DD-HH-mm-ss' + + - name: Setup cache + uses: actions/cache@v2 + timeout-minutes: 3 + continue-on-error: true + with: + path: "/opt/veer-el2/.cache/" + key: cache_${{ steps.cache_timestamp.outputs.time }} + restore-keys: cache_ + + - name: Build Verilator + run: | + git clone https://github.com/verilator/verilator + pushd verilator + git checkout v5.008 + autoconf + ./configure --prefix=/opt/verilator + make -j `nproc` + make install + popd + cd /opt && tar -czvf verilator.tar.gz verilator/ + + - name: Store Verilator binaries + uses: actions/upload-artifact@v3 + with: + name: verilator + path: /opt/*.tar.gz + retention-days: 1 + + tests: + name: Verification tests + runs-on: ubuntu-latest + needs: verilator + env: + DEBIAN_FRONTEND: "noninteractive" + + steps: + - name: Setup repository + uses: actions/checkout@v3 + with: + submodules: recursive + path: Caliptra + + - name: Setup repository + uses: actions/checkout@v3 + with: + submodules: recursive + + - name: Install dependencies + run: | + sudo apt -qqy update && sudo apt -qqy --no-install-recommends install \ + git python3 python3-pip build-essential ninja-build cpanminus ccache \ + gcc-riscv64-unknown-elf + sudo cpanm Bit::Vector + pip3 install meson + pip3 install -r verification/requirements.txt + + - name: Download verilator binaries + uses: actions/download-artifact@v3 + with: + name: verilator + path: /opt + + - name: Unpack verilator binaries + run: | + cd /opt && tar -zxvf verilator.tar.gz + + - name: Run tests + run: | + export PATH=/opt/verilator/bin:$PATH + export RV_ROOT=`pwd` + export PYTHONUNBUFFERED=1 + $RV_ROOT/configs/veer.config + pytest verification/test.py -v --timeout=480 --html=test.html --html=$GITHUB_STEP_SUMMARY + + - name: Pack artifacts + if: always() + uses: actions/upload-artifact@v3 + with: + name: results + path: | + test.html + assets/ + sim_build/ diff --git a/verification/requirements.txt b/verification/requirements.txt index e7489ecb490..0ea2f4a320c 100644 --- a/verification/requirements.txt +++ b/verification/requirements.txt @@ -1,4 +1,5 @@ cocotb==1.7.2 cocotb-test==0.2.4 pytest-html -pytest-xdist +pytest-timeout +pytest-md diff --git a/verification/test.py b/verification/test.py index c31b6f0655f..feadfbae4dc 100644 --- a/verification/test.py +++ b/verification/test.py @@ -28,6 +28,7 @@ def test_exu_alu(): run( simulator = "verilator", + compile_args = ["-Wno-WIDTH", "-Wno-UNOPTFLAT"], verilog_sources = ["{}/{}".format(rv_root, el) for el in verilog_sources], includes = ["{}/{}".format(rv_root, el) for el in includes], toplevel = "el2_exu_alu_ctl", diff --git a/verification/tests/common.py b/verification/tests/common.py index a527e42371f..a7857fbcfea 100644 --- a/verification/tests/common.py +++ b/verification/tests/common.py @@ -31,7 +31,7 @@ def __init__(self, dut, **kwargs): # test_name = kwargs.get('test_name', inspect.stack()[1][3]) # tn = cocotb.binary.BinaryValue(value=test_name.encode(), n_bits=4096) # self.dut.test_name.value = tn - + @cocotb.coroutine async def reset(self): self.dut.rst_l.value = 1 @@ -39,4 +39,5 @@ async def reset(self): self.dut.rst_l.value = 0 await ClockCycles(self.dut.clk, 2) self.dut.rst_l.value = 1 - await ClockCycles(self.dut.clk, 2) \ No newline at end of file + await ClockCycles(self.dut.clk, 2) + diff --git a/verification/tests/test-exu-alu.py b/verification/tests/test-exu-alu.py index 4ec83607584..dfefff818ce 100644 --- a/verification/tests/test-exu-alu.py +++ b/verification/tests/test-exu-alu.py @@ -24,8 +24,8 @@ async def test_add(dut): inputs = random.sample(range(0x1, 0x3fffffff), 2) - clk_gen = make_clock(dut, 1) harness = Harness(dut) + clk_gen = make_clock(harness.dut, 100) await harness.reset() @@ -45,8 +45,8 @@ async def test_add(dut): async def test_sub(dut): inputs = random.sample(range(0x1, 0x3fffffff), 2) - clk_gen = make_clock(dut, 1) harness = Harness(dut) + clk_gen = make_clock(harness.dut, 100) await harness.reset()