Added Common++ unit test project based on Gtest.

.github/workflows/build_and_test.yml

@@ -215,7 +215,7 @@ jobs:
       - name: Test PcapPlusPlus
         run: |
           . .venv/bin/activate
-          python3 ci/run_tests/run_tests.py --interface eth0 --test-suites "packet"
+          python3 ci/run_tests/run_tests.py --interface eth0 --test-suites "common" "packet"
 
       - name: Check installation
         run: |

.pre-commit-config.yaml

@@ -36,7 +36,7 @@ repos:
         args: ["--style=file", "-i"]  # Use the .clang-format file for configuration and apply all fixes
         files: ^(Common\+\+|Packet\+\+|Pcap\+\+|Tests|Examples)/.*\.(cpp|h)$
       - id: cppcheck
-        args: ["--std=c++11", "--language=c++", "--suppressions-list=cppcheckSuppressions.txt", "--inline-suppr", "--force"]
+        args: ["--std=c++11", "--language=c++", "--suppressions-list=cppcheckSuppressions.txt", "--inline-suppr", "--force", "--library=googletest"]
   - repo: https://github.com/BlankSpruce/gersemi
     rev: 0.19.3
     hooks:

Common++/header/IpAddress.h

@@ -883,6 +883,19 @@ namespace pcpp
 		std::unique_ptr<IPv6Network> m_IPv6Network;
 	};
 
+	namespace literals
+	{
+		inline IPv4Address operator""_ipv4(const char* addrString, std::size_t size)
+		{
+			return IPv4Address(std::string(addrString, size));
+		}
+
+		inline IPv6Address operator""_ipv6(const char* addrString, std::size_t size)
+		{
+			return IPv6Address(std::string(addrString, size));
+		}
+	}  // namespace literals
+
 	inline std::ostream& operator<<(std::ostream& oss, const pcpp::IPv4Address& ipv4Address)
 	{
 		oss << ipv4Address.toString();

Common++/header/MacAddress.h

@@ -1,5 +1,6 @@
 #pragma once
 
+#include <array>
 #include <algorithm>
 #include <initializer_list>
 #include <iterator>
@@ -177,9 +178,9 @@ namespace pcpp
 		bool copyToNewBuffer(uint8_t** buffer, size_t& size) const;
 
 		/// A static value representing a zero value of MAC address, meaning address of value "00:00:00:00:00:00"
-		static MacAddress Zero;
+		static const MacAddress Zero;
 		/// A static value representing a broadcast MAC address, meaning address of value "ff:ff:ff:ff:ff:ff"
-		static MacAddress Broadcast;
+		static const MacAddress Broadcast;
 
 	private:
 		std::array<uint8_t, 6> m_Address{};

Common++/src/MacAddress.cpp

@@ -3,9 +3,9 @@
 namespace pcpp
 {
 
-	MacAddress MacAddress::Zero(0, 0, 0, 0, 0, 0);
+	const MacAddress MacAddress::Zero(0, 0, 0, 0, 0, 0);
 
-	MacAddress MacAddress::Broadcast(0xff, 0xff, 0xff, 0xff, 0xff, 0xff);
+	const MacAddress MacAddress::Broadcast(0xff, 0xff, 0xff, 0xff, 0xff, 0xff);
 
 	std::string MacAddress::toString() const
 	{

Tests/CMakeLists.txt

@@ -1,5 +1,6 @@
 if(PCAPPP_BUILD_TESTS)
   add_subdirectory(PcppTestFramework)
+  add_subdirectory(Common++Test)
   add_subdirectory(Packet++Test)
 
   if(PCAPPP_BUILD_PCAPPP)

Tests/Common++Test/CMakeLists.txt

@@ -0,0 +1,45 @@
+cmake_minimum_required(VERSION 3.14)
+
+include(FetchContent)
+
+# TODO: This may have issues with brew as it doesn't allow the use of FetchContent.
+FetchContent_Declare(googletest GIT_REPOSITORY https://github.com/google/googletest.git GIT_TAG v1.16.0)
+
+if(WIN32)
+  # Prevent overriding the parent project's compiler/linker settings.
+  set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+endif()
+
+FetchContent_MakeAvailable(googletest)
+
+add_executable(
+  Common++Test
+  "main.cpp"
+  "Tests/GeneralUtilsTests.cpp"
+  "Tests/IPAddressTests.cpp"
+  "Tests/LoggerTests.cpp"
+  "Tests/LRUListTests.cpp"
+  "Tests/MacAddressTests.cpp"
+  "Tests/ObjectPoolTests.cpp"
+  "Tests/PointerVectorTests.cpp"
+  "Tests/SystemUtilsTests.cpp"
+  "Tests/TimespecTimevalTests.cpp"
+)
+
+target_link_libraries(Common++Test PRIVATE Common++ memplumber gtest gmock)
+
+target_include_directories(Common++Test PRIVATE $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/header>)
+target_precompile_headers(Common++Test PRIVATE $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/header/pch.h>)
+
+if(MSVC)
+  # This executable requires getopt.h not available on VStudio
+  target_link_libraries(Common++Test PRIVATE Getopt-for-Visual-Studio)
+endif()
+
+set_property(TARGET Common++Test PROPERTY RUNTIME_OUTPUT_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/Bin")
+set_property(TARGET Common++Test PROPERTY RUNTIME_OUTPUT_DIRECTORY_DEBUG "${CMAKE_CURRENT_SOURCE_DIR}/Bin")
+set_property(TARGET Common++Test PROPERTY RUNTIME_OUTPUT_DIRECTORY_RELEASE "${CMAKE_CURRENT_SOURCE_DIR}/Bin")
+
+enable_testing()
+
+add_test(NAME Common++Test COMMAND $<TARGET_FILE:Common++Test> WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/)

Tests/Common++Test/Tests/GeneralUtilsTests.cpp

@@ -0,0 +1,37 @@
+#include "pch.h"
+
+#include <cstring>
+
+#include "GeneralUtils.h"
+
+namespace pcpp
+{
+	TEST(GeneralUtilsTests, byteArrayToHexString)
+	{
+		std::array<uint8_t, 3> byteArr = { 0xaa, 0x2b, 0x10 };
+		EXPECT_EQ(byteArrayToHexString(byteArr.data(), byteArr.size()), "aa2b10");
+	};
+
+	TEST(GeneralUtilsTests, hexStringToByteArray)
+	{
+		std::array<uint8_t, 3> resultByteArr = { 0 };
+		EXPECT_EQ(hexStringToByteArray("aa2b10", resultByteArr.data(), resultByteArr.size()), 3);
+		EXPECT_EQ(resultByteArr, (std::array<uint8_t, 3>{ 0xaa, 0x2b, 0x10 }));
+	};
+
+	TEST(GeneralUtilsTests, cross_platform_memmem)
+	{
+		const char haystack[] = "Hello, World!";
+		const char needle[] = "World";
+		EXPECT_EQ(cross_platform_memmem(haystack, sizeof(haystack), needle,
+		                                sizeof(needle) - 1 /* ignore the null terminator */),
+		          haystack + 7);
+	};
+
+	TEST(GeneralUtilsTests, align)
+	{
+		EXPECT_EQ(align<4>(3), 4);
+		EXPECT_EQ(align<4>(4), 4);
+		EXPECT_EQ(align<4>(5), 8);
+	};
+}  // namespace pcpp