tests/tests/webkit/src/android/webkit/cts/CookieTest.java

/*
 * Copyright (C) 2009 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 android.webkit.cts;

import android.platform.test.annotations.Presubmit;
import android.webkit.CookieManager;

import com.android.compatibility.common.util.NullWebViewUtils;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;

import android.webkit.WebView;

import androidx.test.ext.junit.rules.ActivityScenarioRule;
import androidx.test.ext.junit.runners.AndroidJUnit4;
import androidx.test.filters.MediumTest;

import org.junit.Assume;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;

/**
 * Original framework tests for CookieManager
 */
@MediumTest
@RunWith(AndroidJUnit4.class)
public class CookieTest extends SharedWebViewTest {

    private CookieManager mCookieManager;
    private static final long WAIT_TIME = 50;

    @Rule
    public ActivityScenarioRule mActivityScenarioRule =
            new ActivityScenarioRule(CookieSyncManagerCtsActivity.class);

    @Before
    public void setUp() throws Exception {
        if (getTestEnvironment().getWebView() == null) {
            return;
        }

        mCookieManager = CookieManager.getInstance();
        mCookieManager.removeAllCookie();
        // cookies are removed asynchronously, wait a bit for cookies to be removed
        int maxWait = 10;
        for (int i=0; i < maxWait; i++) {
            // this is unfortuately non-deterministic, but ensure sleep a least once to limit
            // chance of remove thread running after test has begun
            Thread.sleep(WAIT_TIME);
            if (!mCookieManager.hasCookies()) {
                break;
            }
        }
        assertFalse(mCookieManager.hasCookies());
    }

    @Override
    protected SharedWebViewTestEnvironment createTestEnvironment() {
        Assume.assumeTrue("WebView is not available", NullWebViewUtils.isWebViewAvailable());

        SharedWebViewTestEnvironment.Builder builder = new SharedWebViewTestEnvironment.Builder();

        mActivityScenarioRule
                .getScenario()
                .onActivity(
                        activity -> {
                            WebView webView = ((CookieSyncManagerCtsActivity) activity)
                                        .getWebView();
                            builder.setHostAppInvoker(
                                            SharedWebViewTestEnvironment.createHostAppInvoker(
                                                activity))
                                    .setWebView(webView);
                        });

        return builder.build();
    }

    @Presubmit
    @Test
    public void testDomain() {
        String url = "http://www.foo.com";

        // basic
        mCookieManager.setCookie(url, "a=b");
        String cookie = mCookieManager.getCookie(url);
        assertEquals("a=b", cookie);

        // no cross domain cookie
        cookie = mCookieManager.getCookie("http://bar.com");
        assertNull(cookie);

        // more than one cookie
        mCookieManager.setCookie(url, "c=d; domain=.foo.com");
        cookie = mCookieManager.getCookie(url);
        assertTrue(cookie.contains("a=b;"));
        assertTrue(cookie.contains("c=d"));

        // host cookie should not be accessible from a sub-domain.
        cookie = mCookieManager.getCookie("http://bar.www.foo.com");
        assertEquals("c=d", cookie);

        // test setting a domain= that doesn't start w/ a dot, should
        // treat it as a domain cookie, as if there was a pre-pended dot.
        mCookieManager.setCookie(url, "e=f; domain=www.foo.com");
        cookie = mCookieManager.getCookie(url);
        assertTrue(cookie.contains("a=b"));
        assertTrue(cookie.contains("c=d"));
        assertTrue(cookie.contains("e=f"));

        cookie = mCookieManager.getCookie("http://sub.www.foo.com");
        assertTrue(cookie.contains("c=d"));
        assertTrue(cookie.contains("e=f"));

        cookie = mCookieManager.getCookie("http://foo.com");
        assertEquals("c=d", cookie);
    }

