ZATS Cookies

This page is under construction, so we cannot guarantee the accuracy of the content!

Since 1.1.0

Cookie validation

In order to provide handling the HTTP cookies for developers, ZATS Mimic introduces a group of methods on Client. ZATS Mimic seamlessly maintains cookies after connecting with a ZK application. We can read the current cookies and verify the behavior of the ZK application. The following is a typical example about cookie validation:

cookie.zul

<zk>
	<div apply="CookieComposer">
		<button id="change" label="change" />
	</div>
</zk>

CookieComposer.java

public class CookieComposer extends GenericForwardComposer {
	public void doAfterCompose(Component comp) throws Exception {
		super.doAfterCompose(comp);
		setCookie("foo", "bar");
	}

	public void onClick$change() {
		setCookie("foo", "hello");
	}

	public void setCookie(String name, String value) {
		HttpServletResponse resp = (HttpServletResponse) Executions.getCurrent().getNativeResponse();
		resp.addCookie(new Cookie(name, value));
	}
}

• Line 13: This will add a cookie when beginning.
• Line 16, 17: It changes the cookie from server-side when the user clicking the button.

Test.java

@Test
public void Test() {
	Client client = Zats.newClient();
	DesktopAgent desktop = client.connect("/cookie.zul");
	Assert.assertEquals("bar", client.getCookie("foo"));
	Assert.assertEquals(null, client.getCookie("not existed"));
	desktop.query("#change").click();
	Assert.assertEquals("hello", client.getCookie("foo"));
}

• Line 13, 14, 15: After connected to a ZUL page, we can get the cookies and verify them.
• Line 16, 17: ZATS Mimic maintains all cookies during any operations.

Cookie handling from client-side

Besides applying cookies from the server-side, developers can also handle cookies from the client-side. In a ZK application, we can achieve the above behavior through the Client-side programming. Because ZATS Mimic doesn't perform the JavaScript code, it lets developers add, modify or remove cookies through Client in test code to simulate the Client-side programming.

cookie.zul

<zscript><![CDATA[
	public void setCookie(String name, String value) {
		javax.servlet.http.HttpServletResponse resp = Executions.getCurrent().getNativeResponse();
		resp.addCookie(new javax.servlet.http.Cookie(name, value));
	}
	setCookie("foo", "bar");
]]>
</zscript>
<button id="change" label="change" onClick='setCookie("foo", "hello");' />
<button id="show" label="show">
	<attribute name="onClick"><![CDATA[
		javax.servlet.http.HttpServletRequest req = Executions.getCurrent().getNativeRequest();
		StringBuilder sb = new StringBuilder();
		for (javax.servlet.http.Cookie c : req.getCookies())
			sb.append(c.getName()).append("=").append(c.getValue()).append(";");
		msg.setValue(sb.toString());
	]]>
	</attribute>
</button>
<label id="msg" />

• Line 15: This will add a cookie when beginning.
• Line 18: It changes the cookie from server-side when the user clicking the button.
• Line 19, 29: If we click the button, web application will show all received cookies.

Test.java

@Test
public void test() {
	Client client = Zats.newClient();
	DesktopAgent desktop = client.connect("/cookie.zul");
	client.setCookie("hello", "ZK");
	desktop.query("#show").click();
	String msg = desktop.query("#msg").as(Label.class).getValue();
	Assert.assertTrue(msg.contains("hello=ZK"));
}

• Line 13, 14: We can directly append a new cookie or replace old value with the same name in the test code. If we pass an cookie with null value, it indicates that removing the specific cookie. Notice that the name of cookie can not start with $ character, it would be a reserved name.

Notes