Changeset 95331 in vbox for trunk/src/VBox/HostServices

Timestamp:

Jun 21, 2022 7:42:54 PM (2 years ago)

Author:

vboxsync

Message:

tstGuestPropSvc: Unbroke testcase after notification changes, service set properties and whatnot. bugref:10185

File:

• trunk/src/VBox/HostServices/GuestProperties/testcase/tstGuestPropSvc.cpp (modified) (24 diffs)

trunk/src/VBox/HostServices/GuestProperties/testcase/tstGuestPropSvc.cpp

@@ -47 +47 @@
 };
 
+/** Dummy helper callback. */
+static DECLCALLBACK(int) tstHlpInfoDeregister(void *pvInstance, const char *pszName)
+{
+    RT_NOREF(pvInstance, pszName);
+    return VINF_SUCCESS;
+}
+
+/** Dummy helper callback. */
+static DECLCALLBACK(int) tstHlpInfoRegister(void *pvInstance, const char *pszName, const char *pszDesc,
+                                            PFNDBGFHANDLEREXT pfnHandler, void *pvUser)
+{
+    RT_NOREF(pvInstance, pszName, pszDesc, pfnHandler, pvUser);
+    return VINF_SUCCESS;
+}
+
 /** Call completion callback for guest calls. */
 static DECLCALLBACK(int) callComplete(VBOXHGCMCALLHANDLE callHandle, int32_t rc)
@@ -61 +76 @@
 void initTable(VBOXHGCMSVCFNTABLE *pTable, VBOXHGCMSVCHELPERS *pHelpers)
 {
-    pTable->cbSize              = sizeof (VBOXHGCMSVCFNTABLE);
+    RT_ZERO(*pHelpers);
+    pHelpers->pfnCallComplete   = callComplete;
+    pHelpers->pfnInfoRegister   = tstHlpInfoRegister;
+    pHelpers->pfnInfoDeregister = tstHlpInfoDeregister;
+
+    RT_ZERO(*pTable);
+    pTable->cbSize              = sizeof(VBOXHGCMSVCFNTABLE);
     pTable->u32Version          = VBOX_HGCM_SVC_VERSION;
-    pHelpers->pfnCallComplete   = callComplete;
     pTable->pHelpers            = pHelpers;
 }
@@ -235 +255 @@
 }
 
+#if 0
 /** Result strings for zeroth enumeration test */
 static const char *g_apchEnumResult0[] =
@@ -264 +285 @@
            "TEST NAME\0TEST VALUE\0""999999\0RDONLYHOST\0"
            "/test/name\0/test/value\0""999999999999\0RDONLYGUEST\0\0\0\0\0") - 1;
+#endif
 
 /** Result strings for first and second enumeration test */
@@ -293 +315 @@
     /** The enumeration pattern to test */
     const char     *pszPatterns;
-    /** The size of the pattern string */
-    const uint32_t  cchPatterns;
+    /** The size of the pattern string (including terminator) */
+    const uint32_t  cbPatterns;
     /** The expected enumeration output strings */
     const char    **papchResult;
