Added tests for consistency between ordering of GetDevices and filter selector

Author: oleksandr-pavlyk

dpctl-capi/tests/test_sycl_device_manager.cpp

@@ -24,10 +24,12 @@
 ///
 //===----------------------------------------------------------------------===//
 
+#include "../helper/include/dpctl_utils_helper.h"
 #include "dpctl_sycl_device_interface.h"
 #include "dpctl_sycl_device_manager.h"
 #include "dpctl_sycl_device_selector_interface.h"
 #include <gtest/gtest.h>
+#include <string>
 
 struct TestDPCTLDeviceManager : public ::testing::TestWithParam<const char *>
 {
@@ -81,12 +83,12 @@ INSTANTIATE_TEST_SUITE_P(DeviceMgrFunctions,
                                            "opencl:cpu:0",
                                            "level_zero:gpu:0"));
 
-struct TestDPCTLDeviceVector : public ::testing::TestWithParam<int>
+struct TestDPCTLGetDevices : public ::testing::TestWithParam<int>
 {
     DPCTLDeviceVectorRef DV = nullptr;
     size_t nDevices = 0;
 
-    TestDPCTLDeviceVector()
+    TestDPCTLGetDevices()
     {
         EXPECT_NO_FATAL_FAILURE(DV = DPCTLDeviceMgr_GetDevices(GetParam()));
         EXPECT_TRUE(DV != nullptr);
@@ -100,14 +102,14 @@ struct TestDPCTLDeviceVector : public ::testing::TestWithParam<int>
         }
     }
 
-    ~TestDPCTLDeviceVector()
+    ~TestDPCTLGetDevices()
     {
         EXPECT_NO_FATAL_FAILURE(DPCTLDeviceVector_Clear(DV));
         EXPECT_NO_FATAL_FAILURE(DPCTLDeviceVector_Delete(DV));
     }
 };
 
-TEST_P(TestDPCTLDeviceVector, ChkGetAt)
+TEST_P(TestDPCTLGetDevices, ChkGetAt)
 {
     for (auto i = 0ul; i < nDevices; ++i) {
         DPCTLSyclDeviceRef DRef = nullptr;
@@ -118,14 +120,18 @@ TEST_P(TestDPCTLDeviceVector, ChkGetAt)
 
 INSTANTIATE_TEST_SUITE_P(
     GetDevices,
-    TestDPCTLDeviceVector,
+    TestDPCTLGetDevices,
     ::testing::Values(DPCTLSyclBackendType::DPCTL_HOST,
                       DPCTLSyclBackendType::DPCTL_LEVEL_ZERO,
                       DPCTLSyclBackendType::DPCTL_OPENCL,
                       DPCTLSyclBackendType::DPCTL_OPENCL |
                           DPCTLSyclDeviceType::DPCTL_GPU));
 
-TEST(TestDPCTLDeviceVector, ChkDPCTLDeviceVectorCreate)
+struct TestDPCTLDeviceVector : public ::testing::Test
+{
+};
+
+TEST_F(TestDPCTLDeviceVector, ChkDPCTLDeviceVectorCreate)
 {
     DPCTLDeviceVectorRef DVRef = nullptr;
     size_t nDevices = 0;
@@ -135,3 +141,63 @@ TEST(TestDPCTLDeviceVector, ChkDPCTLDeviceVectorCreate)
     EXPECT_TRUE(nDevices == 0);
     EXPECT_NO_FATAL_FAILURE(DPCTLDeviceVector_Delete(DVRef));
 }
+
+struct TestDPCTLGetDevicesOrdering : public ::testing::TestWithParam<int>
+{
+    DPCTLDeviceVectorRef DV = nullptr;
+    size_t nDevices = 0;
+
+    TestDPCTLGetDevicesOrdering()
+    {
+        const int device_type_mask =
+            (GetParam() & DPCTLSyclDeviceType::DPCTL_ALL) |
+            DPCTLSyclBackendType::DPCTL_ALL_BACKENDS;
+        EXPECT_NO_FATAL_FAILURE(
+            DV = DPCTLDeviceMgr_GetDevices(device_type_mask));
+        EXPECT_TRUE(DV != nullptr);
+        EXPECT_NO_FATAL_FAILURE(nDevices = DPCTLDeviceVector_Size(DV));
+    }
+
+    void SetUp()
+    {
+        if (!nDevices) {
+            GTEST_SKIP_("Skipping as no devices returned for identifier");
+        }
+    }
+
+    ~TestDPCTLGetDevicesOrdering()
+    {
+        EXPECT_NO_FATAL_FAILURE(DPCTLDeviceVector_Clear(DV));
+        EXPECT_NO_FATAL_FAILURE(DPCTLDeviceVector_Delete(DV));
+    }
+};
+
+TEST_P(TestDPCTLGetDevicesOrdering, ChkConsistencyWithFilterSelector)
+{
+    for (auto i = 0ul; i < nDevices; ++i) {
+        DPCTLSyclDeviceType Dty;
+        std::string fs_device_type, fs;
+        DPCTLSyclDeviceRef DRef = nullptr, D0Ref = nullptr;
+        DPCTLSyclDeviceSelectorRef DSRef = nullptr;
+        EXPECT_NO_FATAL_FAILURE(DRef = DPCTLDeviceVector_GetAt(DV, i));
+        EXPECT_NO_FATAL_FAILURE(Dty = DPCTLDevice_GetDeviceType(DRef));
+        EXPECT_NO_FATAL_FAILURE(
+            fs_device_type = DPCTL_DeviceTypeToStr(
+                DPCTL_DPCTLDeviceTypeToSyclDeviceType(Dty)));
+        EXPECT_NO_FATAL_FAILURE(fs = fs_device_type + ":" + std::to_string(i));
+        EXPECT_NO_FATAL_FAILURE(DSRef = DPCTLFilterSelector_Create(fs.c_str()));
+        EXPECT_NO_FATAL_FAILURE(D0Ref = DPCTLDevice_CreateFromSelector(DSRef));
+        EXPECT_NO_FATAL_FAILURE(DPCTLDeviceSelector_Delete(DSRef));
+        EXPECT_TRUE(DPCTLDevice_AreEq(DRef, D0Ref));
+        EXPECT_NO_FATAL_FAILURE(DPCTLDevice_Delete(D0Ref));
+        EXPECT_NO_FATAL_FAILURE(DPCTLDevice_Delete(DRef));
+    }
+}
+
+INSTANTIATE_TEST_SUITE_P(
+    GetDevices,
+    TestDPCTLGetDevicesOrdering,
+    ::testing::Values(DPCTLSyclDeviceType::DPCTL_HOST_DEVICE,
+                      DPCTLSyclDeviceType::DPCTL_ACCELERATOR,
+                      DPCTLSyclDeviceType::DPCTL_GPU,
+                      DPCTLSyclDeviceType::DPCTL_CPU));