Changeset 89135 in vbox for trunk/src/VBox

Timestamp:

May 18, 2021 10:38:17 AM (4 years ago)

Author:

vboxsync

Message:

Audio/ValKit: More code for testing infrastructure. bugref:10008

Location:

trunk/src/VBox

Files:

• Devices/Audio/AudioTest.cpp (modified) (16 diffs)
• Devices/Audio/AudioTest.h (modified) (5 diffs)
• ValidationKit/utils/audio/vkat.cpp (modified) (4 diffs)

trunk/src/VBox/Devices/Audio/AudioTest.cpp

@@ -315 +315 @@
 }
 
+DECLINLINE(int) audioTestManifestWriteData(PAUDIOTESTSET pSet, const void *pvData, size_t cbData)
+{
+    /** @todo Use RTIniFileWrite once its implemented. */
+    return RTFileWrite(pSet->f.hFile, pvData, cbData, NULL);
+}
+
 /**
  * Writes string data to a test set manifest.
@@ -326 +332 @@
 {
     char *psz = NULL;
-    RTStrAPrintfV(&psz, pszFormat, args);
-    AssertPtr(psz);
-
-    /** @todo Use RTIniFileWrite once its implemented. */
-    int rc = RTFileWrite(pSet->f.hFile, psz, strlen(psz), NULL);
+    if (RTStrAPrintfV(&psz, pszFormat, args) == -1)
+        return VERR_NO_MEMORY;
+    AssertPtrReturn(psz, VERR_NO_MEMORY);
+
+    int rc = audioTestManifestWriteData(pSet, psz, strlen(psz));
     AssertRC(rc);
 
@@ -339 +345 @@
 
 /**
- * Writes a terminated string line to a test set manifest.
+ * Writes a string to a test set manifest.
  * Convenience function.
  *
@@ -347 +353 @@
  * @param   ...                 Variable arguments for \a pszFormat. Optional.
  */
-static int audioTestManifestWriteLn(PAUDIOTESTSET pSet, const char *pszFormat, ...)
+static int audioTestManifestWrite(PAUDIOTESTSET pSet, const char *pszFormat, ...)
 {
     va_list va;
@@ -357 +363 @@
     va_end(va);
 
-    /** @todo Keep it as simple as possible for now. Improve this later. */
-    rc = RTFileWrite(pSet->f.hFile, "\n", strlen("\n"), NULL);
-    AssertRC(rc);
-
-    return rc;
-}
-
-/**
- * Writes a section entry to a test set manifest.
+    return rc;
+}
+
+/**
+ * Returns the current read/write offset (in bytes) of the opened manifest file.
+ *
+ * @returns Current read/write offset (in bytes).
+ * @param   pSet                Set to return offset for.
+ *                              Must have an opened manifest file.
+ */
+DECLINLINE(uint64_t) audioTestManifestGetOffsetAbs(PAUDIOTESTSET pSet)
+{
+    AssertReturn(RTFileIsValid(pSet->f.hFile), 0);
+    return RTFileTell(pSet->f.hFile);
+}
+
+/**
+ * Writes a section header to a test set manifest.
  *
  * @returns VBox status code.
@@ -372 +387 @@
  * @param   ...                 Variable arguments for \a pszSection. Optional.
  */
-static int audioTestManifestWriteSection(PAUDIOTESTSET pSet, const char *pszSection, ...)
+static int audioTestManifestWriteSectionHdr(PAUDIOTESTSET pSet, const char *pszSection, ...)
 {
     va_list va;
@@ -378 +393 @@
 
     /** @todo Keep it as simple as possible for now. Improve this later. */
-    int rc = RTFileWrite(pSet->f.hFile, "[", strlen("["), NULL);
+    int rc = audioTestManifestWrite(pSet, "[");
     AssertRC(rc);
 
@@ -384 +399 @@
     AssertRC(rc);
 
-    rc = RTFileWrite(pSet->f.hFile, "]\n", strlen("]\n"), NULL);
+    rc = audioTestManifestWrite(pSet, "]\n");
     AssertRC(rc);
 
@@ -394 +409 @@
 /**
  * Initializes an audio test set, internal function.
+ *
  * @param   pSet                Test set to initialize.
  */
@@ -401 +417 @@
 
     RTListInit(&pSet->lstObj);
+    pSet->cObj = 0;
+
+    RTListInit(&pSet->lstTest);
+    pSet->cTests        = 0;
+    pSet->cTestsRunning = 0;
+    pSet->offTestCount  = 0;
+
+    pSet->cTotalFailures = 0;
 }
 
