minidump: Add InitializeFromSnapshot() for MinidumpModuleCrashpadInfoListWriter and downstream

minidump/minidump_simple_string_dictionary_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_simple_string_dictionary_writer.h"
 
+#include <map>
 #include <string>
 
 #include "gtest/gtest.h"
 #include "minidump/minidump_extensions.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 MinidumpSimpleStringDictionary* MinidumpSimpleStringDictionaryAtStart(
     const std::string& file_contents,
     size_t count) {
   MINIDUMP_LOCATION_DESCRIPTOR location_descriptor;
   location_descriptor.DataSize =
       sizeof(MinidumpSimpleStringDictionary) +
       count * sizeof(MinidumpSimpleStringDictionaryEntry);
   location_descriptor.Rva = 0;
   return MinidumpWritableAtLocationDescriptor<MinidumpSimpleStringDictionary>(
       file_contents, location_descriptor);
 }
 
 TEST(MinidumpSimpleStringDictionaryWriter, EmptySimpleStringDictionary) {
   StringFileWriter file_writer;
 
   MinidumpSimpleStringDictionaryWriter dictionary_writer;
 
+  EXPECT_FALSE(dictionary_writer.IsUseful());
+
   EXPECT_TRUE(dictionary_writer.WriteEverything(&file_writer));
   ASSERT_EQ(sizeof(MinidumpSimpleStringDictionary),
             file_writer.string().size());
 
   const MinidumpSimpleStringDictionary* dictionary =
       MinidumpSimpleStringDictionaryAtStart(file_writer.string(), 0);
   ASSERT_TRUE(dictionary);
   EXPECT_EQ(0u, dictionary->count);
 }
 
 TEST(MinidumpSimpleStringDictionaryWriter, EmptyKeyValue) {
   StringFileWriter file_writer;
 
   MinidumpSimpleStringDictionaryWriter dictionary_writer;
   auto entry_writer =
       make_scoped_ptr(new MinidumpSimpleStringDictionaryEntryWriter());
   dictionary_writer.AddEntry(entry_writer.Pass());
 
+  EXPECT_TRUE(dictionary_writer.IsUseful());
+
   EXPECT_TRUE(dictionary_writer.WriteEverything(&file_writer));
   ASSERT_EQ(sizeof(MinidumpSimpleStringDictionary) +
                 sizeof(MinidumpSimpleStringDictionaryEntry) +
                 2 * sizeof(MinidumpUTF8String) + 1 + 3 + 1,  // 3 for padding
             file_writer.string().size());
 
   const MinidumpSimpleStringDictionary* dictionary =
       MinidumpSimpleStringDictionaryAtStart(file_writer.string(), 1);
   ASSERT_TRUE(dictionary);
   EXPECT_EQ(1u, dictionary->count);
@@ skipping 12 matching lines @@
 
   char kKey[] = "key";
   char kValue[] = "value";
 
   MinidumpSimpleStringDictionaryWriter dictionary_writer;
   auto entry_writer =
       make_scoped_ptr(new MinidumpSimpleStringDictionaryEntryWriter());
   entry_writer->SetKeyValue(kKey, kValue);
   dictionary_writer.AddEntry(entry_writer.Pass());
 
+  EXPECT_TRUE(dictionary_writer.IsUseful());
+
   EXPECT_TRUE(dictionary_writer.WriteEverything(&file_writer));
   ASSERT_EQ(sizeof(MinidumpSimpleStringDictionary) +
                 sizeof(MinidumpSimpleStringDictionaryEntry) +
                 2 * sizeof(MinidumpUTF8String) + sizeof(kKey) + sizeof(kValue),
             file_writer.string().size());
 
   const MinidumpSimpleStringDictionary* dictionary =
       MinidumpSimpleStringDictionaryAtStart(file_writer.string(), 1);
   ASSERT_TRUE(dictionary);
   EXPECT_EQ(1u, dictionary->count);
@@ skipping 24 matching lines @@
   dictionary_writer.AddEntry(entry_writer_0.Pass());
   auto entry_writer_1 =
       make_scoped_ptr(new MinidumpSimpleStringDictionaryEntryWriter());
   entry_writer_1->SetKeyValue(kKey1, kValue1);
   dictionary_writer.AddEntry(entry_writer_1.Pass());
   auto entry_writer_2 =
       make_scoped_ptr(new MinidumpSimpleStringDictionaryEntryWriter());
   entry_writer_2->SetKeyValue(kKey2, kValue2);
   dictionary_writer.AddEntry(entry_writer_2.Pass());
 
+  EXPECT_TRUE(dictionary_writer.IsUseful());
+
   EXPECT_TRUE(dictionary_writer.WriteEverything(&file_writer));
   ASSERT_EQ(sizeof(MinidumpSimpleStringDictionary) +
                 3 * sizeof(MinidumpSimpleStringDictionaryEntry) +
                 6 * sizeof(MinidumpUTF8String) + sizeof(kKey2) +
                 sizeof(kValue2) + 3 + sizeof(kKey0) + 1 + sizeof(kValue0) + 1 +
                 sizeof(kKey1) + 3 + sizeof(kValue1),
             file_writer.string().size());
 
   const MinidumpSimpleStringDictionary* dictionary =
       MinidumpSimpleStringDictionaryAtStart(file_writer.string(), 3);
@@ skipping 42 matching lines @@
   MinidumpSimpleStringDictionaryWriter dictionary_writer;
   auto entry_writer_0 =
       make_scoped_ptr(new MinidumpSimpleStringDictionaryEntryWriter());
   entry_writer_0->SetKeyValue(kKey, kValue0);
   dictionary_writer.AddEntry(entry_writer_0.Pass());
   auto entry_writer_1 =
       make_scoped_ptr(new MinidumpSimpleStringDictionaryEntryWriter());
   entry_writer_1->SetKeyValue(kKey, kValue1);
   dictionary_writer.AddEntry(entry_writer_1.Pass());
 
+  EXPECT_TRUE(dictionary_writer.IsUseful());
+
   EXPECT_TRUE(dictionary_writer.WriteEverything(&file_writer));
   ASSERT_EQ(sizeof(MinidumpSimpleStringDictionary) +
                 sizeof(MinidumpSimpleStringDictionaryEntry) +
                 2 * sizeof(MinidumpUTF8String) + sizeof(kKey) + sizeof(kValue1),
             file_writer.string().size());
 
   const MinidumpSimpleStringDictionary* dictionary =
       MinidumpSimpleStringDictionaryAtStart(file_writer.string(), 1);
   ASSERT_TRUE(dictionary);
   EXPECT_EQ(1u, dictionary->count);
   EXPECT_EQ(12u, dictionary->entries[0].key);
   EXPECT_EQ(20u, dictionary->entries[0].value);
   EXPECT_EQ(kKey,
             MinidumpUTF8StringAtRVAAsString(file_writer.string(),
                                             dictionary->entries[0].key));
   EXPECT_EQ(kValue1,
             MinidumpUTF8StringAtRVAAsString(file_writer.string(),
                                             dictionary->entries[0].value));
 }
 
