libabigail/tests/test-abidiff-exit.cc
tangmeng eea4e92b2d Standardize and improve the output of several tests
This patch updates several test harnesses to make their output show
the command line of the failing tests, a brief informative summary
about the number of unit tests executed, failed and executed with
success.

These tests now used the
abigail::tests::emit_test_{summary,status_and_update_counters}
functions provided in tests/test-utils.cc.

	* tests/test-abidiff-exit.cc (main): Use
	abigail::tests::emit_test_{summary, status_and_update_counters}
	functions to ameliorate and standardize test output.
	* tests/test-alt-dwarf-file.cc (main): Likewise.
	* tests/test-annotate.cc (main): Likewise.
	* tests/test-diff-dwarf-abixml.cc (main): Likewise.
	* tests/test-ini.cc (main): Likewise.
	* tests/test-lookup-syms.cc (main): Likewise.

Signed-off-by: tangmeng <tangmeng@uniontech.com>
Signed-off-by: Dodji Seketeli <dodji@redhat.com>
2021-11-17 12:44:16 +01:00

556 lines
17 KiB
C++

// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
// -*- Mode: C++ -*-
//
// Copyright (C) 2016-2020 Red Hat, Inc.
//
// Author: Dodji Seketeli
/// @file
///
/// This program runs abidiff between input files and checks that
/// the exit code of the abidiff is the one we expect.
///
/// The set of input files and reference reports to consider should be
/// present in the source distribution.
/// This is an aggregate that specifies where a test shall get its
/// input from and where it shall write its ouput to.
#include <sys/wait.h>
#include <cstring>
#include <string>
#include <vector>
#include <fstream>
#include <iostream>
#include <cstdlib>
#include "abg-tools-utils.h"
#include "test-utils.h"
using abigail::tools_utils::abidiff_status;
using abigail::tests::emit_test_status_and_update_counters;
using abigail::tests::emit_test_summary;
struct InOutSpec
{
const char* in_elfv0_path;
const char* in_elfv1_path;
const char* in_suppr_path;
const char* in_elfv0_headers_dirs;
const char* in_elfv1_headers_dirs;
const char* abidiff_options;
abidiff_status status;
const char* in_report_path;
const char* out_report_path;
};// end struct InOutSpec;
InOutSpec in_out_specs[] =
{
{
"data/test-abidiff-exit/test1-voffset-change-v0.o",
"data/test-abidiff-exit/test1-voffset-change-v1.o",
"",
"",
"",
"--no-default-suppression --no-show-locs",
abigail::tools_utils::ABIDIFF_ABI_CHANGE
| abigail::tools_utils::ABIDIFF_ABI_INCOMPATIBLE_CHANGE,
"data/test-abidiff-exit/test1-voffset-change-report0.txt",
"output/test-abidiff-exit/test1-voffset-change-report0.txt"
},
{
"data/test-abidiff-exit/test1-voffset-change-v0.o",
"data/test-abidiff-exit/test1-voffset-change-v1.o",
"data/test-abidiff-exit/test1-voffset-change.abignore",
"",
"",
"--no-default-suppression --no-show-locs",
abigail::tools_utils::ABIDIFF_OK,
"data/test-abidiff-exit/test1-voffset-change-report1.txt",
"output/test-abidiff-exit/test1-voffset-change-report1.txt"
},
{
"data/test-abidiff-exit/test2-filtered-removed-fns-v0.o",
"data/test-abidiff-exit/test2-filtered-removed-fns-v1.o",
"",
"",
"",
"--no-default-suppression --no-show-locs",
abigail::tools_utils::ABIDIFF_ABI_CHANGE
| abigail::tools_utils::ABIDIFF_ABI_INCOMPATIBLE_CHANGE,
"data/test-abidiff-exit/test2-filtered-removed-fns-report0.txt",
"output/test-abidiff-exit/test2-filtered-removed-fns-report0.txt"
},
{
"data/test-abidiff-exit/test2-filtered-removed-fns-v0.o",
"data/test-abidiff-exit/test2-filtered-removed-fns-v1.o",
"data/test-abidiff-exit/test2-filtered-removed-fns.abignore",
"",
"",
"--no-default-suppression --no-show-locs",
abigail::tools_utils::ABIDIFF_OK,
"data/test-abidiff-exit/test2-filtered-removed-fns-report1.txt",
"output/test-abidiff-exit/test2-filtered-removed-fns-report1.txt"
},
{
"data/test-abidiff-exit/test-loc-v0.bi",
"data/test-abidiff-exit/test-loc-v1.bi",
"",
"",
"",
"",
abigail::tools_utils::ABIDIFF_ABI_CHANGE,
"data/test-abidiff-exit/test-loc-with-locs-report.txt",
"output/test-abidiff-exit/test-loc-with-locs-report.txt"
},
{
"data/test-abidiff-exit/test-loc-v0.bi",
"data/test-abidiff-exit/test-loc-v1.bi",
"",
"",
"",
"--no-show-locs",
abigail::tools_utils::ABIDIFF_ABI_CHANGE,
"data/test-abidiff-exit/test-loc-without-locs-report.txt",
"output/test-abidiff-exit/test-loc-without-locs-report.txt"
},
{
"data/test-abidiff-exit/test-no-stray-comma-v0.o",
"data/test-abidiff-exit/test-no-stray-comma-v1.o",
"",
"",
"",
"--leaf-changes-only",
abigail::tools_utils::ABIDIFF_ABI_CHANGE,
"data/test-abidiff-exit/test-no-stray-comma-report.txt",
"output/test-abidiff-exit/test-no-stray-comma-report.txt"
},
{
"data/test-abidiff-exit/test-leaf-stats-v0.o",
"data/test-abidiff-exit/test-leaf-stats-v1.o",
"",
"",
"",
"--no-show-locs --leaf-changes-only",
abigail::tools_utils::ABIDIFF_ABI_CHANGE,
"data/test-abidiff-exit/test-leaf-stats-report.txt",
"output/test-abidiff-exit/test-leaf-stats-report.txt"
},
{
"data/test-abidiff-exit/test-leaf-more-v0.o",
"data/test-abidiff-exit/test-leaf-more-v1.o",
"",
"",
"",
"--no-show-locs --leaf-changes-only",
abigail::tools_utils::ABIDIFF_ABI_CHANGE
| abigail::tools_utils::ABIDIFF_ABI_INCOMPATIBLE_CHANGE,
"data/test-abidiff-exit/test-leaf-more-report.txt",
"output/test-abidiff-exit/test-leaf-more-report.txt"
},
{
"data/test-abidiff-exit/test-leaf-fun-type-v0.o",
"data/test-abidiff-exit/test-leaf-fun-type-v1.o",
"",
"",
"",
"--no-show-locs --leaf-changes-only",
abigail::tools_utils::ABIDIFF_ABI_CHANGE,
"data/test-abidiff-exit/test-leaf-fun-type-report.txt",
"output/test-abidiff-exit/test-leaf-fun-type-report.txt"
},
{
"data/test-abidiff-exit/test-leaf-redundant-v0.o",
"data/test-abidiff-exit/test-leaf-redundant-v1.o",
"",
"",
"",
"--leaf-changes-only",
abigail::tools_utils::ABIDIFF_ABI_CHANGE,
"data/test-abidiff-exit/test-leaf-redundant-report.txt",
"output/test-abidiff-exit/test-leaf-redundant-report.txt"
},
{
"data/test-abidiff-exit/test-leaf-peeling-v0.o",
"data/test-abidiff-exit/test-leaf-peeling-v1.o",
"",
"",
"",
"--leaf-changes-only",
abigail::tools_utils::ABIDIFF_ABI_CHANGE,
"data/test-abidiff-exit/test-leaf-peeling-report.txt",
"output/test-abidiff-exit/test-leaf-peeling-report.txt"
},
{
"data/test-abidiff-exit/test-leaf-cxx-members-v0.o",
"data/test-abidiff-exit/test-leaf-cxx-members-v1.o",
"",
"",
"",
"--leaf-changes-only",
abigail::tools_utils::ABIDIFF_ABI_CHANGE
| abigail::tools_utils::ABIDIFF_ABI_INCOMPATIBLE_CHANGE,
"data/test-abidiff-exit/test-leaf-cxx-members-report.txt",
"output/test-abidiff-exit/test-leaf-cxx-members-report.txt"
},
{
"data/test-abidiff-exit/test-member-size-v0.o",
"data/test-abidiff-exit/test-member-size-v1.o",
"",
"",
"",
"",
abigail::tools_utils::ABIDIFF_ABI_CHANGE,
"data/test-abidiff-exit/test-member-size-report0.txt",
"output/test-abidiff-exit/test-member-size-report0.txt"
},
{
"data/test-abidiff-exit/test-member-size-v0.o",
"data/test-abidiff-exit/test-member-size-v1.o",
"",
"",
"",
"--leaf-changes-only",
abigail::tools_utils::ABIDIFF_ABI_CHANGE,
"data/test-abidiff-exit/test-member-size-report1.txt",
"output/test-abidiff-exit/test-member-size-report1.txt"
},
{
"data/test-abidiff-exit/test-decl-struct-v0.o",
"data/test-abidiff-exit/test-decl-struct-v1.o",
"",
"",
"",
"--harmless",
abigail::tools_utils::ABIDIFF_ABI_CHANGE,
"data/test-abidiff-exit/test-decl-struct-report.txt",
"output/test-abidiff-exit/test-decl-struct-report.txt"
},
{
"data/test-abidiff-exit/test-fun-param-v0.abi",
"data/test-abidiff-exit/test-fun-param-v1.abi",
"",
"",
"",
"",
abigail::tools_utils::ABIDIFF_ABI_CHANGE,
"data/test-abidiff-exit/test-fun-param-report.txt",
"output/test-abidiff-exit/test-fun-param-report.txt"
},
{
"data/test-abidiff-exit/test-decl-enum-v0.o",
"data/test-abidiff-exit/test-decl-enum-v1.o",
"",
"",
"",
"--harmless",
abigail::tools_utils::ABIDIFF_ABI_CHANGE,
"data/test-abidiff-exit/test-decl-enum-report.txt",
"output/test-abidiff-exit/test-decl-enum-report.txt"
},
{
"data/test-abidiff-exit/test-decl-enum-v0.o",
"data/test-abidiff-exit/test-decl-enum-v1.o",
"",
"",
"",
"",
abigail::tools_utils::ABIDIFF_OK,
"data/test-abidiff-exit/test-decl-enum-report-2.txt",
"output/test-abidiff-exit/test-decl-enum-report-2.txt"
},
{
"data/test-abidiff-exit/test-decl-enum-v0.o",
"data/test-abidiff-exit/test-decl-enum-v1.o",
"",
"",
"",
"--leaf-changes-only",
abigail::tools_utils::ABIDIFF_OK,
"data/test-abidiff-exit/test-decl-enum-report-3.txt",
"output/test-abidiff-exit/test-decl-enum-report-3.txt"
},
{
"data/test-abidiff-exit/test-net-change-v0.o",
"data/test-abidiff-exit/test-net-change-v1.o",
"",
"",
"",
"--no-default-suppression --no-show-locs",
abigail::tools_utils::ABIDIFF_ABI_CHANGE
| abigail::tools_utils::ABIDIFF_ABI_INCOMPATIBLE_CHANGE,
"data/test-abidiff-exit/test-net-change-report0.txt",
"output/test-abidiff-exit/test-net-change-report0.txt"
},
{
"data/test-abidiff-exit/test-net-change-v0.o",
"data/test-abidiff-exit/test-net-change-v1.o",
"data/test-abidiff-exit/test-net-change.abignore",
"",
"",
"--no-default-suppression --no-show-locs",
abigail::tools_utils::ABIDIFF_OK,
"data/test-abidiff-exit/test-net-change-report1.txt",
"output/test-abidiff-exit/test-net-change-report1.txt"
},
{
"data/test-abidiff-exit/test-net-change-v0.o",
"data/test-abidiff-exit/test-net-change-v1.o",
"",
"",
"",
"--no-default-suppression --no-show-locs --leaf-changes-only",
abigail::tools_utils::ABIDIFF_ABI_CHANGE
| abigail::tools_utils::ABIDIFF_ABI_INCOMPATIBLE_CHANGE,
"data/test-abidiff-exit/test-net-change-report2.txt",
"output/test-abidiff-exit/test-net-change-report2.txt"
},
{
"data/test-abidiff-exit/test-net-change-v0.o",
"data/test-abidiff-exit/test-net-change-v1.o",
"data/test-abidiff-exit/test-net-change.abignore",
"",
"",
"--no-default-suppression --no-show-locs --leaf-changes-only",
abigail::tools_utils::ABIDIFF_OK,
"data/test-abidiff-exit/test-net-change-report3.txt",
"output/test-abidiff-exit/test-net-change-report3.txt"
},
{
"data/test-abidiff-exit/test-headers-dirs/test-headers-dir-v0.o",
"data/test-abidiff-exit/test-headers-dirs/test-headers-dir-v1.o",
"",
"data/test-abidiff-exit/test-headers-dirs/headers-a",
"data/test-abidiff-exit/test-headers-dirs/headers-a",
"--no-default-suppression",
abigail::tools_utils::ABIDIFF_OK,
"data/test-abidiff-exit/test-headers-dirs/test-headers-dir-report-1.txt",
"output/test-abidiff-exit/test-headers-dirs/test-headers-dir-report-1.txt"
},
{
"data/test-abidiff-exit/test-headers-dirs/test-headers-dir-v0.o",
"data/test-abidiff-exit/test-headers-dirs/test-headers-dir-v1.o",
"",
"data/test-abidiff-exit/test-headers-dirs/headers-a, "
"data/test-abidiff-exit/test-headers-dirs/headers-b",
"data/test-abidiff-exit/test-headers-dirs/headers-a, "
"data/test-abidiff-exit/test-headers-dirs/headers-b",
"--no-default-suppression",
abigail::tools_utils::ABIDIFF_ABI_CHANGE,
"data/test-abidiff-exit/test-headers-dirs/test-headers-dir-report-2.txt",
"output/test-abidiff-exit/test-headers-dirs/test-headers-dir-report-2.txt"
},
{
"data/test-abidiff-exit/qualifier-typedef-array-v0.o",
"data/test-abidiff-exit/qualifier-typedef-array-v1.o",
"",
"",
"",
"",
abigail::tools_utils::ABIDIFF_OK,
"data/test-abidiff-exit/qualifier-typedef-array-report-0.txt",
"output/test-abidiff-exit/qualifier-typedef-array-report-0.txt"
},
{
"data/test-abidiff-exit/qualifier-typedef-array-v0.o",
"data/test-abidiff-exit/qualifier-typedef-array-v1.o",
"",
"",
"",
"--harmless",
abigail::tools_utils::ABIDIFF_ABI_CHANGE,
"data/test-abidiff-exit/qualifier-typedef-array-report-1.txt",
"output/test-abidiff-exit/qualifier-typedef-array-report-1.txt"
},
{
"data/test-abidiff-exit/qualifier-typedef-array-v0.o",
"data/test-abidiff-exit/qualifier-typedef-array-v1.o",
"",
"",
"",
"--leaf-changes-only",
abigail::tools_utils::ABIDIFF_OK,
"data/test-abidiff-exit/qualifier-typedef-array-report-2.txt",
"output/test-abidiff-exit/qualifier-typedef-array-report-2.txt"
},
{
"data/test-abidiff-exit/qualifier-typedef-array-v0.o",
"data/test-abidiff-exit/qualifier-typedef-array-v1.o",
"",
"",
"",
"--harmless --leaf-changes-only",
abigail::tools_utils::ABIDIFF_OK,
"data/test-abidiff-exit/qualifier-typedef-array-report-3.txt",
"output/test-abidiff-exit/qualifier-typedef-array-report-3.txt"
},
{
"data/test-abidiff-exit/test-non-leaf-array-v0.o",
"data/test-abidiff-exit/test-non-leaf-array-v1.o",
"",
"",
"",
"--leaf-changes-only",
abigail::tools_utils::ABIDIFF_ABI_CHANGE,
"data/test-abidiff-exit/test-non-leaf-array-report.txt",
"output/test-abidiff-exit/test-non-leaf-array-report.txt"
},
{
"data/test-abidiff-exit/test-crc-v0.abi",
"data/test-abidiff-exit/test-crc-v1.abi",
"",
"",
"",
"",
abigail::tools_utils::ABIDIFF_ABI_CHANGE,
"data/test-abidiff-exit/test-crc-report.txt",
"output/test-abidiff-exit/test-crc-report.txt"
},
{
"data/test-abidiff-exit/test-missing-alias.abi",
"data/test-abidiff-exit/test-missing-alias.abi",
"data/test-abidiff-exit/test-missing-alias.suppr",
"",
"",
"",
abigail::tools_utils::ABIDIFF_OK,
"data/test-abidiff-exit/test-missing-alias-report.txt",
"output/test-abidiff-exit/test-missing-alias-report.txt"
},
{
"data/test-abidiff-exit/test-PR28316-v0.o",
"data/test-abidiff-exit/test-PR28316-v1.o",
"",
"",
"",
"--no-default-suppression --harmless",
abigail::tools_utils::ABIDIFF_ABI_CHANGE,
"data/test-abidiff-exit/test-PR28316-report.txt",
"output/test-abidiff-exit/test-PR28316-report.txt"
},
{0, 0, 0 ,0, 0, 0, abigail::tools_utils::ABIDIFF_OK, 0, 0}
};
/// Prefix the strings in a vector of string.
///
/// @param strings the strings to prefix.
///
/// @param prefix the prefix to use.
static void
do_prefix_strings(std::vector<std::string> &strings,
const std::string& prefix)
{
for (std::vector<std::string>::size_type i = 0; i < strings.size(); ++i)
strings[i] = prefix + strings[i];
}
int
main()
{
using std::string;
using std::vector;
using std::cerr;
using abigail::tests::get_src_dir;
using abigail::tests::get_build_dir;
using abigail::tools_utils::ensure_parent_dir_created;
using abigail::tools_utils::split_string;
using abigail::tools_utils::abidiff_status;
unsigned int total_count = 0, passed_count = 0, failed_count = 0;
string in_elfv0_path, in_elfv1_path,
in_suppression_path, abidiff_options, abidiff, cmd, diff_cmd,
ref_diff_report_path, out_diff_report_path;
vector<string> in_elfv0_headers_dirs, in_elfv1_headers_dirs;
string source_dir_prefix = string(get_src_dir()) + "/tests/";
string build_dir_prefix = string(get_build_dir()) + "/tests/";
for (InOutSpec* s = in_out_specs; s->in_elfv0_path; ++s)
{
bool is_ok = true;
in_elfv0_path = source_dir_prefix + s->in_elfv0_path;
in_elfv1_path = source_dir_prefix + s->in_elfv1_path;
split_string(s->in_elfv0_headers_dirs, ",", in_elfv0_headers_dirs);
split_string(s->in_elfv1_headers_dirs, ",", in_elfv1_headers_dirs);
do_prefix_strings(in_elfv0_headers_dirs, source_dir_prefix);
do_prefix_strings(in_elfv1_headers_dirs, source_dir_prefix);
if (s->in_suppr_path && strcmp(s->in_suppr_path, ""))
in_suppression_path = source_dir_prefix + s->in_suppr_path;
else
in_suppression_path.clear();
abidiff_options = s->abidiff_options;
ref_diff_report_path = source_dir_prefix + s->in_report_path;
out_diff_report_path = build_dir_prefix + s->out_report_path;
if (!ensure_parent_dir_created(out_diff_report_path))
{
cerr << "could not create parent directory for "
<< out_diff_report_path;
is_ok = false;
continue;
}
abidiff = string(get_build_dir()) + "/tools/abidiff";
if (!abidiff_options.empty())
abidiff += " " + abidiff_options;
if (!in_elfv0_headers_dirs.empty())
for (vector<string>::const_iterator s = in_elfv0_headers_dirs.begin();
s != in_elfv0_headers_dirs.end();
++s)
abidiff += " --headers-dir1 " + *s;
if (!in_elfv1_headers_dirs.empty())
for (vector<string>::const_iterator s = in_elfv1_headers_dirs.begin();
s != in_elfv1_headers_dirs.end();
++s)
abidiff += " --headers-dir2 " + *s;
if (!in_suppression_path.empty())
abidiff += " --suppressions " + in_suppression_path;
cmd = abidiff + " " + in_elfv0_path + " " + in_elfv1_path;
cmd += " > " + out_diff_report_path;
bool abidiff_ok = true;
int code = system(cmd.c_str());
if (!WIFEXITED(code))
abidiff_ok = false;
else
{
abigail::tools_utils::abidiff_status status =
static_cast<abidiff_status>(WEXITSTATUS(code));
if (status != s->status)
{
cerr << "for command '"
<< cmd
<< "', expected abidiff status to be " << s->status
<< " but instead, got " << status << "\n";
abidiff_ok = false;
}
}
if (abidiff_ok)
{
diff_cmd = "diff -u " + ref_diff_report_path
+ " " + out_diff_report_path;
if (system(diff_cmd.c_str()))
is_ok = false;
}
else
is_ok = false;
emit_test_status_and_update_counters(is_ok,
cmd,
passed_count,
failed_count,
total_count);
}
emit_test_summary(total_count, passed_count, failed_count);
return failed_count;
}