-
Notifications
You must be signed in to change notification settings - Fork 0
/
tutorialstack.html
429 lines (334 loc) · 13.6 KB
/
tutorialstack.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>easyb makes it easy, man</title>
<meta name="keywords" content="BDD, behavior driven development, java, java bdd, groovy, groovy bdd,
groovy behavior driven development, java behavior driven development, ruby, rspec, easyb, easy bdd" />
<meta name="description" content="easyb is story verification framework built in the spirit of behavior driven development." />
<link href="default.css" rel="stylesheet" type="text/css" />
</head>
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
var pageTracker = _gat._getTracker("UA-3500051-1");
pageTracker._initData();
pageTracker._trackPageview();
</script>
<body>
<!-- start header -->
<div id="header">
<h1><a href="http://www.easyb.org"><span>easyb</span></a></h1>
<h2> -- BDD in java can't get any easier</h2>
</div>
<!-- end header -->
<!-- start page -->
<div id="page">
<!-- start content -->
<div id="content">
<div class="post">
<h2 class="title">An in-depth tutorial</h2>
<div class="entry">
<p>With easyb it's quite easy to create stories (which are logically made up of scenarios) that facilitate driving development, much like TDD is supposed to do. That is, easyb (and BDD concepts) can seriously assist your test-first-development desires; however, you don't need to focus on tests-- just focus on the intended behavior! It happens to be easy too. Remember, easyb may be a Groovy framework but it is for Java-- so if you are coding normal Java applications, you can use easyb!</p>
<p>Using roughly the same (albeit prosaic, but oh so easy) <code>Stack</code> example from IBM developerWorks' <a href="http://www.ibm.com/developerworks/web/library/j-cq09187/index.html">Adventures in behavior-driven development</a>, easyb can be used to fashion a series of scenarios that describe a stack data-structure <i>before</i> you actually write it-- because easyb stories are Groovy, you don't have to worry about compilation issues either. Even better, easyb stories are single Groovy files that have scenarios in sequential order.</p>
<h3>Pushing null</h3>
<p>Thinking at a high level about a stack, one could maybe specify that:
<blockquote>given an empty stack, when <code>null</code> is <code>push</code>ed, an exception should be thrown and the stack should still be empty.</blockquote>
</p>
<p>Whether or not you actually create a place holder object first is up to you; however, for the purposes of this example, the first step is to create a <code>Stack</code> object (in Java, of course!). </p>
<pre><code>
public class Stack<E> {
public Stack() {
}
}
</code></pre>
<p>The scenario can then be written out as follows: </p>
<pre><code>
given "an empty stack",{
stack = new Stack()
}
when "null is pushed", {
pushnull = {
stack.push(null)
}
}
then "an exception should be thrown", {
ensureThrows(RuntimeException){
pushnull()
}
}
and "then the stack should still be empty", {
stack.empty.shouldBe true
}
</code></pre>
<p>Note how multiple <code>then</code>s were used; plus, see the <code>when</code> clause? A closure is created to essentially capture the intended behavior, which will be exercised in the first <code>then</code>. As you can infer, the <code>ensureThrows</code> method take two parameters-- an exception type and a closure to invoke. Logically, we expect that the call to <code>push</code> with <code>null</code> will yield a <code>RuntimeException</code>. The second <code>then</code> clause then ensures that the stack is still empty.</p>
<p>Of course, executing this story will yield some errors-- as you can see below, the <code>isEmpty</code> method isn't defined yet! What about the <code>push</code> call as well? It turns out that an exception <i>was</i> generated as a result of that invocation; however, the framework caught it (because it was looking for a <code>RuntimeException</code>, which apparently <code>groovy.lang.MissingMethodException</code> is a subclass of).</p>
<pre><code>
1) Specification the stack should still be empty:
groovy.lang.MissingMethodException: No signature of method: \
org.disco.easyb.bdd.stack.Stack.isEmpty() is applicable for \
argument types: () values: {}
at groovy.lang.MetaClassImpl.invokeMethod(MetaClassImpl.java:572)
at groovy.lang.MetaClassImpl.invokeMethod(MetaClassImpl.java:450)
</code></pre>
<p>Accordingly, the stack needs an <code>isEmpty</code> method defined. </p>
<pre><code>
public boolean isEmpty(){
return true;
}
</code></pre>
<p>The stack still needs a <code>push</code> method too.</p>
<pre><code>
public void push(E value){
throw new RuntimeException();
}
</code></pre>
<p>Running this story now works out nicely. </p>
<h3>Empty pops</h3>
<p>The stack isn't finished yet-- in fact, as coded, it only works to make a story succeed. BDD, however, is an excellent mechanism for collaboration between stakeholders and development; as such, it makes sense to delay writing the actual implementation as long as possible and instead focus on behavior. </p>
<p>Therefore, the next behavior of a stack could be:<blockquote>given an empty stack, when <code>pop</code> is called an exception should be thrown and the stack should still be empty</blockquote></p>
<p>Coding this scenario in easyb is easy too-- just add it to the existing story! It looks quite familiar, right?</p>
<pre><code>
given "an empty stack",{
stack = new Stack()
}
when "pop is called", {
popnull = {
stack.pop()
}
}
then "an exception should be thrown", {
ensureThrows(RuntimeException){
popnull()
}
}
and "then the stack should still be empty", {
stack.empty.shouldBe true
}
</code></pre>
<p>Running the story now yields another issue-- the <code>pop</code> method isn't defined.</p>
<pre><code>
public E pop(){
throw new RuntimeException();
}
</code></pre>
<p>Now things work and the story has two scenarios.</p>
<h3>Push and pop working together</h3>
<p>Moving on, another behavior relates to the logical behavior of <code>push</code> and <code>pop</code> working together:
<blockquote>given a stack with one <code>push</code>ed value, when <code>pop</code> is called that object should be returned and the stack should be empty.</blockquote></p>
<p>Things are looking easy, eh?</p>
<pre><code>
given "an empty stack with one pushed value",{
stack = new Stack()
pushVal = "foo"
stack.push(pushVal)
}
when "pop is called", {
popVal = stack.pop()
}
then "that object should be returned", {
popVal.shouldBe pushVal
}
and "then the stack should be empty", {
stack.empty.shouldBe true
}
</code></pre>
<p>In the above code, a value is <code>push</code>ed and then <code>pop</code>ped and the values are compared for equality. Things don't work, however. The <code>push</code> method is defined to throw an exception so the scenario fails. </p>
<pre><code>
....There was an error running the script
java.lang.RuntimeException
at org.disco.easyb.bdd.stack.Stack.push(Stack.java:10)
at gjdk.org.disco.bdd.story.stack.Stack_GroovyReflector.invoke(Unknown Source)
</code></pre>
<p>Time to code a real <code>pop</code> method! Oh yeah, and a <code>push</code> one as well.</p>
<pre><code>
public class Stack<E> {
private ArrayList<E> list;
public Stack() {
this.list = new ArrayList<E>();
}
public void push(E value) {
if (value == null) {
throw new RuntimeException("Can't push null");
} else {
this.list.add(value);
}
}
public boolean isEmpty() {
return true;
}
public E pop() {
if (this.list.size() > 0) {
return this.list.remove(this.list.size() - 1);
} else {
throw new RuntimeException("Nothing to pop");
}
}
}
</code></pre>
<p>Now the story is starting to work again! </p>
<pre><code>
6 behavior steps run successfully
</code></pre>
<h3>Coding isEmpty</h3>
<p>It seems the <code>isEmpty</code> method is still hardcoded, which leads to another behavior: <blockquote>given a stack with any pushed values, <code>isEmpty</code> should return <code>false</code>.</blockquote></p>
<p>This scenario is even easier to code with easyb-- in fact, you can forget the <code>when</code> clause all together (if you want).</p>
<pre><code>
given "an empty stack with one pushed value",{
stack = new Stack()
stack.push("bar")
}
then "the stack should not be empty", {
stack.empty.shouldBe false
}
</code></pre>
<p>The empty test fails of course.</p>
<pre><code>
......F
Time: 0.92s
Failures: 1.
1) Specification the stack should be empty:
VerificationException: Expected:
equal to [false]
but got:
true:
</code></pre>
<p>Coding it in Java is easy.</p>
<pre><code>
public boolean isEmpty() {
return this.list.isEmpty();
}
</code></pre>
<h3>The meat of a stack</h3>
<p>The meat of a stack is the behavior of <code>push</code> and <code>pop</code> called multiple times; accordingly <blockquote>given a stack with two values, when <code>pop</code> is called the last item <code>push<c/ode>ed should be returned.</blockquote></p>
<pre><code>
given "a stack with two values",{
stack = new Stack()
push1 = "foo"
push2 = "bar"
stack.push(push1)
stack.push(push2)
}
when "pop is called", {
popVal = stack.pop()
}
then "the last item pushed should be returned", {
popVal.shouldBe push2
}
and "then the stack should not be empty", {
stack.empty.shouldBe false
}
</code></pre>
<p>Things read nicely don't they? Don't forget, this scenario is in one file containing the entire story.</p>
<h3>Peek's behavior</h3>
<p>The <code>peek</code> method is commonly found on stacks, as such: <blockquote>given a stack containing items, when <code>peek</code> is called, it should provide the value of the most recent <code>push</code>ed value; however, that value should remain in the stack.</blockquote></p>
<pre><code>
given "a stack containing an item",{
stack = new Stack()
push1 = "foo"
stack.push(push1)
}
when "peek is called", {
peeked = stack.peek()
}
then "it should provide the value of the most recent pushed value", {
peeked.shouldEqual "foo"
}
and "then the stack should not be empty", {
stack.empty.shouldBe false
}
and "then calling pop should also return the peeked value", {
def popped = stack.pop()
popped.shouldBe(push1)
and
popped.shouldBe(peeked)
}
and "then the stack should be empty", {
stack.empty.shouldBe true
}
</code></pre>
<p>This scenario is fairly detailed and long; however, the point is valid-- you can use as many <code>then</code>s as you need.</p>
<p>Oh yeah, <code>peek</code> wasn't ever coded. </p>
<pre><code>
.........There was an error running the script
groovy.lang.MissingMethodException: No signature of method:
org.disco.easyb.bdd.stack.Stack.peek() is applicable for
argument types: () values: {}
at groovy.lang.MetaClassImpl.invokeMethod(MetaClassImpl.java:572)
</code></pre>
<p>Coding peek takes a New York second.</p>
<pre><code>
public E peek() {
if(this.list.size() > 0){
return this.list.get(this.list.size()-1);
}else{
return null;
}
}
</code></pre>
<p>Time to run the entire story!</p>
<pre><code>
13 behavior steps run successfully
</code></pre>
<p>In this tutorial, a stack was created by driving development with BDD. In essence, easyb was used to tell the story of a stack-- as things failed, the proper behavior was coded. Scenarios were written in literate form via easyb's constructs and they all aggregated up to create a story that lives as executable documentation for the object being verified.
</p>
<p>Wow, aren't things easy with easyb?</p>
<!--
<pre><code>
</code></pre>
-->
</div>
</div>
</div>
<!-- end content -->
<!-- start sidebar -->
<div id="sidebar">
<ul>
<li>
<h2>Overview</h2>
<ul>
<li><a href="./index.html">Home</a></li>
<li><a href="./howtos.html">Stories</a></li>
<li><a href="./howtobb.html">Specifications</a></li>
<li><a href="./download.html">Download</a></li>
</ul>
</li>
<li>
<h2>Details</h2>
<ul>
<li><a href="./running.html">Running easyb</a></li>
<li><a href="./tutorialstack.html">An in-depth tutorial</a></li>
<li><a href="./dsls.html">easyb syntax specification</a></li>
<li><a href="./lic.html">License</a></li>
<li><a href="./source.html">Source code</a></li>
<li><a href="./contact.html">Contact</a></li>
</ul>
</li>
<li>
<h2>Plug-ins</h2>
<ul>
<li><a href="./dbunit.html">DbUnit plug-in</a></li>
</ul>
</li>
<li>
<h2>Resources</h2>
<ul>
<li><a href="http://dannorth.net/introducing-bdd/">Introducing BDD</a> (DanNorth.net)</li>
<li><a href="http://rspec.rubyforge.org/">RSpec</a></li>
<li><a href="http://groovy.codehaus.org/">Groovy</a></li>
<li><a href="http://code.google.com/p/easyb/w/list">easyb wiki</a></li>
<li><a href="./articles.html">Additional resources</a></li>
</ul>
</li>
</ul>
<div style="clear: both;"> </div>
</div>
<!-- end sidebar -->
</div>
<!-- end page -->
<div id="footer">
</div>
</body>
</html>