mirror of
https://github.com/chromium/crashpad.git
synced 2025-03-20 18:53:47 +00:00
359bdd8622
The client ID is added to a new field, MinidumpCrashpadInfo::client_id,
in each minidump file that is written. The ProcessSnapshot::ClientID()
gives access to value at the snapshot level. In the upload thread,
client IDs are retrieved from minidump files and used to populate the
“guid” HTTP form parameter.
The Breakpad client supplies these values at upload without hyphens and
with all capital letters. Currently, the Crashpad client uses hyphens
and lowercase letters when communicating with a Breakpad server.
TEST=crashpad_minidump_test MinidumpCrashpadInfoWriter.*,
crashpad_snapshot_test ProcessSnapshotMinidump.*,
run_with_crashpad --handler crashpad_handler \
-a --database=/tmp/crashpad_db \
-a --url=https://clients2.google.com/cr/staging_report \
-a --annotation=prod=crashpad \
-a --annotation=ver=0.7.0 \
crashy_program
R=rsesek@chromium.org
Review URL: https://codereview.chromium.org/998033002
303 lines
11 KiB
C++
303 lines
11 KiB
C++
// 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_info_writer.h"
|
||
|
||
#include <windows.h>
|
||
#include <dbghelp.h>
|
||
|
||
#include <map>
|
||
#include <string>
|
||
|
||
#include "gtest/gtest.h"
|
||
#include "minidump/minidump_extensions.h"
|
||
#include "minidump/minidump_file_writer.h"
|
||
#include "minidump/minidump_module_crashpad_info_writer.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 "snapshot/test/test_module_snapshot.h"
|
||
#include "snapshot/test/test_process_snapshot.h"
|
||
#include "util/file/string_file.h"
|
||
|
||
namespace crashpad {
|
||
namespace test {
|
||
namespace {
|
||
|
||
void GetCrashpadInfoStream(
|
||
const std::string& file_contents,
|
||
const MinidumpCrashpadInfo** crashpad_info,
|
||
const MinidumpSimpleStringDictionary** simple_annotations,
|
||
const MinidumpModuleCrashpadInfoList** module_list) {
|
||
const MINIDUMP_DIRECTORY* directory;
|
||
const MINIDUMP_HEADER* header =
|
||
MinidumpHeaderAtStart(file_contents, &directory);
|
||
ASSERT_NO_FATAL_FAILURE(VerifyMinidumpHeader(header, 1, 0));
|
||
ASSERT_TRUE(directory);
|
||
|
||
ASSERT_EQ(kMinidumpStreamTypeCrashpadInfo, directory[0].StreamType);
|
||
|
||
*crashpad_info = MinidumpWritableAtLocationDescriptor<MinidumpCrashpadInfo>(
|
||
file_contents, directory[0].Location);
|
||
ASSERT_TRUE(*crashpad_info);
|
||
|
||
*simple_annotations =
|
||
MinidumpWritableAtLocationDescriptor<MinidumpSimpleStringDictionary>(
|
||
file_contents, (*crashpad_info)->simple_annotations);
|
||
|
||
*module_list =
|
||
MinidumpWritableAtLocationDescriptor<MinidumpModuleCrashpadInfoList>(
|
||
file_contents, (*crashpad_info)->module_list);
|
||
}
|
||
|
||
TEST(MinidumpCrashpadInfoWriter, Empty) {
|
||
MinidumpFileWriter minidump_file_writer;
|
||
auto crashpad_info_writer = make_scoped_ptr(new MinidumpCrashpadInfoWriter());
|
||
EXPECT_FALSE(crashpad_info_writer->IsUseful());
|
||
|
||
minidump_file_writer.AddStream(crashpad_info_writer.Pass());
|
||
|
||
StringFile string_file;
|
||
ASSERT_TRUE(minidump_file_writer.WriteEverything(&string_file));
|
||
|
||
const MinidumpCrashpadInfo* crashpad_info = nullptr;
|
||
const MinidumpSimpleStringDictionary* simple_annotations = nullptr;
|
||
const MinidumpModuleCrashpadInfoList* module_list = nullptr;
|
||
|
||
ASSERT_NO_FATAL_FAILURE(GetCrashpadInfoStream(
|
||
string_file.string(), &crashpad_info, &simple_annotations, &module_list));
|
||
|
||
EXPECT_EQ(MinidumpCrashpadInfo::kVersion, crashpad_info->version);
|
||
EXPECT_EQ(UUID(), crashpad_info->client_id);
|
||
EXPECT_FALSE(simple_annotations);
|
||
EXPECT_FALSE(module_list);
|
||
}
|
||
|
||
TEST(MinidumpCrashpadInfoWriter, ClientID) {
|
||
MinidumpFileWriter minidump_file_writer;
|
||
auto crashpad_info_writer = make_scoped_ptr(new MinidumpCrashpadInfoWriter());
|
||
|
||
UUID client_id;
|
||
ASSERT_TRUE(
|
||
client_id.InitializeFromString("00112233-4455-6677-8899-aabbccddeeff"));
|
||
crashpad_info_writer->SetClientID(client_id);
|
||
|
||
EXPECT_TRUE(crashpad_info_writer->IsUseful());
|
||
|
||
minidump_file_writer.AddStream(crashpad_info_writer.Pass());
|
||
|
||
StringFile string_file;
|
||
ASSERT_TRUE(minidump_file_writer.WriteEverything(&string_file));
|
||
|
||
const MinidumpCrashpadInfo* crashpad_info = nullptr;
|
||
const MinidumpSimpleStringDictionary* simple_annotations = nullptr;
|
||
const MinidumpModuleCrashpadInfoList* module_list = nullptr;
|
||
|
||
ASSERT_NO_FATAL_FAILURE(GetCrashpadInfoStream(
|
||
string_file.string(), &crashpad_info, &simple_annotations, &module_list));
|
||
|
||
EXPECT_EQ(MinidumpCrashpadInfo::kVersion, crashpad_info->version);
|
||
EXPECT_EQ(client_id, crashpad_info->client_id);
|
||
EXPECT_FALSE(simple_annotations);
|
||
EXPECT_FALSE(module_list);
|
||
}
|
||
|
||
TEST(MinidumpCrashpadInfoWriter, SimpleAnnotations) {
|
||
MinidumpFileWriter minidump_file_writer;
|
||
auto crashpad_info_writer = make_scoped_ptr(new MinidumpCrashpadInfoWriter());
|
||
|
||
const char kKey[] =
|
||
"a thing that provides a means of gaining access to or understanding "
|
||
"something";
|
||
const char kValue[] =
|
||
"the numerical amount denoted by an algebraic term; a magnitude, "
|
||
"quantity, or number";
|
||
auto simple_string_dictionary_writer =
|
||
make_scoped_ptr(new MinidumpSimpleStringDictionaryWriter());
|
||
auto simple_string_dictionary_entry_writer =
|
||
make_scoped_ptr(new MinidumpSimpleStringDictionaryEntryWriter());
|
||
simple_string_dictionary_entry_writer->SetKeyValue(kKey, kValue);
|
||
simple_string_dictionary_writer->AddEntry(
|
||
simple_string_dictionary_entry_writer.Pass());
|
||
crashpad_info_writer->SetSimpleAnnotations(
|
||
simple_string_dictionary_writer.Pass());
|
||
|
||
EXPECT_TRUE(crashpad_info_writer->IsUseful());
|
||
|
||
minidump_file_writer.AddStream(crashpad_info_writer.Pass());
|
||
|
||
StringFile string_file;
|
||
ASSERT_TRUE(minidump_file_writer.WriteEverything(&string_file));
|
||
|
||
const MinidumpCrashpadInfo* crashpad_info = nullptr;
|
||
const MinidumpSimpleStringDictionary* simple_annotations = nullptr;
|
||
const MinidumpModuleCrashpadInfoList* module_list = nullptr;
|
||
|
||
ASSERT_NO_FATAL_FAILURE(GetCrashpadInfoStream(
|
||
string_file.string(), &crashpad_info, &simple_annotations, &module_list));
|
||
|
||
EXPECT_EQ(MinidumpCrashpadInfo::kVersion, crashpad_info->version);
|
||
EXPECT_FALSE(module_list);
|
||
|
||
ASSERT_TRUE(simple_annotations);
|
||
ASSERT_EQ(1u, simple_annotations->count);
|
||
EXPECT_EQ(kKey,
|
||
MinidumpUTF8StringAtRVAAsString(
|
||
string_file.string(), simple_annotations->entries[0].key));
|
||
EXPECT_EQ(kValue,
|
||
MinidumpUTF8StringAtRVAAsString(
|
||
string_file.string(), simple_annotations->entries[0].value));
|
||
}
|
||
|
||
TEST(MinidumpCrashpadInfoWriter, CrashpadModuleList) {
|
||
const uint32_t kMinidumpModuleListIndex = 3;
|
||
|
||
MinidumpFileWriter minidump_file_writer;
|
||
auto crashpad_info_writer = make_scoped_ptr(new MinidumpCrashpadInfoWriter());
|
||
|
||
auto module_list_writer =
|
||
make_scoped_ptr(new MinidumpModuleCrashpadInfoListWriter());
|
||
auto module_writer = make_scoped_ptr(new MinidumpModuleCrashpadInfoWriter());
|
||
module_list_writer->AddModule(module_writer.Pass(), kMinidumpModuleListIndex);
|
||
crashpad_info_writer->SetModuleList(module_list_writer.Pass());
|
||
|
||
EXPECT_TRUE(crashpad_info_writer->IsUseful());
|
||
|
||
minidump_file_writer.AddStream(crashpad_info_writer.Pass());
|
||
|
||
StringFile string_file;
|
||
ASSERT_TRUE(minidump_file_writer.WriteEverything(&string_file));
|
||
|
||
const MinidumpCrashpadInfo* crashpad_info = nullptr;
|
||
const MinidumpSimpleStringDictionary* simple_annotations = nullptr;
|
||
const MinidumpModuleCrashpadInfoList* module_list = nullptr;
|
||
|
||
ASSERT_NO_FATAL_FAILURE(GetCrashpadInfoStream(
|
||
string_file.string(), &crashpad_info, &simple_annotations, &module_list));
|
||
|
||
EXPECT_EQ(MinidumpCrashpadInfo::kVersion, crashpad_info->version);
|
||
EXPECT_FALSE(simple_annotations);
|
||
|
||
ASSERT_TRUE(module_list);
|
||
ASSERT_EQ(1u, module_list->count);
|
||
|
||
EXPECT_EQ(kMinidumpModuleListIndex,
|
||
module_list->modules[0].minidump_module_list_index);
|
||
const MinidumpModuleCrashpadInfo* module =
|
||
MinidumpWritableAtLocationDescriptor<MinidumpModuleCrashpadInfo>(
|
||
string_file.string(), module_list->modules[0].location);
|
||
ASSERT_TRUE(module);
|
||
|
||
EXPECT_EQ(MinidumpModuleCrashpadInfo::kVersion, module->version);
|
||
EXPECT_EQ(0u, module->list_annotations.DataSize);
|
||
EXPECT_EQ(0u, module->list_annotations.Rva);
|
||
EXPECT_EQ(0u, module->simple_annotations.DataSize);
|
||
EXPECT_EQ(0u, module->simple_annotations.Rva);
|
||
}
|
||
|
||
TEST(MinidumpCrashpadInfoWriter, InitializeFromSnapshot) {
|
||
UUID client_id;
|
||
ASSERT_TRUE(
|
||
client_id.InitializeFromString("fedcba98-7654-3210-0123-456789abcdef"));
|
||
|
||
const char kKey[] = "version";
|
||
const char kValue[] = "40.0.2214.111";
|
||
const char kEntry[] = "This is a simple annotation in a list.";
|
||
|
||
// Test with a useless module, one that doesn’t carry anything that would
|
||
// require MinidumpCrashpadInfo or any child object.
|
||
auto process_snapshot = make_scoped_ptr(new TestProcessSnapshot());
|
||
|
||
auto module_snapshot = make_scoped_ptr(new TestModuleSnapshot());
|
||
process_snapshot->AddModule(module_snapshot.Pass());
|
||
|
||
auto info_writer = make_scoped_ptr(new MinidumpCrashpadInfoWriter());
|
||
info_writer->InitializeFromSnapshot(process_snapshot.get());
|
||
EXPECT_FALSE(info_writer->IsUseful());
|
||
|
||
// Try again with a useful module.
|
||
process_snapshot.reset(new TestProcessSnapshot());
|
||
|
||
process_snapshot->SetClientID(client_id);
|
||
|
||
std::map<std::string, std::string> annotations_simple_map;
|
||
annotations_simple_map[kKey] = kValue;
|
||
process_snapshot->SetAnnotationsSimpleMap(annotations_simple_map);
|
||
|
||
module_snapshot.reset(new TestModuleSnapshot());
|
||
std::vector<std::string> annotations_list(1, std::string(kEntry));
|
||
module_snapshot->SetAnnotationsVector(annotations_list);
|
||
process_snapshot->AddModule(module_snapshot.Pass());
|
||
|
||
info_writer.reset(new MinidumpCrashpadInfoWriter());
|
||
info_writer->InitializeFromSnapshot(process_snapshot.get());
|
||
EXPECT_TRUE(info_writer->IsUseful());
|
||
|
||
MinidumpFileWriter minidump_file_writer;
|
||
minidump_file_writer.AddStream(info_writer.Pass());
|
||
|
||
StringFile string_file;
|
||
ASSERT_TRUE(minidump_file_writer.WriteEverything(&string_file));
|
||
|
||
const MinidumpCrashpadInfo* info = nullptr;
|
||
const MinidumpSimpleStringDictionary* simple_annotations;
|
||
const MinidumpModuleCrashpadInfoList* module_list;
|
||
ASSERT_NO_FATAL_FAILURE(GetCrashpadInfoStream(
|
||
string_file.string(), &info, &simple_annotations, &module_list));
|
||
|
||
EXPECT_EQ(MinidumpCrashpadInfo::kVersion, info->version);
|
||
|
||
EXPECT_EQ(client_id, info->client_id);
|
||
|
||
ASSERT_TRUE(simple_annotations);
|
||
ASSERT_EQ(1u, simple_annotations->count);
|
||
EXPECT_EQ(kKey,
|
||
MinidumpUTF8StringAtRVAAsString(
|
||
string_file.string(), simple_annotations->entries[0].key));
|
||
EXPECT_EQ(kValue,
|
||
MinidumpUTF8StringAtRVAAsString(
|
||
string_file.string(), simple_annotations->entries[0].value));
|
||
|
||
ASSERT_TRUE(module_list);
|
||
ASSERT_EQ(1u, module_list->count);
|
||
|
||
EXPECT_EQ(0u, module_list->modules[0].minidump_module_list_index);
|
||
const MinidumpModuleCrashpadInfo* module =
|
||
MinidumpWritableAtLocationDescriptor<MinidumpModuleCrashpadInfo>(
|
||
string_file.string(), module_list->modules[0].location);
|
||
ASSERT_TRUE(module);
|
||
|
||
EXPECT_EQ(MinidumpModuleCrashpadInfo::kVersion, module->version);
|
||
|
||
const MinidumpRVAList* list_annotations =
|
||
MinidumpWritableAtLocationDescriptor<MinidumpRVAList>(
|
||
string_file.string(), module->list_annotations);
|
||
ASSERT_TRUE(list_annotations);
|
||
|
||
ASSERT_EQ(1u, list_annotations->count);
|
||
EXPECT_EQ(kEntry,
|
||
MinidumpUTF8StringAtRVAAsString(string_file.string(),
|
||
list_annotations->children[0]));
|
||
|
||
const MinidumpSimpleStringDictionary* module_simple_annotations =
|
||
MinidumpWritableAtLocationDescriptor<MinidumpSimpleStringDictionary>(
|
||
string_file.string(), module->simple_annotations);
|
||
EXPECT_FALSE(module_simple_annotations);
|
||
}
|
||
|
||
} // namespace
|
||
} // namespace test
|
||
} // namespace crashpad
|