diff --git a/TESTING.md b/TESTING.md index 57fca7285..359f10a69 100644 --- a/TESTING.md +++ b/TESTING.md @@ -1,23 +1,23 @@ # Testing the RISCV-Sail model -This document contains information regarding the testing of the RISC-V +This document contains information regarding the testing of the RISC-V Sail model. ## Background For the longest time, the set of tests used to validate changes to the model, were a set of precompiled .elf files (along with their .dump file counterparts) -that were stored in the repo under `test/riscv-tests`. The scripts used to -run theses tests (and to gather test results) were `test/run_tests.sh` and +that were stored in the repo under `test/riscv-tests`. The scripts used to +run theses tests (and to gather test results) were `test/run_tests.sh` and `test/run_fp_tests.sh`. These tests are a compiled snapshot of tests that can be found at https://github.com/riscv-software-src/riscv-tests that date back to 2019. -This methodolgy was defecient in several ways. +This methodolgy was defecient in several ways. 1. Original test source is difficult to track down. -1. Storing compiled code in a git repo is usually frowned upon. +1. Storing compiled code in a git repo is usually frowned upon. 1. There is no easy way to add new tests to the repo when you add a new feature. 1. `run_tests.sh` is difficult to enhance with new features. @@ -32,10 +32,10 @@ To fix the defeciencies of the old test methodology, we have done the following: 1. Created a new test directory at the repo root, `TEST_DIR_ROOT/` under which all new test collateral will be put. -1. Created a `bin/` directory under which various model scripts and executables +1. Created a `bin/` directory under which various model scripts and executables are added. 1. Installed https://github.com/riscv-software-src/riscv-tests as a submodule -at `TEST_DIR_ROOT/riscv-tests.git/`. We will be working on a special branch +at `TEST_DIR_ROOT/riscv-tests.git/`. We will be working on a special branch in this repository: `riscv-tests-sail`. This allows us to add tests onto our branch. And we can incorporate new tests into our testsuite as they appear in the riscv-tests repo (by merging these new tests from the master branch @@ -68,9 +68,4 @@ inspect the log file is a neccessary feature that needs to be added. 1. Negative testing. We need to be able to check for proper detection of errors which would then mean that the test "passed". For example, we might want to check that if the vector extension is not enabled, that a test that uses a vector instruction -would "fail". - - - - - +would "fail".