-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathEasyDashboardScripts.htm
More file actions
494 lines (411 loc) · 16.5 KB
/
EasyDashboardScripts.htm
File metadata and controls
494 lines (411 loc) · 16.5 KB
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
<html xmlns:o="urn:schemas-microsoft-com:office:office"
xmlns:w="urn:schemas-microsoft-com:office:word"
xmlns="http://www.w3.org/TR/REC-html40">
<head>
<meta http-equiv=Content-Type content="text/html; charset=windows-1252">
<meta name=ProgId content=Word.Document>
<meta name=Generator content="Microsoft Word 11">
<meta name=Originator content="Microsoft Word 11">
<link rel=File-List href="EasyDashboardScripts_files/filelist.xml">
<title>EasyDashboardScripts</title>
<!--[if gte mso 9]><xml>
<o:DocumentProperties>
<o:Author>David Cole</o:Author>
<o:LastAuthor> </o:LastAuthor>
<o:Revision>2</o:Revision>
<o:TotalTime>2</o:TotalTime>
<o:Created>2006-12-01T16:51:00Z</o:Created>
<o:LastSaved>2006-12-01T16:51:00Z</o:LastSaved>
<o:Pages>1</o:Pages>
<o:Words>849</o:Words>
<o:Characters>4843</o:Characters>
<o:Company>Kitware, Inc.</o:Company>
<o:Lines>40</o:Lines>
<o:Paragraphs>11</o:Paragraphs>
<o:CharactersWithSpaces>5681</o:CharactersWithSpaces>
<o:Version>11.5606</o:Version>
</o:DocumentProperties>
</xml><![endif]--><!--[if gte mso 9]><xml>
<w:WordDocument>
<w:GrammarState>Clean</w:GrammarState>
<w:PunctuationKerning/>
<w:ValidateAgainstSchemas/>
<w:SaveIfXMLInvalid>false</w:SaveIfXMLInvalid>
<w:IgnoreMixedContent>false</w:IgnoreMixedContent>
<w:AlwaysShowPlaceholderText>false</w:AlwaysShowPlaceholderText>
<w:Compatibility>
<w:BreakWrappedTables/>
<w:SnapToGridInCell/>
<w:WrapTextWithPunct/>
<w:UseAsianBreakRules/>
<w:DontGrowAutofit/>
</w:Compatibility>
<w:BrowserLevel>MicrosoftInternetExplorer4</w:BrowserLevel>
</w:WordDocument>
</xml><![endif]--><!--[if gte mso 9]><xml>
<w:LatentStyles DefLockedState="false" LatentStyleCount="156">
</w:LatentStyles>
</xml><![endif]-->
<style>
<!--
/* Font Definitions */
@font-face
{font-family:Wingdings;
panose-1:5 0 0 0 0 0 0 0 0 0;
mso-font-charset:2;
mso-generic-font-family:auto;
mso-font-pitch:variable;
mso-font-signature:0 268435456 0 0 -2147483648 0;}
/* Style Definitions */
p.MsoNormal, li.MsoNormal, div.MsoNormal
{mso-style-parent:"";
margin:0in;
margin-bottom:.0001pt;
mso-pagination:widow-orphan;
font-size:12.0pt;
font-family:"Times New Roman";
mso-fareast-font-family:"Times New Roman";}
h1
{mso-style-next:Normal;
margin-top:12.0pt;
margin-right:0in;
margin-bottom:3.0pt;
margin-left:0in;
mso-pagination:widow-orphan;
page-break-after:avoid;
mso-outline-level:1;
font-size:16.0pt;
font-family:Arial;
mso-font-kerning:16.0pt;}
span.GramE
{mso-style-name:"";
mso-gram-e:yes;}
@page Section1
{size:8.5in 11.0in;
margin:1.0in 1.25in 1.0in 1.25in;
mso-header-margin:.5in;
mso-footer-margin:.5in;
mso-paper-source:0;}
div.Section1
{page:Section1;}
/* List Definitions */
@list l0
{mso-list-id:-132;
mso-list-type:simple;
mso-list-template-ids:176176926;}
@list l0:level1
{mso-level-tab-stop:1.25in;
mso-level-number-position:left;
margin-left:1.25in;
text-indent:-.25in;}
@list l1
{mso-list-id:-131;
mso-list-type:simple;
mso-list-template-ids:-902652076;}
@list l1:level1
{mso-level-tab-stop:1.0in;
mso-level-number-position:left;
margin-left:1.0in;
text-indent:-.25in;}
@list l2
{mso-list-id:-130;
mso-list-type:simple;
mso-list-template-ids:1440797556;}
@list l2:level1
{mso-level-tab-stop:.75in;
mso-level-number-position:left;
margin-left:.75in;
text-indent:-.25in;}
@list l3
{mso-list-id:-129;
mso-list-type:simple;
mso-list-template-ids:-1312630788;}
@list l3:level1
{mso-level-tab-stop:.5in;
mso-level-number-position:left;
text-indent:-.25in;}
@list l4
{mso-list-id:-128;
mso-list-type:simple;
mso-list-template-ids:-13746010;}
@list l4:level1
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:1.25in;
mso-level-number-position:left;
margin-left:1.25in;
text-indent:-.25in;
font-family:Symbol;}
@list l5
{mso-list-id:-127;
mso-list-type:simple;
mso-list-template-ids:-1363106196;}
@list l5:level1
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:1.0in;
mso-level-number-position:left;
margin-left:1.0in;
text-indent:-.25in;
font-family:Symbol;}
@list l6
{mso-list-id:-126;
mso-list-type:simple;
mso-list-template-ids:-1010514470;}
@list l6:level1
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:.75in;
mso-level-number-position:left;
margin-left:.75in;
text-indent:-.25in;
font-family:Symbol;}
@list l7
{mso-list-id:-125;
mso-list-type:simple;
mso-list-template-ids:-250042386;}
@list l7:level1
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:.5in;
mso-level-number-position:left;
text-indent:-.25in;
font-family:Symbol;}
@list l8
{mso-list-id:-120;
mso-list-type:simple;
mso-list-template-ids:-1291802262;}
@list l8:level1
{mso-level-tab-stop:.25in;
mso-level-number-position:left;
margin-left:.25in;
text-indent:-.25in;}
@list l9
{mso-list-id:-119;
mso-list-type:simple;
mso-list-template-ids:599786864;}
@list l9:level1
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:.25in;
mso-level-number-position:left;
margin-left:.25in;
text-indent:-.25in;
font-family:Symbol;}
@list l10
{mso-list-id:655451938;
mso-list-type:hybrid;
mso-list-template-ids:-1168233516 67698689 67698691 67698693 67698689 67698691 67698693 67698689 67698691 67698693;}
@list l10:level1
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:.5in;
mso-level-number-position:left;
text-indent:-.25in;
font-family:Symbol;}
@list l11
{mso-list-id:1965885298;
mso-list-type:hybrid;
mso-list-template-ids:-1348305898 67698689 67698691 67698693 67698689 67698691 67698693 67698689 67698691 67698693;}
@list l11:level1
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:.5in;
mso-level-number-position:left;
text-indent:-.25in;
font-family:Symbol;}
ol
{margin-bottom:0in;}
ul
{margin-bottom:0in;}
-->
</style>
<!--[if gte mso 10]>
<style>
/* Style Definitions */
table.MsoNormalTable
{mso-style-name:"Table Normal";
mso-tstyle-rowband-size:0;
mso-tstyle-colband-size:0;
mso-style-noshow:yes;
mso-style-parent:"";
mso-padding-alt:0in 5.4pt 0in 5.4pt;
mso-para-margin:0in;
mso-para-margin-bottom:.0001pt;
mso-pagination:widow-orphan;
font-size:10.0pt;
font-family:"Times New Roman";
mso-ansi-language:#0400;
mso-fareast-language:#0400;
mso-bidi-language:#0400;}
</style>
<![endif]-->
</head>
<body lang=EN-US style='tab-interval:.5in'>
<div class=Section1>
<h1>EasyDashboardScripts</h1>
<p class=MsoNormal>Wouldn't it be nice if, on any computer, you could do this
to run a dashboard for your favorite software project?</p>
<p class=MsoNormal><o:p> </o:p></p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span><span class=GramE>ctest</span>
-S FavoriteProject.cmake</p>
<p class=MsoNormal><o:p> </o:p></p>
<p class=MsoNormal>And wouldn't it be even nicer if the contents of
FavoriteProject.cmake looked as simple as this?</p>
<p class=MsoNormal><o:p> </o:p></p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span><span class=GramE>SET(</span>dir
"${CTEST_SCRIPT_DIRECTORY}/../EasyDashboardScripts")</p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span><span class=GramE>INCLUDE(</span>"${dir}/EasyDashboard.cmake")</p>
<p class=MsoNormal><o:p> </o:p></p>
<p class=MsoNormal>And wouldn't it just be totally sweet if you could even
modify how the dashboard builds by adding some simple parameters to the ctest
call like this?</p>
<p class=MsoNormal><o:p> </o:p></p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span><span class=GramE>ctest</span>
-S FavoriteProject.cmake,Debug-Shared-WrapPython</p>
<p class=MsoNormal><o:p> </o:p></p>
<p class=MsoNormal>It would be nice. Actually, it is nice. Sweet! It's even
entirely possible with the scripts found in EasyDashboardScripts.</p>
<h1>Easy Setup</h1>
<p class=MsoNormal>Here's the bare bones bootstrap sequence to use EasyDashboard
on your computer:</p>
<ul style='margin-top:0in' type=disc>
<li class=MsoNormal style='mso-list:l10 level1 lfo11;tab-stops:list .5in'>Create
a Dashboards directory</li>
<li class=MsoNormal style='mso-list:l10 level1 lfo11;tab-stops:list .5in'>Put
EasyDashboardScripts under Dashboards</li>
<li class=MsoNormal style='mso-list:l10 level1 lfo11;tab-stops:list .5in'>Create
"Dashboards/My Tests" (with a space)</li>
<li class=MsoNormal style='mso-list:l10 level1 lfo11;tab-stops:list .5in'>Put
your source trees under "My Tests" (with cvs, svn or whatever
)</li>
<li class=MsoNormal style='mso-list:l10 level1 lfo11;tab-stops:list .5in'>cd
into EasyDashboardScripts and run a dashboard with "ctest S
ProjectName.cmake"</li>
</ul>
<p class=MsoNormal><o:p> </o:p></p>
<p class=MsoNormal>Scripts are included in EasyDashboardScripts to run
dashboards for the following projects without any additional work:</p>
<ul style='margin-top:0in' type=disc>
<li class=MsoNormal style='mso-list:l11 level1 lfo12;tab-stops:list .5in'>CableSwig</li>
<li class=MsoNormal style='mso-list:l11 level1 lfo12;tab-stops:list .5in'>CMake</li>
<li class=MsoNormal style='mso-list:l11 level1 lfo12;tab-stops:list .5in'>ParaView</li>
<li class=MsoNormal style='mso-list:l11 level1 lfo12;tab-stops:list .5in'>KWWidgets</li>
<li class=MsoNormal style='mso-list:l11 level1 lfo12;tab-stops:list .5in'>VTK</li>
</ul>
<p class=MsoNormal><o:p> </o:p></p>
<p class=MsoNormal>Additional work is only required if you want to override the
default settings that EasyDashboard uses. If you want to learn more about how
it works or <span class=GramE>customize</span> it for your machine, then read
on
</p>
<h1>Goals and Conventions</h1>
<p class=MsoNormal>Let's start by stating some goals and agreeing on some
conventions to adhere to on any machine that runs dashboards.</p>
<p class=MsoNormal><o:p> </o:p></p>
<p class=MsoNormal><b style='mso-bidi-font-weight:normal'>Goals<o:p></o:p></b></p>
<p class=MsoNormal>Write a single dashboard script for a project that will
drive a dashboard for that project on *any* machine with *any* development
environment.</p>
<p class=MsoNormal>Set up a new machine to run dashboards with almost zero
effort. <span class=GramE>If you have CMake 2.4 or later installed and a
development/build environment, you should be able to run a dashboard with only a
few *minutes* worth of prep work.</span> Anybody anywhere who can build a
project with CMake and a native build tool should be able to run a dashboard
for that project.</p>
<p class=MsoNormal>Alter a dashboard script slightly (or even radically) by
passing arguments in with the script to control such things as build type/configuration,
development environment, wrapping languages and initial cache settings.</p>
<p class=MsoNormal><span class=GramE>Use "new style" CTest 2.4
dashboard scripts to eliminate double configures</span> and reduce dashboard
run times.</p>
<p class=MsoNormal><o:p> </o:p></p>
<p class=MsoNormal><b style='mso-bidi-font-weight:normal'>Conventions<o:p></o:p></b></p>
<p class=MsoNormal>User name: run dashboards as a non-privileged user named
"dashboard" share the password for this user with other people
around you who <span class=GramE>may need</span> to logon to your machine when
you're not around to investigate a test failure that only occurs on your
machine.</p>
<p class=MsoNormal>Directory structure: have a "Dashboards"
directory, typically in the dashboard user's home directory, or at
"C:\Dashboards" on a Windows machine. Have standard subdirectories as
follows:</p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span>Dashboards</p>
<p class=MsoNormal><span style='mso-spacerun:yes'>
</span>EasyDashboardScripts</p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span>Logs</p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span>My Tests</p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span>Support</p>
<p class=MsoNormal>The project source trees should reside in the "My
Tests" subdirectory. For example,</p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span>Dashboards</p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span>My Tests</p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span>CMake</p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span>SourceTree3</p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span>SourceTree4</p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span>VTK</p>
<p class=MsoNormal>The project binary/build trees should reside as siblings of
the source tree in the "My Tests" subdirectory.</p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span>Dashboards</p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span>My Tests</p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span>FavoriteProject</p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span>FavoriteProject
Win32-vs8-Debug</p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span>FavoriteProject
Win32-vs8-Release</p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span>SourceTree3</p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span>SourceTree3
Win32-vs8-Debug</p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span>SourceTree3
Win32-nmake8-MinSizeRel</p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span>SourceTree4</p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span>SourceTree4
Win32-borland-Debug</p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span>SourceTree4
Win32-cygwin-MinSizeRel</p>
<p class=MsoNormal>The "My Tests" directory name should have a space
in it.</p>
<p class=MsoNormal>The names of the binary trees are the names of the source
trees appended with a space and some configuration parameter values.</p>
<p class=MsoNormal>Project script location: place project scripts in any
subdirectory of Dashboards, such that "${CTEST_SCRIPT_DIRECTORY}/<span
class=GramE>.."</span> resolves to the Dashboards directory. Following
this convention allows project scripts to use:</p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span><span class=GramE>SET(</span>dir
"${CTEST_SCRIPT_DIRECTORY}/../EasyDashboardScripts")</p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span><span class=GramE>INCLUDE(</span>"${dir}/EasyDashboard.cmake")</p>
<p class=MsoNormal>Following the project script location convention also allows
separate directories for separate groups of project scripts if necessary
(perhaps originating from different CVS or SVN repositories), yet they can all
use the same technique for obtaining the EasyDashboard functionality.</p>
<p class=MsoNormal>A directory structure like this may ensue:</p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span>Dashboards</p>
<p class=MsoNormal><span style='mso-spacerun:yes'>
</span>EasyDashboardScripts</p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span>MyDashboardScripts</p>
<p class=MsoNormal><span style='mso-spacerun:yes'>
</span>ProjectDashboardScripts</p>
<p class=MsoNormal>Do not use the prefix "ED_" for CMake variables in
project scripts. ED_ names are reserved for use by EasyDashboard.cmake and its associated
scripts.</p>
<p class=MsoNormal>Argument composition: alphanumeric and underscores only.
*No* spaces, quotes, semi-colons, colons, commas, dashes, braces, other
punctuation or "special characters" are allowed in script arguments
that control dashboard run parameters. Project specific arguments should be
alphanumerics that begin with a project specific prefix followed by an
underscore, similar to typical CMakeLists variable naming conventions.</p>
<p class=MsoNormal>Argument uniqueness: all possible arguments should be
completely orthogonal to all other possible arguments with respect to regular
expression matching in CMake scripting. Ideally, no argument should match any
other argument when comparing each pairwise with every other on either side of
a CMake MATCHES comparison. See the Arguments section for more discussion on
this point. (Note: Arguments section still to be written
)</p>
<p class=MsoNormal>Attach any additional custom cmake scripts used when
processing your main project script (an override script, for example) as
dashboard notes using this construct as the very first line of the additional
script:</p>
<p class=MsoNormal><o:p> </o:p></p>
<p class=MsoNormal><span style='mso-spacerun:yes'> </span><span class=GramE>SET(</span>ED_notes
${ED_notes} "${CMAKE_CURRENT_LIST_FILE}")</p>
<p class=MsoNormal><o:p> </o:p></p>
</div>
</body>
</html>