1 // Copyright (c) 2020 The Chromium Embedded Framework Authors. All rights 2 // reserved. Use of this source code is governed by a BSD-style license that 3 // can be found in the LICENSE file. 4 5 #ifndef CEF_TESTS_CEFTESTS_TEST_SERVER_H_ 6 #define CEF_TESTS_CEFTESTS_TEST_SERVER_H_ 7 #pragma once 8 9 #include <string> 10 11 #include "include/base/cef_bind.h" 12 #include "include/cef_registration.h" 13 #include "include/cef_request.h" 14 #include "include/cef_response.h" 15 #include "include/cef_server.h" 16 17 namespace test_server { 18 19 extern const char kServerAddress[]; 20 extern const uint16 kServerPort; 21 extern const char kServerScheme[]; 22 extern const char kServerOrigin[]; 23 24 typedef base::Closure DoneCallback; 25 26 typedef base::Callback<void(const std::string& server_origin)> 27 StartDoneCallback; 28 29 // Starts the server if it is not currently running, and executes |callback| on 30 // the UI thread. This method should be called by each test case that relies on 31 // the server. 32 void Start(const StartDoneCallback& callback); 33 34 // Stops the server if it is currently running, and executes |callback| on the 35 // UI thread. This method will be called by the test framework on shutdown. 36 void Stop(const DoneCallback& callback); 37 38 // Observer for CefServerHandler callbacks. Methods will be called on the UI 39 // thread. 40 class Observer { 41 public: 42 // Called when this Observer is registered. 43 virtual void OnRegistered() = 0; 44 45 // Called when this Observer is unregistered. 46 virtual void OnUnregistered() = 0; 47 48 // See CefServerHandler documentation for usage. Return true if the callback 49 // was handled. OnClientConnected(CefRefPtr<CefServer> server,int connection_id)50 virtual bool OnClientConnected(CefRefPtr<CefServer> server, 51 int connection_id) { 52 return false; 53 } OnClientDisconnected(CefRefPtr<CefServer> server,int connection_id)54 virtual bool OnClientDisconnected(CefRefPtr<CefServer> server, 55 int connection_id) { 56 return false; 57 } 58 virtual bool OnHttpRequest(CefRefPtr<CefServer> server, 59 int connection_id, 60 const CefString& client_address, 61 CefRefPtr<CefRequest> request) = 0; 62 63 protected: ~Observer()64 virtual ~Observer() {} 65 }; 66 67 // Add an observer for CefServerHandler callbacks. Remains registered until the 68 // returned CefRegistration object is destroyed. Registered observers will be 69 // executed in the order of registration until one returns true to indicate that 70 // it handled the callback. |callback| will be executed on the UI thread after 71 // registration is complete. 72 CefRefPtr<CefRegistration> AddObserver(Observer* observer, 73 const DoneCallback& callback); 74 75 // Combination of AddObserver() followed by Start(). 76 CefRefPtr<CefRegistration> AddObserverAndStart( 77 Observer* observer, 78 const StartDoneCallback& callback); 79 80 // Helper for sending a fully qualified response. 81 void SendResponse(CefRefPtr<CefServer> server, 82 int connection_id, 83 CefRefPtr<CefResponse> response, 84 const std::string& response_data); 85 86 // Helper for managing Observer registration and callbacks. Only used on the UI 87 // thread. 88 class ObserverHelper : Observer { 89 public: 90 ObserverHelper(); 91 ~ObserverHelper() override; 92 93 // Initialize the registration. Results in a call to OnInitialized(). 94 void Initialize(); 95 96 // Shut down the registration. Results in a call to OnShutdown(). 97 void Shutdown(); 98 99 // Implement this method to start sending server requests after Initialize(). 100 virtual void OnInitialized(const std::string& server_origin) = 0; 101 102 // Implement this method to continue the test after Shutdown(). 103 virtual void OnShutdown() = 0; 104 105 private: 106 void OnStartDone(const std::string& server_origin); 107 void OnRegistered() override; 108 void OnUnregistered() override; 109 110 CefRefPtr<CefRegistration> registration_; 111 112 enum class State { 113 NONE, 114 INITIALIZING, 115 INITIALIZED, 116 SHUTTINGDOWN, 117 } state_ = State::NONE; 118 119 base::WeakPtrFactory<ObserverHelper> weak_ptr_factory_; 120 121 DISALLOW_COPY_AND_ASSIGN(ObserverHelper); 122 }; 123 124 } // namespace test_server 125 126 #endif // CEF_TESTS_CEFTESTS_TEST_SERVER_H_ 127