185 lines · cpp
1//===----- unittests/AnnotationsTest.cpp ----------------------------------===//2//3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.4// See https://llvm.org/LICENSE.txt for license information.5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception6//7//===----------------------------------------------------------------------===//8#include "llvm/Testing/Annotations/Annotations.h"9#include "gmock/gmock.h"10#include "gtest/gtest.h"11 12using ::testing::AllOf;13using ::testing::ElementsAre;14using ::testing::IsEmpty;15using ::testing::Pair;16using ::testing::ResultOf;17using ::testing::UnorderedElementsAre;18 19namespace {20MATCHER_P2(pair, first_matcher, second_matcher, "") {21 return testing::ExplainMatchResult(22 AllOf(ResultOf([](const auto &entry) { return entry.getKey(); },23 first_matcher),24 ResultOf([](const auto &entry) { return entry.getValue(); },25 second_matcher)),26 arg, result_listener);27}28 29llvm::Annotations::Range range(size_t Begin, size_t End) {30 llvm::Annotations::Range R;31 R.Begin = Begin;32 R.End = End;33 return R;34}35 36TEST(AnnotationsTest, CleanedCode) {37 EXPECT_EQ(llvm::Annotations("foo^bar$nnn[[baz$^[[qux]]]]").code(),38 "foobarbazqux");39}40 41TEST(AnnotationsTest, Points) {42 // A single point.43 EXPECT_EQ(llvm::Annotations("^ab").point(), 0u);44 EXPECT_EQ(llvm::Annotations("a^b").point(), 1u);45 EXPECT_EQ(llvm::Annotations("ab^").point(), 2u);46 47 // Multiple points.48 EXPECT_THAT(llvm::Annotations("^a^bc^d^").points(),49 ElementsAre(0u, 1u, 3u, 4u));50 51 // No points.52 EXPECT_THAT(llvm::Annotations("ab[[cd]]").points(), IsEmpty());53 54 // Consecutive points.55 EXPECT_THAT(llvm::Annotations("ab^^^cd").points(), ElementsAre(2u, 2u, 2u));56}57 58TEST(AnnotationsTest, AllPoints) {59 // Multiple points.60 EXPECT_THAT(llvm::Annotations("0$p1^123$p2^456$p1^$p1^78^9").all_points(),61 UnorderedElementsAre(pair("", ElementsAre(9u)),62 pair("p1", ElementsAre(1u, 7u, 7u)),63 pair("p2", ElementsAre(4u))));64 65 // No points.66 EXPECT_THAT(llvm::Annotations("ab[[cd]]").all_points(), IsEmpty());67}68 69TEST(AnnotationsTest, Ranges) {70 // A single range.71 EXPECT_EQ(llvm::Annotations("[[a]]bc").range(), range(0, 1));72 EXPECT_EQ(llvm::Annotations("a[[bc]]d").range(), range(1, 3));73 EXPECT_EQ(llvm::Annotations("ab[[cd]]").range(), range(2, 4));74 75 // Empty range.76 EXPECT_EQ(llvm::Annotations("[[]]ab").range(), range(0, 0));77 EXPECT_EQ(llvm::Annotations("a[[]]b").range(), range(1, 1));78 EXPECT_EQ(llvm::Annotations("ab[[]]").range(), range(2, 2));79 80 // Multiple ranges.81 EXPECT_THAT(llvm::Annotations("[[a]][[b]]cd[[ef]]ef").ranges(),82 ElementsAre(range(0, 1), range(1, 2), range(4, 6)));83 84 // No ranges.85 EXPECT_THAT(llvm::Annotations("ab^c^defef").ranges(), IsEmpty());86}87 88TEST(AnnotationsTest, AllRanges) {89 // Multiple ranges.90 EXPECT_THAT(91 llvm::Annotations("[[]]01$outer[[2[[[[$inner[[3]]]]]]456]]7$outer[[89]]")92 .all_ranges(),93 UnorderedElementsAre(94 pair("", ElementsAre(range(0, 0), range(3, 4), range(3, 4))),95 pair("outer", ElementsAre(range(2, 7), range(8, 10))),96 pair("inner", ElementsAre(range(3, 4)))));97 98 // No ranges.99 EXPECT_THAT(llvm::Annotations("ab^c^defef").all_ranges(), IsEmpty());100}101 102TEST(AnnotationsTest, Nested) {103 llvm::Annotations Annotated("a[[f^oo^bar[[b[[a]]z]]]]bcdef");104 EXPECT_THAT(Annotated.points(), ElementsAre(2u, 4u));105 EXPECT_THAT(Annotated.ranges(),106 ElementsAre(range(8, 9), range(7, 10), range(1, 10)));107}108 109TEST(AnnotationsTest, Payload) {110 // // A single unnamed point or range with unspecified payload111 EXPECT_THAT(llvm::Annotations("a$^b").pointWithPayload(), Pair(1u, ""));112 EXPECT_THAT(llvm::Annotations("a$[[b]]cdef").rangeWithPayload(),113 Pair(range(1, 2), ""));114 115 // A single unnamed point or range with empty payload116 EXPECT_THAT(llvm::Annotations("a$()^b").pointWithPayload(), Pair(1u, ""));117 EXPECT_THAT(llvm::Annotations("a$()[[b]]cdef").rangeWithPayload(),118 Pair(range(1, 2), ""));119 120 // A single unnamed point or range with payload.121 EXPECT_THAT(llvm::Annotations("a$(foo)^b").pointWithPayload(),122 Pair(1u, "foo"));123 EXPECT_THAT(llvm::Annotations("a$(foo)[[b]]cdef").rangeWithPayload(),124 Pair(range(1, 2), "foo"));125 126 // A single named point or range with payload127 EXPECT_THAT(llvm::Annotations("a$name(foo)^b").pointWithPayload("name"),128 Pair(1u, "foo"));129 EXPECT_THAT(130 llvm::Annotations("a$name(foo)[[b]]cdef").rangeWithPayload("name"),131 Pair(range(1, 2), "foo"));132 133 // Multiple named points with payload.134 llvm::Annotations Annotated("a$p1(p1)^bcd$p2(p2)^123$p1^345");135 EXPECT_THAT(Annotated.points(), IsEmpty());136 EXPECT_THAT(Annotated.pointsWithPayload("p1"),137 ElementsAre(Pair(1u, "p1"), Pair(7u, "")));138 EXPECT_THAT(Annotated.pointWithPayload("p2"), Pair(4u, "p2"));139}140 141TEST(AnnotationsTest, Named) {142 // A single named point or range.143 EXPECT_EQ(llvm::Annotations("a$foo^b").point("foo"), 1u);144 EXPECT_EQ(llvm::Annotations("a$foo[[b]]cdef").range("foo"), range(1, 2));145 146 // Empty names should also work.147 EXPECT_EQ(llvm::Annotations("a$^b").point(""), 1u);148 EXPECT_EQ(llvm::Annotations("a$[[b]]cdef").range(""), range(1, 2));149 150 // Multiple named points.151 llvm::Annotations Annotated("a$p1^bcd$p2^123$p1^345");152 EXPECT_THAT(Annotated.points(), IsEmpty());153 EXPECT_THAT(Annotated.points("p1"), ElementsAre(1u, 7u));154 EXPECT_EQ(Annotated.point("p2"), 4u);155}156 157TEST(AnnotationsTest, Errors) {158 // Annotations use llvm_unreachable, it will only crash in debug mode.159#ifndef NDEBUG160 // point() and range() crash on zero or multiple ranges.161 EXPECT_DEATH(llvm::Annotations("ab[[c]]def").point(),162 "expected exactly one point");163 EXPECT_DEATH(llvm::Annotations("a^b^cdef").point(),164 "expected exactly one point");165 166 EXPECT_DEATH(llvm::Annotations("a^bcdef").range(),167 "expected exactly one range");168 EXPECT_DEATH(llvm::Annotations("a[[b]]c[[d]]ef").range(),169 "expected exactly one range");170 171 EXPECT_DEATH(llvm::Annotations("$foo^a$foo^a").point("foo"),172 "expected exactly one point");173 EXPECT_DEATH(llvm::Annotations("$foo[[a]]bc$foo[[a]]").range("foo"),174 "expected exactly one range");175 176 // Parsing failures.177 EXPECT_DEATH(llvm::Annotations("ff[[fdfd"), "unmatched \\[\\[");178 EXPECT_DEATH(llvm::Annotations("ff[[fdjsfjd]]xxx]]"), "unmatched \\]\\]");179 EXPECT_DEATH(llvm::Annotations("ff$fdsfd"), "unterminated \\$name");180 EXPECT_DEATH(llvm::Annotations("ff$("), "unterminated payload");181 EXPECT_DEATH(llvm::Annotations("ff$name("), "unterminated payload");182#endif183}184} // namespace185