Git Product home page Git Product logo

radare2-regressions's Introduction

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).

radare2-regressions's People

Contributors

radare avatar vext01 avatar rudis avatar deeso avatar xvilka avatar montekki avatar nanomad avatar aassfxxx avatar maijin avatar jvoisin avatar eddyb avatar cosarara avatar zakharvoit avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.