Eric Peterson

December 23, 2017

Spread the word

Share your thoughts

Today's featured module is a TestBox module that introduces snapshot testing capabilities to TestBox. If you've avoided testing your legacy applications, come see how [TestBox Snapshots]( can get you started.

TestBox Snapshots

What is snapshot testing?

Snapshot testing is the latest craze. Popularized by Facebook’s Jest testing framework, snapshot testing is a simple way to add regression testing to your application.

Snapshots are useful for making sure the data passed in does not change unexpectedly. Snapshots aren't meant to replace other types of testing and assertions, but rather are another tool for helping you sleep at night knowing your application is performing as it should.


To get started with snapshot testing in TestBox, install the testbox-snapshots module from ForgeBox. Then add the matchers in your beforeAll method.

function beforeAll() {
    addMatchers( "testbox-snapshots.SnapshotMatchers" );

You can then assert that snapshots match using the toMatchSnapshot method.

it( "should display the home page", function() {
	var event = execute( event = "Main.index", renderResults = true );
	expect( event.getRenderedContent() ).toMatchSnapshot();
} );

Note: there is no notToMatchSnapshot method.

Here's the flow for how the matcher works:

  1. It checks if a snapshot has been generated for this spec. If not, it fails the test and suggests you generate a snapshot.

  2. If the updateSnapshots url flag is passed, the snapshot will be created or updated with the new value and the test will pass.

  3. If a snapshot exists and the updateSnapshots url flag is not passed, it passes only if the value passed in matches the snapshot.

Better Diffing

For more precise changes, make sure to include the optional java library in your test's load paths (this.javaSettings). It produces a diff of the files instead of just outputting the contents in their entirety. You can enable this by including the following in your tests/Application.cfc:

this.javaSettings = {
    loadPaths = [ "testbox-snapshots/lib" ],
    reloadOnChange = false

Wrap Up

Want more information on snapshot testing with TestBox? You can check out my own blog post about the subject, or Jason Steinshouer's two-part series on the topic (here and here).

Add Your Comment

Recent Entries

Ortus Solutions Soars Back to CFCamp Munich as Platinum Sponsor and Keynote Presenter!

Ortus Solutions Soars Back to CFCamp Munich as Platinum Sponsor and Keynote Presenter!

We're thrilled to announce that Ortus Solutions is returning to CFCamp Munich for another year! We're incredibly proud to be a continuing sponsor of this fantastic event and can't wait to connect with the ColdFusion community once again.

Taking Center Stage with the Day 1 Keynote

Get ready for some deep dives into the world of BoxLang! Ortus Solutions will be kicking off CFCamp with a dynamic keynote address on day 1. This is your chance to gain valua...

Cristobal Escobar
Cristobal Escobar
May 28, 2024
Into the Box 2025 - Blind Tickets are Out!

Into the Box 2025 - Blind Tickets are Out!

Ortus Solutions is thrilled to announce the release of blind tickets for Into the Box 2025, the premier event for web developers. This year's conference promises to be a game-changer, especially with the unveiling of our groundbreaking new product, BoxLang. **Our team is working hard to get all modern CFML developers amazing tools and software features to improve their productivity. **

Maria Jose Herrera
Maria Jose Herrera
May 27, 2024
Into the Box - Keynote Recap Day 1

Into the Box - Keynote Recap Day 1

Day 1 of Into the Box kicked off with an electrifying keynote session that set the tone for an incredible conference. The excitement was palpable as developers, tech enthusiasts, and industry leaders gathered to explore the latest innovations and trends in web development.

Maria Jose Herrera
Maria Jose Herrera
May 24, 2024