catalog_unittests.cc

Go to the documentation of this file.

// Copyright 2013 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "flutter/tools/licenses_cpp/src/catalog.h"
#include "gtest/gtest.h"
 
static const char* kEntry = R"entry(google
Copyright \‍(c\) \d+ Google Inc
Copyright \‍(c\) \d+ Google Inc. All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
 
  \* Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
 
  \* Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in
    the documentation and/or other materials provided with the
    distribution.
 
  \* Neither the name of the copyright holder nor the names of its
    contributors may be used to endorse or promote products derived
    from this software without specific prior written permission.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES \‍(INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION\) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
\‍(INCLUDING NEGLIGENCE OR OTHERWISE\) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
)entry";
 
static const char* kSkiaLicense =
    R"entry(Copyright (c) 2011 Google Inc. All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
 
  * Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
 
  * Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in
    the documentation and/or other materials provided with the
    distribution.
 
  * Neither the name of the copyright holder nor the names of its
    contributors may be used to endorse or promote products derived
    from this software without specific prior written permission.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
)entry";
 
TEST(CatalogTest, Simple) {
  absl::StatusOr<Catalog> catalog =
      Catalog::Make({{"foobar", ".*foo.*", ".*foo.*"}});
  ASSERT_TRUE(catalog.ok());
  absl::StatusOr<std::vector<Catalog::Match>> match = catalog->FindMatch("foo");
  ASSERT_TRUE(match.ok());
  ASSERT_EQ(match->front().GetMatcher(), "foobar");
}
 
TEST(CatalogTest, MultipleMatchOverlapping) {
  absl::StatusOr<Catalog> catalog = Catalog::Make(
      {{"matcher1", ".*foo.*", ".*foo.*"}, {"matcher2", ".*oo.*", ".*oo.*"}});
  ASSERT_TRUE(catalog.ok()) << catalog.status();
  absl::StatusOr<std::vector<Catalog::Match>> has_match =
      catalog->FindMatch("foo");
  ASSERT_FALSE(has_match.ok());
  ASSERT_TRUE(RE2::PartialMatch(has_match.status().message(),
                                "Selected matchers overlap"))
      << has_match.status().message();
  ASSERT_TRUE(RE2::PartialMatch(has_match.status().message(), "matcher1"))
      << has_match.status().message();
  ASSERT_TRUE(RE2::PartialMatch(has_match.status().message(), "matcher2"))
      << has_match.status().message();
}
 
TEST(CatalogTest, MultipleSelectorsFail) {
  absl::StatusOr<Catalog> catalog = Catalog::Make(
      {{"matcher1", ".*foo.*", "blah"}, {"matcher2", ".*oo.*", "blah"}});
  ASSERT_TRUE(catalog.ok()) << catalog.status();
  absl::StatusOr<std::vector<Catalog::Match>> has_match =
      catalog->FindMatch("foo");
  ASSERT_FALSE(has_match.ok());
  ASSERT_TRUE(RE2::PartialMatch(has_match.status().message(), "matcher1"))
      << has_match.status().message();
  ASSERT_TRUE(RE2::PartialMatch(has_match.status().message(), "matcher2"))
      << has_match.status().message();
}
 
TEST(CatalogTest, OnlyOneSelectorsFail) {
  absl::StatusOr<Catalog> catalog = Catalog::Make(
      {{"matcher1", ".*foo.*", ".*foo.*"}, {"matcher2", ".*oo.*", "blah"}});
  ASSERT_TRUE(catalog.ok()) << catalog.status();
  absl::StatusOr<std::vector<Catalog::Match>> has_match =
      catalog->FindMatch("foo");
  ASSERT_FALSE(has_match.ok());
  ASSERT_TRUE(RE2::PartialMatch(has_match.status().message(), "matcher1"))
      << has_match.status().message();
  ASSERT_TRUE(RE2::PartialMatch(has_match.status().message(), "matcher2"))
      << has_match.status().message();
}
 
TEST(CatalogTest, MultipleMatchNoOverlap) {
  absl::StatusOr<Catalog> catalog =
      Catalog::Make({{"foo", ".*foo", ".*foo"}, {"bar", "bar.*", "bar.*"}});
  ASSERT_TRUE(catalog.ok()) << catalog.status();
  absl::StatusOr<std::vector<Catalog::Match>> has_match =
      catalog->FindMatch("hello foo bar world");
  ASSERT_TRUE(has_match.ok()) << has_match.status();
}
 
TEST(CatalogTest, NoSelectorMatch) {
  absl::StatusOr<Catalog> catalog =
      Catalog::Make({{"foobar", ".*bar.*", ".*foo.*"}});
  ASSERT_TRUE(catalog.ok());
  absl::StatusOr<std::vector<Catalog::Match>> match = catalog->FindMatch("foo");
  ASSERT_FALSE(match.ok());
  ASSERT_EQ(match.status().code(), absl::StatusCode::kNotFound);
}
 
TEST(CatalogTest, NoSelectionMatch) {
  absl::StatusOr<Catalog> catalog =
      Catalog::Make({{"foobar", ".*foo.*", ".*bar.*"}});
  ASSERT_TRUE(catalog.ok());
  absl::StatusOr<std::vector<Catalog::Match>> match = catalog->FindMatch("foo");
  ASSERT_FALSE(match.ok());
  ASSERT_EQ(match.status().code(), absl::StatusCode::kNotFound);
}
 
