crash_logging_unittest.cc 5.55 KB
Newer Older
gejun's avatar
gejun committed
1 2 3 4
// Copyright (c) 2013 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5
#include "butil/debug/crash_logging.h"
gejun's avatar
gejun committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21

#include <map>
#include <string>

#include <gtest/gtest.h>

namespace {

std::map<std::string, std::string>* key_values_ = NULL;

}  // namespace

class CrashLoggingTest : public testing::Test {
 public:
  virtual void SetUp() {
    key_values_ = new std::map<std::string, std::string>;
22
    butil::debug::SetCrashKeyReportingFunctions(
gejun's avatar
gejun committed
23 24 25 26 27
        &CrashLoggingTest::SetKeyValue,
        &CrashLoggingTest::ClearKeyValue);
  }

  virtual void TearDown() {
28
    butil::debug::ResetCrashLoggingForTesting();
gejun's avatar
gejun committed
29 30 31 32 33 34

    delete key_values_;
    key_values_ = NULL;
  }

 private:
35 36
  static void SetKeyValue(const butil::StringPiece& key,
                          const butil::StringPiece& value) {
gejun's avatar
gejun committed
37 38 39
    (*key_values_)[key.as_string()] = value.as_string();
  }

40
  static void ClearKeyValue(const butil::StringPiece& key) {
gejun's avatar
gejun committed
41 42 43 44 45 46
    key_values_->erase(key.as_string());
  }
};

TEST_F(CrashLoggingTest, SetClearSingle) {
  const char* kTestKey = "test-key";
47 48
  butil::debug::CrashKey keys[] = { { kTestKey, 255 } };
  butil::debug::InitCrashKeys(keys, arraysize(keys), 255);
gejun's avatar
gejun committed
49

50
  butil::debug::SetCrashKeyValue(kTestKey, "value");
gejun's avatar
gejun committed
51 52
  EXPECT_EQ("value", (*key_values_)[kTestKey]);

53
  butil::debug::ClearCrashKey(kTestKey);
gejun's avatar
gejun committed
54 55 56 57 58 59 60 61
  EXPECT_TRUE(key_values_->end() == key_values_->find(kTestKey));
}

TEST_F(CrashLoggingTest, SetChunked) {
  const char* kTestKey = "chunky";
  const char* kChunk1 = "chunky-1";
  const char* kChunk2 = "chunky-2";
  const char* kChunk3 = "chunky-3";
62 63
  butil::debug::CrashKey keys[] = { { kTestKey, 15 } };
  butil::debug::InitCrashKeys(keys, arraysize(keys), 5);
gejun's avatar
gejun committed
64 65 66 67

  std::map<std::string, std::string>& values = *key_values_;

  // Fill only the first chunk.
68
  butil::debug::SetCrashKeyValue(kTestKey, "foo");
gejun's avatar
gejun committed
69 70 71 72 73 74
  EXPECT_EQ(1u, values.size());
  EXPECT_EQ("foo", values[kChunk1]);
  EXPECT_TRUE(values.end() == values.find(kChunk2));
  EXPECT_TRUE(values.end() == values.find(kChunk3));

  // Fill three chunks with truncation (max length is 15, this string is 20).
75
  butil::debug::SetCrashKeyValue(kTestKey, "five four three two");
gejun's avatar
gejun committed
76 77 78 79 80 81
  EXPECT_EQ(3u, values.size());
  EXPECT_EQ("five ", values[kChunk1]);
  EXPECT_EQ("four ", values[kChunk2]);
  EXPECT_EQ("three", values[kChunk3]);

  // Clear everything.
82
  butil::debug::ClearCrashKey(kTestKey);
gejun's avatar
gejun committed
83 84 85 86 87 88 89
  EXPECT_EQ(0u, values.size());
  EXPECT_TRUE(values.end() == values.find(kChunk1));
  EXPECT_TRUE(values.end() == values.find(kChunk2));
  EXPECT_TRUE(values.end() == values.find(kChunk3));

  // Refill all three chunks with truncation, then test that setting a smaller
  // value clears the third chunk.
90 91
  butil::debug::SetCrashKeyValue(kTestKey, "five four three two");
  butil::debug::SetCrashKeyValue(kTestKey, "allays");
gejun's avatar
gejun committed
92 93 94 95 96 97
  EXPECT_EQ(2u, values.size());
  EXPECT_EQ("allay", values[kChunk1]);
  EXPECT_EQ("s", values[kChunk2]);
  EXPECT_TRUE(values.end() == values.find(kChunk3));

  // Clear everything.
98
  butil::debug::ClearCrashKey(kTestKey);
gejun's avatar
gejun committed
99 100 101 102 103 104 105 106
  EXPECT_EQ(0u, values.size());
  EXPECT_TRUE(values.end() == values.find(kChunk1));
  EXPECT_TRUE(values.end() == values.find(kChunk2));
  EXPECT_TRUE(values.end() == values.find(kChunk3));
}

