Changeset 88311 in vbox for trunk

Timestamp:

Mar 29, 2021 12:59:22 PM (4 years ago)

Author:

vboxsync

Message:

IPRT/test: Added RTTestErrContext (with variations) for setting a print-once-on-failure message to help put a failure in context w/o needing to get verbose on successful runs. bugref:9890

Location:

trunk

Files:

• include/iprt/mangling.h (modified) (2 diffs)
• include/iprt/test.h (modified) (2 diffs)
• src/VBox/Runtime/r3/test.cpp (modified) (5 diffs)
• src/VBox/Runtime/r3/testi.cpp (modified) (1 diff)

trunk/include/iprt/mangling.h

@@ -2397 +2397 @@
 # define RTTestDestroy                                  RT_MANGLER(RTTestDestroy)
 # define RTTestDisableAssertions                        RT_MANGLER(RTTestDisableAssertions)
+# define RTTestErrContext                               RT_MANGLER(RTTestErrContext)
+# define RTTestErrContextV                              RT_MANGLER(RTTestErrContextV)
 # define RTTestErrorCount                               RT_MANGLER(RTTestErrorCount)
 # define RTTestErrorInc                                 RT_MANGLER(RTTestErrorInc)
@@ -2408 +2410 @@
 # define RTTestGuardedFree                              RT_MANGLER(RTTestGuardedFree)
 # define RTTestIDisableAssertions                       RT_MANGLER(RTTestIDisableAssertions)
+# define RTTestIErrContext                              RT_MANGLER(RTTestIErrContext)
+# define RTTestIErrContextV                             RT_MANGLER(RTTestIErrContextV)
 # define RTTestIErrorCount                              RT_MANGLER(RTTestIErrorCount)
 # define RTTestIErrorInc                                RT_MANGLER(RTTestIErrorInc)

trunk/include/iprt/test.h

@@ -639 +639 @@
 
 /**
+ * Sets error context info to be printed with the first failure.
+ *
+ * @returns IPRT status code.
+ * @param   hTest       The test handle. If NIL_RTTEST we'll use the one
+ *                      associated with the calling thread.
+ * @param   pszFormat   The message, no trailing newline.  NULL to clear the
+ *                      context message.
+ * @param   va          The arguments.
+ */
+RTR3DECL(int) RTTestErrContextV(RTTEST hTest, const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(2, 0);
+
+/**
+ * Sets error context info to be printed with the first failure.
+ *
+ * @returns IPRT status code.
+ * @param   hTest       The test handle. If NIL_RTTEST we'll use the one
+ *                      associated with the calling thread.
+ * @param   pszFormat   The message, no trailing newline.  NULL to clear the
+ *                      context message.
+ * @param   ...         The arguments.
+ */
+RTR3DECL(int) RTTestErrContext(RTTEST hTest, const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(2, 3);
+
+/**
  * Disables and shuts up assertions.
  *
@@ -1115 +1139 @@
  */
 RTR3DECL(int) RTTestIFailureDetails(const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(1, 2);
+
+/**
+ * Sets error context info to be printed with the first failure.
+ *
+ * @returns IPRT status code.
+ * @param   pszFormat   The message, no trailing newline.  NULL to clear the
+ *                      context message.
+ * @param   va          The arguments.
+ */
+RTR3DECL(int) RTTestIErrContextV(const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(1, 0);
+
+/**
+ * Sets error context info to be printed with the first failure.
+ *
+ * @returns IPRT status code.
+ * @param   pszFormat   The message, no trailing newline.  NULL to clear the
+ *                      context message.
+ * @param   ...         The arguments.
+ */
+RTR3DECL(int) RTTestIErrContext(const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(1, 2);
 
 /**

trunk/src/VBox/Runtime/r3/test.cpp

@@ -125 +125 @@
     /** The number of sub tests that failed. */
     uint32_t            cSubTestsFailed;
+
+    /** Error context message. */
+    char               *pszErrCtx;
 
     /** Set if XML output is enabled. */
@@ -520 +523 @@
     RTStrFree((char *)pTest->pszTest);
     pTest->pszTest = NULL;
+    RTStrFree(pTest->pszErrCtx);
+    pTest->pszErrCtx = NULL;
     RTMemFree(pTest);
     return VINF_SUCCESS;
@@ -1259 +1264 @@
         pTest->fSubTestReported = true;
     }
+    RTStrFree(pTest->pszErrCtx);
+    pTest->pszErrCtx = NULL;
     return cch;
 }
@@ -1711 +1718 @@
         RTCritSectEnter(&pTest->OutputLock);
         cch += rtTestPrintf(pTest, fHasNewLine ? "%N" : "%N\n", pszFormat, &va2);
+        if (pTest->pszErrCtx)
+        {
+            cch += rtTestPrintf(pTest, "context: %s\n", pTest->pszErrCtx);
+            RTStrFree(pTest->pszErrCtx);
+            pTest->pszErrCtx = NULL;
+        }
         RTCritSectLeave(&pTest->OutputLock);
 
@@ -1775 +1788 @@
 
 
+RTR3DECL(int) RTTestErrContextV(RTTEST hTest, const char *pszFormat, va_list va)
+{
+    PRTTESTINT pTest = hTest;
+    RTTEST_GET_VALID_RETURN(pTest);
+
+    RTStrFree(pTest->pszErrCtx);
+    pTest->pszErrCtx = NULL;
+
+    if (pszFormat && *pszFormat)
+    {
+        pTest->pszErrCtx = RTStrAPrintf2V(pszFormat, va);
+        AssertReturn(pTest->pszErrCtx, VERR_NO_STR_MEMORY);
+        RTStrStripR(pTest->pszErrCtx);
+    }
+
+    return VINF_SUCCESS;
+}
+
+
+RTR3DECL(int) RTTestErrContext(RTTEST hTest, const char *pszFormat, ...)
+{
+    va_list va;
+    va_start(va, pszFormat);
+    int rc = RTTestErrContextV(hTest, pszFormat, va);
+    va_end(va);
+    return rc;
+}
+
+
 RTR3DECL(int) RTTestDisableAssertions(RTTEST hTest)
 {

trunk/src/VBox/Runtime/r3/testi.cpp

@@ -176 +176 @@
 
 
+RTR3DECL(int) RTTestIErrContextV(const char *pszFormat, va_list va)
+{
+    return RTTestErrContextV(NIL_RTTEST, pszFormat, va);
+}
+
+
+RTR3DECL(int) RTTestErrContext(const char *pszFormat, ...)
+{
+    va_list va;
+    va_start(va, pszFormat);
+    int rc = RTTestIErrContextV(pszFormat, va);
+    va_end(va);
+    return rc;
+}
+
+
 RTR3DECL(int) RTTestIDisableAssertions(void)
 {