    @Test
    public void testSubDomain() {
        String url_abcd = "http://a.b.c.d.com";
        String url_bcd = "http://b.c.d.com";
        String url_cd = "http://c.d.com";
        String url_d = "http://d.com";

        mCookieManager.setCookie(url_abcd, "a=1; domain=.a.b.c.d.com");
        mCookieManager.setCookie(url_abcd, "b=2; domain=.b.c.d.com");
        mCookieManager.setCookie(url_abcd, "c=3; domain=.c.d.com");
        mCookieManager.setCookie(url_abcd, "d=4; domain=.d.com");

        String cookie = mCookieManager.getCookie(url_abcd);
        assertTrue(cookie.contains("a=1"));
        assertTrue(cookie.contains("b=2"));
        assertTrue(cookie.contains("c=3"));
        assertTrue(cookie.contains("d=4"));
        cookie = mCookieManager.getCookie(url_bcd);
        assertTrue(cookie.contains("b=2"));
        assertTrue(cookie.contains("c=3"));
        assertTrue(cookie.contains("d=4"));
        cookie = mCookieManager.getCookie(url_cd);
        assertTrue(cookie.contains("c=3"));
        assertTrue(cookie.contains("d=4"));
        cookie = mCookieManager.getCookie(url_d);
        assertEquals("d=4", cookie);

        // check that the same cookie can exist on different sub-domains.
        mCookieManager.setCookie(url_bcd, "x=bcd; domain=.b.c.d.com");
        mCookieManager.setCookie(url_bcd, "x=cd; domain=.c.d.com");
        cookie = mCookieManager.getCookie(url_bcd);
        assertTrue(cookie.contains("b=2"));
        assertTrue(cookie.contains("c=3"));
        assertTrue(cookie.contains("d=4"));
        assertTrue(cookie.contains("x=bcd"));
        assertTrue(cookie.contains("x=cd"));
        cookie = mCookieManager.getCookie(url_cd);
        assertTrue(cookie.contains("c=3"));
        assertTrue(cookie.contains("d=4"));
        assertTrue(cookie.contains("x=cd"));
    }

    @Test
    public void testInvalidDomain() {
        String url = "http://foo.bar.com";

        mCookieManager.setCookie(url, "a=1; domain=.yo.foo.bar.com");
        String cookie = mCookieManager.getCookie(url);
        assertNull(cookie);

        mCookieManager.setCookie(url, "b=2; domain=.foo.com");
        cookie = mCookieManager.getCookie(url);
        assertNull(cookie);

        mCookieManager.setCookie(url, "c=3; domain=.bar.foo.com");
        cookie = mCookieManager.getCookie(url);
        assertNull(cookie);

        mCookieManager.setCookie(url, "d=4; domain=.foo.bar.com.net");
        cookie = mCookieManager.getCookie(url);
        assertNull(cookie);

        mCookieManager.setCookie(url, "e=5; domain=.ar.com");
        cookie = mCookieManager.getCookie(url);
        assertNull(cookie);

        mCookieManager.setCookie(url, "f=6; domain=.com");
        cookie = mCookieManager.getCookie(url);
        assertNull(cookie);

        mCookieManager.setCookie(url, "g=7; domain=.co.uk");
        cookie = mCookieManager.getCookie(url);
        assertNull(cookie);

        mCookieManager.setCookie(url, "h=8; domain=.foo.bar.com.com");
        cookie = mCookieManager.getCookie(url);
        assertNull(cookie);
    }

    @Test
    public void testPath() {
        String url = "http://www.foo.com";

        mCookieManager.setCookie(url, "a=b; path=/wee");
        String cookie = mCookieManager.getCookie(url + "/wee");
        assertEquals("a=b", cookie);
        cookie = mCookieManager.getCookie(url + "/wee/");
        assertEquals("a=b", cookie);
        cookie = mCookieManager.getCookie(url + "/wee/hee");
        assertEquals("a=b", cookie);
        cookie = mCookieManager.getCookie(url + "/wee/hee/more");
        assertEquals("a=b", cookie);
        cookie = mCookieManager.getCookie(url + "/weehee");
        assertNull(cookie);
        cookie = mCookieManager.getCookie(url);
        assertNull(cookie);

        mCookieManager.setCookie(url, "a=c; path=");
        cookie = mCookieManager.getCookie(url + "/wee");
        // order of contents matters in this case, per spec
        assertEquals("a=b; a=c", cookie);
        cookie = mCookieManager.getCookie(url);
        assertEquals("a=c", cookie);

        mCookieManager.setCookie(url, "a=d");
        cookie = mCookieManager.getCookie(url + "/wee");
        assertEquals("a=b; a=d", cookie);
    }

    @Test
    public void testEmptyValue() {
        String url = "http://www.foobar.com";

        mCookieManager.setCookie(url, "bar=");
        String cookie = mCookieManager.getCookie(url);
        assertEquals("bar=", cookie);

        mCookieManager.setCookie(url, "foobar=;");
        cookie = mCookieManager.getCookie(url);
        assertEquals("bar=; foobar=", cookie);

        mCookieManager.setCookie(url, "baz=; path=/wee");
        cookie = mCookieManager.getCookie(url + "/wee");
        assertEquals("baz=; bar=; foobar=", cookie);
    }
}