/
recidiv.tcl
executable file
·332 lines (299 loc) · 10.7 KB
/
recidiv.tcl
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
#!/usr/bin/env tclsh8.5
package require html
package require smtp
package require mime
################################################################################
# Configuration
################################################################################
if {[llength $argv]} {
set ::configfile [lindex $argv 0]
} else {
puts stderr "Usage: recidiv <config-file>"
exit 1
}
# Create the procedures to set the configuration parameters.
foreach {directive defval} {
notify.from ci@test.org
notify.to {}
history.len 1024
datafile /tmp/recidiv.data
webroot /tmp/
whitelist {}
template {<html><body>%content</body></html>}
notify.every.failure 0
smtp.server 127.0.0.1
wait.after.every.test 0
web.index.show.latest 15
web.index.show.latest.err 5
} {
proc $directive val "set ::$directive \$val"
set $directive $defval
}
# The 'test' procedure is used in order to setup a new CI test.
proc test {name steps {options ""}} {
set options_dict {}
foreach option [split $options "\r\n"] {
if {[llength $option] == 0} continue
dict set options_dict [lindex $option 0] [lrange $option 1 end]
}
lappend ::tests [list $name $steps $options_dict]
}
################################################################################
# Running the tests.
################################################################################
source $::configfile
set ::test_id 0
proc ci_error {stage msg} {
set ::err [list $stage $msg]
puts "### ERROR in stage '$stage': $msg"
}
proc ci_exec_command cmd {
puts "++ $cmd"
set ignore_error 0
if {[string index $cmd 0] eq {!}} {
set cmd [string range $cmd 1 end-1]
set ignore_error 1
}
if {[catch {
if {[lindex $cmd 0] eq {cd}} {
cd [lindex $cmd 1]
set output "Working dir is now '[lindex $cmd 1]'\n"
} else {
set output [exec -ignorestderr {*}$cmd 2>@1]
}
} e]} {
if {$ignore_error} {
set output $e
} else {
ci_error $cmd $e
set output {}
}
}
return $output
}
################################################################################
# Data persistence. We just use the fact that in Tcl everything is a string...
################################################################################
proc save_data {} {
set data {}
foreach test $::tests {
lassign $test name commands options
if {[info exists ::history_$name]} {
lappend data ::history_$name [set ::history_$name]
}
}
lappend data ::test_id [set ::test_id]
set fd [open $::datafile w]
puts -nonewline $fd $data
close $fd
}
proc load_data {} {
if {![file readable $::datafile]} return
set fd [open $::datafile]
set data [read $fd]
close $fd
foreach {var val} $data {
set $var $val
}
}
################################################################################
# History
################################################################################
# Returns the UNIX time of the last exection of the specified test, or
# 0 if the test was never executed before.
proc last_execution_time name {
if {![info exists ::history_$name]} {return 0}
set h [set ::history_$name]
set last [lindex $h end]
lassign $last status id time name tag err output
return $time
}
proc history_add {name status id time tag err output} {
lappend ::history_$name [list $status $id $time $name $tag $err $output]
set ::history_$name [lrange [set ::history_$name] \
end-[expr {[set ::history.len]-1}] end]
}
################################################################################
# HTML generation
################################################################################
# Alias for html entitites.
proc e s {html::html_entities $s}
# Write an HTML file using the global HTML template.
proc write_html {file body} {
set html [string map [list %content% $body] $::template]
set fd [open $file w]
puts -nonewline $fd $html
close $fd
}
# Render commands output to HTML.
proc output-to-html o {
set e [e $o]
regsub -all "\n(@\[^\n\]+)\n" $o "\n</pre><h3>\\1</h3><pre>\n"
}
# Create the detail page, the one of a specific test run.
proc update_detail_page item {
set content {}
foreach {status id time branch tag err fulloutput} $item break
if {[file exists [file join $::webroot run_$id.html]]} return
append content "<div class=\"rundetails\">"
append content "<h2>Details for run #$id (<span class=\"status_$status\">$status</span>)</h2>\n"
append content "<h3>$branch ($tag)</h3>\n"
append content "<h4>[clock format $time]</h4>\n"
if {$status eq {ok}} {
append content "<pre class=\"okpre\">[output-to-html $fulloutput]</pre>\n"
} else {
append content "<div class=\"errorcmd\">Error in: [lindex $err 0]</div>\n<pre class=\"okpre\">[output-to-html $fulloutput]</pre>\n<pre class=\"errpre\">[output-to-html [lindex $err 1]]</pre>\n"
}
append content "</div>"
write_html [file join $::webroot run_$id.html] $content
}
proc latest_runs_to_html {name count status_pattern} {
set h [set ::history_$name]
set c 0
set content {}
for {set j 0} {$j < [llength $h]} {incr j} {
if {$c == $count} break
set item [lindex $h end-$j]
if {$item eq {}} break
foreach {status id time name tag} $item break
if {[string match -nocase $status_pattern $status]} {
append content "<li><a href=\"run_$id.html\">#$id</a> \[<span class=\"status_$status\">$status</span>\] $name ($tag) -- [clock format $time]</li>\n"
update_detail_page $item
incr c
}
}
if {$c == 0} {
append content "No items."
}
return $content
}
# Create the index.html file in the web site, and triggers the generation
# of all the details pages.
proc update_site {} {
set content {}
foreach test $::tests {
lassign $test name commands options
if {[info exists ::history_$name]} {
append content "<h2>$name</h2>\n<ul>\n"
append content [latest_runs_to_html $name [set ::web.index.show.latest] *]
append content "</ul>\n"
set latesterr [latest_runs_to_html $name [set ::web.index.show.latest.err] err]
if {$latesterr ne {}} {
append content "<h3>latest errors</h3>\n<ul>\n"
append content $latesterr
append content "</ul>\n"
}
}
}
write_html [file join $::webroot index.html] $content
}
# Print some history information when the CI is executed.
# Just as a way to say "Welcome, you are running the right thing".
proc print_history_info {} {
foreach test $::tests {
lassign $test name commands options
if {[info exists ::history_$name]} {
puts "$name:"
flush stdout
foreach item [lrange [set ::history_$name] end-4 end] {
foreach {status id time branch tag} $item break
puts "#$id \[$status\] $branch ($tag) -- [clock format $time]"
}
}
puts {}
}
}
################################################################################
# Email notifications
################################################################################
proc send_email_message {from recipient email_server subject body} {
set token [mime::initialize -canonical text/plain -string $body]
mime::setheader $token From $from
mime::setheader $token To $recipient
mime::setheader $token Subject $subject
smtp::sendmessage $token \
-originator $from -recipients $recipient -servers $email_server
mime::finalize $token
}
proc handle_notifications name {
set notify 0
set h [set ::history_$name]
set curr [lindex $h end]
set prev [lindex $h end-1]
foreach {status id time name tag err output} $curr break
if {$status eq {err}} {
if {[set ::notify.every.failure] || $prev eq {} ||
[lindex $prev 0] ne {err}} {
set notify 1
}
} else {
if {$prev ne {} && [lindex $prev 0] eq {err}} {
set notify 1
}
}
# Send email notifications
if {$notify} {
foreach to [set ::notify.to] {
puts "\[\\/\] send notification to $to"
set subject "\[recidiv run $id\] $name [string toupper $status]"
set body "Details below:\n$output\nIn [lindex $err 0]:\n\n[lindex $err 1]"
if {[catch {
send_email_message [set ::notify.from] $to [set ::smtp.server] $subject $body
} e]} {
puts "Warning: problems sending email: $e"
}
}
}
}
################################################################################
# Main!
################################################################################
# Start the CI. Load data, Update the site (just in case you removed it),
# Print the history information, and run tests forever.
load_data
update_site
print_history_info
while 1 {
foreach test $::tests {
lassign $test name commands options
set ::err {}
set tag {???}
set fulloutput {}
# Handle the 'run.minimal.period <seconds>' option, not executing the
# test if it was already executed less than <seconds> seconds ago.
if {[dict exists $options run.minimal.period]} {
set minperiod [lindex [dict get $options run.minimal.period] 0]
set lastexec [last_execution_time $name]
if {[clock seconds]-$lastexec < $minperiod} continue
}
puts "======== Testing '$name'"
foreach cmd $commands {
append fulloutput "\n@$cmd\n" [ci_exec_command $cmd]
if {$::err ne {}} break
}
# If it is a git repository we try to extract the SHA of the version
# we are testing in order to provide more information.
catch {
if {[file exists .git]} {
set gitlog [exec -ignorestderr git log --oneline 2>@1]
set tag [lindex [split $gitlog] 0]
}
}
# Save this run in history.
incr ::test_id
if {$::err ne {}} {
puts "!!! Error for '$name'"
history_add $name err $::test_id [clock seconds] $tag $::err $fulloutput
} else {
puts "Test successful for 'name'"
history_add $name ok $::test_id [clock seconds] $tag {} $fulloutput
}
handle_notifications $name
save_data
puts -nonewline "Updating web site... "
flush stdout
update_site
puts "done\n"
after [expr {[set ::wait.after.every.test]*1000}]
}
}