/*******************************************************************************
* Copyright (c) 2014, Institute for Pervasive Computing, ETH Zurich.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the Institute nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* This file is part of the Californium (Cf) CoAP framework.
******************************************************************************/
/**
*
*/
package ch.ethz.inf.vs.californium.plugtests;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Set;
import ch.ethz.inf.vs.californium.CoapClient;
import ch.ethz.inf.vs.californium.CoapHandler;
import ch.ethz.inf.vs.californium.CoapObserveRelation;
import ch.ethz.inf.vs.californium.CoapResponse;
import ch.ethz.inf.vs.californium.Utils;
import ch.ethz.inf.vs.californium.WebLink;
import ch.ethz.inf.vs.californium.coap.LinkFormat;
import ch.ethz.inf.vs.californium.coap.MediaTypeRegistry;
import ch.ethz.inf.vs.californium.coap.Request;
import ch.ethz.inf.vs.californium.network.EndpointManager;
import ch.ethz.inf.vs.californium.network.config.NetworkConfig;
import ch.ethz.inf.vs.californium.network.config.NetworkConfigDefaults;
import ch.ethz.inf.vs.californium.network.interceptors.MessageTracer;
/**
* The PlugtestClient uses the developer API of Californium to test
* if the test cases can be implemented successfully.
* This client does not implement the tests that are meant to check
* the server functionality (e.g., stop Observe on DELETE).
*
* Use this flag to customize logging output:
* -Djava.util.logging.config.file=../run/Californium-logging.properties
*/
public class PlugtestClient {
/**
* Main entry point.
*
* @param args the arguments
*/
public static void main(String[] args) {
if (args.length == 0) {
System.out.println("\nCalifornium (Cf) Plugtest Client");
System.out
.println("(c) 2014, Institute for Pervasive Computing, ETH Zurich");
System.out.println();
System.out.println("Usage: " + PlugtestClient.class.getSimpleName() + " [-s] URI");
System.out.println(" -s : Skip the ping in case the remote does not implement it");
System.out.println(" URI : The CoAP URI of the Plugtest server to test (coap://...)");
System.exit(-1);
}
// Config used for plugtest
NetworkConfig.getStandard()
.setInt(NetworkConfigDefaults.MAX_MESSAGE_SIZE, 64)
.setInt(NetworkConfigDefaults.DEFAULT_BLOCK_SIZE, 64);
int first = 0;
if (args[first].equals("-s")) ++first;
String uri = args[first++];
// allow quick hostname as argument
if (!uri.startsWith("coap://")) {
uri = "coap://" + uri;
}
if (uri.endsWith("/")) {
uri = uri.substring(-1);
}
if (first==1) {
CoapClient clientPing = new CoapClient(uri);
System.out.println("===============\nCC31\n---------------");
if (!clientPing.ping(2000)) {
System.out.println(uri + " does not respond to ping, exiting...");
System.exit(-1);
} else {
System.out.println(uri + " reponds to ping");
// add special interceptor for message traces
EndpointManager.getEndpointManager().getDefaultEndpoint().addInterceptor(new MessageTracer());
}
}
// testCC(uri);
// testCB(uri);
testCO(uri);
// testCL(uri);
System.exit(0);
}
public static void testCC(String uri) {
// re-usable response object
CoapResponse response;
CoapClient client = new CoapClient(uri + "/test");
System.out.println("===============\nCC01+10");
System.out.println("---------------\nGET /test\n---------------");
response = client.get();
System.out.println(response.advanced().getType() + "-" + response.getCode());
System.out.println(response.getResponseText());
System.out.println("===============\nCC02");
System.out.println("---------------\nDELETE /test\n---------------");
response = client.delete();
System.out.println(response.advanced().getType() + "-" + response.getCode());
System.out.println(response.getResponseText());
System.out.println("===============\nCC03");
System.out.println("---------------\nPUT /test\n---------------");
response = client.put("", MediaTypeRegistry.TEXT_PLAIN);
System.out.println(response.advanced().getType() + "-" + response.getCode());
System.out.println(response.getResponseText());
System.out.println("===============\nCC04");
System.out.println("---------------\nPOST /test\n---------------");
response = client.post("non-empty", MediaTypeRegistry.TEXT_PLAIN);
System.out.println(response.advanced().getType() + "-" + response.getCode());
System.out.println(response.getResponseText());
client.useNONs();
System.out.println("===============\nCC05");
System.out.println("---------------\nNON-GET /test\n---------------");
response = client.get();
System.out.println(response.advanced().getType() + "-" + response.getCode());
System.out.println(response.getResponseText());
System.out.println("===============\nCC06");
System.out.println("---------------\nNON-DELETE /test\n---------------");
response = client.delete();
System.out.println(response.advanced().getType() + "-" + response.getCode());
System.out.println(response.getResponseText());
System.out.println("===============\nCC07");
System.out.println("---------------\nNON-PUT /test\n---------------");
response = client.put("", MediaTypeRegistry.TEXT_PLAIN);
System.out.println(response.advanced().getType() + "-" + response.getCode());
System.out.println(response.getResponseText());
System.out.println("===============\nCC08");
System.out.println("---------------\nNON-POST /test\n---------------");
response = client.post("non-empty", MediaTypeRegistry.TEXT_PLAIN);
System.out.println(response.advanced().getType() + "-" + response.getCode());
System.out.println(response.getResponseText());
client.setURI(uri + "/separate");
client.useCONs();
System.out.println("===============\nCC09+11");
System.out.println("---------------\nGET /separate\n---------------");
response = client.get();
System.out.println(response.advanced().getType() + "-" + response.getCode());
System.out.println(response.getResponseText());
client.setURI(uri + "/test");
System.out.println("===============\nCC12");
System.out.println("---------------\nGET /test w/o Token\n---------------");
Request req12 = Request.newGet(); // never re-use a Request object
req12.setToken(new byte[0]);
response = client.advanced(req12);
System.out.println(response.advanced().getType() + "-" + response.getCode());
System.out.println(response.getResponseText());
client.setURI(uri + "/seg1/seg2/seg3");
System.out.println("===============\nCC13");
System.out.println("---------------\nGET /seg1/seg2/seg3\n---------------");
response = client.get();
System.out.println(response.advanced().getType() + "-" + response.getCode());
System.out.println(response.getResponseText());
client.setURI(uri + "/query?first=1&second=2");
System.out.println("===============\nCC14");
System.out.println("---------------\nGET /query?first=1&second=2\n---------------");
response = client.get();
System.out.println(response.advanced().getType() + "-" + response.getCode());
System.out.println(response.getResponseText());
client.setURI(uri + "/separate");
client.setTimeout(10000);
client.useNONs();
System.out.println("===============\nCC17");
System.out.println("---------------\nNON-GET /separate\n---------------");
response = client.get();
System.out.println(response.advanced().getType() + "-" + response.getCode());
System.out.println(response.getResponseText());
client.setURI(uri + "/test");
client.setTimeout(0);
client.useCONs();
System.out.println("===============\nCC18");
System.out.println("---------------\nPOST /test for Location-Path\n---------------");
response = client.post("TD_COAP_CORE_18", MediaTypeRegistry.TEXT_PLAIN);
System.out.println(response.getCode() + "-" + response.getOptions().getLocationString());
System.out.println(response.getResponseText());
client.setURI(uri + "/location-query");
System.out.println("===============\nCC19");
System.out.println("---------------\nGET /location-query\n---------------");
response = client.post("query", MediaTypeRegistry.TEXT_PLAIN);
System.out.println(response.getCode() + "-" + response.getOptions().getLocationString());
System.out.println(response.getResponseText());
client.setURI(uri + "/multi-format");
System.out.println("===============\nCC20");
System.out.println("---------------\nGET /multi-format text/plain\n---------------");
response = client.get(MediaTypeRegistry.TEXT_PLAIN);
System.out.println(response.getCode() + "-" + MediaTypeRegistry.toString(response.getOptions().getContentFormat()));
System.out.println(response.getResponseText());
System.out.println("---------------\nGET /multi-format application/xml\n---------------");
response = client.get(MediaTypeRegistry.APPLICATION_XML);
System.out.println(response.getCode() + "-" + MediaTypeRegistry.toString(response.getOptions().getContentFormat()));
System.out.println(response.getResponseText());
client.setURI(uri + "/validate");
byte[] etag;
System.out.println("===============\nCC21");
System.out.println("---------------\nGET /validate\n---------------");
response = client.get();
if (response.getOptions().getETagCount()==1) {
etag = response.getOptions().getETags().get(0);
System.out.println(response.getCode() + " - ETag [" + Utils.toHexString(etag) + "]");
System.out.println(response.getResponseText());
System.out.println("---------------\nGET /validate with ETag\n---------------");
response = client.validate(etag);
etag = response.getOptions().getETags().get(0);
System.out.println(response.getCode() + " - ETag [" + Utils.toHexString(etag) + "]");
System.out.println(response.getResponseText());
System.out.println("---------------\nPUT /validate stimulus\n---------------");
CoapClient clientStimulus = new CoapClient(uri + "/validate");
response = clientStimulus.put("CC21 at " + new SimpleDateFormat("HH:mm:ss.SSS").format(new Date()), MediaTypeRegistry.TEXT_PLAIN);
System.out.println(response.getCode());
System.out.println("---------------\nGET /validate with ETag\n---------------");
response = client.validate(etag);
etag = response.getOptions().getETags().get(0);
System.out.println(response.getCode() + " - ETag [" + Utils.toHexString(etag) + "]");
System.out.println(response.getResponseText());
} else {
System.out.println("Error - no ETag");
}
System.out.println("===============\nCC22");
System.out.println("---------------\nGET /validate with If-Match\n---------------");
response = client.get();
if (response.getOptions().getETagCount()==1) {
etag = response.getOptions().getETags().get(0);
System.out.println(response.getCode() + " - ETag [" + Utils.toHexString(etag) + "]");
System.out.println(response.getResponseText());
System.out.println("---------------\nPUT /validate If-Match [" + Utils.toHexString(etag) + "]\n---------------");
response = client.putIfMatch("CC22 at " + new SimpleDateFormat("HH:mm:ss.SSS").format(new Date()),
MediaTypeRegistry.TEXT_PLAIN, etag);
System.out.println(response.getCode());
System.out.println("---------------\nGET /validate\n---------------");
response = client.get();
etag = response.getOptions().getETags().get(0);
System.out.println(response.getCode() + " - ETag [" + Utils.toHexString(etag) + "]");
System.out.println(response.getResponseText());
System.out.println("---------------\nPUT /validate stimulus\n---------------");
CoapClient clientStimulus = new CoapClient(uri + "/validate");
response = clientStimulus.put("CC22 at " + new SimpleDateFormat("HH:mm:ss.SSS").format(new Date()), MediaTypeRegistry.TEXT_PLAIN);
System.out.println(response.getCode());
System.out.println("---------------\nPUT /validate If-Match [" + Utils.toHexString(etag) + "]\n---------------");
response = client.putIfMatch("CC22 at " + new SimpleDateFormat("HH:mm:ss.SSS").format(new Date()),
MediaTypeRegistry.TEXT_PLAIN, etag);
System.out.println(response.getCode());
} else {
System.out.println("Error - no ETag");
}
client.setURI(uri + "/create1");
System.out.println("===============\nCC23");
System.out.println("---------------\nPUT /create1 with If-None-Match\n---------------");
response = client.putIfNoneMatch("CC23 at " + new SimpleDateFormat("HH:mm:ss.SSS").format(new Date()),
MediaTypeRegistry.TEXT_PLAIN);
System.out.println(response.getCode());
System.out.println("---------------\nPUT /create1 with If-None-Match\n---------------");
response = client.putIfNoneMatch("CC23 at " + new SimpleDateFormat("HH:mm:ss.SSS").format(new Date()),
MediaTypeRegistry.TEXT_PLAIN);
System.out.println(response.getCode());
}
public static void testCB(String uri) {
CoapClient client = new CoapClient(uri + "/large");
CoapResponse response;
client.useEarlyNegotiation(64);
System.out.println("===============\nCB01");
System.out.println("---------------\nGET /large\n---------------");
response = client.get();
System.out.println(response.getCode());
System.out.println(response.getResponseText());
client.useLateNegotiation();
System.out.println("===============\nCB02");
System.out.println("---------------\nGET /large\n---------------");
response = client.get();
System.out.println(response.getCode());
System.out.println(response.getResponseText());
client.setURI(uri + "/large-update");
System.out.println("===============\nCB03");
System.out.println("---------------\nPUT /large-update\n---------------");
response = client.put(getLargeRequestPayload(), MediaTypeRegistry.TEXT_PLAIN);
System.out.println(response.getCode());
System.out.println(response.getResponseText());
client.setURI(uri + "/large-create");
System.out.println("===============\nCB04");
System.out.println("---------------\nPOST /large-create\n---------------");
response = client.post(getLargeRequestPayload(), MediaTypeRegistry.TEXT_PLAIN);
System.out.println(response.getCode() + " - " + response.getOptions().getLocationString());
System.out.println(response.getResponseText());
client.setURI(uri + response.getOptions().getLocationString());
System.out.println("---------------\nGET " + response.getOptions().getLocationString() + "\n---------------");
response = client.get();
System.out.println(response.getCode());
System.out.println(response.getResponseText());
client.setURI(uri + "/large-post");
System.out.println("===============\nCB05");
System.out.println("---------------\nPOST /large-post\n---------------");
response = client.post(getLargeRequestPayload(), MediaTypeRegistry.TEXT_PLAIN);
System.out.println(response.getCode());
System.out.println(response.getResponseText());
client.setURI(uri + "/large");
client.useEarlyNegotiation(16);
System.out.println("===============\nCB06");
System.out.println("---------------\nGET /large\n---------------");
response = client.get();
System.out.println(response.getCode());
System.out.println(response.getResponseText());
}
public static void testCO(String uri) {
CoapClient client = new CoapClient(uri + "/obs");
System.out.println("===============\nCO01+06");
System.out.println("---------------\nGET /obs with Observe");
CoapObserveRelation relation1 = client.observe(
new CoapHandler() {
@Override public void onLoad(CoapResponse response) {
String content = response.getResponseText();
System.out.println("-CO01----------");
System.out.println(content);
}
@Override public void onError() {
System.err.println("-Failed--------");
}
});
try { Thread.sleep(6*1000); } catch (InterruptedException e) { }
System.out.println("---------------\nCancel Observe");
relation1.reactiveCancel();
try { Thread.sleep(6*1000); } catch (InterruptedException e) { }
client.setURI(uri + "/obs-non").useNONs();
System.out.println("===============\nCO02+06");
System.out.println("---------------\nNON-GET /obs-non with Observe");
CoapObserveRelation relation2 = client.observe(
new CoapHandler() {
@Override public void onLoad(CoapResponse response) {
String content = response.getResponseText();
System.out.println("-CO02----------");
System.out.println(content);
}
@Override public void onError() {
System.err.println("-Failed--------");
}
});
try { Thread.sleep(6*1000); } catch (InterruptedException e) { }
System.out.println("---------------\nCancel Observe");
relation2.proactiveCancel();
try { Thread.sleep(2*1000); } catch (InterruptedException e) { }
client.setURI(uri + "/obs").useCONs();
System.out.println("===============\nCO04");
System.out.println("---------------\nGET /obs with Observe");
CoapObserveRelation relation4 = client.observeAndWait(
new CoapHandler() {
@Override public void onLoad(CoapResponse response) {
String content = response.getResponseText();
System.out.println("-CO04----------");
System.out.println(content);
}
@Override public void onError() {
System.err.println("-Failed--------");
}
});
long timeout = relation4.getCurrent().getOptions().getMaxAge();
try { Thread.sleep(6*1000); } catch (InterruptedException e) { }
System.out.println("---------------\nReboot Server");
CoapClient clientStimulus = new CoapClient(uri + "/obs-reset");
clientStimulus.post("sesame", MediaTypeRegistry.TEXT_PLAIN);
try { Thread.sleep((timeout+6)*1000); } catch (InterruptedException e) { }
relation4.proactiveCancel();
try { Thread.sleep(2*1000); } catch (InterruptedException e) { }
client.setURI(uri + "/obs-large");
System.out.println("===============\nCO13");
System.out.println("---------------\nGET /obs-large with Observe");
CoapObserveRelation relation13 = client.observe(
new CoapHandler() {
@Override public void onLoad(CoapResponse response) {
String content = response.getResponseText();
System.out.println("-CO13----------");
System.out.println(content);
}
@Override public void onError() {
System.err.println("-Failed--------");
}
});
try { Thread.sleep(11*1000); } catch (InterruptedException e) { }
System.out.println("---------------\nCancel Observe");
relation13.proactiveCancel();
try { Thread.sleep(6*1000); } catch (InterruptedException e) { }
client.setURI(uri + "/obs-pumping");
System.out.println("===============\nCO14");
System.out.println("---------------\nGET /obs-pumping with Observe");
CoapObserveRelation relation14 = client.observe(
new CoapHandler() {
@Override public void onLoad(CoapResponse response) {
String content = response.getResponseText();
System.out.println("-CO14----------");
System.out.println(content);
}
@Override public void onError() {
System.err.println("-Failed--------");
}
});
try { Thread.sleep(21*1000); } catch (InterruptedException e) { }
System.out.println("---------------\nCancel Observe");
relation14.proactiveCancel();
try { Thread.sleep(6*1000); } catch (InterruptedException e) { }
}
public static void testCL(String uri) {
CoapClient client = new CoapClient(uri);
Set<WebLink> links;
System.out.println("===============\nCL01");
System.out.println("---------------\nGET /.well-known/core\n---------------");
links = client.discover();
for (WebLink link : links) {
System.out.println(link);
}
System.out.println("===============\nCL02");
System.out.println("---------------\nGET /.well-known/core?rt=Type1\n---------------");
links = client.discover("rt=Type1");
for (WebLink link : links) {
System.out.println(link);
}
System.out.println("===============\nCL03");
System.out.println("---------------\nGET /.well-known/core?rt=*\n---------------");
links = client.discover("rt=*");
for (WebLink link : links) {
System.out.println(link);
}
System.out.println("===============\nCL04");
System.out.println("---------------\nGET /.well-known/core?rt=Type2\n---------------");
links = client.discover("rt=Type2");
for (WebLink link : links) {
System.out.println(link);
}
System.out.println("===============\nCL05");
System.out.println("---------------\nGET /.well-known/core?if=If*\n---------------");
links = client.discover("if=If*");
for (WebLink link : links) {
System.out.println(link);
}
System.out.println("===============\nCL06");
System.out.println("---------------\nGET /.well-known/core?sz=*\n---------------");
links = client.discover("sz=*");
for (WebLink link : links) {
System.out.println(link);
}
System.out.println("===============\nCL07");
System.out.println("---------------\nGET /.well-known/core?href=/link1\n---------------");
links = client.discover("href=/link1");
for (WebLink link : links) {
System.out.println(link);
}
System.out.println("===============\nCL08");
System.out.println("---------------\nGET /.well-known/core?href=/link*\n---------------");
links = client.discover("href=/link*");
for (WebLink link : links) {
System.out.println(link);
}
System.out.println("===============\nCL09");
System.out.println("---------------\nGET /.well-known/core?ct=40\n---------------");
links = client.discover("ct=40");
System.out.println("Found " + links.size() + " resource(s)");
for (WebLink link : links) {
client.setURI(link.getURI());
System.out.println("---------------\nGET " + link.getURI() + " with ct=40\n---------------");
Set<WebLink> links2 = LinkFormat.parse(client.get(MediaTypeRegistry.APPLICATION_LINK_FORMAT).getResponseText());
System.out.println("Found " + links2.size() + " resource(s)");
for (WebLink link2 : links2) {
client.setURI(link2.getURI());
System.out.println("---------------\nGET " + link2.getURI() + "\n---------------");
CoapResponse response = client.get();
System.out.println(response.advanced().getType() + "-" + response.getCode());
System.out.println(response.getResponseText());
}
}
}
public static String getLargeRequestPayload() {
return new StringBuilder()
.append("/-------------------------------------------------------------\\\n")
.append("| Request BLOCK NO. 1 OF 5 |\n")
.append("| [each line contains 64 bytes] |\n")
.append("\\-------------------------------------------------------------/\n")
.append("/-------------------------------------------------------------\\\n")
.append("| Request BLOCK NO. 2 OF 5 |\n")
.append("| [each line contains 64 bytes] |\n")
.append("\\-------------------------------------------------------------/\n")
.append("/-------------------------------------------------------------\\\n")
.append("| Request BLOCK NO. 3 OF 5 |\n")
.append("| [each line contains 64 bytes] |\n")
.append("\\-------------------------------------------------------------/\n")
.append("/-------------------------------------------------------------\\\n")
.append("| Request BLOCK NO. 4 OF 5 |\n")
.append("| [each line contains 64 bytes] |\n")
.append("\\-------------------------------------------------------------/\n")
.append("/-------------------------------------------------------------\\\n")
.append("| Request BLOCK NO. 5 OF 5 |\n")
.append("| [each line contains 64 bytes] |\n")
.append("\\-------------------------------------------------------------/\n")
.toString();
}
}