author | Jan Vrany <jan.vrany@fit.cvut.cz> |
Wed, 15 May 2013 20:07:49 +0200 | |
changeset 149 | 3f9e255e7d47 |
parent 142 | bbebfa86daea |
child 163 | b8a6ee98534a |
permissions | -rw-r--r-- |
69 | 1 |
"{ Package: 'stx:goodies/builder/reports' }" |
2 |
||
3 |
"{ NameSpace: Builder }" |
|
4 |
||
5 |
Object subclass:#Report |
|
149
3f9e255e7d47
class: Builder::ReportRunner
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
142
diff
changeset
|
6 |
instanceVariableNames:'name packages format' |
69 | 7 |
classVariableNames:'Verbose OutputDir' |
8 |
poolDictionaries:'' |
|
9 |
category:'Builder-Reports' |
|
10 |
! |
|
11 |
||
12 |
||
13 |
!Report class methodsFor:'initialization'! |
|
14 |
||
15 |
initialize |
|
16 |
||
17 |
Verbose := false. |
|
18 |
OutputDir := Filename currentDirectory. |
|
19 |
||
20 |
"Created: / 14-03-2011 / 19:42:03 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
21 |
! ! |
|
22 |
||
23 |
!Report class methodsFor:'instance creation'! |
|
24 |
||
25 |
new |
|
26 |
"return an initialized instance" |
|
27 |
||
28 |
^ self basicNew initialize. |
|
29 |
! ! |
|
30 |
||
31 |
!Report class methodsFor:'accessing'! |
|
32 |
||
76 | 33 |
available |
34 |
"Return all available reports ready to run. |
|
35 |
Unfinished/Experimental reports are not returned" |
|
36 |
||
37 |
^{ |
|
38 |
Builder::TestReport . |
|
39 |
Builder::LintReport . |
|
40 |
} |
|
41 |
||
42 |
"Created: / 13-01-2012 / 12:01:26 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
43 |
! |
|
44 |
||
69 | 45 |
outputDir |
46 |
||
47 |
^OutputDir ? '.' |
|
48 |
||
49 |
" |
|
50 |
Report outputDir: '/tmp/reports' |
|
51 |
" |
|
52 |
||
53 |
"Created: / 07-10-2011 / 09:12:23 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
54 |
! |
|
55 |
||
56 |
outputDir: aStringOrFilename |
|
57 |
||
58 |
OutputDir := aStringOrFilename asFilename. |
|
59 |
||
60 |
" |
|
61 |
Report outputDir: '/tmp/reports' |
|
62 |
" |
|
63 |
||
64 |
"Created: / 14-03-2011 / 19:40:25 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
65 |
! ! |
|
66 |
||
67 |
!Report class methodsFor:'private'! |
|
68 |
||
69 |
convert: aString |
|
70 |
^ (aString asString |
|
71 |
copyReplaceAll: (String with: Character cr with: Character lf) with: (String with: Character lf)) |
|
72 |
copyReplaceAll: (String with: Character cr) with: (String with: Character lf) |
|
73 |
! |
|
74 |
||
75 |
encode: aString |
|
76 |
||
77 |
| in out c | |
|
78 |
||
79 |
(aString includesAny: #($< $> $& $")) ifFalse:[^aString]. |
|
80 |
in := aString readStream. |
|
81 |
out := String new writeStream. |
|
82 |
[in atEnd ] whileFalse:[ |
|
83 |
c := in next. |
|
84 |
c == $< ifTrue:[out nextPutAll:'<'] ifFalse:[ |
|
85 |
c == $> ifTrue:[out nextPutAll:'>'] ifFalse:[ |
|
86 |
c == $& ifTrue:[out nextPutAll:'&'] ifFalse:[ |
|
87 |
c == $" ifTrue:[out nextPutAll:'"'] ifFalse:[ |
|
88 |
out nextPut: c]]]]]. |
|
89 |
^out contents. |
|
90 |
||
91 |
" |
|
92 |
HDReport basicNew encode: 'abx' |
|
93 |
HDReport basicNew encode: '' |
|
94 |
HDReport basicNew encode: 'sss <clint>()' |
|
95 |
" |
|
96 |
||
97 |
"Modified: / 11-03-2011 / 17:12:17 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
98 |
! |
|
99 |
||
100 |
encodeFilename: aString |
|
101 |
||
102 |
^(aString copyReplaceAll: $: with:$_) copyReplaceAll: $/ with:$_ |
|
103 |
||
104 |
"Created: / 14-03-2011 / 14:14:43 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
105 |
"Modified: / 14-03-2011 / 23:45:40 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
106 |
! ! |
|
107 |
||
108 |
!Report class methodsFor:'running'! |
|
109 |
||
110 |
runClasses: aCollectionOfClasses |
|
111 |
||
112 |
^self runClasses: aCollectionOfClasses named: 'Some classes' |
|
113 |
||
114 |
"Created: / 04-08-2011 / 12:25:15 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
115 |
! |
|
116 |
||
117 |
runClasses: aCollectionOfClasses named: aString |
|
118 |
||
119 |
^self new runClasses: aCollectionOfClasses named: aString |
|
120 |
||
121 |
"Modified: / 04-08-2011 / 12:23:26 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
122 |
! |
|
123 |
||
124 |
runPackage: aString |
|
125 |
||
126 |
"Run a report for given package (package id)" |
|
127 |
||
128 |
^self runPackages: (Array with: aString) |
|
129 |
||
130 |
"Modified (comment): / 04-08-2011 / 12:24:59 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
131 |
! |
|
132 |
||
133 |
runPackages: packages |
|
134 |
||
135 |
"Run a report for given list of packages |
|
136 |
(package IDs)" |
|
137 |
||
138 |
^self new runPackages: packages |
|
139 |
||
140 |
"Modified (comment): / 04-08-2011 / 12:24:28 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
141 |
! |
|
142 |
||
143 |
verbose |
|
144 |
||
145 |
^ Verbose |
|
146 |
||
147 |
"Created: / 21-07-2011 / 11:48:13 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
148 |
! |
|
149 |
||
150 |
verbose: aBoolean |
|
151 |
||
152 |
Verbose := aBoolean. |
|
153 |
||
154 |
"Created: / 21-07-2011 / 11:48:02 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
155 |
! ! |
|
156 |
||
157 |
!Report methodsFor:'accessing'! |
|
158 |
||
159 |
format |
|
160 |
^ format |
|
161 |
! |
|
162 |
||
163 |
format: aFormatOrString |
|
164 |
||
165 |
aFormatOrString isString ifTrue:[ |
|
166 |
format := ReportFormat named: aFormatOrString |
|
167 |
] ifFalse:[ |
|
168 |
format := aFormatOrString |
|
169 |
] |
|
170 |
||
171 |
"Created: / 04-08-2011 / 11:55:46 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
172 |
! |
|
173 |
||
174 |
name |
|
175 |
||
176 |
^name isNil ifTrue:[ |
|
177 |
self defaultName |
|
178 |
] ifFalse:[ |
|
179 |
name |
|
180 |
] |
|
181 |
||
182 |
"Modified: / 07-11-2011 / 09:47:56 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
183 |
! |
|
184 |
||
185 |
name:aString |
|
186 |
name := aString. |
|
187 |
! |
|
188 |
||
189 |
outputDirectory |
|
190 |
||
191 |
^self class outputDir asFilename |
|
192 |
||
193 |
"Created: / 07-10-2011 / 09:12:49 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
194 |
! ! |
|
195 |
||
196 |
!Report methodsFor:'accessing-command line options'! |
|
197 |
||
198 |
cmdlineOptionFormat |
|
199 |
||
200 |
^CmdLineOption new |
|
201 |
short: $F; |
|
202 |
long: '--format'; |
|
203 |
description: 'Report format to use'; |
|
204 |
action:[:option | self format: option ] |
|
205 |
||
206 |
"Created: / 06-11-2011 / 21:49:12 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
207 |
! |
|
208 |
||
209 |
cmdlineOptionPackage |
|
210 |
||
211 |
^CmdLineOption new |
|
212 |
short: $p; |
|
213 |
long: '--package'; |
|
214 |
description: 'Package in which to run the report'; |
|
81
a433f1944dca
Loads the package if not already loaded.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
76
diff
changeset
|
215 |
action:[:option | |
149
3f9e255e7d47
class: Builder::ReportRunner
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
142
diff
changeset
|
216 |
packages isNil ifTrue:[ packages := Set new ]. |
3f9e255e7d47
class: Builder::ReportRunner
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
142
diff
changeset
|
217 |
packages add: option. |
81
a433f1944dca
Loads the package if not already loaded.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
76
diff
changeset
|
218 |
] |
69 | 219 |
|
220 |
"Created: / 06-11-2011 / 21:49:49 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
149
3f9e255e7d47
class: Builder::ReportRunner
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
142
diff
changeset
|
221 |
"Modified: / 15-05-2013 / 19:02:18 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
69 | 222 |
! ! |
223 |
||
224 |
!Report methodsFor:'accessing-defaults'! |
|
225 |
||
226 |
defaultFileSuffix |
|
227 |
||
228 |
"Return a default filename suffix. Note that format suffix will be |
|
229 |
appended too if not file is explicitely specified" |
|
230 |
||
231 |
^self subclassResponsibility |
|
232 |
||
233 |
"Created: / 04-08-2011 / 12:47:05 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
234 |
! |
|
235 |
||
236 |
defaultFormat |
|
237 |
"raise an error: must be redefined in concrete subclass(es)" |
|
238 |
||
239 |
^ self subclassResponsibility |
|
240 |
! |
|
241 |
||
242 |
defaultName |
|
243 |
||
244 |
^self class name |
|
245 |
||
246 |
"Created: / 07-11-2011 / 09:47:21 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
247 |
! ! |
|
248 |
||
249 |
!Report methodsFor:'initialization'! |
|
250 |
||
251 |
setupForClasses: classes |
|
252 |
"raise an error: must be redefined in concrete subclass(es)" |
|
253 |
||
254 |
^ self subclassResponsibility |
|
255 |
||
256 |
"Created: / 04-08-2011 / 14:34:31 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
257 |
! |
|
258 |
||
259 |
setupForPackages:arg |
|
260 |
"raise an error: must be redefined in concrete subclass(es)" |
|
261 |
||
262 |
^ self subclassResponsibility |
|
263 |
! ! |
|
264 |
||
265 |
!Report methodsFor:'private'! |
|
266 |
||
267 |
convert:arg |
|
268 |
^ self class convert:arg |
|
269 |
! |
|
270 |
||
271 |
encode:arg |
|
272 |
^ self class encode:arg |
|
273 |
! |
|
274 |
||
275 |
encodeFilename:arg |
|
276 |
^ self class encodeFilename:arg |
|
81
a433f1944dca
Loads the package if not already loaded.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
76
diff
changeset
|
277 |
! |
a433f1944dca
Loads the package if not already loaded.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
76
diff
changeset
|
278 |
|
a433f1944dca
Loads the package if not already loaded.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
76
diff
changeset
|
279 |
loadPackageIfNotAlready: pkg |
142 | 280 |
"Loads a package, if it is not loaded already. |
281 |
Raises an error if package cannot be loaded" |
|
81
a433f1944dca
Loads the package if not already loaded.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
76
diff
changeset
|
282 |
|
a433f1944dca
Loads the package if not already loaded.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
76
diff
changeset
|
283 |
| def | |
a433f1944dca
Loads the package if not already loaded.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
76
diff
changeset
|
284 |
def := ProjectDefinition definitionClassForPackage:pkg. |
a433f1944dca
Loads the package if not already loaded.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
76
diff
changeset
|
285 |
def isNil ifTrue:[ |
142 | 286 |
(Smalltalk loadPackage:pkg) ifFalse:[ |
81
a433f1944dca
Loads the package if not already loaded.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
76
diff
changeset
|
287 |
self error:'Cannot load package: ', pkg. |
a433f1944dca
Loads the package if not already loaded.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
76
diff
changeset
|
288 |
]. |
a433f1944dca
Loads the package if not already loaded.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
76
diff
changeset
|
289 |
def := ProjectDefinition definitionClassForPackage:pkg. |
a433f1944dca
Loads the package if not already loaded.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
76
diff
changeset
|
290 |
]. |
a433f1944dca
Loads the package if not already loaded.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
76
diff
changeset
|
291 |
def isNil ifTrue:[ |
142 | 292 |
self error:'Package loaded but project definition not found: ', pkg. |
81
a433f1944dca
Loads the package if not already loaded.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
76
diff
changeset
|
293 |
]. |
a433f1944dca
Loads the package if not already loaded.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
76
diff
changeset
|
294 |
|
a433f1944dca
Loads the package if not already loaded.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
76
diff
changeset
|
295 |
"Created: / 13-01-2012 / 12:56:48 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
69 | 296 |
! ! |
297 |
||
298 |
!Report methodsFor:'running'! |
|
299 |
||
300 |
run |
|
301 |
||
302 |
self setUp. |
|
303 |
format writeHeader. |
|
304 |
[ self runReport ] ensure:[ |
|
305 |
format writeFooter. |
|
306 |
self tearDown. |
|
307 |
] |
|
308 |
||
309 |
"Modified: / 04-08-2011 / 12:42:32 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
310 |
! |
|
311 |
||
312 |
runClasses:classes named:aString |
|
313 |
name := aString. |
|
314 |
self setupForClasses:classes. |
|
315 |
self run |
|
316 |
||
317 |
"Modified: / 04-08-2011 / 14:34:41 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
318 |
! |
|
319 |
||
320 |
runPackage: package |
|
321 |
||
322 |
^self runPackages: (Array with: package) |
|
323 |
||
324 |
"Created: / 04-08-2011 / 12:53:58 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
325 |
! |
|
326 |
||
327 |
runPackages:packages |
|
328 |
packages size == 1 |
|
329 |
ifTrue:[ name := packages anyOne. ] |
|
330 |
ifFalse:[ name := ('%1 packages' bindWith:packages size). ]. |
|
331 |
self setupForPackages:packages. |
|
332 |
^ self run |
|
333 |
||
334 |
" |
|
335 |
HDTestReport runPackage:'stx:goodies/monticello' |
|
336 |
HDTestReport runPackage:'stx:libjava'" |
|
337 |
"Created: / 04-08-2011 / 12:35:32 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
338 |
! |
|
339 |
||
340 |
runReport |
|
341 |
"Actually run the report. What to do (what classes/packages to check) |
|
342 |
must be stored instance variables" |
|
343 |
||
344 |
^ self subclassResponsibility |
|
345 |
||
346 |
"Created: / 04-08-2011 / 12:39:43 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
347 |
! |
|
348 |
||
349 |
setUp |
|
350 |
||
351 |
| stream | |
|
149
3f9e255e7d47
class: Builder::ReportRunner
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
142
diff
changeset
|
352 |
|
3f9e255e7d47
class: Builder::ReportRunner
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
142
diff
changeset
|
353 |
packages notNil ifTrue:[ |
3f9e255e7d47
class: Builder::ReportRunner
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
142
diff
changeset
|
354 |
packages do:[:pkg| self loadPackageIfNotAlready: pkg]. |
3f9e255e7d47
class: Builder::ReportRunner
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
142
diff
changeset
|
355 |
self setupForPackages: packages. |
3f9e255e7d47
class: Builder::ReportRunner
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
142
diff
changeset
|
356 |
packages := nil. |
3f9e255e7d47
class: Builder::ReportRunner
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
142
diff
changeset
|
357 |
]. |
69 | 358 |
format isNil ifTrue:[format := self defaultFormat]. |
359 |
stream := (OutputDir / (self encodeFilename: ('%1-%2.%3' bindWith: self name with: self defaultFileSuffix with: format defaultFileSuffix))) writeStream. |
|
360 |
format report: self stream: stream |
|
361 |
||
362 |
"Created: / 04-08-2011 / 12:43:32 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
149
3f9e255e7d47
class: Builder::ReportRunner
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
142
diff
changeset
|
363 |
"Modified: / 15-05-2013 / 19:03:06 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
69 | 364 |
! |
365 |
||
366 |
tearDown |
|
367 |
||
368 |
format streamFlush; streamClose. |
|
369 |
||
370 |
"Created: / 04-08-2011 / 12:43:40 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
371 |
! ! |
|
372 |
||
373 |
!Report class methodsFor:'documentation'! |
|
374 |
||
375 |
version |
|
376 |
^ '$Header$' |
|
377 |
! |
|
378 |
||
379 |
version_CVS |
|
380 |
^ '$Header$' |
|
381 |
! |
|
382 |
||
383 |
version_SVN |
|
149
3f9e255e7d47
class: Builder::ReportRunner
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
142
diff
changeset
|
384 |
^ '$Id$' |
69 | 385 |
! ! |
386 |
||
142 | 387 |
|
69 | 388 |
Report initialize! |