tstGuestCtrlParseBuffer.cpp revision c7814cf6e1240a519cbec0441e033d0e2470ed00
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync * Output stream parsing test cases.
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync * Copyright (C) 2011-2012 Oracle Corporation
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync * available from http://www.virtualbox.org. This file is free software;
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync * you can redistribute it and/or modify it under the terms of the GNU
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync * General Public License (GPL) as published by the Free Software
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
9f3a515a29d45728a5c5330459abd3429e35bda1vboxsyncusing namespace com;
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync} VBOXGUESTCTRL_BUFFER_VALUE, *PVBOXGUESTCTRL_BUFFER_VALUE;
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsynctypedef std::map< RTCString, VBOXGUESTCTRL_BUFFER_VALUE > GuestBufferMap;
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsynctypedef std::map< RTCString, VBOXGUESTCTRL_BUFFER_VALUE >::iterator GuestBufferMapIter;
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsynctypedef std::map< RTCString, VBOXGUESTCTRL_BUFFER_VALUE >::const_iterator GuestBufferMapIterConst;
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsyncchar szUnterm2[] = { 'f', 'o', 'o', '3', '=', 'b', 'a', 'r', '3' };
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsyncstatic struct
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync const char *pbData;
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync * Single object parsing.
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync * An object is represented by one or multiple key=value pairs which are
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync * separated by a single "\0". If this termination is missing it will be assumed
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync * that we need to collect more data to do a successful parsing.
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync /* Invalid stuff. */
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync { "foo=bar1", 0, 0, 0, 0, VERR_INVALID_PARAMETER },
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync { "foo=bar2", 0, 50, 50, 0, VERR_INVALID_PARAMETER },
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync /* Empty buffers. */
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync /* Unterminated values (missing "\0"). */
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync { "test1", sizeof("test1"), 0, 0, 0, VERR_MORE_DATA },
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync { "test2=", sizeof("test2="), 0, 0, 0, VERR_MORE_DATA },
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync { "test3=test3", sizeof("test3=test3"), 0, 0, 0, VERR_MORE_DATA },
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync { "test4=test4\0t41", sizeof("test4=test4\0t41"), 0, sizeof("test4=test4\0") - 1, 1, VERR_MORE_DATA },
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync { "test5=test5\0t51=t51", sizeof("test5=test5\0t51=t51"), 0, sizeof("test5=test5\0") - 1, 1, VERR_MORE_DATA },
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync /* Next block unterminated. */
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync { "t51=t51\0t52=t52\0\0t53=t53", sizeof("t51=t51\0t52=t52\0\0t53=t53"), 0, sizeof("t51=t51\0t52=t52\0") - 1, 2, VINF_SUCCESS },
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync { "test6=test6\0\0t61=t61", sizeof("test6=test6\0\0t61=t61"), 0, sizeof("test6=test6\0") - 1, 1, VINF_SUCCESS },
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync /* Good stuff. */
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync { "test61=\0test611=test611\0", sizeof("test61=\0test611=test611\0"), 0, sizeof("test61=\0test611=test611\0") - 1, 2, VINF_SUCCESS },
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync { "test7=test7\0\0", sizeof("test7=test7\0\0"), 0, sizeof("test7=test7\0") - 1, 1, VINF_SUCCESS },
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync { "test8=test8\0t81=t81\0\0", sizeof("test8=test8\0t81=t81\0\0"), 0, sizeof("test8=test8\0t81=t81\0") - 1, 2, VINF_SUCCESS },
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync /* Good stuff, but with a second block -- should be *not* taken into account since
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync * we're only interested in parsing/handling the first object. */
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync { "t9=t9\0t91=t91\0\0t92=t92\0\0", sizeof("t9=t9\0t91=t91\0\0t92=t92\0\0"), 0, sizeof("t9=t9\0t91=t91\0") - 1, 2, VINF_SUCCESS },
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync /* Nasty stuff. */
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync { "���=f��\0\0", sizeof("���=f��\0\0"), 0, sizeof("���=f��\0") - 1, 1, VINF_SUCCESS },
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync { "���=f��\0���=���", sizeof("���=f��\0���=���"), 0, sizeof("���=f��\0") - 1, 1, VERR_MORE_DATA },
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync /* Some "real world" examples. */
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync { "hdr_id=vbt_stat\0hdr_ver=1\0name=foo.txt\0\0",
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync sizeof("hdr_id=vbt_stat\0hdr_ver=1\0name=foo.txt\0\0"),
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync 0, sizeof("hdr_id=vbt_stat\0hdr_ver=1\0name=foo.txt\0") - 1,
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsyncstatic struct
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync const char *pbData;
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync /** Number of data blocks retrieved. These are separated by "\0\0". */
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync /** Overall result when done parsing. */
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync /* No blocks. */
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync { "\0\0\0\0", sizeof("\0\0\0\0"), 0, VERR_NO_DATA },
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync /* Good stuff. */
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync { "\0b1=b1\0\0", sizeof("\0b1=b1\0\0"), 1, VERR_NO_DATA },
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync { "b1=b1\0\0", sizeof("b1=b1\0\0"), 1, VERR_NO_DATA },
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync { "b1=b1\0b2=b2\0\0", sizeof("b1=b1\0b2=b2\0\0"), 1, VERR_NO_DATA },
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync { "b1=b1\0b2=b2\0\0\0", sizeof("b1=b1\0b2=b2\0\0\0"), 1, VERR_NO_DATA }
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync static struct
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync const char *pbData;
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync { "test5=test5\0t51=t51", sizeof("test5=test5\0t51=t51"), 0, sizeof("test5=test5\0") - 1, 1, VERR_MORE_DATA },
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync { "\0\0test5=test5\0t51=t51", sizeof("\0\0test5=test5\0t51=t51"), 0, sizeof("\0\0test5=test5\0") - 1, 1, VERR_MORE_DATA },
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync unsigned iTest = 0;
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync RTTestIPrintf(RTTESTLVL_DEBUG, "Manual test #%d\n", iTest);
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync rc = stream.AddData((BYTE*)aTest[iTest].pbData, aTest[iTest].cbData);
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync RTTestIPrintf(RTTESTLVL_DEBUG, "\tReturned with rc=%Rrc, numItems=%ld\n",
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync int rc = RTTestInitAndCreate("tstParseBuffer", &hTest);
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync RTTestIPrintf(RTTESTLVL_DEBUG, "Initializing COM...\n");
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync RTTestFailed(hTest, "Failed to initialize COM (%Rhrc)!\n", hrc);
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync RTTestIPrintf(RTTESTLVL_INFO, "Doing basic tests ...\n");
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync RTTestFailed(hTest, "Basic size test #1 failed (%u <-> 10)", sizeof("sizecheck"));
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync RTTestFailed(hTest, "Basic size test #2 failed (%u <-> 7)", sizeof("off=rab"));
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync RTTestFailed(hTest, "Basic size test #3 failed (%u <-> 10)", sizeof("off=rab\0\0"));
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync RTTestIPrintf(RTTESTLVL_INFO, "Doing line tests ...\n");
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync /* Don't let the assertions trigger here
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync * -- we rely on the return values in the test(s) below. */
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync unsigned iTest = 0;
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync for (iTest; iTest < RT_ELEMENTS(aTestBlock); iTest++)
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync RTTestIPrintf(RTTESTLVL_DEBUG, "=> Test #%u\n", iTest);
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync int iResult = stream.AddData((BYTE*)aTestBlock[iTest].pbData, aTestBlock[iTest].cbData);
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync RTTestFailed(hTest, "\tReturned %Rrc, expected %Rrc\n",
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync else if (stream.GetOffset() != aTestBlock[iTest].uOffsetAfter)
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync RTTestFailed(hTest, "\tOffset %u wrong, expected %u\n",
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync stream.GetOffset(), aTestBlock[iTest].uOffsetAfter);
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync RTTestIPrintf(RTTESTLVL_DEBUG, "\tMore data (Offset: %u)\n", stream.GetOffset());
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync if (curBlock.GetCount() != aTestBlock[iTest].uMapElements)
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync RTTestFailed(hTest, "\tMap has %u elements, expected %u\n",
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync curBlock.GetCount(), aTestBlock[iTest].uMapElements);
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync /* There is remaining data left in the buffer (which needs to be merged
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync * with a following buffer) -- print it. */
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync size_t uToWrite = aTestBlock[iTest].cbData - uOffset;
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync const char *pszRemaining = aTestBlock[iTest].pbData;
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync RTTestIPrintf(RTTESTLVL_DEBUG, "\tRemaining (%u):\n", uToWrite);
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync /* How to properly get the current RTTESTLVL (aka IPRT_TEST_MAX_LEVEL) here?
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync * Hack alert: Using RTEnvGet for now. */
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync if (!RTStrICmp(RTEnvGet("IPRT_TEST_MAX_LEVEL"), "debug"))
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync RTStrmWriteEx(g_pStdOut, &aTestBlock[iTest].pbData[uOffset], uToWrite - 1, NULL);
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync RTTestIPrintf(RTTESTLVL_INFO, "Doing block tests ...\n");
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync for (iTest; iTest < RT_ELEMENTS(aTestStream); iTest++)
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync RTTestIPrintf(RTTESTLVL_DEBUG, "=> Block test #%u\n", iTest);
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync int iResult = stream.AddData((BYTE*)aTestStream[iTest].pbData, aTestStream[iTest].cbData);
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync RTTestIPrintf(RTTESTLVL_DEBUG, "\tReturned with %Rrc\n", iResult);
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync /* Only count block which have at least one pair. */
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync RTTestFailed(hTest, "\tReturned %Rrc, expected %Rrc\n",
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync else if (uNumBlocks != aTestStream[iTest].uNumBlocks)
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync RTTestFailed(hTest, "\tReturned %u blocks, expected %u\n",
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync RTTestFailed(hTest, "\tAdding data failed with %Rrc", iResult);
c0d22c23d3289cef0332f4d61ab15df48ed34979vboxsync RTTestIPrintf(RTTESTLVL_DEBUG, "Shutting down COM...\n");