extensions/browser/api/test/test_api.h

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef EXTENSIONS_BROWSER_API_TEST_TEST_API_H_
   6 #define EXTENSIONS_BROWSER_API_TEST_TEST_API_H_
   7
   8 #include "base/values.h"
   9 #include "extensions/browser/extension_function.h"
  10
  11 namespace base {
  12
  13 template <typename T>
  14 struct DefaultSingletonTraits;
  15
  16 }  // namespace base
  17
  18 namespace extensions {
  19
  20 // A function that is only available in tests.
  21 // Prior to running, checks that we are in a testing process.
  22 class TestExtensionFunction : public SyncExtensionFunction {
  23  protected:
  24   ~TestExtensionFunction() override;
  25
  26   // SyncExtensionFunction:
  27   bool RunSync() override;
  28
  29   virtual bool RunSafe() = 0;
  30 };
  31
  32 class TestNotifyPassFunction : public TestExtensionFunction {
  33  public:
  34   DECLARE_EXTENSION_FUNCTION("test.notifyPass", UNKNOWN)
  35
  36  protected:
  37   ~TestNotifyPassFunction() override;
  38
  39   // TestExtensionFunction:
  40   bool RunSafe() override;
  41 };
  42
  43 class TestNotifyFailFunction : public TestExtensionFunction {
  44  public:
  45   DECLARE_EXTENSION_FUNCTION("test.notifyFail", UNKNOWN)
  46
  47  protected:
  48   ~TestNotifyFailFunction() override;
  49
  50   // TestExtensionFunction:
  51   bool RunSafe() override;
  52 };
  53
  54 class TestLogFunction : public TestExtensionFunction {
  55  public:
  56   DECLARE_EXTENSION_FUNCTION("test.log", UNKNOWN)
  57
  58  protected:
  59   ~TestLogFunction() override;
  60
  61   // TestExtensionFunction:
  62   bool RunSafe() override;
  63 };
  64
  65 class TestSendMessageFunction : public AsyncExtensionFunction {
  66  public:
  67   DECLARE_EXTENSION_FUNCTION("test.sendMessage", UNKNOWN)
  68
  69   // Sends a reply back to the calling extension. Many extensions don't need
  70   // a reply and will just ignore it.
  71   void Reply(const std::string& message);
  72
  73   // Sends an error back to the calling extension.
  74   void ReplyWithError(const std::string& error);
  75
  76  protected:
  77   ~TestSendMessageFunction() override;
  78
  79   // ExtensionFunction:
  80   bool RunAsync() override;
  81 };
  82
  83 class TestGetConfigFunction : public TestExtensionFunction {
  84  public:
  85   DECLARE_EXTENSION_FUNCTION("test.getConfig", UNKNOWN)
  86
  87   // Set the dictionary returned by chrome.test.getConfig().
  88   // Does not take ownership of |value|.
  89   static void set_test_config_state(base::DictionaryValue* value);
  90
  91  protected:
  92   // Tests that set configuration state do so by calling
  93   // set_test_config_state() as part of test set up, and unsetting it
  94   // during tear down.  This singleton class holds a pointer to that
  95   // state, owned by the test code.
  96   class TestConfigState {
  97    public:
  98     static TestConfigState* GetInstance();
  99
 100     void set_config_state(base::DictionaryValue* config_state) {
 101       config_state_ = config_state;
 102     }
 103
 104     const base::DictionaryValue* config_state() { return config_state_; }
 105
 106    private:
 107     friend struct base::DefaultSingletonTraits<TestConfigState>;
 108     TestConfigState();
 109
 110     base::DictionaryValue* config_state_;
 111
 112     DISALLOW_COPY_AND_ASSIGN(TestConfigState);
 113   };
 114
 115   ~TestGetConfigFunction() override;
 116
 117   // TestExtensionFunction:
 118   bool RunSafe() override;
 119 };
 120
 121 class TestWaitForRoundTripFunction : public TestExtensionFunction {
 122  public:
 123   DECLARE_EXTENSION_FUNCTION("test.waitForRoundTrip", UNKNOWN)
 124
 125  protected:
 126   ~TestWaitForRoundTripFunction() override;
 127
 128   // TestExtensionFunction:
 129   bool RunSafe() override;
 130 };
 131
 132 }  // namespace extensions
 133
 134 #endif  // EXTENSIONS_BROWSER_API_TEST_TEST_API_H_