Object Mentor Blog: Contracts and Integration Tests for Component Interfaces

Contracts and Integration Tests for Component Interfaces

Dean Wampler — Sun, 29 Jun 2008 21:54:00 -0500

I am mentoring a team that is transitioning to XP, the first team in a planned, corporate-wide transition. Recently we ran into miscommunication problems about an interface we are providing to another team.

The problems didn’t surface until a “big-bang” integration right before a major release, when it was too late to fix the problem. The feature was backed out of the release, as a result.

There are several lessons to take away from this experience and a few techniques for preventing these problems in the first place.

End-to-end automated integration tests are a well-established way of catching these problems early on. The team I’m mentoring has set up its own continuous-integration (CI) server and the team is getting pretty good at writing acceptance tests using FitNesse. However, these tests only cover the components provided by the team, not the true end-to-end user stories. So, they are imperfect as both acceptance tests and integration tests. Our longer-term goal is to automate true end-to-end acceptance and integration tests, across all components and services.

In this particular case, the other team is following a waterfall-style of development, with big design up front. Therefore, my team needed to give them an interface to design against, before we were ready to actually implement the service.

There are a couple of problems with this approach. First, the two teams should really “pair” to work out the interface and behavior across their components. As I said, we’re just starting to go Agile, but my goal is to have virtual feature teams, where members of the required component teams come together as needed to implement features. This would help prevent the miscommunication of one team defining an interface and sharing it with another team through documentation, etc. Getting people to communicate face-to-face and to write code together would minimize miscommunication.

Second, defining a service interface without the implementation is risky, because it’s very likely you will miss important details. The best way to work out the details of the interface is to test drive it in some way.

This suggests another technique I want to introduce to the team. When defining an interface for external consumption, don’t just deliver the “static” interface (source files, documentation, etc.), also deliver working Mock Objects that the other team can test against. You should develop these mocks as you test drive the interface, even if you aren’t yet working on the full implementation (for schedule or other reasons).

The mocks encapsulate and enforce the behavioral contract of the interface. Design by Contract is a very effective way of thinking about interface design and implementing automated enforcement of it. Test-driven development mostly serves the same practical function, but thinking in “contractual” terms brings clarity to tests that is often missing in many of the tests I see.

Many developers already use mocks for components that don’t exist yet and find that the mocks help them design the interfaces to those components, even while the mocks are being used to test clients of the components.

Of course, there is no guarantee that the mocks faithfully represent the actual behavior, but they will minimize surprises. Whether you have mocks or not, there is no substitute for running automated integration tests on real components as soon as possible.

"Contracts and Integration Tests for Component Interfaces" by Breguet watches

Fri, 23 Dec 2011 21:22:12 -0600

day before

"Contracts and Integration Tests for Component Interfaces" by Bilförsäkringar

Mon, 31 Oct 2011 19:19:49 -0500

Great share of this article brother.

"Contracts and Integration Tests for Component Interfaces" by wedding dresses

Tue, 18 Oct 2011 21:02:20 -0500

There are a couple of problems with this approach. But you’re right.

"Contracts and Integration Tests for Component Interfaces" by ferragamo shoes

Fri, 16 Sep 2011 03:11:12 -0500

Ferragmo belt from ferragamo outlet has top quality with best craftsmanship. Now Salvatore ferragamo sale belts online with reasonable price and free shipping.

"Contracts and Integration Tests for Component Interfaces" by Coach Factory Online

Tue, 07 Jun 2011 21:43:11 -0500

nice post?

"Contracts and Integration Tests for Component Interfaces" by okey oyunu oyna

Wed, 27 Apr 2011 13:36:57 -0500

interesting article i am glad for it

internette görüntülü olarak okey oyunu oyna, gerçek kisilerle tanis, turnuva heyecanini yasa.

"Contracts and Integration Tests for Component Interfaces" by Seobaglyak

Tue, 12 Apr 2011 00:00:49 -0500

Very interesting. I am glad I came across this…

"Contracts and Integration Tests for Component Interfaces" by iPad Video Converter for Mac

Wed, 09 Mar 2011 19:38:50 -0600

very useful information for me! I’ll recommend it to my friends.

"Contracts and Integration Tests for Component Interfaces" by Criminal Records

Fri, 11 Feb 2011 12:27:46 -0600

The mocks encapsulate and enforce the behavioral contract of the interface.

"Contracts and Integration Tests for Component Interfaces" by http://www.blacktowhiteiphone4.com

Thu, 23 Dec 2010 01:35:06 -0600

Great news! White iphone 4 Conversion Kit is now avaible! With hottest White color outlook can certainly catch your eyes and heart!

"Contracts and Integration Tests for Component Interfaces" by oxpdffr

Thu, 04 Nov 2010 01:52:14 -0500

image en PDF convertisseur offre aux utilisateurs une solution facile pour convertir efficacement des images en fichiers PDF. Il passe par imprimante virtuelle installé dans votre ordinateur pour convertir des formats images( par exemple, JPG, JPEG, BMP,TIFF, etc) en PDF. Il y a plusieurs de méthodes de conversion que vous pouvez choisir préférée. Attention : Nous ne pouvons pas directement glisser/déplacer une image dans notre imprimante.

"Contracts and Integration Tests for Component Interfaces" by authentic nikes

Wed, 03 Nov 2010 03:55:06 -0500

Thanks for posting some great ideas and I’ll try to return back

with a completely different browser to check things out

"Contracts and Integration Tests for Component Interfaces" by Tenant Screening

Tue, 26 Oct 2010 15:03:55 -0500

Nice article to read. Keep posting good and useful information.

"Contracts and Integration Tests for Component Interfaces" by Convert youtube to mp3

Sun, 25 Jul 2010 21:21:11 -0500

Very interesting. I am glad I came across this.