blob: 5de926ab35a24c81001ad8f2588e0f2d80077534 [file] [log] [blame]
// Copyright 2015 The Crashpad Authors
//
// 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 "snapshot/win/module_snapshot_win.h"
#include <stdlib.h>
#include <string.h>
#include <map>
#include <string>
#include <vector>
#include "base/files/file_path.h"
#include "base/strings/utf_string_conversions.h"
#include "build/build_config.h"
#include "client/crashpad_info.h"
#include "client/simple_string_dictionary.h"
#include "gtest/gtest.h"
#include "snapshot/annotation_snapshot.h"
#include "snapshot/win/pe_image_reader.h"
#include "snapshot/win/process_reader_win.h"
#include "test/test_paths.h"
#include "test/win/child_launcher.h"
#include "util/file/file_io.h"
#include "util/win/process_info.h"
namespace crashpad {
namespace test {
namespace {
enum TestType {
// Don't crash, just test the CrashpadInfo interface.
kDontCrash = 0,
// The child process should crash by __debugbreak().
kCrashDebugBreak,
};
void TestAnnotationsOnCrash(TestType type,
TestPaths::Architecture architecture) {
// Spawn a child process, passing it the pipe name to connect to.
base::FilePath child_test_executable =
TestPaths::BuildArtifact(L"snapshot",
L"annotations",
TestPaths::FileType::kExecutable,
architecture);
ChildLauncher child(child_test_executable, L"");
ASSERT_NO_FATAL_FAILURE(child.Start());
// Wait for the child process to indicate that it's done setting up its
// annotations via the CrashpadInfo interface.
char c;
CheckedReadFileExactly(child.stdout_read_handle(), &c, sizeof(c));
ProcessReaderWin process_reader;
ASSERT_TRUE(process_reader.Initialize(child.process_handle(),
ProcessSuspensionState::kRunning));
// Read all the kinds of annotations referenced from the CrashpadInfo
// structure.
const std::vector<ProcessInfo::Module>& modules = process_reader.Modules();
std::map<std::string, std::string> all_annotations_simple_map;
std::vector<AnnotationSnapshot> all_annotation_objects;
for (const ProcessInfo::Module& module : modules) {
internal::ModuleSnapshotWin module_snapshot;
module_snapshot.Initialize(&process_reader, module);
std::map<std::string, std::string> module_annotations_simple_map =
module_snapshot.AnnotationsSimpleMap();
all_annotations_simple_map.insert(module_annotations_simple_map.begin(),
module_annotations_simple_map.end());
auto module_annotations_list = module_snapshot.AnnotationObjects();
all_annotation_objects.insert(all_annotation_objects.end(),
module_annotations_list.begin(),
module_annotations_list.end());
}
// Verify the "simple map" annotations.
EXPECT_GE(all_annotations_simple_map.size(), 5u);
EXPECT_EQ(all_annotations_simple_map["#TEST# pad"], "crash");
EXPECT_EQ(all_annotations_simple_map["#TEST# key"], "value");
EXPECT_EQ(all_annotations_simple_map["#TEST# x"], "y");
EXPECT_EQ(all_annotations_simple_map["#TEST# longer"], "shorter");
EXPECT_EQ(all_annotations_simple_map["#TEST# empty_value"], "");
// Verify the typed annotation objects.
EXPECT_EQ(all_annotation_objects.size(), 3u);
bool saw_same_name_3 = false, saw_same_name_4 = false;
for (const auto& annotation : all_annotation_objects) {
EXPECT_EQ(annotation.type,
static_cast<uint16_t>(Annotation::Type::kString));
std::string value(reinterpret_cast<const char*>(annotation.value.data()),
annotation.value.size());
if (annotation.name == "#TEST# one") {
EXPECT_EQ(value, "moocow");
} else if (annotation.name == "#TEST# same-name") {
if (value == "same-name 3") {
EXPECT_FALSE(saw_same_name_3);
saw_same_name_3 = true;
} else if (value == "same-name 4") {
EXPECT_FALSE(saw_same_name_4);
saw_same_name_4 = true;
} else {
ADD_FAILURE() << "unexpected annotation value " << value;
}
} else {
ADD_FAILURE() << "unexpected annotation " << annotation.name;
}
}
// Tell the child process to continue.
DWORD expected_exit_code;
switch (type) {
case kDontCrash:
c = ' ';
expected_exit_code = 0;
break;
case kCrashDebugBreak:
c = 'd';
expected_exit_code = STATUS_BREAKPOINT;
break;
default:
FAIL();
}
CheckedWriteFile(child.stdin_write_handle(), &c, sizeof(c));
EXPECT_EQ(child.WaitForExit(), expected_exit_code);
}
TEST(ModuleSnapshotWinTest, DontCrash) {
TestAnnotationsOnCrash(kDontCrash, TestPaths::Architecture::kDefault);
}
TEST(ModuleSnapshotWinTest, CrashDebugBreak) {
TestAnnotationsOnCrash(kCrashDebugBreak, TestPaths::Architecture::kDefault);
}
#if defined(ARCH_CPU_64_BITS)
TEST(ModuleSnapshotWinTest, DontCrashWOW64) {
if (!TestPaths::Has32BitBuildArtifacts()) {
GTEST_SKIP();
}
TestAnnotationsOnCrash(kDontCrash, TestPaths::Architecture::k32Bit);
}
TEST(ModuleSnapshotWinTest, CrashDebugBreakWOW64) {
if (!TestPaths::Has32BitBuildArtifacts()) {
GTEST_SKIP();
}
TestAnnotationsOnCrash(kCrashDebugBreak, TestPaths::Architecture::k32Bit);
}
#endif // ARCH_CPU_64_BITS
} // namespace
} // namespace test
} // namespace crashpad