bauxite 0.6.5 → 0.6.6

Sign up to get free protection for your applications and to get access to all the features.
@@ -102,8 +102,11 @@
102
102
 
103
103
  <p>This composite logger forwards logging calls to each of its children.</p>
104
104
 
105
- <p>Set the <code>:loggers</code> option to a comma-separated list of logger
106
- names</p>
105
+ <p>Composite logger options include:</p>
106
+ <dl class="rdoc-list label-list"><dt><code>loggers</code>
107
+ <dd>
108
+ <p>A comma-separated list of logger names.</p>
109
+ </dd></dl>
107
110
 
108
111
  </section>
109
112
 
@@ -130,7 +133,7 @@ names</p>
130
133
 
131
134
  <div class="method-heading">
132
135
  <span class="method-name">new</span><span
133
- class="method-args">(options)</span>
136
+ class="method-args">(options, loggers = nil)</span>
134
137
 
135
138
  <span class="method-click-advice">click to toggle source</span>
136
139
 
@@ -145,15 +148,18 @@ names</p>
145
148
 
146
149
 
147
150
  <div class="method-source-code" id="new-source">
148
- <pre><span class="ruby-comment"># File lib/bauxite/loggers/composite.rb, line 32</span>
149
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">options</span>)
150
- <span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:loggers</span>]
151
- <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">&quot;Missing required logger option &#39;loggers&#39;. &quot;</span><span class="ruby-operator">+</span>
152
- <span class="ruby-string">&quot;The value of this option is a comma-separated list of valid loggers. &quot;</span><span class="ruby-operator">+</span>
153
- <span class="ruby-string">&quot;For example loggers=xterm,file.&quot;</span>
151
+ <pre><span class="ruby-comment"># File lib/bauxite/loggers/composite.rb, line 33</span>
152
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">options</span>, <span class="ruby-identifier">loggers</span> = <span class="ruby-keyword">nil</span>)
153
+ <span class="ruby-keyword">unless</span> <span class="ruby-identifier">loggers</span>
154
+ <span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:loggers</span>]
155
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">&quot;Missing required logger option &#39;loggers&#39;. &quot;</span><span class="ruby-operator">+</span>
156
+ <span class="ruby-string">&quot;The value of this option is a comma-separated list of valid loggers. &quot;</span><span class="ruby-operator">+</span>
157
+ <span class="ruby-string">&quot;For example loggers=xterm,file.&quot;</span>
158
+ <span class="ruby-keyword">end</span>
159
+ <span class="ruby-identifier">loggers</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:loggers</span>].<span class="ruby-identifier">split</span>(<span class="ruby-string">&#39;,&#39;</span>)
154
160
  <span class="ruby-keyword">end</span>
155
161
 
156
- <span class="ruby-ivar">@loggers</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:loggers</span>].<span class="ruby-identifier">split</span>(<span class="ruby-string">&#39;,&#39;</span>).<span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">l</span><span class="ruby-operator">|</span>
162
+ <span class="ruby-ivar">@loggers</span> = <span class="ruby-identifier">loggers</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">l</span><span class="ruby-operator">|</span>
157
163
  <span class="ruby-constant">Bauxite</span><span class="ruby-operator">::</span><span class="ruby-constant">Context</span><span class="ruby-operator">::</span><span class="ruby-identifier">load_logger</span>(<span class="ruby-identifier">l</span>, <span class="ruby-identifier">options</span>)
158
164
  <span class="ruby-keyword">end</span>
159
165
  <span class="ruby-keyword">end</span></pre>
@@ -198,7 +204,7 @@ first logger.</p>
198
204
 
199
205
 
200
206
  <div class="method-source-code" id="debug_prompt-source">
201
- <pre><span class="ruby-comment"># File lib/bauxite/loggers/composite.rb, line 58</span>
207
+ <pre><span class="ruby-comment"># File lib/bauxite/loggers/composite.rb, line 62</span>
202
208
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">debug_prompt</span>
203
209
  <span class="ruby-ivar">@loggers</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">debug_prompt</span>
204
210
  <span class="ruby-keyword">end</span></pre>
@@ -231,7 +237,7 @@ first logger.</p>
231
237
 
232
238
 
233
239
  <div class="method-source-code" id="finalize-source">
234
- <pre><span class="ruby-comment"># File lib/bauxite/loggers/composite.rb, line 77</span>
240
+ <pre><span class="ruby-comment"># File lib/bauxite/loggers/composite.rb, line 81</span>
235
241
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">finalize</span>(<span class="ruby-identifier">ctx</span>)
236
242
  <span class="ruby-ivar">@loggers</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">l</span><span class="ruby-operator">|</span> <span class="ruby-identifier">l</span>.<span class="ruby-identifier">finalize</span>(<span class="ruby-identifier">ctx</span>) }
237
243
  <span class="ruby-keyword">end</span></pre>
@@ -266,7 +272,7 @@ first logger.</p>
266
272
 
267
273
 
268
274
  <div class="method-source-code" id="log-source">
269
- <pre><span class="ruby-comment"># File lib/bauxite/loggers/composite.rb, line 71</span>
275
+ <pre><span class="ruby-comment"># File lib/bauxite/loggers/composite.rb, line 75</span>
270
276
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">log</span>(<span class="ruby-identifier">s</span>, <span class="ruby-identifier">type</span> = <span class="ruby-value">:info</span>)
271
277
  <span class="ruby-ivar">@loggers</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">l</span><span class="ruby-operator">|</span> <span class="ruby-identifier">l</span>.<span class="ruby-identifier">log</span>(<span class="ruby-identifier">s</span>, <span class="ruby-identifier">type</span>) }
272
278
  <span class="ruby-keyword">end</span></pre>
@@ -303,7 +309,7 @@ first logger.</p>
303
309
 
304
310
 
305
311
  <div class="method-source-code" id="log_cmd-source">
306
- <pre><span class="ruby-comment"># File lib/bauxite/loggers/composite.rb, line 50</span>
312
+ <pre><span class="ruby-comment"># File lib/bauxite/loggers/composite.rb, line 54</span>
307
313
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">log_cmd</span>(<span class="ruby-identifier">action</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
308
314
  <span class="ruby-identifier">_log_cmd_block</span>(<span class="ruby-ivar">@loggers</span>, <span class="ruby-identifier">action</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
309
315
  <span class="ruby-keyword">end</span></pre>
@@ -336,7 +342,7 @@ first logger.</p>
336
342
 
337
343
 
338
344
  <div class="method-source-code" id="progress-source">
339
- <pre><span class="ruby-comment"># File lib/bauxite/loggers/composite.rb, line 63</span>
345
+ <pre><span class="ruby-comment"># File lib/bauxite/loggers/composite.rb, line 67</span>
340
346
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">progress</span>(<span class="ruby-identifier">value</span>)
341
347
  <span class="ruby-ivar">@loggers</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">l</span><span class="ruby-operator">|</span> <span class="ruby-identifier">l</span>.<span class="ruby-identifier">progress</span>(<span class="ruby-identifier">value</span>) }
342
348
  <span class="ruby-keyword">end</span></pre>
@@ -75,6 +75,8 @@
75
75
 
76
76
  <li class="calls-super" ><a href="#method-c-new">::new</a>
77
77
 
78
+ <li ><a href="#method-i-finalize">#finalize</a>
79
+
78
80
  <li ><a href="#method-i-log_cmd">#log_cmd</a>
79
81
 
80
82
  </ul>
@@ -95,6 +97,12 @@
95
97
  <p>This logger outputs the raw action text for every action executed to the
96
98
  file specified in the <code>file</code> logger option.</p>
97
99
 
100
+ <p>File logger options include:</p>
101
+ <dl class="rdoc-list label-list"><dt><code>file</code>
102
+ <dd>
103
+ <p>Output file name.</p>
104
+ </dd></dl>
105
+
98
106
  </section>
99
107
 
100
108
 
@@ -140,14 +148,14 @@ file specified in the <code>file</code> logger option.</p>
140
148
 
141
149
 
142
150
  <div class="method-source-code" id="new-source">
143
- <pre><span class="ruby-comment"># File lib/bauxite/loggers/file.rb, line 31</span>
151
+ <pre><span class="ruby-comment"># File lib/bauxite/loggers/file.rb, line 35</span>
144
152
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">options</span>)
145
153
  <span class="ruby-keyword">super</span>(<span class="ruby-identifier">options</span>)
146
154
  <span class="ruby-ivar">@file</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:file</span>]
147
155
  <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@file</span> <span class="ruby-keyword">and</span> <span class="ruby-ivar">@file</span> <span class="ruby-operator">!=</span> <span class="ruby-string">&#39;&#39;</span>
148
156
  <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">&quot;FileLogger configuration error: Undefined &#39;file&#39; option.&quot;</span>
149
157
  <span class="ruby-keyword">end</span>
150
- <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-ivar">@file</span>, <span class="ruby-string">&quot;w&quot;</span>) {} <span class="ruby-comment"># truncate file</span>
158
+ <span class="ruby-ivar">@lines</span> = []
151
159
  <span class="ruby-keyword">end</span></pre>
152
160
  </div>
153
161
 
@@ -167,6 +175,39 @@ file specified in the <code>file</code> logger option.</p>
167
175
  </header>
168
176
 
169
177
 
178
+ <div id="method-i-finalize" class="method-detail ">
179
+
180
+ <div class="method-heading">
181
+ <span class="method-name">finalize</span><span
182
+ class="method-args">(ctx)</span>
183
+
184
+ <span class="method-click-advice">click to toggle source</span>
185
+
186
+ </div>
187
+
188
+
189
+ <div class="method-description">
190
+
191
+ <p>Completes the log execution.</p>
192
+
193
+
194
+
195
+
196
+ <div class="method-source-code" id="finalize-source">
197
+ <pre><span class="ruby-comment"># File lib/bauxite/loggers/file.rb, line 45</span>
198
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">finalize</span>(<span class="ruby-identifier">ctx</span>)
199
+ <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">ctx</span>.<span class="ruby-identifier">output_path</span>(<span class="ruby-ivar">@file</span>), <span class="ruby-string">&#39;w&#39;</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">write</span>(<span class="ruby-ivar">@lines</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">&quot;\n&quot;</span>)) }
200
+ <span class="ruby-keyword">end</span></pre>
201
+ </div>
202
+
203
+ </div>
204
+
205
+
206
+
207
+
208
+ </div>
209
+
210
+
170
211
  <div id="method-i-log_cmd" class="method-detail ">
171
212
 
172
213
  <div class="method-heading">
@@ -186,9 +227,9 @@ file specified in the <code>file</code> logger option.</p>
186
227
 
187
228
 
188
229
  <div class="method-source-code" id="log_cmd-source">
189
- <pre><span class="ruby-comment"># File lib/bauxite/loggers/file.rb, line 41</span>
230
+ <pre><span class="ruby-comment"># File lib/bauxite/loggers/file.rb, line 50</span>
190
231
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">log_cmd</span>(<span class="ruby-identifier">action</span>)
191
- <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-ivar">@file</span>, <span class="ruby-string">&#39;a+&#39;</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">action</span>.<span class="ruby-identifier">text</span><span class="ruby-operator">+</span><span class="ruby-string">&quot;\n&quot;</span>) }
232
+ <span class="ruby-ivar">@lines</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">action</span>.<span class="ruby-identifier">text</span>
192
233
  <span class="ruby-keyword">yield</span>
