Ubuntu 上的 Boost 单元测试动态链接

Boost unit test dynamic linking on Ubuntu

我正在尝试使用 Boost 的单元测试框架构建单元测试。我想使用 Boost 提供的自动生成的测试模块动态地 link 测试套件库。这是我一直在使用的基本结构:

test_main.cpp:

#define BOOST_TEST_DYN_LINK
#define BOOST_TEST_MAIN

#include <boost/test/unit_test.hpp>

lib_case.cpp:

#define BOOST_TEST_DYN_LINK
#include <boost/test/unit_test.hpp>


BOOST_AUTO_TEST_SUITE( test_lib )

BOOST_AUTO_TEST_CASE( test_lib_case ) {
    BOOST_ASSERT(true);
}
BOOST_AUTO_TEST_SUITE_END()

生成文件:

    all: unittest unittest2 unittest3

    lib_case.o: lib_case.cpp
        g++ -g -c -Wall -fPIC lib_case.cpp -o lib_case.o

    libcase.so: lib_case.o
        g++ -shared -Wl,-soname,libcase.so -o libcase.so lib_case.o

    unittest: libcase.so
        g++ -o unittest test_main.cpp -L. -lcase -lboost_unit_test_framework

    unittest2: test_main.cpp lib_case.cpp
        g++ -o unittest2 test_main.cpp lib_case.cpp -lboost_unit_test_framework

    unittest3: lib_case.o
        g++ -o unittest3 test_main.cpp lib_case.o -lboost_unit_test_framework

在 Ubuntu 14.04 上测试,所有可执行文件编译并且 link 没有错误。

'unittest' 无法执行 'test_lib' 套件,声称设置失败,但 'unittest2' 和 'unittest3' 成功:

$./unittest
Test setup error: test tree is empty
$./unittest2
Running 1 test case...
*** No errors detected
$./unittest3
Running 1 test case...
*** No errors detected

现在是头疼的问题:所有单元测试* 运行 Fedora 20 上的测试套件。

在查看 'unittest' 的依赖项列表时,我确实看到 'libcase.so' 未在 Ubuntu 版本中列出,但在 Fedora 20 版本中。我尝试过重新排序依赖项、使用 SO 的绝对路径以及更改 Boost 版本(1.54 和 1.55)。没有任何效果。

有什么想法可以阻止 'libcase.so' 在 Ubuntu 14.04 而不是 Fedora 20 上被 link 编辑?我是否缺少一些神奇的 compiler/linker 标志?

更新:

Sehe 的评论和回答有助于进一步缩小问题范围。如果我正确理解 Boost 的动态 linked UTF 实现(至少从 1.54/55 开始),那么该框架提供了一个测试用例管理器单例。每个测试用例都会在构建时自动向管理器注册。

我认为问题在于,无论出于何种原因,link 在 Ubuntu 'optimizes out' [=67] 期间用于管理器单例实例的静态全局变量=] 将库转换为二进制文件。实际上,尽管共享相同的全局静态变量,但它不会 link 这两个单例实例。它将它们视为两个独立的实例。

我按照 Multiple instances of singleton across shared libraries on Linux 中描述的步骤检查库和二进制文件。与他们的情况不同,-rdynamic 选项不能解决我的问题。

我做了更多测试,发现这很有趣。如果您预加载 libcase.so 对象,则单元测试适用于 Ubuntu。即使 libcase.so 没有出现在它的 ldd 列表中。我觉得这是意料之中的,因为当单元测试 运行 时,经理的单例是 'preloaded',它会 link。

$ LD_PRELOAD=/absolute/path/to/libcase.so ./unittest
Running 1 test case ...

仍然不知道为什么 Ubuntu 不想像 expected/intended 那样 link,而 Fedora 却这样做。阅读 this tutorial(特别是 'Comparison to the Microsoft DLL' 部分)让我觉得 Ubuntu 遵循 Windows linking 模式。

问题是 lib_case.o 被优化掉了,因为没有对那里包含的任何内容的引用。

如果所有引用都从测试用例定义引用单元测试框架(用于自注册)但 none 返回,编译并链接测试主轴到 "unused" 库。

我可以在我的系统上重现它 (Ubuntu 14)。这是一个简单的 hack,展示了如何通过强制引用(在本例中为名为 force_reference_this_object_file.

的全局变量)来修复它

注释

  • 当然你会通常在头文件中声明全局
  • 您会发现您需要部署 libcase.so 或使用 LD_LIBRARY_PATH 将 ./ 包含在库路径中

lib_case.cpp

#define BOOST_TEST_DYN_LINK
#include <boost/test/unit_test.hpp>

int force_reference_this_object_file = 42;

BOOST_AUTO_TEST_SUITE( test_lib )

BOOST_AUTO_TEST_CASE( test_lib_case ) {
    BOOST_ASSERT(true);
}
BOOST_AUTO_TEST_SUITE_END()

test_main.cpp

#define BOOST_TEST_DYN_LINK
#define BOOST_TEST_MAIN

#include <boost/test/unit_test.hpp>

extern int force_reference_this_object_file;

namespace {
    struct Local
    {
        int& ref_;
        Local() : ref_(force_reference_this_object_file) {}
    };

    static Local hack_;
}

生成文件

all: unittest unittest3

CPPFLAGS=-Wall -fPIC
LDFLAGS+=-L ~/WORK/pocpp/3rdparty/boost_1_58_0/stage/lib/

%.o: %.cpp
    g++ -c $(CPPFLAGS) $^ -o $@

libcase.so: lib_case.o
    g++ $(CPPFLAGS) -shared -Wl,-soname,$@ -o $@ $^

unittest: test_main.o | libcase.so
    #g++ $(CPPFLAGS) -o $@ $< $(LDFLAGS) -L. -lcase -lboost_unit_test_framework
    g++ $(CPPFLAGS) -o $@ $< $(LDFLAGS) ./libcase.so -lboost_unit_test_framework

unittest3: test_main.o lib_case.o
    g++ $(CPPFLAGS) -o $@ $^ $(LDFLAGS) -lboost_unit_test_framework

知道了!

Ubuntu 似乎默认使用 --as-needed 链接器选项,而 Fedora 可能不会。关闭它会将 libcase.so 库添加到单元测试所需的列表中。部署库(或使用 LD_LIBRARY_PATH)后,单元测试现在可以工作了。

unittest: libcase.so
        g++ -o unittest test_main.cpp -Wl,--no-as-needed -L. -lcase -lboost_unit_test_framework

认为这很简单...