Extensions: Switch to new permission message system, part I

extensions/common/permissions/permission_message_test_util.cc

+// Copyright 2015 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.
+
+#include "extensions/common/permissions/permission_message_test_util.h"
+
+#include <algorithm>
+#include <iterator>
+
+#include "base/strings/string_split.h"
+#include "base/strings/string_util.h"
+#include "base/strings/utf_string_conversions.h"
+#include "extensions/common/permissions/permission_message_provider.h"
+#include "extensions/common/permissions/permissions_data.h"
+
+// TODO(treib): Remove the legacy messages once we've fully switched to the new
+// permission message system.
+
+namespace extensions {
+
+namespace {
+
+class ScopedForcePermissionMessageSystem {
+ public:
+  ScopedForcePermissionMessageSystem(ForceForTesting force) {
+    extensions::ForcePermissionMessageSystemForTesting(force);
+  }
+  ~ScopedForcePermissionMessageSystem() {
+    extensions::ForcePermissionMessageSystemForTesting(
+        ForceForTesting::DONT_FORCE);
+  }
+};
+
+PermissionMessageStrings GetLegacyMessages(
+    const PermissionsData* permissions_data) {
+  ScopedForcePermissionMessageSystem force(ForceForTesting::FORCE_OLD);
+  return permissions_data->GetPermissionMessageStrings();
+}
+
+PermissionMessageStrings GetLegacyMessages(const PermissionSet* permissions,
+                                           Manifest::Type extension_type) {
+  ScopedForcePermissionMessageSystem force(ForceForTesting::FORCE_OLD);
+  return PermissionMessageProvider::Get()->GetPermissionMessageStrings(
+      permissions, extension_type);
+}
+
+PermissionMessageStrings GetNewMessages(
+    const PermissionsData* permissions_data) {
+  ScopedForcePermissionMessageSystem force(ForceForTesting::FORCE_NEW);
+  return permissions_data->GetPermissionMessageStrings();
+}
+
+PermissionMessageStrings GetNewMessages(const PermissionSet* permissions,
+                                        Manifest::Type extension_type) {
+  ScopedForcePermissionMessageSystem force(ForceForTesting::FORCE_NEW);
+  return PermissionMessageProvider::Get()->GetPermissionMessageStrings(
+      permissions, extension_type);
+}
+
+std::vector<base::string16> MakeVectorString16(const base::string16& str) {
+  return std::vector<base::string16>(1, str);
+}
+
+std::vector<base::string16> MakeVectorString16(const base::string16& str1,
+                                               const base::string16& str2) {
+  std::vector<base::string16> result;
+  result.push_back(str1);
+  result.push_back(str2);
+  return result;
+}
+
+std::vector<base::string16> MakeVectorString16(const std::string& str1,
+                                               const std::string& str2) {
+  return MakeVectorString16(base::UTF8ToUTF16(str1), base::UTF8ToUTF16(str2));
+}
+
+std::vector<base::string16> MakeVectorString16(
+    const std::vector<std::string>& vec) {
+  std::vector<base::string16> result;
+  for (const std::string& msg : vec)
+    result.push_back(base::UTF8ToUTF16(msg));
+  return result;
+}
+
+std::vector<std::vector<base::string16>> MakeVectorVectorString16(
+    const std::vector<base::string16>& vec) {
+  return std::vector<std::vector<base::string16>>(1, vec);
+}
+
+std::vector<std::vector<base::string16>> MakeVectorVectorString16(
+    const std::vector<std::vector<std::string>>& vecs) {
+  std::vector<std::vector<base::string16>> result;
+  for (const std::vector<std::string>& vec : vecs)
+    result.push_back(MakeVectorString16(vec));
+  return result;
+}
+
+// Returns the vector of messages concatenated into a single string, separated
+// by newlines, e.g.: "Bar"\n"Baz"\n
+base::string16 MessagesVectorToString(
+    const std::vector<base::string16>& messages) {
+  if (messages.empty())
+    return base::ASCIIToUTF16("\n");
+  return base::ASCIIToUTF16("\"") +
+         JoinString(messages, base::ASCIIToUTF16("\"\n\"")) +
+         base::ASCIIToUTF16("\"\n");
+}
+
+base::string16 MessagesToString(const PermissionMessageStrings& messages) {
+  std::vector<base::string16> messages_vec;
+  for (const PermissionMessageString& msg : messages)
+    messages_vec.push_back(msg.message);
+  return MessagesVectorToString(messages_vec);
+}
+
+bool CheckThatSubmessagesMatch(
+    const PermissionMessageString& message,

[Yoyo Zhou, 2015/03/17 00:02:05]

Call this expected_message

[Marc Treib, 2015/03/17 10:00:27]

Done.

+    const std::vector<base::string16>& actual_legacy_submessages,
+    const std::vector<base::string16>& actual_submessages) {
+  bool result = true;
+
+  std::vector<base::string16> expected_sorted;
+  for (const base::string16& submessage : message.submessages)
+    expected_sorted.push_back(submessage);
+  std::sort(expected_sorted.begin(), expected_sorted.end());
+
+  std::vector<base::string16> actual_legacy_sorted(actual_legacy_submessages);
+  std::sort(actual_legacy_sorted.begin(), actual_legacy_sorted.end());
+  if (expected_sorted != actual_legacy_sorted) {
+    // This is always a failure, even within an EXPECT_FALSE.
+    // Message: Expected details for "Message" to be { "Foo" }, but got
+    // { "Bar", "Baz" } in the legacy system
+    ADD_FAILURE() << "Expected details for \"" << message.message
+                  << "\" to be:\n" << MessagesVectorToString(expected_sorted)
+                  << "But got:\n"
+                  << MessagesVectorToString(actual_legacy_sorted)
+                  << "in the legacy system";
+    result = false;
+  }
+
+  std::vector<base::string16> actual_sorted(actual_submessages);
+  std::sort(actual_sorted.begin(), actual_sorted.end());
+  if (actual_sorted != actual_submessages) {
+    // This is always a failure, even within an EXPECT_FALSE.
+    // Message: Expected submessages for "Message" to be { "Foo" }, but got
+    // { "Bar", "Baz" }
+    ADD_FAILURE() << "Expected submessages for \"" << message.message
+                  << "\" to be:\n" << MessagesVectorToString(expected_sorted)
+                  << "But got:\n" << MessagesVectorToString(actual_sorted);
+    result = false;
+  }
+
+  return result;
+}
+
+testing::AssertionResult VerifyHasPermissionMessageImpl(

[Yoyo Zhou, 2015/03/17 00:02:05]

I notice the order of arguments here is different from CheckThatSubmessagesMatch
- the convention is usually that expected comes before actual. I would also
check that the name of this function actually makes sense. This is more like
checking that messages match.

[Marc Treib, 2015/03/17 10:00:27]

Argument order fixed.
I think the name does make sense though: This checks for existence of the
(single) expected_message within the (multiple) actual_messages. Always open for
better suggestions, though :)

+    const PermissionMessageStrings& actual_legacy_messages,
+    const PermissionMessageStrings& actual_messages,
+    const PermissionMessageString& expected_message) {
+  auto legacy_message_it =
+      std::find_if(actual_legacy_messages.begin(), actual_legacy_messages.end(),
+                   [&expected_message](const PermissionMessageString& msg) {
+                     return msg.message == expected_message.message;
+                   });
+  bool legacy_found = legacy_message_it != actual_legacy_messages.end();
+
+  auto message_it =
+      std::find_if(actual_messages.begin(), actual_messages.end(),
+                   [&expected_message](const PermissionMessageString& msg) {
+                     return msg.message == expected_message.message;
+                   });
+  bool found = message_it != actual_messages.end();
+
+  if (legacy_found != found) {
+    // This is always a failure, even within an EXPECT_FALSE.
+    ADD_FAILURE()
+        << "Mismatch between legacy and new system when looking for \""
+        << expected_message.message << "\".\nLegacy system returned:\n"
+        << MessagesToString(actual_legacy_messages)
+        << "New system returned:\n" << MessagesToString(actual_messages);
+    return testing::AssertionFailure();
+  }
+
+  if (!found) {
+    // Message: Expected messages to contain "Foo", but got { "Bar", "Baz" }
+    return testing::AssertionFailure() << "Expected messages to contain \""
+                                       << expected_message.message
+                                       << "\", but got "
+                                       << MessagesToString(actual_messages);
+  }
+
+  if (!CheckThatSubmessagesMatch(expected_message,
+                                 legacy_message_it->submessages,
+                                 message_it->submessages)) {
+    return testing::AssertionFailure();
+  }
+
+  // Message: Expected messages NOT to contain "Foo", but got { "Bar", "Baz" }
+  return testing::AssertionSuccess() << "Expected messages NOT to contain \""
+                                     << expected_message.message
+                                     << "\", but got "
+                                     << MessagesToString(actual_messages);
+}
+
+testing::AssertionResult VerifyPermissionMessagesWithSubmessagesImpl(

[Yoyo Zhou, 2015/03/17 00:02:05]

ditto here

[Marc Treib, 2015/03/17 10:00:27]

Done.

+    const PermissionMessageStrings& actual_legacy_messages,
+    const PermissionMessageStrings& actual_messages,
+    const PermissionMessageStrings& expected_messages,
+    bool check_order) {
+  if (expected_messages.size() != actual_legacy_messages.size()) {
+    // Message: Expected 2 messages { "Bar", "Baz" }, but got 0 {} in the
+    // legacy system
+    return testing::AssertionFailure()
+           << "Expected " << expected_messages.size() << " messages:\n"
+           << MessagesToString(expected_messages) << "But got "
+           << actual_legacy_messages.size() << " messages:\n"
+           << MessagesToString(actual_legacy_messages)
+           << "in the legacy system";
+  }
+
+  if (expected_messages.size() != actual_messages.size()) {
+    // Message: Expected 2 messages { "Bar", "Baz" }, but got 0 {}
+    return testing::AssertionFailure()
+           << "Expected " << expected_messages.size() << " messages:\n"
+           << MessagesToString(expected_messages) << "But got "
+           << actual_messages.size() << " messages:\n"
+           << MessagesToString(actual_messages);
+  }
+
+  if (check_order) {
+    for (size_t i = 0; i < expected_messages.size(); i++) {
+      if (expected_messages[i].message != actual_legacy_messages[i].message) {
+        // Message: Expected messages to be { "Foo" }, but got { "Bar", "Baz" }
+        // in the legacy system
+        return testing::AssertionFailure()
+               << "Expected messages to be:\n"
+               << MessagesToString(expected_messages) << "But got:\n"
+               << MessagesToString(actual_legacy_messages)
+               << "in the legacy system";
+      }
+
+      if (expected_messages[i].message != actual_messages[i].message) {
+        // Message: Expected messages to be { "Foo" }, but got { "Bar", "Baz" }
+        return testing::AssertionFailure()
+               << "Expected messages to be:\n"
+               << MessagesToString(expected_messages) << "But got:\n"
+               << MessagesToString(actual_messages);
+      }
+
+      if (!CheckThatSubmessagesMatch(expected_messages[i],
+                                     actual_legacy_messages[i].submessages,
+                                     actual_messages[i].submessages)) {
+        return testing::AssertionFailure();
+      }
+    }
+  } else {
+    for (size_t i = 0; i < expected_messages.size(); i++) {
+      testing::AssertionResult result = VerifyHasPermissionMessageImpl(
+          actual_legacy_messages, actual_messages, expected_messages[i]);
+      if (!result)
+        return result;
+    }
+  }
+  return testing::AssertionSuccess();
+}
+
+}  // namespace
+
+testing::AssertionResult VerifyHasPermissionMessage(
+    const PermissionsData* permissions_data,
+    const std::string& expected_message) {
+  return VerifyHasPermissionMessage(permissions_data,
+                                    base::UTF8ToUTF16(expected_message));
+}
+
+testing::AssertionResult VerifyHasPermissionMessage(
+    const PermissionsData* permissions_data,
+    const base::string16& expected_message) {
+  return VerifyHasPermissionMessageImpl(
+      GetLegacyMessages(permissions_data), GetNewMessages(permissions_data),
+      PermissionMessageString(expected_message));
+}
+
+testing::AssertionResult VerifyHasPermissionMessage(
+    const PermissionSet* permissions,
+    Manifest::Type extension_type,
+    const std::string& expected_message) {
+  return VerifyHasPermissionMessage(permissions, extension_type,
+                                    base::UTF8ToUTF16(expected_message));
+}
+
+testing::AssertionResult VerifyHasPermissionMessage(
+    const PermissionSet* permissions,
+    Manifest::Type extension_type,
+    const base::string16& expected_message) {
+  return VerifyHasPermissionMessageImpl(
+      GetLegacyMessages(permissions, extension_type),
+      GetNewMessages(permissions, extension_type),
+      PermissionMessageString(expected_message));
+}
+
+testing::AssertionResult VerifyNoPermissionMessages(
+    const PermissionsData* permissions_data) {
+  return VerifyPermissionMessages(permissions_data,
+                                  std::vector<base::string16>(), true);
+}
+
+testing::AssertionResult VerifyOnePermissionMessage(
+    const PermissionsData* permissions_data,
+    const std::string& expected_message) {
+  return VerifyOnePermissionMessage(permissions_data,
+                                    base::UTF8ToUTF16(expected_message));
+}
+
+testing::AssertionResult VerifyOnePermissionMessage(
+    const PermissionsData* permissions_data,
+    const base::string16& expected_message) {
+  return VerifyPermissionMessages(permissions_data,
+                                  MakeVectorString16(expected_message), true);
+}
+
+testing::AssertionResult VerifyOnePermissionMessage(
+    const PermissionSet* permissions,
+    Manifest::Type extension_type,
+    const base::string16& expected_message) {
+  return VerifyPermissionMessagesWithSubmessagesImpl(
+      GetLegacyMessages(permissions, extension_type),
+      GetNewMessages(permissions, extension_type),
+      PermissionMessageStrings(1, PermissionMessageString(expected_message)),
+      true);
+}
+
+testing::AssertionResult VerifyOnePermissionMessageWithSubmessages(
+    const PermissionsData* permissions_data,
+    const std::string& expected_message,
+    const std::vector<std::string>& expected_submessages) {
+  return VerifyOnePermissionMessageWithSubmessages(
+      permissions_data, base::UTF8ToUTF16(expected_message),
+      MakeVectorString16(expected_submessages));
+}
+
+testing::AssertionResult VerifyOnePermissionMessageWithSubmessages(
+    const PermissionsData* permissions_data,
+    const base::string16& expected_message,
+    const std::vector<base::string16>& expected_submessages) {
+  return VerifyPermissionMessagesWithSubmessages(
+      permissions_data, MakeVectorString16(expected_message),
+      MakeVectorVectorString16(expected_submessages), true);
+}
+
+testing::AssertionResult VerifyTwoPermissionMessages(
+    const PermissionsData* permissions_data,
+    const std::string& expected_message_1,
+    const std::string& expected_message_2,
+    bool check_order) {
+  return VerifyPermissionMessages(
+      permissions_data,
+      MakeVectorString16(expected_message_1, expected_message_2), check_order);
+}
+
+testing::AssertionResult VerifyTwoPermissionMessages(
+    const PermissionsData* permissions_data,
+    const base::string16& expected_message_1,
+    const base::string16& expected_message_2,
+    bool check_order) {
+  return VerifyPermissionMessages(
+      permissions_data,
+      MakeVectorString16(expected_message_1, expected_message_2), check_order);
+}
+
+testing::AssertionResult VerifyPermissionMessages(
+    const PermissionsData* permissions_data,
+    const std::vector<std::string>& expected_messages,
+    bool check_order) {
+  return VerifyPermissionMessages(
+      permissions_data, MakeVectorString16(expected_messages), check_order);
+}
+
+testing::AssertionResult VerifyPermissionMessages(
+    const PermissionsData* permissions_data,
+    const std::vector<base::string16>& expected_messages,
+    bool check_order) {
+  return VerifyPermissionMessagesWithSubmessages(
+      permissions_data, expected_messages,
+      std::vector<std::vector<base::string16>>(expected_messages.size()),
+      check_order);
+}
+
+testing::AssertionResult VerifyPermissionMessagesWithSubmessages(
+    const PermissionsData* permissions_data,
+    const std::vector<std::string>& expected_messages,
+    const std::vector<std::vector<std::string>>& expected_submessages,
+    bool check_order) {
+  return VerifyPermissionMessagesWithSubmessages(
+      permissions_data, MakeVectorString16(expected_messages),
+      MakeVectorVectorString16(expected_submessages), check_order);
+}
+
+testing::AssertionResult VerifyPermissionMessagesWithSubmessages(
+    const PermissionsData* permissions_data,
+    const std::vector<base::string16>& expected_messages,
+    const std::vector<std::vector<base::string16>>& expected_submessages,
+    bool check_order) {
+  CHECK_EQ(expected_messages.size(), expected_submessages.size());
+  PermissionMessageStrings expected;
+  for (size_t i = 0; i < expected_messages.size(); i++) {
+    expected.push_back(PermissionMessageString(expected_messages[i],
+                                               expected_submessages[i]));
+  }
+  return VerifyPermissionMessagesWithSubmessagesImpl(
+      GetLegacyMessages(permissions_data), GetNewMessages(permissions_data),
+      expected, check_order);
+}
+
+}  // namespace extensions