193
234
  <span class="ruby-keyword">end</span></pre>
194
235
  </div>
@@ -94,12 +94,22 @@
94
94
 
95
95
  <section class="description">
96
96
 
97
- <p>Echo logger.</p>
98
-
99
- <p>This logger outputs the raw action text for every action executed.</p>
100
-
101
- <p>Note that this logger does not include execution status information (i.e.
102
- action succeeded, failed or was skipped).</p>
97
+ <p>Html logger.</p>
98
+
99
+ <p>This logger creates an HTML report of the test execution, linking to the
100
+ captures taken, if any.</p>
101
+
102
+ <p>Html logger options include:</p>
103
+ <dl class="rdoc-list label-list"><dt><code>html</code>
104
+ <dd>
105
+ <p>Name of the outpus HTML report file. If not present, defaults to
106
+ “test.html”.</p>
107
+ </dd><dt><code>html_package</code>
108
+ <dd>
109
+ <p>If set, embed captures into the HTML report file using the data URI scheme
110
+ (base64 encoded). The captures embedded into the report are deleted from
111
+ the filesystem.</p>
112
+ </dd></dl>
103
113
 
104
114
  </section>
105
115
 
@@ -146,11 +156,12 @@ action succeeded, failed or was skipped).</p>
146
156
 
