forked from wgnet/grail
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
680 lines (558 loc) · 36.3 KB
/
index.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
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.12: http://docutils.sourceforge.net/" />
<title>Grail</title>
<style type="text/css">
/*
:Author: David Goodger ([email protected])
:Id: $Id: html4css1.css 7614 2013-02-21 15:55:51Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
overflow: hidden;
}
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin: 0 0 0.5em 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left, .figure.align-left, object.align-left {
clear: left ;
float: left ;
margin-right: 1em }
img.align-right, .figure.align-right, object.align-right {
clear: right ;
float: right ;
margin-left: 1em }
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left }
.align-center {
clear: both ;
text-align: center }
.align-right {
text-align: right }
/* reset inner alignment in figures */
div.align-right {
text-align: inherit }
/* div.align-center * { */
/* text-align: left } */
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font: inherit }
pre.literal-block, pre.doctest-block, pre.math, pre.code {
margin-left: 2em ;
margin-right: 2em }
pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
table.docutils {
margin-top: 0.5em ;
margin-bottom: 0.5em }
table.footnote {
border-left: solid 1px black;
margin-left: 1px }
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
border: 0px;
border-top: 2px solid;
border-bottom: 2px solid;
border-collapse: collapse;
}
table.docutils.booktabs * {
border: 0px;
}
table.docutils.booktabs th {
border-bottom: thin solid;
text-align: left;
}
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
ul.auto-toc {
list-style-type: none }
</style>
</head>
<body>
<div class="document" id="grail">
<h1 class="title">Grail</h1>
<div class="section" id="about">
<h1>About</h1>
<p>Grail is a library which allows test script creation based on steps.</p>
<p>Library usage brings the following benefits to your tests:</p>
<ul class="simple">
<li>strict separation test logic from test implementation</li>
<li>you don't need separate test cases as a documentation for your tests, it will be generated from the code</li>
<li>separate logging is not required, test execution is automatically logged</li>
<li>test script creation is easy for people with basic programming skills</li>
<li>step implementation can be done separately</li>
</ul>
</div>
<div class="section" id="basic-usage">
<h1>Basic Usage</h1>
<div class="line-block">
<div class="line"><tt class="docutils literal">@step</tt> is a basic concept of Grail library. It's decorator which transforms method or function to step.</div>
<div class="line">If you want to use steps your test classes should inherit <tt class="docutils literal">BaseTest</tt>.</div>
<div class="line">When you are doing your tests based on Grail all your test logic should be covered with steps.</div>
</div>
<p>The simple test demonstrating basic usage:</p>
<pre class="code python literal-block">
<span class="keyword namespace">from</span> <span class="name namespace">grail</span> <span class="keyword namespace">import</span> <span class="name">BaseTest</span><span class="punctuation">,</span> <span class="name">step</span>
<span class="keyword">class</span> <span class="name class">MyFirstGrailTest</span><span class="punctuation">(</span><span class="name">BaseTest</span><span class="punctuation">):</span>
<span class="keyword">def</span> <span class="name function">test_some_feature</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">):</span>
<span class="name builtin pseudo">self</span><span class="operator">.</span><span class="name">login_to_application</span><span class="punctuation">()</span>
<span class="name decorator">@step</span>
<span class="keyword">def</span> <span class="name function">login_to_application</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">):</span>
<span class="keyword">pass</span>
</pre>
<p>Such test output will be:</p>
<p><tt class="docutils literal">PASSED login to application</tt></p>
</div>
<div class="section" id="logging-parameters-and-output">
<h1>Logging parameters and output</h1>
<p>When step method takes some params or return value: all the information will be logged.</p>
<p>Example:</p>
<pre class="code python literal-block">
<span class="keyword namespace">from</span> <span class="name namespace">grail</span> <span class="keyword namespace">import</span> <span class="name">BaseTest</span><span class="punctuation">,</span> <span class="name">step</span>
<span class="keyword namespace">from</span> <span class="name namespace">nose.tools</span> <span class="keyword namespace">import</span> <span class="name">eq_</span>
<span class="keyword">class</span> <span class="name class">MyLoggingParametersAndOutputTest</span><span class="punctuation">(</span><span class="name">BaseTest</span><span class="punctuation">):</span>
<span class="keyword">def</span> <span class="name function">test_some_feature</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">):</span>
<span class="name">result</span> <span class="operator">=</span> <span class="name builtin pseudo">self</span><span class="operator">.</span><span class="name">do_some_calculation</span><span class="punctuation">(</span><span class="literal number integer">2</span><span class="punctuation">,</span> <span class="name">second_param</span><span class="operator">=</span><span class="literal number integer">3</span><span class="punctuation">)</span>
<span class="name builtin pseudo">self</span><span class="operator">.</span><span class="name">verify_result</span><span class="punctuation">(</span><span class="name">result</span><span class="punctuation">)</span>
<span class="name decorator">@step</span>
<span class="keyword">def</span> <span class="name function">do_some_calculation</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">,</span> <span class="name">first_param</span><span class="punctuation">,</span> <span class="name">second_param</span><span class="punctuation">):</span>
<span class="keyword">return</span> <span class="name">first_param</span> <span class="operator">+</span> <span class="name">second_param</span>
<span class="name decorator">@step</span>
<span class="keyword">def</span> <span class="name function">verify_result</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">,</span> <span class="name">actual_data</span><span class="punctuation">):</span>
<span class="name">eq_</span><span class="punctuation">(</span><span class="name">actual_data</span><span class="punctuation">,</span> <span class="literal number integer">5</span><span class="punctuation">)</span>
</pre>
<p>Output will contain all execution details:</p>
<div class="line-block">
<div class="line"><tt class="docutils literal">PASSED do some calculation (2, second_param=3) <span class="pre">-></span> 5</tt></div>
<div class="line"><tt class="docutils literal">PASSED verify result (5)</tt></div>
</div>
</div>
<div class="section" id="step-options">
<h1>@step options</h1>
<div class="section" id="description">
<h2>description</h2>
<p>By default step name is method name split by underscores. In the majority of cases it's enough if you are writing readable code.
But there are situations where step description is not so easy to put into method name.
For such cases there is a <tt class="docutils literal">description</tt> parameter.</p>
<pre class="code python literal-block">
<span class="keyword namespace">from</span> <span class="name namespace">grail</span> <span class="keyword namespace">import</span> <span class="name">BaseTest</span><span class="punctuation">,</span> <span class="name">step</span>
<span class="keyword">class</span> <span class="name class">MyTestWithDescription</span><span class="punctuation">(</span><span class="name">BaseTest</span><span class="punctuation">):</span>
<span class="keyword">def</span> <span class="name function">test_some_feature</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">):</span>
<span class="name builtin pseudo">self</span><span class="operator">.</span><span class="name">login_to_application</span><span class="punctuation">()</span>
<span class="name builtin pseudo">self</span><span class="operator">.</span><span class="name">complex_step</span><span class="punctuation">()</span>
<span class="name decorator">@step</span>
<span class="keyword">def</span> <span class="name function">login_to_application</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">):</span>
<span class="keyword">pass</span>
<span class="name decorator">@step</span><span class="punctuation">(</span><span class="name">description</span><span class="operator">=</span><span class="literal string">'Some tricky actions with the application which I can</span><span class="literal string escape">\'</span><span class="literal string">t put to method name'</span><span class="punctuation">)</span>
<span class="keyword">def</span> <span class="name function">complex_step</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">):</span>
<span class="keyword">pass</span>
</pre>
<p>Such test script will generate the following:</p>
<div class="line-block">
<div class="line"><tt class="docutils literal">PASSED login to application</tt></div>
<div class="line"><tt class="docutils literal">PASSED Some tricky actions with the application which I can't put to method name</tt></div>
</div>
</div>
<div class="section" id="pending">
<h2>pending</h2>
<p>If step method is created but not implemented you can specify <tt class="docutils literal">pending</tt> property. It will fail corresponding test execution but
at the same time you can have full test case description (e.g. for manual execution).</p>
<p>Example:</p>
<pre class="code python literal-block">
<span class="keyword namespace">from</span> <span class="name namespace">grail</span> <span class="keyword namespace">import</span> <span class="name">BaseTest</span><span class="punctuation">,</span> <span class="name">step</span>
<span class="keyword">class</span> <span class="name class">MyNotFinishedTest</span><span class="punctuation">(</span><span class="name">BaseTest</span><span class="punctuation">):</span>
<span class="keyword">def</span> <span class="name function">test_some_feature</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">):</span>
<span class="name builtin pseudo">self</span><span class="operator">.</span><span class="name">first_implemented_step</span><span class="punctuation">()</span>
<span class="name builtin pseudo">self</span><span class="operator">.</span><span class="name">second_pending_step</span><span class="punctuation">()</span>
<span class="name builtin pseudo">self</span><span class="operator">.</span><span class="name">some_third_step</span><span class="punctuation">()</span>
<span class="name decorator">@step</span>
<span class="keyword">def</span> <span class="name function">first_implemented_step</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">):</span>
<span class="keyword">print</span> <span class="literal string">'Some implemented actions'</span>
<span class="name decorator">@step</span><span class="punctuation">(</span><span class="name">pending</span><span class="operator">=</span><span class="name builtin pseudo">True</span><span class="punctuation">)</span>
<span class="keyword">def</span> <span class="name function">second_pending_step</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">):</span>
<span class="keyword">print</span> <span class="literal string">'This is not final implementation'</span>
<span class="name decorator">@step</span>
<span class="keyword">def</span> <span class="name function">some_third_step</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">):</span>
<span class="keyword">print</span> <span class="literal string">'This step is implemented but will be Ignored and you will not see this message'</span>
</pre>
<p>Test execution output:</p>
<div class="line-block">
<div class="line"><tt class="docutils literal">PASSED first implemented step</tt></div>
<div class="line-block">
<div class="line"><tt class="docutils literal">Some implemented actions</tt></div>
</div>
<div class="line"><tt class="docutils literal">PENDING second pending step</tt></div>
<div class="line"><tt class="docutils literal">IGNORED some third step</tt></div>
<div class="line"><br /></div>
<div class="line"><tt class="docutils literal">Error</tt></div>
<div class="line"><tt class="docutils literal">Traceback (most recent call last):</tt></div>
<div class="line-block">
<div class="line"><tt class="docutils literal">File "/home/i_khrol/PyCharm/grail/grail/base_test.py", line 30, in wrapper</tt></div>
<div class="line-block">
<div class="line"><tt class="docutils literal">raise <span class="pre">Exception('Test</span> is failed as there are pending steps')</tt></div>
</div>
</div>
<div class="line"><tt class="docutils literal">Exception: Test is failed as there are pending steps</tt></div>
</div>
</div>
<div class="section" id="step-group">
<h2>step_group</h2>
<div class="line-block">
<div class="line">If you want to call one step from another you should use <tt class="docutils literal">step_group</tt>. It's special step which is a set of other steps.</div>
<div class="line"><em>Important</em>: Like test itself step group should be based only on steps.</div>
</div>
<p>Example below also shows that there is no limitation where you should store your steps.
It could be any class method, function. You can also call the same step multiple times.</p>
<pre class="code python literal-block">
<span class="keyword namespace">from</span> <span class="name namespace">grail</span> <span class="keyword namespace">import</span> <span class="name">BaseTest</span><span class="punctuation">,</span> <span class="name">step</span>
<span class="keyword">class</span> <span class="name class">SomeClassWithSteps</span><span class="punctuation">(</span><span class="name builtin">object</span><span class="punctuation">):</span>
<span class="name decorator">@step</span>
<span class="keyword">def</span> <span class="name function">step_from_another_class</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">):</span>
<span class="keyword">pass</span>
<span class="name decorator">@step</span>
<span class="keyword">def</span> <span class="name function">some_simple_action_one</span><span class="punctuation">():</span>
<span class="keyword">pass</span>
<span class="keyword">class</span> <span class="name class">MyTestWithGroup</span><span class="punctuation">(</span><span class="name">BaseTest</span><span class="punctuation">):</span>
<span class="name">external_steps</span> <span class="operator">=</span> <span class="name">SomeClassWithSteps</span><span class="punctuation">()</span>
<span class="keyword">def</span> <span class="name function">test_some_feature</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">):</span>
<span class="name builtin pseudo">self</span><span class="operator">.</span><span class="name">complex_step_based_on_other_steps</span><span class="punctuation">()</span>
<span class="name decorator">@step</span><span class="punctuation">(</span><span class="name">step_group</span><span class="operator">=</span><span class="name builtin pseudo">True</span><span class="punctuation">)</span>
<span class="keyword">def</span> <span class="name function">complex_step_based_on_other_steps</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">):</span>
<span class="name builtin pseudo">self</span><span class="operator">.</span><span class="name">external_steps</span><span class="operator">.</span><span class="name">step_from_another_class</span><span class="punctuation">()</span>
<span class="name">some_simple_action_one</span><span class="punctuation">()</span>
<span class="name builtin pseudo">self</span><span class="operator">.</span><span class="name">external_steps</span><span class="operator">.</span><span class="name">step_from_another_class</span><span class="punctuation">()</span>
</pre>
<p>The output:</p>
<div class="line-block">
<div class="line"><tt class="docutils literal">PASSED complex step based on other steps</tt></div>
<div class="line-block">
<div class="line"><tt class="docutils literal">PASSED step from another class</tt></div>
<div class="line"><tt class="docutils literal">PASSED some simple action one</tt></div>
<div class="line"><tt class="docutils literal">PASSED step from another class</tt></div>
</div>
</div>
</div>
<div class="section" id="format-description">
<h2>format_description</h2>
<p>There are cases when you want to format your step description special way:</p>
<ul class="simple">
<li>skip some parameters in logging</li>
<li>put some values in the middle of the message</li>
</ul>
<p>If you want to do this you should set <tt class="docutils literal">format_description=True</tt>.
In this case <tt class="docutils literal"><span class="pre">description.format(*args,</span> **kwargs)</tt> will be used as step description.</p>
<pre class="code python literal-block">
<span class="keyword namespace">from</span> <span class="name namespace">grail</span> <span class="keyword namespace">import</span> <span class="name">BaseTest</span><span class="punctuation">,</span> <span class="name">step</span>
<span class="keyword">class</span> <span class="name class">MyVeryFormattedTest</span><span class="punctuation">(</span><span class="name">BaseTest</span><span class="punctuation">):</span>
<span class="keyword">def</span> <span class="name function">test_some_feature</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">):</span>
<span class="name builtin pseudo">self</span><span class="operator">.</span><span class="name">some_tricky_formatting</span><span class="punctuation">(</span><span class="literal string">'value'</span><span class="punctuation">,</span> <span class="name">kwarg_to_format</span><span class="operator">=</span><span class="literal string">'kw_value'</span><span class="punctuation">,</span> <span class="name">skip_this</span><span class="operator">=</span><span class="literal number integer">100500</span><span class="punctuation">)</span>
<span class="name decorator">@step</span><span class="punctuation">(</span><span class="name">description</span><span class="operator">=</span><span class="literal string">'Some info: {0}, another info: {kwarg_to_format}'</span><span class="punctuation">,</span> <span class="name">format_description</span><span class="operator">=</span><span class="name builtin pseudo">True</span><span class="punctuation">)</span>
<span class="keyword">def</span> <span class="name function">some_tricky_formatting</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">,</span> <span class="name">arg_to_format</span><span class="punctuation">,</span> <span class="name">kwarg_to_format</span><span class="punctuation">,</span> <span class="name">skip_this</span><span class="punctuation">):</span>
<span class="keyword">print</span> <span class="name">arg_to_format</span>
<span class="keyword">print</span> <span class="name">kwarg_to_format</span>
<span class="keyword">print</span> <span class="name">skip_this</span>
</pre>
<p>Output will be like this:</p>
<div class="line-block">
<div class="line"><tt class="docutils literal">PASSED Some info: value, another info: kw_value</tt></div>
<div class="line-block">
<div class="line"><tt class="docutils literal">value</tt></div>
<div class="line"><tt class="docutils literal">kw_value</tt></div>
<div class="line"><tt class="docutils literal">100500</tt></div>
</div>
</div>
</div>
<div class="section" id="treat-nested-steps-as-methods">
<h2>treat_nested_steps_as_methods</h2>
<p>It's forbidden to call steps from each other if it's not step group.
But if you <em>really</em> need it you can tell caller to ignore <tt class="docutils literal">@step</tt> functionality within itself.</p>
<pre class="code python literal-block">
<span class="keyword namespace">from</span> <span class="name namespace">grail</span> <span class="keyword namespace">import</span> <span class="name">BaseTest</span><span class="punctuation">,</span> <span class="name">step</span>
<span class="keyword">class</span> <span class="name class">DoItInVerySpecialCases</span><span class="punctuation">(</span><span class="name">BaseTest</span><span class="punctuation">):</span>
<span class="keyword">def</span> <span class="name function">test_its_not_recommended_to_do_this</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">):</span>
<span class="name builtin pseudo">self</span><span class="operator">.</span><span class="name">external_step</span><span class="punctuation">()</span>
<span class="name decorator">@step</span><span class="punctuation">(</span><span class="name">treat_nested_steps_as_methods</span><span class="operator">=</span><span class="name builtin pseudo">True</span><span class="punctuation">)</span>
<span class="keyword">def</span> <span class="name function">external_step</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">):</span>
<span class="name builtin pseudo">self</span><span class="operator">.</span><span class="name">this_is_not_a_step_anymore</span><span class="punctuation">()</span>
<span class="name decorator">@step</span>
<span class="keyword">def</span> <span class="name function">this_is_not_a_step_anymore</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">):</span>
<span class="keyword">pass</span>
</pre>
<p>Output will not contain description for the internal step:</p>
<div class="line-block">
<div class="line"><tt class="docutils literal">PASSED external step</tt></div>
</div>
</div>
<div class="section" id="log-output">
<h2>log_output</h2>
<p>There are cases when method output is too huge or it not interested in logging at all. You can switch off output logging for step.</p>
<pre class="code python literal-block">
<span class="keyword namespace">from</span> <span class="name namespace">grail</span> <span class="keyword namespace">import</span> <span class="name">BaseTest</span><span class="punctuation">,</span> <span class="name">step</span>
<span class="keyword">class</span> <span class="name class">MyDisableLogOutputTest</span><span class="punctuation">(</span><span class="name">BaseTest</span><span class="punctuation">):</span>
<span class="keyword">def</span> <span class="name function">test_some_feature</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">):</span>
<span class="name builtin pseudo">self</span><span class="operator">.</span><span class="name">log_output</span><span class="punctuation">()</span>
<span class="name builtin pseudo">self</span><span class="operator">.</span><span class="name">do_not_log_output</span><span class="punctuation">()</span>
<span class="name decorator">@step</span>
<span class="keyword">def</span> <span class="name function">log_output</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">):</span>
<span class="keyword">return</span> <span class="literal string">'Important output'</span>
<span class="name decorator">@step</span><span class="punctuation">(</span><span class="name">log_output</span><span class="operator">=</span><span class="name builtin pseudo">False</span><span class="punctuation">)</span>
<span class="keyword">def</span> <span class="name function">do_not_log_output</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">):</span>
<span class="keyword">return</span> <span class="literal string">'Some invisible in logs data'</span>
</pre>
<p>Output:</p>
<div class="line-block">
<div class="line"><tt class="docutils literal">PASSED log output <span class="pre">-></span> Important output</tt></div>
<div class="line"><tt class="docutils literal">PASSED do not log output</tt></div>
</div>
</div>
</div>
<div class="section" id="export-mode">
<h1>Export Mode</h1>
<p>Regular test automation process assumes some manual test cases that should be automated.
With Grail you can do vise versa - write code and get manual test cases.
In order to generate test description from the code you should set <tt class="docutils literal">grail.settings.export_mode=True</tt>.
With this setting tests will be executed but steps' internal will not be called.
So you can have your test description when your scripts are not implemented yet or
automated test execution is blocked due to any other reasons.</p>
<div class="section" id="important-things-to-keep-in-mind">
<h2>Important things to keep in mind</h2>
<p>In <tt class="docutils literal">export_mode</tt> only <tt class="docutils literal">setUp</tt> and tests are executed. All the fixtures are skipped.
It's important to have your <tt class="docutils literal">setUp</tt> and tests be implemented fully with <tt class="docutils literal">@step</tt>-annotated methods and functions.
For other fixtures it's up-to-you to use steps or not.</p>
<p>All <tt class="docutils literal">@step</tt> features are enabled during export.</p>
<p>Empty params are not included to step description in <tt class="docutils literal">export_mode</tt>.</p>
</div>
<div class="section" id="example">
<h2>Example</h2>
<p>This test output could be used as manual test case. E.g. you can store it in your favorite test management system.</p>
<pre class="code python literal-block">
<span class="keyword namespace">from</span> <span class="name namespace">grail</span> <span class="keyword namespace">import</span> <span class="name">BaseTest</span><span class="punctuation">,</span> <span class="name">step</span>
<span class="keyword namespace">import</span> <span class="name namespace">grail.settings</span>
<span class="name">grail</span><span class="operator">.</span><span class="name">settings</span><span class="operator">.</span><span class="name">export_mode</span> <span class="operator">=</span> <span class="name builtin pseudo">True</span>
<span class="keyword">class</span> <span class="name class">MyTestForExport</span><span class="punctuation">(</span><span class="name">BaseTest</span><span class="punctuation">):</span>
<span class="keyword">def</span> <span class="name function">test_some_feature</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">):</span>
<span class="name builtin pseudo">self</span><span class="operator">.</span><span class="name">login_to_application</span><span class="punctuation">()</span>
<span class="name builtin pseudo">self</span><span class="operator">.</span><span class="name">one_more_step</span><span class="punctuation">(</span><span class="literal string">'Step input 1'</span><span class="punctuation">)</span>
<span class="name builtin pseudo">self</span><span class="operator">.</span><span class="name">pending_step</span><span class="punctuation">()</span>
<span class="name builtin pseudo">self</span><span class="operator">.</span><span class="name">step_group</span><span class="punctuation">()</span>
<span class="name decorator">@step</span>
<span class="keyword">def</span> <span class="name function">login_to_application</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">):</span>
<span class="keyword">pass</span>
<span class="name decorator">@step</span>
<span class="keyword">def</span> <span class="name function">one_more_step</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">,</span> <span class="name">step_input</span><span class="punctuation">):</span>
<span class="keyword">print</span> <span class="literal string">'You will not see next line print'</span>
<span class="keyword">print</span> <span class="name">step_input</span>
<span class="name decorator">@step</span><span class="punctuation">(</span><span class="name">description</span><span class="operator">=</span><span class="literal string">'Some step that will be implemented'</span><span class="punctuation">)</span>
<span class="keyword">def</span> <span class="name function">pending_step</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">):</span>
<span class="keyword">pass</span>
<span class="name decorator">@step</span><span class="punctuation">(</span><span class="name">step_group</span><span class="operator">=</span><span class="name builtin pseudo">True</span><span class="punctuation">)</span>
<span class="keyword">def</span> <span class="name function">step_group</span><span class="punctuation">(</span><span class="name builtin pseudo">self</span><span class="punctuation">):</span>
<span class="name builtin pseudo">self</span><span class="operator">.</span><span class="name">one_more_step</span><span class="punctuation">(</span><span class="literal string">'Step input 2'</span><span class="punctuation">)</span>
<span class="name builtin pseudo">self</span><span class="operator">.</span><span class="name">one_more_step</span><span class="punctuation">(</span><span class="name builtin pseudo">None</span><span class="punctuation">)</span>
</pre>
<p>Output which can be used as manual test case:</p>
<div class="line-block">
<div class="line"><tt class="docutils literal">login to application</tt></div>
<div class="line"><tt class="docutils literal">one more step (Step input 1)</tt></div>
<div class="line"><tt class="docutils literal">Some step that will be implemented</tt></div>
<div class="line"><tt class="docutils literal">step group</tt></div>
<div class="line-block">
<div class="line"><tt class="docutils literal">one more step (Step input 2)</tt></div>
<div class="line"><tt class="docutils literal">one more step</tt></div>
</div>
</div>
</div>
</div>
</div>
</body>
</html>