Ported Cookie2 test cases from the HttpClient 3.x branch

git-svn-id: https://svn.apache.org/repos/asf/jakarta/httpcomponents/httpclient/trunk@582602 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Oleg Kalnichevski 2007-10-07 09:35:48 +00:00
parent e6d76b2750
commit 3bd51e812d
5 changed files with 322 additions and 8 deletions

View File

@ -41,7 +41,7 @@ package org.apache.http.cookie;
public interface SM {
public static final String COOKIE = "Cookie";
public static final String COOKIE_2 = "Cookie2";
public static final String COOKIE2 = "Cookie2";
public static final String SET_COOKIE = "Set-Cookie";
public static final String SET_COOKIE2 = "Set-Cookie2";

View File

@ -73,6 +73,23 @@ public class RFC2965Spec extends RFC2109Spec {
registerAttribHandler(ClientCookie.VERSION_ATTR, new RFC2965VersionAttributeHandler());
}
private BasicClientCookie createCookie(
final String name, final String value, final CookieOrigin origin) {
BasicClientCookie cookie = new BasicClientCookie(name, value);
cookie.setPath(getDefaultPath(origin));
cookie.setDomain(getDefaultDomain(origin));
return cookie;
}
private BasicClientCookie createCookie2(
final String name, final String value, final CookieOrigin origin) {
BasicClientCookie2 cookie = new BasicClientCookie2(name, value);
cookie.setPath(getDefaultPath(origin));
cookie.setDomain(getDefaultDomain(origin));
cookie.setPorts(new int [] { origin.getPort() });
return cookie;
}
public Cookie[] parse(
final Header header,
CookieOrigin origin) throws MalformedCookieException {
@ -96,11 +113,13 @@ public class RFC2965Spec extends RFC2109Spec {
if (name == null || name.equals("")) {
throw new MalformedCookieException("Cookie name may not be empty");
}
BasicClientCookie2 cookie = new BasicClientCookie2(name, value);
cookie.setPath(getDefaultPath(origin));
cookie.setDomain(getDefaultDomain(origin));
cookie.setPorts(new int [] { origin.getPort() });
BasicClientCookie cookie;
if (header.getName().equals(SM.SET_COOKIE2)) {
cookie = createCookie2(name, value, origin);
} else {
cookie = createCookie(name, value, origin);
}
// cycle through the parameters
NameValuePair[] attribs = headerelement.getParameters();
@ -212,7 +231,7 @@ public class RFC2965Spec extends RFC2109Spec {
public Header getVersionHeader() {
CharArrayBuffer buffer = new CharArrayBuffer(40);
buffer.append(SM.COOKIE_2);
buffer.append(SM.COOKIE2);
buffer.append(": ");
buffer.append("$Version=");
buffer.append(Integer.toString(getVersion()));

View File

@ -6,6 +6,7 @@ import org.apache.http.cookie.CookieAttributeHandler;
import org.apache.http.cookie.CookieOrigin;
import org.apache.http.cookie.MalformedCookieException;
import org.apache.http.cookie.SetCookie;
import org.apache.http.cookie.SetCookie2;
/**
* <tt>"Version"</tt> cookie attribute handler for RFC 2965 cookie spec.
@ -48,7 +49,7 @@ public class RFC2965VersionAttributeHandler implements CookieAttributeHandler {
if (cookie == null) {
throw new IllegalArgumentException("Cookie may not be null");
}
if (cookie instanceof ClientCookie) {
if (cookie instanceof SetCookie2) {
if (cookie instanceof ClientCookie
&& !((ClientCookie) cookie).containsAttribute(ClientCookie.VERSION_ATTR)) {
throw new MalformedCookieException(

View File

@ -0,0 +1,284 @@
/*
* $HeadURL$
* $Revision$
* $Date$
* ====================================================================
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.http.client.protocol;
import java.io.IOException;
import junit.framework.Test;
import junit.framework.TestSuite;
import org.apache.http.Header;
import org.apache.http.HttpEntity;
import org.apache.http.HttpException;
import org.apache.http.HttpRequest;
import org.apache.http.HttpResponse;
import org.apache.http.HttpStatus;
import org.apache.http.ProtocolVersion;
import org.apache.http.client.CookieStore;
import org.apache.http.client.RoutedRequest;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.params.ClientPNames;
import org.apache.http.client.params.CookiePolicy;
import org.apache.http.cookie.Cookie;
import org.apache.http.cookie.SM;
import org.apache.http.cookie.SetCookie2;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.BasicCookieStore;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.localserver.ServerTestBase;
import org.apache.http.message.BasicHeader;
import org.apache.http.protocol.ExecutionContext;
import org.apache.http.protocol.HttpContext;
import org.apache.http.protocol.HttpRequestHandler;
/**
* Cookie2 support tests.
*
* @author Oleg Kalnichevski
*
* @version $Revision$
*/
public class TestCookie2Support extends ServerTestBase {
// ------------------------------------------------------------ Constructor
public TestCookie2Support(final String testName) throws IOException {
super(testName);
}
// ------------------------------------------------------------------- Main
public static void main(String args[]) {
String[] testCaseName = { TestCookie2Support.class.getName() };
junit.textui.TestRunner.main(testCaseName);
}
// ------------------------------------------------------- TestCase Methods
public static Test suite() {
return new TestSuite(TestCookie2Support.class);
}
private static class CookieVer0Service implements HttpRequestHandler {
public void handle(
final HttpRequest request,
final HttpResponse response,
final HttpContext context) throws HttpException, IOException {
ProtocolVersion httpversion = request.getRequestLine().getProtocolVersion();
response.setStatusLine(httpversion, HttpStatus.SC_OK);
response.addHeader(new BasicHeader("Set-Cookie", "name1=value1; path=/test"));
StringEntity entity = new StringEntity("whatever");
response.setEntity(entity);
}
}
public void testCookieVersionSupportHeader1() throws Exception {
this.localServer.register("*", new CookieVer0Service());
DefaultHttpClient client = new DefaultHttpClient();
client.getParams().setParameter(ClientPNames.COOKIE_POLICY, CookiePolicy.RFC_2965);
CookieStore cookieStore = new BasicCookieStore();
HttpContext context = client.getDefaultContext();
context.setAttribute(ClientContext.COOKIE_STORE, cookieStore);
HttpGet httpget = new HttpGet("/test/");
RoutedRequest request1 = new RoutedRequest.Impl(httpget, getDefaultRoute());
HttpResponse response1 = client.execute(request1, context);
HttpEntity e1 = response1.getEntity();
if (e1 != null) {
e1.consumeContent();
}
Cookie[] cookies = cookieStore.getCookies();
assertNotNull(cookies);
assertEquals(1, cookies.length);
RoutedRequest request2 = new RoutedRequest.Impl(httpget, getDefaultRoute());
HttpResponse response2 = client.execute(request2, context);
HttpEntity e2 = response2.getEntity();
if (e2 != null) {
e2.consumeContent();
}
HttpRequest reqWrapper = (HttpRequest) context.getAttribute(ExecutionContext.HTTP_REQUEST);
Header cookiesupport = reqWrapper.getFirstHeader("Cookie2");
assertNotNull(cookiesupport);
assertEquals("$Version=1", cookiesupport.getValue());
}
private static class CookieVer1Service implements HttpRequestHandler {
public void handle(
final HttpRequest request,
final HttpResponse response,
final HttpContext context) throws HttpException, IOException {
ProtocolVersion httpversion = request.getRequestLine().getProtocolVersion();
response.setStatusLine(httpversion, HttpStatus.SC_OK);
response.addHeader(new BasicHeader("Set-Cookie", "name1=value1; Path=\"/test\"; Version=1"));
response.addHeader(new BasicHeader("Set-Cookie2", "name2=value2; Path=\"/test\"; Version=1"));
StringEntity entity = new StringEntity("whatever");
response.setEntity(entity);
}
}
public void testCookieVersionSupportHeader2() throws Exception {
this.localServer.register("*", new CookieVer1Service());
DefaultHttpClient client = new DefaultHttpClient();
client.getParams().setParameter(ClientPNames.COOKIE_POLICY, CookiePolicy.RFC_2965);
CookieStore cookieStore = new BasicCookieStore();
HttpContext context = client.getDefaultContext();
context.setAttribute(ClientContext.COOKIE_STORE, cookieStore);
HttpGet httpget = new HttpGet("/test/");
RoutedRequest request1 = new RoutedRequest.Impl(httpget, getDefaultRoute());
HttpResponse response1 = client.execute(request1, context);
HttpEntity e1 = response1.getEntity();
if (e1 != null) {
e1.consumeContent();
}
Cookie[] cookies = cookieStore.getCookies();
assertNotNull(cookies);
assertEquals(2, cookies.length);
RoutedRequest request2 = new RoutedRequest.Impl(httpget, getDefaultRoute());
HttpResponse response2 = client.execute(request2, context);
HttpEntity e2 = response2.getEntity();
if (e2 != null) {
e2.consumeContent();
}
HttpRequest reqWrapper = (HttpRequest) context.getAttribute(ExecutionContext.HTTP_REQUEST);
Header cookiesupport = reqWrapper.getFirstHeader(SM.COOKIE2);
assertNull(cookiesupport);
}
private static class CookieVer2Service implements HttpRequestHandler {
public void handle(
final HttpRequest request,
final HttpResponse response,
final HttpContext context) throws HttpException, IOException {
ProtocolVersion httpversion = request.getRequestLine().getProtocolVersion();
response.setStatusLine(httpversion, HttpStatus.SC_OK);
response.addHeader(new BasicHeader("Set-Cookie2", "name2=value2; Path=\"/test\"; Version=2"));
StringEntity entity = new StringEntity("whatever");
response.setEntity(entity);
}
}
public void testCookieVersionSupportHeader3() throws Exception {
this.localServer.register("*", new CookieVer2Service());
DefaultHttpClient client = new DefaultHttpClient();
client.getParams().setParameter(ClientPNames.COOKIE_POLICY, CookiePolicy.RFC_2965);
CookieStore cookieStore = new BasicCookieStore();
HttpContext context = client.getDefaultContext();
context.setAttribute(ClientContext.COOKIE_STORE, cookieStore);
HttpGet httpget = new HttpGet("/test/");
RoutedRequest request1 = new RoutedRequest.Impl(httpget, getDefaultRoute());
HttpResponse response1 = client.execute(request1, context);
HttpEntity e1 = response1.getEntity();
if (e1 != null) {
e1.consumeContent();
}
Cookie[] cookies = cookieStore.getCookies();
assertNotNull(cookies);
assertEquals(1, cookies.length);
RoutedRequest request2 = new RoutedRequest.Impl(httpget, getDefaultRoute());
HttpResponse response2 = client.execute(request2, context);
HttpEntity e2 = response2.getEntity();
if (e2 != null) {
e2.consumeContent();
}
HttpRequest reqWrapper = (HttpRequest) context.getAttribute(ExecutionContext.HTTP_REQUEST);
Header cookiesupport = reqWrapper.getFirstHeader("Cookie2");
assertNotNull(cookiesupport);
assertEquals("$Version=1", cookiesupport.getValue());
}
private static class SetCookieVersionMixService implements HttpRequestHandler {
public void handle(
final HttpRequest request,
final HttpResponse response,
final HttpContext context) throws HttpException, IOException {
ProtocolVersion httpversion = request.getRequestLine().getProtocolVersion();
response.setStatusLine(httpversion, HttpStatus.SC_OK);
response.addHeader(new BasicHeader("Set-Cookie", "name=wrong; Path=/test"));
response.addHeader(new BasicHeader("Set-Cookie2", "name=right; Path=\"/test\"; Version=1"));
StringEntity entity = new StringEntity("whatever");
response.setEntity(entity);
}
}
public void testSetCookieVersionMix() throws Exception {
this.localServer.register("*", new SetCookieVersionMixService());
DefaultHttpClient client = new DefaultHttpClient();
client.getParams().setParameter(ClientPNames.COOKIE_POLICY, CookiePolicy.RFC_2965);
CookieStore cookieStore = new BasicCookieStore();
HttpContext context = client.getDefaultContext();
context.setAttribute(ClientContext.COOKIE_STORE, cookieStore);
HttpGet httpget = new HttpGet("/test/");
RoutedRequest request1 = new RoutedRequest.Impl(httpget, getDefaultRoute());
HttpResponse response1 = client.execute(request1, context);
HttpEntity e1 = response1.getEntity();
if (e1 != null) {
e1.consumeContent();
}
Cookie[] cookies = cookieStore.getCookies();
assertNotNull(cookies);
assertEquals(1, cookies.length);
assertEquals("right", cookies[0].getValue());
assertTrue(cookies[0] instanceof SetCookie2);
}
}

View File

@ -36,6 +36,7 @@ import junit.framework.TestCase;
import org.apache.http.HttpHost;
import org.apache.http.HttpVersion;
import org.apache.http.conn.HttpRoute;
import org.apache.http.conn.PlainSocketFactory;
import org.apache.http.conn.Scheme;
import org.apache.http.conn.SchemeRegistry;
@ -175,6 +176,15 @@ public abstract class ServerTestBase extends TestCase {
"http");
}
/**
* Obtains the default route to the local test server.
*
* @return the default route to the local test server
*/
protected HttpRoute getDefaultRoute() {
return new HttpRoute(new HttpHost("localhost", localServer.getServicePort()));
}
/**
* Opens a connection to the given target using