147
157
 
148
158
  <div class="method-source-code" id="new-source">
149
- <pre><span class="ruby-comment"># File lib/bauxite/loggers/html.rb, line 34</span>
159
+ <pre><span class="ruby-comment"># File lib/bauxite/loggers/html.rb, line 42</span>
150
160
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">options</span>)
151
161
  <span class="ruby-keyword">super</span>(<span class="ruby-identifier">options</span>)
152
162
  <span class="ruby-ivar">@data</span> = []
153
163
  <span class="ruby-ivar">@file</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:html</span>] <span class="ruby-operator">||</span> <span class="ruby-string">&#39;test.html&#39;</span>
164
+ <span class="ruby-ivar">@imgs</span> = []
154
165
  <span class="ruby-keyword">end</span></pre>
155
166
  </div>
156
167
 
@@ -189,7 +200,7 @@ action succeeded, failed or was skipped).</p>
189
200
 
190
201
 
191
202
  <div class="method-source-code" id="finalize-source">
192
- <pre><span class="ruby-comment"># File lib/bauxite/loggers/html.rb, line 81</span>
203
+ <pre><span class="ruby-comment"># File lib/bauxite/loggers/html.rb, line 90</span>
193
204
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">finalize</span>(<span class="ruby-identifier">ctx</span>)
194
205
  <span class="ruby-identifier">output</span> = <span class="ruby-identifier">ctx</span>.<span class="ruby-identifier">variables</span>[<span class="ruby-string">&#39;__OUTPUT__&#39;</span>] <span class="ruby-operator">||</span> <span class="ruby-string">&#39;&#39;</span>
195
206
 
@@ -270,12 +281,9 @@ action succeeded, failed or was skipped).</p>
270
281
  <span class="ruby-identifier">html</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-string">&quot;
