Merge pull request #775 from intel-innersource/uid_aantonov_add_gtests

Introduce GoogleTests in PCM project

Author: twillhal

.gitmodules

@@ -10,3 +10,6 @@
 [submodule "Intel-PMT"]
 	path = Intel-PMT
 	url = https://github.com/intel/Intel-PMT.git
+[submodule "googletest"]
+	path = googletest
+	url = https://github.com/google/googletest.git

CMakeLists.txt

@@ -185,6 +185,10 @@ add_subdirectory(src)
 add_subdirectory(examples)
 add_subdirectory(tests)
 
+if(UNIX)
+    add_subdirectory(googletest)
+endif(UNIX)
+
 message(STATUS "Install directory: ${CMAKE_INSTALL_PREFIX}")
 
 #######################

googletest

@@ -170,11 +170,29 @@ struct bdf {
     uint8_t busno;
     uint8_t devno;
     uint8_t funcno;
+
     bdf() : domainno(0), busno(0), devno(0), funcno(0) {}
     bdf(uint32_t domain, uint8_t bus, uint8_t device, uint8_t function) :
         domainno(domain), busno(bus), devno(device), funcno(function) {}
     bdf(uint8_t bus, uint8_t device, uint8_t function) :
         domainno(0), busno(bus), devno(device), funcno(function) {}
+
+    std::string to_string() const
+    {
+        std::ostringstream oss;
+        oss << std::hex << std::uppercase << std::setfill('0')
+            << std::setw(DOMAIN_WIDTH) << domainno << ":"
+            << std::setw(BUS_WIDTH) << static_cast<int>(busno) << ":"
+            << std::setw(DEVICE_WIDTH) << static_cast<int>(devno) << "."
+            << std::setw(FUNCTION_WIDTH) << static_cast<int>(funcno);
+        return oss.str();
+    }
+
+private:
+    static const int DOMAIN_WIDTH = 4;
+    static const int BUS_WIDTH = 2;
+    static const int DEVICE_WIDTH = 2;
+    static const int FUNCTION_WIDTH = 1;
 };
 
 struct pci {

src/lspci.h

@@ -1,7 +1,8 @@
 # SPDX-License-Identifier: BSD-3-Clause
 # Copyright (c) 2022-2024, Intel Corporation
 
-set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin/tests)
+set(CMAKE_TEST_BINARY_DIR ${CMAKE_BINARY_DIR}/bin/tests)
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_TEST_BINARY_DIR})
 
 if(UNIX)
 
@@ -16,6 +17,7 @@ if(UNIX)
         target_link_libraries(urltest Threads::Threads PCM_STATIC)
     endif(LINUX)
 
+    add_subdirectory(utests)
 endif(UNIX)
 
 if(PCM_FUZZ)
@@ -33,4 +35,4 @@ if(PCM_FUZZ)
     target_link_libraries(pcm-sensor-server-ssl-fuzz Threads::Threads PCM_STATIC ${SSL_LIBS})
     target_link_libraries(pcm-fuzz Threads::Threads PCM_STATIC)
     target_link_libraries(pcm-memory-fuzz Threads::Threads PCM_STATIC)
-endif()
+endif()

tests/CMakeLists.txt

@@ -408,5 +408,25 @@ if [ "$?" -ne "0" ]; then
 fi
 online_offline_cores 1
 
+# Below is UT part
+
+echo "Running Unit Tests"
+failed=()
+for test_binary in ./tests/utests/*; do
+    if [ -x "$test_binary" ]; then
+        echo "Running $test_binary"
+        "$test_binary"
+        if [ "$?" -ne "0" ]; then
+            failed+=("$test_binary")
+        fi
+    else
+        echo "Skipping $test_binary (not executable)"
+    fi
+done
+
+if [ "${#failed[@]}" -ne "0" ]; then
+    echo "Failed test programs: ${failed[@]}"
+    exit 1
+fi
 
 popd

tests/test.sh

@@ -0,0 +1,25 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright (c) 2009-2025, Intel Corporation
+
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_TEST_BINARY_DIR}/utests)
+
+project(pcm_utests LANGUAGES CXX)
+
+enable_testing()
+
+include_directories(${CMAKE_SOURCE_DIR}/src/)
+include_directories("${GMOCK_DIR}/include")
+
+file(GLOB LSPCI_TEST_FILES lspci-utest.cpp ${CMAKE_SOURCE_DIR}/src/lspci.cpp)
+set(LIBS Threads::Threads PCM_STATIC)
+add_executable(lspci-utest ${LSPCI_TEST_FILES})
+
+target_link_libraries(
+    lspci-utest
+    GTest::gtest_main
+    GTest::gmock_main
+    ${LIBS}
+)
+
+include(GoogleTest)
+gtest_discover_tests(lspci-utest)

tests/utests/CMakeLists.txt

@@ -0,0 +1,27 @@
+// SPDX-License-Identifier: BSD-3-Clause
+// Copyright (c) 2009-2025, Intel Corporation
+// written by Alexander Antonov
+
+#include "lspci.h"
+#include <gtest/gtest.h>
+#include <string>
+
+using namespace pcm;
+
+TEST(BDFTest, ToStringDefaultConstructor)
+{
+    struct bdf default_bdf;
+    EXPECT_EQ(default_bdf.to_string(), "0000:00:00.0");
+}
+
+TEST(BDFTest, ToStringCustomConstructor)
+{
+    struct bdf custom_bdf(0x1234, 0x56, 0x10, 0x7);
+    EXPECT_EQ(custom_bdf.to_string(), "1234:56:10.7");
+}
+
+TEST(BDFTest, ToStringPartialConstructor)
+{
+    struct bdf partial_bdf(0x56, 0x10, 0x7);
+    EXPECT_EQ(partial_bdf.to_string(), "0000:56:10.7");
+}