libabigail/tests/test-abicompat.cc
Dodji Seketeli 080b88c9a1 Implement a [suppress_file] suppression directive
abidiff, abipkgdiff and abicompat now recognize a [suppress_file]
directive in suppression specifications.  That directive instructs the
tool to avoid loading some binaries altogether.

This is the first directive that won't act on the result of the
comparison of two binaries.  It actually acts earlier and prevents the
tool from loading some binaries altogether.

The directive looks like:

    [suppress_file]
      # Don't load any library named lib_private*.so
      file_name_regexp = lib_private.*\\.so

This prevents the tool from loading (and thus comparing) any library
which name matches the pattern "lib_private*.so".

    [suppress_file]
      # Only load libraries name lib_public*.so
      file_name_not_regexp = lib_public.*\\.so

This instructs the tool to only load (and compare) files which name
match the pattern "lib_public*.so".

	* doc/manuals/libabigail-concepts.rst: Document the new
	'suppress_file' directive.
	* include/abg-suppression.h (file_suppression): Define new class.
	(file_suppression_sptr): Define new typedef.
	(is_file_suppression, file_is_suppressed): Declare new functions.
	* src/abg-suppression.cc ():
	(read_file_suppression, is_file_suppression, file_is_suppressed):
	Define new functions.
	(file_suppression::{file_suppression, suppresses_file,
	~file_suppression}): Define new member functions.
	* tools/abidiff.cc (main): If a suppression specification
	suppresses one of the input files, then do not perform the
	comparison.
	* tools/abipkgdiff.cc (compare): If a suppression specification
	suppresses a file that is to be compared, then do not perform the
	comparison.
	* tools/abicompat.cc (create_diff_context): New static function.
	(perform_compat_check_in_normal_mode)
	(perform_compat_check_in_weak_mode): Adjust to take a context in
	parameter.  Do not create a diff context here anymore, do not load
	suppression files here either.
	(main): Use the new create_diff_context to create a diff context
	and initialize it, including loading suppression specifications.
	If any suppression specification suppresses a file to load, then
	do not load perform any compatibility checking.  Adjust
	invocations of perform_compat_check_in_weak_mode and
	perform_compat_check_in_normal_mode to pass the diff context.
	* tests/data/test-diff-suppr/test0-type-suppr-3.suppr: New test
	input.
	* tests/data/test-diff-suppr/test0-type-suppr-4.suppr: Likewise.
	* tests/data/test-diff-suppr/test0-type-suppr-report-4.txt: Likewise.
	* tests/data/test-diff-suppr/test0-type-suppr-5.suppr: Likewise.
	* tests/data/test-diff-suppr/test0-type-suppr-report-5.txt:
	Likewise.
	* tests/data/test-diff-suppr/test0-type-suppr-6.suppr: Likewise.
	* tests/data/test-diff-suppr/test0-type-suppr-report-6.txt:
	Likewise.
	* tests/data/test-diff-suppr/test0-type-suppr-report-7.txt:
	Likewise.
	* tests/test-diff-suppr.cc (in_out_specs): Use the new test
	inputs.
	* tests/data/test-abicompat/test0-fn-changed-1.suppr: New test
	input.
	* tests/data/test-abicompat/test0-fn-changed-report-3.txt:
	Likewise.
	* tests/test-abicompat.cc (in_out_specs):: Use the new test
	inputs.
	* tests/data/Makefile.am: Add the new test material to source
	distribution.

Signed-off-by: Dodji Seketeli <dodji@redhat.com>
2016-05-08 12:39:26 +02:00

281 lines
9.5 KiB
C++