271
282
  &lt;/body&gt;
272
283
  &lt;/html&gt;&quot;</span>
273
- <span class="ruby-identifier">file</span> = <span class="ruby-ivar">@file</span>
274
- <span class="ruby-keyword">if</span> <span class="ruby-identifier">output</span> <span class="ruby-operator">!=</span> <span class="ruby-string">&#39;&#39;</span>
275
- <span class="ruby-identifier">file</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">output</span>, <span class="ruby-identifier">file</span>)
276
- <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">mkdir</span> <span class="ruby-identifier">output</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">exists?</span> <span class="ruby-identifier">output</span>
277
- <span class="ruby-keyword">end</span>
284
+ <span class="ruby-identifier">file</span> = <span class="ruby-identifier">ctx</span>.<span class="ruby-identifier">output_path</span>(<span class="ruby-ivar">@file</span>)
278
285
  <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">file</span>, <span class="ruby-string">&#39;w&#39;</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">html</span> }
286
+ <span class="ruby-constant">File</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-operator">*</span><span class="ruby-ivar">@imgs</span>) <span class="ruby-keyword">if</span> <span class="ruby-ivar">@imgs</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span>
279
287
  <span class="ruby-keyword">end</span></pre>
280
288
  </div>
281
289
 
@@ -309,7 +317,7 @@ action succeeded, failed or was skipped).</p>
309
317
 
310
318
 
311
319
  <div class="method-source-code" id="log-source">
312
- <pre><span class="ruby-comment"># File lib/bauxite/loggers/html.rb, line 45</span>
320
+ <pre><span class="ruby-comment"># File lib/bauxite/loggers/html.rb, line 54</span>
313
321
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">log</span>(<span class="ruby-identifier">s</span>, <span class="ruby-identifier">type</span> = <span class="ruby-value">:info</span>)
314
322
  <span class="ruby-keyword">end</span></pre>
