MB-30278: Subdoc regression tests for backtick un-escaping issue

Regression tests for how KV-Engine subdoc API uses subjson to parse
backticked escaped paths.

Change-Id: I42a144ba3f37c38d3e4ca0f8990652cda85011c2
Reviewed-on: http://review.couchbase.org/96259
Well-Formed: Build Bot <[email protected]>
Reviewed-by: Tim Bradgate <[email protected]>
Tested-by: Build Bot <[email protected]>

Author: daverigby

tests/testapp/testapp.cc

@@ -944,18 +944,18 @@ void validate_object(const char *key, const std::string& expected_value) {
     safe_send(send.bytes, len, false);
 
     std::vector<char> receive;
-    receive.resize(sizeof(protocol_binary_response_get) + expected_value.size());
-
-    safe_recv_packet(receive.data(), receive.size());
+    safe_recv_packet(receive);
 
     auto* response = reinterpret_cast<protocol_binary_response_no_extras*>(receive.data());
     mcbp_validate_response_header(response, PROTOCOL_BINARY_CMD_GET,
                                   PROTOCOL_BINARY_RESPONSE_SUCCESS);
     char* ptr = receive.data() + sizeof(*response) + 4;
-    size_t vallen = response->message.header.response.getBodylen() - 4;
-    ASSERT_EQ(expected_value.size(), vallen);
-    std::string actual(ptr, vallen);
-    EXPECT_EQ(expected_value, actual);
+    if (response->message.header.response.getStatus() ==
+        PROTOCOL_BINARY_RESPONSE_SUCCESS) {
+        size_t vallen = response->message.header.response.getBodylen() - 4;
+        std::string actual(ptr, vallen);
+        EXPECT_EQ(expected_value, actual);
+    }
 }
 
 void validate_flags(const char *key, uint32_t expected_flags) {
@@ -1352,6 +1352,10 @@ bool safe_recv_packet(std::vector<uint8_t>& buf) {
     return safe_recv_packetT(buf);
 }
 
+bool safe_recv_packet(std::vector<char>& buf) {
+    return safe_recv_packetT(buf);
+}
+
 // Configues the ewouldblock_engine to use the given mode; value
 // is a mode-specific parameter.
 void TestappTest::ewouldblock_engine_configure(ENGINE_ERROR_CODE err_code,

tests/testapp/testapp.h

@@ -434,6 +434,7 @@ bool safe_recv(void *buf, size_t len);
  */
 bool safe_recv_packet(void *buf, size_t size);
 bool safe_recv_packet(std::vector<uint8_t>& buf);
+bool safe_recv_packet(std::vector<char>& buf);
 
 /* Whether receiving an EOF during a read is considered an error */
 void set_allow_closed_read(bool enabled);

tests/testapp/testapp_subdoc.cc

@@ -1856,6 +1856,34 @@ TEST_P(SubdocTestappTest, SubdocUTF8ValTest) {
     validate_object("dict", "{ \"key1\": \"Ẇ̴̷̦͔͖͚̝̟̋̽ͪ̾ͤ̈́ͯͮͮ̀͗̌ͭ̾͜h̨̥̞͖̬̠͍͖̘̹͎͌̇̂̃ͯͣ͗̆̌̑ͨ̍̊ͪ̆̾̆̚͟͞ȧ̛̰̞̗̞̬̣̹͎̰̝͍͈̮̖̘̫̤̟͆̈́̒͗ͦ̋̓̌̊̋͝ͅţ͒ͮ͋̋̔̽ͥ̂ͭ̒̉̔̃ͫ̌̆̆҉̹͙̟̩̖̩̹̳̜͚̜̜ ͎̲͕̺̔̿̀͒̈́̏̌ͬͫ͒͂ͩͦ̀͝â̢̡̘̫̮̞̩̰̎ͨ̾ͤ̈́͑̉̈ͧ͆̃ͩ͆̚͡ ̧̢̛̙͔̰̹̲̱͔̤̝͖̥͚͓̲̪̯̟̖̏͒̽ͬ̂ͫͩͭ͋̏͊̽͗͊̀ͭ̋͘c̵̴͐̉̇͂̋ͬ̇̃͊ͨ͗̆̄̊́͏̡̡̫̦̦͉̼̙̜͉̯̮̪̫͍̩̼̘̫̻͍o̸̷͕̭̼̺̤͖͚̯̪̥̘̪̼̝̩̮͕̥̟̐͒̏ͭͦͮ̒ͧ̔̉̅̂͜͢͡o̷̢̡͕̟͓̺͚̟̱̜̻͇̘͍̤͓̲ͣͫ̾͛͗̅̐̏͑͆͌̀͜ͅͅͅl̴̡̙̹͖̈̄̌͒ͣ͒̅̏̕ ͛̐̿͋ͦ͛͌̄ͫ̒ͪ͊̀ͤ̀̿͏̶̡҉҉̤͎͖v̸̵̱͇̲͎̩͚̩͈̙̜̳̞̭̯̩̻̮̪ͯ̋̔͗̃̊ͬͮ̄̃͛̂̒̍͘͘a̦̝͇̙̬̬̰̪͙̗̟͙̝̬͛͂͑ͣ̓͑̏ͤ̑̀̚̚͘l͊̔́͋̋ͫ̈́̿̈̉̀͏̡͍͇̲̙̺̮͠uͬ̄̋̔ͪͧͥ͛ͭ̏̅ͫ͊̚͏̧͈̠̱͇͉̦̫͎͠ę̸͔̯̭̤͕̱͈̖͖̯̭̞͈͖ͨ̑̌̓̈ͮ͂̆̀͟ͅ\" }");
 }
 
+// MB-30278: Perform a DICT_ADD followed by SD_GET to a path with backticks in
+// them; to verify the path caching of un-escaped components is correctly reset
+// between calls.
+TEST_P(SubdocTestappTest, MB_30278_SubdocBacktickLookup) {
+    // Test DICT_ADD where the element key contains a literal backtick.
+    store_document("doc", "{}");
+    // Add a key with literal backtick (which we escape by passing
+    // double-backtick)
+    EXPECT_SD_OK(BinprotSubdocCommand(
+            PROTOCOL_BINARY_CMD_SUBDOC_DICT_ADD, "doc", "key``", "\"value\""));
+    EXPECT_SD_GET("doc", "key``", "\"value\"");
+    validate_object("doc", R"({"key`":"value"})");
+}
+
+// MB-30278: Perform two DICT_ADD calls to paths with backticks in them;
+// to verify the path caching of un-escaped components is correctly reset
+// between calls.
+TEST_P(SubdocTestappTest, MB_30278_SubdocBacktickDictAdd) {
+    store_document("doc", "{}");
+    EXPECT_SD_OK(BinprotSubdocCommand(
+            PROTOCOL_BINARY_CMD_SUBDOC_DICT_ADD, "doc", "key``", "\"value\""));
+    EXPECT_SD_OK(BinprotSubdocCommand(PROTOCOL_BINARY_CMD_SUBDOC_DICT_ADD,
+                                      "doc",
+                                      "key2``",
+                                      "\"value2\""));
+    validate_object("doc", R"({"key`":"value","key2`":"value2"})");
+}
+
 INSTANTIATE_TEST_CASE_P(
         Subdoc,
         SubdocTestappTest,

tests/testapp/testapp_subdoc_multipath.cc

@@ -594,3 +594,28 @@ TEST_P(SubdocTestappTest, SubdocMultiMutation_AddDocFlagInavlidCas) {
                               "56"});
     expect_subdoc_cmd(mutation, PROTOCOL_BINARY_RESPONSE_EINVAL, {});
 }
+
+// MB-30278: Perform a multi-mutation with two paths with backticks in them.
+TEST_P(SubdocTestappTest, MB_30278_SubdocBacktickMultiMutation) {
+    store_document("dict", "{}");
+
+    SubdocMultiMutationCmd mutation;
+    mutation.key = "dict";
+    mutation.specs.push_back({PROTOCOL_BINARY_CMD_SUBDOC_DICT_ADD,
+                              SUBDOC_FLAG_NONE,
+                              "key1``",
+                              "1"});
+    mutation.specs.push_back({PROTOCOL_BINARY_CMD_SUBDOC_DICT_ADD,
+                              SUBDOC_FLAG_NONE,
+                              "key2``",
+                              "2"});
+    mutation.specs.push_back({PROTOCOL_BINARY_CMD_SUBDOC_DICT_ADD,
+                              SUBDOC_FLAG_NONE,
+                              "key3``",
+                              "3"});
+    expect_subdoc_cmd(mutation, PROTOCOL_BINARY_RESPONSE_SUCCESS, {});
+
+    validate_object("dict", R"({"key1`":1,"key2`":2,"key3`":3})");
+
+    delete_object("dict");
+}