Add MinidumpCrashpadModule, its list form, their writers, and their tests

minidump/minidump_crashpad_module_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_crashpad_module_writer.h"
+
+#include <dbghelp.h>
+
+#include "gtest/gtest.h"
+#include "minidump/minidump_extensions.h"
+#include "minidump/minidump_simple_string_dictionary_writer.h"
+#include "minidump/test/minidump_file_writer_test_util.h"
+#include "minidump/test/minidump_string_writer_test_util.h"
+#include "minidump/test/minidump_writable_test_util.h"
+#include "util/file/string_file_writer.h"
+
+namespace crashpad {
+namespace test {
+namespace {
+
+const MinidumpCrashpadModuleList* MinidumpCrashpadModuleListAtStart(
+    const std::string& file_contents,
+    size_t count) {
+  MINIDUMP_LOCATION_DESCRIPTOR location_descriptor;
+  location_descriptor.DataSize = sizeof(MinidumpCrashpadModuleList) +
+                                 count * sizeof(MINIDUMP_LOCATION_DESCRIPTOR);
+  location_descriptor.Rva = 0;
+  return MinidumpWritableAtLocationDescriptor<MinidumpCrashpadModuleList>(
+      file_contents, location_descriptor);
+}
+
+TEST(MinidumpCrashpadModuleWriter, EmptyList) {
+  StringFileWriter file_writer;
+
+  MinidumpCrashpadModuleListWriter crashpad_module_list_writer;
+
+  EXPECT_TRUE(crashpad_module_list_writer.WriteEverything(&file_writer));
+  ASSERT_EQ(sizeof(MinidumpCrashpadModuleList), file_writer.string().size());
+
+  const MinidumpCrashpadModuleList* crashpad_module_list =
+      MinidumpCrashpadModuleListAtStart(file_writer.string(), 0);
+  ASSERT_TRUE(crashpad_module_list);
+
+  EXPECT_EQ(0u, crashpad_module_list->count);
+}
+
+TEST(MinidumpCrashpadModuleWriter, EmptyModule) {
+  StringFileWriter file_writer;
+
+  MinidumpCrashpadModuleListWriter crashpad_module_list_writer;
+  MinidumpCrashpadModuleWriter crashpad_module_writer;
+  crashpad_module_list_writer.AddCrashpadModule(&crashpad_module_writer);
+
+  EXPECT_TRUE(crashpad_module_list_writer.WriteEverything(&file_writer));
+  ASSERT_EQ(sizeof(MinidumpCrashpadModuleList) +
+                sizeof(MINIDUMP_LOCATION_DESCRIPTOR) +
+                sizeof(MinidumpCrashpadModule),
+            file_writer.string().size());
+
+  const MinidumpCrashpadModuleList* crashpad_module_list =
+      MinidumpCrashpadModuleListAtStart(file_writer.string(), 1);
+  ASSERT_TRUE(crashpad_module_list);
+
+  ASSERT_EQ(1u, crashpad_module_list->count);
+
+  const MinidumpCrashpadModule* crashpad_module =
+      MinidumpWritableAtLocationDescriptor<MinidumpCrashpadModule>(
+          file_writer.string(), crashpad_module_list->crashpad_modules[0]);
+  ASSERT_TRUE(crashpad_module);
+
+  EXPECT_EQ(MinidumpCrashpadModule::kVersion, crashpad_module->version);
+  EXPECT_EQ(0u, crashpad_module->minidump_module_list_index);
+  EXPECT_EQ(0u, crashpad_module->simple_annotations.DataSize);
+  EXPECT_EQ(0u, crashpad_module->simple_annotations.Rva);
+}
+
+TEST(MinidumpCrashpadModuleWriter, FullModule) {
+  const uint32_t kMinidumpModuleListIndex = 1;
+  const char kKey[] = "key";
+  const char kValue[] = "value";
+
+  StringFileWriter file_writer;
+
+  MinidumpCrashpadModuleListWriter crashpad_module_list_writer;
+
+  MinidumpCrashpadModuleWriter crashpad_module_writer;
+  crashpad_module_writer.SetMinidumpModuleListIndex(kMinidumpModuleListIndex);
+  MinidumpSimpleStringDictionaryWriter simple_string_dictionary_writer;
+  MinidumpSimpleStringDictionaryEntryWriter
+      simple_string_dictionary_entry_writer;
+  simple_string_dictionary_entry_writer.SetKeyValue(kKey, kValue);
+  simple_string_dictionary_writer.AddEntry(
+      &simple_string_dictionary_entry_writer);
+  crashpad_module_writer.SetSimpleAnnotations(&simple_string_dictionary_writer);
+  crashpad_module_list_writer.AddCrashpadModule(&crashpad_module_writer);
+
+  EXPECT_TRUE(crashpad_module_list_writer.WriteEverything(&file_writer));
+  ASSERT_EQ(sizeof(MinidumpCrashpadModuleList) +
+                sizeof(MINIDUMP_LOCATION_DESCRIPTOR) +
+                sizeof(MinidumpCrashpadModule) +
+                sizeof(MinidumpSimpleStringDictionary) +
+                sizeof(MinidumpSimpleStringDictionaryEntry) +
+                sizeof(MinidumpUTF8String) + arraysize(kKey) +
+                sizeof(MinidumpUTF8String) + arraysize(kValue),
+            file_writer.string().size());
+
+  const MinidumpCrashpadModuleList* crashpad_module_list =
+      MinidumpCrashpadModuleListAtStart(file_writer.string(), 1);
+  ASSERT_TRUE(crashpad_module_list);
+
+  ASSERT_EQ(1u, crashpad_module_list->count);
+
+  const MinidumpCrashpadModule* crashpad_module =
+      MinidumpWritableAtLocationDescriptor<MinidumpCrashpadModule>(
+          file_writer.string(), crashpad_module_list->crashpad_modules[0]);
+  ASSERT_TRUE(crashpad_module);
+
+  EXPECT_EQ(MinidumpCrashpadModule::kVersion, crashpad_module->version);
+  EXPECT_EQ(kMinidumpModuleListIndex,
+            crashpad_module->minidump_module_list_index);
+  EXPECT_NE(0u, crashpad_module->simple_annotations.DataSize);
+  EXPECT_NE(0u, crashpad_module->simple_annotations.Rva);
+
+  const MinidumpSimpleStringDictionary* simple_annotations =
+      MinidumpWritableAtLocationDescriptor<MinidumpSimpleStringDictionary>(
+          file_writer.string(), crashpad_module->simple_annotations);
+  ASSERT_TRUE(simple_annotations);
+
+  ASSERT_EQ(1u, simple_annotations->count);
+  EXPECT_EQ(kKey,
+            MinidumpUTF8StringAtRVAAsString(
+                file_writer.string(), simple_annotations->entries[0].key));
+  EXPECT_EQ(kValue,
+            MinidumpUTF8StringAtRVAAsString(
+                file_writer.string(), simple_annotations->entries[0].value));
+}
+
+TEST(MinidumpCrashpadModuleWriter, ThreeModules) {
+  const uint32_t kMinidumpModuleListIndex0 = 0;
+  const char kKey0[] = "key";
+  const char kValue0[] = "value";
+  const uint32_t kMinidumpModuleListIndex1 = 2;
+  const uint32_t kMinidumpModuleListIndex2 = 5;
+  const char kKey2A[] = "K";
+  const char kValue2A[] = "VVV";
+  const char kKey2B[] = "river";
+  const char kValue2B[] = "hudson";
+
+  StringFileWriter file_writer;
+
+  MinidumpCrashpadModuleListWriter crashpad_module_list_writer;
+
+  MinidumpCrashpadModuleWriter crashpad_module_writer_0;
+  crashpad_module_writer_0.SetMinidumpModuleListIndex(
+      kMinidumpModuleListIndex0);
+  MinidumpSimpleStringDictionaryWriter simple_string_dictionary_writer_0;
+  MinidumpSimpleStringDictionaryEntryWriter
+      simple_string_dictionary_entry_writer_0;
+  simple_string_dictionary_entry_writer_0.SetKeyValue(kKey0, kValue0);
+  simple_string_dictionary_writer_0.AddEntry(
+      &simple_string_dictionary_entry_writer_0);
+  crashpad_module_writer_0.SetSimpleAnnotations(
+      &simple_string_dictionary_writer_0);
+  crashpad_module_list_writer.AddCrashpadModule(&crashpad_module_writer_0);
+
+  MinidumpCrashpadModuleWriter crashpad_module_writer_1;
+  crashpad_module_writer_1.SetMinidumpModuleListIndex(
+      kMinidumpModuleListIndex1);
+  crashpad_module_list_writer.AddCrashpadModule(&crashpad_module_writer_1);
+
+  MinidumpCrashpadModuleWriter crashpad_module_writer_2;
+  crashpad_module_writer_2.SetMinidumpModuleListIndex(
+      kMinidumpModuleListIndex2);
+  MinidumpSimpleStringDictionaryWriter simple_string_dictionary_writer_2;
+  MinidumpSimpleStringDictionaryEntryWriter
+      simple_string_dictionary_entry_writer_2a;
+  simple_string_dictionary_entry_writer_2a.SetKeyValue(kKey2A, kValue2A);
+  simple_string_dictionary_writer_2.AddEntry(
+      &simple_string_dictionary_entry_writer_2a);
+  MinidumpSimpleStringDictionaryEntryWriter
+      simple_string_dictionary_entry_writer_2b;
+  simple_string_dictionary_entry_writer_2b.SetKeyValue(kKey2B, kValue2B);
+  simple_string_dictionary_writer_2.AddEntry(
+      &simple_string_dictionary_entry_writer_2b);
+  crashpad_module_writer_2.SetSimpleAnnotations(
+      &simple_string_dictionary_writer_2);
+  crashpad_module_list_writer.AddCrashpadModule(&crashpad_module_writer_2);
+
+  EXPECT_TRUE(crashpad_module_list_writer.WriteEverything(&file_writer));
+
+  const MinidumpCrashpadModuleList* crashpad_module_list =
+      MinidumpCrashpadModuleListAtStart(file_writer.string(), 3);
+  ASSERT_TRUE(crashpad_module_list);
+
+  ASSERT_EQ(3u, crashpad_module_list->count);
+
+  const MinidumpCrashpadModule* crashpad_module_0 =
+      MinidumpWritableAtLocationDescriptor<MinidumpCrashpadModule>(
+          file_writer.string(), crashpad_module_list->crashpad_modules[0]);
+  ASSERT_TRUE(crashpad_module_0);
+
+  EXPECT_EQ(MinidumpCrashpadModule::kVersion, crashpad_module_0->version);
+  EXPECT_EQ(kMinidumpModuleListIndex0,
+            crashpad_module_0->minidump_module_list_index);
+
+  const MinidumpSimpleStringDictionary* simple_annotations_0 =
+      MinidumpWritableAtLocationDescriptor<MinidumpSimpleStringDictionary>(
+          file_writer.string(), crashpad_module_0->simple_annotations);
+  ASSERT_TRUE(simple_annotations_0);
+
+  ASSERT_EQ(1u, simple_annotations_0->count);
+  EXPECT_EQ(kKey0,
+            MinidumpUTF8StringAtRVAAsString(
+                file_writer.string(), simple_annotations_0->entries[0].key));
+  EXPECT_EQ(kValue0,
+            MinidumpUTF8StringAtRVAAsString(
+                file_writer.string(), simple_annotations_0->entries[0].value));
+
+  const MinidumpCrashpadModule* crashpad_module_1 =
+      MinidumpWritableAtLocationDescriptor<MinidumpCrashpadModule>(
+          file_writer.string(), crashpad_module_list->crashpad_modules[1]);
+  ASSERT_TRUE(crashpad_module_1);
+
+  EXPECT_EQ(MinidumpCrashpadModule::kVersion, crashpad_module_1->version);
+  EXPECT_EQ(kMinidumpModuleListIndex1,
+            crashpad_module_1->minidump_module_list_index);
+
+  const MinidumpSimpleStringDictionary* simple_annotations_1 =
+      MinidumpWritableAtLocationDescriptor<MinidumpSimpleStringDictionary>(
+          file_writer.string(), crashpad_module_1->simple_annotations);
+  EXPECT_FALSE(simple_annotations_1);
+
+  const MinidumpCrashpadModule* crashpad_module_2 =
+      MinidumpWritableAtLocationDescriptor<MinidumpCrashpadModule>(
+          file_writer.string(), crashpad_module_list->crashpad_modules[2]);
+  ASSERT_TRUE(crashpad_module_2);
+
+  EXPECT_EQ(MinidumpCrashpadModule::kVersion, crashpad_module_2->version);
+  EXPECT_EQ(kMinidumpModuleListIndex2,
+            crashpad_module_2->minidump_module_list_index);
+
+  const MinidumpSimpleStringDictionary* simple_annotations_2 =
+      MinidumpWritableAtLocationDescriptor<MinidumpSimpleStringDictionary>(
+          file_writer.string(), crashpad_module_2->simple_annotations);
+  ASSERT_TRUE(simple_annotations_2);
+
+  ASSERT_EQ(2u, simple_annotations_2->count);
+  EXPECT_EQ(kKey2A,
+            MinidumpUTF8StringAtRVAAsString(
+                file_writer.string(), simple_annotations_2->entries[0].key));
+  EXPECT_EQ(kValue2A,
+            MinidumpUTF8StringAtRVAAsString(
+                file_writer.string(), simple_annotations_2->entries[0].value));
+  EXPECT_EQ(kKey2B,
+            MinidumpUTF8StringAtRVAAsString(
+                file_writer.string(), simple_annotations_2->entries[1].key));
+  EXPECT_EQ(kValue2B,
+            MinidumpUTF8StringAtRVAAsString(
+                file_writer.string(), simple_annotations_2->entries[1].value));
+}
+
+}  // namespace
+}  // namespace test
+}  // namespace crashpad