This should avoid problems like we just had where bad tests can break
the OpenOCD workflow. These tests only run if any debug files are
changed, so should have no impact at all on non-debug tests in this
repo.

This file is copied and then slightly changed from riscv-openocd. New
changes are that cacheable steps (building spike, OpenOCD) are stored to
the cache even if running the tests fails.

debug: Only run pylint if debug files changed.

Just doing this to make a change in the debug files, which should now
cause the pylint workflow to execute.

debug: Disable unavailable tests.

They have issues when run in a github workflow.

debug: Test OpenOCD behavior when harts become unavailable, using new spike mechanism

Use new spike mechanism to test OpenOCD behavior when a hart becomes
unavailable, and then available again.

Use new spike mechanism to test OpenOCD behavior when the current hart
becomes unavailable while running.

Create ThreadTerminated exception.

Use the new spike mechanism to test OpenOCD behavior when a hart becomes
unavailable while running.

Create CommandException.

It's a bit messy to read the log file to get the output, but it seems to
be flushed often so that this works.

Also, added the `targets` method for retrieving the list of targets,
and `wait_until_running` method to wait until all targets are in a
running state.

Just so it's easier to quickly comment out code and hard-code the target
to use without pylint complaining. This really should be a command line
option.

debug: flushregs -> maintenance flush register-cache

flushregs is deprecated.

* Add an exclude list for known failing Hifive1 tests

This commit adds a list of known failing tests based on: https://github.com/riscv/riscv-openocd/issues/869#issue-1769176709



* Fix name of the HiFive1 flash target 

Signed-off-by: Marek Vrbka <133884222+MarekVCodasip@users.noreply.github.com>

---------

Signed-off-by: Marek Vrbka <133884222+MarekVCodasip@users.noreply.github.com>

change warning check in RepeatReadTest

debug: Don't rely on RISCV env

Fix for test program compilation failures due to lack of `zicsr` extension in `-march=rvXX...`

That made sense when mostly people used riscv-tools, but now they get
tools from all sorts of places and most of them are suitable for the
debug tests.

Also document RISCV_TESTS_DEBUG_GCC and RISCV_TESTS_DEBUG_GDB
environment variables in the README.

The github workflows that rely on these tests don't use the Makefile,
but instead invoke gdbserver.py directly, so they're not affected by
this change.

Fixes #481

debug: pylint fix.

Github workflow to run pylint against debug tests

Add --target-timeout to debug test script.

I'm using this to greatly reduce the timeout when I'm reproducing a
failure I know is going to time out.

debug: optimize the FreeRtosTest case.

Add a way to exclude tests by specifying an exclusion file

This patch adds a way to specify a yaml file which specifies either
for each target individually or for all targets to exclude tests.
Example file format is included in excluded.yaml.example.

To make sure the rtos module of OpenOCD works well.

Signed-off-by: Chao Du <duchao@eswincomputing.com>

Get gcc and gdb path from environment.

If the environment variables aren't set, then use the same defaults as
previously.

My current set of tools use riscv64-elf-gcc and riscv64-elf-gdb, and
this makes it trivial to use them.

debug: New pylint => new warnings => new cleanups

- Replace general "Exception" with "GdbServerError" in gdbserver.py for when no
samples are collected
- Replace general "Exception" with "TargetsException" in targets.py for XLEN
mismatch
- Introduce "TestLibError" exception in testlib.py and replace general
exceptions in various locations
- Update pylint.rc to remove overgeneral-exceptions warning