+TEST(MinidumpSimpleStringDictionaryWriter, InitializeFromMap) {
+  char kKey0[] = "Dictionaries";
+  char kValue0[] = "USEFUL*";
+  char kKey1[] = "#1 Key!";
+  char kValue1[] = "";
+  char kKey2[] = "key two";
+  char kValue2[] = "value two";
+
+  std::map<std::string, std::string> map;
+  map[kKey0] = kValue0;
+  map[kKey1] = kValue1;
+  map[kKey2] = kValue2;
+
+  MinidumpSimpleStringDictionaryWriter dictionary_writer;
+  dictionary_writer.InitializeFromMap(map);
+
+  EXPECT_TRUE(dictionary_writer.IsUseful());
+
+  StringFileWriter file_writer;
+  ASSERT_TRUE(dictionary_writer.WriteEverything(&file_writer));
+
+  const MinidumpSimpleStringDictionary* dictionary =
+      MinidumpSimpleStringDictionaryAtStart(file_writer.string(), map.size());
+  ASSERT_TRUE(dictionary);
+  ASSERT_EQ(3u, dictionary->count);
+
+  // The entries don’t appear in the order they were added. The current
+  // implementation uses a std::map and sorts keys, so the entires appear in
+  // alphabetical order. However, this is an implementation detail, and it’s OK
+  // if the writer stops sorting in this order. Testing for a specific order is
+  // just the easiest way to write this test while the writer will output things
+  // in a known order.
+  EXPECT_EQ(kKey1,
+            MinidumpUTF8StringAtRVAAsString(file_writer.string(),
+                                            dictionary->entries[0].key));
+  EXPECT_EQ(kValue1,
+            MinidumpUTF8StringAtRVAAsString(file_writer.string(),
+                                            dictionary->entries[0].value));
+  EXPECT_EQ(kKey0,
+            MinidumpUTF8StringAtRVAAsString(file_writer.string(),
+                                            dictionary->entries[1].key));
+  EXPECT_EQ(kValue0,
+            MinidumpUTF8StringAtRVAAsString(file_writer.string(),
+                                            dictionary->entries[1].value));
+  EXPECT_EQ(kKey2,
+            MinidumpUTF8StringAtRVAAsString(file_writer.string(),
+                                            dictionary->entries[2].key));
+  EXPECT_EQ(kValue2,
+            MinidumpUTF8StringAtRVAAsString(file_writer.string(),
+                                            dictionary->entries[2].value));
+}
+
 }  // namespace
 }  // namespace test
 }  // namespace crashpad