/* * Copyright 2018 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package androidx.webkit; import android.graphics.Bitmap; import android.net.Uri; import android.support.test.filters.MediumTest; import android.support.test.runner.AndroidJUnit4; import android.webkit.ValueCallback; import android.webkit.WebResourceRequest; import android.webkit.WebResourceResponse; import android.webkit.WebView; import android.webkit.WebViewClient; import org.junit.Assert; import org.junit.Assume; import org.junit.Before; import org.junit.Test; import org.junit.runner.RunWith; import java.util.HashMap; import java.util.Map; import java.util.concurrent.CountDownLatch; import java.util.concurrent.TimeUnit; @MediumTest @RunWith(AndroidJUnit4.class) public class WebViewClientCompatTest { private WebViewOnUiThread mWebViewOnUiThread; private static final long TEST_TIMEOUT = 20000L; private static final String TEST_URL = "http://www.example.com/"; private static final String TEST_SAFE_BROWSING_URL = "chrome://safe-browsing/match?type=malware"; @Before public void setUp() { mWebViewOnUiThread = new WebViewOnUiThread(); } @Test public void testShouldOverrideUrlLoadingDefault() { // This never calls into chromium, so we don't need to do any feature checks. final MockWebViewClient webViewClient = new MockWebViewClient(); // Create any valid WebResourceRequest, the return values don't matter much. final WebResourceRequest resourceRequest = new WebResourceRequest() { @Override public Uri getUrl() { return Uri.parse(TEST_URL); } @Override public boolean isForMainFrame() { return false; } @Override public boolean isRedirect() { return false; } @Override public boolean hasGesture() { return false; } @Override public String getMethod() { return "GET"; } @Override public Map getRequestHeaders() { return new HashMap(); } }; Assert.assertFalse(webViewClient.shouldOverrideUrlLoading( mWebViewOnUiThread.getWebViewOnCurrentThread(), resourceRequest)); } @Test public void testShouldOverrideUrlLoading() throws InterruptedException { Assume.assumeTrue( WebViewFeature.isFeatureSupported(WebViewFeature.SHOULD_OVERRIDE_WITH_REDIRECTS)); Assume.assumeTrue( WebViewFeature.isFeatureSupported(WebViewFeature.WEB_RESOURCE_REQUEST_IS_REDIRECT)); String data = "" + "new page" + ""; mWebViewOnUiThread.loadDataAndWaitForCompletion(data, "text/html", null); final CountDownLatch pageFinishedLatch = new CountDownLatch(1); final MockWebViewClient webViewClient = new MockWebViewClient() { @Override public void onPageFinished(WebView view, String url) { super.onPageFinished(view, url); pageFinishedLatch.countDown(); } }; mWebViewOnUiThread.setWebViewClient(webViewClient); mWebViewOnUiThread.getSettings().setJavaScriptEnabled(true); clickOnLinkUsingJs("link", mWebViewOnUiThread); pageFinishedLatch.await(TEST_TIMEOUT, TimeUnit.MILLISECONDS); Assert.assertEquals(TEST_URL, webViewClient.getLastShouldOverrideResourceRequest().getUrl().toString()); WebResourceRequest request = webViewClient.getLastShouldOverrideResourceRequest(); Assert.assertNotNull(request); Assert.assertTrue(request.isForMainFrame()); Assert.assertFalse(WebResourceRequestCompat.isRedirect(request)); Assert.assertFalse(request.hasGesture()); } private void clickOnLinkUsingJs(final String linkId, WebViewOnUiThread webViewOnUiThread) throws InterruptedException { final CountDownLatch callbackLatch = new CountDownLatch(1); ValueCallback callback = new ValueCallback() { @Override public void onReceiveValue(String value) { callbackLatch.countDown(); } }; webViewOnUiThread.evaluateJavascript( "document.getElementById('" + linkId + "').click();" + "console.log('element with id [" + linkId + "] clicked');", callback); Assert.assertTrue(callbackLatch.await(TEST_TIMEOUT, TimeUnit.MILLISECONDS)); } @Test public void testOnReceivedError() throws Exception { Assume.assumeTrue( WebViewFeature.isFeatureSupported(WebViewFeature.RECEIVE_WEB_RESOURCE_ERROR)); Assume.assumeTrue( WebViewFeature.isFeatureSupported(WebViewFeature.WEB_RESOURCE_ERROR_GET_CODE)); final MockWebViewClient webViewClient = new MockWebViewClient(); mWebViewOnUiThread.setWebViewClient(webViewClient); String wrongUri = "invalidscheme://some/resource"; Assert.assertNull(webViewClient.getOnReceivedResourceError()); mWebViewOnUiThread.loadUrlAndWaitForCompletion(wrongUri); Assert.assertNotNull(webViewClient.getOnReceivedResourceError()); Assert.assertEquals(WebViewClient.ERROR_UNSUPPORTED_SCHEME, webViewClient.getOnReceivedResourceError().getErrorCode()); } @Test public void testOnReceivedErrorForSubresource() throws Exception { Assume.assumeTrue( WebViewFeature.isFeatureSupported(WebViewFeature.RECEIVE_WEB_RESOURCE_ERROR)); final MockWebViewClient webViewClient = new MockWebViewClient(); mWebViewOnUiThread.setWebViewClient(webViewClient); Assert.assertNull(webViewClient.getOnReceivedResourceError()); String data = "" + " " + "

" + " " + ""; mWebViewOnUiThread.loadDataAndWaitForCompletion(data, "text/html", null); Assert.assertNotNull(webViewClient.getOnReceivedResourceError()); Assert.assertEquals(WebViewClient.ERROR_UNSUPPORTED_SCHEME, webViewClient.getOnReceivedResourceError().getErrorCode()); } @Test public void testOnSafeBrowsingHitBackToSafety() throws Throwable { Assume.assumeTrue(WebViewFeature.isFeatureSupported(WebViewFeature.SAFE_BROWSING_HIT)); Assume.assumeTrue(WebViewFeature.isFeatureSupported(WebViewFeature.SAFE_BROWSING_ENABLE)); Assume.assumeTrue(WebViewFeature.isFeatureSupported( WebViewFeature.SAFE_BROWSING_RESPONSE_BACK_TO_SAFETY)); Assume.assumeTrue( WebViewFeature.isFeatureSupported(WebViewFeature.WEB_RESOURCE_ERROR_GET_CODE)); final SafeBrowsingBackToSafetyClient backToSafetyWebViewClient = new SafeBrowsingBackToSafetyClient(); mWebViewOnUiThread.setWebViewClient(backToSafetyWebViewClient); WebSettingsCompat.setSafeBrowsingEnabled(mWebViewOnUiThread.getSettings(), true); // Load any page String data = "some safe page"; mWebViewOnUiThread.loadDataAndWaitForCompletion(data, "text/html", null); final String originalUrl = mWebViewOnUiThread.getUrl(); enableSafeBrowsingAndLoadUnsafePage(backToSafetyWebViewClient); // Back to safety should produce a network error Assert.assertNotNull(backToSafetyWebViewClient.getOnReceivedResourceError()); Assert.assertEquals(WebViewClient.ERROR_UNSAFE_RESOURCE, backToSafetyWebViewClient.getOnReceivedResourceError().getErrorCode()); // Check that we actually navigated backward Assert.assertEquals(originalUrl, mWebViewOnUiThread.getUrl()); } @Test public void testOnSafeBrowsingHitProceed() throws Throwable { Assume.assumeTrue(WebViewFeature.isFeatureSupported(WebViewFeature.SAFE_BROWSING_HIT)); Assume.assumeTrue(WebViewFeature.isFeatureSupported(WebViewFeature.SAFE_BROWSING_ENABLE)); Assume.assumeTrue(WebViewFeature.isFeatureSupported( WebViewFeature.SAFE_BROWSING_RESPONSE_PROCEED)); final SafeBrowsingProceedClient proceedWebViewClient = new SafeBrowsingProceedClient(); mWebViewOnUiThread.setWebViewClient(proceedWebViewClient); WebSettingsCompat.setSafeBrowsingEnabled(mWebViewOnUiThread.getSettings(), true); // Load any page String data = "some safe page"; mWebViewOnUiThread.loadDataAndWaitForCompletion(data, "text/html", null); enableSafeBrowsingAndLoadUnsafePage(proceedWebViewClient); // Check that we actually proceeded Assert.assertEquals(TEST_SAFE_BROWSING_URL, mWebViewOnUiThread.getUrl()); } private void enableSafeBrowsingAndLoadUnsafePage(SafeBrowsingClient client) throws Throwable { // Note: Safe Browsing depends on user opt-in as well, so we can't assume it's actually // enabled. #getSafeBrowsingEnabled will tell us the true state of whether Safe Browsing is // enabled. boolean deviceSupportsSafeBrowsing = WebSettingsCompat.getSafeBrowsingEnabled(mWebViewOnUiThread.getSettings()); Assume.assumeTrue(deviceSupportsSafeBrowsing); Assert.assertNull(client.getOnReceivedResourceError()); mWebViewOnUiThread.loadUrlAndWaitForCompletion(TEST_SAFE_BROWSING_URL); Assert.assertEquals(TEST_SAFE_BROWSING_URL, client.getOnSafeBrowsingHitRequest().getUrl().toString()); Assert.assertTrue(client.getOnSafeBrowsingHitRequest().isForMainFrame()); } @Test public void testOnPageCommitVisibleCalled() throws Exception { Assume.assumeTrue(WebViewFeature.isFeatureSupported(WebViewFeature.VISUAL_STATE_CALLBACK)); final CountDownLatch callbackLatch = new CountDownLatch(1); mWebViewOnUiThread.setWebViewClient(new WebViewClientCompat() { @Override public void onPageCommitVisible(WebView view, String url) { Assert.assertEquals(url, "about:blank"); callbackLatch.countDown(); } }); mWebViewOnUiThread.loadUrl("about:blank"); Assert.assertTrue(callbackLatch.await(TEST_TIMEOUT, TimeUnit.MILLISECONDS)); } private class MockWebViewClient extends WebViewOnUiThread.WaitForLoadedClient { private boolean mOnPageStartedCalled; private boolean mOnPageFinishedCalled; private boolean mOnLoadResourceCalled; private WebResourceErrorCompat mOnReceivedResourceError; private WebResourceResponse mOnReceivedHttpError; private WebResourceRequest mLastShouldOverrideResourceRequest; MockWebViewClient() { super(mWebViewOnUiThread); } public WebResourceErrorCompat getOnReceivedResourceError() { return mOnReceivedResourceError; } public WebResourceResponse getOnReceivedHttpError() { return mOnReceivedHttpError; } public WebResourceRequest getLastShouldOverrideResourceRequest() { return mLastShouldOverrideResourceRequest; } @Override public void onPageStarted(WebView view, String url, Bitmap favicon) { super.onPageStarted(view, url, favicon); mOnPageStartedCalled = true; } @Override public void onPageFinished(WebView view, String url) { super.onPageFinished(view, url); Assert.assertTrue(mOnPageStartedCalled); Assert.assertTrue(mOnLoadResourceCalled); mOnPageFinishedCalled = true; } @Override public void onLoadResource(WebView view, String url) { super.onLoadResource(view, url); Assert.assertTrue(mOnPageStartedCalled); mOnLoadResourceCalled = true; } @Override @SuppressWarnings("deprecation") public void onReceivedError(WebView view, int errorCode, String description, String failingUrl) { // This can be called if a test runs for a WebView which does not support the {@link // WebViewFeature#RECEIVE_WEB_RESOURCE_ERROR} feature. } @Override public void onReceivedError(WebView view, WebResourceRequest request, WebResourceErrorCompat error) { mOnReceivedResourceError = error; } @Override public void onReceivedHttpError(WebView view, WebResourceRequest request, WebResourceResponse errorResponse) { super.onReceivedHttpError(view, request, errorResponse); mOnReceivedHttpError = errorResponse; } @Override @SuppressWarnings("deprecation") public boolean shouldOverrideUrlLoading(WebView view, String url) { // This can be called if a test runs for a WebView which does not support the {@link // WebViewFeature#SHOULD_OVERRIDE_WITH_REDIRECTS} feature. return false; } @Override public boolean shouldOverrideUrlLoading(WebView view, WebResourceRequest request) { mLastShouldOverrideResourceRequest = request; return false; } } private class SafeBrowsingClient extends MockWebViewClient { private WebResourceRequest mOnSafeBrowsingHitRequest; private int mOnSafeBrowsingHitThreatType; public WebResourceRequest getOnSafeBrowsingHitRequest() { return mOnSafeBrowsingHitRequest; } public void setOnSafeBrowsingHitRequest(WebResourceRequest request) { mOnSafeBrowsingHitRequest = request; } public int getOnSafeBrowsingHitThreatType() { return mOnSafeBrowsingHitThreatType; } public void setOnSafeBrowsingHitThreatType(int type) { mOnSafeBrowsingHitThreatType = type; } } private class SafeBrowsingBackToSafetyClient extends SafeBrowsingClient { @Override public void onSafeBrowsingHit(WebView view, WebResourceRequest request, int threatType, SafeBrowsingResponseCompat response) { // Immediately go back to safety to return the network error code setOnSafeBrowsingHitRequest(request); setOnSafeBrowsingHitThreatType(threatType); response.backToSafety(/* report */ true); } } private class SafeBrowsingProceedClient extends SafeBrowsingClient { @Override public void onSafeBrowsingHit(WebView view, WebResourceRequest request, int threatType, SafeBrowsingResponseCompat response) { // Proceed through Safe Browsing warnings setOnSafeBrowsingHitRequest(request); setOnSafeBrowsingHitThreatType(threatType); response.proceed(/* report */ true); } } }