315
323
  </div>
@@ -341,7 +349,7 @@ action succeeded, failed or was skipped).</p>
341
349
 
342
350
 
343
351
  <div class="method-source-code" id="log_cmd-source">
344
- <pre><span class="ruby-comment"># File lib/bauxite/loggers/html.rb, line 49</span>
352
+ <pre><span class="ruby-comment"># File lib/bauxite/loggers/html.rb, line 58</span>
345
353
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">log_cmd</span>(<span class="ruby-identifier">action</span>)
346
354
  <span class="ruby-identifier">ret</span> = <span class="ruby-keyword">yield</span>
347
355
  <span class="ruby-keyword">ensure</span>
@@ -98,6 +98,16 @@
98
98
 
99
99
  <p>This logger outputs colorized lines using xterm (VT100/2) escape sequences.</p>
100
100
 
101
+ <p>XTerm logger options include:</p>
102
+ <dl class="rdoc-list label-list"><dt><code>nc</code>, <code>color</code>
103
+ <dd>
104
+ <p>If set to &#39;no&#39;, prints text without using colors. Note that
105
+ positional escape sequences will still be used to show progress. To disable
106
+ escape sequences completely, consider using the <a
107
+ href="TerminalLogger.html">Bauxite::Loggers::TerminalLogger</a> logger
108
+ instead.</p>
109
+ </dd></dl>
110
+
101
111
  </section>
102
112
 
103
113
 
@@ -143,7 +153,7 @@
143
153
 
144
154
 
145
155
  <div class="method-source-code" id="_fmt-source">
146
- <pre><span class="ruby-comment"># File lib/bauxite/loggers/xterm.rb, line 52</span>
156
+ <pre><span class="ruby-comment"># File lib/bauxite/loggers/xterm.rb, line 60</span>
147
157
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">_fmt</span>(<span class="ruby-identifier">color</span>, <span class="ruby-identifier">text</span>, <span class="ruby-identifier">size</span> = <span class="ruby-value">0</span>)
148
158
  <span class="ruby-identifier">text</span> = <span class="ruby-keyword">super</span>(<span class="ruby-identifier">color</span>, <span class="ruby-identifier">text</span>, <span class="ruby-identifier">size</span>)
149
159
  <span class="ruby-keyword">if</span> <span class="ruby-ivar">@options</span>[<span class="ruby-value">:nc</span>] <span class="ruby-keyword">or</span> <span class="ruby-ivar">@options</span>[<span class="ruby-value">:color</span>] <span class="ruby-operator">==</span> <span class="ruby-string">&#39;no&#39;</span>
@@ -181,7 +191,7 @@
181
191
 
182
192
 
183
193
  <div class="method-source-code" id="_restore_cursor-source">
