twolfsonspritesmith-engine-test 
Common test suite for spritesmith engines
These files were written for usage with mocha
Specification version
The current repository version is built to match specification version:
2.0.0
Specification documentation can be found at:
https://github.com/twolfson/spritesmith-engine-spec/tree/2.0.0
Getting started
Install the module via: npm install spritesmith-engine-test
Create files that require and run the test suite:
test/myengine_test.js:
// Load in dependencies
var spritesmithEngineTest = require('spritesmith-engine-test');
var MyEngine = require('../lib/engine');
// Run our test suite
// DEV: This loads and define multiple `mocha` test suites
spritesmithEngineTest.run({
engine: MyEngine,
engineName: 'myengine'
});
Run your tests via mocha:
# Install test dependencies
npm install mocha
# Run mocha test suite
./node_modules/.bin/mocha test/
# myengine
# interpretting an image file
# ✓ gathers statistics on an image file
# ...
Documentation
spritesmith-engine-test exports the following keys its module.exports:
- config
Object- Assortment of configurations used for each test suite- See lib/config.js for documentation
- Feel free to reuse these in any of your one-off tests
- run
Function- Test suite runner- Documentation cane be found below
- spritesmithUtils
Object- One-off utilities for our test mocha suites- See lib/utils/ for documentation
- Feel free to reuse these in any of your one-off tests
run(params)
Generates a set of mocha test suites for a spritesmith engine
- params
Object- Container for test setup- engine
Object-spritesmithengine as defined by spritesmith-engine-spec - engineName
String- Name of engine to use in test suites - engineOptions
Object- Optional options to pass toengineconstructor - tests
Object- Optional overrides to enable/disable tests- By default, all tests will run
- Signature should be
testName: boolean(e.g.{interpretPngImage: false}) - A list of tests can be found below
- engine
Example with tests:
spritesmithEngineTest.run({
engine: myengine,
engineName: 'myengine',
// Skip over rendering a GIF image
tests: {
renderGifCanvas: false
}
});
Tests
Our test suite has the following tests built into it:
- assertSpecVersion - Verify the engine has a
specVersionfor the corresponding specification - interpretPngImage - Loads a PNG image and asserts we get the correct height/width
- interpretJpegImage - Same as
interpretPngImagebut for a JPEG (usingformat: 'jpeg') - interpretJpgImage - Same as
interpretPngImagebut for a JPEG (usingformat: 'jpg') - interpretGifImage - Same as
interpretPngImagebut for a GIF - renderPngCanvas - Loads a PNG image, renders it via the
export, and asserts the image is more/less the same - renderJpgCanvas - Same as
renderPngCanvasbut for a JPG - renderGifCanvas - Same as
renderPngCanvasbut for a GIF - renderPngBufferVinylCanvas - Same as
renderPngCanvasbut uses a buffer-based Vinyl object instead of a filepath - renderPngStreamVinylCanvas - Same as
renderPngCanvasbut uses a stream-based Vinyl object instead of a filepath - renderPngNullVinylCanvas - Same as
renderPngCanvasbut uses a null-based Vinyl object instead of a filepath - renderMultiplePngImages - Load multiple images, place them at different spots on a canvas, and verify the placements are respected
- renderManyPngImages - Load 500 images and render them on a canvas
- This is to verify each engine can handle a signficant amount of images
- interpretLargePngImage - Load an 800x600 image and assert we get the correct height/width
- This is part of a regression we encountered in
phantomjssmith
- This is part of a regression we encountered in
Donating
Support this project and others by twolfson via donations.
http://twolfson.com/support-me
License
Copyright (c) 2013-2014 Todd Wolfson
Licensed under the MIT license.