TEST_F(CrashLoggingTest, ScopedCrashKey) {
  const char* kTestKey = "test-key";
107 108
  butil::debug::CrashKey keys[] = { { kTestKey, 255 } };
  butil::debug::InitCrashKeys(keys, arraysize(keys), 255);
gejun's avatar
gejun committed
109 110 111 112

  EXPECT_EQ(0u, key_values_->size());
  EXPECT_TRUE(key_values_->end() == key_values_->find(kTestKey));
  {
113
    butil::debug::ScopedCrashKey scoped_crash_key(kTestKey, "value");
gejun's avatar
gejun committed
114 115 116 117 118 119 120 121
    EXPECT_EQ("value", (*key_values_)[kTestKey]);
    EXPECT_EQ(1u, key_values_->size());
  }
  EXPECT_EQ(0u, key_values_->size());
  EXPECT_TRUE(key_values_->end() == key_values_->find(kTestKey));
}

TEST_F(CrashLoggingTest, InitSize) {
122
  butil::debug::CrashKey keys[] = {
gejun's avatar
gejun committed
123 124 125 126 127
    { "chunked-3", 15 },
    { "single", 5 },
    { "chunked-6", 30 },
  };

128
  size_t num_keys = butil::debug::InitCrashKeys(keys, arraysize(keys), 5);
gejun's avatar
gejun committed
129 130 131

  EXPECT_EQ(10u, num_keys);

132 133 134 135
  EXPECT_TRUE(butil::debug::LookupCrashKey("chunked-3"));
  EXPECT_TRUE(butil::debug::LookupCrashKey("single"));
  EXPECT_TRUE(butil::debug::LookupCrashKey("chunked-6"));
  EXPECT_FALSE(butil::debug::LookupCrashKey("chunked-6-4"));
gejun's avatar
gejun committed
136 137 138
}

TEST_F(CrashLoggingTest, ChunkValue) {
139
  using butil::debug::ChunkCrashKeyValue;
gejun's avatar
gejun committed
140 141

  // Test truncation.
142
  butil::debug::CrashKey key = { "chunky", 10 };
gejun's avatar
gejun committed
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
  std::vector<std::string> results =
      ChunkCrashKeyValue(key, "hello world", 64);
  ASSERT_EQ(1u, results.size());
  EXPECT_EQ("hello worl", results[0]);

  // Test short string.
  results = ChunkCrashKeyValue(key, "hi", 10);
  ASSERT_EQ(1u, results.size());
  EXPECT_EQ("hi", results[0]);

  // Test chunk pair.
  key.max_length = 6;
  results = ChunkCrashKeyValue(key, "foobar", 3);
  ASSERT_EQ(2u, results.size());
  EXPECT_EQ("foo", results[0]);
  EXPECT_EQ("bar", results[1]);

  // Test chunk pair truncation.
  results = ChunkCrashKeyValue(key, "foobared", 3);
  ASSERT_EQ(2u, results.size());
  EXPECT_EQ("foo", results[0]);
  EXPECT_EQ("bar", results[1]);

  // Test extra chunks.
  key.max_length = 100;
  results = ChunkCrashKeyValue(key, "hello world", 3);
  ASSERT_EQ(4u, results.size());
  EXPECT_EQ("hel", results[0]);
  EXPECT_EQ("lo ", results[1]);
  EXPECT_EQ("wor", results[2]);
  EXPECT_EQ("ld",  results[3]);
}

TEST_F(CrashLoggingTest, ChunkRounding) {
  // If max_length=12 and max_chunk_length=5, there should be 3 chunks,
  // not 2.
179 180
  butil::debug::CrashKey key = { "round", 12 };
  EXPECT_EQ(3u, butil::debug::InitCrashKeys(&key, 1, 5));
gejun's avatar
gejun committed
181
}