/**
* Copyright 2005-2011 Noelios Technologies.
*
* The contents of this file are subject to the terms of one of the following
* open source licenses: LGPL 3.0 or LGPL 2.1 or CDDL 1.0 or EPL 1.0 (the
* "Licenses"). You can select the license that you prefer but you may not use
* this file except in compliance with one of these Licenses.
*
* You can obtain a copy of the LGPL 3.0 license at
* http://www.opensource.org/licenses/lgpl-3.0.html
*
* You can obtain a copy of the LGPL 2.1 license at
* http://www.opensource.org/licenses/lgpl-2.1.php
*
* You can obtain a copy of the CDDL 1.0 license at
* http://www.opensource.org/licenses/cddl1.php
*
* You can obtain a copy of the EPL 1.0 license at
* http://www.opensource.org/licenses/eclipse-1.0.php
*
* See the Licenses for the specific language governing permissions and
* limitations under the Licenses.
*
* Alternatively, you can obtain a royalty free commercial license with less
* limitations, transferable or non-transferable, directly at
* http://www.noelios.com/products/restlet-engine
*
* Restlet is a registered trademark of Noelios Technologies.
*/
package org.restlet.test.engine;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import org.restlet.data.Cookie;
import org.restlet.data.CookieSetting;
import org.restlet.engine.header.CookieReader;
import org.restlet.engine.header.CookieSettingReader;
import org.restlet.engine.header.CookieSettingWriter;
import org.restlet.engine.header.CookieWriter;
import org.restlet.engine.util.DateUtils;
import org.restlet.test.RestletTestCase;
/**
* Unit tests for the Cookie related classes.
*
* @author Jerome Louvel
*/
public class CookiesTestCase extends RestletTestCase {
/**
* Test one cookie header.
*
* @param headerValue
* The cookie header value.
* @throws IOException
*/
private void testCookie(String headerValue) throws IOException {
CookieReader cr = new CookieReader(headerValue);
List<Cookie> cookies = new ArrayList<Cookie>();
Cookie cookie = cr.readValue();
while (cookie != null) {
cookies.add(cookie);
cookie = cr.readValue();
}
// Rewrite the header
String newHeaderValue = CookieWriter.write(cookies);
// Compare initial and new headers
assertEquals(headerValue, newHeaderValue);
}
/**
* Test one cookie header.
*
* @param headerValue
* The cookie header value.
* @throws IOException
*/
private void testCookieValues(String headerValue) throws IOException {
CookieReader cr = new CookieReader(headerValue);
List<Cookie> cookies = new ArrayList<Cookie>();
Cookie cookie = cr.readValue();
while (cookie != null) {
cookies.add(cookie);
cookie = cr.readValue();
}
// Rewrite the header
String newHeaderValue = CookieWriter.write(cookies);
// Reparse
List<Cookie> cookies2 = new ArrayList<Cookie>();
cr = new CookieReader(newHeaderValue);
cookie = cr.readValue();
while (cookie != null) {
cookies2.add(cookie);
cookie = cr.readValue();
}
// Compare initial and new cookies
assertEquals(cookies.size(), cookies2.size());
for (int i = 0; i < cookies.size(); i++) {
assertEquals(cookies.get(i).getName(), cookies2.get(i).getName());
assertEquals(cookies.get(i).getValue(), cookies2.get(i).getValue());
}
}
/**
* Test a cookie date value.
*
* @param headerValue
* The cookie date value.
*/
private void testCookieDate(String dateValue) {
final Date date = DateUtils.parse(dateValue, DateUtils.FORMAT_RFC_1036);
// Rewrite the date
final String newDateValue = DateUtils.format(date,
DateUtils.FORMAT_RFC_1036.get(0));
// Compare initial and new headers
assertEquals(dateValue, newDateValue);
}
/**
* Test one set cookie header.
*
* @param headerValue
* The set cookie header value.
* @param compare
* Indicates if the new header should be compared with the old
* one.
* @throws IOException
*/
private void testCookieSetting(String headerValue, boolean compare)
throws IOException {
CookieSettingReader cr = new CookieSettingReader(headerValue);
CookieSetting cookie = cr.readValue();
// Rewrite the header
String newHeaderValue = CookieSettingWriter.write(cookie);
// Compare initial and new headers
if (compare) {
boolean result = newHeaderValue.toLowerCase().startsWith(
headerValue.toLowerCase());
assertTrue(result);
}
}
/**
* Tests the parsing of cookies.
*/
public void testParsing() throws IOException {
// Netscape speficiation
testCookie("CUSTOMER=WILE_E_COYOTE");
testCookie("CUSTOMER=WILE_E_COYOTE; PART_NUMBER=ROCKET_LAUNCHER_0001");
testCookie("CUSTOMER=WILE_E_COYOTE; PART_NUMBER=ROCKET_LAUNCHER_0001; SHIPPING=FEDEX");
testCookie("NUMBER=RIDING_ROCKET_0023; PART_NUMBER=ROCKET_LAUNCHER_0001");
testCookieSetting("CUSTOMER=WILE_E_COYOTE; path=/", true);
testCookieSetting("PART_NUMBER=ROCKET_LAUNCHER_0001; path=/", true);
testCookieSetting("SHIPPING=FEDEX; path=/foo", true);
testCookieSetting("NUMBER=RIDING_ROCKET_0023; path=/ammo", true);
testCookieDate("Tuesday, 09-Nov-99 23:12:40 GMT");
// RFC 2109
testCookie("$Version=\"1\"; Customer=\"WILE_E_COYOTE\"; $Path=\"/acme\"");
testCookie("$Version=\"1\"; Customer=\"WILE_E_COYOTE\"; $Path=\"/acme\"; Part_Number=\"Rocket_Launcher_0001\"; $Path=\"/acme\"");
testCookie("$Version=\"1\"; Customer=\"WILE_E_COYOTE\"; $Path=\"/acme\"; Part_Number=\"Rocket_Launcher_0001\"; $Path=\"/acme\"; Shipping=\"FedEx\"; $Path=\"/acme\"");
testCookie("$Version=\"1\"; Part_Number=\"Riding_Rocket_0023\"; $Path=\"/acme/ammo\"; Part_Number=\"Rocket_Launcher_0001\"; $Path=\"/acme\"");
testCookieSetting(
"Customer=\"WILE_E_COYOTE\"; Version=\"1\"; Path=\"/acme\"",
true);
testCookieSetting(
"Part_Number=\"Rocket_Launcher_0001\"; Version=\"1\"; Path=\"/acme\"",
true);
testCookieSetting("Shipping=\"FedEx\"; Version=\"1\"; Path=\"/acme\"",
true);
testCookieSetting(
"Part_Number=\"Rocket_Launcher_0001\"; Version=\"1\"; Path=\"/acme\"",
true);
testCookieSetting(
"Part_Number=\"Riding_Rocket_0023\"; Version=\"1\"; Path=\"/acme/ammo\"",
true);
// Bug #49
testCookieSetting(
"RMS_ADMETA_VISITOR_RMS=27756847%3A240105; expires=Thu, 02 Mar 2006 21:09:00 GMT; path=/; domain=.admeta.com",
false);
testCookieValues("Cookie 1=One; Cookie 2=Two; Cookie 3=Three; Cookie 4=Four; Cookie 5=\"Five\"; Cookie 6=\"Six\"");
}
}