| 1 | /* $Id: tstRTJson.cpp 69111 2017-10-17 14:26:02Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * IPRT Testcase - JSON API.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2016-2017 Oracle Corporation
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 10 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 11 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 12 | * General Public License (GPL) as published by the Free Software
|
|---|
| 13 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 14 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 15 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 16 | *
|
|---|
| 17 | * The contents of this file may alternatively be used under the terms
|
|---|
| 18 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 19 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
|---|
| 20 | * VirtualBox OSE distribution, in which case the provisions of the
|
|---|
| 21 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 22 | *
|
|---|
| 23 | * You may elect to license modified versions of this file under the
|
|---|
| 24 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 25 | */
|
|---|
| 26 |
|
|---|
| 27 |
|
|---|
| 28 | /*********************************************************************************************************************************
|
|---|
| 29 | * Header Files *
|
|---|
| 30 | *********************************************************************************************************************************/
|
|---|
| 31 | #include <iprt/json.h>
|
|---|
| 32 | #include <iprt/string.h>
|
|---|
| 33 | #include <iprt/test.h>
|
|---|
| 34 |
|
|---|
| 35 | static const char *g_pszJson =
|
|---|
| 36 | "{\n"
|
|---|
| 37 | " \"number\": 100,\n"
|
|---|
| 38 | " \"string\": \"test\",\n"
|
|---|
| 39 | " \"array\": [1, 2, 3, 4, 5, \"6\"],\n"
|
|---|
| 40 | " \"subobject\":\n"
|
|---|
| 41 | " {\n"
|
|---|
| 42 | " \"false\": false,\n"
|
|---|
| 43 | " \"true\": true,\n"
|
|---|
| 44 | " \"null\": null\n"
|
|---|
| 45 | " }\n"
|
|---|
| 46 | "}\n";
|
|---|
| 47 |
|
|---|
| 48 | /**
|
|---|
| 49 | * Some basic tests to detect malformed JSON.
|
|---|
| 50 | */
|
|---|
| 51 | static void tstBasic(RTTEST hTest)
|
|---|
| 52 | {
|
|---|
| 53 | RTTestSub(hTest, "Basic valid/malformed tests");
|
|---|
| 54 | static struct
|
|---|
| 55 | {
|
|---|
| 56 | const char *pszJson;
|
|---|
| 57 | int iRcResult;
|
|---|
| 58 | } const aTests[] =
|
|---|
| 59 | {
|
|---|
| 60 | { "", VERR_JSON_MALFORMED },
|
|---|
| 61 | { ",", VERR_JSON_MALFORMED },
|
|---|
| 62 | { ":", VERR_JSON_MALFORMED },
|
|---|
| 63 | { " \n\t{", VERR_JSON_MALFORMED },
|
|---|
| 64 | { "}", VERR_JSON_MALFORMED },
|
|---|
| 65 | { "[", VERR_JSON_MALFORMED },
|
|---|
| 66 | { "]", VERR_JSON_MALFORMED },
|
|---|
| 67 | { "[ \"test\" : ", VERR_JSON_MALFORMED },
|
|---|
| 68 | { "null", VINF_SUCCESS },
|
|---|
| 69 | { "true", VINF_SUCCESS },
|
|---|
| 70 | { "false", VINF_SUCCESS },
|
|---|
| 71 | { "100", VINF_SUCCESS },
|
|---|
| 72 | { "\"test\"", VINF_SUCCESS },
|
|---|
| 73 | { "{ }", VINF_SUCCESS },
|
|---|
| 74 | { "[ ]", VINF_SUCCESS },
|
|---|
| 75 | { "[ 100, 200 ]", VINF_SUCCESS },
|
|---|
| 76 | { "{ \"1\": 1 }", VINF_SUCCESS },
|
|---|
| 77 | { "{ \"1\": 1, \"2\": 2 }", VINF_SUCCESS }
|
|---|
| 78 | };
|
|---|
| 79 | for (unsigned iTest = 0; iTest < RT_ELEMENTS(aTests); iTest++)
|
|---|
| 80 | {
|
|---|
| 81 | RTJSONVAL hJsonVal = NIL_RTJSONVAL;
|
|---|
| 82 | int rc = RTJsonParseFromString(&hJsonVal, aTests[iTest].pszJson, NULL);
|
|---|
| 83 | if (rc != aTests[iTest].iRcResult)
|
|---|
| 84 | RTTestFailed(hTest, "RTJsonParseFromString() for \"%s\" failed, expected %Rrc got %Rrc\n",
|
|---|
| 85 | aTests[iTest].pszJson, aTests[iTest].iRcResult, rc);
|
|---|
| 86 | if (RT_SUCCESS(rc))
|
|---|
| 87 | {
|
|---|
| 88 | if (hJsonVal != NIL_RTJSONVAL)
|
|---|
| 89 | RTJsonValueRelease(hJsonVal);
|
|---|
| 90 | else
|
|---|
| 91 | RTTestFailed(hTest, "RTJsonParseFromString() returned success but no value\n");
|
|---|
| 92 | }
|
|---|
| 93 | else if (hJsonVal != NIL_RTJSONVAL)
|
|---|
| 94 | RTTestFailed(hTest, "RTJsonParseFromString() failed but a JSON value was returned\n");
|
|---|
| 95 | }
|
|---|
| 96 | }
|
|---|
| 97 |
|
|---|
| 98 | /**
|
|---|
| 99 | * Checks that methods not indended for the given type return the correct error.
|
|---|
| 100 | */
|
|---|
| 101 | static void tstCorrectnessRcForInvalidType(RTTEST hTest, RTJSONVAL hJsonVal, RTJSONVALTYPE enmType)
|
|---|
| 102 | {
|
|---|
| 103 | bool fSavedMayPanic = RTAssertSetMayPanic(false);
|
|---|
| 104 | bool fSavedQuiet = RTAssertSetQuiet(true);
|
|---|
| 105 |
|
|---|
| 106 | if ( enmType != RTJSONVALTYPE_OBJECT
|
|---|
| 107 | && enmType != RTJSONVALTYPE_ARRAY)
|
|---|
| 108 | {
|
|---|
| 109 | /* The iterator API should return errors. */
|
|---|
| 110 | RTJSONIT hJsonIt = NIL_RTJSONIT;
|
|---|
| 111 | RTTEST_CHECK_RC(hTest, RTJsonIteratorBegin(hJsonVal, &hJsonIt), VERR_JSON_VALUE_INVALID_TYPE);
|
|---|
| 112 | }
|
|---|
| 113 |
|
|---|
| 114 | if (enmType != RTJSONVALTYPE_ARRAY)
|
|---|
| 115 | {
|
|---|
| 116 | /* The Array access methods should return errors. */
|
|---|
| 117 | uint32_t cItems = 0;
|
|---|
| 118 | RTJSONVAL hJsonValItem = NIL_RTJSONVAL;
|
|---|
| 119 | RTTEST_CHECK(hTest, RTJsonValueGetArraySize(hJsonVal) == 0);
|
|---|
| 120 | RTTEST_CHECK_RC(hTest, RTJsonValueQueryArraySize(hJsonVal, &cItems), VERR_JSON_VALUE_INVALID_TYPE);
|
|---|
| 121 | RTTEST_CHECK_RC(hTest, RTJsonValueQueryByIndex(hJsonVal, 0, &hJsonValItem), VERR_JSON_VALUE_INVALID_TYPE);
|
|---|
| 122 | }
|
|---|
| 123 |
|
|---|
| 124 | if (enmType != RTJSONVALTYPE_OBJECT)
|
|---|
| 125 | {
|
|---|
| 126 | /* The object access methods should return errors. */
|
|---|
| 127 | RTJSONVAL hJsonValMember = NIL_RTJSONVAL;
|
|---|
| 128 | RTTEST_CHECK_RC(hTest, RTJsonValueQueryByName(hJsonVal, "test", &hJsonValMember), VERR_JSON_VALUE_INVALID_TYPE);
|
|---|
| 129 | }
|
|---|
| 130 |
|
|---|
| 131 | if (enmType != RTJSONVALTYPE_NUMBER)
|
|---|
| 132 | {
|
|---|
| 133 | int64_t i64Num = 0;
|
|---|
| 134 | RTTEST_CHECK_RC(hTest, RTJsonValueQueryInteger(hJsonVal, &i64Num), VERR_JSON_VALUE_INVALID_TYPE);
|
|---|
| 135 | }
|
|---|
| 136 |
|
|---|
| 137 | if (enmType != RTJSONVALTYPE_STRING)
|
|---|
| 138 | {
|
|---|
| 139 | const char *psz = NULL;
|
|---|
| 140 | RTTEST_CHECK(hTest, RTJsonValueGetString(hJsonVal) == NULL);
|
|---|
| 141 | RTTEST_CHECK_RC(hTest, RTJsonValueQueryString(hJsonVal, &psz), VERR_JSON_VALUE_INVALID_TYPE);
|
|---|
| 142 | }
|
|---|
| 143 |
|
|---|
| 144 | RTAssertSetMayPanic(fSavedMayPanic);
|
|---|
| 145 | RTAssertSetQuiet(fSavedQuiet);
|
|---|
| 146 | }
|
|---|
| 147 |
|
|---|
| 148 | /**
|
|---|
| 149 | * Tests the array accessors.
|
|---|
| 150 | */
|
|---|
| 151 | static void tstArray(RTTEST hTest, RTJSONVAL hJsonVal)
|
|---|
| 152 | {
|
|---|
| 153 | uint32_t cItems = 0;
|
|---|
| 154 | RTTEST_CHECK(hTest, RTJsonValueGetArraySize(hJsonVal) == 6);
|
|---|
| 155 | RTTEST_CHECK_RC_OK(hTest, RTJsonValueQueryArraySize(hJsonVal, &cItems));
|
|---|
| 156 | RTTEST_CHECK(hTest, cItems == RTJsonValueGetArraySize(hJsonVal));
|
|---|
| 157 |
|
|---|
| 158 | for (uint32_t i = 1; i <= 5; i++)
|
|---|
| 159 | {
|
|---|
| 160 | int64_t i64Num = 0;
|
|---|
| 161 | RTJSONVAL hJsonValItem = NIL_RTJSONVAL;
|
|---|
| 162 | RTTEST_CHECK_RC_OK_RETV(hTest, RTJsonValueQueryByIndex(hJsonVal, i - 1, &hJsonValItem));
|
|---|
| 163 | RTTEST_CHECK(hTest, RTJsonValueGetType(hJsonValItem) == RTJSONVALTYPE_NUMBER);
|
|---|
| 164 | RTTEST_CHECK_RC_OK_RETV(hTest, RTJsonValueQueryInteger(hJsonValItem, &i64Num));
|
|---|
| 165 | RTTEST_CHECK(hTest, i64Num == (int64_t)i);
|
|---|
| 166 | RTTEST_CHECK(hTest, RTJsonValueRelease(hJsonValItem) == 1);
|
|---|
| 167 | }
|
|---|
| 168 |
|
|---|
| 169 | /* Last should be string. */
|
|---|
| 170 | const char *pszStr = NULL;
|
|---|
| 171 | RTJSONVAL hJsonValItem = NIL_RTJSONVAL;
|
|---|
| 172 | RTTEST_CHECK_RC_OK_RETV(hTest, RTJsonValueQueryByIndex(hJsonVal, 5, &hJsonValItem));
|
|---|
| 173 | RTTEST_CHECK(hTest, RTJsonValueGetType(hJsonValItem) == RTJSONVALTYPE_STRING);
|
|---|
| 174 | RTTEST_CHECK_RC_OK_RETV(hTest, RTJsonValueQueryString(hJsonValItem, &pszStr));
|
|---|
| 175 | RTTEST_CHECK(hTest, RTJsonValueGetString(hJsonValItem) == pszStr);
|
|---|
| 176 | RTTEST_CHECK(hTest, strcmp(pszStr, "6") == 0);
|
|---|
| 177 | RTTEST_CHECK(hTest, RTJsonValueRelease(hJsonValItem) == 1);
|
|---|
| 178 | }
|
|---|
| 179 |
|
|---|
| 180 | /**
|
|---|
| 181 | * Tests the iterator API for the given JSON array or object value.
|
|---|
| 182 | */
|
|---|
| 183 | static void tstIterator(RTTEST hTest, RTJSONVAL hJsonVal)
|
|---|
| 184 | {
|
|---|
| 185 | RTJSONIT hJsonIt = NIL_RTJSONIT;
|
|---|
| 186 | int rc = RTJsonIteratorBegin(hJsonVal, &hJsonIt);
|
|---|
| 187 | RTTEST_CHECK(hTest, RT_SUCCESS(rc));
|
|---|
| 188 | if (RT_SUCCESS(rc))
|
|---|
| 189 | {
|
|---|
| 190 | const char *pszName = NULL;
|
|---|
| 191 | RTJSONVAL hJsonValMember = NIL_RTJSONVAL;
|
|---|
| 192 | rc = RTJsonIteratorQueryValue(hJsonIt, &hJsonValMember, &pszName);
|
|---|
| 193 | RTTEST_CHECK(hTest, RT_SUCCESS(rc));
|
|---|
| 194 | RTTEST_CHECK(hTest, pszName != NULL);
|
|---|
| 195 | RTTEST_CHECK(hTest, hJsonValMember != NIL_RTJSONVAL);
|
|---|
| 196 | while (RT_SUCCESS(rc))
|
|---|
| 197 | {
|
|---|
| 198 | RTJSONVALTYPE enmTypeMember = RTJsonValueGetType(hJsonValMember);
|
|---|
| 199 | tstCorrectnessRcForInvalidType(hTest, hJsonValMember, enmTypeMember);
|
|---|
| 200 |
|
|---|
| 201 | switch (enmTypeMember)
|
|---|
| 202 | {
|
|---|
| 203 | case RTJSONVALTYPE_OBJECT:
|
|---|
| 204 | RTTEST_CHECK(hTest, strcmp(pszName, "subobject") == 0);
|
|---|
| 205 | tstIterator(hTest, hJsonValMember);
|
|---|
| 206 | break;
|
|---|
| 207 | case RTJSONVALTYPE_ARRAY:
|
|---|
| 208 | RTTEST_CHECK(hTest, strcmp(pszName, "array") == 0);
|
|---|
| 209 | tstArray(hTest, hJsonValMember);
|
|---|
| 210 | break;
|
|---|
| 211 | case RTJSONVALTYPE_STRING:
|
|---|
| 212 | {
|
|---|
| 213 | RTTEST_CHECK(hTest, strcmp(pszName, "string") == 0);
|
|---|
| 214 | const char *pszStr = NULL;
|
|---|
| 215 | RTTEST_CHECK_RC_OK(hTest, RTJsonValueQueryString(hJsonValMember, &pszStr));
|
|---|
| 216 | RTTEST_CHECK(hTest, strcmp(pszStr, "test") == 0);
|
|---|
| 217 | break;
|
|---|
| 218 | }
|
|---|
| 219 | case RTJSONVALTYPE_NUMBER:
|
|---|
| 220 | {
|
|---|
| 221 | RTTEST_CHECK(hTest, strcmp(pszName, "number") == 0);
|
|---|
| 222 | int64_t i64Num = 0;
|
|---|
| 223 | RTTEST_CHECK_RC_OK(hTest, RTJsonValueQueryInteger(hJsonValMember, &i64Num));
|
|---|
| 224 | RTTEST_CHECK(hTest, i64Num == 100);
|
|---|
| 225 | break;
|
|---|
| 226 | }
|
|---|
| 227 | case RTJSONVALTYPE_NULL:
|
|---|
| 228 | RTTEST_CHECK(hTest, strcmp(pszName, "null") == 0);
|
|---|
| 229 | break;
|
|---|
| 230 | case RTJSONVALTYPE_TRUE:
|
|---|
| 231 | RTTEST_CHECK(hTest, strcmp(pszName, "true") == 0);
|
|---|
| 232 | break;
|
|---|
| 233 | case RTJSONVALTYPE_FALSE:
|
|---|
| 234 | RTTEST_CHECK(hTest, strcmp(pszName, "false") == 0);
|
|---|
| 235 | break;
|
|---|
| 236 | default:
|
|---|
| 237 | RTTestFailed(hTest, "Invalid JSON value type %u returned\n", enmTypeMember);
|
|---|
| 238 | }
|
|---|
| 239 |
|
|---|
| 240 | RTTEST_CHECK(hTest, RTJsonValueRelease(hJsonValMember) == 1);
|
|---|
| 241 | rc = RTJsonIteratorNext(hJsonIt);
|
|---|
| 242 | RTTEST_CHECK(hTest, rc == VINF_SUCCESS || rc == VERR_JSON_ITERATOR_END);
|
|---|
| 243 | if (RT_SUCCESS(rc))
|
|---|
| 244 | RTTEST_CHECK_RC_OK(hTest, RTJsonIteratorQueryValue(hJsonIt, &hJsonValMember, &pszName));
|
|---|
| 245 | }
|
|---|
| 246 | RTJsonIteratorFree(hJsonIt);
|
|---|
| 247 | }
|
|---|
| 248 | }
|
|---|
| 249 |
|
|---|
| 250 | /**
|
|---|
| 251 | * Test that the parser returns the correct values for a valid JSON.
|
|---|
| 252 | */
|
|---|
| 253 | static void tstCorrectness(RTTEST hTest)
|
|---|
| 254 | {
|
|---|
| 255 | RTTestSub(hTest, "Correctness");
|
|---|
| 256 |
|
|---|
| 257 | RTJSONVAL hJsonVal = NIL_RTJSONVAL;
|
|---|
| 258 | RTTEST_CHECK_RC_OK_RETV(hTest, RTJsonParseFromString(&hJsonVal, g_pszJson, NULL));
|
|---|
| 259 |
|
|---|
| 260 | if (hJsonVal != NIL_RTJSONVAL)
|
|---|
| 261 | {
|
|---|
| 262 | RTJSONVALTYPE enmType = RTJsonValueGetType(hJsonVal);
|
|---|
| 263 | if (enmType == RTJSONVALTYPE_OBJECT)
|
|---|
| 264 | {
|
|---|
| 265 | /* Excercise the other non object APIs to return VERR_JSON_VALUE_INVALID_TYPE. */
|
|---|
| 266 | tstCorrectnessRcForInvalidType(hTest, hJsonVal, enmType);
|
|---|
| 267 | tstIterator(hTest, hJsonVal);
|
|---|
| 268 | }
|
|---|
| 269 | else
|
|---|
| 270 | RTTestFailed(hTest, "RTJsonParseFromString() returned an invalid JSON value, expected OBJECT got %u\n", enmType);
|
|---|
| 271 | RTTEST_CHECK(hTest, RTJsonValueRelease(hJsonVal) == 0);
|
|---|
| 272 | }
|
|---|
| 273 | else
|
|---|
| 274 | RTTestFailed(hTest, "RTJsonParseFromString() returned success but no value\n");
|
|---|
| 275 | }
|
|---|
| 276 |
|
|---|
| 277 | int main()
|
|---|
| 278 | {
|
|---|
| 279 | RTTEST hTest;
|
|---|
| 280 | int rc = RTTestInitAndCreate("tstRTJson", &hTest);
|
|---|
| 281 | if (rc)
|
|---|
| 282 | return rc;
|
|---|
| 283 | RTTestBanner(hTest);
|
|---|
| 284 |
|
|---|
| 285 | tstBasic(hTest);
|
|---|
| 286 | tstCorrectness(hTest);
|
|---|
| 287 |
|
|---|
| 288 | /*
|
|---|
| 289 | * Summary.
|
|---|
| 290 | */
|
|---|
| 291 | return RTTestSummaryAndDestroy(hTest);
|
|---|
| 292 | }
|
|---|
| 293 |
|
|---|
