rizin/binrz/rz-test/rz-test.c
Giovanni 70fdd67278
Allow rizin tools to run as standalone binaries (#6011)
* Implement TOOL/ENVS/EXIT_STATUS for rz-test

* update readme
2026-03-11 16:24:23 +00:00

1505 lines
41 KiB
C

// SPDX-FileCopyrightText: 2020-2021 thestr4ng3r <info@florianmaerkl.de>
// SPDX-License-Identifier: LGPL-3.0-only
#include "rz_test.h"
#include <assert.h>
#include <rz_cons.h>
#include <rz_main.h>
#include <rz_windows.h>
#include <rz_util/rz_print.h>
#define Color_INSERT Color_BGREEN
#define Color_DELETE Color_BRED
#define Color_BGINSERT "\x1b[48;5;22m"
#define Color_BGDELETE "\x1b[48;5;52m"
#define Color_HLINSERT Color_BGINSERT Color_INSERT
#define Color_HLDELETE Color_BGDELETE Color_DELETE
#define WORKERS_DEFAULT 8
#define RIZIN_CMD_DEFAULT "rizin"
#define RZ_ASM_CMD_DEFAULT "rz-asm"
#define JSON_TEST_FILE_DEFAULT "bins/elf/crackme0x00b"
#define TIMEOUT_DEFAULT 960
#define STRV(x) #x
#define STR(x) STRV(x)
#define WORKERS_DEFAULT_STR STR(WORKERS_DEFAULT)
#define TIMEOUT_DEFAULT_STR STR(TIMEOUT_DEFAULT)
typedef struct rz_testfile_counts_t {
ut64 tests_left; // count of remaining tests
ut64 ok;
ut64 xx;
ut64 br;
ut64 fx;
ut64 total_elapsed;
} RzTestFileCounts;
typedef struct rz_test_state_t {
RzTestRunConfig run_config;
bool verbose;
bool no_diffing; // disable diffing unless the tests fails.
RzTestDatabase *db;
PJ *test_results;
RzThreadCond *cond; // signaled from workers to main thread to update status
RzThreadLock *lock; // protects everything below
HtSP *path_left; // char * (path to test file) => RzTestFileCounts *
RzPVector /*<char *>*/ completed_paths;
ut64 ok_count;
ut64 xx_count;
ut64 br_count;
ut64 fx_count;
RzPVector /*<RzTest *>*/ queue;
RzPVector /*<RzTestResultInfo *>*/ results;
} RzTestState;
static void *worker_th(RzTestState *state);
static void print_state(RzTestState *state, ut64 prev_completed);
static void print_log(RzTestState *state, ut64 prev_completed, ut64 prev_paths_completed);
static void interact(RzTestState *state);
static bool interact_fix(RzTestResultInfo *result, RzPVector /*<RzTestResultInfo *>*/ *fixup_results);
static void interact_break(RzTestResultInfo *result, RzPVector /*<RzTestResultInfo *>*/ *fixup_results);
static void interact_commands(RzTestResultInfo *result, RzPVector /*<RzTestResultInfo *>*/ *fixup_results);
static void accept_all(RzTestState *state);
static int help(bool verbose) {
printf("%s%s%s", Color_CYAN, "Usage: ", Color_RESET);
printf("rz-test [-qvVnL] [-j threads] [test file/dir | @test-type]\n");
if (verbose) {
const char *options[] = {
// clang-format off
"-h", "", "Show this help",
"-v", "", "Show version information",
"-q", "", "Quiet mode",
"-V", "", "Be verbose",
"-N", "", "Disable diffing unless the test fails.",
"-i", "", "Interactive mode",
"-y", "", "Accept all interactive changes",
"-n", "", "Do nothing (don't run any test, just load/parse them)",
"-L", "", "Log mode (better printing for CI, logfiles, etc.)",
"-F", "dir", "Run fuzz tests (open and default analysis) on all files in the given dir",
"-j", "threads", "How many threads to use for running tests concurrently (default is " WORKERS_DEFAULT_STR ")",
"-r", "bindir", "Path to rizin bin folder (default is $PATH)",
"-f", "file", "File to use for JSON tests (default is " JSON_TEST_FILE_DEFAULT ")",
"-C", "dir", "Chdir before running rz-test (default follows test pathname/cwd)",
"-t", "seconds", "Timeout per test (default is " TIMEOUT_DEFAULT_STR " seconds)",
"-o", "file", "Output test run information in JSON format to file",
"-e", "dir", "Exclude a particular directory while testing (this option can appear many times)",
"-s", "num", "Number of expected successful tests",
"-x", "num", "Number of expected failed tests",
// clang-format on
};
rz_print_colored_help(options, RZ_ARRAY_SIZE(options), false);
printf("Supported test types: @json @unit @fuzz @cmds\n"
"OS/Arch for archos tests: " RZ_TEST_ARCH_OS "\n");
}
return 1;
}
static bool rz_test_test_run_unit(void) {
return rz_sys_system("make -C unit all run") == 0;
}
/**
* \brief Change cwd to test root dir (that has the `db/` dir) by checking dirs of test_path.
* \param test_path Test pathname. If NULL, empty, or starts with `@`, cwd is used.
* \return True if test root dir is found.
*
* The cwd change is done so that tests can find their test binaries stored in the
* `<test root dir>/bins` dir no matter what the old cwd was.
*/
static bool rz_test_chdir_fromtest(const char *test_path) {
if (!test_path || *test_path == '@') {
test_path = "";
}
char *abs_test_path = rz_file_abspath(test_path);
if (!rz_file_is_directory(abs_test_path)) {
char *last_slash = (char *)rz_str_lchr(abs_test_path, RZ_SYS_DIR[0]);
if (last_slash) {
*last_slash = 0;
}
}
if (chdir(abs_test_path) == -1) {
free(abs_test_path);
return false;
}
free(abs_test_path);
bool found = false;
char *cwd = NULL;
char *old_cwd = NULL;
while (true) {
cwd = rz_sys_getdir();
if (old_cwd && !strcmp(old_cwd, cwd)) {
break;
}
if (rz_file_is_directory("test")) {
rz_sys_chdir("test");
if (rz_file_is_directory("db")) {
found = true;
eprintf("Running from %s\n", cwd);
break;
}
rz_sys_chdir("..");
}
if (rz_file_is_directory("db")) {
found = true;
eprintf("Running from %s\n", cwd);
break;
}
free(old_cwd);
old_cwd = cwd;
cwd = NULL;
if (chdir("..") == -1) {
break;
}
}
free(old_cwd);
free(cwd);
return found;
}
static bool rz_test_can_find_rizin(const char *bin_path) {
char *exec = NULL;
const char **tools = NULL;
size_t count = 0;
rz_test_load_valid_tools(&tools, &count);
for (size_t i = 0; i < count; ++i) {
exec = rz_test_find_executable(tools[i], bin_path);
if (RZ_STR_ISEMPTY(exec)) {
eprintf("Cannot find %s in bin path: %s\n", tools[i], bin_path ? bin_path : "$PATH");
free(exec);
return false;
} else if (!rz_test_check_tool_available(exec)) {
eprintf("%s is not a valid executable\n", exec);
free(exec);
return false;
}
free(exec);
}
return true;
}
static bool log_mode = false;
int rz_test_main(int argc, const char **argv) {
int workers_count = WORKERS_DEFAULT;
bool verbose = false;
bool no_diffing = false;
bool nothing = false;
bool quiet = false;
bool interactive = false;
bool accept = false;
char *bin_path = NULL;
char *json_test_file = NULL;
char *output_file = NULL;
char *fuzz_dir = NULL;
RzPVector *except_dir = rz_pvector_new(free);
const char *rz_test_dir = NULL;
ut64 timeout_sec = TIMEOUT_DEFAULT;
st64 expect_succ = -1;
st64 expect_fail = -1;
int ret = 0;
char *cwd = NULL;
RzTestState state = { 0 };
eprintf("Running rz-test on %s\n", RZ_TEST_ARCH_OS);
if (!except_dir) {
RZ_LOG_ERROR("Fail to create RzPVector\n");
ret = -1;
goto beach;
}
#if __WINDOWS__
UINT old_cp = GetConsoleOutputCP();
{
HANDLE streams[] = { GetStdHandle(STD_OUTPUT_HANDLE), GetStdHandle(STD_ERROR_HANDLE) };
DWORD mode;
int i;
for (i = 0; i < RZ_ARRAY_SIZE(streams); i++) {
GetConsoleMode(streams[i], &mode);
SetConsoleMode(streams[i],
mode | ENABLE_PROCESSED_OUTPUT | ENABLE_VIRTUAL_TERMINAL_PROCESSING);
}
}
#endif
RzGetopt opt;
rz_getopt_init(&opt, argc, (const char **)argv, "hqvj:r:m:f:C:LnVNt:F:io:e:s:x:y");
int c;
while ((c = rz_getopt_next(&opt)) != -1) {
switch (c) {
case 'h':
ret = help(true);
goto beach;
case 'q':
quiet = true;
break;
case 'v':
if (quiet) {
printf(RZ_VERSION "\n");
} else {
RzPath *sys_path = rz_path_new();
if (!sys_path) {
goto beach;
}
char *s = rz_version_str(sys_path, "rz-test");
printf("%s\n", s);
free(s);
rz_path_free(sys_path);
}
ret = 0;
goto beach;
case 'V':
verbose = true;
break;
case 'N':
no_diffing = true;
break;
case 'i':
interactive = true;
break;
case 'y':
accept = true;
break;
case 'L':
log_mode = true;
break;
case 'F':
free(fuzz_dir);
fuzz_dir = strdup(opt.arg);
break;
case 'j':
workers_count = atoi(opt.arg);
if (workers_count <= 0) {
eprintf("Invalid thread count\n");
ret = help(false);
goto beach;
}
break;
case 'r':
bin_path = rz_file_abspath(opt.arg);
break;
case 'C':
rz_test_dir = opt.arg;
break;
case 'n':
nothing = true;
break;
case 'f':
free(json_test_file);
json_test_file = strdup(opt.arg);
break;
case 't':
timeout_sec = strtoull(opt.arg, NULL, 0);
if (!timeout_sec) {
timeout_sec = UT64_MAX;
}
break;
case 'o':
free(output_file);
output_file = strdup(opt.arg);
break;
case 'e':
rz_pvector_push(except_dir, strdup(opt.arg));
break;
case 's':
// rz_num_math returns 0 for both '0' and invalid str
expect_succ = rz_num_math(NULL, opt.arg);
if (!rz_num_is_valid_input(NULL, opt.arg) || expect_succ < 0) {
RZ_LOG_ERROR("Number of expected successful tests is invalid\n");
goto beach;
}
break;
case 'x':
expect_fail = rz_num_math(NULL, opt.arg);
if (!rz_num_is_valid_input(NULL, opt.arg) || expect_fail < 0) {
RZ_LOG_ERROR("Number of expected failed tests is invalid\n");
goto beach;
}
break;
default:
ret = help(false);
goto beach;
}
}
cwd = rz_sys_getdir();
if (!rz_test_dir) {
bool dir_found = rz_test_chdir_fromtest(opt.ind < argc ? argv[opt.ind] : NULL);
if (!dir_found) {
eprintf("Cannot find db/ directory related to the given tests. Assuming '-C .'.\n");
rz_test_dir = cwd;
}
}
if (rz_test_dir && chdir(rz_test_dir) == -1) {
eprintf("Cannot find %s directory.\n", rz_test_dir);
ret = -1;
goto beach;
}
if (fuzz_dir) {
char *tmp = fuzz_dir;
fuzz_dir = rz_file_abspath_rel(cwd, fuzz_dir);
free(tmp);
}
if (!rz_subprocess_init()) {
eprintf("Subprocess init failed\n");
ret = -1;
goto beach;
}
atexit(rz_subprocess_fini);
// this must be done after initializing rz_subprocess
if (!rz_test_can_find_rizin(bin_path)) {
ret = -1;
goto beach;
}
rz_sys_setenv("TZ", "UTC");
ut64 time_start = rz_time_now_mono();
// Avoid PATH search for each process launched
state.run_config.bin_path = bin_path;
state.run_config.json_test_file = json_test_file ? json_test_file : JSON_TEST_FILE_DEFAULT;
state.run_config.timeout_ms = timeout_sec > UT64_MAX / 1000 ? UT64_MAX : timeout_sec * 1000;
state.verbose = verbose;
state.no_diffing = no_diffing;
state.db = rz_test_test_database_new();
if (!state.db) {
ret = -1;
goto beach;
}
rz_pvector_init(&state.queue, NULL);
rz_pvector_init(&state.results, (RzPVectorFree)rz_test_test_result_info_free);
rz_pvector_init(&state.completed_paths, NULL);
if (output_file) {
state.test_results = pj_new();
pj_a(state.test_results);
}
state.lock = rz_th_lock_new(false);
if (!state.lock) {
ret = -1;
goto beach;
}
state.cond = rz_th_cond_new();
if (!state.cond) {
ret = -1;
goto beach;
}
if (opt.ind < argc) {
// Manually specified path(s)
int i;
for (i = opt.ind; i < argc; i++) {
const char *arg = argv[i];
char *alloc_arg = NULL;
if (*arg == '@') {
arg++;
eprintf("Category: %s\n", arg);
if (!strcmp(arg, "unit")) {
if (!rz_test_test_run_unit()) {
ret = -1;
goto beach;
}
continue;
} else if (!strcmp(arg, "fuzz")) {
if (!fuzz_dir) {
eprintf("No fuzz dir given. Use -F [dir]\n");
ret = -1;
goto beach;
}
if (!rz_test_test_database_load_fuzz(state.db, fuzz_dir)) {
eprintf("Failed to load fuzz tests from \"%s\"\n", fuzz_dir);
}
continue;
} else if (!strcmp(arg, "json")) {
arg = "db/json";
} else if (!strcmp(arg, "dasm")) {
arg = "db/asm";
} else if (!strcmp(arg, "cmds")) {
arg = "db";
} else {
arg = alloc_arg = rz_str_newf("db/%s", arg + 1);
}
}
char *tf = rz_file_abspath_rel(cwd, arg);
if (!tf || !rz_test_test_database_load(state.db, tf)) {
eprintf("Failed to load tests from \"%s\"\n", tf);
rz_test_test_database_free(state.db);
free(tf);
free(alloc_arg);
ret = -1;
goto beach;
}
RZ_FREE(alloc_arg);
free(tf);
}
} else {
// Default db path
if (!rz_test_test_database_load(state.db, "db")) {
eprintf("Failed to load tests from ./db\n");
rz_test_test_database_free(state.db);
ret = -1;
goto beach;
}
if (fuzz_dir && !rz_test_test_database_load_fuzz(state.db, fuzz_dir)) {
eprintf("Failed to load fuzz tests from \"%s\"\n", fuzz_dir);
}
}
// filter out except_dir
if (!rz_pvector_empty(except_dir)) {
void **it;
rz_pvector_foreach (except_dir, it) {
char *dir_abs_path = rz_file_abspath_rel(cwd, (char *)*it), *tp;
if (log_mode || verbose) {
printf("Removing tests in dir: %s\n", dir_abs_path);
}
for (ut32 i = 0; i < rz_pvector_len(&state.db->tests); i++) {
RzTest *test = rz_pvector_at(&state.db->tests, i);
if (rz_file_is_abspath(test->path)) {
tp = strdup(test->path);
} else {
tp = rz_file_abspath_rel(cwd, test->path);
}
if (rz_str_startswith(tp, dir_abs_path)) {
if (log_mode || verbose) {
char *name = rz_test_test_name(test);
printf("Removed test %s: %s\n", test->path, name);
free(name);
}
rz_test_test_free(test);
rz_pvector_remove_at(&state.db->tests, i--);
}
RZ_FREE(tp);
}
RZ_FREE(dir_abs_path);
}
}
uint32_t loaded_tests = rz_pvector_len(&state.db->tests);
printf("Loaded %u tests.\n", loaded_tests);
if (nothing) {
goto coast;
}
bool jq_available = rz_test_check_jq_available();
if (!jq_available) {
eprintf("Skipping json tests because jq is not available.\n");
size_t i;
for (i = 0; i < rz_pvector_len(&state.db->tests);) {
RzTest *test = rz_pvector_at(&state.db->tests, i);
if (test->type == RZ_TEST_TYPE_JSON) {
rz_test_test_free(test);
rz_pvector_remove_at(&state.db->tests, i);
continue;
}
i++;
}
}
if (rz_pvector_len(&state.db->tests) != 0) {
rz_pvector_insert_range(&state.queue, 0, state.db->tests.v.a, rz_pvector_len(&state.db->tests));
} else {
eprintf("No tests discovered\n");
}
if (log_mode) {
// Log mode prints the state after every completed file.
// The count of tests left per file is stored in a ht.
state.path_left = ht_sp_new(HT_STR_DUP, NULL, free);
if (state.path_left) {
void **it;
rz_pvector_foreach (&state.queue, it) {
RzTest *test = *it;
RzTestFileCounts *counts = ht_sp_find(state.path_left, test->path, NULL);
if (!counts) {
counts = calloc(1, sizeof(RzTestFileCounts));
ht_sp_insert(state.path_left, test->path, counts);
}
counts->tests_left++;
}
}
}
rz_th_lock_enter(state.lock);
RzPVector workers;
rz_pvector_init(&workers, NULL);
int i;
for (i = 0; i < workers_count; i++) {
RzThread *th = rz_th_new((RzThreadFunction)worker_th, &state);
if (!th) {
eprintf("Failed to start thread.\n");
rz_th_lock_leave(state.lock);
exit(-1);
}
rz_pvector_push(&workers, th);
}
ut64 prev_completed = UT64_MAX;
ut64 prev_paths_completed = 0;
while (true) {
ut64 completed = (ut64)rz_pvector_len(&state.results);
if (log_mode) {
print_log(&state, prev_completed, prev_paths_completed);
} else if (completed != prev_completed) {
print_state(&state, prev_completed);
}
prev_completed = completed;
prev_paths_completed = (ut64)rz_pvector_len(&state.completed_paths);
if (completed == rz_pvector_len(&state.db->tests)) {
break;
}
rz_th_cond_wait(state.cond, state.lock);
}
rz_th_lock_leave(state.lock);
printf("\n");
void **it;
rz_pvector_foreach (&workers, it) {
RzThread *th = *it;
rz_th_wait(th);
rz_th_free(th);
}
rz_pvector_clear(&workers);
ut64 seconds = (rz_time_now_mono() - time_start) / 1000000;
printf("Finished in");
if (seconds > 60) {
ut64 minutes = seconds / 60;
printf(" %" PFMT64u " minutes and", minutes);
seconds -= (minutes * 60);
}
printf(" %" PFMT64u " seconds.\n", seconds % 60);
if (output_file) {
pj_end(state.test_results);
char *results = pj_drain(state.test_results);
rz_file_dump(output_file, (ut8 *)results, strlen(results), false);
free(results);
}
if (interactive) {
interact(&state);
}
if (accept) {
accept_all(&state);
}
if (expect_succ > 0 && expect_succ != state.ok_count) {
ret = 1;
}
if (expect_fail > 0 && expect_fail != state.xx_count) {
ret = 1;
}
if (expect_fail < 0 && expect_succ < 0 && state.xx_count) {
ret = 1;
}
coast:
rz_pvector_clear(&state.queue);
rz_pvector_clear(&state.results);
rz_pvector_clear(&state.completed_paths);
rz_test_test_database_free(state.db);
ht_sp_free(state.path_left);
beach:
free(bin_path);
free(output_file);
free(json_test_file);
free(fuzz_dir);
RZ_FREE(cwd);
rz_th_lock_free(state.lock);
rz_th_cond_free(state.cond);
rz_pvector_free(except_dir);
#if __WINDOWS__
if (old_cp) {
(void)SetConsoleOutputCP(old_cp);
// chcp doesn't pick up the code page switch for some reason
(void)rz_sys_cmdf("chcp %u > NUL", old_cp);
}
#endif
return ret;
}
// elapsed is in microsecs
static char *readable_elapsed_time(ut64 elapsed) {
elapsed /= 1000;
ut32 millisecs = elapsed % 1000;
elapsed /= 1000;
ut32 secs = elapsed % 60;
elapsed /= 60;
ut32 mins = elapsed % 60;
elapsed /= 60;
ut32 hours = elapsed % 60;
return rz_str_newf("%02uh%02um%02us%03ums", hours, mins, secs, millisecs);
}
static void test_result_to_json(PJ *pj, RzTestResultInfo *result) {
rz_return_if_fail(pj && result);
pj_o(pj);
pj_k(pj, "type");
RzTest *test = result->test;
switch (test->type) {
case RZ_TEST_TYPE_CMD:
pj_s(pj, "cmd");
pj_ks(pj, "name", test->cmd_test->name.value ? test->cmd_test->name.value : "missing name");
break;
case RZ_TEST_TYPE_ASM:
pj_s(pj, "asm");
pj_ks(pj, "arch", test->asm_test->arch);
pj_ki(pj, "bits", test->asm_test->bits);
pj_kn(pj, "line", test->asm_test->line);
break;
case RZ_TEST_TYPE_JSON:
pj_s(pj, "json");
pj_ks(pj, "cmd", test->json_test->cmd);
break;
case RZ_TEST_TYPE_FUZZ:
pj_s(pj, "fuzz");
pj_ks(pj, "file", test->fuzz_test->file);
break;
}
switch (result->result) {
case RZ_TEST_RESULT_OK:
pj_ks(pj, "result", "ok");
break;
case RZ_TEST_RESULT_FAILED:
pj_ks(pj, "result", "failed");
break;
case RZ_TEST_RESULT_BROKEN:
pj_ks(pj, "result", "broken");
break;
case RZ_TEST_RESULT_FIXED:
pj_ks(pj, "result", "fixed");
break;
}
pj_ks(pj, "path", rz_str_get(result->test->path));
pj_kb(pj, "run_failed", result->run_failed);
pj_kn(pj, "time_elapsed", result->time_elapsed);
char *time_human = readable_elapsed_time(result->time_elapsed);
pj_ks(pj, "time_elapsed_human", time_human);
free(time_human);
pj_kb(pj, "timeout", result->timeout);
pj_end(pj);
}
static void *worker_th(RzTestState *state) {
rz_th_lock_enter(state->lock);
while (true) {
if (rz_pvector_empty(&state->queue)) {
break;
}
RzTest *test = rz_pvector_pop(&state->queue);
rz_th_lock_leave(state->lock);
RzTestResultInfo *result = rz_test_run_test(&state->run_config, test);
rz_th_lock_enter(state->lock);
rz_pvector_push(&state->results, result);
if (!log_mode) {
switch (result->result) {
case RZ_TEST_RESULT_OK:
state->ok_count++;
break;
case RZ_TEST_RESULT_FAILED:
state->xx_count++;
break;
case RZ_TEST_RESULT_BROKEN:
state->br_count++;
break;
case RZ_TEST_RESULT_FIXED:
state->fx_count++;
break;
}
}
if (state->path_left) {
RzTestFileCounts *counts = ht_sp_find(state->path_left, test->path, NULL);
if (counts) {
switch (result->result) {
case RZ_TEST_RESULT_OK:
counts->ok++;
break;
case RZ_TEST_RESULT_FAILED:
counts->xx++;
break;
case RZ_TEST_RESULT_BROKEN:
counts->br++;
break;
case RZ_TEST_RESULT_FIXED:
counts->fx++;
break;
}
counts->total_elapsed += result->time_elapsed;
counts->tests_left--;
if (!counts->tests_left) {
rz_pvector_push(&state->completed_paths, (void *)test->path);
}
}
}
rz_th_cond_signal(state->cond);
}
rz_th_lock_leave(state->lock);
return NULL;
}
static char *get_matched_str(const char *regexp, const char *str) {
RzStrBuf *match_str = rz_test_regex_full_match_str(regexp, str);
size_t len = rz_strbuf_length(match_str);
if (len && rz_strbuf_get(match_str)[len - 1] != '\n') { // empty matches are not changed
rz_strbuf_append(match_str, "\n");
}
return rz_strbuf_drain(match_str);
}
static void print_diff(const char *actual, const char *expected, const char *regexp) {
RzDiff *d = NULL;
char *uni = NULL;
const char *output = actual;
if (regexp) {
output = get_matched_str(regexp, actual);
}
d = rz_diff_lines_new(expected, output, NULL);
if (!d) {
goto cleanup;
}
uni = rz_diff_unified_text(d, "expected", "actual", false, true);
if (!uni) {
goto cleanup;
}
puts(uni);
free(uni);
cleanup:
rz_diff_free(d);
if (regexp) {
free((char *)output);
}
}
static RzSubprocessOutput *print_runner(const char *file, const char *args[], size_t args_size,
const char *envvars[], const char *envvals[], size_t env_size, ut64 timeout_ms, void *user) {
size_t i;
for (i = 0; i < env_size; i++) {
printf("%s=%s ", envvars[i], envvals[i]);
}
printf("%s", file);
for (i = 0; i < args_size; i++) {
const char *str = args[i];
if (strpbrk(str, "\n \'\"")) {
printf(" '%s'", str); // TODO: escape
} else {
printf(" %s", str);
}
}
printf("\n");
return NULL;
}
static void print_asm_exit_status(const char *mode, bool timeout, int ret, const char *err) {
printf("-- %s exit status: ", mode);
if (timeout) {
printf(Color_CYAN "TIMEOUT" Color_RESET);
} else if (ret != 0) {
printf(Color_RED "%d" Color_RESET, ret);
} else {
printf("0");
}
printf("\n");
if (RZ_STR_ISNOTEMPTY(err)) {
printf("-- %s stderr\n" Color_RED "%s" Color_RESET "\n", mode, err);
}
}
static void print_result_diff(RzTestRunConfig *config, RzTestResultInfo *result) {
if (result->run_failed) {
printf(Color_RED "RUN FAILED (e.g. wrong rizin path)" Color_RESET "\n");
return;
}
switch (result->test->type) {
case RZ_TEST_TYPE_CMD: {
rz_test_run_cmd_test(config, result->test->cmd_test, print_runner, NULL);
const char *expect = result->test->cmd_test->expect.value;
const char *out = (const char *)result->proc_out->out;
const char *regexp_out = result->test->cmd_test->regexp_out.value;
if (expect && !rz_test_cmp_cmd_output(out, expect, regexp_out)) {
printf("-- stdout\n");
print_diff(out, expect, regexp_out);
}
expect = result->test->cmd_test->expect_err.value;
const char *err = (const char *)result->proc_out->err;
const char *regexp_err = result->test->cmd_test->regexp_err.value;
if (expect && !rz_test_cmp_cmd_output(err, expect, regexp_err)) {
printf("-- stderr\n");
print_diff(err, expect, regexp_err);
} else if (*err) {
printf("-- stderr\n%s\n", err);
}
if (result->proc_out->ret != result->test->cmd_test->exit_status.value) {
printf("-- exit status: " Color_RED "%d" Color_RESET "\n", result->proc_out->ret);
}
break;
}
case RZ_TEST_TYPE_ASM: {
RzAsmTest *test = result->test->asm_test;
RzAsmTestOutput *out = result->asm_out;
char *expect_hex = rz_hex_bin2strdup(test->bytes, test->bytes_size);
printf("-- <asm> " Color_YELLOW "%s %c--%c %s%s" Color_RESET "\n",
test->disasm,
test->mode & RZ_ASM_TEST_MODE_DISASSEMBLE ? '<' : '-',
test->mode & RZ_ASM_TEST_MODE_ASSEMBLE ? '>' : '-',
expect_hex ? expect_hex : "",
test->il ? " ---> <IL>" : "");
if (test->mode & RZ_ASM_TEST_MODE_DISASSEMBLE) {
const char *expect = test->disasm;
const char *actual = out->disasm;
if (expect && actual && strcmp(actual, expect)) {
printf("-- disassembly\n");
print_diff(actual, expect, NULL);
}
}
if (test->mode & RZ_ASM_TEST_MODE_ASSEMBLE) {
printf("-- assembly\n");
if (out->bytes && (out->bytes_size != test->bytes_size || memcmp(out->bytes, test->bytes, out->bytes_size))) {
char *actual = rz_hex_bin2strdup(out->bytes, out->bytes_size);
print_diff(actual ? actual : "", expect_hex ? expect_hex : "", NULL);
free(actual);
}
}
if (test->il) {
const char *expect = test->il;
const char *actual = out->il;
const char *hdr = "-- IL\n";
if (expect && actual && strcmp(actual, expect)) {
printf("%s", hdr);
print_diff(actual, expect, NULL);
}
}
if (test->mode & RZ_ASM_TEST_MODE_DISASSEMBLE) {
print_asm_exit_status("disasm", out->disas_timeout, out->disas_ret, out->disas_err);
}
if (test->mode & RZ_ASM_TEST_MODE_ASSEMBLE) {
print_asm_exit_status("asm", out->as_timeout, out->as_ret, out->as_err);
}
if (test->il) {
print_asm_exit_status("IL", out->il_timeout, out->il_ret, out->il_err);
}
free(expect_hex);
break;
}
case RZ_TEST_TYPE_JSON:
break;
case RZ_TEST_TYPE_FUZZ:
rz_test_run_fuzz_test(config, result->test->fuzz_test, print_runner, NULL);
printf("-- stdout\n%s\n", (const char *)result->proc_out->out);
printf("-- stderr\n%s\n", (const char *)result->proc_out->err);
printf("-- exit status: " Color_RED "%d" Color_RESET "\n", result->proc_out->ret);
break;
}
}
static void print_new_results(RzTestState *state, ut64 prev_completed) {
// Detailed test result (with diff if necessary)
ut64 completed = (ut64)rz_pvector_len(&state->results);
for (ut64 i = prev_completed; i < completed; i++) {
RzTestResultInfo *result = rz_pvector_at(&state->results, (size_t)i);
if (state->test_results) {
test_result_to_json(state->test_results, result);
}
if (!state->verbose && (result->result == RZ_TEST_RESULT_OK || result->result == RZ_TEST_RESULT_FIXED || result->result == RZ_TEST_RESULT_BROKEN)) {
continue;
}
char *name = rz_test_test_name(result->test);
if (!name) {
continue;
}
printf("\n" RZ_CONS_CURSOR_UP RZ_CONS_CLEAR_LINE);
switch (result->result) {
case RZ_TEST_RESULT_OK:
printf(Color_GREEN "[OK]" Color_RESET);
break;
case RZ_TEST_RESULT_FAILED:
printf(Color_RED "[XX]" Color_RESET);
break;
case RZ_TEST_RESULT_BROKEN:
printf(Color_BLUE "[BR]" Color_RESET);
break;
case RZ_TEST_RESULT_FIXED:
printf(Color_CYAN "[FX]" Color_RESET);
break;
}
if (result->timeout) {
printf(Color_CYAN " TIMEOUT" Color_RESET);
}
// time_elapsed is in microsecs
char *elapsed = readable_elapsed_time(result->time_elapsed);
printf(Color_BLUE " %s" Color_RESET " %s " Color_YELLOW "%s" Color_RESET "\n", elapsed, result->test->path, name);
if (result->result == RZ_TEST_RESULT_FAILED || (state->verbose && !state->no_diffing && result->result == RZ_TEST_RESULT_BROKEN)) {
print_result_diff(&state->run_config, result);
}
free(elapsed);
free(name);
}
}
static void print_state_counts(RzTestState *state) {
printf("%8" PFMT64u " OK %5" PFMT64u " BR %8" PFMT64u " XX %5" PFMT64u " FX",
state->ok_count, state->br_count, state->xx_count, state->fx_count);
}
static void print_state(RzTestState *state, ut64 prev_completed) {
#if __WINDOWS__
setvbuf(stdout, NULL, _IOFBF, 8192);
#endif
print_new_results(state, prev_completed);
// [x/x] OK 42 BR 0 ...
printf(RZ_CONS_CLEAR_LINE);
int w = printf("[%" PFMT64u "/%" PFMT64u "]", (ut64)rz_pvector_len(&state->results), (ut64)rz_pvector_len(&state->db->tests));
while (w >= 0 && w < 20) {
printf(" ");
w++;
}
printf(" ");
print_state_counts(state);
fflush(stdout);
#if __WINDOWS__
setvbuf(stdout, NULL, _IONBF, 0);
#endif
}
static void print_log(RzTestState *state, ut64 prev_completed, ut64 prev_paths_completed) {
print_new_results(state, prev_completed);
ut64 paths_completed = rz_pvector_len(&state->completed_paths);
for (; prev_paths_completed < paths_completed; prev_paths_completed++) {
const char *name = (const char *)rz_pvector_at(&state->completed_paths, prev_paths_completed);
if (!name) {
name = "unknown path. something is very wrong.";
}
if (state->path_left) {
char *total_elapsed = NULL;
RzTestFileCounts *counts = ht_sp_find(state->path_left, name, NULL);
if (counts) {
state->ok_count += counts->ok;
state->xx_count += counts->xx;
state->br_count += counts->br;
state->fx_count += counts->fx;
total_elapsed = readable_elapsed_time(counts->total_elapsed);
}
printf("%s [**] %-60s ", rz_str_get(total_elapsed), name);
free(total_elapsed);
} else {
printf("[**] %-60s ", name);
}
print_state_counts(state);
printf("\n");
fflush(stdout);
}
}
static void interact(RzTestState *state) {
void **it;
RzPVector failed_results;
rz_pvector_init(&failed_results, NULL);
rz_pvector_foreach (&state->results, it) {
RzTestResultInfo *result = *it;
if (result->result == RZ_TEST_RESULT_FAILED) {
rz_pvector_push(&failed_results, result);
}
}
if (rz_pvector_empty(&failed_results)) {
goto beach;
}
#if __WINDOWS__
(void)SetConsoleOutputCP(65001); // UTF-8
#endif
printf("\n");
printf("#####################\n");
printf(" %" PFMT64u " failed test(s) " UTF8_POLICE_CARS_REVOLVING_LIGHT "\n",
(ut64)rz_pvector_len(&failed_results));
ut32 cnt = 0;
rz_pvector_foreach (&failed_results, it) {
cnt++;
RzTestResultInfo *result = *it;
if (result->test->type != RZ_TEST_TYPE_CMD && result->test->type != RZ_TEST_TYPE_ASM) {
continue;
}
printf("#####################\n\n");
char *name = rz_test_test_name(result->test);
if (name) {
printf(Color_RED "[XX]" Color_RESET " %s " Color_YELLOW "%s" Color_RESET " (%d/%zu)\n", result->test->path, name, cnt, rz_pvector_len(&failed_results));
free(name);
}
print_result_diff(&state->run_config, result);
bool have_commands = result->test->type == RZ_TEST_TYPE_CMD;
menu:
printf("Wat do? "
"(f)ix " UTF8_WHITE_HEAVY_CHECK_MARK UTF8_VS16 UTF8_VS16 UTF8_VS16 " "
"(i)gnore " UTF8_SEE_NO_EVIL_MONKEY " "
"(b)roken " UTF8_SKULL_AND_CROSSBONES UTF8_VS16 UTF8_VS16 UTF8_VS16 " "
"%s"
"(q)uit " UTF8_DOOR "\n",
have_commands ? "(c)ommands " UTF8_KEYBOARD UTF8_VS16 " " : "");
printf("> ");
char buf[0x30];
if (!fgets(buf, sizeof(buf), stdin)) {
break;
}
if (strlen(buf) != 2) {
goto menu;
}
switch (buf[0]) {
case 'f':
if (!interact_fix(result, &failed_results)) {
printf("This test has failed too hard to be fixed.\n");
goto menu;
}
break;
case 'i':
break;
case 'b':
interact_break(result, &failed_results);
break;
case 'c':
if (have_commands) {
interact_commands(result, &failed_results);
break;
}
goto menu;
case 'q':
goto beach;
default:
goto menu;
}
}
beach:
rz_pvector_clear(&failed_results);
}
static void accept_all(RzTestState *state) {
void **it;
RzPVector failed_results;
rz_pvector_init(&failed_results, NULL);
rz_pvector_foreach (&state->results, it) {
RzTestResultInfo *result = *it;
if (result->result == RZ_TEST_RESULT_FAILED) {
rz_pvector_push(&failed_results, result);
}
}
if (rz_pvector_empty(&failed_results)) {
goto beach;
}
#if __WINDOWS__
(void)SetConsoleOutputCP(65001); // UTF-8
#endif
rz_pvector_foreach (&failed_results, it) {
RzTestResultInfo *result = *it;
if (result->test->type != RZ_TEST_TYPE_CMD && result->test->type != RZ_TEST_TYPE_ASM) {
continue;
}
if (!interact_fix(result, &failed_results)) {
char *name = rz_test_test_name(result->test);
printf("This test %s has failed too hard to be fixed.\n", name ? name : "");
free(name);
}
}
beach:
rz_pvector_clear(&failed_results);
}
static char *format_cmd_kv(const char *key, const char *val) {
RzStrBuf buf;
rz_strbuf_init(&buf);
rz_strbuf_appendf(&buf, "%s=", key);
if (strchr(val, '\n')) {
rz_strbuf_appendf(&buf, "<<EOF\n%sEOF", val);
} else {
rz_strbuf_append(&buf, val);
}
return rz_strbuf_drain_nofree(&buf);
}
static char *replace_lines(const char *src, size_t from, size_t to, const char *news) {
const char *begin = src;
size_t line = 1;
while (line < from) {
begin = strchr(begin, '\n');
if (!begin) {
break;
}
begin++;
line++;
}
if (!begin) {
return NULL;
}
const char *end = begin;
while (line < to) {
end = strchr(end, '\n');
if (!end) {
break;
}
end++;
line++;
}
RzStrBuf buf;
rz_strbuf_init(&buf);
rz_strbuf_append_n(&buf, src, begin - src);
rz_strbuf_append(&buf, news);
rz_strbuf_append(&buf, "\n");
if (end) {
rz_strbuf_append(&buf, end);
}
return rz_strbuf_drain_nofree(&buf);
}
// After editing a test, fix the line numbers previously saved for all the other tests
static void fixup_tests(RzPVector /*<RzTestResultInfo *>*/ *results, const char *edited_file, ut64 start_line, st64 delta) {
void **it;
rz_pvector_foreach (results, it) {
RzTestResultInfo *result = *it;
if (result->test->type != RZ_TEST_TYPE_CMD) {
continue;
}
if (result->test->path != edited_file) { // this works because all the paths come from the string pool
continue;
}
RzCmdTest *test = result->test->cmd_test;
test->run_line += delta;
#define DO_KEY_STR(key, field) \
if (test->field.value) { \
if (test->field.line_begin >= start_line) { \
test->field.line_begin += delta; \
} \
if (test->field.line_end >= start_line) { \
test->field.line_end += delta; \
} \
}
#define DO_KEY_BOOL(key, field) \
if (test->field.set && test->field.line >= start_line) { \
test->field.line += delta; \
}
#define DO_KEY_NUM(key, field) \
if (test->field.set && test->field.line >= start_line) { \
test->field.line += delta; \
}
RZ_CMD_TEST_FOREACH_RECORD(DO_KEY_STR, DO_KEY_BOOL, DO_KEY_NUM)
#undef DO_KEY_STR
#undef DO_KEY_BOOL
#undef DO_KEY_NUM
}
}
static char *read_test_file_for_fix(const char *path) {
char *content = rz_file_slurp(path, NULL);
if (!content) {
eprintf("Failed to read file \"%s\"\n", path);
}
return content;
}
static void save_test_file_for_fix(const char *path, const char *newc) {
if (rz_file_dump(path, (const ut8 *)newc, -1, false)) {
#if __UNIX__
sync();
#endif
} else {
eprintf("Failed to write file \"%s\"\n", path);
}
}
static char *replace_cmd_kv(const char *path, const char *content, size_t line_begin, size_t line_end, const char *key, const char *value, RzPVector /*<RzTestResultInfo *>*/ *fixup_results) {
char *kv = format_cmd_kv(key, value);
if (!kv) {
return NULL;
}
size_t kv_lines = rz_str_char_count(kv, '\n') + 1;
char *newc = replace_lines(content, line_begin, line_end, kv);
free(kv);
if (!newc) {
return NULL;
}
size_t lines_before = line_end - line_begin;
st64 delta = (st64)kv_lines - (st64)lines_before;
if (line_end == line_begin) {
delta++;
}
fixup_tests(fixup_results, path, line_end, delta);
return newc;
}
static void replace_cmd_kv_file(const char *path, ut64 line_begin, ut64 line_end, const char *key, const char *value, RzPVector /*<RzTestResultInfo *>*/ *fixup_results) {
char *content = read_test_file_for_fix(path);
if (!content) {
return;
}
char *newc = replace_cmd_kv(path, content, line_begin, line_end, key, value, fixup_results);
free(content);
if (!newc) {
return;
}
save_test_file_for_fix(path, newc);
free(newc);
}
static bool interact_fix_cmd(RzTestResultInfo *result, RzPVector /*<RzTestResultInfo *>*/ *fixup_results) {
assert(result->test->type == RZ_TEST_TYPE_CMD);
if (result->run_failed || result->proc_out->ret != result->test->cmd_test->exit_status.value) {
return false;
}
RzCmdTest *test = result->test->cmd_test;
RzSubprocessOutput *out = result->proc_out;
if (test->expect.value && out->out) {
const char *out_str = (char *)out->out;
const char *regexp = test->regexp_out.value;
if (regexp) {
out_str = get_matched_str(regexp, out_str);
}
replace_cmd_kv_file(result->test->path, test->expect.line_begin, test->expect.line_end, "EXPECT",
out_str, fixup_results);
}
if (test->expect_err.value && out->err) {
const char *err_str = (char *)out->err;
const char *regexp = test->regexp_err.value;
if (regexp) {
err_str = get_matched_str(regexp, err_str);
}
replace_cmd_kv_file(result->test->path, test->expect_err.line_begin, test->expect_err.line_end, "EXPECT_ERR",
err_str, fixup_results);
}
return true;
}
static void replace_file_line(const char *path, ut64 line_idx, const char *line_new) {
char *content = read_test_file_for_fix(path);
if (!content) {
return;
}
char *newc = replace_lines(content, line_idx, line_idx + 1, line_new);
free(content);
if (!newc) {
return;
}
save_test_file_for_fix(path, newc);
free(newc);
}
static void replace_asm_test(RZ_NONNULL const char *path, ut64 line_idx,
int mode, RZ_NONNULL const char *disasm, RZ_NONNULL const ut8 *bytes, size_t bytes_sz, ut64 offset, RZ_NULLABLE const char *il) {
char *hex = rz_hex_bin2strdup(bytes, bytes_sz);
if (!hex) {
return;
}
char offset_str[0x20];
if ((!offset && !il) || snprintf(offset_str, sizeof(offset_str), " 0x%" PFMT64x, offset) < 0) {
*offset_str = '\0';
}
char *line = rz_str_newf("%s%s%s%s \"%s\" %s%s%s%s",
(mode & RZ_ASM_TEST_MODE_ASSEMBLE) ? "a" : "",
(mode & RZ_ASM_TEST_MODE_DISASSEMBLE) ? "d" : "",
(mode & RZ_ASM_TEST_MODE_BIG_ENDIAN) ? "E" : "",
(mode & RZ_ASM_TEST_MODE_BROKEN) ? "B" : "",
disasm, hex, offset_str, il ? " " : "", il ? il : "");
free(hex);
if (!line) {
return;
}
replace_file_line(path, line_idx, line);
free(line);
}
/**
* Check if both assembly and disassembly passes failed,
* making it non-trivial to repair automatically.
*/
static bool asm_test_failed_both_ways(RzAsmTest *test, RzAsmTestOutput *out) {
// check that both ways are requested
if (!(test->mode & RZ_ASM_TEST_MODE_ASSEMBLE) || !(test->mode & RZ_ASM_TEST_MODE_DISASSEMBLE)) {
return false;
}
// check that disasm is wrong
if (out->disasm && !strcmp(test->disasm, out->disasm)) {
return false;
}
// check that asm is wrong too
if (out->bytes && out->bytes_size == test->bytes_size && !memcmp(out->bytes, test->bytes, test->bytes_size)) {
return false;
}
// determined that both ways are broken
return true;
}
static bool interact_fix_asm(RzTestResultInfo *result) {
assert(result->test->type == RZ_TEST_TYPE_ASM);
RzAsmTest *test = result->test->asm_test;
RzAsmTestOutput *out = result->asm_out;
const char *disasm = test->mode & RZ_ASM_TEST_MODE_DISASSEMBLE ? out->disasm : test->disasm;
if (!disasm) {
return false;
}
const ut8 *bytes;
size_t bytes_sz;
if (test->mode & RZ_ASM_TEST_MODE_ASSEMBLE) {
bytes = out->bytes;
bytes_sz = out->bytes_size;
} else {
bytes = test->bytes;
bytes_sz = test->bytes_size;
}
if (!bytes) {
return false;
}
if (asm_test_failed_both_ways(test, out)) {
// both disasm and asm failed, so trying to fix here would likely only make things worse
return false;
}
if (test->il && (out->il_failed || !out->il)) {
// IL wasn't lifted or validation failed, this can only be fixed in code
return false;
}
replace_asm_test(result->test->path, test->line, test->mode, disasm, bytes, bytes_sz, test->offset, out->il);
return true;
}
static bool interact_fix(RzTestResultInfo *result, RzPVector /*<RzTestResultInfo *>*/ *fixup_results) {
switch (result->test->type) {
case RZ_TEST_TYPE_CMD:
return interact_fix_cmd(result, fixup_results);
case RZ_TEST_TYPE_ASM:
return interact_fix_asm(result);
default:
return false;
}
}
static void interact_break_cmd(RzTestResultInfo *result, RzPVector /*<RzTestResultInfo *>*/ *fixup_results) {
assert(result->test->type == RZ_TEST_TYPE_CMD);
RzCmdTest *test = result->test->cmd_test;
ut64 line_begin;
ut64 line_end;
if (test->broken.set) {
line_begin = test->broken.set;
line_end = line_begin + 1;
} else {
line_begin = line_end = test->run_line;
}
replace_cmd_kv_file(result->test->path, line_begin, line_end, "BROKEN", "1", fixup_results);
}
static void interact_break_asm(RzTestResultInfo *result) {
assert(result->test->type == RZ_TEST_TYPE_ASM);
RzAsmTest *test = result->test->asm_test;
replace_asm_test(result->test->path, test->line,
test->mode | RZ_ASM_TEST_MODE_BROKEN, test->disasm, test->bytes, test->bytes_size, test->offset, test->il);
}
static void interact_break(RzTestResultInfo *result, RzPVector /*<RzTestResultInfo *>*/ *fixup_results) {
switch (result->test->type) {
case RZ_TEST_TYPE_CMD:
interact_break_cmd(result, fixup_results);
break;
case RZ_TEST_TYPE_ASM:
interact_break_asm(result);
break;
default:
break;
}
}
static void interact_commands(RzTestResultInfo *result, RzPVector /*<RzTestResultInfo *>*/ *fixup_results) {
assert(result->test->type == RZ_TEST_TYPE_CMD);
RzCmdTest *test = result->test->cmd_test;
if (!test->cmds.value) {
return;
}
char *name = NULL;
int fd = rz_file_mkstemp("rz-test-cmds", &name);
if (fd == -1) {
free(name);
eprintf("Failed to open tmp file\n");
return;
}
size_t cmds_sz = strlen(test->cmds.value);
if (write(fd, test->cmds.value, cmds_sz) != cmds_sz) {
eprintf("Failed to write to tmp file\n");
free(name);
close(fd);
return;
}
close(fd);
char *editor = rz_sys_getenv("EDITOR");
if (!editor || !*editor) {
free(editor);
editor = strdup("vim");
if (!editor) {
free(name);
return;
}
}
rz_sys_cmdf("%s '%s'", editor, name);
free(editor);
char *newcmds = rz_file_slurp(name, NULL);
if (!newcmds) {
eprintf("Failed to read edited command file\n");
free(name);
return;
}
rz_str_trim(newcmds);
// if it's multiline we want exactly one trailing newline
if (strchr(newcmds, '\n')) {
char *tmp = newcmds;
newcmds = rz_str_newf("%s\n", newcmds);
free(tmp);
if (!newcmds) {
free(name);
return;
}
}
replace_cmd_kv_file(result->test->path, test->cmds.line_begin, test->cmds.line_end, "CMDS", newcmds, fixup_results);
free(name);
free(newcmds);
}
int MAIN_NAME(int argc, const ARGV_TYPE **argv) {
char **utf8_argv = ARGV_TYPE_TO_UTF8(argc, argv);
int ret = rz_test_main(argc, (const char **)utf8_argv);
FREE_UTF8_ARGV(argc, utf8_argv);
return ret;
}