* [PATCH v3 0/4] ktest: add email support
@ 2018-04-06 22:17 Tim Tianyang Chen
2018-04-06 22:17 ` [PATCH v3 1/4] " Tim Tianyang Chen
` (3 more replies)
0 siblings, 4 replies; 6+ messages in thread
From: Tim Tianyang Chen @ 2018-04-06 22:17 UTC (permalink / raw)
To: rostedt; +Cc: linux-kernel, dhaval.giani, tim.tianyang.chen, Tim Tianyang Chen
This patch set will let users define a mailer, an email address and when to receive
notifications during automated testings. Users need to setup the specified mailer
prior to using this feature.
Tim Tianyang Chen (4):
ktest: add email support
ktest: add SigInt handling
ktest: use dodie for critical falures
ktest: add email options to sample.config
tools/testing/ktest/ktest.pl | 125 ++++++++++++++++++++++++++++++----------
tools/testing/ktest/sample.conf | 22 +++++++
2 files changed, 117 insertions(+), 30 deletions(-)
--
1.8.3.1
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH v3 1/4] ktest: add email support
2018-04-06 22:17 [PATCH v3 0/4] ktest: add email support Tim Tianyang Chen
@ 2018-04-06 22:17 ` Tim Tianyang Chen
2018-04-06 22:17 ` [PATCH v3 2/4] ktest: add SigInt handling Tim Tianyang Chen
` (2 subsequent siblings)
3 siblings, 0 replies; 6+ messages in thread
From: Tim Tianyang Chen @ 2018-04-06 22:17 UTC (permalink / raw)
To: rostedt; +Cc: linux-kernel, dhaval.giani, tim.tianyang.chen, Tim Tianyang Chen
Users can define optional variables to get email notifications.
Ktest can send emails when the script:
* was started
* failed with fatal errors and called dodie()
* completed all testing
Users have to setup the mailer provided in config prior to using this script.
Supported mailers: mailx, mail, sendmail
mailer specific routines are _sendmail_send(), _mailx_send()
Suggested-by: Dhaval Giani <dhaval.giani@oracle.com>
Signed-off-by: Tim Tianyang Chen <tianyang.chen@oracle.com>
---
tools/testing/ktest/ktest.pl | 61 +++++++++++++++++++++++++++++++++++++++++---
1 file changed, 58 insertions(+), 3 deletions(-)
diff --git a/tools/testing/ktest/ktest.pl b/tools/testing/ktest/ktest.pl
index 8809f244bb7c..a9a6318b1395 100755
--- a/tools/testing/ktest/ktest.pl
+++ b/tools/testing/ktest/ktest.pl
@@ -22,6 +22,11 @@ my %evals;
#default opts
my %default = (
+ "MAILER" => "sendmail", # default mailer
+ "EMAIL_ON_ERROR" => 1,
+ "EMAIL_WHEN_FINISHED" => 1,
+ "EMAIL_WHEN_CANCELED" => 0,
+ "EMAIL_WHEN_STARTED" => 0,
"NUM_TESTS" => 1,
"TEST_TYPE" => "build",
"BUILD_TYPE" => "randconfig",
@@ -204,6 +209,15 @@ my $install_time;
my $reboot_time;
my $test_time;
+my $mailto;
+my $mailer;
+my $email_on_error;
+my $email_when_finished;
+my $email_when_started;
+my $email_when_canceled;
+
+my $script_start_time = localtime();
+
# set when a test is something other that just building or install
# which would require more options.
my $buildonly = 1;
@@ -229,6 +243,12 @@ my $no_reboot = 1;
my $reboot_success = 0;
my %option_map = (
+ "MAILTO" => \$mailto,
+ "MAILER" => \$mailer,
+ "EMAIL_ON_ERROR" => \$email_on_error,
+ "EMAIL_WHEN_FINISHED" => \$email_when_finished,
+ "EMAIL_WHEN_STARTED" => \$email_when_started,
+ "EMAIL_WHEN_CANCELED" => \$email_when_canceled,
"MACHINE" => \$machine,
"SSH_USER" => \$ssh_user,
"TMP_DIR" => \$tmpdir,
@@ -1426,6 +1446,11 @@ sub dodie {
print " See $opt{LOG_FILE} for more info.\n";
}
+ if ($email_on_error) {
+ send_email("KTEST: critical failure for your [$test_type] test",
+ "Your test started at $script_start_time has failed with:\n@_\n");
+ }
+
if ($monitor_cnt) {
# restore terminal settings
system("stty $stty_orig");
@@ -4222,6 +4247,26 @@ sub set_test_option {
return eval_option($name, $option, $i);
}
+sub _mailx_send {
+ my ($subject, $message) = @_;
+ system("$mailer -s \'$subject\' $mailto <<< \'$message\'");
+}
+
+sub _sendmail_send {
+ my ($subject, $message) = @_;
+ system("echo -e \"Subject: $subject\n\n$message\" | sendmail -t $mailto");
+}
+
+sub send_email {
+ if (defined($mailto) && defined($mailer)) {
+ if ($mailer eq "mail" || $mailer eq "mailx"){ _mailx_send(@_);}
+ elsif ($mailer eq "sendmail" ) { _sendmail_send(@_);}
+ else { doprint "\nYour mailer: $mailer is not supported.\n" }
+ } else {
+ print "No email sent: email or mailer not specified in config.\n"
+ }
+}
+
# First we need to do is the builds
for (my $i = 1; $i <= $opt{"NUM_TESTS"}; $i++) {
@@ -4262,9 +4307,15 @@ for (my $i = 1; $i <= $opt{"NUM_TESTS"}; $i++) {
$start_minconfig_defined = 1;
# The first test may override the PRE_KTEST option
- if (defined($pre_ktest) && $i == 1) {
- doprint "\n";
- run_command $pre_ktest;
+ if ($i == 1) {
+ if (defined($pre_ktest)) {
+ doprint "\n";
+ run_command $pre_ktest;
+ }
+ if ($email_when_started) {
+ send_email("KTEST: Your [$test_type] test was started",
+ "Your test was started on $script_start_time");
+ }
}
# Any test can override the POST_KTEST option
@@ -4428,4 +4479,8 @@ if ($opt{"POWEROFF_ON_SUCCESS"}) {
doprint "\n $successes of $opt{NUM_TESTS} tests were successful\n\n";
+if ($email_when_finished) {
+ send_email("KTEST: Your [$test_type] test has finished!",
+ "$successes of $opt{NUM_TESTS} tests started at $script_start_time were successful!");
+}
exit 0;
--
1.8.3.1
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [PATCH v3 2/4] ktest: add SigInt handling
2018-04-06 22:17 [PATCH v3 0/4] ktest: add email support Tim Tianyang Chen
2018-04-06 22:17 ` [PATCH v3 1/4] " Tim Tianyang Chen
@ 2018-04-06 22:17 ` Tim Tianyang Chen
2018-04-06 22:17 ` [PATCH v3 3/4] ktest: use dodie for critical falures Tim Tianyang Chen
2018-04-06 22:17 ` [PATCH v3 4/4] ktest: add email options to sample.config Tim Tianyang Chen
3 siblings, 0 replies; 6+ messages in thread
From: Tim Tianyang Chen @ 2018-04-06 22:17 UTC (permalink / raw)
To: rostedt; +Cc: linux-kernel, dhaval.giani, tim.tianyang.chen, Tim Tianyang Chen
User can cancel tests and specify handler's behavior using option
'EMAIL_WHEN_CANCELED'.
Suggested-by: Dhaval Giani <dhaval.giani@oracle.com>
Signed-off-by: Tim Tianyang Chen <tianyang.chen@oracle.com>
---
tools/testing/ktest/ktest.pl | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/tools/testing/ktest/ktest.pl b/tools/testing/ktest/ktest.pl
index a9a6318b1395..b0db4a6d3e97 100755
--- a/tools/testing/ktest/ktest.pl
+++ b/tools/testing/ktest/ktest.pl
@@ -4267,6 +4267,16 @@ sub send_email {
}
}
+sub cancel_test {
+ if ($email_when_canceled) {
+ send_email("KTEST: Your [$test_type] test was cancelled",
+ "Your test started at $script_start_time was cancelled: sig int");
+ }
+ die "\nCaught Sig Int, test interrupted: $!\n"
+}
+
+$SIG{INT} = qw(cancel_test);
+
# First we need to do is the builds
for (my $i = 1; $i <= $opt{"NUM_TESTS"}; $i++) {
--
1.8.3.1
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [PATCH v3 3/4] ktest: use dodie for critical falures
2018-04-06 22:17 [PATCH v3 0/4] ktest: add email support Tim Tianyang Chen
2018-04-06 22:17 ` [PATCH v3 1/4] " Tim Tianyang Chen
2018-04-06 22:17 ` [PATCH v3 2/4] ktest: add SigInt handling Tim Tianyang Chen
@ 2018-04-06 22:17 ` Tim Tianyang Chen
2018-04-06 22:17 ` [PATCH v3 4/4] ktest: add email options to sample.config Tim Tianyang Chen
3 siblings, 0 replies; 6+ messages in thread
From: Tim Tianyang Chen @ 2018-04-06 22:17 UTC (permalink / raw)
To: rostedt; +Cc: linux-kernel, dhaval.giani, tim.tianyang.chen, Tim Tianyang Chen
Users should get emails when the script dies because of a critical failure. Critical
failures are defined as any errors that could abnormally terminate the script.
In order to add email support, this patch converts all die() to dodie() except:
* when '-v' is used as an option to get the version of the script.
* in Sig-Int handeler because it's not a fatal error to cancel the script.
* errors happen during parsing config
Suggested-by: Dhaval Giani <dhaval.giani@oracle.com>
Signed-off-by: Tim Tianyang Chen <tianyang.chen@oracle.com>
---
tools/testing/ktest/ktest.pl | 54 ++++++++++++++++++++++----------------------
1 file changed, 27 insertions(+), 27 deletions(-)
diff --git a/tools/testing/ktest/ktest.pl b/tools/testing/ktest/ktest.pl
index b0db4a6d3e97..21cdb8152ef6 100755
--- a/tools/testing/ktest/ktest.pl
+++ b/tools/testing/ktest/ktest.pl
@@ -1502,7 +1502,7 @@ sub exec_console {
close($pts);
exec $console or
- die "Can't open console $console";
+ dodie "Can't open console $console";
}
sub open_console {
@@ -1650,7 +1650,7 @@ sub save_logs {
if (!-d $dir) {
mkpath($dir) or
- die "can't create $dir";
+ dodie "can't create $dir";
}
my %files = (
@@ -1663,7 +1663,7 @@ sub save_logs {
while (my ($name, $source) = each(%files)) {
if (-f "$source") {
cp "$source", "$dir/$name" or
- die "failed to copy $source";
+ dodie "failed to copy $source";
}
}
@@ -1837,7 +1837,7 @@ sub get_grub2_index {
$ssh_grub =~ s,\$SSH_COMMAND,cat $grub_file,g;
open(IN, "$ssh_grub |")
- or die "unable to get $grub_file";
+ or dodie "unable to get $grub_file";
my $found = 0;
@@ -1852,7 +1852,7 @@ sub get_grub2_index {
}
close(IN);
- die "Could not find '$grub_menu' in $grub_file on $machine"
+ dodie "Could not find '$grub_menu' in $grub_file on $machine"
if (!$found);
doprint "$grub_number\n";
$last_grub_menu = $grub_menu;
@@ -1880,7 +1880,7 @@ sub get_grub_index {
$ssh_grub =~ s,\$SSH_COMMAND,cat /boot/grub/menu.lst,g;
open(IN, "$ssh_grub |")
- or die "unable to get menu.lst";
+ or dodie "unable to get menu.lst";
my $found = 0;
@@ -1895,7 +1895,7 @@ sub get_grub_index {
}
close(IN);
- die "Could not find '$grub_menu' in /boot/grub/menu on $machine"
+ dodie "Could not find '$grub_menu' in /boot/grub/menu on $machine"
if (!$found);
doprint "$grub_number\n";
$last_grub_menu = $grub_menu;
@@ -2008,7 +2008,7 @@ sub monitor {
my $full_line = "";
open(DMESG, "> $dmesg") or
- die "unable to write to $dmesg";
+ dodie "unable to write to $dmesg";
reboot_to;
@@ -2887,7 +2887,7 @@ sub run_bisect {
sub update_bisect_replay {
my $tmp_log = "$tmpdir/ktest_bisect_log";
run_command "git bisect log > $tmp_log" or
- die "can't create bisect log";
+ dodie "can't create bisect log";
return $tmp_log;
}
@@ -2896,9 +2896,9 @@ sub bisect {
my $result;
- die "BISECT_GOOD[$i] not defined\n" if (!defined($bisect_good));
- die "BISECT_BAD[$i] not defined\n" if (!defined($bisect_bad));
- die "BISECT_TYPE[$i] not defined\n" if (!defined($bisect_type));
+ dodie "BISECT_GOOD[$i] not defined\n" if (!defined($bisect_good));
+ dodie "BISECT_BAD[$i] not defined\n" if (!defined($bisect_bad));
+ dodie "BISECT_TYPE[$i] not defined\n" if (!defined($bisect_type));
my $good = $bisect_good;
my $bad = $bisect_bad;
@@ -2961,7 +2961,7 @@ sub bisect {
if ($check ne "good") {
doprint "TESTING BISECT BAD [$bad]\n";
run_command "git checkout $bad" or
- die "Failed to checkout $bad";
+ dodie "Failed to checkout $bad";
$result = run_bisect $type;
@@ -2973,7 +2973,7 @@ sub bisect {
if ($check ne "bad") {
doprint "TESTING BISECT GOOD [$good]\n";
run_command "git checkout $good" or
- die "Failed to checkout $good";
+ dodie "Failed to checkout $good";
$result = run_bisect $type;
@@ -2984,7 +2984,7 @@ sub bisect {
# checkout where we started
run_command "git checkout $head" or
- die "Failed to checkout $head";
+ dodie "Failed to checkout $head";
}
run_command "git bisect start$start_files" or
@@ -3441,9 +3441,9 @@ sub patchcheck_reboot {
sub patchcheck {
my ($i) = @_;
- die "PATCHCHECK_START[$i] not defined\n"
+ dodie "PATCHCHECK_START[$i] not defined\n"
if (!defined($patchcheck_start));
- die "PATCHCHECK_TYPE[$i] not defined\n"
+ dodie "PATCHCHECK_TYPE[$i] not defined\n"
if (!defined($patchcheck_type));
my $start = $patchcheck_start;
@@ -3457,7 +3457,7 @@ sub patchcheck {
if (defined($patchcheck_end)) {
$end = $patchcheck_end;
} elsif ($cherry) {
- die "PATCHCHECK_END must be defined with PATCHCHECK_CHERRY\n";
+ dodie "PATCHCHECK_END must be defined with PATCHCHECK_CHERRY\n";
}
# Get the true sha1's since we can use things like HEAD~3
@@ -3521,7 +3521,7 @@ sub patchcheck {
doprint "\nProcessing commit \"$item\"\n\n";
run_command "git checkout $sha1" or
- die "Failed to checkout $sha1";
+ dodie "Failed to checkout $sha1";
# only clean on the first and last patch
if ($item eq $list[0] ||
@@ -3612,7 +3612,7 @@ sub read_kconfig {
}
open(KIN, "$kconfig")
- or die "Can't open $kconfig";
+ or dodie "Can't open $kconfig";
while (<KIN>) {
chomp;
@@ -3771,7 +3771,7 @@ sub get_depends {
$dep =~ s/^[^$valid]*[$valid]+//;
} else {
- die "this should never happen";
+ dodie "this should never happen";
}
}
@@ -4032,7 +4032,7 @@ sub make_min_config {
# update new ignore configs
if (defined($ignore_config)) {
open (OUT, ">$temp_config")
- or die "Can't write to $temp_config";
+ or dodie "Can't write to $temp_config";
foreach my $config (keys %save_configs) {
print OUT "$save_configs{$config}\n";
}
@@ -4060,7 +4060,7 @@ sub make_min_config {
# Save off all the current mandatory configs
open (OUT, ">$temp_config")
- or die "Can't write to $temp_config";
+ or dodie "Can't write to $temp_config";
foreach my $config (keys %keep_configs) {
print OUT "$keep_configs{$config}\n";
}
@@ -4300,11 +4300,11 @@ for (my $i = 1; $i <= $opt{"NUM_TESTS"}; $i++) {
$outputdir = set_test_option("OUTPUT_DIR", $i);
$builddir = set_test_option("BUILD_DIR", $i);
- chdir $builddir || die "can't change directory to $builddir";
+ chdir $builddir || dodie "can't change directory to $builddir";
if (!-d $outputdir) {
mkpath($outputdir) or
- die "can't create $outputdir";
+ dodie "can't create $outputdir";
}
$make = "$makecmd O=$outputdir";
@@ -4341,7 +4341,7 @@ for (my $i = 1; $i <= $opt{"NUM_TESTS"}; $i++) {
if (!-d $tmpdir) {
mkpath($tmpdir) or
- die "can't create $tmpdir";
+ dodie "can't create $tmpdir";
}
$ENV{"SSH_USER"} = $ssh_user;
@@ -4414,7 +4414,7 @@ for (my $i = 1; $i <= $opt{"NUM_TESTS"}; $i++) {
if (defined($checkout)) {
run_command "git checkout $checkout" or
- die "failed to checkout $checkout";
+ dodie "failed to checkout $checkout";
}
$no_reboot = 0;
--
1.8.3.1
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [PATCH v3 4/4] ktest: add email options to sample.config
2018-04-06 22:17 [PATCH v3 0/4] ktest: add email support Tim Tianyang Chen
` (2 preceding siblings ...)
2018-04-06 22:17 ` [PATCH v3 3/4] ktest: use dodie for critical falures Tim Tianyang Chen
@ 2018-04-06 22:17 ` Tim Tianyang Chen
3 siblings, 0 replies; 6+ messages in thread
From: Tim Tianyang Chen @ 2018-04-06 22:17 UTC (permalink / raw)
To: rostedt; +Cc: linux-kernel, dhaval.giani, tim.tianyang.chen, Tim Tianyang Chen
A block of email options is added under the optional config section.
Suggested-by: Dhaval Giani <dhaval.giani@oracle.com>
Signed-off-by: Tim Tianyang Chen <tianyang.chen@oracle.com>
---
tools/testing/ktest/sample.conf | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
diff --git a/tools/testing/ktest/sample.conf b/tools/testing/ktest/sample.conf
index 6c58cd8bbbae..ba3dd4a9c7fb 100644
--- a/tools/testing/ktest/sample.conf
+++ b/tools/testing/ktest/sample.conf
@@ -396,6 +396,28 @@
#### Optional Config Options (all have defaults) ####
+# Email options for receiving notifications. Users must setup
+# the specified mailer prior to using this feature.
+#
+# (default undefined)
+#MAILTO =
+#
+# Supported mailers: sendmail, mail, mailx
+# (default sendmail)
+#MAILER = sendmail
+#
+# Errors are defined as those would terminate the script
+# (default 1)
+#EMAIL_ON_ERROR = 1
+# (default 1)
+#EMAIL_WHEN_FINISHED = 1
+# (default 0)
+#EMAIL_WHEN_STARTED = 1
+#
+# Users can cancel the test by Ctrl^C
+# (default 0)
+#EMAIL_WHEN_CANCELED = 1
+
# Start a test setup. If you leave this off, all options
# will be default and the test will run once.
# This is a label and not really an option (it takes no value).
--
1.8.3.1
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [PATCH v3 2/4] Ktest: add SigInt handling
2018-03-26 20:08 [PATCH v3 0/4] Ktest: add email support Tim Tianyang Chen
@ 2018-03-26 20:08 ` Tim Tianyang Chen
0 siblings, 0 replies; 6+ messages in thread
From: Tim Tianyang Chen @ 2018-03-26 20:08 UTC (permalink / raw)
To: rostedt; +Cc: linux-kernel, dhaval.giani
User can cancel tests and specify handler's behavior using option
'EMAIL_WHEN_CANCELED'.
Suggested-by: Dhaval Giani <dhaval.giani@oracle.com>
Signed-off-by: Tim Tianyang Chen <tianyang.chen@oracle.com>
---
ktest.pl | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/ktest.pl b/ktest.pl
index 9469783bc6c1..8be12ee27d34 100755
--- a/ktest.pl
+++ b/ktest.pl
@@ -4269,6 +4269,16 @@ sub send_email {
}
}
+sub cancel_test {
+ if ($email_when_canceled) {
+ send_email("KTEST: Your [$test_type] test was cancelled",
+ "Your test started at $script_start_time was cancelled: sig int");
+ }
+ die "\nCaught Sig Int, test interrupted: $!\n"
+}
+
+$SIG{INT} = qw(cancel_test);
+
# First we need to do is the builds
for (my $i = 1; $i <= $opt{"NUM_TESTS"}; $i++) {
--
2.15.1
^ permalink raw reply related [flat|nested] 6+ messages in thread
end of thread, other threads:[~2018-04-06 22:18 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-04-06 22:17 [PATCH v3 0/4] ktest: add email support Tim Tianyang Chen
2018-04-06 22:17 ` [PATCH v3 1/4] " Tim Tianyang Chen
2018-04-06 22:17 ` [PATCH v3 2/4] ktest: add SigInt handling Tim Tianyang Chen
2018-04-06 22:17 ` [PATCH v3 3/4] ktest: use dodie for critical falures Tim Tianyang Chen
2018-04-06 22:17 ` [PATCH v3 4/4] ktest: add email options to sample.config Tim Tianyang Chen
-- strict thread matches above, loose matches on Subject: below --
2018-03-26 20:08 [PATCH v3 0/4] Ktest: add email support Tim Tianyang Chen
2018-03-26 20:08 ` [PATCH v3 2/4] Ktest: add SigInt handling Tim Tianyang Chen
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).