Skip to content

Latest commit

 

History

History
97 lines (69 loc) · 2.92 KB

README.md

File metadata and controls

97 lines (69 loc) · 2.92 KB
Raw

Radare2 Regression Test Suite

A set of regression tests for Radare2 (http://radare.org).

Originally based on work by and now in collaboration with pancake.

Directory Hierarchy

  • t/: Test scripts.
  • s/: Sample binaries.
  • test.sh: Test driver script sourced by tests (not to be run manually).
  • run_tests.sh: Run all tests.

Requirements

  • Radare2 installed (and in $PATH or set the R2 environment).
  • Valgrind (optional).

Usage

  • Run './run_tests.sh' in the top level directory to run all tests (alternatively you can use 'make').
  • To run individual tests, type 'cd t; ./testname'.
  • To remove old test results run 'make clean'.

Options

The following options can be passed to run_tests.sh or the individual tests (environment variables).

  • To run tests with valgrind, use 'VALGRIND=1'.
  • To get verbose output, use 'VERBOSE=1' (always enabled for individual tests).

Exit code

run_test.sh exits with the following exit codes:

  • 0: all tests passed
  • 1: at least one test failed
  • 2: no tests failed, but there was at least one broken test
  • 3: no tests failed or are broken, but there is at least one fixed test

Reporting Radare2 Bugs

Please to not post Radare2 bugs on the r2-regressions github tracker. Instead use the official r2 tracker:

https://github.com/radare/radare2/issues?state=open

Writing test cases

Test cases are simple shell scripts (POSIX compliant) and either run by run_tests.sh or manually in t/.

The following variables are available:

  • NAME (recommend): radare2 command being tested (e.g. px).
  • FILE (required): File argument for radare2.
  • ARGS (optional): Additional arguments for radare2. If not present no additional arguments are used.
  • CMDS (required): Commands to run, one per line. Just like in interactive mode.
  • EXPECT (required): Expected output.
  • FILTER (optional): Filter program (like grep or sed) to filter radare2's output before comparing it with EXPECT. Useful to fix random output to generate stable tests.
  • BROKEN (optional): This tests documents a bug which is not yet fixed.
  • EXITCODE (optional): Check the exit code of radare2 matches. Can be used to check handling of invalid arguments.

All uppercase variable names are reserved for the test system.

The following functions are available:

  • run_test(): Run the test with the variables. Can be called multiple times in one test file.

The test files should be named according to the following convention:

  • cmd_*: For each command (see libr/core/cmd.c).
  • feat_*: For features not tied to a single command, like grep or redirection.
  • file_*: For each supported file format.

License

The test files are licensed under GPL 3 (or later).