ZATS Cookies"

From Documentation
m (correct highlight (via JWB))
 
(19 intermediate revisions by one other user not shown)
Line 3: Line 3:
 
  Since 1.1.0
 
  Since 1.1.0
  
 +
== Cookie validation ==
 +
In order to provide handling the [http://www.ietf.org/rfc/rfc2965.txt HTTP cookies] for developers, ZATS Mimic introduces a group of methods on [http://www.zkoss.org/javadoc/latest/zats/org/zkoss/zats/mimic/Client.html 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:
  
In order to provide developers handle the [http://www.ietf.org/rfc/rfc2965.txt HTTP cookies], ZATS Mimic introduces a group of methods on [http://www.zkoss.org/javadoc/latest/zats/org/zkoss/zats/mimic/Client.html Client]. ZATS Mimic seamlessly maintains cookies after connected with a ZK application. We can read the current cookies and verify the behavior of the ZK application.
+
'''cookie.zul'''
 +
<source lang="xml">
 +
<zk>
 +
<div apply="CookieComposer">
 +
<button id="change" label="change" />
 +
</div>
 +
</zk>
 +
</source>
 +
 
 +
'''CookieComposer.java'''
 +
<source lang="java" start="10" highlight="13, 16, 18">
 +
public class CookieComposer extends SelectorComposer<Component> {
 +
public void doAfterCompose(Component comp) throws Exception {
 +
super.doAfterCompose(comp);
 +
setCookie("foo", "bar");
 +
}
 +
 
 +
@Listen("onClick=#change")
 +
public void change() {
 +
setCookie("foo", "hello");
 +
}
  
'''cookie.zul'''
 
<source lang="java" start="10" high="15,18,19,29">
 
<zscript><![CDATA[
 
 
public void setCookie(String name, String value) {
 
public void setCookie(String name, String value) {
javax.servlet.http.HttpServletResponse resp = Executions.getCurrent().getNativeResponse();
+
HttpServletResponse resp = (HttpServletResponse)Executions.getCurrent().getNativeResponse();
resp.addCookie(new javax.servlet.http.Cookie(name, value));
+
resp.addCookie(new 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" />
 
 
</source>
 
</source>
 
+
* '''Line 13''': This will add a cookie when beginning.
* '''Line 15''': This will add a cookie when beginning.
+
* '''Line 16, 18''': It changes the cookie from server-side when the user clicking the button.
* '''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.java'''
<source lang="java" start="10" high="13,14,15,16,17">
+
<source lang="java" start="10" highlight="13,14,15,16,17">
Zats.init(".");
+
@Test
try{
+
public void Test() {
 
Client client = Zats.newClient();
 
Client client = Zats.newClient();
 
DesktopAgent desktop = client.connect("/cookie.zul");
 
DesktopAgent desktop = client.connect("/cookie.zul");
Line 45: Line 47:
 
desktop.query("#change").click();
 
desktop.query("#change").click();
 
Assert.assertEquals("hello", client.getCookie("foo"));
 
Assert.assertEquals("hello", client.getCookie("foo"));
}finally{
 
Zats.end();
 
 
}
 
}
 
</source>
 
</source>
 +
* '''Line 13-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.
  
* '''Line 13, 14, 15''': After connected to a ZUL page, we can get the cookies and verify them.
+
== Set cookie in a test case ==
* '''Line 16, 17''': ZATS Mimic maintains all cookies during any operations.
+
Usually, developers use cookies to keep some information between individual connections. For example, it can trace activities of users or remember some useful information for users. ZATS Mimic lets us add, change or remove cookies through the <code>Client</code>. That is useful for testing above cases. The following is a simple example about using cookie to remind last read page number:
  
== Cookie handling from client-side ==
+
'''cookie.zul'''
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<ref>for more detail. Please refer to [[ZK_Client-side_Reference]]</ref>. Because ZATS Mimic doesn't perform the JavaScript code, it lets developers add, modify or remove cookies through <tt>Client</tt> in test code to simulate the Client-side programming.
+
<source lang="xml" highlight="3">
 +
<zk>
 +
<div apply="CookieComposer">
 +
<label id="msg" value="first time reading" />
 +
</div>
 +
</zk>
 +
</source>
 +
* '''Line 3''': It reminds user of last read page number here.
  
<source lang="java" start="10" high="11, 12">
+
'''CookieComposer'''
Client client = Zats.newClient();
+
<source lang="java" start="10" highlight="20,21">
DesktopAgent desktop = client.connect("/cookie.zul");
+
public class CookieComposer extends SelectorComposer<Component> {
client.setCookie("hello", "ZK");
+
@Wire
desktop.query("#show").click();
+
private Label msg;
String msg = desktop.query("#msg").as(Label.class).getValue();
+
Assert.assertTrue(msg.contains("hello=ZK"));
+
public void doAfterCompose(Component comp) throws Exception {
 +
super.doAfterCompose(comp);
 +
Execution exec = Executions.getCurrent();
 +
Cookie[] cookies = ((HttpServletRequest)exec.getNativeRequest()).getCookies();
 +
if(cookies != null) {
 +
for(Cookie cookie : cookies) {
 +
if("page".equals(cookie.getName()))
 +
msg.setValue("last read page: " + cookie.getValue());
 +
}
 +
}
 +
}
 +
}
 
</source>
 
</source>
 +
* '''Line 20-21''': This will show the last read page according to the cookie stored at client-side.
  
* '''Line 11, 12''': 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 <tt>null</tt> value, it indicates to remove the specific cookie. Notice that the name of cookie can not start with '''$''' character, it will be a reserved name.
+
'''Test.java'''
 
+
<source lang="java" start="10" highlight="12, 13, 14">
'''Notes'''
+
@Test
<references/>
+
public void test() {
 +
Client client = Zats.newClient();
 +
client.setCookie("page", "99");
 +
DesktopAgent desktop = client.connect("/cookie.zul");
 +
String msg = desktop.query("#msg").as(Label.class).getValue();
 +
Assert.assertEquals("last read page: 99", msg);
 +
}
 +
</source>
 +
* '''Line 12-14''': We can append a new cookie before connecting with a page for testing.
  
 
{{ZATSEssentialsPageFooter}}
 
{{ZATSEssentialsPageFooter}}

Latest revision as of 02:59, 20 January 2022

WarningTriangle-32x32.png This page is under construction, so we cannot guarantee the accuracy of the content!

aowang



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 SelectorComposer<Component> {
	public void doAfterCompose(Component comp) throws Exception {
		super.doAfterCompose(comp);
		setCookie("foo", "bar");
	}

	@Listen("onClick=#change")
	public void 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, 18: 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-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.

Set cookie in a test case

Usually, developers use cookies to keep some information between individual connections. For example, it can trace activities of users or remember some useful information for users. ZATS Mimic lets us add, change or remove cookies through the Client. That is useful for testing above cases. The following is a simple example about using cookie to remind last read page number:

cookie.zul

<zk>
	<div apply="CookieComposer">
		<label id="msg" value="first time reading" />
	</div>
</zk>
  • Line 3: It reminds user of last read page number here.

CookieComposer

public class CookieComposer extends SelectorComposer<Component> {
	@Wire
	private Label msg;
	
	public void doAfterCompose(Component comp) throws Exception {
		super.doAfterCompose(comp);
		Execution exec = Executions.getCurrent();
		Cookie[] cookies = ((HttpServletRequest)exec.getNativeRequest()).getCookies();
		if(cookies != null) {
			for(Cookie cookie : cookies) {
				if("page".equals(cookie.getName()))
					msg.setValue("last read page: " + cookie.getValue());
			}
		}
	}
}
  • Line 20-21: This will show the last read page according to the cookie stored at client-side.

Test.java

@Test
public void test() {
	Client client = Zats.newClient();
	client.setCookie("page", "99");
	DesktopAgent desktop = client.connect("/cookie.zul");
	String msg = desktop.query("#msg").as(Label.class).getValue();
	Assert.assertEquals("last read page: 99", msg);
}
  • Line 12-14: We can append a new cookie before connecting with a page for testing.



Last Update : 2022/01/20

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.