Skip to content

Latest commit

 

History

History
79 lines (53 loc) · 2.61 KB

README.md

File metadata and controls

79 lines (53 loc) · 2.61 KB
Raw

Tron

Short for jumbotron, it is a minimalistic framework to help with our minimalistic assertion based tests.

Usage

Except for the special features, tron behaves exactly like console

Tests

A tron test is a function that you pass to tron that contains any sanity checks that you don't want bogging down your final product.

Call it with your test function like this:

 my_test = (your, args, here) ->
   tron.log( 'this writes to the log' )
   tron.info( "this is \#{your} info message" )
   tron.warn( "this is warning about your \#{args}" )
   tron.error( "there is an error \#{here}" )
   
 tron.test(my_test, 'your', 'args', 'here')

or call it like this:

tron.test( ->
  tron.log('this is a log message')
  tron.info('this is info')
  tron.warn('this is a warning')
  tron.error('this is an error')
)

Tron tests can be selectively run a percentage of the time using tron.throttle() to ease up CPU usage for deployed systems.

Throttle

Calling tron.throttle( p ) where p is a fraction representing the percentage of tests you want to run will allow you to lift some of the testing burden off of deployed servers.

Stopwatch

One function to start and stop the timer.

tron.stopwatch('awesomebenchmark')
fastest_code()
tron.stopwatch('awesomebenchmark')

Log Levels

Tron allows you to filter out messages of unimportance.

Setting Level

To set the level, use:

###
Here we will set tron to hide all messages less important than a warning.
###
tron.level( tron.warn )

License

Copyright (c) 2012 Socrenchus LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.