@@ -612 +636 @@
         AssertRCReturn(rc, rc);
 
-        rc = audioTestManifestWriteSection(pSet, "header");
-        AssertRCReturn(rc, rc);
-
-        rc = audioTestManifestWriteLn(pSet, "magic=vkat_ini"); /* VKAT Manifest, .INI-style. */
-        AssertRCReturn(rc, rc);
-        rc = audioTestManifestWriteLn(pSet, "ver=%d", AUDIOTEST_MANIFEST_VER);
-        AssertRCReturn(rc, rc);
-        rc = audioTestManifestWriteLn(pSet, "tag=%s", pSet->szTag);
+        rc = audioTestManifestWriteSectionHdr(pSet, "header");
+        AssertRCReturn(rc, rc);
+
+        rc = audioTestManifestWrite(pSet, "magic=vkat_ini\n"); /* VKAT Manifest, .INI-style. */
+        AssertRCReturn(rc, rc);
+        rc = audioTestManifestWrite(pSet, "ver=%d\n", AUDIOTEST_MANIFEST_VER);
+        AssertRCReturn(rc, rc);
+        rc = audioTestManifestWrite(pSet, "tag=%s\n", pSet->szTag);
         AssertRCReturn(rc, rc);
 
@@ -627 +651 @@
             AssertFailedReturn(VERR_BUFFER_OVERFLOW);
 
-        rc = audioTestManifestWriteLn(pSet, "date_created=%s", szVal);
+        rc = audioTestManifestWrite(pSet, "date_created=%s\n", szVal);
         AssertRCReturn(rc, rc);
 
         rc = RTSystemQueryOSInfo(RTSYSOSINFO_PRODUCT, szVal, sizeof(szVal));
         AssertRCReturn(rc, rc);
-        rc = audioTestManifestWriteLn(pSet, "os_product=%s", szVal);
+        rc = audioTestManifestWrite(pSet, "os_product=%s\n", szVal);
         AssertRCReturn(rc, rc);
         rc = RTSystemQueryOSInfo(RTSYSOSINFO_RELEASE, szVal, sizeof(szVal));
         AssertRCReturn(rc, rc);
-        rc = audioTestManifestWriteLn(pSet, "os_rel=%s", szVal);
+        rc = audioTestManifestWrite(pSet, "os_rel=%s\n", szVal);
         AssertRCReturn(rc, rc);
         rc = RTSystemQueryOSInfo(RTSYSOSINFO_VERSION, szVal, sizeof(szVal));
         AssertRCReturn(rc, rc);
-        rc = audioTestManifestWriteLn(pSet, "os_ver=%s", szVal);
-        AssertRCReturn(rc, rc);
-
-        rc = audioTestManifestWriteLn(pSet, "vbox_ver=%s r%u %s (%s %s)",
+        rc = audioTestManifestWrite(pSet, "os_ver=%s\n", szVal);
+        AssertRCReturn(rc, rc);
+        rc = audioTestManifestWrite(pSet, "vbox_ver=%s r%u %s (%s %s)\n",
                                       VBOX_VERSION_STRING, RTBldCfgRevision(),
                                       RTBldCfgTargetDotArch(), __DATE__, __TIME__);
         AssertRCReturn(rc, rc);
 
+        rc = audioTestManifestWrite(pSet, "test_count=");
+        AssertRCReturn(rc, rc);
+        pSet->offTestCount = audioTestManifestGetOffsetAbs(pSet);
+        rc = audioTestManifestWrite(pSet, "0000\n"); /* A bit messy, but does the trick for now. */
+        AssertRCReturn(rc, rc);
+
         pSet->enmMode = AUDIOTESTSETMODE_TEST;
     }