@@ -303 +325 @@
 }   g_aEnumStrings[] =
 {
+#if 0 /* unpredictable automatic variables set by the service now */
     {
         "", sizeof(""),
@@ -309 +332 @@
         g_cbEnumBuffer0
     },
-    {
-        "/*\0?E*", sizeof("/*\0?E*"),
+#endif
+    {
+        "/t*\0?E*", sizeof("/t*\0?E*"),
         g_apchEnumResult1,
         g_acbEnumResult1,
@@ -316 +340 @@
     },
     {
-        "/*|?E*", sizeof("/*|?E*"),
+        "/t*|?E*", sizeof("/t*|?E*"),
         g_apchEnumResult1,
         g_acbEnumResult1,
@@ -340 +364 @@
 
         /* Check that we get buffer overflow with a too small buffer. */
-        HGCMSvcSetPv(&aParms[0], (void *)g_aEnumStrings[i].pszPatterns, g_aEnumStrings[i].cchPatterns);
+        HGCMSvcSetPv(&aParms[0], (void *)g_aEnumStrings[i].pszPatterns, g_aEnumStrings[i].cbPatterns);
         HGCMSvcSetPv(&aParms[1], (void *)abBuffer, g_aEnumStrings[i].cbBuffer - 1);
         memset(abBuffer, 0x55, sizeof(abBuffer));
@@ -350 +374 @@
             if (RT_SUCCESS(rc2))
                 RTTESTI_CHECK_MSG(cbNeeded == g_aEnumStrings[i].cbBuffer,
-                                  ("expected %u, got %u, pattern %d\n", g_aEnumStrings[i].cbBuffer, cbNeeded, i));
+                                  ("expected %#x, got %#x, pattern %d\n", g_aEnumStrings[i].cbBuffer, cbNeeded, i));
         }
         else
@@ -356 +380 @@
 
         /* Make a successfull call. */
-        HGCMSvcSetPv(&aParms[0], (void *)g_aEnumStrings[i].pszPatterns, g_aEnumStrings[i].cchPatterns);
+        HGCMSvcSetPv(&aParms[0], (void *)g_aEnumStrings[i].pszPatterns, g_aEnumStrings[i].cbPatterns);
         HGCMSvcSetPv(&aParms[1], (void *)abBuffer, g_aEnumStrings[i].cbBuffer);
         memset(abBuffer, 0x55, sizeof(abBuffer));
@@ -366 +390 @@
             {
                 bool found = false;
-                for (unsigned k = 0; !found && k <   g_aEnumStrings[i].cbBuffer
-                                                   - g_aEnumStrings[i].pacchResult[j];
-                     ++k)
-                    if (memcmp(abBuffer + k, g_aEnumStrings[i].papchResult[j],
-                        g_aEnumStrings[i].pacchResult[j]) == 0)
+                for (unsigned k = 0; !found && k < g_aEnumStrings[i].cbBuffer - g_aEnumStrings[i].pacchResult[j]; ++k)
+                    if (memcmp(abBuffer + k, g_aEnumStrings[i].papchResult[j], g_aEnumStrings[i].pacchResult[j]) == 0)
                         found = true;
                 if (!found)
@@ -399 +420 @@
                   bool useSetProp)
 {
+    RTThreadSleep(1); /* stupid, stupid timestamp fudge to avoid asserting in getOldNotification() */
+
     VBOXHGCMCALLHANDLE_TYPEDEF callHandle = { VINF_SUCCESS };
     int command = GUEST_PROP_FN_SET_PROP_VALUE;
@@ -534 +557 @@
         /** Should this succeed or be rejected with VERR_PERMISSION_DENIED? */
         bool isAllowed;
-    }
-    s_aDelProperties[] =
+    } s_aDelProperties[] =
     {
         { "Red", false, true },
@@ -549 +571 @@
     for (unsigned i = 0; i < RT_ELEMENTS(s_aDelProperties); ++i)
     {
-        int rc = doDelProp(pTable, s_aDelProperties[i].pcszName,
-                           s_aDelProperties[i].isHost);
+        int rc = doDelProp(pTable, s_aDelProperties[i].pcszName, s_aDelProperties[i].isHost);
         if (s_aDelProperties[i].isAllowed && RT_FAILURE(rc))
             RTTestIFailed("Deleting property '%s' failed with rc=%Rrc.",
@@ -666 +687 @@
 g_aGetNotifications[] =
 {
-    { "Red\0Stop!\0TRANSIENT", sizeof("Red\0Stop!\0TRANSIENT") },
-    { "Amber\0Caution!\0", sizeof("Amber\0Caution!\0") },
-    { "Green\0Go!\0READONLY", sizeof("Green\0Go!\0READONLY") },
-    { "Blue\0What on earth...?\0", sizeof("Blue\0What on earth...?\0") },
-    { "/VirtualBox/GuestAdd/SomethingElse\0test\0",
-      sizeof("/VirtualBox/GuestAdd/SomethingElse\0test\0") },
-    { "/VirtualBox/GuestAdd/SharedFolders/MountDir\0test\0RDONLYGUEST",
-      sizeof("/VirtualBox/GuestAdd/SharedFolders/MountDir\0test\0RDONLYGUEST") },
-    { "/VirtualBox/HostInfo/VRDP/Client/1/Name\0test\0TRANSIENT, RDONLYGUEST, TRANSRESET",
-      sizeof("/VirtualBox/HostInfo/VRDP/Client/1/Name\0test\0TRANSIENT, RDONLYGUEST, TRANSRESET") },
-    { "Red\0\0", sizeof("Red\0\0") },
-    { "Amber\0\0", sizeof("Amber\0\0") },
+    // Name\0Value\0Flags\0fWasDeleted\0
+#define STR_AND_SIZE(a_sz) { a_sz, sizeof(a_sz) }
+    STR_AND_SIZE("Red\0Stop!\0TRANSIENT\0" "0"), /* first test is used by testAsyncNotification, - testGetNotification skips it. (mess) */
+    STR_AND_SIZE("Red\0Stop!\0TRANSIENT\0" "1"),
+    STR_AND_SIZE("Amber\0Caution!\0\0" "1"),
+    STR_AND_SIZE("Green\0Go!\0READONLY\0" "0"),
+    STR_AND_SIZE("Blue\0What on earth...?\0\0" "0"),
+    STR_AND_SIZE("/VirtualBox/GuestAdd/SomethingElse\0test\0\0" "0"),
+    STR_AND_SIZE("/VirtualBox/GuestAdd/SharedFolders/MountDir\0test\0RDONLYGUEST\0" "0"),
+    STR_AND_SIZE("/VirtualBox/HostInfo/VRDP/Client/1/Name\0test\0TRANSIENT, RDONLYGUEST, TRANSRESET\0" "0"),
+    STR_AND_SIZE("Red\0\0\0" "1"),
+    STR_AND_SIZE("Amber\0\0\0" "1"),
+#undef STR_AND_SIZE
 };
 
@@ -690 +712 @@
 
     /* Test "buffer too small" */
-    static char                 s_szPattern[] = "";
+    static char                 s_szPattern[] = "/VirtualBox/GuestAdd/*|/VirtualBox/HostInfo/VRDP/Client*|Red*|Amber*|Green*|Blue*";
     VBOXHGCMCALLHANDLE_TYPEDEF  callHandle = { VINF_SUCCESS };
     VBOXHGCMSVCPARM             aParms[4];
-    uint32_t                    cbRetNeeded;
+    uint32_t                    cbRetNeeded = 0;
 
     for (uint32_t cbBuf = 1;
-         cbBuf < g_aGetNotifications[0].cbBuffer - 1;
+         cbBuf < g_aGetNotifications[1].cbBuffer - 1;
          cbBuf++)
     {
@@ -703 +725 @@
         memset(pvBuf, 0x55, cbBuf);
 
-        HGCMSvcSetPv(&aParms[0], (void *)s_szPattern, sizeof(s_szPattern));
+        HGCMSvcSetStr(&aParms[0], s_szPattern);
         HGCMSvcSetU64(&aParms[1], 1);
         HGCMSvcSetPv(&aParms[2], pvBuf, cbBuf);
@@ -710 +732 @@
         if (   callHandle.rc != VERR_BUFFER_OVERFLOW
             || RT_FAILURE(HGCMSvcGetU32(&aParms[3], &cbRetNeeded))
-            || cbRetNeeded != g_aGetNotifications[0].cbBuffer
+            || cbRetNeeded != g_aGetNotifications[1].cbBuffer
            )
-        {
-            RTTestIFailed("Getting notification for property '%s' with a too small buffer did not fail correctly: %Rrc",
-                          g_aGetNotifications[0].pchBuffer, callHandle.rc);
-        }
+            RTTestIFailed("Getting notification for property '%s' with a too small buffer did not fail correctly: rc=%Rrc, cbRetNeeded=%#x (expected %#x)",
+                          g_aGetNotifications[1].pchBuffer, callHandle.rc, cbRetNeeded, g_aGetNotifications[1].cbBuffer);
         RTTestGuardedFree(g_hTest, pvBuf);
     }
@@ -722 +742 @@
      * to get the oldest available notification. */
     uint64_t u64Timestamp = 1;
-    for (unsigned i = 0; i < RT_ELEMENTS(g_aGetNotifications); ++i)
+    for (unsigned i = 1; i < RT_ELEMENTS(g_aGetNotifications); ++i)
     {
         uint32_t cbBuf = g_aGetNotifications[i].cbBuffer + _1K;
@@ -729 +749 @@
         memset(pvBuf, 0x55, cbBuf);
 
-        HGCMSvcSetPv(&aParms[0], (void *)s_szPattern, sizeof(s_szPattern));
+        HGCMSvcSetStr(&aParms[0], s_szPattern);
         HGCMSvcSetU64(&aParms[1], u64Timestamp);
         HGCMSvcSetPv(&aParms[2], pvBuf, cbBuf);
@@ -741 +761 @@
            )
         {
-            RTTestIFailed("Failed to get notification for property '%s' (rc=%Rrc).",
-                          g_aGetNotifications[i].pchBuffer, callHandle.rc);
+            RTTestIFailed("Failed to get notification for property '%s' (#%u): rc=%Rrc (expected %Rrc), cbRetNeeded=%#x (expected %#x)\n"
+                          "%.*Rhxd\n---expected:---\n%.*Rhxd",
+                          g_aGetNotifications[i].pchBuffer, i, callHandle.rc, i == 0 ? VWRN_NOT_FOUND : VINF_SUCCESS,
+                          cbRetNeeded, g_aGetNotifications[i].cbBuffer, RT_MIN(cbRetNeeded, cbBuf), pvBuf,
+                          g_aGetNotifications[i].cbBuffer, g_aGetNotifications[i].pchBuffer);
         }
         RTTestGuardedFree(g_hTest, pvBuf);
@@ -767 +790 @@
     static char s_szPattern[] = "";
 
-    HGCMSvcSetPv(&g_AsyncNotification.aParms[0], (void *)s_szPattern, sizeof(s_szPattern));
+    HGCMSvcSetStr(&g_AsyncNotification.aParms[0], s_szPattern);
     HGCMSvcSetU64(&g_AsyncNotification.aParms[1], 0);
-    HGCMSvcSetPv(&g_AsyncNotification.aParms[2], (void *)g_AsyncNotification.abBuffer,
-                 sizeof(g_AsyncNotification.abBuffer));
+    HGCMSvcSetPv(&g_AsyncNotification.aParms[2], g_AsyncNotification.abBuffer, sizeof(g_AsyncNotification.abBuffer));
     g_AsyncNotification.callHandle.rc = VINF_HGCM_ASYNC_EXECUTE;
     pTable->pfnCall(pTable->pvService, &g_AsyncNotification.callHandle, 0, NULL,
@@ -787 +809 @@
     RT_NOREF1(pTable);
     uint64_t u64Timestamp;
-    uint32_t u32Size;
+    uint32_t cb;
     if (   g_AsyncNotification.callHandle.rc != VINF_SUCCESS
         || RT_FAILURE(HGCMSvcGetU64(&g_AsyncNotification.aParms[1], &u64Timestamp))
-        || RT_FAILURE(HGCMSvcGetU32(&g_AsyncNotification.aParms[3], &u32Size))
-        || u32Size != g_aGetNotifications[0].cbBuffer
-        || memcmp(g_AsyncNotification.abBuffer, g_aGetNotifications[0].pchBuffer, u32Size) != 0
+        || RT_FAILURE(HGCMSvcGetU32(&g_AsyncNotification.aParms[3], &cb))
+        || cb != g_aGetNotifications[0].cbBuffer
+        || memcmp(g_AsyncNotification.abBuffer, g_aGetNotifications[0].pchBuffer, cb) != 0
        )
     {
-        RTTestIFailed("Asynchronous GET_NOTIFICATION call did not complete as expected, rc=%Rrc.",
-                      g_AsyncNotification.callHandle.rc);
+        RTTestIFailed("Asynchronous GET_NOTIFICATION call did not complete as expected: rc=%Rrc, cb=%#x (expected %#x)\n"
+                      "abBuffer=%.*Rhxs\n"
+                      "expected=%.*Rhxs",
+                      g_AsyncNotification.callHandle.rc, cb, g_aGetNotifications[0].cbBuffer,
+                      cb, g_AsyncNotification.abBuffer, g_aGetNotifications[0].cbBuffer, g_aGetNotifications[0].pchBuffer);
     }
 }