unittests/ADT/StringMapTest.cpp

   1 //===- llvm/unittest/ADT/StringMapMap.cpp - StringMap unit tests ----------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #include "gtest/gtest.h"
  11 #include "llvm/ADT/StringMap.h"
  12 #include "llvm/Support/DataTypes.h"
  13 using namespace llvm;
  14
  15 namespace {
  16
  17 // Test fixture
  18 class StringMapTest : public testing::Test {
  19 protected:
  20   StringMap<uint32_t> testMap;
  21
  22   static const char testKey[];
  23   static const uint32_t testValue;
  24   static const char* testKeyFirst;
  25   static size_t testKeyLength;
  26   static const std::string testKeyStr;
  27
  28   void assertEmptyMap() {
  29     // Size tests
  30     EXPECT_EQ(0u, testMap.size());
  31     EXPECT_TRUE(testMap.empty());
  32
  33     // Iterator tests
  34     EXPECT_TRUE(testMap.begin() == testMap.end());
  35
  36     // Lookup tests
  37     EXPECT_EQ(0u, testMap.count(testKey));
  38     EXPECT_EQ(0u, testMap.count(StringRef(testKeyFirst, testKeyLength)));
  39     EXPECT_EQ(0u, testMap.count(testKeyStr));
  40     EXPECT_TRUE(testMap.find(testKey) == testMap.end());
  41     EXPECT_TRUE(testMap.find(StringRef(testKeyFirst, testKeyLength)) ==
  42                 testMap.end());
  43     EXPECT_TRUE(testMap.find(testKeyStr) == testMap.end());
  44   }
  45
  46   void assertSingleItemMap() {
  47     // Size tests
  48     EXPECT_EQ(1u, testMap.size());
  49     EXPECT_FALSE(testMap.begin() == testMap.end());
  50     EXPECT_FALSE(testMap.empty());
  51
  52     // Iterator tests
  53     StringMap<uint32_t>::iterator it = testMap.begin();
  54     EXPECT_STREQ(testKey, it->first().data());
  55     EXPECT_EQ(testValue, it->second);
  56     ++it;
  57     EXPECT_TRUE(it == testMap.end());
  58
  59     // Lookup tests
  60     EXPECT_EQ(1u, testMap.count(testKey));
  61     EXPECT_EQ(1u, testMap.count(StringRef(testKeyFirst, testKeyLength)));
  62     EXPECT_EQ(1u, testMap.count(testKeyStr));
  63     EXPECT_TRUE(testMap.find(testKey) == testMap.begin());
  64     EXPECT_TRUE(testMap.find(StringRef(testKeyFirst, testKeyLength)) ==
  65                 testMap.begin());
  66     EXPECT_TRUE(testMap.find(testKeyStr) == testMap.begin());
  67   }
  68 };
  69
  70 const char StringMapTest::testKey[] = "key";
  71 const uint32_t StringMapTest::testValue = 1u;
  72 const char* StringMapTest::testKeyFirst = testKey;
  73 size_t StringMapTest::testKeyLength = sizeof(testKey) - 1;
  74 const std::string StringMapTest::testKeyStr(testKey);
  75
  76 // Empty map tests.
  77 TEST_F(StringMapTest, EmptyMapTest) {
  78   assertEmptyMap();
  79 }
  80
  81 // Constant map tests.
  82 TEST_F(StringMapTest, ConstEmptyMapTest) {
  83   const StringMap<uint32_t>& constTestMap = testMap;
  84
  85   // Size tests
  86   EXPECT_EQ(0u, constTestMap.size());
  87   EXPECT_TRUE(constTestMap.empty());
  88
  89   // Iterator tests
  90   EXPECT_TRUE(constTestMap.begin() == constTestMap.end());
  91
  92   // Lookup tests
  93   EXPECT_EQ(0u, constTestMap.count(testKey));
  94   EXPECT_EQ(0u, constTestMap.count(StringRef(testKeyFirst, testKeyLength)));
  95   EXPECT_EQ(0u, constTestMap.count(testKeyStr));
  96   EXPECT_TRUE(constTestMap.find(testKey) == constTestMap.end());
  97   EXPECT_TRUE(constTestMap.find(StringRef(testKeyFirst, testKeyLength)) ==
  98               constTestMap.end());
  99   EXPECT_TRUE(constTestMap.find(testKeyStr) == constTestMap.end());
 100 }
 101
 102 // A map with a single entry.
 103 TEST_F(StringMapTest, SingleEntryMapTest) {
 104   testMap[testKey] = testValue;
 105   assertSingleItemMap();
 106 }
 107
 108 // Test clear() method.
 109 TEST_F(StringMapTest, ClearTest) {
 110   testMap[testKey] = testValue;
 111   testMap.clear();
 112   assertEmptyMap();
 113 }
 114
 115 // Test erase(iterator) method.
 116 TEST_F(StringMapTest, EraseIteratorTest) {
 117   testMap[testKey] = testValue;
 118   testMap.erase(testMap.begin());
 119   assertEmptyMap();
 120 }
 121
 122 // Test erase(value) method.
 123 TEST_F(StringMapTest, EraseValueTest) {
 124   testMap[testKey] = testValue;
 125   testMap.erase(testKey);
 126   assertEmptyMap();
 127 }
 128
 129 // Test inserting two values and erasing one.
 130 TEST_F(StringMapTest, InsertAndEraseTest) {
 131   testMap[testKey] = testValue;
 132   testMap["otherKey"] = 2;
 133   testMap.erase("otherKey");
 134   assertSingleItemMap();
 135 }
 136
 137 // A more complex iteration test.
 138 TEST_F(StringMapTest, IterationTest) {
 139   bool visited[100];
 140
 141   // Insert 100 numbers into the map
 142   for (int i = 0; i < 100; ++i) {
 143     std::stringstream ss;
 144     ss << "key_" << i;
 145     testMap[ss.str()] = i;
 146     visited[i] = false;
 147   }
 148
 149   // Iterate over all numbers and mark each one found.
 150   for (StringMap<uint32_t>::iterator it = testMap.begin();
 151       it != testMap.end(); ++it) {
 152     std::stringstream ss;
 153     ss << "key_" << it->second;
 154     ASSERT_STREQ(ss.str().c_str(), it->first().data());
 155     visited[it->second] = true;
 156   }
 157
 158   // Ensure every number was visited.
 159   for (int i = 0; i < 100; ++i) {
 160     ASSERT_TRUE(visited[i]) << "Entry #" << i << " was never visited";
 161   }
 162 }
 163
 164 } // end anonymous namespace
 165
 166 namespace llvm {
 167
 168 template <>
 169 class StringMapEntryInitializer<uint32_t> {
 170 public:
 171   template <typename InitTy>
 172   static void Initialize(StringMapEntry<uint32_t> &T, InitTy InitVal) {
 173     T.second = InitVal;
 174   }
 175 };
 176
 177 } // end llvm namespace
 178
 179 namespace {
 180
 181 // Test StringMapEntry::Create() method.
 182 TEST_F(StringMapTest, StringMapEntryTest) {
 183   StringMap<uint32_t>::value_type* entry =
 184       StringMap<uint32_t>::value_type::Create(
 185           testKeyFirst, testKeyFirst + testKeyLength, 1u);
 186   EXPECT_STREQ(testKey, entry->first().data());
 187   EXPECT_EQ(1u, entry->second);
 188   free(entry);
 189 }
 190
 191 // Test insert() method.
 192 TEST_F(StringMapTest, InsertTest) {
 193   SCOPED_TRACE("InsertTest");
 194   testMap.insert(
 195       StringMap<uint32_t>::value_type::Create(
 196           testKeyFirst, testKeyFirst + testKeyLength,
 197           testMap.getAllocator(), 1u));
 198   assertSingleItemMap();
 199 }
 200
 201 } // end anonymous namespace