@@ -665 +694 @@
         return VINF_SUCCESS;
 
-    int rc = VINF_SUCCESS;
+    AssertReturn(pSet->cTestsRunning == 0, VERR_WRONG_ORDER); /* Make sure no tests sill are running. */
+
+    int rc = AudioTestSetClose(pSet);
+    if (RT_FAILURE(rc))
+        return rc;
 
     PAUDIOTESTOBJ pObj, pObjNext;
@@ -688 +721 @@
     Assert(pSet->cObj == 0);
 
-    if (RTFileIsValid(pSet->f.hFile))
-    {
-        RTFileClose(pSet->f.hFile);
-        pSet->f.hFile = NIL_RTFILE;
-    }
+    PAUDIOTESTENTRY pEntry, pEntryNext;
+    RTListForEachSafe(&pSet->lstTest, pEntry, pEntryNext, AUDIOTESTENTRY, Node)
+    {
+        RTListNodeRemove(&pEntry->Node);
+        RTMemFree(pEntry);
+
+        Assert(pSet->cTests);
+        pSet->cTests--;
+    }
+
+    if (RT_FAILURE(rc))
+        return rc;
+
+    Assert(pSet->cTests == 0);
 
     return rc;
@@ -729 +771 @@
  * Closes an opened audio test set.
  *
+ * @returns VBox status code.
  * @param   pSet                Test set to close.
  */
-void AudioTestSetClose(PAUDIOTESTSET pSet)
-{
-    AudioTestSetDestroy(pSet);
+int AudioTestSetClose(PAUDIOTESTSET pSet)
+{
+    if (!pSet)
+        return VINF_SUCCESS;
+
+    /* Update number of ran tests. */
+    int rc = RTFileSeek(pSet->f.hFile, pSet->offTestCount, RTFILE_SEEK_BEGIN, NULL);
+    AssertRCReturn(rc, rc);
+    rc = audioTestManifestWrite(pSet, "%04RU32", pSet->cTests);
+    AssertRCReturn(rc, rc);
+
+    if (RTFileIsValid(pSet->f.hFile))
+    {
+        RTFileClose(pSet->f.hFile);
+        pSet->f.hFile = NIL_RTFILE;
+    }
+
+    return rc;
 }
 
@@ -860 +918 @@
 
     return rc;
+}
+
+int AudioTestSetTestBegin(PAUDIOTESTSET pSet, const char *pszDesc, PAUDIOTESTPARMS pParms, PAUDIOTESTENTRY *ppEntry)
+{
+    AssertReturn(pSet->cTestsRunning == 0, VERR_WRONG_ORDER); /* No test nesting allowed. */
+
+    PAUDIOTESTENTRY pEntry = (PAUDIOTESTENTRY)RTMemAllocZ(sizeof(AUDIOTESTENTRY));
+    AssertPtrReturn(pEntry, VERR_NO_MEMORY);
+
+    int rc = RTStrCopy(pEntry->szDesc, sizeof(pEntry->szDesc), pszDesc);
+    AssertRCReturn(rc, rc);
+
+    memcpy(&pEntry->Parms, pParms, sizeof(AUDIOTESTPARMS));
+    pEntry->pParent = pSet;
+
+    rc = audioTestManifestWrite(pSet, "\n");
+    AssertRCReturn(rc, rc);
+
+    rc = audioTestManifestWriteSectionHdr(pSet, "test%04RU32", pSet->cTests);
+    AssertRCReturn(rc, rc);
+
+    rc = audioTestManifestWrite(pSet, "desc=%s\n", pszDesc);
+    AssertRCReturn(rc, rc);
+
+    RTListAppend(&pSet->lstTest, &pEntry->Node);
+    pSet->cTests++;
+    pSet->cTestsRunning++;
+
+    *ppEntry = pEntry;
+
+    return rc;
+}
+
+int AudioTestSetTestFailed(PAUDIOTESTENTRY pEntry, int rc, const char *pszErr)
+{
+    AssertReturn(pEntry->pParent->cTestsRunning == 1,            VERR_WRONG_ORDER); /* No test nesting allowed. */
+    AssertReturn(pEntry->rc                     == VINF_SUCCESS, VERR_WRONG_ORDER);
+
+    pEntry->rc = rc;
+
+    int rc2 = audioTestManifestWrite(pEntry->pParent, "error_rc=%RI32\n", rc);
+    AssertRCReturn(rc2, rc2);
+    rc2 = audioTestManifestWrite(pEntry->pParent, "error_desc=%s", pszErr);
+    AssertRCReturn(rc2, rc2);
+
+    pEntry->pParent->cTestsRunning--;
+
+    return rc2;
+}
+
+int AudioTestSetTestDone(PAUDIOTESTENTRY pEntry)
+{
+    AssertReturn(pEntry->pParent->cTestsRunning == 1,            VERR_WRONG_ORDER); /* No test nesting allowed. */
+    AssertReturn(pEntry->rc                     == VINF_SUCCESS, VERR_WRONG_ORDER);
+
+    int rc2 = audioTestManifestWrite(pEntry->pParent, "error_rc=%RI32\n", VINF_SUCCESS);
+    AssertRCReturn(rc2, rc2);
+
+    pEntry->pParent->cTestsRunning--;
+
+    return rc2;
 }
 

