util.js
240 lines
| 7.6 KiB
| application/javascript
|
JavascriptLexer
|
r13249 | // | ||
// Utility functions for the HTML notebook's CasperJS tests. | ||||
// | ||||
// Get the URL of a notebook server on which to run tests. | ||||
|
r13275 | casper.get_notebook_server = function () { | ||
|
r13271 | port = casper.cli.get("port") | ||
port = (typeof port === 'undefined') ? '8888' : port; | ||||
return 'http://127.0.0.1:' + port | ||||
|
r13249 | }; | ||
// Create and open a new notebook. | ||||
|
r13275 | casper.open_new_notebook = function () { | ||
var baseUrl = this.get_notebook_server(); | ||||
|
r13284 | this.start(baseUrl); | ||
this.thenClick('button#new_notebook'); | ||||
this.waitForPopup(''); | ||||
|
r13290 | this.withPopup('', function () {this.waitForSelector('.CodeMirror-code');}); | ||
|
r13284 | this.then(function () { | ||
// XXX: Kind of odd, the next line works for one test, but not when | ||||
// running multiple tests back-to-back, so we will just point the main | ||||
// casper browser to the same URL as the popup we just grabbed. | ||||
//this.page = this.popups[0]; | ||||
this.open(this.popups[0].url); | ||||
}); | ||||
|
r13258 | // initially, the cells aren't created, so wait for them to appear | ||
this.waitForSelector('.CodeMirror-code'); | ||||
|
r13290 | // and make sure the kernel has started | ||
|
r13302 | this.waitFor( this.kernel_running ); | ||
|
r14933 | // track the IPython busy/idle state | ||
this.thenEvaluate(function () { | ||||
$([IPython.events]).on('status_idle.Kernel',function () { | ||||
IPython._status = 'idle'; | ||||
}); | ||||
$([IPython.events]).on('status_busy.Kernel',function () { | ||||
IPython._status = 'busy'; | ||||
}); | ||||
}); | ||||
|
r13302 | }; | ||
// return whether or not the kernel is running | ||||
casper.kernel_running = function kernel_running() { | ||||
return this.evaluate(function kernel_running() { | ||||
return IPython.notebook.kernel.running; | ||||
|
r13290 | }); | ||
|
r13249 | }; | ||
// Shut down the current notebook's kernel. | ||||
|
r13275 | casper.shutdown_current_kernel = function () { | ||
|
r13249 | this.thenEvaluate(function() { | ||
|
r13255 | IPython.notebook.kernel.kill(); | ||
|
r13249 | }); | ||
}; | ||||
// Delete created notebook. | ||||
|
r13275 | casper.delete_current_notebook = function () { | ||
|
r13249 | this.thenEvaluate(function() { | ||
var nbData = $('body').data(); | ||||
var url = nbData.baseProjectUrl + 'notebooks/' + nbData.notebookId; | ||||
$.ajax(url, { | ||||
type: 'DELETE', | ||||
}); | ||||
}); | ||||
}; | ||||
|
r14933 | casper.wait_for_idle = function () { | ||
|
r14934 | this.waitFor(function () { | ||
return this.evaluate(function () { | ||||
return IPython._status == 'idle'; | ||||
|
r14933 | }); | ||
}); | ||||
}; | ||||
|
r14904 | // wait for the nth output in a given cell | ||
casper.wait_for_output = function (cell_num, out_num) { | ||||
|
r14933 | this.wait_for_idle(); | ||
|
r14904 | out_num = out_num || 0; | ||
this.then(function() { | ||||
this.waitFor(function (c, o) { | ||||
return this.evaluate(function get_output(c, o) { | ||||
var cell = IPython.notebook.get_cell(c); | ||||
return cell.output_area.outputs.length > o; | ||||
}, | ||||
// pass parameter from the test suite js to the browser code js | ||||
{c : cell_num, o : out_num}); | ||||
}); | ||||
|
r14435 | }, | ||
function then() { }, | ||||
function timeout() { | ||||
this.echo("wait_for_output timed out!"); | ||||
|
r13294 | }); | ||
}; | ||||
|
r14864 | // return an output of a given cell | ||
|
r14147 | casper.get_output_cell = function (cell_num, out_num) { | ||
out_num = out_num || 0; | ||||
var result = casper.evaluate(function (c, o) { | ||||
|
r13299 | var cell = IPython.notebook.get_cell(c); | ||
|
r14147 | return cell.output_area.outputs[o]; | ||
|
r13299 | }, | ||
|
r14147 | {c : cell_num, o : out_num}); | ||
|
r14864 | if (!result) { | ||
var num_outputs = casper.evaluate(function (c) { | ||||
var cell = IPython.notebook.get_cell(c); | ||||
return cell.output_area.outputs.length; | ||||
}, | ||||
{c : cell_num}); | ||||
this.test.assertTrue(false, | ||||
"Cell " + cell_num + " has no output #" + out_num + " (" + num_outputs + " total)" | ||||
); | ||||
} else { | ||||
return result; | ||||
} | ||||
|
r13299 | }; | ||
|
r13300 | // return the number of cells in the notebook | ||
casper.get_cells_length = function () { | ||||
var result = casper.evaluate(function () { | ||||
return IPython.notebook.get_cells().length; | ||||
}) | ||||
return result; | ||||
}; | ||||
|
r13765 | // Set the text content of a cell. | ||
casper.set_cell_text = function(index, text){ | ||||
this.evaluate(function (index, text) { | ||||
var cell = IPython.notebook.get_cell(index); | ||||
cell.set_text(text); | ||||
|
r14933 | }, index, text); | ||
|
r13765 | }; | ||
|
r13766 | // Inserts a cell at the bottom of the notebook | ||
// Returns the new cell's index. | ||||
casper.insert_cell_at_bottom = function(cell_type){ | ||||
if (cell_type===undefined) { | ||||
cell_type = 'code'; | ||||
} | ||||
return this.evaluate(function (cell_type) { | ||||
var cell = IPython.notebook.insert_cell_at_bottom(cell_type); | ||||
return IPython.notebook.find_cell_index(cell); | ||||
|
r14933 | }, cell_type); | ||
|
r13766 | }; | ||
|
r13765 | // Insert a cell at the bottom of the notebook and set the cells text. | ||
// Returns the new cell's index. | ||||
casper.append_cell = function(text, cell_type) { | ||||
|
r13766 | var index = this.insert_cell_at_bottom(cell_type); | ||
|
r13765 | if (text !== undefined) { | ||
|
r13766 | this.set_cell_text(index, text); | ||
|
r13765 | } | ||
return index; | ||||
}; | ||||
// Asynchronously executes a cell by index. | ||||
// Returns the cell's index. | ||||
casper.execute_cell = function(index){ | ||||
var that = this; | ||||
this.then(function(){ | ||||
that.evaluate(function (index) { | ||||
var cell = IPython.notebook.get_cell(index); | ||||
cell.execute(); | ||||
|
r14933 | }, index); | ||
|
r13765 | }); | ||
return index; | ||||
}; | ||||
// Synchronously executes a cell by index. | ||||
// Optionally accepts a then_callback parameter. then_callback will get called | ||||
// when the cell has finished executing. | ||||
// Returns the cell's index. | ||||
casper.execute_cell_then = function(index, then_callback) { | ||||
|
r13766 | var return_val = this.execute_cell(index); | ||
|
r13765 | |||
|
r14933 | this.wait_for_idle(); | ||
|
r13765 | |||
var that = this; | ||||
this.then(function(){ | ||||
if (then_callback!==undefined) { | ||||
then_callback.apply(that, [index]); | ||||
} | ||||
}); | ||||
return return_val; | ||||
}; | ||||
// Utility function that allows us to easily check if an element exists | ||||
// within a cell. Uses JQuery selector to look for the element. | ||||
casper.cell_element_exists = function(index, selector){ | ||||
return casper.evaluate(function (index, selector) { | ||||
var $cell = IPython.notebook.get_cell(index).element; | ||||
return $cell.find(selector).length > 0; | ||||
}, index, selector); | ||||
}; | ||||
// Utility function that allows us to execute a jQuery function on an | ||||
// element within a cell. | ||||
casper.cell_element_function = function(index, selector, function_name, function_args){ | ||||
return casper.evaluate(function (index, selector, function_name, function_args) { | ||||
var $cell = IPython.notebook.get_cell(index).element; | ||||
var $el = $cell.find(selector); | ||||
return $el[function_name].apply($el, function_args); | ||||
}, index, selector, function_name, function_args); | ||||
}; | ||||
|
r13253 | // Wrap a notebook test to reduce boilerplate. | ||
|
r13275 | casper.notebook_test = function(test) { | ||
this.open_new_notebook(); | ||||
|
r13253 | this.then(test); | ||
|
r13285 | //XXX: we get sporadic error messages when shutting down some of the tests. | ||
// Since the entire server will go down at the end of running the test | ||||
// suite, it's ok for now to not try to shut anything down. | ||||
|
r13288 | this.shutdown_current_kernel(); | ||
|
r13285 | |||
|
r13275 | //XXX: the implementation of delete_current_notebook is currently broken | ||
|
r13285 | // it's not a big deal, since the notebook directory will be deleted on | ||
// cleanup, but we should add tests for deleting the notebook separately | ||||
|
r13275 | //this.delete_current_notebook(); | ||
|
r13253 | |||
// Run the browser automation. | ||||
this.run(function() { | ||||
this.test.done(); | ||||
}); | ||||
}; | ||||
|
r13309 | casper.options.waitTimeout=10000 | ||
|
r13272 | casper.on('waitFor.timeout', function onWaitForTimeout(timeout) { | ||
|
r13275 | this.echo("Timeout for " + casper.get_notebook_server()); | ||
|
r13272 | this.echo("Is the notebook server running?"); | ||
}); | ||||
|
r13249 | // Pass `console.log` calls from page JS to casper. | ||
casper.printLog = function () { | ||||
this.on('remote.message', function(msg) { | ||||
this.echo('Remote message caught: ' + msg); | ||||
}); | ||||
}; | ||||