@@ -17,7 +17,6 @@ You need to have [Node](http://tinyclouds.org/node/) installed. new diligence.Server(function(setup) { setup.publicPath = '../public'; setup.testPaths ='tests/tests.js'; - setup.collectPath ='tests/collect.js', setup.process = function(req, results) { puts('* You can customize the process function in your setup block to handle test results'); for(var key in results) { @@ -27,43 +26,43 @@ You need to have [Node](http://tinyclouds.org/node/) installed. }); } -* Enter paths to your files as setup.testPaths (path globbing coming next) -* Modify the function in tests/collect.js to return an object structure that contains the results of your tests. Use whatever structure you want, but keep in mind it will be transferred to the server encoded in JSON (so you can only send data). +* Enter paths to your files as setup.testPaths. Make sure that the last file in the list makes a call to <code>diligence.respond</code> with an object structure that represents your test results. +* Modify the function in tests/respond.js to return an object structure that contains the results of your tests. Use whatever structure you want, but keep in mind it will be transferred to the server encoded in JSON (so you can only send data). * Modify setup.process to handle your returned data as you see fit. ## Configuration options The following options can be set inside a setup block: -### publicPath - -A string. The path to the public directory, relative to the suite file. Defaults to 'public/' (will work when <code>diligence.js</code> and the public directory are in the same directory). - -### testPaths +### debug -A string or an array of strings. The path to one or more files to be sent to the client. File globbing coming soon. +Boolean. Whether to show noisy debug information. -### collectPath +### port -A string. The path to <code>collect.js</code>, where the data collection code if defined. This code should return an object structure that can be converted to JSON using <code>JSON.stringify</code>. +An integer. This is the port the diligence server will run on. Default is 5678. ### process A callback function that recieves the decoded JSON data from the client. It is up to this function to write to the console, log files, etc. -### port +### publicPath -An integer. This is the port the diligence server will run on. Default is 5678. +A string. The path to the public directory, relative to the suite file. Defaults to 'public/' (will work when <code>diligence.js</code> and the public directory are in the same directory). -### debug +### testPaths -Boolean. Whether to show noisy debug information. +A string or an array of strings. The path to one or more files to be sent to the client. File globbing coming soon. ## Running the server node test_suite.js -Where 'test_suite.js' is the name of your configuration file. Then point a browser to localhost:5678. I've only used Firefox and Safari so far. +Where 'test_suite.js' is the name of your configuration file. Then point a browser to localhost:5678. + +### Browser Compatibility + +Diligence works in Safari, Firefox, and Chrome. Opera has a problem with the ajax code, which probably needs to be replaced anyhow. IE support coming next. ## What is going on here README.markdown cda7204540aa443e4f52f64b85d0dd712f4cb74e Jim Benton jim@autonomousmachine.com http://github.com/jim/diligence/commit/af3eb33585f62fa6bfe350b97421f764522ffec6 af3eb33585f62fa6bfe350b97421f764522ffec6 2009-06-17T16:07:29-07:00 2009-06-17T16:07:29-07:00 Updated README 09526f90886b8cba8d38999efd81ebf9d996959f Jim Benton jim@autonomousmachine.com