mirror of
https://github.com/danog/ir.git
synced 2024-11-30 04:39:43 +01:00
Merge pull request #9 from weltling/ir_test_cxx
test: Switch from ir-test.php to a C++ test runner
This commit is contained in:
Dmitry Stogov
GitHub
commit
0d3a9f3eaa
19
.github/workflows/push.yml
vendored
19
.github/workflows/push.yml
vendored
@ -20,15 +20,14 @@ jobs:
|
||||
run: |
|
||||
apt update -y
|
||||
DEBIAN_FRONTEND=noninteractive apt install -y \
|
||||
gcc \
|
||||
gcc g++-12 \
|
||||
libcapstone-dev \
|
||||
libcapstone4 \
|
||||
make \
|
||||
php-cli
|
||||
make
|
||||
- name: make
|
||||
run: make TARGET=x86_64 all
|
||||
- name: test
|
||||
run: make TARGET=x86_64 test-ci
|
||||
run: make CXX=g++-12 TARGET=x86_64 test-ci
|
||||
Linux_i386:
|
||||
name: 'Linux i386'
|
||||
runs-on: ubuntu-22.04
|
||||
@ -41,11 +40,10 @@ jobs:
|
||||
dpkg --add-architecture i386
|
||||
apt update -y
|
||||
DEBIAN_FRONTEND=noninteractive apt install -y \
|
||||
gcc \
|
||||
gcc g++-12 \
|
||||
gcc-multilib \
|
||||
libc6:i386 \
|
||||
make \
|
||||
php-cli \
|
||||
wget
|
||||
- name: Build capstone
|
||||
run: |
|
||||
@ -60,7 +58,7 @@ jobs:
|
||||
- name: make
|
||||
run: make TARGET=x86 all
|
||||
- name: test
|
||||
run: make TARGET=x86 test-ci
|
||||
run: make CXX=g++-12 TARGET=x86 test-ci
|
||||
Linux_aarch64:
|
||||
name: 'Linux aarch64'
|
||||
runs-on: ubuntu-20.04
|
||||
@ -76,16 +74,15 @@ jobs:
|
||||
install: |
|
||||
apt update -y
|
||||
DEBIAN_FRONTEND=noninteractive apt install -y \
|
||||
gcc \
|
||||
gcc g++-12 \
|
||||
libc6 \
|
||||
libcapstone-dev \
|
||||
libcapstone4 \
|
||||
make \
|
||||
php-cli
|
||||
make
|
||||
run: |
|
||||
make CC=gcc TARGET=aarch64 all
|
||||
# FIXME: For some reason some of the object files are rebuilt
|
||||
make CC=gcc TARGET=aarch64 test-ci
|
||||
make CC=gcc CXX=g++-12 TARGET=aarch64 test-ci
|
||||
|
||||
Windows:
|
||||
strategy:
|
||||
|
||||
15
Makefile
15
Makefile
@ -6,6 +6,7 @@ BUILD_DIR = .
|
||||
SRC_DIR = .
|
||||
|
||||
CC = gcc
|
||||
CXX = g++
|
||||
BUILD_CC = gcc
|
||||
CFLAGS = -Wall -Wextra -Wno-unused-parameter
|
||||
LDFLAGS = -lm
|
||||
@ -83,20 +84,24 @@ $(BUILD_DIR)/ir_emit_$(DASM_ARCH).h: $(SRC_DIR)/ir_$(DASM_ARCH).dasc $(SRC_DIR)/
|
||||
$(OBJS_COMMON) $(OBJS_IR) $(OBJS_IR_TEST): $(BUILD_DIR)/$(notdir %.o): $(SRC_DIR)/$(notdir %.c)
|
||||
$(CC) $(CFLAGS) -I$(BUILD_DIR) -o $@ -c $<
|
||||
|
||||
test: $(BUILD_DIR)/ir
|
||||
$(BUILD_DIR)/ir-test: $(SRC_DIR)/ir-test.cxx
|
||||
$(CXX) -O3 -std=c++17 $(SRC_DIR)/ir-test.cxx -o $(BUILD_DIR)/ir-test
|
||||
|
||||
test: $(BUILD_DIR)/ir $(BUILD_DIR)/ir-test
|
||||
$(BUILD_DIR)/ir $(SRC_DIR)/test.ir --dump --save 2>$(BUILD_DIR)/test.log
|
||||
$(BUILD_DIR)/ir $(SRC_DIR)/test.ir --dot $(BUILD_DIR)/ir.dot
|
||||
dot -Tpdf $(BUILD_DIR)/ir.dot -o $(BUILD_DIR)/ir.pdf
|
||||
BUILD_DIR=$(BUILD_DIR) SRC_DIR=$(SRC_DIR) $(PHP) $(SRC_DIR)/ir-test.php
|
||||
BUILD_DIR=$(BUILD_DIR) SRC_DIR=$(SRC_DIR) $(BUILD_DIR)/ir-test
|
||||
|
||||
test-ci: $(BUILD_DIR)/ir
|
||||
BUILD_DIR=$(BUILD_DIR) SRC_DIR=$(SRC_DIR) $(PHP) $(SRC_DIR)/ir-test.php --show-diff
|
||||
test-ci: $(BUILD_DIR)/ir $(BUILD_DIR)/ir-test
|
||||
BUILD_DIR=$(BUILD_DIR) SRC_DIR=$(SRC_DIR) $(BUILD_DIR)/ir-test --show-diff
|
||||
|
||||
clean:
|
||||
rm -rf $(BUILD_DIR)/ir $(BUILD_DIR)/ir_test $(BUILD_DIR)/*.o \
|
||||
$(BUILD_DIR)/minilua $(BUILD_DIR)/ir_emit_$(DASM_ARCH).h \
|
||||
$(BUILD_DIR)/ir_fold_hash.h $(BUILD_DIR)/gen_ir_fold_hash \
|
||||
$(BUILD_DIR)/ir.dot $(BUILD_DIR)/ir.pdf $(BUILD_DIR)/test.log
|
||||
$(BUILD_DIR)/ir.dot $(BUILD_DIR)/ir.pdf $(BUILD_DIR)/test.log \
|
||||
$(BUILD_DIR)/ir-test
|
||||
find $(SRC_DIR)/tests -type f -name '*.diff' -delete
|
||||
find $(SRC_DIR)/tests -type f -name '*.out' -delete
|
||||
find $(SRC_DIR)/tests -type f -name '*.exp' -delete
|
||||
|
||||
331
ir-test.cxx
Normal file
331
ir-test.cxx
Normal file
@ -0,0 +1,331 @@
|
||||
/*
|
||||
* IR - Lightweight JIT Compilation Framework
|
||||
* (Test runner implementation)
|
||||
* Copyright (C) 2023 by IR project.
|
||||
* Authors: Dmitry Stogov <dmitry@php.net>, Anatol Belski <anbelski@linux.microsoft.com>
|
||||
*/
|
||||
|
||||
#include <string>
|
||||
#include <regex>
|
||||
#include <iostream>
|
||||
#include <fstream>
|
||||
#include <sstream>
|
||||
#include <filesystem>
|
||||
#include <array>
|
||||
#include <exception>
|
||||
#include <cstdlib>
|
||||
|
||||
#ifdef _WIN32
|
||||
# include <windows.h>
|
||||
# define popen _popen
|
||||
# define pclose _pclose
|
||||
# define PATH_SEP "\\"
|
||||
# define EXE_SUF ".exe"
|
||||
# define REGEX_FLAGS std::regex::extended
|
||||
# define DIFF_ARGS "--strip-trailing-cr"
|
||||
# define IR_ARGS "--no-abort-fault"
|
||||
#else
|
||||
# define PATH_SEP "/"
|
||||
# define EXE_SUF ""
|
||||
# define REGEX_FLAGS std::regex::ECMAScript | std::regex::multiline
|
||||
# define DIFF_ARGS ""
|
||||
# define IR_ARGS ""
|
||||
#endif
|
||||
|
||||
uint32_t skipped = 0;
|
||||
std::vector<std::string> bad_list;
|
||||
std::vector<std::tuple<std::string, std::string>> failed;
|
||||
std::vector<std::tuple<std::string, std::string, std::string>> xfailed_list;
|
||||
bool show_diff = false, colorize = true;
|
||||
std::string src_dir, build_dir, test_dir, ir_exe, ir_target;
|
||||
|
||||
namespace ir {
|
||||
decltype(auto) trim(std::string s) {
|
||||
const char* ws = " \t\n\r\f\v";
|
||||
s.erase(0, s.find_first_not_of(ws));
|
||||
s.erase(s.find_last_not_of(ws) + 1);
|
||||
return s;
|
||||
}
|
||||
|
||||
decltype(auto) exec(const std::string& cmd) {
|
||||
std::array<char, 256> buffer;
|
||||
std::string result;
|
||||
std::unique_ptr<FILE, decltype(&pclose)> pipe(popen(cmd.c_str(), "r"), pclose);
|
||||
if (!pipe) {
|
||||
throw std::runtime_error("popen() failed!");
|
||||
}
|
||||
while (fgets(buffer.data(), buffer.size(), pipe.get()) != nullptr) {
|
||||
result += buffer.data();
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
decltype(auto) get_dir_from_env(const char* name) {
|
||||
const char* _tmp = std::getenv(name);
|
||||
std::string ret = _tmp ? _tmp : ".";
|
||||
return ret;
|
||||
}
|
||||
|
||||
enum color { GREEN, YELLOW, RED };
|
||||
|
||||
decltype(auto) colorize(const std::string& s, enum color c) {
|
||||
if (::colorize)
|
||||
switch (c) {
|
||||
case GREEN:
|
||||
return "\x1b[1;32m" + s + "\x1b[0m";
|
||||
case YELLOW:
|
||||
return "\x1b[1;33m" + s + "\x1b[0m";
|
||||
case RED:
|
||||
return "\x1b[1;31m" + s + "\x1b[0m";
|
||||
}
|
||||
return "" + s;
|
||||
}
|
||||
|
||||
void init_console() {
|
||||
#ifdef _WIN32
|
||||
if (::colorize) {
|
||||
DWORD mode, new_mode = ENABLE_VIRTUAL_TERMINAL_PROCESSING | DISABLE_NEWLINE_AUTO_RETURN;
|
||||
HANDLE h = GetStdHandle(STD_OUTPUT_HANDLE);
|
||||
GetConsoleMode(h, &mode);
|
||||
SetConsoleMode(h, mode | new_mode);
|
||||
}
|
||||
#endif
|
||||
}
|
||||
|
||||
class broken_test_exception : public std::exception {} broken_test;
|
||||
|
||||
struct it_sect {
|
||||
std::size_t name_pos;
|
||||
std::string name;
|
||||
std::size_t content_pos;
|
||||
std::string content;
|
||||
};
|
||||
|
||||
struct test {
|
||||
// Section contents
|
||||
std::string name, code, expect, target, xfail, args;
|
||||
// Test file path and contents and output filenames
|
||||
std::string irt_file, irt_file_content, ir_file, out_file, exp_file, diff_file;
|
||||
test(const std::string& test_fl) : irt_file{test_fl} {
|
||||
std::ifstream f(test_fl);
|
||||
if (!f) throw "Couldn't read '" + test_fl + "'";
|
||||
std::ostringstream oss;
|
||||
oss << f.rdbuf();
|
||||
irt_file_content = oss.str();
|
||||
|
||||
auto make_fn = [&test_fl](const std::string& s) {
|
||||
return test_fl.substr(0, test_fl.length() - 4) + s;
|
||||
};
|
||||
ir_file = make_fn(".ir");
|
||||
out_file = make_fn(".out");
|
||||
exp_file = make_fn(".exp");
|
||||
diff_file = make_fn(".diff");
|
||||
|
||||
parse();
|
||||
}
|
||||
void parse() {
|
||||
std::regex sect_reg("^--[A-Z]+--$", REGEX_FLAGS);
|
||||
auto sect_begin = std::sregex_iterator(irt_file_content.begin(), irt_file_content.end(), sect_reg);
|
||||
auto sect_end = std::sregex_iterator();
|
||||
std::vector<it_sect> test_data;
|
||||
|
||||
// PASS 0: Find all the test sections
|
||||
auto found_sects = std::distance(sect_begin, sect_end);
|
||||
for (auto i = sect_begin; i != sect_end; i++) {
|
||||
it_sect iti;
|
||||
std::smatch m = *i;
|
||||
iti.name_pos = m.position();
|
||||
iti.name = m.str();
|
||||
test_data.push_back(std::move(iti));
|
||||
}
|
||||
// PASS 1: Read section contents
|
||||
auto it = test_data.begin();
|
||||
auto it_next = it;
|
||||
it_next++;
|
||||
for (; it != test_data.end(); it++) {
|
||||
it->content_pos = it->name_pos + it->name.length();
|
||||
|
||||
if (test_data.end() == it_next) {
|
||||
it->content = trim(irt_file_content.substr(it->content_pos, irt_file_content.length() - it->content_pos));
|
||||
} else {
|
||||
it->content = trim(irt_file_content.substr(it->content_pos, it_next->name_pos - it->content_pos));
|
||||
it_next++;
|
||||
}
|
||||
}
|
||||
|
||||
// PASS 2: Save necessary data into properties
|
||||
#define NO_SECT test_data.end()
|
||||
auto get_sect = [&test_data](std::string s) -> decltype(auto) {
|
||||
for (auto test_it = test_data.begin(); test_it != test_data.end(); test_it++)
|
||||
if (!test_it->name.compare(s)) return test_it;
|
||||
return NO_SECT;
|
||||
};
|
||||
auto test_sect = get_sect("--TEST--");
|
||||
auto code_sect = get_sect("--CODE--");
|
||||
auto exp_sect = get_sect("--EXPECT--");
|
||||
if (NO_SECT == test_sect || NO_SECT == code_sect || NO_SECT == exp_sect) {
|
||||
throw broken_test;
|
||||
}
|
||||
name = test_sect->content;
|
||||
code = code_sect->content;
|
||||
expect = exp_sect->content;
|
||||
auto args_sect = get_sect("--ARGS--");
|
||||
args = (NO_SECT == args_sect) ? "--save": args_sect->content;
|
||||
auto tgt_sect = get_sect("--TARGET--");
|
||||
if (NO_SECT != tgt_sect) target = tgt_sect->content;
|
||||
auto xfail_sect = get_sect("--XFAIL--");
|
||||
if (NO_SECT != xfail_sect) xfail = xfail_sect->content;
|
||||
}
|
||||
bool skip() {
|
||||
return target.length() > 0 && target.compare(::ir_target);
|
||||
}
|
||||
bool run() {
|
||||
std::remove(out_file.c_str());
|
||||
std::remove(exp_file.c_str());
|
||||
std::remove(diff_file.c_str());
|
||||
std::remove(ir_file.c_str());
|
||||
|
||||
std::ofstream in_os(ir_file);
|
||||
in_os << code;
|
||||
in_os.close();
|
||||
|
||||
auto test_cmd = ::ir_exe + " " + ir_file + " " + args + " " + IR_ARGS + " >" + out_file + " 2>&1";
|
||||
auto diff_cmd = std::string("diff") + " " + DIFF_ARGS + "-u " + exp_file + " " + out_file + " > " + diff_file + " 2>&1";
|
||||
|
||||
int ret_code = std::system(test_cmd.c_str()) >> 0x8;
|
||||
if (ret_code) {
|
||||
return false;
|
||||
}
|
||||
|
||||
std::stringstream out_buf;
|
||||
out_buf << std::ifstream(out_file).rdbuf();
|
||||
std::string out = trim(out_buf.str());
|
||||
out.erase(std::remove(out.begin(), out.end(), '\r'), out.end());
|
||||
|
||||
if (out.compare(expect)) {
|
||||
std::ofstream exp_os(exp_file);
|
||||
exp_os << (expect + "\n");
|
||||
exp_os.close();
|
||||
|
||||
// XXX move away from diff tool dependency
|
||||
ret_code = std::system(diff_cmd.c_str()) >> 0x8;
|
||||
if (0 != ret_code && 1 != ret_code) { // 1 stands for "there is a diff"
|
||||
std::cout << diff_cmd << std::endl;
|
||||
std::cout << ret_code << std::endl;
|
||||
throw "Couldn't compare output vs. expected result for '" + irt_file + "'";
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
};
|
||||
|
||||
void find_tests_in_dir(std::string& test_dir, std::vector<std::string>& irt_files) {
|
||||
for (const std::filesystem::directory_entry& ent :
|
||||
std::filesystem::recursive_directory_iterator(test_dir)) {
|
||||
std::string fl(ent.path().string());
|
||||
if (fl.length() < 4 || 0 != fl.compare(fl.length()-4, 4, ".irt")) continue;
|
||||
irt_files.push_back(fl);
|
||||
}
|
||||
std::sort(irt_files.begin(), irt_files.end(), [&](const std::string& a, const std::string& b) {
|
||||
return 1 <= b.compare(a);
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
int main(int argc, char **argv) {
|
||||
for (int i = 1; i < argc; i++) {
|
||||
// XXX use some cleaner arg parsing solution
|
||||
if (!std::string(argv[i]).compare("--show-diff")) {
|
||||
::show_diff = true;
|
||||
} else if (!std::string(argv[i]).compare("--no-color")) {
|
||||
::colorize = false;
|
||||
}
|
||||
}
|
||||
ir::init_console();
|
||||
|
||||
::build_dir = ir::get_dir_from_env("BUILD_DIR");
|
||||
::src_dir = ir::get_dir_from_env("SRC_DIR");
|
||||
::test_dir = ::src_dir + PATH_SEP + "tests";
|
||||
::ir_exe = ::build_dir + PATH_SEP + "ir" + EXE_SUF;
|
||||
::ir_target = ir::trim(ir::exec(::ir_exe + " --target"));
|
||||
std::vector<std::string> irt_files;
|
||||
|
||||
ir::find_tests_in_dir(::test_dir, irt_files);
|
||||
for (const std::string& test_fl : irt_files) {
|
||||
try {
|
||||
auto test = ir::test(test_fl);
|
||||
|
||||
size_t idx = &test_fl - &irt_files[0] + 1;
|
||||
std::string test_ln_0 = "TEST: " + std::to_string(idx) + PATH_SEP + std::to_string(irt_files.size()) + " " + test.name + "[" + test_fl + "]\r";
|
||||
std::cout << test_ln_0 << std::flush;
|
||||
|
||||
if (test.skip()) {
|
||||
std::cout << std::string(test_ln_0.length(), ' ');
|
||||
std::cout << "\r" << ir::colorize("SKIP", ir::YELLOW) << ": " << test.name << " [" << test_fl << "]\n";
|
||||
::skipped++;
|
||||
continue;
|
||||
}
|
||||
|
||||
auto ret = test.run();
|
||||
std::cout << std::string(test_ln_0.length(), ' ');
|
||||
|
||||
if (ret) {
|
||||
std::cout << "\r" << ir::colorize("PASS", ir::GREEN) << ": " << test.name << " [" << test_fl << "]\n";
|
||||
} else if (test.xfail.length() > 0) {
|
||||
std::cout << "\r" << ir::colorize("XFAIL", ir::RED) << ": " << test.name << " [" << test_fl << "] XFAIL REASON: " << test.xfail << "\n";
|
||||
::xfailed_list.push_back({test.name, test.irt_file, test.xfail});
|
||||
} else {
|
||||
std::cout << "\r" << ir::colorize("FAIL", ir::RED) << ": " << test.name << " [" << test_fl << "]\n";
|
||||
::failed.push_back({test.name, test.irt_file});
|
||||
if (::show_diff) {
|
||||
std::ifstream f(test.diff_file);
|
||||
if (!f) {
|
||||
throw "Couldn't read '" + test.diff_file + "'";
|
||||
}
|
||||
std::cout << f.rdbuf() << std::endl;
|
||||
f.close();
|
||||
}
|
||||
}
|
||||
} catch (ir::broken_test_exception& e) {
|
||||
std::cout << "\r" << ir::colorize("BROK", ir::RED) << ": [" << test_fl << "]\n";
|
||||
::bad_list.push_back(test_fl);
|
||||
} catch (std::string& s) {
|
||||
std::cout << "\r" << ir::colorize("ERROR", ir::RED) << ": " << s << '\n';
|
||||
} catch (std::exception& e) {
|
||||
std::cout << "\r" << ir::colorize("ERROR", ir::RED) << ": " << e.what() << '\n';
|
||||
}
|
||||
|
||||
// XXX parallelize
|
||||
}
|
||||
|
||||
// Produce the summary
|
||||
#define SEPARATOR() std::cout << std::string(32, '-') << std::endl
|
||||
#define WRAP_OUT(expr) SEPARATOR(); expr; SEPARATOR()
|
||||
WRAP_OUT(std::cout << "Test Summary" << std::endl);
|
||||
if (::bad_list.size() > 0) {
|
||||
std::cout << "Bad tests: " << ::bad_list.size() << std::endl;
|
||||
WRAP_OUT(for (const std::string& fname : ::bad_list) std::cout << fname << std::endl);
|
||||
}
|
||||
std::cout << "Total: " << irt_files.size() << std::endl;
|
||||
std::cout << "Passed: " << (irt_files.size() - ::failed.size() - ::skipped) << std::endl;
|
||||
std::cout << "Expected fail: " << ::xfailed_list.size() << std::endl;
|
||||
std::cout << "Failed: " << ::failed.size() << std::endl;
|
||||
std::cout << "Skipped: " << ::skipped << std::endl;
|
||||
if (::xfailed_list.size() > 0) {
|
||||
WRAP_OUT(std::cout << "EXPECTED FAILED TESTS" << std::endl);
|
||||
for (const auto& t : ::xfailed_list) {
|
||||
std::cout << std::get<0>(t) << " [" << std::get<1>(t) << "] XFAIL REASON: " << std::get<2>(t) << std::endl;
|
||||
}
|
||||
}
|
||||
if (::failed.size() > 0) {
|
||||
WRAP_OUT(std::cout << "FAILED TESTS" << std::endl);
|
||||
for (const auto& t : ::failed) {
|
||||
std::cout << std::get<0>(t) << " [" << std::get<1>(t) << "]" << std::endl;
|
||||
}
|
||||
}
|
||||
SEPARATOR();
|
||||
|
||||
return ::failed.size() > 0 ? 1 : 0;
|
||||
}
|
||||
@ -30,6 +30,10 @@ LDFLAGS=$(LDFLAGS) /DEBUG
|
||||
CC=cl.exe
|
||||
!endif
|
||||
|
||||
!if "$(CXX)" == ""
|
||||
CXX=cl.exe
|
||||
!endif
|
||||
|
||||
!if "$(LD)" == ""
|
||||
LD=link.exe
|
||||
!endif
|
||||
@ -108,12 +112,15 @@ $(VCPKG_CAPSTONE): $(VCPKG_DIR)\vcpkg.exe
|
||||
$(BUILD_DIR):
|
||||
md "$(BUILD_DIR)"
|
||||
|
||||
test: $(BUILD_DIR)\ir.exe
|
||||
$(BUILD_DIR)\ir-test.exe: $(SRC_DIR)/ir-test.cxx
|
||||
"$(CXX)" /std:c++17 $(SRC_DIR)\ir-test.cxx /Fe:$@
|
||||
|
||||
test: $(BUILD_DIR)\ir.exe $(BUILD_DIR)\ir-test.exe
|
||||
set PATH=$(VCPKG_DIR)\installed\$(VCPKG_TRIPLET)\bin:%%PATH%%
|
||||
$(BUILD_DIR)\ir.exe $(SRC_DIR)\test.ir --dump --save $(BUILD_DIR)\test.log
|
||||
set BUILD_DIR=$(BUILD_DIR)
|
||||
set SRC_DIR=$(SRC_DIR)
|
||||
$(PHP) $(SRC_DIR)\ir-test.php --no-color
|
||||
$(BUILD_DIR)\ir-test.exe
|
||||
|
||||
clean:
|
||||
del /f /q $(BUILD_DIR)\*.obj $(BUILD_DIR)\*.exe $(BUILD_DIR)\*.pdb $(BUILD_DIR)\*.ilk $(BUILD_DIR)\*.h
|
||||
|
||||
Loading…
Reference in New Issue
Block a user