Migrate from catch2v2 to catch2v3 (#692)

* migrate from catch2v2 to catch2v3 and implement VisorTest helper lib
* Replach benchmark with catch2 benchmark

Author: leoparente

conanfile.txt

@@ -1,6 +1,5 @@
 [requires]
-benchmark/1.8.3
-catch2/2.13.10
+catch2/3.4.0
 corrade/2020.06
 cpp-httplib/0.14.0
 docopt.cpp/0.6.3

libs/CMakeLists.txt

@@ -1,5 +1,6 @@
 message(STATUS "Custom Libraries")
 
+add_subdirectory(visor_test)
 add_subdirectory(visor_transaction)
 add_subdirectory(visor_tcp)
 add_subdirectory(visor_dns)

libs/visor_dns/CMakeLists.txt

@@ -24,4 +24,16 @@ target_link_libraries(VisorLibDns
         ${CONAN_LIBS_FMT}
         )
 
-add_subdirectory(tests)
+## TEST SUITE
+add_executable(unit-tests-visor-dns
+        tests/test_dns.cpp
+        tests/benchmark_dns.cpp)
+
+target_link_libraries(unit-tests-visor-dns
+        PRIVATE
+        Visor::Lib::Dns
+        ${CONAN_LIBS_CATCH2})
+
+add_test(NAME unit-tests-visor-dns
+        WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/libs/visor_dns
+        COMMAND unit-tests-visor-dns)

libs/visor_dns/dns.h

@@ -8,6 +8,7 @@
 #include "DnsResource.h"
 #include "DnsResourceData.h"
 #include <string>
+#include <string_view>
 #include <unordered_map>
 
 namespace visor::lib::dns {

libs/visor_dns/tests/CMakeLists.txt

@@ -1,8 +1,9 @@
 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+#include <catch2/benchmark/catch_benchmark.hpp>
+#include <catch2/catch_test_macros.hpp>
 
-#include "benchmark/benchmark.h"
 #include "dns.h"
 #ifdef __GNUC__
 #pragma GCC diagnostic push
@@ -21,66 +22,65 @@
 
 using namespace visor::lib::dns;
 
-static void BM_aggregateDomain(benchmark::State &state)
+void BM_aggregateDomain(const std::string &domain)
 {
     AggDomainResult result;
-    std::string domain{"biz.foo.bar.com"};
-    for (auto _ : state) {
-        result = aggregateDomain(domain);
-    }
-}
-BENCHMARK(BM_aggregateDomain);
-
-static void BM_aggregateDomainLong(benchmark::State &state)
-{
-    AggDomainResult result;
-    std::string domain{"long1.long2.long3.long4.long5.long6.long7.long8.biz.foo.bar.com"};
-    for (auto _ : state) {
-        result = aggregateDomain(domain);
-    }
+    result = aggregateDomain(domain);
 }
 
-BENCHMARK(BM_aggregateDomainLong);
-
-static void BM_pcapReadNoParse(benchmark::State &state)
+void BM_pcapReadNoParse()
 {
+    auto reader = pcpp::IFileReaderDevice::getReader("tests/dns_udp_tcp_random.pcap");
 
-    for (auto _ : state) {
-        auto reader = pcpp::IFileReaderDevice::getReader("fixtures/dns_udp_tcp_random.pcap");
-
-        if (!reader->open()) {
-            throw std::runtime_error("Cannot open pcap/pcapng file");
-        }
-
-        pcpp::RawPacket rawPacket;
-        while (reader->getNextPacket(rawPacket)) {
-        }
+    if (!reader->open()) {
+        throw std::runtime_error("Cannot open pcap/pcapng file");
+    }
 
-        reader->close();
-        delete reader;
+    pcpp::RawPacket rawPacket;
+    while (reader->getNextPacket(rawPacket)) {
     }
+
+    reader->close();
+    delete reader;
 }
-BENCHMARK(BM_pcapReadNoParse);
 
-static void BM_pcapReadParse1(benchmark::State &state)
+void BM_pcapReadParse()
 {
 
-    for (auto _ : state) {
-        auto reader = pcpp::IFileReaderDevice::getReader("fixtures/dns_udp_tcp_random.pcap");
-
-        if (!reader->open()) {
-            throw std::runtime_error("Cannot open pcap/pcapng file");
-        }
+    auto reader = pcpp::IFileReaderDevice::getReader("tests/dns_udp_tcp_random.pcap");
 
-        pcpp::RawPacket rawPacket;
-        while (reader->getNextPacket(rawPacket)) {
-            pcpp::Packet packet(&rawPacket, pcpp::OsiModelTransportLayer);
-        }
+    if (!reader->open()) {
+        throw std::runtime_error("Cannot open pcap/pcapng file");
+    }
 
-        reader->close();
-        delete reader;
+    pcpp::RawPacket rawPacket;
+    while (reader->getNextPacket(rawPacket)) {
+        pcpp::Packet packet(&rawPacket, pcpp::OsiModelTransportLayer);
     }
+
+    reader->close();
+    delete reader;
 }
-BENCHMARK(BM_pcapReadParse1);
 
-BENCHMARK_MAIN();
+TEST_CASE("DNS benchmark")
+{
+    BENCHMARK("Aggregate Domain")
+    {
+        return BM_aggregateDomain("biz.foo.bar.com");
+    };
+
+    BENCHMARK("Aggregate Domain Long")
+    {
+        return BM_aggregateDomain("long1.long2.long3.long4.long5.long6.long7.long8.biz.foo.bar.com");
+    };
+
+    BENCHMARK("Pcap Read No Parse")
+    {
+        return BM_pcapReadNoParse();
+    };
+
+    BENCHMARK("Pcap Read No Parse")
+    {
+        return BM_pcapReadParse();
+    };
+}

libs/visor_dns/tests/benchmark_dns.cpp

@@ -1,117 +1,119 @@
-#include "catch2/catch.hpp"
+#include <catch2/catch_test_macros.hpp>
 
 #include "dns.h"
 
 using namespace visor::lib::dns;
 
+static std::pair<std::string, std::string> convert(const AggDomainResult &result)
+{
+    return {std::string(result.first), std::string(result.second)};
+}
+
 TEST_CASE("DNS Utilities", "[dns]")
 {
+    std::pair<std::string, std::string> result;
+    std::string domain;
 
     SECTION("aggregateDomain")
     {
-        AggDomainResult result;
-        std::string domain;
-
         domain = "biz.foo.bar.com";
-        result = aggregateDomain(domain);
+        result = convert(aggregateDomain(domain));
         CHECK(result.first == ".bar.com");
         CHECK(result.second == ".foo.bar.com");
 
         domain = "a.com";
-        result = aggregateDomain(domain);
+        result = convert(aggregateDomain(domain));
         CHECK(result.first == "a.com");
         CHECK(result.second == "");
 
         domain = "abcdefg.com.";
-        result = aggregateDomain(domain);
+        result = convert(aggregateDomain(domain));
         CHECK(result.first == "abcdefg.com.");
         CHECK(result.second == "");
 
         domain = "foo.bar.com";
-        result = aggregateDomain(domain);
+        result = convert(aggregateDomain(domain));
         CHECK(result.first == ".bar.com");
         CHECK(result.second == "foo.bar.com");
 
         domain = ".";
-        result = aggregateDomain(domain);
+        result = convert(aggregateDomain(domain));
         CHECK(result.first == ".");
         CHECK(result.second == "");
 
         domain = "..";
-        result = aggregateDomain(domain);
+        result = convert(aggregateDomain(domain));
         CHECK(result.first == "..");
         CHECK(result.second == "");
 
         domain = "a";
-        result = aggregateDomain(domain);
+        result = convert(aggregateDomain(domain));
         CHECK(result.first == "a");
         CHECK(result.second == "");
 
         domain = "a.";
-        result = aggregateDomain(domain);
+        result = convert(aggregateDomain(domain));
         CHECK(result.first == "a.");
         CHECK(result.second == "");
 
         domain = "foo.bar.com.";
-        result = aggregateDomain(domain);
+        result = convert(aggregateDomain(domain));
         CHECK(result.first == ".bar.com.");
         CHECK(result.second == "foo.bar.com.");
 
         domain = ".foo.bar.com";
-        result = aggregateDomain(domain);
+        result = convert(aggregateDomain(domain));
         CHECK(result.first == ".bar.com");
         CHECK(result.second == ".foo.bar.com");
 
         domain = "a.b.c";
-        result = aggregateDomain(domain);
+        result = convert(aggregateDomain(domain));
         CHECK(result.first == ".b.c");
         CHECK(result.second == "a.b.c");
 
         domain = ".b.c";
-        result = aggregateDomain(domain);
+        result = convert(aggregateDomain(domain));
         CHECK(result.first == ".b.c");
         CHECK(result.second == "");
     }
 
     SECTION("aggregateDomain with static suffix")
     {
-        AggDomainResult result;
-        std::string domain;
         std::string static_suffix;
 
         domain = "biz.foo.bar.com";
         static_suffix = ".bar.com";
-        result = aggregateDomain(domain, static_suffix.size());
+        result = convert(aggregateDomain(domain, static_suffix.size()));
         CHECK(result.first == ".foo.bar.com");
         CHECK(result.second == "biz.foo.bar.com");
 
         domain = "biz.foo.bar.com";
         static_suffix = "bar.com";
-        result = aggregateDomain(domain, static_suffix.size());
+        result = convert(aggregateDomain(domain, static_suffix.size()));
         CHECK(result.first == ".foo.bar.com");
         CHECK(result.second == "biz.foo.bar.com");
 
         domain = "biz.foo.bar.com";
         static_suffix = "foo.bar.com";
-        result = aggregateDomain(domain, static_suffix.size());
+        result = convert(aggregateDomain(domain, static_suffix.size()));
         CHECK(result.first == "biz.foo.bar.com");
         CHECK(result.second == "");
 
         domain = "foo.bar.com.";
         static_suffix = "biz.foo.bar.com";
-        result = aggregateDomain(domain, static_suffix.size());
+        result = convert(aggregateDomain(domain, static_suffix.size()));
         CHECK(result.first == ".bar.com.");
         CHECK(result.second == "foo.bar.com.");
 
         domain = "www.google.co.uk";
         static_suffix = ".co.uk";
-        result = aggregateDomain(domain, static_suffix.size());
+        result = convert(aggregateDomain(domain, static_suffix.size()));
         CHECK(result.first == ".google.co.uk");
         CHECK(result.second == "www.google.co.uk");
 
         domain = "www.google.co.uk";
         static_suffix = "google.co.uk";
-        result = aggregateDomain(domain, static_suffix.size());
+        result = convert(aggregateDomain(domain, static_suffix.size()));
         CHECK(result.first == "www.google.co.uk");
         CHECK(result.second == "");
     }

libs/visor_dns/tests/dns_udp_tcp_random.pcap

@@ -0,0 +1,17 @@
+message(STATUS "Visor Lib Test Helper")
+
+add_library(VisorLibTest INTERFACE)
+add_library(Visor::Lib::Test ALIAS VisorLibTest)
+
+target_include_directories(VisorLibTest
+    INTERFACE
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>)
+
+target_link_libraries(VisorLibTest
+    INTERFACE
+    ${CONAN_LIBS_SPDLOG}
+    ${CONAN_LIBS_CATCH2})
+
+target_compile_features(VisorLibTest INTERFACE cxx_std_17)
+
+target_sources(VisorLibTest INTERFACE ${CMAKE_CURRENT_SOURCE_DIR}/catch2/catch_test_visor.hpp)