trunk/src/VBox/Devices/Audio/AudioTest.h

@@ -158 +158 @@
 typedef AUDIOTESTPARMS *PAUDIOTESTPARMS;
 
+/**
+ * Enumeration for an audio test object type.
+ */
 typedef enum AUDIOTESTOBJTYPE
 {
+    /** Unknown / invalid, do not use. */
     AUDIOTESTOBJTYPE_UNKNOWN = 0,
+    /** The test object is a file. */
     AUDIOTESTOBJTYPE_FILE,
     /** The usual 32-bit hack. */
@@ -166 +171 @@
 } AUDIOTESTOBJTYPE;
 
+/**
+ * Structure for keeping an audio test object file.
+ */
 typedef struct AUDIOTESTOBJFILE
 {
     RTFILE hFile;
 } AUDIOTESTOBJFILE;
-
+/** Pointer to an audio test object file. */
+typedef AUDIOTESTOBJFILE *PAUDIOTESTOBJFILE;
+
+/**
+ * Structure for keeping a single audio test object.
+ *
+ * A test object is data which is needed in order to perform and verify one or
+ * more audio test case(s).
+ */
 typedef struct AUDIOTESTOBJ
 {
+    /** List node. */
     RTLISTNODE           Node;
+    /** Name of the test object.
+     *  Must not contain a path and has to be able to serialize to disk. */
     char                 szName[64];
+    /** The object type. */
     AUDIOTESTOBJTYPE     enmType;
+    /** Union for holding the object type-specific data. */
     union
     {
@@ -183 +204 @@
 /** Pointer to an audio test object. */
 typedef AUDIOTESTOBJ *PAUDIOTESTOBJ;
+
+struct AUDIOTESTSET;
+
+typedef struct AUDIOTESTENTRY
+{
+    /** List node. */
+    RTLISTNODE           Node;
+    AUDIOTESTSET        *pParent;
+    char                 szDesc[64];
+    AUDIOTESTPARMS       Parms;
+    int                  rc;
+} AUDIOTESTENTRY;
+/** Pointer to an audio test entry. */
+typedef AUDIOTESTENTRY *PAUDIOTESTENTRY;
 
 /**
@@ -200 +235 @@
         RTINIFILE    hIniFile;
     } f;
+    /** Number of test objects in lstObj. */
     uint32_t         cObj;
+    /** List containing PAUDIOTESTOBJ test object entries. */
     RTLISTANCHOR     lstObj;
+    /** Number of performed tests.
+     *  Not necessarily bound to the test object entries above. */
+    uint32_t         cTests;
+    /** Absolute offset (in bytes) where to write the "test_count" value later. */
+    uint64_t         offTestCount;
+    /** List containing PAUDIOTESTENTRY test entries. */
+    RTLISTANCHOR     lstTest;
+    /** Number of tests currently running. */
+    uint32_t         cTestsRunning;
+    /** Number of total (test) failures. */
+    uint32_t         cTotalFailures;
 } AUDIOTESTSET;
 /** Pointer to an audio test set. */
@@ -267 +315 @@
 int    AudioTestSetObjClose(PAUDIOTESTOBJ pObj);
 
+int    AudioTestSetTestBegin(PAUDIOTESTSET pSet, const char *pszDesc, PAUDIOTESTPARMS pParms, PAUDIOTESTENTRY *ppEntry);
+int    AudioTestSetTestFailed(PAUDIOTESTENTRY pEntry, int rc, const char *pszErr);
+int    AudioTestSetTestDone(PAUDIOTESTENTRY pEntry);
+
 int    AudioTestSetCreate(PAUDIOTESTSET pSet, const char *pszPath, const char *pszTag);
 int    AudioTestSetDestroy(PAUDIOTESTSET pSet);
 int    AudioTestSetOpen(PAUDIOTESTSET pSet, const char *pszPath);
-void   AudioTestSetClose(PAUDIOTESTSET pSet);
+int    AudioTestSetClose(PAUDIOTESTSET pSet);
 int    AudioTestSetWipe(PAUDIOTESTSET pSet);
 int    AudioTestSetPack(PAUDIOTESTSET pSet, const char *pszOutDir, char *pszFileName, size_t cbFileName);

trunk/src/VBox/ValidationKit/utils/audio/vkat.cpp

@@ -1215 +1215 @@
 
 /*********************************************************************************************************************************
-*   Implementation of Something                                                                                                  *
+*   Implementation of audio test environment handling                                                                            *
 *********************************************************************************************************************************/
 
@@ -1311 +1311 @@
 
 /*********************************************************************************************************************************
-*   Some other stuff, you name it.                                                                                               *
+*   Device enumeration + handling.                                                                                               *
 *********************************************************************************************************************************/
 
@@ -1613 +1613 @@
     for (uint32_t i = 0; i < pTstParms->cIterations; i++)
     {
-        AudioTestToneParamsInitRandom(&pTstParms->TestTone, &pTstParms->TestTone.Props);
-        rc = audioTestCreateStreamDefaultOut(pTstEnv, pStream, &pTstParms->TestTone.Props);
+        PAUDIOTESTENTRY pTst;
+        rc = AudioTestSetTestBegin(&pTstEnv->Set, "Playing test tone", pTstParms, &pTst);
         if (RT_SUCCESS(rc))
-            rc = audioTestPlayTone(pTstEnv, pStream, &pTstParms->TestTone);
-
-        int rc2 = audioTestStreamDestroy(pTstEnv, pStream);
-        if (RT_SUCCESS(rc))
-            rc = rc2;
+        {
+            AudioTestToneParamsInitRandom(&pTstParms->TestTone, &pTstParms->TestTone.Props);
+            rc = audioTestCreateStreamDefaultOut(pTstEnv, pStream, &pTstParms->TestTone.Props);
+            if (RT_SUCCESS(rc))
+            {
+                rc = audioTestPlayTone(pTstEnv, pStream, &pTstParms->TestTone);
+            }
+
+            int rc2 = audioTestStreamDestroy(pTstEnv, pStream);
+            if (RT_SUCCESS(rc))
+                rc = rc2;
+
+            if (RT_SUCCESS(rc))
+            {
+               AudioTestSetTestDone(pTst);
+            }
+            else
+                AudioTestSetTestFailed(pTst, rc, "Playing test tone failed");
+        }
+
+        if (RT_FAILURE(rc))
+            RTTestFailed(g_hTest, "Playing tone failed\n");
     }
 
@@ -1889 +1906 @@
             RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS, "Test set packed up to '%s'\n", szFileOut);
 
+#ifndef DEBUG_andy
         /* Clean up. */
         int rc2 = AudioTestSetWipe(&TstEnv.Set);
         AssertRC(rc2); /* Annoying, but not test-critical. */
-
+#endif
         audioTestEnvDestroy(&TstEnv);
     }