* MCTX3420 2013 - Remote pressurised can experiment.
* Unit testing for the server API.
* These unit tests use the QUnit unit testing framework.
- * @requires QUnit and jQuery
+ * @requires QUnit, jQuery, and base64.js
* @date 28/8/13
* @author Jeremy Tan
*/
-var api = location.protocol + "//" + location.host + "/api/";
+//Namespace ut
+
+ut = {};
+ut.api = location.protocol + "//" + location.host + "/api/";
+ut.ckey = undefined;
+ut.controlcb = $.Callbacks();
/**
* Sends an AJAX query to the API
- * query(module, username, password, callback);
- * query(module, callback);
- * query(module, opts, callback);
- * query(module, opts, username, password, callback);
* @param {string} module The name of the module to be queried
- * @param {Object} opts Object containing parameters to pass to module
- * @param {string} username Optional
- * @param {string} password Required if username specified
- * @param {function} callback Function that receives JSON data
- * @returns JSON data
+ * @param {Object} opts Object holding the parameters, username, password and
+ * callback. The parameters should be an object of key/value
+ * pairs.
+ * @returns jqXHR object (but calls callback with JSON data, or null on AJAX error)
*/
-function query(module, opts, username, password, callback) {
- if (typeof opts === 'string') {
- callback = password;
- password = username;
- username = opts;
- opts = undefined;
- } else if (typeof opts === 'function') {
- callback = opts;
- opts = undefined;
- } else if (typeof username === 'function') {
- callback = username;
- username = undefined;
- }
-
- function buildQuery(opts) {
- var result = "?";
- var first = true;
-
- for (key in opts) {
- if (!first)
- result += "&";
- else
- first = false;
- result += encodeURIComponent(key) +
- (opts.key ? "=" + encodeURIComponent(opts.key) : "");
- }
- return result;
- }
-
- var queryurl = api + module;
- if (opts)
- queryurl += buildQuery(opts);
+function query(module, opts) {
+ var queryurl = ut.api + module;
var authfunc;
- if (username) {
+ if (opts.username) {
authfunc = function(xhr) {
xhr.setRequestHeader("Authorization",
- "Basic " + btoa(username + ":" + password));
+ "Basic " + base64.encode(opts.username + ":" + opts.password));
};
}
- $.ajax({
+ return $.ajax({
url: queryurl,
type: 'GET',
dataType: 'json',
- beforeSend: authfunc
- }).done(callback)
+ data: opts.params,
+ beforeSend: authfunc,
+ async: opts.async
+ }).done(opts.callback)
.fail(function(jqXHR) {
- //Note:Callback must be called so the QUnit test can run.
- if (jqXHR.status !== 400) {
- callback({"status" : jqXHR.status, "description" : jqXHR.statusText});
- } else {
- try {
- callback($.parseJSON(jqXHR.responseText));
- } catch (err) {
- callback({"status" : jqXHR.status, "description" : jqXHR.statusText});
- }
- }
+ ok(false, "Request failed: " + jqXHR.status.toString() + " " + jqXHR.statusText);
+ opts.callback(null);
});
}
+QUnit.module("API basics");
+QUnit.asyncTest("API Existence (identify)", function () {
+ query("identify", {callback : function(data) {
+ start();
+ ok(data.status > 0, "Return status");
+ ok(data.description, data.description);
+ ok(data.build_date, data.build_date);
+ }});
+});
-QUnit.asyncTest("API Existence", function () {
- query("test", function(data) {
+QUnit.asyncTest("Invalid module", function () {
+ query("dontexist", {callback : function(data) {
start();
- //TODO:Change fastcgi error codes
- equal(parseInt(data.status, 10), 400, "Nonexistent module"); //Magic numbers!
- });
+ ok(data.status < 0);
+ }});
});
-QUnit.asyncTest("Login test", function() {
- query("login", {"force" : true}, "mctxadmin", "admin", function(data) {
+QUnit.module("Sensors");
+QUnit.asyncTest("Existence", function() {
+ query("sensors", {params : {id : 0}, callback : function(data) {
start();
- equal(parseInt(data.status, 10), 200, "Login ok"); //Magic numbers!
- });
+ ok(data.status > 0, "Return status");
+ ok(data.data !== undefined, "Data field existence");
+ var result = "Data: ";
+ for (var i = 0; i < data.data.length; i++) {
+ result += data.data[i][0] + ":" + data.data[i][1] + ", ";
+ }
+ ok(true, result);
+ }});
});
-QUnit.test("Sensors module", function() {
-
+QUnit.asyncTest("Invalid sensor id 1", function() {
+ query("sensors", {params : {id : 999}, callback : function(data) {
+ start();
+ ok(data.status < 0, "Return status");
+ }});
});
-/*QUnit.test("Login module", function () {
-
-});*/
+QUnit.asyncTest("Invalid sensor id 2", function() {
+ query("sensors", {params : {id : ""}, callback : function(data) {
+ start();
+ ok(data.status < 0, "Return status");
+ }});
+});
-QUnit.test("Access control", function () {
-
+QUnit.asyncTest("Out of bounds sensor id 1", function() {
+ query("sensors", {params : {id : "-1"}, callback : function(data) {
+ start();
+ ok(data.status < 0, "Return status");
+ }});
+});
+
+QUnit.asyncTest("Out of bounds sensor id 2", function() {
+ query("sensors", {params : {id : "999"}, callback : function(data) {
+ start();
+ ok(data.status < 0, "Return status");
+ }});
+});
+
+QUnit.module("Controls and access");
+QUnit.asyncTest("Gaining access", function() {
+ ut.controlcb.add(function () {
+ query("control", {params : {action : "start", force : true},
+ username : $("#username").val(), password : $("#password").val(),
+ async : false,
+ callback : function(data) {
+ start();
+ ok(data.status > 0, "Return status");
+ ut.ckey = data.key;
+ }});
+ });
+});
+
+QUnit.asyncTest("Setting actuator value", function () {
+ ut.controlcb.add(function () {
+ query("control", {params : {action : "set", id : 0,
+ username : $("#username").val(), password : $("#password").val(),
+ value : 200, key : ut.ckey},
+ callback : function(data) {
+ start();
+ ok(data.status > 0, "Return status");
+ ok(true, data.description);
+ }});
+ });
+});
+
+$(document).ready(function(){
+ $("#control").submit(function () {
+ ut.controlcb.fire();
+ return false;
+ });
});
\ No newline at end of file