// -*- Mode: C++ -*-
//
// Copyright (C) 2014-2016 Red Hat, Inc.
//
// This file is part of the GNU Application Binary Interface Generic
// Analysis and Instrumentation Library (libabigail). This library is
// free software; you can redistribute it and/or modify it under the
// terms of the GNU Lesser General Public License as published by the
// Free Software Foundation; either version 3, or (at your option) any
// later version.
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Lesser Public License for more details.
// You should have received a copy of the GNU Lesser General Public
// License along with this program; see the file COPYING-LGPLV3. If
// not, see <http://www.gnu.org/licenses/>.
// Author: Dodji Seketeli
/// @file
///
/// Given a program P that links against a library L of version V
/// denoted L(V), this program checks if P is still ABI compatible
/// with a subsequent version of L denoted L(V+N), N being a positive
/// integer. The result of the check is a report that is compared
/// against a reference report. This program actually performs these
/// checks for a variety of tuple {P, L(V), L(V+N)}
///
/// The set of input files and reference reports to consider should be
/// present in the source distribution.
#include <cstring>
#include <string>
#include <fstream>
#include <iostream>
#include <cstdlib>
#include "abg-tools-utils.h"
#include "test-utils.h"
using std::string;
using std::cerr;
struct InOutSpec
{
const char* in_app_path;
const char* in_lib1_path;
const char* in_lib2_path;
const char* suppressions;
const char* options;
const char* in_report_path;
const char* out_report_path;
};
InOutSpec in_out_specs[] =
{
{
"data/test-abicompat/test0-fn-changed-app",
"data/test-abicompat/libtest0-fn-changed-libapp-v0.so",
"data/test-abicompat/libtest0-fn-changed-libapp-v1.so",
"",
"--show-base-names --no-show-locs --no-redundant",
"data/test-abicompat/test0-fn-changed-report-0.txt",
"output/test-abicompat/test0-fn-changed-report-0.txt",
},
{
"data/test-abicompat/test0-fn-changed-app",
"data/test-abicompat/libtest0-fn-changed-libapp-v0.so",
"data/test-abicompat/libtest0-fn-changed-libapp-v1.so",
"data/test-abicompat/test0-fn-changed-0.suppr",
"--show-base-names --no-show-locs --no-redundant",
"data/test-abicompat/test0-fn-changed-report-1.txt",
"output/test-abicompat/test0-fn-changed-report-1.txt",
},
{ // Previous test, but emitting loc info.
"data/test-abicompat/test0-fn-changed-app",
"data/test-abicompat/libtest0-fn-changed-libapp-v0.so",
"data/test-abicompat/libtest0-fn-changed-libapp-v1.so",
"",
"--show-base-names --no-redundant",
"data/test-abicompat/test0-fn-changed-report-2.txt",
"output/test-abicompat/test0-fn-changed-report-2.txt",
},
{
"data/test-abicompat/test0-fn-changed-app",
"data/test-abicompat/libtest0-fn-changed-libapp-v0.so",
"data/test-abicompat/libtest0-fn-changed-libapp-v1.so",
"data/test-abicompat/test0-fn-changed-1.suppr",
"--show-base-names --no-show-locs --no-redundant",
"data/test-abicompat/test0-fn-changed-report-3.txt",
"output/test-abicompat/test0-fn-changed-report-3.txt",
},
{
"data/test-abicompat/test1-fn-removed-app",
"data/test-abicompat/libtest1-fn-removed-v0.so",
"data/test-abicompat/libtest1-fn-removed-v1.so",
"",
"--show-base-names --no-show-locs --no-redundant",
"data/test-abicompat/test1-fn-removed-report-0.txt",
"output/test-abicompat/test1-fn-removed-report-0.txt",
},
{
"data/test-abicompat/test2-var-removed-app",
"data/test-abicompat/libtest2-var-removed-v0.so",
"data/test-abicompat/libtest2-var-removed-v1.so",
"",
"--show-base-names --no-show-locs --no-redundant",
"data/test-abicompat/test2-var-removed-report-0.txt",
"output/test-abicompat/test2-var-removed-report-0.txt",
},
{
"data/test-abicompat/test3-fn-removed-app",
"data/test-abicompat/libtest3-fn-removed-v0.so",
"data/test-abicompat/libtest3-fn-removed-v1.so",
"",
"--show-base-names --no-show-locs --no-redundant",
"data/test-abicompat/test3-fn-removed-report-0.txt",
"output/test-abicompat/test3-fn-removed-report-0.txt",
},
{
"data/test-abicompat/test4-soname-changed-app",
"data/test-abicompat/libtest4-soname-changed-v0.so",
"data/test-abicompat/libtest4-soname-changed-v1.so",
"",
"--show-base-names --no-show-locs --no-redundant",
"data/test-abicompat/test4-soname-changed-report-0.txt",
"output/test-abicompat/test4-soname-changed-report-0.txt",
},
{
"data/test-abicompat/test5-fn-changed-app",
"data/test-abicompat/libtest5-fn-changed-libapp-v1.so",
"",
"",
"--show-base-names --no-show-locs --weak-mode",
"data/test-abicompat/test5-fn-changed-report-0.txt",
"output/test-abicompat/test5-fn-changed-report-0.txt",
},
{ // Previous test, but emitting loc info.
"data/test-abicompat/test5-fn-changed-app",
"data/test-abicompat/libtest5-fn-changed-libapp-v1.so",
"",
"",
"--show-base-names --weak-mode",
"data/test-abicompat/test5-fn-changed-report-1.txt",
"output/test-abicompat/test5-fn-changed-report-1.txt",
},
{
"data/test-abicompat/test6-var-changed-app",
"data/test-abicompat/libtest6-var-changed-libapp-v1.so",
"",
"",
"--show-base-names --no-show-locs --weak-mode",
"data/test-abicompat/test6-var-changed-report-0.txt",
"output/test-abicompat/test6-var-changed-report-0.txt",
},
{ // Previous test, but emitting loc info.
"data/test-abicompat/test6-var-changed-app",
"data/test-abicompat/libtest6-var-changed-libapp-v1.so",
"",
"",
"--show-base-names --weak-mode",
"data/test-abicompat/test6-var-changed-report-1.txt",
"output/test-abicompat/test6-var-changed-report-1.txt",
},
{
"data/test-abicompat/test7-fn-changed-app",
"data/test-abicompat/libtest7-fn-changed-libapp-v0.so",
"data/test-abicompat/libtest7-fn-changed-libapp-v1.so",
"",
"--show-base-names --no-show-locs --no-redundant",
"data/test-abicompat/test7-fn-changed-report-0.txt",
"output/test-abicompat/test7-fn-changed-report-0.txt",
},
{
"data/test-abicompat/test7-fn-changed-app",
"data/test-abicompat/libtest7-fn-changed-libapp-v1.so",
"",
"",
"--show-base-names --no-show-locs --weak-mode",
"data/test-abicompat/test7-fn-changed-report-1.txt",
"output/test-abicompat/test7-fn-changed-report-1.txt",
},
{ // Previous test, but emitting loc info.
"data/test-abicompat/test7-fn-changed-app",
"data/test-abicompat/libtest7-fn-changed-libapp-v1.so",
"",
"",
"--show-base-names --weak-mode",
"data/test-abicompat/test7-fn-changed-report-2.txt",
"output/test-abicompat/test7-fn-changed-report-2.txt",
},
{
"data/test-abicompat/test8-fn-changed-app",
"data/test-abicompat/libtest8-fn-changed-libapp-v1.so",
"",
"",
"--show-base-names --weak-mode",
"data/test-abicompat/test8-fn-changed-report-0.txt",
"output/test-abicompat/test8-fn-changed-report-0.txt",
},
{
"data/test-abicompat/test9-fn-changed-app",
"data/test-abicompat/libtest9-fn-changed-v1.so ",
"",
"",
"--show-base-names --weak-mode",
"data/test-abicompat/test9-fn-changed-report-0.txt",
"output/test-abicompat/test9-fn-changed-report-0.txt",
},
// This entry must be the last one.
{0, 0, 0, 0, 0, 0, 0}
};
int
main()
{
using abigail::tests::get_src_dir;
using abigail::tests::get_build_dir;
using abigail::tools_utils::ensure_parent_dir_created;
using abigail::tools_utils::abidiff_status;
bool is_ok = true;
string in_app_path, in_lib1_path, in_lib2_path, suppression_path,
abicompat_options, ref_report_path, out_report_path, abicompat, cmd;
for (InOutSpec* s = in_out_specs; s->in_app_path; ++s)
{
in_app_path = string(get_src_dir()) + "/tests/" + s->in_app_path;
in_lib1_path = string(get_src_dir()) + "/tests/" + s->in_lib1_path;
if (s->in_lib2_path && strcmp(s->in_lib2_path, ""))
in_lib2_path = string(get_src_dir()) + "/tests/" + s->in_lib2_path;
else
in_lib2_path.clear();
if (s->suppressions == 0 || !strcmp(s->suppressions, ""))
suppression_path.clear();
else
suppression_path = string(get_src_dir()) + "/tests/" + s->suppressions;
abicompat_options = s->options;
ref_report_path = string(get_src_dir()) + "/tests/" + s->in_report_path;
out_report_path =
string(get_build_dir()) + "/tests/" + s->out_report_path;
if (!ensure_parent_dir_created(out_report_path))
{
cerr << "could not create parent directory for "
<< out_report_path;
is_ok = false;
continue;
}
abicompat = string(get_build_dir()) + "/tools/abicompat";
if (!suppression_path.empty())
abicompat += " --suppressions " + suppression_path;
abicompat += " " + abicompat_options;
cmd = abicompat + " " + in_app_path + " " + in_lib1_path;
if (!in_lib2_path.empty())
cmd += string(" ") + in_lib2_path;
cmd += " > " + out_report_path;
bool abicompat_ok = true;
abidiff_status status = static_cast<abidiff_status>(system(cmd.c_str()));
if (abigail::tools_utils::abidiff_status_has_error(status))
abicompat_ok = false;
if (abicompat_ok)
{
cmd = "diff -u " + ref_report_path + " " + out_report_path;
if (system(cmd.c_str()))
is_ok = false;
}
else
is_ok = false;
}
return !is_ok;
}