Introduce MinidumpStringWriter and its test

minidump/minidump_string_writer_test.cc

+// Copyright 2014 The Crashpad Authors. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include "minidump/minidump_string_writer.h"
+
+#include <dbghelp.h>
+
+#include <string>
+
+#include "base/basictypes.h"
+#include "base/strings/string16.h"
+#include "base/strings/stringprintf.h"
+#include "gtest/gtest.h"
+#include "util/file/string_file_writer.h"
+
+namespace {
+
+using namespace crashpad;
+using namespace testing;
+
+const MINIDUMP_STRING* MinidumpStringCast(const StringFileWriter& file_writer) {
+  return reinterpret_cast<const MINIDUMP_STRING*>(&file_writer.string()[0]);
+}
+
+TEST(MinidumpStringWriter, MinidumpUTF16StringWriter) {
+  StringFileWriter file_writer;
+
+  {
+    SCOPED_TRACE("unset");
+    file_writer.Reset();
+    crashpad::internal::MinidumpUTF16StringWriter string_writer;
+    EXPECT_TRUE(string_writer.WriteEverything(&file_writer));
+    ASSERT_EQ(6u, file_writer.string().size());
+    const MINIDUMP_STRING* minidump_string = MinidumpStringCast(file_writer);
+    EXPECT_EQ(0u, minidump_string->Length);
+    EXPECT_EQ(0, minidump_string->Buffer[0]);
+  }
+
+  const struct {
+    size_t input_length;
+    const char* input_string;
+    size_t output_length;
+    const char16 output_string[10];
+  } kTestData[] = {
+      {0, "", 0, {}},
+      {1, "a", 1, {'a'}},
+      {2, "\0b", 2, {0, 'b'}},
+      {3, "cde", 3, {'c', 'd', 'e'}},
+      {9, "Hi world!", 9, {'H', 'i', ' ', 'w', 'o', 'r', 'l', 'd', '!'}},
+      {7, "ret\nurn", 7, {'r', 'e', 't', '\n', 'u', 'r', 'n'}},
+      {2, "\303\251", 1, {0x00e9}},  // é
+
+      // oóöőo
+      {8, "o\303\263\303\266\305\221o", 5, {'o', 0x00f3, 0x00f6, 0x151, 'o'}},
+      {4, "\360\220\204\202", 2, {0xd800, 0xdd02}},  // 𐄂 (non-BMP)
+  };
+
+  for (size_t index = 0; index < arraysize(kTestData); ++index) {
+    SCOPED_TRACE(base::StringPrintf(
+        "index %zu, input %s", index, kTestData[index].input_string));
+
+    // Make sure that the expected output string with its NUL terminator fits in
+    // the space provided.
+    ASSERT_EQ(
+        0,
+        kTestData[index]
+            .output_string[arraysize(kTestData[index].output_string) - 1]);
+
+    file_writer.Reset();
+    crashpad::internal::MinidumpUTF16StringWriter string_writer;
+    string_writer.SetUTF8(std::string(kTestData[index].input_string,
+                                      kTestData[index].input_length));
+    EXPECT_TRUE(string_writer.WriteEverything(&file_writer));
+
+    const size_t expected_utf16_units_with_nul =
+        kTestData[index].output_length + 1;
+    const size_t expected_utf16_bytes =
+        expected_utf16_units_with_nul * sizeof(MINIDUMP_STRING::Buffer[0]);
+    ASSERT_EQ(sizeof(MINIDUMP_STRING) + expected_utf16_bytes,
+              file_writer.string().size());
+    const MINIDUMP_STRING* minidump_string = MinidumpStringCast(file_writer);
+    EXPECT_EQ(
+        kTestData[index].output_length * sizeof(minidump_string->Buffer[0]),
+        minidump_string->Length);
+    EXPECT_EQ(0,
+              base::c16memcmp(kTestData[index].output_string,
+                              minidump_string->Buffer,
+                              expected_utf16_units_with_nul));
+  }
+}
+
+TEST(MinidumpStringWriter, ConvertInvalidUTF8ToUTF16) {
+  StringFileWriter file_writer;
+
+  const char* kTestData[] = {
+      "\200",  // continuation byte
+      "\300",  // start byte followed by EOF
+      "\310\177",  // start byte without continuation
+      "\340\200",  // EOF in middle of 3-byte sequence
+      "\340\200\115",  // invalid 3-byte sequence
+      "\303\0\251",  // NUL in middle of valid sequence
+  };
+
+  for (size_t index = 0; index < arraysize(kTestData); ++index) {
+    SCOPED_TRACE(
+        base::StringPrintf("index %zu, input %s", index, kTestData[index]));
+    file_writer.Reset();
+    crashpad::internal::MinidumpUTF16StringWriter string_writer;
+    string_writer.SetUTF8(kTestData[index]);
+    EXPECT_TRUE(string_writer.WriteEverything(&file_writer));
+
+    // The requirements for conversion of invalid UTF-8 input are lax. Make sure
+    // that at least enough data was written for a string that has one unit and
+    // a NUL terminator, make sure that the length field matches the length of
+    // data written, make sure the data is NUL-terminated, and make sure that at
+    // least one U+FFFD replacement character was written.
+    ASSERT_GE(file_writer.string().size(),
+              sizeof(MINIDUMP_STRING) + 2 * sizeof(MINIDUMP_STRING::Buffer[0]));
+    const MINIDUMP_STRING* minidump_string = MinidumpStringCast(file_writer);
+    EXPECT_EQ(file_writer.string().size() - sizeof(MINIDUMP_STRING) -
+                  sizeof(MINIDUMP_STRING::Buffer[0]),
+              minidump_string->Length);
+    size_t out_units =
+        minidump_string->Length / sizeof(minidump_string->Buffer[0]);
+    EXPECT_EQ(0, minidump_string->Buffer[out_units]);
+    EXPECT_NE(reinterpret_cast<char16*>(NULL),
+              base::c16memchr(minidump_string->Buffer, 0xfffd, out_units));
+  }
+}
+
+const MinidumpUTF8String* MinidumpUTF8StringCast(
+    const StringFileWriter& file_writer) {
+  return reinterpret_cast<const MinidumpUTF8String*>(&file_writer.string()[0]);
+}
+
+TEST(MinidumpStringWriter, MinidumpUTF8StringWriter) {
+  StringFileWriter file_writer;
+
+  {
+    SCOPED_TRACE("unset");
+    file_writer.Reset();
+    crashpad::internal::MinidumpUTF8StringWriter string_writer;
+    EXPECT_TRUE(string_writer.WriteEverything(&file_writer));
+    ASSERT_EQ(5u, file_writer.string().size());
+    const MinidumpUTF8String* minidump_string =
+        MinidumpUTF8StringCast(file_writer);
+    EXPECT_EQ(0u, minidump_string->Length);
+    EXPECT_EQ(0, minidump_string->Buffer[0]);
+  }
+
+  const struct {
+    size_t length;
+    const char* string;
+  } kTestData[] = {
+      {0, ""},
+      {1, "a"},
+      {2, "\0b"},
+      {3, "cde"},
+      {9, "Hi world!"},
+      {7, "ret\nurn"},
+      {2, "\303\251"},  // é
+
+      // oóöőo
+      {8, "o\303\263\303\266\305\221o"},
+      {4, "\360\220\204\202"},  // 𐄂 (non-BMP)
+  };
+
+  for (size_t index = 0; index < arraysize(kTestData); ++index) {
+    SCOPED_TRACE(base::StringPrintf(
+        "index %zu, input %s", index, kTestData[index].string));
+
+    file_writer.Reset();
+    crashpad::internal::MinidumpUTF8StringWriter string_writer;
+    string_writer.SetUTF8(
+        std::string(kTestData[index].string, kTestData[index].length));
+    EXPECT_TRUE(string_writer.WriteEverything(&file_writer));
+
+    const size_t expected_utf8_bytes_with_nul = kTestData[index].length + 1;
+    ASSERT_EQ(sizeof(MinidumpUTF8String) + expected_utf8_bytes_with_nul,
+              file_writer.string().size());
+    const MinidumpUTF8String* minidump_string =
+        MinidumpUTF8StringCast(file_writer);
+    EXPECT_EQ(kTestData[index].length, minidump_string->Length);
+    EXPECT_EQ(0,
+              memcmp(kTestData[index].string,
+                     minidump_string->Buffer,
+                     expected_utf8_bytes_with_nul));
+  }
+}
+
+}  // namespace