Webinar
Smarty

Your Convey needs more focus

Smarty header pin graphic
February 7, 2014
Tags

One of the great benefits of TDD/BDD is that you usually don't have to spend much, if any time at all in a debugger. To enter a debugger is to admit a loss of control over the system under test. Even so, there are times when you do need to debug something, even if you're maintaining the discipline.

Lately, most of my coding is in GoLang. Coming from using an IDE almost exclusively to write Python (using PyCharm) and C# (using VS and ReSharper), and knowing how great the visual debugging tools are it's hard to fathom using a console-based debugger for GoLang code. Yes, I know about godbg, which is an amazing tool, but I would rather stay in my test runner of choice, which is GoConvey.

Up until now I would do something like this to achieve debugging:

  • Add log.Println statements where the bugs are
  • Use SkipConvey to limit execution to the test in question (this can get tedious if the test suite is large)
  • Run the tests and observe the output

Or...

  • Add the logging statements
  • Use an init function in the test code to substitute a nil writer to the logger
  • Substitute stdout in the Convey scope that executes the code with logging
  • run the tests and observe the output

Yuck.

Now, there's a better way. It still means putting in some logging, which may or may not be temporary. But, all you have to do now is something like this:

FocusConvey("Subject: Integer incrementation and decrementation", t, func() {
	var x int
FocusConvey("Given a starting integer value", func() {
	x = 42

	FocusConvey("When incremented", func() {
		x++

		Convey("The value should be greater by one", func() {
			So(x, ShouldEqual, 43)
		})
		FocusConvey("The value should NOT be what it used to be", func() {
			So(x, ShouldNotEqual, 42)
		})
	})
	Convey("When decremented", func() {
		x--

		Convey("The value should be lesser by one", func() {
			So(x, ShouldEqual, 41)
		})
		Convey("The value should NOT be what it used to be", func() {
			So(x, ShouldNotEqual, 42)
		})
	})
	Reset(func() {
		x = 0
	})
})

})

In this code, only those scopes declared with FocusConvey will be executed, the reset will be ignored. Much easier to toggle for debugging purposes.

Of course, you shouldn't leave the test suite with a bunch of FocusConvey calls lying around. After you fix your code get rid of the Focus and just keep Convey.

Happy debugging!

Subscribe to our blog!
Learn more about RSS feeds here.
rss feed icon
Subscribe Now
Read our recent posts
Cozy-cringe couture: Ugly Sweater Day
Arrow Icon
Just as wearing an “I voted” sticker has a time and a place, so too does the ugliest sweater you own. That’s right. It’s that time magical time when otherwise sensible adults deliberately dress like their grandmother's couch had a love child with a craft store explosion. The beauty of Ugly Sweater Day lies in its delicious irony – the more you fail at fashion, the more you succeed at the holiday. It's the only day of the year when "Where did you get that hideous thing?" is a genuine compliment.
Be an address ninja
Arrow Icon
We love ninjas!Yes, we do!We love ninjas!How about you? crickets We know they’re out there. BUT TODAY IS THEIR DAY, so even though these sneaky, highly-trained martial artists aren’t going to join our cheering throngs, we’ll celebrate them on National Day of the Ninja. Why?Because we’re ninja masters (sort of). We’re really good at solving every address issue just like we believe our fellow shadow warriors would—silently running in the background, solving challenges with unparalleled speed and accuracy.
EigenRisk® adds Smarty’s location intelligence resources to its global CAT risk management platform
Arrow Icon
We're happy to announce a recent partnership with EigenRisk, an insurance technology firm. Below, you will find the announcement they published on their site:ANN ARBOR, MI, December 05, 2024—EigenRisk®, a leading provider of catastrophe risk management solutions, today announced a new agreement with Smarty, a preeminent provider of address data solutions. The agreement will make Smarty’s address location intelligence and geocoding resources available through the EigenPrism® catastrophe risk management platform.