SERVER-31026 Properly format UUIDs in BSONElement::toString

1 files changed, 87 insertions, 0 deletions

diff --git a/src/mongo/bson/bsonelement_test.cpp b/src/mongo/bson/bsonelement_test.cpp
new file mode 100644
index 00000000000..cca5dbb7ed4
--- /dev/null
+++ b/src/mongo/bson/bsonelement_test.cpp
@@ -0,0 +1,87 @@
+/**
+ *    Copyright (C) 2017 MongoDB Inc.
+ *
+ *    This program is free software: you can redistribute it and/or  modify
+ *    it under the terms of the GNU Affero General Public License, version 3,
+ *    as published by the Free Software Foundation.
+ *
+ *    This program is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *    GNU Affero General Public License for more details.
+ *
+ *    You should have received a copy of the GNU Affero General Public License
+ *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ *    As a special exception, the copyright holders give permission to link the
+ *    code of portions of this program with the OpenSSL library under certain
+ *    conditions as described in each individual source file and distribute
+ *    linked combinations including the program with the OpenSSL library. You
+ *    must comply with the GNU Affero General Public License in all respects for
+ *    all of the code used other than as permitted herein. If you modify file(s)
+ *    with this exception, you may extend this exception to your version of the
+ *    file(s), but you are not obligated to do so. If you do not wish to do so,
+ *    delete this exception statement from your version. If you delete this
+ *    exception statement from all source files in the program, then also delete
+ *    it in the license file.
+ */
+
+#include "mongo/platform/basic.h"
+
+#include "mongo/bson/bsonelement.h"
+#include "mongo/bson/bsonobj.h"
+#include "mongo/bson/bsonobjbuilder.h"
+#include "mongo/unittest/unittest.h"
+#include "mongo/util/uuid.h"
+
+namespace mongo {
+namespace {
+
+TEST(BSONElement, BinDataToString) {
+    BSONObjBuilder builder;
+    unsigned char bintype0[] = {0xDE, 0xEA, 0xBE, 0xEF, 0x01};  // Random BinData shorter than UUID
+
+    const UUID validUUID = UUID::gen();
+    unsigned char zeroUUID[16] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
+    unsigned char overlongUUID[] = {0xBF,
+                                    0xF7,
+                                    0x1F,
+                                    0x75,
+                                    0x04,
+                                    0x67,
+                                    0x45,
+                                    0xA4,
+                                    0x9A,
+                                    0x06,
+                                    0xE9,
+                                    0xBB,
+                                    0x02,
+                                    0x72,
+                                    0x81,
+                                    0x64,
+                                    0xff};  // Valid RFC4122v4 UUID, but with extra byte added.
+    unsigned char zeroLength[] = {};
+    StringData unknownType = "binary data\000with an unknown type"_sd;  // No terminating zero
+    const BinDataType unknownBinDataType = BinDataType(42);
+    builder.appendBinData("bintype0", sizeof(bintype0), BinDataGeneral, bintype0);
+    validUUID.appendToBuilder(&builder, "validUUID");
+    builder.appendBinData("zeroUUID", sizeof(zeroUUID), newUUID, zeroUUID);
+    builder.appendBinData("overlongUUID", sizeof(overlongUUID), newUUID, overlongUUID);
+    builder.appendBinData("zeroLength", 0, BinDataGeneral, zeroLength);
+    builder.appendBinData(
+        "unknownType", unknownType.size(), unknownBinDataType, unknownType.rawData());
+
+    BSONObj obj = builder.obj();
+    ASSERT_EQ(obj["bintype0"].toString(), "bintype0: BinData(0, DEEABEEF01)");
+    ASSERT_EQ(obj["validUUID"].toString(), "validUUID: UUID(\"" + validUUID.toString() + "\")");
+    ASSERT_EQ(obj["zeroUUID"].toString(),
+              "zeroUUID: UUID(\"00000000-0000-0000-0000-000000000000\")");
+    ASSERT_EQ(obj["overlongUUID"].toString(),
+              "overlongUUID: BinData(4, BFF71F75046745A49A06E9BB02728164FF)");
+    ASSERT_EQ(obj["zeroLength"].toString(), "zeroLength: BinData(0, )");
+    ASSERT_EQ(obj["unknownType"].toString(),
+              "unknownType: BinData(42, "
+              "62696E6172792064617461007769746820616E20756E6B6E6F776E2074797065)");
+}
+}  // namespace
+}  // namespace mongo