Added Common++ unit test project based on Gtest.

.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.17.0
     hooks:

Common++/header/IpAddress.h

@@ -1082,40 +1082,53 @@ namespace pcpp
 		std::unique_ptr<IPv4Network> m_IPv4Network;
 		std::unique_ptr<IPv6Network> m_IPv6Network;
 	};
-}  // namespace pcpp
 
-inline std::ostream& operator<<(std::ostream& os, const pcpp::IPv4Address& ipv4Address)
-{
-	os << ipv4Address.toString();
-	return os;
-}
+	namespace literals
+	{
+		inline IPv4Address operator""_ipv4(const char* addrString, std::size_t size)
+		{
+			return IPv4Address(std::string(addrString, size));
+		}
 
-inline std::ostream& operator<<(std::ostream& os, const pcpp::IPv6Address& ipv6Address)
-{
-	os << ipv6Address.toString();
-	return os;
-}
+		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& os, const pcpp::IPAddress& ipAddress)
-{
-	os << ipAddress.toString();
-	return os;
-}
+	inline std::ostream& operator<<(std::ostream& os, const pcpp::IPv4Address& ipv4Address)
+	{
+		os << ipv4Address.toString();
+		return os;
+	}
 
-inline std::ostream& operator<<(std::ostream& os, const pcpp::IPv4Network& network)
-{
-	os << network.toString();
-	return os;
-}
+	inline std::ostream& operator<<(std::ostream& os, const pcpp::IPv6Address& ipv6Address)
+	{
+		os << ipv6Address.toString();
+		return os;
+	}
 
-inline std::ostream& operator<<(std::ostream& os, const pcpp::IPv6Network& network)
-{
-	os << network.toString();
-	return os;
-}
+	inline std::ostream& operator<<(std::ostream& os, const pcpp::IPAddress& ipAddress)
+	{
+		os << ipAddress.toString();
+		return os;
+	}
 
-inline std::ostream& operator<<(std::ostream& os, const pcpp::IPNetwork& network)
-{
-	os << network.toString();
-	return os;
-}
+	inline std::ostream& operator<<(std::ostream& os, const pcpp::IPv4Network& network)
+	{
+		os << network.toString();
+		return os;
+	}
+
+	inline std::ostream& operator<<(std::ostream& os, const pcpp::IPv6Network& network)
+	{
+		os << network.toString();
+		return os;
+	}
+
+	inline std::ostream& operator<<(std::ostream& os, const pcpp::IPNetwork& network)
+	{
+		os << network.toString();
+		return os;
+	}
+}  // namespace pcpp

Common++/header/MacAddress.h

@@ -1,5 +1,6 @@
 #pragma once
 
+#include <array>
 #include <algorithm>
 #include <initializer_list>
 #include <iterator>
@@ -41,6 +42,15 @@ namespace pcpp
 			memcpy(m_Address, addr, sizeof(m_Address));
 		}
 
+		/**
+		 * A constructor that creates an instance of the class out of a std::array.
+		 * @param[in] addr The std::array containing 6 bytes representing the MAC address.
+		 */
+		explicit MacAddress(std::array<uint8_t, 6> const& addr)
+		{
+			std::copy(addr.begin(), addr.end(), std::begin(m_Address));
+		}
+
 		/**
 		 * A constructor that creates an instance of the class out of a std::string.
 		 * If the string doesn't represent a valid MAC address, the constructor throws an exception.
@@ -173,10 +183,10 @@ namespace pcpp
 	private:
 		uint8_t m_Address[6] = { 0 };
 	};
-}  // namespace pcpp
 
-inline std::ostream& operator<<(std::ostream& os, const pcpp::MacAddress& macAddress)
-{
-	os << macAddress.toString();
-	return os;
-}
+	inline std::ostream& operator<<(std::ostream& os, const pcpp::MacAddress& macAddress)
+	{
+		os << macAddress.toString();
+		return os;
+	}
+}  // namespace pcpp

Tests/CMakeLists.txt

@@ -1,4 +1,5 @@
 if(PCAPPP_BUILD_TESTS)
+  add_subdirectory(Common++Test)
   add_subdirectory(Packet++Test)
   add_subdirectory(Pcap++Test)
   add_subdirectory(PcppTestFramework)

Tests/Common++Test/CMakeLists.txt

@@ -0,0 +1,51 @@
+cmake_minimum_required(VERSION 3.14)
+
+include(FetchContent)
+
+FetchContent_Declare(
+  googletest
+  GIT_REPOSITORY https://github.com/google/googletest.git
+  GIT_TAG release-1.12.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
+  Tests/GeneralUtilsTests.cpp
+  Tests/IPAddressTests.cpp
+  Tests/LRUListTests.cpp
+  Tests/MacAddressTests.cpp
+  Tests/PointerVectorTests.cpp)
+
+target_link_libraries(
+  Common++Test
+  PRIVATE Common++
+          memplumber
+          gtest
+          gmock
+          gmock_main)
+
+target_include_directories(Common++Test PRIVATE $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/Utils>)
+
+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,38 @@
+#include <array>
+#include <cstring>
+#include <gtest/gtest.h>
+#include <gmock/gmock.h>
+
+#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