Move Command class out of the Extension class and into its own location (under chrome/common/exten…

chrome/common/extensions/extension_commands_unittest.cc

+// Copyright (c) 2012 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 "chrome/common/extensions/extension_commands.h"
+
+#include "base/memory/scoped_ptr.h"
+#include "base/string_number_conversions.h"
+#include "base/values.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+class ExtensionCommandsTest : public testing::Test {
+};
+
+TEST(ExtensionCommandsTest, ExtensionCommandParsing) {
+  const ui::Accelerator None = ui::Accelerator();
+  const ui::Accelerator ShiftF =
+      ui::Accelerator(ui::VKEY_F, true, false, false);
+  const ui::Accelerator CtrlF =
+      ui::Accelerator(ui::VKEY_F, false, true, false);
+  const ui::Accelerator AltF =
+      ui::Accelerator(ui::VKEY_F, false, false, true);
+  const ui::Accelerator CtrlShiftF =
+      ui::Accelerator(ui::VKEY_F, true, true, false);
+  const ui::Accelerator AltShiftF =
+      ui::Accelerator(ui::VKEY_F, true, false, true);
+
+  const struct {
+    bool expected_result;
+    ui::Accelerator accelerator;
+    const char* command_name;
+    const char* key;
+    const char* description;
+  } kTests[] = {
+    // Negative test (one or more missing required fields). We don't need to
+    // test |command_name| being blank as it is used as a key in the manifest,
+    // so it can't be blank (and we CHECK() when it is).
+    { false, None, "command", "",       "" },
+    { false, None, "command", "Ctrl+f", "" },
+    { false, None, "command", "",       "description" },
+    // Ctrl+Alt is not permitted, see MSDN link in comments in Parse function.
+    { false, None, "command", "Ctrl+Alt+F", "description" },
+    // Unsupported shortcuts/too many, or missing modifier.
+    { false, None, "command", "A",                "description" },
+    { false, None, "command", "F10",              "description" },
+    { false, None, "command", "Ctrl+1",           "description" },
+    { false, None, "command", "Ctrl+F+G",         "description" },
+    { false, None, "command", "Ctrl+Alt+Shift+G", "description" },
+    // Basic tests.
+    { true, CtrlF,      "command", "Ctrl+F",       "description" },
+    { true, ShiftF,     "command", "Shift+F",      "description" },
+    { true, AltF,       "command", "Alt+F",        "description" },
+    { true, CtrlShiftF, "command", "Ctrl+Shift+F", "description" },
+    { true, AltShiftF,  "command", "Alt+Shift+F",  "description" },
+    // Order tests.
+    { true, CtrlF,      "command", "F+Ctrl",       "description" },
+    { true, ShiftF,     "command", "F+Shift",      "description" },
+    { true, AltF,       "command", "F+Alt",        "description" },
+    { true, CtrlShiftF, "command", "F+Ctrl+Shift", "description" },
+    { true, CtrlShiftF, "command", "F+Shift+Ctrl", "description" },
+    { true, AltShiftF,  "command", "F+Alt+Shift",  "description" },
+    { true, AltShiftF,  "command", "F+Shift+Alt",  "description" },
+    // Case insensitivity is not OK.
+    { false, CtrlF, "command", "Ctrl+f", "description" },
+    { false, CtrlF, "command", "cTrL+F", "description" },
+    // Skipping description is OK for browser- and pageActions.
+    { true, CtrlF, "_execute_browser_action", "Ctrl+F", "" },
+    { true, CtrlF, "_execute_page_action",    "Ctrl+F", "" },
+  };
+
+  // TODO(finnur): test Command/Options on Mac when implemented.
+
+  for (size_t i = 0; i < ARRAYSIZE_UNSAFE(kTests); ++i) {
+    // First parse the command as a simple string.
+    scoped_ptr<DictionaryValue> input(new DictionaryValue);
+    input->SetString("suggested_key", kTests[i].key);
+    input->SetString("description", kTests[i].description);
+
+    SCOPED_TRACE(std::string("Command name: |") + kTests[i].command_name +
+                 "| key: |" + kTests[i].key +
+                 "| description: |" + kTests[i].description +
+                 "| index: " + base::IntToString(i));
+
+    extensions::Command command;
+    string16 error;
+    bool result =
+        command.Parse(input.get(), kTests[i].command_name, i, &error);
+
+    EXPECT_EQ(kTests[i].expected_result, result);
+    if (result) {
+      EXPECT_STREQ(kTests[i].description, command.description().c_str());
+      EXPECT_STREQ(kTests[i].command_name, command.command_name().c_str());
+      EXPECT_EQ(kTests[i].accelerator, command.accelerator());
+    }
+
+    // Now parse the command as a dictionary of multiple values.
+    input.reset(new DictionaryValue);
+    DictionaryValue* key_dict = new DictionaryValue();
+    key_dict->SetString("default", kTests[i].key);
+    key_dict->SetString("windows", kTests[i].key);
+    key_dict->SetString("mac", kTests[i].key);
+    input->Set("suggested_key", key_dict);
+    input->SetString("description", kTests[i].description);
+
+    result = command.Parse(input.get(), kTests[i].command_name, i, &error);
+
+    EXPECT_EQ(kTests[i].expected_result, result);
+    if (result) {
+      EXPECT_STREQ(kTests[i].description, command.description().c_str());
+      EXPECT_STREQ(kTests[i].command_name, command.command_name().c_str());
+      EXPECT_EQ(kTests[i].accelerator, command.accelerator());
+    }
+  }
+}
+
+TEST(ExtensionCommandsTest, ExtensionCommandParsingFallback) {
+  std::string description = "desc";
+  std::string command_name = "foo";
+
+  // Test that platform specific keys are honored on each platform, despite
+  // fallback being given.
+  scoped_ptr<DictionaryValue> input(new DictionaryValue);
+  DictionaryValue* key_dict = new DictionaryValue();
+  key_dict->SetString("default",  "Ctrl+Shift+D");
+  key_dict->SetString("windows",  "Ctrl+Shift+W");
+  key_dict->SetString("mac",      "Ctrl+Shift+M");
+  key_dict->SetString("linux",    "Ctrl+Shift+L");
+  key_dict->SetString("chromeos", "Ctrl+Shift+C");
+  input->Set("suggested_key", key_dict);
+  input->SetString("description", description);
+
+  extensions::Command command;
+  string16 error;
+  EXPECT_TRUE(command.Parse(input.get(), command_name, 0, &error));
+  EXPECT_STREQ(description.c_str(), command.description().c_str());
+  EXPECT_STREQ(command_name.c_str(), command.command_name().c_str());
+
+#if defined(OS_WIN)
+  ui::Accelerator accelerator(ui::VKEY_W, true, true, false);
+#elif defined(OS_MACOSX)
+  ui::Accelerator accelerator(ui::VKEY_M, true, true, false);
+#elif defined(OS_CHROMEOS)
+  ui::Accelerator accelerator(ui::VKEY_C, true, true, false);
+#elif defined(OS_LINUX)
+  ui::Accelerator accelerator(ui::VKEY_L, true, true, false);
+#else
+  ui::Accelerator accelerator(ui::VKEY_D, true, true, false);
+#endif
+  EXPECT_EQ(accelerator, command.accelerator());
+
+  // Misspell a platform.
+  key_dict->SetString("windosw", "Ctrl+M");
+  EXPECT_FALSE(command.Parse(input.get(), command_name, 0, &error));
+  EXPECT_TRUE(key_dict->Remove("windosw", NULL));
+
+  // Now remove platform specific keys (leaving just "default") and make sure
+  // every platform falls back to the default.
+  EXPECT_TRUE(key_dict->Remove("windows", NULL));
+  EXPECT_TRUE(key_dict->Remove("mac", NULL));
+  EXPECT_TRUE(key_dict->Remove("linux", NULL));
+  EXPECT_TRUE(key_dict->Remove("chromeos", NULL));
+  EXPECT_TRUE(command.Parse(input.get(), command_name, 0, &error));
+  EXPECT_EQ(ui::VKEY_D, command.accelerator().key_code());
+
+  // Now remove "default", leaving no option but failure. Or, in the words of
+  // the immortal Adam Savage: "Failure is always an option".
+  EXPECT_TRUE(key_dict->Remove("default", NULL));
+  EXPECT_FALSE(command.Parse(input.get(), command_name, 0, &error));
+
+  // Now add only a valid platform that we are not running on to make sure devs
+  // are notified of errors on other platforms.
+#if defined(OS_WIN)
+  key_dict->SetString("mac", "Ctrl+Shift+M");
+#else
+  key_dict->SetString("windows", "Ctrl+Shift+W");
+#endif
+  EXPECT_FALSE(command.Parse(input.get(), command_name, 0, &error));
+
+  // Make sure Mac specific keys are not processed on other platforms.
+#if !defined(OS_MACOSX)
+  key_dict->SetString("windows", "Command+Shift+M");
+  EXPECT_FALSE(command.Parse(input.get(), command_name, 0, &error));
+  key_dict->SetString("windows", "Options+Shift+M");
+  EXPECT_FALSE(command.Parse(input.get(), command_name, 0, &error));
+#endif
+}