Home | History | Annotate | Download | only in tests 
      1 /*
      2  * Copyright (C) 2011 Google Inc. All rights reserved.
      3  *
      4  * Redistribution and use in source and binary forms, with or without
      5  * modification, are permitted provided that the following conditions are
      6  * met:
      7  *
      8  *     * Redistributions of source code must retain the above copyright
      9  * notice, this list of conditions and the following disclaimer.
     10  *     * Redistributions in binary form must reproduce the above
     11  * copyright notice, this list of conditions and the following disclaimer
     12  * in the documentation and/or other materials provided with the
     13  * distribution.
     14  *     * Neither the name of Google Inc. nor the names of its
     15  * contributors may be used to endorse or promote products derived from
     16  * this software without specific prior written permission.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     29  */
     30 
     31 #ifndef FrameTestHelpers_h
     32 #define FrameTestHelpers_h
     33 
     34 #include "public/platform/WebURLRequest.h"
     35 #include "public/web/WebFrameClient.h"
     36 #include "public/web/WebHistoryItem.h"
     37 #include "public/web/WebViewClient.h"
     38 #include "web/WebViewImpl.h"
     39 #include "wtf/PassOwnPtr.h"
     40 #include <string>
     41 
     42 namespace blink {
     43 
     44 class WebLocalFrameImpl;
     45 class WebSettings;
     46 
     47 namespace FrameTestHelpers {
     48 
     49 class TestWebFrameClient;
     50 
     51 // Loads a url into the specified WebFrame for testing purposes. Pumps any
     52 // pending resource requests, as well as waiting for the threaded parser to
     53 // finish, before returning.
     54 void loadFrame(WebFrame*, const std::string& url);
     55 // Same as above, but for WebFrame::loadHTMLString().
     56 void loadHTMLString(WebFrame*, const std::string& html, const WebURL& baseURL);
     57 // Same as above, but for WebFrame::loadHistoryItem().
     58 void loadHistoryItem(WebFrame*, const WebHistoryItem&, WebHistoryLoadType, WebURLRequest::CachePolicy);
     59 // Same as above, but for WebFrame::reload().
     60 void reloadFrame(WebFrame*);
     61 void reloadFrameIgnoringCache(WebFrame*);
     62 
     63 // Pumps pending resource requests while waiting for a frame to load. Don't use
     64 // this. Use one of the above helpers.
     65 void pumpPendingRequestsDoNotUse(WebFrame*);
     66 
     67 void runPendingTasks();
     68 
     69 // Convenience class for handling the lifetime of a WebView and its associated mainframe in tests.
     70 class WebViewHelper {
     71     WTF_MAKE_NONCOPYABLE(WebViewHelper);
     72 public:
     73     WebViewHelper();
     74     ~WebViewHelper();
     75 
     76     // Creates and initializes the WebView. Implicitly calls reset() first. IF a
     77     // WebFrameClient or a WebViewClient are passed in, they must outlive the
     78     // WebViewHelper.
     79     WebViewImpl* initialize(bool enableJavascript = false, TestWebFrameClient* = 0, WebViewClient* = 0, void (*updateSettingsFunc)(WebSettings*) = 0);
     80 
     81     // Same as initialize() but also performs the initial load of the url. Only
     82     // returns once the load is complete.
     83     WebViewImpl* initializeAndLoad(const std::string& url, bool enableJavascript = false, TestWebFrameClient* = 0, WebViewClient* = 0, void (*updateSettingsFunc)(WebSettings*) = 0);
     84 
     85     void reset();
     86 
     87     WebView* webView() const { return m_webView; }
     88     WebViewImpl* webViewImpl() const { return m_webView; }
     89 
     90 private:
     91     WebViewImpl* m_webView;
     92 };
     93 
     94 // Minimal implementation of WebFrameClient needed for unit tests that load frames. Tests that load
     95 // frames and need further specialization of WebFrameClient behavior should subclass this.
     96 class TestWebFrameClient : public WebFrameClient {
     97 public:
     98     TestWebFrameClient();
     99 
    100     virtual WebFrame* createChildFrame(WebLocalFrame* parent, const WebString& frameName) OVERRIDE;
    101     virtual void frameDetached(WebFrame*) OVERRIDE;
    102     virtual void didStartLoading(bool) OVERRIDE;
    103     virtual void didStopLoading() OVERRIDE;
    104 
    105     bool isLoading() { return m_loadsInProgress > 0; }
    106 
    107 private:
    108     int m_loadsInProgress;
    109 };
    110 
    111 class TestWebViewClient : public WebViewClient {
    112 public:
    113     virtual ~TestWebViewClient() { }
    114     virtual void initializeLayerTreeView() OVERRIDE;
    115     virtual WebLayerTreeView* layerTreeView() OVERRIDE { return m_layerTreeView.get(); }
    116 
    117 private:
    118     OwnPtr<WebLayerTreeView> m_layerTreeView;
    119 };
    120 
    121 } // namespace FrameTestHelpers
    122 } // namespace blink
    123 
    124 #endif // FrameTestHelpers_h
    125