TEST(CatalogTest, SimpleParseEntry) {
  std::stringstream ss;
  ss << "foobar\n";
  ss << "unique\n";
  ss << R"match(Multiline
matcher
.*)match";
 
  absl::StatusOr<Catalog::Entry> entry = Catalog::ParseEntry(ss);
  EXPECT_TRUE(entry.ok()) << entry.status();
  if (entry.ok()) {
    EXPECT_EQ(entry->name, "foobar");
    EXPECT_EQ(entry->unique, "unique");
    EXPECT_EQ(entry->matcher, R"match(Multiline\s+matcher\s+.*)match");
  }
}
 
TEST(CatalogTest, SkiaLicense) {
  std::stringstream ss;
  ss << kEntry;
  absl::StatusOr<Catalog::Entry> entry = Catalog::ParseEntry(ss);
  ASSERT_TRUE(entry.ok()) << entry.status();
  absl::StatusOr<Catalog> catalog = Catalog::Make({*entry});
  ASSERT_TRUE(catalog.ok());
  absl::StatusOr<std::vector<Catalog::Match>> match =
      catalog->FindMatch(kSkiaLicense);
  EXPECT_TRUE(match.ok()) << match.status();
}
 
namespace {
std::string RemoveNewlines(std::string_view input) {
  if (input.empty()) {
    return std::string();
  }
  std::string no_newline;
  char last_char = input[0];
  for (size_t i = 1; i < input.size(); ++i) {
    char current = input[i];
    if (last_char == '\n' && current == '\n') {
      no_newline.push_back('\n');
      no_newline.push_back('\n');
    } else if (last_char == '\n') {
      no_newline.push_back(' ');
    } else {
      no_newline.push_back(last_char);
    }
    last_char = current;
  }
  if (last_char != '\n') {
    no_newline.push_back(last_char);
  }
  return no_newline;
}
}  // namespace
 
TEST(CatalogTest, SkiaLicenseIgnoreWhitespace) {
  std::stringstream ss;
  ss << kEntry;
  absl::StatusOr<Catalog::Entry> entry = Catalog::ParseEntry(ss);
  ASSERT_TRUE(entry.ok()) << entry.status();
  absl::StatusOr<Catalog> catalog = Catalog::Make({*entry});
  ASSERT_TRUE(catalog.ok());
 
  std::string no_newline_license = RemoveNewlines(kSkiaLicense);
 
  absl::StatusOr<std::vector<Catalog::Match>> match =
      catalog->FindMatch(no_newline_license);
  ASSERT_TRUE(match.ok()) << match.status();
  ASSERT_EQ(match->size(), 1u);
  EXPECT_EQ(match->at(0).GetMatchedText(), no_newline_license);
}
 
TEST(CatalogTest, SkiaLicenseIgnoreTrailing) {
  std::stringstream ss;
  ss << kEntry;
  absl::StatusOr<Catalog::Entry> entry = Catalog::ParseEntry(ss);
  ASSERT_TRUE(entry.ok()) << entry.status();
  absl::StatusOr<Catalog> catalog = Catalog::Make({*entry});
  ASSERT_TRUE(catalog.ok());
 
  std::string no_end(kSkiaLicense);
  ASSERT_EQ(no_end.back(), '\n');
  no_end.pop_back();
 
  absl::StatusOr<std::vector<Catalog::Match>> match =
      catalog->FindMatch(no_end);
  EXPECT_TRUE(match.ok()) << match.status();
}
 
TEST(CatalogTest, ExtractsGroups) {
  std::string entry_text = R"entry(entry
start.*stop.*last
start(.*)stop(.*)last
)entry";
  std::stringstream ss;
  ss << entry_text;
  absl::StatusOr<Catalog::Entry> entry = Catalog::ParseEntry(ss);
  ASSERT_TRUE(entry.ok()) << entry.status();
  absl::StatusOr<Catalog> catalog = Catalog::Make({*entry});
  ASSERT_TRUE(catalog.ok());
 
  std::string text = "start hello stop world last";
 
  absl::StatusOr<std::vector<Catalog::Match>> match = catalog->FindMatch(text);
  EXPECT_TRUE(match.ok()) << match.status();
  ASSERT_EQ(match->size(), 1u);
  EXPECT_EQ(match->at(0).GetMatchedText(), "startstoplast");
}
 
TEST(CatalogTest, OptionalGroups) {
  std::string entry_text = R"entry(entry
start.*middle(?:foo)?end
start(.*)middle(?:(foo))?end
)entry";
  std::stringstream ss;
  ss << entry_text;
  absl::StatusOr<Catalog::Entry> entry = Catalog::ParseEntry(ss);
  ASSERT_TRUE(entry.ok()) << entry.status();
  absl::StatusOr<Catalog> catalog = Catalog::Make({*entry});
  ASSERT_TRUE(catalog.ok());
 
  std::string text = "start hello middleend";
  absl::StatusOr<std::vector<Catalog::Match>> match = catalog->FindMatch(text);
  EXPECT_TRUE(match.ok()) << match.status();
  ASSERT_EQ(match->size(), 1u);
  EXPECT_EQ(match->at(0).GetMatchedText(), "startmiddleend");
}