1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
// Copyright 2014 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.
#ifndef CHROME_BROWSER_EXTENSIONS_EXTENSION_API_UNITTEST_H_
#define CHROME_BROWSER_EXTENSIONS_EXTENSION_API_UNITTEST_H_
#include <string>
#include "base/memory/ref_counted.h"
#include "base/memory/scoped_ptr.h"
#include "chrome/test/base/browser_with_test_window_test.h"
namespace base {
class Value;
class DictionaryValue;
class ListValue;
}
namespace content {
class WebContents;
}
class UIThreadExtensionFunction;
namespace extensions {
// Use this class to enable calling API functions in a unittest.
// By default, this class will create and load an empty unpacked |extension_|,
// which will be used in all API function calls. This extension can be
// overridden using set_extension().
// By default, this class does not create a WebContents for the API functions.
// If a WebContents is needed, calling CreateBackgroundPage() will create a
// background page for the extension and use it in API function calls. (If
// needed, this could be expanded to allow for alternate WebContents).
// When calling RunFunction[AndReturn*], |args| should be in JSON format,
// wrapped in a list. See also RunFunction* in extension_function_test_utils.h.
// TODO(yoz): Move users of this base class to use the equivalent base class
// in extensions/browser/api_unittest.h.
class ExtensionApiUnittest : public BrowserWithTestWindowTest {
public:
ExtensionApiUnittest();
~ExtensionApiUnittest() override;
content::WebContents* contents() { return contents_; }
const Extension* extension() const { return extension_.get(); }
scoped_refptr<Extension> extension_ref() { return extension_; }
void set_extension(scoped_refptr<Extension> extension) {
extension_ = extension;
}
protected:
// SetUp creates and loads an empty, unpacked Extension.
void SetUp() override;
// Creates a background page for |extension_|, and sets it for the WebContents
// to be used in API calls.
// If |contents_| is already set, this does nothing.
void CreateBackgroundPage();
// Various ways of running an API function. These methods take ownership of
// |function|. |args| should be in JSON format, wrapped in a list.
// See also the RunFunction* methods in extension_function_test_utils.h.
// Return the function result as a base::Value.
scoped_ptr<base::Value> RunFunctionAndReturnValue(
UIThreadExtensionFunction* function, const std::string& args);
// Return the function result as a base::DictionaryValue, or NULL.
// This will EXPECT-fail if the result is not a DictionaryValue.
scoped_ptr<base::DictionaryValue> RunFunctionAndReturnDictionary(
UIThreadExtensionFunction* function, const std::string& args);
// Return the function result as a base::ListValue, or NULL.
// This will EXPECT-fail if the result is not a ListValue.
scoped_ptr<base::ListValue> RunFunctionAndReturnList(
UIThreadExtensionFunction* function, const std::string& args);
// Return an error thrown from the function, if one exists.
// This will EXPECT-fail if any result is returned from the function.
std::string RunFunctionAndReturnError(
UIThreadExtensionFunction* function, const std::string& args);
// Run the function and ignore any result.
void RunFunction(
UIThreadExtensionFunction* function, const std::string& args);
private:
// The WebContents used to associate a RenderViewHost with API function calls,
// or NULL.
content::WebContents* contents_;
// The Extension used when running API function calls.
scoped_refptr<Extension> extension_;
};
} // namespace extensions
#endif // CHROME_BROWSER_EXTENSIONS_EXTENSION_API_UNITTEST_H_
|
