portugalfuturista/rizin
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
rizin/test/unit/test_project_migrate.c
Anton Kochkov 3c59df7e98
Refactor RzTypes to use structs instead of SDB + New Tree-Sitter based C Parser (#1047) 
- Removed oldshell version of `t` (types) commands
- Removed `tk` command because types storage switched to the hashtable
- Added `tfc` command to show the calling convention of the function or set it
- Added `tsl` (RZ_OUTPUT_MODE_LONG) to show structure members' sizes and offsets
- Added `tul` (RZ_OUTPUT_MODE_LONG) to show union members' sizes
- Switched the types storage to the hashtable instead of SDB
- Added load and export from/to SDB for standard type libraries and serialization for Projects
- Changed all `char *type` occurences to the proper `RzType`
- Added `RzCallable` type for the function/class method types
- Changed all function types API to use the `RzCallable` API
- Switched the function types (`RzCallable`) storage to the hashtable instead of SDB
- Added a connection between `RzAnalysisFunction` and `RzCallable` - `rz_analysis_function_derive_type()` API function to derive new `RzCallable` type from the `RzAnalysisFunction` even if it doesn't exist in the RzTypeDB.
- Moved type links to the RzAnalysis where they belong
- Removed TCC and MPC-based parsers
- Added Tree-Sitter-based parser for C grammar (see `librz/type/parser/*`)
- Reworked type databases in `librz/analysis/d/` to be consistent with C standard, libc, platform-specific definitions
- Switched the type links from `char *` to `RzType`
- Switched the type links from SDB to the hashtable
- Added concept of the "type paths", e.g. `a.b[20].c` where `b` is a member of `a` (`a` is either structure or a union) and `c` is a member of `b`, and `b` is an array where we take 20-th element.
- Added concept of the typeclasses (a bit similar to Haskell) for numerical types: `None` (the most generic one), `Num` (includes `Integral` and `Floating`), `Integral` (includes `Signed Integral` and `Unsigned Integral`), `Floating`.
- Added concept of type equality (`rz_types_equal(a, b)` API function)
- Added Doxygen documentation to every API function in the `librz/type/*`.
- Updated the project format from **V2** to **V3**, added migration.
2021-07-20 01:46:45 +08:00

198 lines
8.1 KiB
C
Raw Blame History

// SPDX-FileCopyrightText: 2021 Florian Märkl <info@florianmaerkl.de>
// SPDX-License-Identifier: LGPL-3.0-only
#include <rz_core.h>
#include <rz_project.h>
#include "minunit.h"
/**
* \file
* About Project Migration Tests:
*
* Every migration from version A to version B has to come with two kinds of tests,
* of which both cover all changes performed by this migration:
*
* * **Individual tests for only the single migration from A to B.**
* These are written against the sdb directly and test changes made by a single call to the
* respective `rz_project_migrate_vA_vB` function. No RzCore is involved in these tests.
* They should be written once and ideally never change in the future as they are not affected
* by later project versions.
* They are called `test_migrate_vA_vB_<...>` here.
* * **Loading tests from version A to the current version.**
* These load a project of version A completely into an RzCore. Then they test if the data
* migrated has eventually been correctly deserialized into the core.
* They make sure that the results produced by the migration and tested by the individual tests
* are actually valid for the deserialization.
* As the feature set and architecture of RzCore and all descendants may change, these tests
* can be adapted in the future and in extreme cases even be removed if the migrated data simply
* is not used anymore.
* These are called `test_load_vA_<...>` here.
*
* See also `librz/core/project_migrate.c` for general info on implementing project migrations.
*
*/
bool test_migrate_v1_v2_noreturn() {
RzProject *prj = rz_project_load_file_raw("prj/v1-noreturn.rzdb");
mu_assert_notnull(prj, "load raw project");
RzSerializeResultInfo *res = rz_serialize_result_info_new();
bool s = rz_project_migrate_v1_v2(prj, res);
mu_assert_true(s, "migrate success");
Sdb *core_db = sdb_ns(prj, "core", false);
mu_assert_notnull(core_db, "core ns");
Sdb *analysis_db = sdb_ns(core_db, "analysis", false);
mu_assert_notnull(analysis_db, "analysis ns");
Sdb *types_db = sdb_ns(analysis_db, "types", false);
mu_assert_notnull(types_db, "types ns");
mu_assert_null(sdb_get(types_db, "addr.1337.noreturn", 0), "old noreturn deleted");
mu_assert_null(sdb_get(types_db, "addr.4242.noreturn", 0), "old noreturn deleted");
Sdb *noreturn_db = sdb_ns(analysis_db, "noreturn", false);
mu_assert_notnull(noreturn_db, "noreturn ns");
mu_assert_streq(sdb_get(noreturn_db, "addr.1337.noreturn", 0), "true", "new noreturn added");
mu_assert_streq(sdb_get(noreturn_db, "addr.4242.noreturn", 0), "true", "new noreturn added");
rz_serialize_result_info_free(res);
rz_project_free(prj);
mu_end;
}
bool test_migrate_v1_v2_noreturn_empty() {
RzProject *prj = rz_project_load_file_raw("prj/v1-noreturn-empty.rzdb");
mu_assert_notnull(prj, "load raw project");
RzSerializeResultInfo *res = rz_serialize_result_info_new();
bool s = rz_project_migrate_v1_v2(prj, res);
mu_assert_true(s, "migrate success");
Sdb *core_db = sdb_ns(prj, "core", false);
mu_assert_notnull(core_db, "core ns");
Sdb *analysis_db = sdb_ns(core_db, "analysis", false);
mu_assert_notnull(analysis_db, "analysis ns");
Sdb *types_db = sdb_ns(analysis_db, "types", false);
mu_assert_notnull(types_db, "types ns");
Sdb *noreturn_db = sdb_ns(analysis_db, "noreturn", false);
// not more to test here, just assert the existence of the noreturn ns
mu_assert_notnull(noreturn_db, "noreturn ns");
rz_serialize_result_info_free(res);
rz_project_free(prj);
mu_end;
}
bool test_migrate_v2_v3() {
// TODO: like above
mu_end;
}
bool test_load_v1_noreturn() {
RzCore *core = rz_core_new();
RzSerializeResultInfo *res = rz_serialize_result_info_new();
mu_assert_notnull(res, "result info new");
RzProjectErr err = rz_project_load_file(core, "prj/v1-noreturn.rzdb", true, res);
mu_assert_eq(err, RZ_PROJECT_ERR_SUCCESS, "project load err");
mu_assert_eq(rz_list_length(res), 2, "info");
mu_assert_streq(rz_list_get_n(res, 0), "project migrated from version 1 to 2.", "info");
mu_assert_streq(rz_list_get_n(res, 1), "project migrated from version 2 to 3.", "info");
mu_assert_true(rz_analysis_noreturn_at_addr(core->analysis, 0x4242), "noreturn");
mu_assert_true(rz_analysis_noreturn_at_addr(core->analysis, 0x1337), "noreturn");
mu_assert_false(rz_analysis_noreturn_at_addr(core->analysis, 0x12345), "nono");
rz_serialize_result_info_free(res);
rz_core_free(core);
mu_end;
}
bool test_load_v1_noreturn_empty() {
RzCore *core = rz_core_new();
RzSerializeResultInfo *res = rz_serialize_result_info_new();
mu_assert_notnull(res, "result info new");
RzProjectErr err = rz_project_load_file(core, "prj/v1-noreturn-empty.rzdb", true, res);
mu_assert_eq(err, RZ_PROJECT_ERR_SUCCESS, "project load err");
mu_assert_eq(rz_list_length(res), 2, "info");
mu_assert_streq(rz_list_get_n(res, 0), "project migrated from version 1 to 2.", "info");
mu_assert_streq(rz_list_get_n(res, 1), "project migrated from version 2 to 3.", "info");
mu_assert_false(rz_analysis_noreturn_at_addr(core->analysis, 0x4242), "nono");
mu_assert_false(rz_analysis_noreturn_at_addr(core->analysis, 0x1337), "nono");
mu_assert_false(rz_analysis_noreturn_at_addr(core->analysis, 0x12345), "nono");
rz_serialize_result_info_free(res);
rz_core_free(core);
mu_end;
}
bool test_load_v2_typelink() {
RzCore *core = rz_core_new();
RzSerializeResultInfo *res = rz_serialize_result_info_new();
mu_assert_notnull(res, "result info new");
RzProjectErr err = rz_project_load_file(core, "prj/v2-typelink-callables.rzdb", true, res);
mu_assert_eq(err, RZ_PROJECT_ERR_SUCCESS, "project load err");
mu_assert_eq(rz_list_length(res), 1, "info");
mu_assert_streq(rz_list_get_n(res, 0), "project migrated from version 2 to 3.", "info");
mu_assert_true(rz_analysis_type_link_exists(core->analysis, 0x80484b0), "has typelink");
RzType *typelink = rz_analysis_type_link_at(core->analysis, 0x80484b0);
mu_assert_notnull(typelink, "has typelink");
mu_assert_eq(RZ_TYPE_KIND_POINTER, typelink->kind, "typelink is a pointer");
mu_assert_true(rz_type_atomic_str_eq(core->analysis->typedb, typelink->pointer.type, "char"), "typelink is char *");
rz_serialize_result_info_free(res);
rz_core_free(core);
mu_end;
}
bool test_load_v2_callables() {
RzCore *core = rz_core_new();
RzSerializeResultInfo *res = rz_serialize_result_info_new();
mu_assert_notnull(res, "result info new");
RzProjectErr err = rz_project_load_file(core, "prj/v2-typelink-callables.rzdb", true, res);
mu_assert_eq(err, RZ_PROJECT_ERR_SUCCESS, "project load err");
mu_assert_eq(rz_list_length(res), 1, "info");
mu_assert_streq(rz_list_get_n(res, 0), "project migrated from version 2 to 3.", "info");
RzAnalysisFunction *fcn = rz_analysis_get_function_byname(core->analysis, "entry0");
mu_assert_notnull(fcn, "find \"entry0\" function");
fcn = rz_analysis_get_function_byname(core->analysis, "main");
mu_assert_notnull(fcn, "find \"entry0\" function");
RzTypeDB *typedb = core->analysis->typedb;
RzCallable *chmod = rz_type_func_get(typedb, "chmod");
mu_assert_notnull(chmod, "func \"chmod\" callable type");
mu_assert_streq(chmod->name, "chmod", "is chmod() function");
mu_assert_eq(2, rz_type_func_args_count(typedb, "chmod"), "chmod() has 2 arguments");
mu_assert_false(chmod->noret, "func \"chmod\" returns");
RzCallableArg *arg0 = *rz_pvector_index_ptr(chmod->args, 0);
mu_assert_notnull(arg0, "func \"chmod\" has 1st argument");
mu_assert_streq(arg0->name, "path", "has \"path\" argument");
RzCallableArg *arg1 = *rz_pvector_index_ptr(chmod->args, 1);
mu_assert_notnull(arg1, "func \"chmod\" has 2nd argument");
mu_assert_streq(arg1->name, "mode", "has \"mode\" argument");
mu_assert_true(rz_type_atomic_str_eq(typedb, chmod->ret, "int"), "chmod() returns \"int\"");
rz_serialize_result_info_free(res);
rz_core_free(core);
mu_end;
}
int all_tests() {
mu_run_test(test_migrate_v1_v2_noreturn);
mu_run_test(test_migrate_v1_v2_noreturn_empty);
mu_run_test(test_migrate_v2_v3);
mu_run_test(test_load_v1_noreturn);
mu_run_test(test_load_v1_noreturn_empty);
mu_run_test(test_load_v2_typelink);
mu_run_test(test_load_v2_callables);
return tests_passed != tests_run;
}
mu_main(all_tests)
Reference in a new issue View git blame Copy permalink