| OLD | NEW |
| 1 // Copyright 2014 The Crashpad Authors. All rights reserved. | 1 // Copyright 2014 The Crashpad Authors. All rights reserved. |
| 2 // | 2 // |
| 3 // Licensed under the Apache License, Version 2.0 (the "License"); | 3 // Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 // you may not use this file except in compliance with the License. | 4 // you may not use this file except in compliance with the License. |
| 5 // You may obtain a copy of the License at | 5 // You may obtain a copy of the License at |
| 6 // | 6 // |
| 7 // http://www.apache.org/licenses/LICENSE-2.0 | 7 // http://www.apache.org/licenses/LICENSE-2.0 |
| 8 // | 8 // |
| 9 // Unless required by applicable law or agreed to in writing, software | 9 // Unless required by applicable law or agreed to in writing, software |
| 10 // distributed under the License is distributed on an "AS IS" BASIS, | 10 // distributed under the License is distributed on an "AS IS" BASIS, |
| 11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | 11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 // See the License for the specific language governing permissions and | 12 // See the License for the specific language governing permissions and |
| 13 // limitations under the License. | 13 // limitations under the License. |
| 14 | 14 |
| 15 #include "minidump/minidump_crashpad_info_writer.h" | 15 #include "minidump/minidump_crashpad_info_writer.h" |
| 16 | 16 |
| 17 #include <dbghelp.h> | 17 #include <dbghelp.h> |
| 18 | 18 |
| 19 #include "gtest/gtest.h" | 19 #include "gtest/gtest.h" |
| 20 #include "minidump/minidump_crashpad_module_writer.h" |
| 20 #include "minidump/minidump_extensions.h" | 21 #include "minidump/minidump_extensions.h" |
| 21 #include "minidump/minidump_file_writer.h" | 22 #include "minidump/minidump_file_writer.h" |
| 22 #include "minidump/minidump_simple_string_dictionary_writer.h" | |
| 23 #include "minidump/test/minidump_file_writer_test_util.h" | 23 #include "minidump/test/minidump_file_writer_test_util.h" |
| 24 #include "minidump/test/minidump_string_writer_test_util.h" | |
| 25 #include "minidump/test/minidump_writable_test_util.h" | 24 #include "minidump/test/minidump_writable_test_util.h" |
| 26 #include "util/file/string_file_writer.h" | 25 #include "util/file/string_file_writer.h" |
| 27 | 26 |
| 28 namespace crashpad { | 27 namespace crashpad { |
| 29 namespace test { | 28 namespace test { |
| 30 namespace { | 29 namespace { |
| 31 | 30 |
| 32 void GetCrashpadInfoStream( | 31 void GetCrashpadInfoStream( |
| 33 const std::string& file_contents, | 32 const std::string& file_contents, |
| 34 const MinidumpCrashpadInfo** crashpad_info, | 33 const MinidumpCrashpadInfo** crashpad_info, |
| 35 const MinidumpSimpleStringDictionary** simple_annotations) { | 34 const MinidumpCrashpadModuleList** crashpad_module_list) { |
| 36 const size_t kDirectoryOffset = sizeof(MINIDUMP_HEADER); | |
| 37 const size_t kCrashpadInfoStreamOffset = | |
| 38 kDirectoryOffset + sizeof(MINIDUMP_DIRECTORY); | |
| 39 size_t end = kCrashpadInfoStreamOffset + sizeof(MinidumpCrashpadInfo); | |
| 40 const size_t kSimpleAnnotationsOffset = simple_annotations ? end : 0; | |
| 41 if (simple_annotations) { | |
| 42 end += sizeof(MinidumpSimpleStringDictionary); | |
| 43 } | |
| 44 const size_t kFileSize = end; | |
| 45 | |
| 46 if (!simple_annotations) { | |
| 47 ASSERT_EQ(kFileSize, file_contents.size()); | |
| 48 } else { | |
| 49 EXPECT_GE(file_contents.size(), kFileSize); | |
| 50 } | |
| 51 | |
| 52 const MINIDUMP_DIRECTORY* directory; | 35 const MINIDUMP_DIRECTORY* directory; |
| 53 const MINIDUMP_HEADER* header = | 36 const MINIDUMP_HEADER* header = |
| 54 MinidumpHeaderAtStart(file_contents, &directory); | 37 MinidumpHeaderAtStart(file_contents, &directory); |
| 55 ASSERT_NO_FATAL_FAILURE(VerifyMinidumpHeader(header, 1, 0)); | 38 ASSERT_NO_FATAL_FAILURE(VerifyMinidumpHeader(header, 1, 0)); |
| 56 ASSERT_TRUE(directory); | 39 ASSERT_TRUE(directory); |
| 57 | 40 |
| 58 ASSERT_EQ(kMinidumpStreamTypeCrashpadInfo, directory[0].StreamType); | 41 ASSERT_EQ(kMinidumpStreamTypeCrashpadInfo, directory[0].StreamType); |
| 59 EXPECT_EQ(kCrashpadInfoStreamOffset, directory[0].Location.Rva); | |
| 60 | 42 |
| 61 *crashpad_info = MinidumpWritableAtLocationDescriptor<MinidumpCrashpadInfo>( | 43 *crashpad_info = MinidumpWritableAtLocationDescriptor<MinidumpCrashpadInfo>( |
| 62 file_contents, directory[0].Location); | 44 file_contents, directory[0].Location); |
| 63 ASSERT_TRUE(*crashpad_info); | 45 ASSERT_TRUE(*crashpad_info); |
| 64 | 46 |
| 65 if (simple_annotations) { | 47 *crashpad_module_list = |
| 66 EXPECT_EQ(kSimpleAnnotationsOffset, | 48 MinidumpWritableAtLocationDescriptor<MinidumpCrashpadModuleList>( |
| 67 (*crashpad_info)->simple_annotations.Rva); | 49 file_contents, (*crashpad_info)->crashpad_module_list); |
| 68 *simple_annotations = | |
| 69 MinidumpWritableAtLocationDescriptor<MinidumpSimpleStringDictionary>( | |
| 70 file_contents, (*crashpad_info)->simple_annotations); | |
| 71 ASSERT_TRUE(*simple_annotations); | |
| 72 } else { | |
| 73 ASSERT_EQ(0u, (*crashpad_info)->simple_annotations.DataSize); | |
| 74 ASSERT_EQ(0u, (*crashpad_info)->simple_annotations.Rva); | |
| 75 } | |
| 76 } | 50 } |
| 77 | 51 |
| 78 TEST(MinidumpCrashpadInfoWriter, Empty) { | 52 TEST(MinidumpCrashpadInfoWriter, Empty) { |
| 79 MinidumpFileWriter minidump_file_writer; | 53 MinidumpFileWriter minidump_file_writer; |
| 80 MinidumpCrashpadInfoWriter crashpad_info_writer; | 54 MinidumpCrashpadInfoWriter crashpad_info_writer; |
| 81 | 55 |
| 82 minidump_file_writer.AddStream(&crashpad_info_writer); | 56 minidump_file_writer.AddStream(&crashpad_info_writer); |
| 83 | 57 |
| 84 StringFileWriter file_writer; | 58 StringFileWriter file_writer; |
| 85 ASSERT_TRUE(minidump_file_writer.WriteEverything(&file_writer)); | 59 ASSERT_TRUE(minidump_file_writer.WriteEverything(&file_writer)); |
| 86 | 60 |
| 87 const MinidumpCrashpadInfo* crashpad_info; | 61 const MinidumpCrashpadInfo* crashpad_info; |
| 62 const MinidumpCrashpadModuleList* crashpad_module_list; |
| 88 | 63 |
| 89 ASSERT_NO_FATAL_FAILURE( | 64 ASSERT_NO_FATAL_FAILURE(GetCrashpadInfoStream( |
| 90 GetCrashpadInfoStream(file_writer.string(), &crashpad_info, nullptr)); | 65 file_writer.string(), &crashpad_info, &crashpad_module_list)); |
| 91 | 66 |
| 92 EXPECT_EQ(sizeof(*crashpad_info), crashpad_info->size); | 67 EXPECT_EQ(MinidumpCrashpadInfo::kVersion, crashpad_info->version); |
| 93 EXPECT_EQ(1u, crashpad_info->version); | 68 EXPECT_FALSE(crashpad_module_list); |
| 94 EXPECT_EQ(0u, crashpad_info->simple_annotations.DataSize); | |
| 95 EXPECT_EQ(0u, crashpad_info->simple_annotations.Rva); | |
| 96 } | 69 } |
| 97 | 70 |
| 98 TEST(MinidumpCrashpadInfoWriter, SimpleAnnotations) { | 71 TEST(MinidumpCrashpadInfoWriter, CrashpadModuleList) { |
| 72 const uint32_t kMinidumpModuleListIndex = 3; |
| 73 |
| 99 MinidumpFileWriter minidump_file_writer; | 74 MinidumpFileWriter minidump_file_writer; |
| 100 MinidumpCrashpadInfoWriter crashpad_info_writer; | 75 MinidumpCrashpadInfoWriter crashpad_info_writer; |
| 101 | 76 |
| 102 minidump_file_writer.AddStream(&crashpad_info_writer); | 77 minidump_file_writer.AddStream(&crashpad_info_writer); |
| 103 | 78 |
| 104 MinidumpSimpleStringDictionaryWriter simple_annotations_writer; | 79 MinidumpCrashpadModuleListWriter crashpad_module_list_writer; |
| 105 | 80 MinidumpCrashpadModuleWriter crashpad_module_writer; |
| 106 // Set a key and value before adding the simple_annotations_writer to | 81 crashpad_module_writer.SetMinidumpModuleListIndex(kMinidumpModuleListIndex); |
| 107 // crashpad_info_writer, and another one after. | 82 crashpad_module_list_writer.AddCrashpadModule(&crashpad_module_writer); |
| 108 const char kKey0[] = "k0"; | 83 crashpad_info_writer.SetCrashpadModuleList(&crashpad_module_list_writer); |
| 109 const char kValue0[] = "v"; | |
| 110 const char kKey1[] = "KEY1"; | |
| 111 const char kValue1[] = ""; | |
| 112 MinidumpSimpleStringDictionaryEntryWriter entry_0; | |
| 113 entry_0.SetKeyValue(kKey0, kValue0); | |
| 114 simple_annotations_writer.AddEntry(&entry_0); | |
| 115 | |
| 116 crashpad_info_writer.SetSimpleAnnotations(&simple_annotations_writer); | |
| 117 | |
| 118 MinidumpSimpleStringDictionaryEntryWriter entry_1; | |
| 119 entry_1.SetKeyValue(kKey1, kValue1); | |
| 120 simple_annotations_writer.AddEntry(&entry_1); | |
| 121 | 84 |
| 122 StringFileWriter file_writer; | 85 StringFileWriter file_writer; |
| 123 ASSERT_TRUE(minidump_file_writer.WriteEverything(&file_writer)); | 86 ASSERT_TRUE(minidump_file_writer.WriteEverything(&file_writer)); |
| 124 | 87 |
| 125 const MinidumpCrashpadInfo* crashpad_info; | 88 const MinidumpCrashpadInfo* crashpad_info; |
| 126 const MinidumpSimpleStringDictionary* simple_annotations; | 89 const MinidumpCrashpadModuleList* crashpad_module_list; |
| 127 | 90 |
| 128 ASSERT_NO_FATAL_FAILURE(GetCrashpadInfoStream( | 91 ASSERT_NO_FATAL_FAILURE(GetCrashpadInfoStream( |
| 129 file_writer.string(), &crashpad_info, &simple_annotations)); | 92 file_writer.string(), &crashpad_info, &crashpad_module_list)); |
| 130 | 93 |
| 131 EXPECT_EQ(sizeof(*crashpad_info), crashpad_info->size); | 94 EXPECT_EQ(MinidumpCrashpadInfo::kVersion, crashpad_info->version); |
| 132 EXPECT_EQ(1u, crashpad_info->version); | 95 ASSERT_TRUE(crashpad_module_list); |
| 96 ASSERT_EQ(1u, crashpad_module_list->count); |
| 133 | 97 |
| 134 ASSERT_EQ(2u, simple_annotations->count); | 98 const MinidumpCrashpadModule* crashpad_module = |
| 99 MinidumpWritableAtLocationDescriptor<MinidumpCrashpadModule>( |
| 100 file_writer.string(), crashpad_module_list->crashpad_modules[0]); |
| 101 ASSERT_TRUE(crashpad_module); |
| 135 | 102 |
| 136 EXPECT_EQ(kKey1, | 103 EXPECT_EQ(MinidumpCrashpadModule::kVersion, crashpad_module->version); |
| 137 MinidumpUTF8StringAtRVAAsString( | 104 EXPECT_EQ(kMinidumpModuleListIndex, |
| 138 file_writer.string(), simple_annotations->entries[0].key)); | 105 crashpad_module->minidump_module_list_index); |
| 139 EXPECT_EQ(kValue1, | 106 EXPECT_EQ(0u, crashpad_module->simple_annotations.DataSize); |
| 140 MinidumpUTF8StringAtRVAAsString( | 107 EXPECT_EQ(0u, crashpad_module->simple_annotations.Rva); |
| 141 file_writer.string(), simple_annotations->entries[0].value)); | |
| 142 EXPECT_EQ(kKey0, | |
| 143 MinidumpUTF8StringAtRVAAsString( | |
| 144 file_writer.string(), simple_annotations->entries[1].key)); | |
| 145 EXPECT_EQ(kValue0, | |
| 146 MinidumpUTF8StringAtRVAAsString( | |
| 147 file_writer.string(), simple_annotations->entries[1].value)); | |
| 148 } | 108 } |
| 149 | 109 |
| 150 } // namespace | 110 } // namespace |
| 151 } // namespace test | 111 } // namespace test |
| 152 } // namespace crashpad | 112 } // namespace crashpad |
| OLD | NEW |