15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef CHROME_BROWSER_EXTENSIONS_EXTENSION_TEST_MESSAGE_LISTENER_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CHROME_BROWSER_EXTENSIONS_EXTENSION_TEST_MESSAGE_LISTENER_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/compiler_specific.h" 11f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)#include "base/memory/ref_counted.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/public/browser/notification_observer.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/public/browser/notification_registrar.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace extensions { 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class TestSendMessageFunction; 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This class helps us wait for incoming messages sent from javascript via 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// chrome.test.sendMessage(). A sample usage would be: 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 22effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// ExtensionTestMessageListener listener("foo", false); // won't reply 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// ... do some work 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// ASSERT_TRUE(listener.WaitUntilSatisfied()); 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// It is also possible to have the extension wait for our reply. This is 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// useful for coordinating multiple pages/processes and having them wait on 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// each other. Example: 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 30effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// ExtensionTestMessageListener listener1("foo1", true); // will reply 31effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// ExtensionTestMessageListener listener2("foo2", true); // will reply 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// ASSERT_TRUE(listener1.WaitUntilSatisfied()); 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// ASSERT_TRUE(listener2.WaitUntilSatisfied()); 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// ... do some work 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// listener1.Reply("foo2 is ready"); 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// listener2.Reply("foo1 is ready"); 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 38effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// Further, we can use this to listen for a success and failure message: 39effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// 40effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// ExtensionTestMessageListener listener("success", will_reply); 41effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// listener.set_failure_message("failure"); 42effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// ASSERT_TRUE(listener.WaitUntilSatisfied()); 43effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// if (listener.message() == "success") { 44effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// HandleSuccess(); 45effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// } else { 46effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// ASSERT_EQ("failure", listener.message()); 47effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// HandleFailure(); 48effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// } 49effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// 50effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// Or, use it to listen to any arbitrary message: 51effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// 52effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// ExtensionTestMessageListener listener(will_reply); 53effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// ASSERT_TRUE(listener.WaitUntilSatisfied()); 54effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// if (listener.message() == "foo") 55effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// HandleFoo(); 56effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// else if (listener.message() == "bar") 57effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// HandleBar(); 58effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// else if (listener.message() == "baz") 59effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// HandleBaz(); 60effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// else 61effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// NOTREACHED(); 62effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// 63effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// You can also use the class to listen for messages from a specified extension: 64effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// 65effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// ExtensionTestMessageListener listener(will_reply); 66effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// listener.set_extension_id(extension->id()); 67effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// ASSERT_TRUE(listener.WaitUntilSatisfied()); 68effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// ... do some work. 69effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// 70effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// Finally, you can reset the listener to reuse it. 71effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// 72effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// ExtensionTestMessageListener listener(true); // will reply 73effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// ASSERT_TRUE(listener.WaitUntilSatisfied()); 74effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// while (listener.message() != "end") { 75effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// Handle(listener.message()); 76effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// listener.Reply("bar"); 77effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// listener.Reset(); 78effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// ASSERT_TRUE(listener.WaitUntilSatisfied()); 79effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch// } 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Note that when using it in browser tests, you need to make sure it gets 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// destructed *before* the browser gets torn down. Two common patterns are to 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// either make it a local variable inside your test body, or if it's a member 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// variable of a ExtensionBrowserTest subclass, override the 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// InProcessBrowserTest::CleanUpOnMainThread() method and clean it up there. 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class ExtensionTestMessageListener : public content::NotificationObserver { 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // We immediately start listening for |expected_message|. 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ExtensionTestMessageListener(const std::string& expected_message, 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool will_reply); 91effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch // Construct a message listener which will listen for any message. 92effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch explicit ExtensionTestMessageListener(bool will_reply); 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 94effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch virtual ~ExtensionTestMessageListener(); 952a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This returns true immediately if we've already gotten the expected 97effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch // message, or waits until it arrives. 98effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch // Returns false if the wait is interrupted and we still haven't gotten the 99effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch // message, or if the message was equal to |failure_message_|. 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool WaitUntilSatisfied(); 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Send the given message as a reply. It is only valid to call this after 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // WaitUntilSatisfied has returned true, and if will_reply is true. 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Reply(const std::string& message); 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Convenience method that formats int as a string and sends it. 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Reply(int message); 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 109effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch // Reset the listener to listen again. No settings (such as messages to 110effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch // listen for) are modified. 111effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch void Reset(); 112effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch 113effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch // Getters and setters. 114effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch 115effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch bool was_satisfied() const { return satisfied_; } 116effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch 117effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch void set_failure_message(const std::string& failure_message) { 118effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch failure_message_ = failure_message; 119effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch } 120effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch 121effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch const std::string& extension_id() const { return extension_id_; } 122effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch void set_extension_id(const std::string& extension_id) { 123effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch extension_id_ = extension_id; 124effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch } 125effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch 126effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch const std::string& message() const { return message_; } 127effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch 128effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch private: 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Implements the content::NotificationObserver interface. 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void Observe(int type, 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const content::NotificationSource& source, 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const content::NotificationDetails& details) OVERRIDE; 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) content::NotificationRegistrar registrar_; 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The message we're expecting. 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string expected_message_; 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 139effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch // The last message we received. 140effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch std::string message_; 141effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Whether we've seen expected_message_ yet. 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool satisfied_; 1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If we're waiting, then we want to post a quit task when the expected 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // message arrives. 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool waiting_; 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 149effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch // Whether or not we will wait for any message, regardless of contents. 150effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch bool wait_for_any_message_; 151effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If true, we expect the calling code to manually send a reply. Otherwise, 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // we send an automatic empty reply to the extension. 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool will_reply_; 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 156effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch // Whether or not we have already replied (we can only reply once). 157effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch bool replied_; 158effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch 159effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch // The extension id that we listen for, or empty. 160effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch std::string extension_id_; 161effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch 1622a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // The message that signals failure. 1632a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) std::string failure_message_; 1642a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1652a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // If we received a message that was the failure message. 1662a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool failed_; 1672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The function we need to reply to. 169f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) scoped_refptr<extensions::TestSendMessageFunction> function_; 1705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // CHROME_BROWSER_EXTENSIONS_EXTENSION_TEST_MESSAGE_LISTENER_H_ 173