author | Claus Gittinger <cg@exept.de> |
Fri, 08 May 2015 12:28:56 +0200 | |
changeset 610 | 756214d7dcca |
parent 604 | d9117215a675 |
child 631 | d933b277021f |
permissions | -rw-r--r-- |
509 | 1 |
" |
2 |
COPYRIGHT (c) 2012 by eXept Software AG |
|
3 |
All Rights Reserved |
|
4 |
||
5 |
This software is furnished under a license and may be used |
|
6 |
only in accordance with the terms of that license and with the |
|
7 |
inclusion of the above copyright notice. This software may not |
|
8 |
be provided or otherwise made available to, or used by, any |
|
9 |
other person. No title to or ownership of the software is |
|
10 |
hereby transferred. |
|
11 |
" |
|
12 |
"{ Package: 'stx:goodies/sunit' }" |
|
13 |
||
604 | 14 |
"{ NameSpace: Smalltalk }" |
15 |
||
509 | 16 |
Object subclass:#MetricsReporter |
17 |
instanceVariableNames:'packages stream classMetricNames methodMetricNames |
|
18 |
packageMetricNames' |
|
19 |
classVariableNames:'' |
|
20 |
poolDictionaries:'' |
|
584
aab981776647
Moved to category "SUnit-Smalltalk/X-Report" as it is St/X-specific (and mostly obsolete)
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
568
diff
changeset
|
21 |
category:'SUnit-Smalltalk/X-Report' |
509 | 22 |
! |
23 |
||
24 |
!MetricsReporter class methodsFor:'documentation'! |
|
25 |
||
26 |
copyright |
|
27 |
" |
|
28 |
COPYRIGHT (c) 2012 by eXept Software AG |
|
29 |
All Rights Reserved |
|
30 |
||
31 |
This software is furnished under a license and may be used |
|
32 |
only in accordance with the terms of that license and with the |
|
33 |
inclusion of the above copyright notice. This software may not |
|
34 |
be provided or otherwise made available to, or used by, any |
|
35 |
other person. No title to or ownership of the software is |
|
36 |
hereby transferred. |
|
37 |
||
38 |
" |
|
39 |
! |
|
40 |
||
41 |
documentation |
|
42 |
" |
|
43 |
this is used as a last step in jenkins automated builds. |
|
44 |
||
45 |
Currently supported formats are: |
|
46 |
#xml_metrics - a java metrics compatible format |
|
47 |
||
48 |
[author:] |
|
49 |
Claus Gittinger |
|
50 |
||
51 |
[see also:] |
|
52 |
" |
|
53 |
! |
|
54 |
||
55 |
examples |
|
56 |
" |
|
57 |
[exBegin] |
|
568 | 58 |
String streamContents:[:stream | |
59 |
MetricsReporter |
|
60 |
reportPackages:{ 'stx:libjavascript' } |
|
61 |
format:#xml_metrics |
|
62 |
on:stream. |
|
63 |
]. |
|
64 |
[exEnd] |
|
65 |
[exBegin] |
|
66 |
String streamContents:[:stream | |
|
67 |
MetricsReporter |
|
68 |
reportPackages:{ 'stx:libbasic' } |
|
69 |
format:#xml_metrics |
|
70 |
on:stream. |
|
71 |
]. |
|
72 |
[exEnd] |
|
73 |
[exBegin] |
|
74 |
String streamContents:[:stream | |
|
75 |
MetricsReporter |
|
76 |
reportPackages:{ 'stx:libbasic*' } |
|
77 |
format:#xml_metrics |
|
78 |
on:stream. |
|
79 |
]. |
|
80 |
[exEnd] |
|
81 |
[exBegin] |
|
509 | 82 |
'metrics.xml' asFilename writingFileDo:[:stream | |
568 | 83 |
MetricsReporter |
84 |
reportPackages:{ 'stx:libjavascript' } |
|
85 |
format:#xml_metrics |
|
86 |
on:stream. |
|
509 | 87 |
]. |
88 |
[exEnd] |
|
89 |
||
90 |
[exBegin] |
|
91 |
'metrics.xml' asFilename writingFileDo:[:stream | |
|
92 |
MetricsReporter |
|
93 |
reportPackages: |
|
94 |
{ |
|
95 |
'exept:workflow' |
|
96 |
'exept:expecco' |
|
97 |
'exept:expecco/plugins/*' |
|
98 |
} |
|
99 |
format:#xml_metrics |
|
100 |
on:stream. |
|
101 |
]. |
|
102 |
[exEnd] |
|
522 | 103 |
|
568 | 104 |
package metrics only: |
522 | 105 |
[exBegin] |
106 |
MetricsReporter new |
|
107 |
stream: Transcript; |
|
108 |
packages: |
|
109 |
{ |
|
110 |
'exept:workflow' . |
|
111 |
'exept:expecco' . |
|
112 |
}; |
|
113 |
classMetricNames: #(); |
|
114 |
methodMetricNames: #(); |
|
115 |
packageMetricNames: #( 'LOC' 'NOM' 'NOC'); |
|
116 |
reportXml_metrics. |
|
117 |
[exEnd] |
|
568 | 118 |
[exBegin] |
119 |
MetricsReporter new |
|
120 |
stream: Transcript; |
|
121 |
packages: |
|
122 |
{ |
|
123 |
'stx:libbasic' . |
|
124 |
'stx:libbasic2' . |
|
125 |
'stx:libbasic3' . |
|
126 |
}; |
|
127 |
classMetricNames: #(); |
|
128 |
methodMetricNames: #(); |
|
129 |
packageMetricNames: #( 'LOC' 'NOM' 'NOC'); |
|
130 |
reportXml_metrics. |
|
131 |
[exEnd] |
|
132 |
[exBegin] |
|
133 |
MetricsReporter new |
|
134 |
stream: Transcript; |
|
135 |
packages: |
|
136 |
{ |
|
137 |
'stx:libbasic*' . |
|
138 |
}; |
|
139 |
classMetricNames: #(); |
|
140 |
methodMetricNames: #(); |
|
141 |
packageMetricNames: #( 'LOC' 'NOM' 'NOC'); |
|
142 |
reportXml_metrics. |
|
143 |
[exEnd] |
|
144 |
[exBegin] |
|
145 |
MetricsReporter new |
|
146 |
stream: Transcript; |
|
147 |
packages: |
|
148 |
{ |
|
149 |
'stx:*' . |
|
150 |
}; |
|
151 |
classMetricNames: #(); |
|
152 |
methodMetricNames: #(); |
|
153 |
packageMetricNames: #( 'LOC' 'NOM' 'NOC'); |
|
154 |
reportXml_metrics. |
|
155 |
[exEnd] |
|
509 | 156 |
" |
157 |
! |
|
158 |
||
159 |
format_metrics |
|
160 |
" |
|
161 |
<?xml version=""1.0"" encoding=""UTF-8"" ?> |
|
162 |
||
163 |
<!!ELEMENT metrics (project)* > |
|
164 |
<!!ELEMENT project (name, measurement*, group*) > |
|
165 |
<!!ELEMENT group (name, measurement*, class*) > |
|
166 |
<!!ELEMENT class (name, measurement*, method*) > |
|
167 |
<!!ELEMENT method (name, measurement*) > |
|
168 |
<!!ELEMENT name (#PCDATA) > |
|
169 |
<!!ELEMENT measurement (short-name, long-name, value, (members? | (minimum, median, average, standard-deviation, maximum, sum, nb-data-points))) > |
|
170 |
<!!ELEMENT short-name (#PCDATA) > |
|
171 |
<!!ELEMENT long-name (#PCDATA) > |
|
172 |
<!!ELEMENT value (#PCDATA) > |
|
173 |
<!!ELEMENT members (member*) > |
|
174 |
<!!ELEMENT minimum (#PCDATA) > |
|
175 |
<!!ELEMENT median (#PCDATA) > |
|
176 |
<!!ELEMENT average (#PCDATA) > |
|
177 |
<!!ELEMENT standard-deviation (#PCDATA) > |
|
178 |
<!!ELEMENT maximum (#PCDATA) > |
|
179 |
<!!ELEMENT sum (#PCDATA) > |
|
180 |
<!!ELEMENT nb-data-points (#PCDATA) > |
|
181 |
<!!ELEMENT member (#PCDATA) > |
|
182 |
" |
|
183 |
! ! |
|
184 |
||
185 |
!MetricsReporter class methodsFor:'queries'! |
|
186 |
||
187 |
supportedFormats |
|
188 |
"return a list of formats and short-info-string, as per supported format symbol" |
|
189 |
||
190 |
^ #( |
|
191 |
(#'xml_metrics' 'xml format') |
|
192 |
) |
|
193 |
||
194 |
"Created: / 30-07-2011 / 10:18:18 / cg" |
|
195 |
! ! |
|
196 |
||
197 |
!MetricsReporter class methodsFor:'reporting'! |
|
198 |
||
199 |
reportPackages: aCollectionOfPackages format: format on: stream |
|
200 |
self new |
|
201 |
reportPackages: aCollectionOfPackages format: format on: stream |
|
202 |
! ! |
|
203 |
||
204 |
!MetricsReporter methodsFor:'accessing'! |
|
205 |
||
206 |
classMetricNames |
|
520 | 207 |
^ classMetricNames ? #( 'NOM' 'LOC' ) |
509 | 208 |
! |
209 |
||
521 | 210 |
classMetricNames:something |
211 |
classMetricNames := something. |
|
212 |
! |
|
213 |
||
509 | 214 |
methodMetricNames |
215 |
^ methodMetricNames ? #( "'LOC'" ) |
|
216 |
! |
|
217 |
||
521 | 218 |
methodMetricNames:something |
219 |
methodMetricNames := something. |
|
220 |
! |
|
221 |
||
509 | 222 |
packageMetricNames |
223 |
^ packageMetricNames ? #( 'LOC' ) |
|
224 |
! |
|
225 |
||
521 | 226 |
packageMetricNames:something |
227 |
packageMetricNames := something. |
|
228 |
! |
|
229 |
||
509 | 230 |
packages:something |
231 |
packages := something. |
|
232 |
! |
|
233 |
||
234 |
stream:something |
|
235 |
stream := something. |
|
236 |
! ! |
|
237 |
||
238 |
!MetricsReporter methodsFor:'metric generation'! |
|
239 |
||
240 |
classMetricValue:metricName for:aClass |
|
241 |
|metric| |
|
242 |
||
243 |
metric := OOM::ClassMetrics type:metricName for:aClass. |
|
244 |
^ self metricInfoFor:metric |
|
245 |
! |
|
246 |
||
247 |
methodMetricValue:metricName for:aMethod |
|
248 |
|metric| |
|
249 |
||
250 |
metric := OOM::MethodMetrics type:metricName for:aMethod. |
|
251 |
^ self metricInfoFor:metric |
|
252 |
! |
|
253 |
||
254 |
metricInfoFor:metric |
|
255 |
^ { metric class shortName . metric class descriptiveName . metric metricValue } |
|
256 |
! |
|
257 |
||
568 | 258 |
packageMetricValue:metricName for:aPackageIDOrPattern |
259 |
|overAllInfo| |
|
260 |
||
261 |
aPackageIDOrPattern includesMatchCharacters ifTrue:[ |
|
262 |
Smalltalk allProjectIDs do:[:eachPackageID | |
|
263 |
|thisInfo| |
|
509 | 264 |
|
568 | 265 |
(eachPackageID matches:aPackageIDOrPattern) ifTrue:[ |
266 |
thisInfo := self metricInfoFor:(OOM::PackageMetrics type:metricName for:eachPackageID). |
|
267 |
overAllInfo isNil ifTrue:[ |
|
268 |
overAllInfo := thisInfo |
|
269 |
] ifFalse:[ |
|
270 |
"/ kludge: only works with accumulative metrics (i.e. not with averages etc.) |
|
271 |
overAllInfo at:(overAllInfo size) put:(overAllInfo last + thisInfo last). |
|
272 |
]. |
|
273 |
]. |
|
274 |
]. |
|
275 |
^ overAllInfo |
|
276 |
] ifFalse:[ |
|
277 |
^ self metricInfoFor:(OOM::PackageMetrics type:metricName for:aPackageIDOrPattern). |
|
278 |
]. |
|
509 | 279 |
! ! |
280 |
||
281 |
!MetricsReporter methodsFor:'reporting'! |
|
282 |
||
283 |
reportPackages: aCollectionOfPackages format: aSymbol on: aStream |
|
284 |
||
285 |
packages := aCollectionOfPackages. |
|
286 |
stream := aStream. |
|
287 |
self report: aSymbol |
|
288 |
! ! |
|
289 |
||
290 |
!MetricsReporter methodsFor:'reporting - xml-metrics'! |
|
291 |
||
292 |
generateClassMetricsFor:aClass |
|
293 |
^ self classMetricNames collect:[:metricName | |
|
294 |
self classMetricValue:metricName for:aClass. |
|
295 |
]. |
|
296 |
! |
|
297 |
||
298 |
generateMethodMetricsFor:aMethod |
|
299 |
^ self methodMetricNames collect:[:metricName | |
|
300 |
self methodMetricValue:metricName for:aMethod. |
|
301 |
]. |
|
302 |
! |
|
303 |
||
568 | 304 |
generatePackageMetricsFor:aPackageIDOrPattern |
509 | 305 |
^ self packageMetricNames collect:[:metricName | |
568 | 306 |
self packageMetricValue:metricName for:aPackageIDOrPattern. |
509 | 307 |
]. |
308 |
! |
|
309 |
||
310 |
reportXml_metricValues:metricValues |
|
311 |
|metricShortName metricLongName metricValue| |
|
312 |
||
313 |
metricValues do:[:eachTuple | |
|
314 |
metricShortName := eachTuple first. |
|
315 |
metricLongName := eachTuple second. |
|
316 |
metricValue := eachTuple third. |
|
317 |
||
318 |
stream nextPutLine: ' <measurement>'. |
|
319 |
stream nextPutLine: (' <short-name>%1</short-name>' bindWith:metricShortName). |
|
320 |
stream nextPutLine: (' <long-name>%1</long-name>' bindWith:metricLongName). |
|
321 |
stream nextPutLine: (' <value>%1</value>' bindWith:metricValue). |
|
322 |
stream nextPutLine: ' </measurement>'. |
|
323 |
] |
|
324 |
! |
|
325 |
||
326 |
reportXml_metrics |
|
327 |
" |
|
328 |
self new |
|
329 |
stream:Transcript; |
|
330 |
packages:#( 'exept:workflow' ); |
|
331 |
reportXml_metrics |
|
332 |
" |
|
333 |
||
568 | 334 |
"/ need the exept-metrics package |
586 | 335 |
Smalltalk loadPackage:'exept:programming/oom'. |
509 | 336 |
|
337 |
stream nextPutLine: '<?xml version="1.0"?>'; |
|
338 |
nextPutLine: '<metrics>'. |
|
339 |
||
340 |
packages do:[:eachPackageID | |
|
568 | 341 |
"/ if the package is a matchPattern, generate metrics for all loaded packages |
342 |
"/ which match that pattern. |
|
343 |
"/ Otherwise, make sure that this package is loaded and generate metrics for that |
|
344 |
"/ one only. |
|
345 |
eachPackageID includesMatchCharacters ifFalse:[ |
|
346 |
Smalltalk loadPackage:eachPackageID. |
|
347 |
]. |
|
509 | 348 |
self reportXml_metricsForPackage:eachPackageID |
349 |
]. |
|
350 |
stream nextPutLine: '</metrics>'. |
|
351 |
! |
|
352 |
||
353 |
reportXml_metricsForClass:aClass |
|
354 |
stream nextPutLine: ' <class>'. |
|
355 |
stream nextPutLine: (' <name>%1</name>' bindWith:aClass name). |
|
356 |
||
357 |
self methodMetricNames notEmptyOrNil ifTrue:[ |
|
358 |
aClass instAndClassMethodsDo:[:eachMethod | |
|
359 |
self reportXml_metricsForMethod:eachMethod |
|
360 |
]. |
|
361 |
]. |
|
362 |
||
519 | 363 |
self classMetricNames notEmptyOrNil ifTrue:[ |
364 |
self reportXml_metricValues:(self generateClassMetricsFor:aClass). |
|
365 |
]. |
|
366 |
||
509 | 367 |
stream nextPutLine: ' </class>'. |
368 |
! |
|
369 |
||
370 |
reportXml_metricsForMethod:aMethod |
|
371 |
stream nextPutLine: ' <method>'. |
|
372 |
stream nextPutLine:(' <name>%1</name>' bindWith:aMethod selector). |
|
373 |
||
374 |
self reportXml_metricValues:(self generateMethodMetricsFor:aMethod). |
|
375 |
||
376 |
stream nextPutLine: ' </method>'. |
|
377 |
! |
|
378 |
||
568 | 379 |
reportXml_metricsForPackage:aPackageIDOrPattern |
380 |
|genMetricsForClass| |
|
381 |
||
382 |
genMetricsForClass := |
|
383 |
[:aClass | |
|
384 |
Autoload autoloadFailedSignal handle:[:ex | |
|
385 |
] do:[ |
|
386 |
aClass autoload. |
|
387 |
self reportXml_metricsForClass:aClass |
|
388 |
] |
|
389 |
]. |
|
390 |
||
509 | 391 |
stream nextPutLine: ' <project>'. |
568 | 392 |
stream nextPutLine: (' <name>%1</name>' bindWith:aPackageIDOrPattern). |
509 | 393 |
|
394 |
(self classMetricNames notEmptyOrNil |
|
395 |
or:[self methodMetricNames notEmptyOrNil]) ifTrue:[ |
|
568 | 396 |
aPackageIDOrPattern includesMatchCharacters ifTrue:[ |
397 |
Smalltalk allClasses do:[:eachClass | |
|
398 |
(eachClass package matches:aPackageIDOrPattern) iftrue:[ |
|
399 |
genMetricsForClass value:eachClass |
|
400 |
]. |
|
509 | 401 |
]. |
568 | 402 |
] ifFalse:[ |
403 |
Smalltalk allClassesInPackage:aPackageIDOrPattern do:genMetricsForClass. |
|
509 | 404 |
]. |
405 |
]. |
|
406 |
||
568 | 407 |
self reportXml_metricValues:(self generatePackageMetricsFor:aPackageIDOrPattern). |
519 | 408 |
|
509 | 409 |
stream nextPutLine: ' </project>'. |
410 |
! ! |
|
411 |
||
412 |
!MetricsReporter methodsFor:'reporting-private'! |
|
413 |
||
414 |
report:formatSymbol |
|
415 |
"currently supported formatSymbols: |
|
568 | 416 |
xml_metrics" |
509 | 417 |
|
418 |
|reportFormatSelector| |
|
419 |
||
420 |
reportFormatSelector := self reportFormatSelector:formatSymbol. |
|
421 |
(self respondsTo: reportFormatSelector) |
|
422 |
ifTrue:[self perform: reportFormatSelector] |
|
423 |
ifFalse:[self error:'Unsupported format: ', formatSymbol]. |
|
424 |
||
425 |
"Modified (comment): / 03-08-2011 / 12:57:54 / cg" |
|
426 |
! |
|
427 |
||
428 |
reportFormatSelector:format |
|
604 | 429 |
^ ('report' , format asString asUppercaseFirst) asSymbol |
509 | 430 |
! ! |
431 |
||
432 |
!MetricsReporter class methodsFor:'documentation'! |
|
433 |
||
434 |
version |
|
604 | 435 |
^ '$Header: /cvs/stx/stx/goodies/sunit/MetricsReporter.st,v 1.9 2015-02-18 15:05:18 cg Exp $' |
509 | 436 |
! |
437 |
||
438 |
version_CVS |
|
604 | 439 |
^ '$Header: /cvs/stx/stx/goodies/sunit/MetricsReporter.st,v 1.9 2015-02-18 15:05:18 cg Exp $' |
509 | 440 |
! ! |
568 | 441 |