184
- <pre><span class="ruby-comment"># File lib/bauxite/loggers/xterm.rb, line 66</span>
194
+ <pre><span class="ruby-comment"># File lib/bauxite/loggers/xterm.rb, line 74</span>
185
195
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">_restore_cursor</span>
186
196
  <span class="ruby-identifier">print</span> <span class="ruby-string">&quot;\033[u&quot;</span>
187
197
  <span class="ruby-keyword">true</span>
@@ -215,7 +225,7 @@
215
225
 
216
226
 
217
227
  <div class="method-source-code" id="_save_cursor-source">
218
- <pre><span class="ruby-comment"># File lib/bauxite/loggers/xterm.rb, line 61</span>
228
+ <pre><span class="ruby-comment"># File lib/bauxite/loggers/xterm.rb, line 69</span>
219
229
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">_save_cursor</span>
220
230
  <span class="ruby-identifier">print</span> <span class="ruby-string">&quot;\033[s&quot;</span>
221
231
  <span class="ruby-keyword">true</span>
@@ -254,7 +264,7 @@
254
264
 
255
265
 
256
266
  <div class="method-source-code" id="_screen_width-source">
257
- <pre><span class="ruby-comment"># File lib/bauxite/loggers/xterm.rb, line 76</span>
267
+ <pre><span class="ruby-comment"># File lib/bauxite/loggers/xterm.rb, line 84</span>
258
268
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">_screen_width</span>
259
269
  <span class="ruby-keyword">if</span> <span class="ruby-constant">RbConfig</span><span class="ruby-operator">::</span><span class="ruby-constant">CONFIG</span>[<span class="ruby-string">&#39;host_os&#39;</span>] <span class="ruby-operator">=~</span>
260
270
  <span class="ruby-regexp">/(aix|darwin|linux|(net|free|open)bsd|cygwin|solaris|irix|hpux)/i</span>
data/doc/README_md.html CHANGED
@@ -444,8 +444,7 @@ create an execute shell build task with the following text:</p>
444
444
 
445
445
  <pre>#!/bin/bash
446
446
  source ~/.rvm/scripts/rvm
447
- bauxite -l echo -u http://localhost:4444/wd/hub \
448
- -t 60 -o 240 --csv-summary &quot;$WORKSPACE/test.csv&quot; \
447
+ bauxite -t 60 -o 240 --jenkins &quot;$WORKSPACE/test-results&quot; \
449
448
  &quot;$WORKSPACE/test/suite.bxt&quot;</pre>
450
449
 
451
450
  <p>Assuming you have Selenium Server running on localhost and your workspace
@@ -461,12 +460,16 @@ test browse_around.bxt
461
460
  test purchase_something.bxt
462
461
  # more tests here...</pre>
463
462
 
464
- <p>Note the <code>--csv-summary</code> option in the configuration above. That
465
- option generates a single-line CSV file ideal to feed into the
466
- <code>Plot</code> Jenkins plugin. I won&#39;t go into the details of
467
- configuring the Plot plugin, but instead here is a fragment of a possible
468
- Jenkins <code>config.xml</code> plotting the <a
469
- href="Bauxite.html">Bauxite</a> test results:</p>
463
+ <p>Note the <code>--jenkins</code> option in the configuration above. That
464
+ option sets the default configuration arguments for Jenkins integration.
465
+ For more details on the <code>bauxite</code> command-line arguments refer
466
+ to the <a
467
+ href="http://pzavolinsky.github.io/bauxite/Bauxite/Application.html">RDoc
468
+ documentation</a>.</p>
469
+
470
+ <p>I won&#39;t go into the details of configuring the Jenkins publishing
471
+ plugins to print <a href="Bauxite.html">Bauxite</a> test results, but
472
+ instead here is a fragment of a possible Jenkins <code>config.xml</code>:</p>
470
473
 
471
474
  <pre>&lt;publishers&gt;
472
475
  ...
@@ -477,7 +480,7 @@ href="Bauxite.html">Bauxite</a> test results:</p>
477
480
  &lt;yaxis&gt;Number of tests&lt;/yaxis&gt;
478
481
  &lt;series&gt;
479
482
  &lt;hudson.plugins.plot.CSVSeries&gt;
480
- &lt;file&gt;test.csv&lt;/file&gt;
483
+ &lt;file&gt;test-results/summary.csv&lt;/file&gt;
481
484
  &lt;label&gt;&lt;/label&gt;
482
485
  &lt;fileType&gt;csv&lt;/fileType&gt;
483
486
  &lt;strExclusionSet&gt;
@@ -503,7 +506,7 @@ href="Bauxite.html">Bauxite</a> test results:</p>
503
506
  &lt;yaxis&gt;Test time (s)&lt;/yaxis&gt;
504
507
  &lt;series&gt;
505
508
  &lt;hudson.plugins.plot.CSVSeries&gt;
506
- &lt;file&gt;test.csv&lt;/file&gt;
509
+ &lt;file&gt;test-results/summary.csv&lt;/file&gt;
507
510
  &lt;label&gt;&lt;/label&gt;
508
511
  &lt;fileType&gt;csv&lt;/fileType&gt;
509
512
  &lt;strExclusionSet&gt;
data/doc/created.rid CHANGED
@@ -1,7 +1,7 @@
1
- Thu, 06 Feb 2014 20:30:38 -0300
2
- README.md Fri, 31 Jan 2014 08:21:19 -0300
1
+ Sun, 09 Feb 2014 21:18:47 -0300
2
+ README.md Sun, 09 Feb 2014 20:55:37 -0300
3
3
  lib/bauxite/actions/break.rb Mon, 27 Jan 2014 20:58:50 -0300
4
- lib/bauxite/actions/asserth.rb Thu, 06 Feb 2014 19:25:05 -0300
4
+ lib/bauxite/actions/asserth.rb Sun, 09 Feb 2014 18:41:12 -0300
5
5
  lib/bauxite/actions/assert.rb Mon, 27 Jan 2014 20:58:50 -0300
6
6
  lib/bauxite/actions/wait.rb Mon, 27 Jan 2014 20:58:50 -0300
7
7
  lib/bauxite/actions/assertv.rb Mon, 27 Jan 2014 20:58:50 -0300
@@ -13,7 +13,7 @@ lib/bauxite/actions/assertw.rb Thu, 06 Feb 2014 19:25:05 -0300
13
13
  lib/bauxite/actions/doif.rb Tue, 04 Feb 2014 19:42:30 -0300
14
14
  lib/bauxite/actions/ruby.rb Mon, 27 Jan 2014 20:58:50 -0300
15
15
  lib/bauxite/actions/echo.rb Mon, 27 Jan 2014 20:58:50 -0300
16
- lib/bauxite/actions/capture.rb Thu, 06 Feb 2014 19:53:56 -0300
16
+ lib/bauxite/actions/capture.rb Sun, 09 Feb 2014 20:56:49 -0300
17
17
  lib/bauxite/actions/js.rb Mon, 27 Jan 2014 20:58:50 -0300
18
18
  lib/bauxite/actions/replace.rb Mon, 27 Jan 2014 20:58:50 -0300
19
19
  lib/bauxite/actions/write.rb Mon, 27 Jan 2014 20:58:50 -0300
@@ -34,10 +34,10 @@ lib/bauxite/actions/alias.rb Mon, 27 Jan 2014 20:58:50 -0300
34
34
  lib/bauxite/parsers/html.rb Thu, 06 Feb 2014 19:25:05 -0300
35
35
  lib/bauxite/parsers/csv.rb Mon, 27 Jan 2014 20:58:50 -0300
36
36
  lib/bauxite/parsers/default.rb Mon, 27 Jan 2014 20:58:50 -0300
37
- lib/bauxite/application.rb Tue, 04 Feb 2014 19:42:30 -0300
37
+ lib/bauxite/application.rb Sun, 09 Feb 2014 21:02:36 -0300
38
38
  lib/bauxite/core/errors.rb Mon, 27 Jan 2014 20:58:50 -0300
39
39
  lib/bauxite/core/selector.rb Tue, 28 Jan 2014 21:05:35 -0300
40
- lib/bauxite/core/context.rb Tue, 04 Feb 2014 21:48:38 -0300
40
+ lib/bauxite/core/context.rb Sun, 09 Feb 2014 21:04:35 -0300
41
41
  lib/bauxite/core/logger.rb Tue, 04 Feb 2014 19:47:18 -0300
42
42
  lib/bauxite/core/action.rb Tue, 04 Feb 2014 20:25:25 -0300
43
43
  lib/bauxite/core/parser.rb Mon, 27 Jan 2014 20:58:50 -0300
@@ -47,8 +47,8 @@ lib/bauxite/selectors/window.rb Thu, 06 Feb 2014 20:27:10 -0300
47
47
  lib/bauxite/selectors/smart.rb Fri, 31 Jan 2014 20:43:53 -0300
48
48
  lib/bauxite/selectors/frame.rb Tue, 28 Jan 2014 19:38:40 -0300
49
49
  lib/bauxite/loggers/terminal.rb Mon, 27 Jan 2014 20:58:50 -0300
50
- lib/bauxite/loggers/file.rb Mon, 27 Jan 2014 20:58:50 -0300
51
- lib/bauxite/loggers/composite.rb Thu, 06 Feb 2014 19:25:05 -0300
52
- lib/bauxite/loggers/html.rb Thu, 06 Feb 2014 19:25:05 -0300
50
+ lib/bauxite/loggers/file.rb Sun, 09 Feb 2014 21:17:29 -0300
51
+ lib/bauxite/loggers/composite.rb Sun, 09 Feb 2014 21:07:12 -0300
52
+ lib/bauxite/loggers/html.rb Sun, 09 Feb 2014 20:12:24 -0300
53
53
  lib/bauxite/loggers/echo.rb Mon, 27 Jan 2014 20:58:50 -0300
54
- lib/bauxite/loggers/xterm.rb Mon, 27 Jan 2014 20:58:50 -0300
54
+ lib/bauxite/loggers/xterm.rb Sun, 09 Feb 2014 21:15:58 -0300
data/doc/index.html CHANGED
@@ -476,8 +476,7 @@ create an execute shell build task with the following text:</p>
476
476
 
477
477
  <pre>#!/bin/bash
478
478
  source ~/.rvm/scripts/rvm
479
- bauxite -l echo -u http://localhost:4444/wd/hub \
480
- -t 60 -o 240 --csv-summary &quot;$WORKSPACE/test.csv&quot; \
479
+ bauxite -t 60 -o 240 --jenkins &quot;$WORKSPACE/test-results&quot; \
481
480
  &quot;$WORKSPACE/test/suite.bxt&quot;</pre>
482
481
 
483
482
  <p>Assuming you have Selenium Server running on localhost and your workspace
@@ -493,12 +492,16 @@ test browse_around.bxt
493
492
  test purchase_something.bxt
494
493
  # more tests here...</pre>
495
494
 
496
- <p>Note the <code>--csv-summary</code> option in the configuration above. That
497
- option generates a single-line CSV file ideal to feed into the
498
- <code>Plot</code> Jenkins plugin. I won&#39;t go into the details of
499
- configuring the Plot plugin, but instead here is a fragment of a possible
500
- Jenkins <code>config.xml</code> plotting the <a
501
- href="Bauxite.html">Bauxite</a> test results:</p>
495
+ <p>Note the <code>--jenkins</code> option in the configuration above. That
496
+ option sets the default configuration arguments for Jenkins integration.
497
+ For more details on the <code>bauxite</code> command-line arguments refer
498
+ to the <a
499
+ href="http://pzavolinsky.github.io/bauxite/Bauxite/Application.html">RDoc
500
+ documentation</a>.</p>
501
+
502
+ <p>I won&#39;t go into the details of configuring the Jenkins publishing
503
+ plugins to print <a href="Bauxite.html">Bauxite</a> test results, but
504
+ instead here is a fragment of a possible Jenkins <code>config.xml</code>:</p>
502
505
 
503
506
  <pre>&lt;publishers&gt;
504
507
  ...
@@ -509,7 +512,7 @@ href="Bauxite.html">Bauxite</a> test results:</p>
509
512
  &lt;yaxis&gt;Number of tests&lt;/yaxis&gt;
510
513
  &lt;series&gt;
511
514
  &lt;hudson.plugins.plot.CSVSeries&gt;
512
- &lt;file&gt;test.csv&lt;/file&gt;
515
+ &lt;file&gt;test-results/summary.csv&lt;/file&gt;
513
516
  &lt;label&gt;&lt;/label&gt;
514
517
  &lt;fileType&gt;csv&lt;/fileType&gt;
515
518
  &lt;strExclusionSet&gt;
@@ -535,7 +538,7 @@ href="Bauxite.html">Bauxite</a> test results:</p>
535
538
  &lt;yaxis&gt;Test time (s)&lt;/yaxis&gt;
536
539
  &lt;series&gt;
537
540
  &lt;hudson.plugins.plot.CSVSeries&gt;
538
- &lt;file&gt;test.csv&lt;/file&gt;
541
+ &lt;file&gt;test-results/summary.csv&lt;/file&gt;
539
542
  &lt;label&gt;&lt;/label&gt;
540
543
  &lt;fileType&gt;csv&lt;/fileType&gt;
541
544
  &lt;strExclusionSet&gt;