- •Contents
- •Preface
- •Acknowledgments
- •About the author
- •About the cover illustration
- •Higher product quality
- •Less rework
- •Better work alignment
- •Remember
- •Deriving scope from goals
- •Specifying collaboratively
- •Illustrating using examples
- •Validating frequently
- •Evolving a documentation system
- •A practical example
- •Business goal
- •An example of a good business goal
- •Scope
- •User stories for a basic loyalty system
- •Key Examples
- •Key examples: Free delivery
- •Free delivery
- •Examples
- •Living documentation
- •Remember
- •Tests can be good documentation
- •Remember
- •How to begin changing the process
- •Focus on improving quality
- •Start with functional test automation
- •When: Testers own test automation
- •Use test-driven development as a stepping stone
- •When: Developers have a good understanding of TDD
- •How to begin changing the team culture
- •Avoid “agile” terminology
- •When: Working in an environment that’s resistant to change
- •Ensure you have management support
- •Don’t make test automation the end goal
- •Don’t focus on a tool
- •Keep one person on legacy scripts during migration
- •When: Introducing functional automation to legacy systems
- •Track who is running—and not running—automated checks
- •When: Developers are reluctant to participate
- •Global talent management team at ultimate software
- •Sky Network services
- •Dealing with sign-off and traceability
- •Get sign-off on exported living documentation
- •When: Signing off iteration by iteration
- •When: Signing off longer milestones
- •Get sign-off on “slimmed down use cases”
- •When: Regulatory sign-off requires details
- •Introduce use case realizations
- •When: All details are required for sign-off
- •Warning signs
- •Watch out for tests that change frequently
- •Watch out for boomerangs
- •Watch out for organizational misalignment
- •Watch out for just-in-case code
- •Watch out for shotgun surgery
- •Remember
- •Building the right scope
- •Understand the “why” and “who”
- •Understand where the value is coming from
- •Understand what outputs the business users expect
- •Have developers provide the “I want” part of user stories
- •When: Business users trust the development team
- •Collaborating on scope without high-level control
- •Ask how something would be useful
- •Ask for an alternative solution
- •Make sure teams deliver complete features
- •When: Large multisite projects
- •Further information
- •Remember
- •Why do we need to collaborate on specifications?
- •The most popular collaborative models
- •Try big, all-team workshops
- •Try smaller workshops (“Three Amigos”)
- •Pair-writing
- •When: Mature products
- •Have developers frequently review tests before an iteration
- •When: Analysts writing tests
- •Try informal conversations
- •When: Business stakeholders are readily available
- •Preparing for collaboration
- •Hold introductory meetings
- •When: Project has many stakeholders
- •Involve stakeholders
- •Undertake detailed preparation and review up front
- •When: Remote Stakeholders
- •Prepare only initial examples
- •Don’t hinder discussion by overpreparing
- •Choosing a collaboration model
- •Remember
- •Illustrating using examples: an example
- •Examples should be precise
- •Don’t have yes/no answers in your examples
- •Avoid using abstract classes of equivalence
- •Ask for an alternative way to check the functionality
- •When: Complex/legacy infrastructures
- •Examples should be realistic
- •Avoid making up your own data
- •When: Data-driven projects
- •Get basic examples directly from customers
- •When: Working with enterprise customers
- •Examples should be easy to understand
- •Avoid the temptation to explore every combinatorial possibility
- •Look for implied concepts
- •Illustrating nonfunctional requirements
- •Get precise performance requirements
- •When: Performance is a key feature
- •Try the QUPER model
- •When: Sliding scale requirements
- •Use a checklist for discussions
- •When: Cross-cutting concerns
- •Build a reference example
- •When: Requirements are impossible to quantify
- •Remember
- •Free delivery
- •Examples should be precise and testable
- •When: Working on a legacy system
- •Don’t get trapped in user interface details
- •When: Web projects
- •Use a descriptive title and explain the goal using a short paragraph
- •Show and keep quiet
- •Don’t overspecify examples
- •Start with basic examples; then expand through exploring
- •When: Describing rules with many parameter combinations
- •In order to: Make the test easier to understand
- •When: Dealing with complex dependencies/referential integrity
- •Apply defaults in the automation layer
- •Don’t always rely on defaults
- •When: Working with objects with many attributes
- •Remember
- •Is automation required at all?
- •Starting with automation
- •When: Working on a legacy system
- •Plan for automation upfront
- •Don’t postpone or delegate automation
- •Avoid automating existing manual test scripts
- •Gain trust with user interface tests
- •Don’t treat automation code as second-grade code
- •Describe validation processes in the automation layer
- •Don’t replicate business logic in the test automation layer
- •Automate along system boundaries
- •When: Complex integrations
- •Don’t check business logic through the user interface
- •Automate below the skin of the application
- •Automating user interfaces
- •Specify user interface functionality at a higher level of abstraction
- •When: User interface contains complex logic
- •Avoid recorded UI tests
- •Set up context in a database
- •Test data management
- •Avoid using prepopulated data
- •When: Specifying logic that’s not data driven
- •Try using prepopulated reference data
- •When: Data-driven systems
- •Pull prototypes from the database
- •When: Legacy data-driven systems
- •Remember
- •Reducing unreliability
- •When: Working on a system with bad automated test support
- •Identify unstable tests using CI test history
- •Set up a dedicated continuous validation environment
- •Employ fully automated deployment
- •Create simpler test doubles for external systems
- •When: Working with external reference data sources
- •Selectively isolate external systems
- •When: External systems participate in work
- •Try multistage validation
- •When: Large/multisite groups
- •Execute tests in transactions
- •Run quick checks for reference data
- •When: Data-driven systems
- •Wait for events, not for elapsed time
- •Make asynchronous processing optional
- •Getting feedback faster
- •Introduce business time
- •When: Working with temporal constraints
- •Break long test packs into smaller modules
- •Avoid using in-memory databases for testing
- •When: Data-driven systems
- •Separate quick and slow tests
- •When: A small number of tests take most of the time to execute
- •Keep overnight packs stable
- •When: Slow tests run only overnight
- •Create a current iteration pack
- •Parallelize test runs
- •When: You can get more than one test Environment
- •Try disabling less risky tests
- •When: Test feedback is very slow
- •Managing failing tests
- •Create a known regression failures pack
- •Automatically check which tests are turned off
- •When: Failing tests are disabled, not moved to a separate pack
- •Remember
- •Living documentation should be easy to understand
- •Look for higher-level concepts
- •Avoid using technical automation concepts in tests
- •When: Stakeholders aren’t technical
- •Living documentation should be consistent
- •When: Web projects
- •Document your building blocks
- •Living documentation should be organized for easy access
- •Organize current work by stories
- •Reorganize stories by functional areas
- •Organize along UI navigation routes
- •When: Documenting user interfaces
- •Organize along business processes
- •When: End-to-end use case traceability required
- •Listen to your living documentation
- •Remember
- •Starting to change the process
- •Optimizing the process
- •The current process
- •The result
- •Key lessons
- •Changing the process
- •The current process
- •Key lessons
- •Changing the process
- •Optimizing the process
- •Living documentation as competitive advantage
- •Key lessons
- •Changing the process
- •Improving collaboration
- •The result
- •Key lessons
- •Changing the process
- •Living documentation
- •Current process
- •Key lessons
- •Changing the process
- •Current process
- •Key lessons
- •Collaboration requires preparation
- •There are many different ways to collaborate
- •Looking at the end goal as business process documentation is a useful model
- •Long-term value comes from living documentation
- •Index
150 Speciication by Example
visible user interface automation to gain trust (as described earlier in this chapter), going below the user interface is often a much better solution to verifying business logic whenever possible.
Automate below the skin of the application
When: Checking session and worklow constraints
Worklow and session rules can often be checked only against the user interface layer. But that doesn’t mean that the only option to automate those checks is to launch a browser. Instead of automating the speciications through a browser, several teams developing web applications saved a lot of time and effort going right below the skin of the application—to the HTTP layer. Tim Andersen explains this approach:
We’d send a hash-map that looks a lot like the HTTP request. We have default values that would be rewritten with what’s important for the test, and we were testing by basically going right where our HTTP requests were going. That’s how our personas [ixtures] worked, by making HTTP requests with an object. That’s how they used real state and used real objects.
Not running a browser allows automated checks to execute in parallel and run much faster. Christian Hassa used a similar approach but went one level lower, to the web controllers inside the application. This avoided the HTTP calls as well
and made the feedback even faster. He explains this approach:
We bound parts [of a speciication] directly to the UI with Selenium but other parts directly to a MVC controller. It was a signiicant overhead to bind directly to the UI, and I don’t think that this is the primary value of this technique. If I could choose binding all speciications to the controller or a limited set of speciications to the UI, I would always choose executing all the speciications to the controller. Binding to the UI is optional to me; not binding all speciications that are relevant to the system is not an option. And binding to the UI costs signiicantly more.
Automating |
just |
below |
the |
skin of the application is a good |
way to |
reuse re |
|
business lows |
and avoid |
duplication |
in the automation layer. |
Executing |
the |
||
checks directly using HTTP calls—not through a browser—speeds up validation |
|||||||
signiicantly |
and |
makes |
it |
possible to |
run checks in parallel. |
|
|
Browser automation libraries are often slow and lock user proiles, so only one such check can run at any given time on a single machine. There are many tools and libraries for
Chapter 9 Automating validation without changing speciications 151
direct HTTP automation, such as WebRat,2 Twill,3 and the Selenium 2.0 HtmlUnit driv- er.4 Many modern MVC frameworks allow automation below the HTTP layer, making such checks even more eficient. These tools allow us to execute tests in parallel, faster, and more reliably because they have fewer moving parts than browser automation.
Choosing what to automate
In |
Bridging the Communication Gap, |
I |
advised |
|
automating |
all |
the |
speciications. |
|
|
|||||||||||||||||||||||||
After |
talking |
to |
|
many |
diferent |
teams |
while |
|
preparing |
this |
book, |
I |
now |
know |
th |
||||||||||||||||||||
there |
are |
situations |
where |
automation would |
|
not |
pay |
of. |
Gaspar |
Nagy |
gave |
me |
tw |
||||||||||||||||||||||
good |
examples: |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||||
|
|
‘‘ |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||
|
|
|
|
If |
the |
automation |
cost |
would be |
|
too |
high |
compared |
to |
|
the |
beneit |
|
||||||||||||||||||
|
|
of |
that |
acceptance |
|
criteria—for |
example, |
|
displaying |
in |
a |
sortable |
grid. |
|
|
||||||||||||||||||||
|
|
The |
user interface |
control |
[widget] |
will |
support |
|
sorting |
out |
of |
|
the |
box. To |
|
||||||||||||||||||||
|
|
check whether the data is |
really |
sorted you |
need |
lots |
of |
|
test |
data |
edge |
|
|||||||||||||||||||||||
|
|
cases. |
This |
|
is |
best |
left |
to |
|
a |
quick |
manual |
|
check. |
|
|
|
|
|
|
|
|
|
|
|
||||||||||
|
|
Our |
application |
|
required |
oline |
functionality |
as well. Very special oline |
|
|
|||||||||||||||||||||||||
|
|
edge cases might be hard |
|
to |
automate, |
and |
testing |
manually |
|
is |
probably |
|
|||||||||||||||||||||||
|
|
good |
enough. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||||
In |
both |
these |
cases, |
a |
|
quick |
manual |
check |
|
can |
give |
the |
team |
a |
level |
of |
conid |
||||||||||||||||||
in the system that’’was |
acceptable |
to |
their |
|
customers. |
Automation |
would |
|
cost |
much |
|||||||||||||||||||||||||
more than the time it would save long term. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|||||||||||||||||||
Checking |
layout |
|
examples |
is, |
in |
|
most |
cases, |
|
a |
bad |
|
choice |
to |
automate. |
|
Automating |
||||||||||||||||||
them |
is |
technically |
possible, |
but |
|
for |
many |
teams |
|
the |
beneits |
of |
that |
wouldn’t justif |
|||||||||||||||||||||
the |
|
costs. |
Automating |
reference |
|
usability |
examples |
|
(such |
as |
the |
|
ones |
suggested |
|
||||||||||||||||||||
in the “Build a reference example” section |
|
in |
chapter 7) is practically impossible |
||||||||||||||||||||||||||||||||
Usability and fun require a human eye and |
|
a |
subjective measurement. Other good |
||||||||||||||||||||||||||||||||
examples |
of |
checks |
|
that |
are |
probably |
not |
worth |
|
automating |
are |
intuitiveness |
or |
as |
|||||||||||||||||||||
serting how good something looks |
or |
how |
easy |
|
it |
|
is |
to |
use. |
This |
|
doesn’t |
mean |
||||||||||||||||||||||
such examples aren’t useful to discuss, illustrate |
with examples, or store in a spe |
||||||||||||||||||||||||||||||||||
ication |
system; |
|
quite |
the |
contrary. |
Discussing |
examples |
will |
ensure |
|
that |
|
everyone |
|
|||||||||||||||||||||
has the same understanding, but we can check |
the result more eiciently by hand |
||||||||||||||||||||||||||||||||||
Automating |
as |
much |
as |
we |
can |
around |
those |
functions can help us focus manu |
|||||||||||||||||||||||||||
checks only on the very |
few |
aspects |
where |
initial |
|
automation |
or |
long-term |
mainte |
||||||||||||||||||||||||||
nance would |
be |
costly. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2http://wiki.github.com/brynary/webrat
3http://twill.idyll.org
4http://seleniumhq.org/docs/09_webdriver.html#htmlunit-driver