Automated registration of Unit test using boost test

[Sidsky]

This is first step in #1780 to update the test-suite to use automated registration. The toplevelfixture.hppis a fixture that fills in for QUANTLIB_TEST_CASE macro which is to initialise and restore settings after each test case.

The QuantLibGlobalFixture is used for a one-time setup and teardown (start/stop timer, read command line arguments, etc)

The struct if_speed is used as a predicate in precondition for selected test cases where the test cases are run based on the speed of execution.

I'm still researching on how to migrate quantlibbenchmark.cpp. Please suggest if you have any ideas!

[boring-cyborg]

Thanks for opening this pull request! It might take a while before we look at it, so don't worry if there seems to be no feedback. We'll get to it.

[CLAassistant]

All committers have signed the CLA.

[lballabio]

@klausspanderen — maybe you can advise about the benchmark?

[klausspanderen]

Hi

I think in this case we need to declare the benchmark test cases in quantlibbenchmark.cpp like

namespace QuantLibTest {
    namespace AmericanOptionTest {
        struct testFdAmericanGreeks: public BOOST_AUTO_TEST_CASE_FIXTURE { void test_method(); };
    }
}

and change the registration towards

    Benchmark("AmericanOption::FdAmericanGreeks", std::bind(&QuantLibTest::AmericanOptionTest::testFdAmericanGreeks::test_method, QuantLibTest::AmericanOptionTest::testFdAmericanGreeks()), 518.31),

and replace the typedef fct_ptr by std::function<void(void)>

[Sidsky]

I get a function undefined error in linux build. Not sure if declaring test_method() as an empty function - test_method(){}, is the correct way to resolve the issue. It does pass all the checks but fails for cmake-with-options with error C2011: 'QuantLibTest::AmericanOptionTest::testFdAmericanGreeks': 'struct' type redefinition

[Sidsky]

Hi @klausspanderen, I have updated the code with your suggested changes, however, the code fails to build on linux because of unresolved/undefined/redefinition issues. I think the reason why this happens is because the macro in americanoption.cpp-

BOOST_AUTO_TEST_CASE(testFdAmericanGreeks) {
    ...
}

replaces the code with-

struct testFdAmericanGreeks : public BOOST_AUTO_TEST_CASE_FIXTURE {
    void test_method();
}; 

.
.
.
void testFdAmericanGreeks::test_method() {
    ...
}

Since it is already defined and declared once in the americanoption.cpp file, doing it again in quantlibbenchmark.cpp causes redefinition.

If I am not mistaken, the bind function is used to bind the testFdAmericanGreeks() in the americanoption.cpp file, without defining the test code again. I'm not sure whether test_method() in quantlibbenchmark.cpp requires to add the test code again?

One possible reason for the unresolved symbol error could be that the americanoption.hpp is no longer available.

Please advise.

[klausspanderen]

I've added the PR#5 for your repo (from my branch test_reg). Important are just the changes to the test-suite folder. Maybe the compiled americanoption.cpp file was missing in the linker step? Please let me know if it doesn't work for you.

[Sidsky]

Thanks so much! @klausspanderen

[Sidsky]

Hi @lballabio @klausspanderen, please let me know if I'm moving in the right direction. We can keep this PR active, I'll keep adding more commits.

[lballabio]

Hi—yes, let's continue in this direction. Thanks!

[Sidsky]

Thanks

I'm puzzled, but I'd probably just add

set_source_files_properties(quantlibbenchmark.cpp PROPERTIES SKIP_UNITY_BUILD_INCLUSION true)

and have that file compiled on its own.

Thanks. I have added a similar fix in Makefile.am for linux build.

[lballabio]

Don't roll back these changes; but since there are still lots of files to modify, in general I'd keep helper functions closer to the tests that use them. Incidentally, this would also reduce the diffs.

[Sidsky]

Alright, I'll try to keep them as close as possible.

You will also find that in some files I have combined segregated functions belonging to same namespace into a single namespace at the top. The reason for that is that when BOOST_FIXTURE_TEST_SUITE and BOOST_AUTO_TEST_SUITE is declared, it creates a new namespace. If a namespace is declared before the fixture declaration- say namespace a, that would act as a top-level namespace, however, if the same namespace is used to add more function in it between test cases, that declares a new namespace which is FixtureName::SuiteName::a. To avoid conflicts and namespace errors I choose to restructure them and combine them into one before the fixture declaration.

[lballabio]

Oh, I see. In that case, you're right, do move them at the top.

[lballabio]

So, should we merge what we have so far and continue in another PR? Or do you want to continue here?

[Sidsky]

yes, I think we can start merging. I'll finish migrating the remaining files in the next PR

[lballabio]

Ok, thanks. Later today I'll push a further fix to the check_test_times script and then I'll merge the PR.

[boring-cyborg]

Congratulations on your first merged pull request!