2018-03-26 20:10:14

by Tim Tianyang Chen

[permalink] [raw]
Subject: [PATCH v3 0/4] Ktest: add email support

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

ktest.pl | 125 +++++++++++++++++++++++++++++++++++++++++++++---------------
sample.conf | 22 +++++++++++
2 files changed, 117 insertions(+), 30 deletions(-)

--
2.15.1



2018-03-26 20:10:48

by Tim Tianyang Chen

[permalink] [raw]
Subject: [PATCH v3 1/4] Ktest: add email support

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 <[email protected]>
Signed-off-by: Tim Tianyang Chen <[email protected]>

---
changes since v2:
coding style fix for option maps and if statements
moved sig int handeling to another patch
changes since v1:
added options for when to send emails to option_map
---
ktest.pl | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++---
1 file changed, 58 insertions(+), 3 deletions(-)

diff --git a/ktest.pl b/ktest.pl
index 0c8b61f8398e..9469783bc6c1 100755
--- a/ktest.pl
+++ b/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");
@@ -4224,6 +4249,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++) {

@@ -4264,9 +4309,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
@@ -4430,4 +4481,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;
--
2.15.1


2018-03-26 20:16:36

by Tim Tianyang Chen

[permalink] [raw]
Subject: [PATCH v3 4/4] Ktest: add email options to sample.config

A block of email options is added under the optional config section.

Suggested-by: Dhaval Giani <[email protected]>
Signed-off-by: Tim Tianyang Chen <[email protected]>

---
Changes since v2:
Added comments and defaults for each option
---
sample.conf | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)

diff --git a/sample.conf b/sample.conf
index 6c58cd8bbbae..ba3dd4a9c7fb 100644
--- a/sample.conf
+++ b/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).
--
2.15.1


2018-03-26 20:18:49

by Tim Tianyang Chen

[permalink] [raw]
Subject: [PATCH v3 2/4] Ktest: add SigInt handling

User can cancel tests and specify handler's behavior using option
'EMAIL_WHEN_CANCELED'.

Suggested-by: Dhaval Giani <[email protected]>
Signed-off-by: Tim Tianyang Chen <[email protected]>
---
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


2018-03-26 20:19:04

by Tim Tianyang Chen

[permalink] [raw]
Subject: [PATCH v3 3/4] Ktest: use dodie for critical falures

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 <[email protected]>
Signed-off-by: Tim Tianyang Chen <[email protected]>

---
Changes since v2:
revert a change for opening and appending the config file
Changes since v1:
revert changes for errors happen during config parsing
---
ktest.pl | 54 +++++++++++++++++++++++++++---------------------------
1 file changed, 27 insertions(+), 27 deletions(-)

diff --git a/ktest.pl b/ktest.pl
index 8be12ee27d34..03514a06844c 100755
--- a/ktest.pl
+++ b/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;

@@ -3773,7 +3773,7 @@ sub get_depends {

$dep =~ s/^[^$valid]*[$valid]+//;
} else {
- die "this should never happen";
+ dodie "this should never happen";
}
}

@@ -4034,7 +4034,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";
}
@@ -4062,7 +4062,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";
}
@@ -4302,11 +4302,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";
@@ -4343,7 +4343,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;
@@ -4416,7 +4416,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;
--
2.15.1


2018-04-03 19:55:10

by Tim Tianyang Chen

[permalink] [raw]
Subject: Re: [PATCH v3 0/4] Ktest: add email support

Hi Steve, did you get a chance to take a look? cc'ing myself and a
personal email. When I sent the patchset I forgot to include.

Tianyang

On 2018-03-26 04:08 PM, Tim Tianyang Chen wrote:

> 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
>
> ktest.pl | 125 +++++++++++++++++++++++++++++++++++++++++++++---------------
> sample.conf | 22 +++++++++++
> 2 files changed, 117 insertions(+), 30 deletions(-)
>

2018-04-03 19:56:58

by Dhaval Giani

[permalink] [raw]
Subject: Re: [PATCH v3 0/4] Ktest: add email support

On 2018-03-26 04:08 PM, Tim Tianyang Chen wrote:
> 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
>
> ktest.pl | 125 +++++++++++++++++++++++++++++++++++++++++++++---------------
> sample.conf | 22 +++++++++++
> 2 files changed, 117 insertions(+), 30 deletions(-)
>

Steve,

Any thoughts?

Thanks!
Dhaval

2018-04-03 23:07:55

by Steven Rostedt

[permalink] [raw]
Subject: Re: [PATCH v3 0/4] Ktest: add email support

On Tue, 3 Apr 2018 12:52:20 -0700
Tim Tianyang Chen <[email protected]> wrote:

> Hi Steve, did you get a chance to take a look? cc'ing myself and a
> personal email. When I sent the patchset I forgot to include.

Sorry, I'm trying to get my own ktest patches in (I have a bunch of non
committed changes) and I need to clean them up before adding yours.

I'll take a look at them tonight or tomorrow.

Thanks!

-- Steve

2018-04-04 19:52:29

by Steven Rostedt

[permalink] [raw]
Subject: Re: [PATCH v3 0/4] Ktest: add email support

On Tue, 3 Apr 2018 18:38:19 -0400
Steven Rostedt <[email protected]> wrote:

> On Tue, 3 Apr 2018 12:52:20 -0700
> Tim Tianyang Chen <[email protected]> wrote:
>
> > Hi Steve, did you get a chance to take a look? cc'ing myself and a
> > personal email. When I sent the patchset I forgot to include.
>
> Sorry, I'm trying to get my own ktest patches in (I have a bunch of non
> committed changes) and I need to clean them up before adding yours.
>
> I'll take a look at them tonight or tomorrow.

I started working on ktest again, but didn't get as far as I wanted.
I'll be continuing more on it tomorrow. I want this ready for this
merge window, so it is high on my priority list (including your
patches).

-- Steve

2018-04-06 18:29:07

by Steven Rostedt

[permalink] [raw]
Subject: Re: [PATCH v3 1/4] Ktest: add email support

On Mon, 26 Mar 2018 13:08:01 -0700
Tim Tianyang Chen <[email protected]> wrote:

> 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 <[email protected]>
> Signed-off-by: Tim Tianyang Chen <[email protected]>
>
> ---
> changes since v2:
> coding style fix for option maps and if statements
> moved sig int handeling to another patch
> changes since v1:
> added options for when to send emails to option_map
> ---
> ktest.pl | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++---
> 1 file changed, 58 insertions(+), 3 deletions(-)
>
> diff --git a/ktest.pl b/ktest.pl
> index 0c8b61f8398e..9469783bc6c1 100755
> --- a/ktest.pl
> +++ b/ktest.pl

If you can, please use git to make your diffs.

The full path name needs to be here.

tools/testing/ktest/ktest.pl

-- Steve

> @@ -22,6 +22,11 @@ my %evals;
>
>

2018-04-06 22:25:54

by Tim Tianyang Chen

[permalink] [raw]
Subject: Re: [PATCH v3 1/4] Ktest: add email support



On 04/06/2018 11:24 AM, Steven Rostedt wrote:
> On Mon, 26 Mar 2018 13:08:01 -0700
> Tim Tianyang Chen <[email protected]> wrote:
>
>> 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 <[email protected]>
>> Signed-off-by: Tim Tianyang Chen <[email protected]>
>>
>> ---
>> changes since v2:
>> coding style fix for option maps and if statements
>> moved sig int handeling to another patch
>> changes since v1:
>> added options for when to send emails to option_map
>> ---
>> ktest.pl | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++---
>> 1 file changed, 58 insertions(+), 3 deletions(-)
>>
>> diff --git a/ktest.pl b/ktest.pl
>> index 0c8b61f8398e..9469783bc6c1 100755
>> --- a/ktest.pl
>> +++ b/ktest.pl
> If you can, please use git to make your diffs.
>
> The full path name needs to be here.
>
> tools/testing/ktest/ktest.pl
>
Sorry I was working on my private folder, version tracked with other
stuff. Just re-sent them.

Tim

2018-04-06 22:46:51

by Steven Rostedt

[permalink] [raw]
Subject: Re: [PATCH v3 1/4] Ktest: add email support

On Fri, 6 Apr 2018 15:19:48 -0700
Tim Tianyang Chen <[email protected]> wrote:


> > The full path name needs to be here.
> >
> > tools/testing/ktest/ktest.pl
> >
> Sorry I was working on my private folder, version tracked with other
> stuff. Just re-sent them.

I just fixed them up and pulled them in myself. ;-)

I also added the following on top of them (and testing this, live while
testing ftrace patches and other builds).

-- Steve

diff --git a/tools/testing/ktest/ktest.pl b/tools/testing/ktest/ktest.pl
index 30a4c053f98b..837fa75cbb47 100755
--- a/tools/testing/ktest/ktest.pl
+++ b/tools/testing/ktest/ktest.pl
@@ -23,7 +23,7 @@ my %evals;

#default opts
my %default = (
- "MAILER" => "sendmail", # default mailer
+ "MAILER" => "sendmail", # default mailer
"EMAIL_ON_ERROR" => 1,
"EMAIL_WHEN_FINISHED" => 1,
"EMAIL_WHEN_CANCELED" => 0,
@@ -218,6 +218,7 @@ my $dirname = $FindBin::Bin;

my $mailto;
my $mailer;
+my $mail_exec;
my $email_on_error;
my $email_when_finished;
my $email_when_started;
@@ -250,8 +251,9 @@ my $no_reboot = 1;
my $reboot_success = 0;

my %option_map = (
- "MAILTO" => \$mailto,
- "MAILER" => \$mailer,
+ "MAILTO" => \$mailto,
+ "MAILER" => \$mailer,
+ "MAIL_EXEC" => \$mail_exec,
"EMAIL_ON_ERROR" => \$email_on_error,
"EMAIL_WHEN_FINISHED" => \$email_when_finished,
"EMAIL_WHEN_STARTED" => \$email_when_started,
@@ -1431,7 +1433,14 @@ sub do_not_reboot {
($test_type eq "config_bisect" && $opt{"CONFIG_BISECT_TYPE[$i]"} eq "build");
}

+my $in_die = 0;
+
sub dodie {
+
+ # avoid recusion
+ return if ($in_die);
+ $in_die = 1;
+
doprint "CRITICAL FAILURE... ", @_, "\n";

my $i = $iteration;
@@ -4126,21 +4135,31 @@ sub set_test_option {

sub _mailx_send {
my ($subject, $message) = @_;
- system("$mailer -s \'$subject\' $mailto <<< \'$message\'");
+
+ if (!defined($mail_exec)) {
+ $mail_exec = $mailer;
+ }
+ run_command "$mail_exec -s \'$subject\' $mailto <<< \'$message\'";
}

sub _sendmail_send {
my ($subject, $message) = @_;
- system("echo -e \"Subject: $subject\n\n$message\" | sendmail -t $mailto");
+
+ if (!defined($mail_exec)) {
+ $mail_exec = "/usr/sbin/sendmail";
+ }
+ run_command "echo \'Subject: $subject\n\n$message\' | $mail_exec -t $mailto";
}

sub send_email {
- if (defined($mailto) && defined($mailer)) {
+ if (defined($mailto)) {
+ if (!defined($mailer)) {
+ doprint "No email sent: email or mailer not specified in config.\n";
+ return;
+ }
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"
+ else { die "\nYour mailer: $mailer is not supported.\n" }
}
}

diff --git a/tools/testing/ktest/sample.conf b/tools/testing/ktest/sample.conf
index d1a2626aaa0a..86e7cffc45c0 100644
--- a/tools/testing/ktest/sample.conf
+++ b/tools/testing/ktest/sample.conf
@@ -411,6 +411,10 @@
# (default sendmail)
#MAILER = sendmail
#
+# The executable to run
+# (default: for sendmail "/usr/sbin/sendmail", otherwise equals ${MAILER})
+#MAIL_EXEC = /usr/sbin/sendmail
+#
# Errors are defined as those would terminate the script
# (default 1)
#EMAIL_ON_ERROR = 1

2018-04-06 23:16:08

by Tim Tianyang Chen

[permalink] [raw]
Subject: Re: [PATCH v3 1/4] Ktest: add email support

> I just fixed them up and pulled them in myself. ;-)
>
> I also added the following on top of them (and testing this, live while
> testing ftrace patches and other builds).
Thanks Steve!
> diff --git a/tools/testing/ktest/ktest.pl b/tools/testing/ktest/ktest.pl
> index 30a4c053f98b..837fa75cbb47 100755
> --- a/tools/testing/ktest/ktest.pl
> +++ b/tools/testing/ktest/ktest.pl
> @@ -23,7 +23,7 @@ my %evals;
>
> #default opts
> my %default = (
> - "MAILER" => "sendmail", # default mailer
> + "MAILER" => "sendmail", # default mailer
Noticed this when I sent the new version.

> "EMAIL_ON_ERROR" => 1,
> "EMAIL_WHEN_FINISHED" => 1,
> "EMAIL_WHEN_CANCELED" => 0,
> @@ -218,6 +218,7 @@ my $dirname = $FindBin::Bin;
>
> my $mailto;
> my $mailer;
> +my $mail_exec;
> my $email_on_error;
> my $email_when_finished;
> my $email_when_started;
> @@ -1431,7 +1433,14 @@ sub do_not_reboot {
> ($test_type eq "config_bisect" && $opt{"CONFIG_BISECT_TYPE[$i]"} eq "build");
> }
>
> +my $in_die = 0;
> +
> sub dodie {
> +
> + # avoid recusion
> + return if ($in_die);
> + $in_die = 1;
> +
> doprint "CRITICAL FAILURE... ", @_, "\n";
Good idea.
>
> my $i = $iteration;
> @@ -4126,21 +4135,31 @@ sub set_test_option {
>
> sub _mailx_send {
> my ($subject, $message) = @_;
> - system("$mailer -s \'$subject\' $mailto <<< \'$message\'");
> +
> + if (!defined($mail_exec)) {
> + $mail_exec = $mailer;
> + }
> + run_command "$mail_exec -s \'$subject\' $mailto <<< \'$message\'";
> }
>
> sub _sendmail_send {
> my ($subject, $message) = @_;
> - system("echo -e \"Subject: $subject\n\n$message\" | sendmail -t $mailto");
> +
> + if (!defined($mail_exec)) {
> + $mail_exec = "/usr/sbin/sendmail";
> + }
> + run_command "echo \'Subject: $subject\n\n$message\' | $mail_exec -t $mailto";
> }
>
Not sure if I understand why $mail_exec is necessary. Doesn't $mailer
already have a default? Wouldn't people just use $mailer to define the
executable they want to use? What if the $mailx_exec specified doesn't
use '-t' option?

Thanks,
Tim

2018-04-07 22:56:02

by Steven Rostedt

[permalink] [raw]
Subject: Re: [PATCH v3 1/4] Ktest: add email support

On Fri, 6 Apr 2018 16:09:28 -0700
Tim Tianyang Chen <[email protected]> wrote:


> > sub _sendmail_send {
> > my ($subject, $message) = @_;
> > - system("echo -e \"Subject: $subject\n\n$message\" | sendmail -t $mailto");
> > +
> > + if (!defined($mail_exec)) {
> > + $mail_exec = "/usr/sbin/sendmail";
> > + }
> > + run_command "echo \'Subject: $subject\n\n$message\' | $mail_exec -t $mailto";
> > }
> >
> Not sure if I understand why $mail_exec is necessary. Doesn't $mailer
> already have a default? Wouldn't people just use $mailer to define the
> executable they want to use? What if the $mailx_exec specified doesn't
> use '-t' option?

sendmail isn't in my path, I had to specify the path name to find it.
Hmm, we could have "MAILER_PATH" to find it. I can change that.

Actually, what we should also add is the format to print it out.

MAIL_COMMAND = echo \'Subject: $SUBJECT\n\n$MESSAGE\' | sendmail -t ${MAILTO}

Note the difference between $SUBJECT, $MESSAGE and ${MAILTO}. When we
have ${FOO} that is a variable the user controls. But $FOO is a
variable that is hard coded for certain commands.

That may be better to have.

Here's my latest total diff:

diff --git a/tools/testing/ktest/ktest.pl b/tools/testing/ktest/ktest.pl
index 30a4c053f98b..a14fc309d140 100755
--- a/tools/testing/ktest/ktest.pl
+++ b/tools/testing/ktest/ktest.pl
@@ -23,7 +23,7 @@ my %evals;

#default opts
my %default = (
- "MAILER" => "sendmail", # default mailer
+ "MAILER" => "sendmail", # default mailer
"EMAIL_ON_ERROR" => 1,
"EMAIL_WHEN_FINISHED" => 1,
"EMAIL_WHEN_CANCELED" => 0,
@@ -218,6 +218,8 @@ my $dirname = $FindBin::Bin;

my $mailto;
my $mailer;
+my $mail_path;
+my $mail_command;
my $email_on_error;
my $email_when_finished;
my $email_when_started;
@@ -250,8 +252,10 @@ my $no_reboot = 1;
my $reboot_success = 0;

my %option_map = (
- "MAILTO" => \$mailto,
- "MAILER" => \$mailer,
+ "MAILTO" => \$mailto,
+ "MAILER" => \$mailer,
+ "MAIL_PATH" => \$mail_path,
+ "MAIL_COMMAND" => \$mail_command,
"EMAIL_ON_ERROR" => \$email_on_error,
"EMAIL_WHEN_FINISHED" => \$email_when_finished,
"EMAIL_WHEN_STARTED" => \$email_when_started,
@@ -1431,7 +1435,14 @@ sub do_not_reboot {
($test_type eq "config_bisect" && $opt{"CONFIG_BISECT_TYPE[$i]"} eq "build");
}

+my $in_die = 0;
+
sub dodie {
+
+ # avoid recusion
+ return if ($in_die);
+ $in_die = 1;
+
doprint "CRITICAL FAILURE... ", @_, "\n";

my $i = $iteration;
@@ -4124,23 +4135,61 @@ sub set_test_option {
return eval_option($name, $option, $i);
}

-sub _mailx_send {
- my ($subject, $message) = @_;
- system("$mailer -s \'$subject\' $mailto <<< \'$message\'");
+sub find_mailer {
+ my ($mailer) = @_;
+
+ my @paths = split /:/, $ENV{PATH};
+
+ # sendmail is usually in /usr/sbin
+ $paths[$#paths + 1] = "/usr/sbin";
+
+ foreach my $path (@paths) {
+ if (-x "$path/$mailer") {
+ return $path;
+ }
+ }
+
+ return undef;
}

-sub _sendmail_send {
+sub do_send_mail {
my ($subject, $message) = @_;
- system("echo -e \"Subject: $subject\n\n$message\" | sendmail -t $mailto");
+
+ if (!defined($mail_path)) {
+ # find the mailer
+ $mail_path = find_mailer $mailer;
+ if (!defined($mail_path)) {
+ die "\nCan not find $mailer in PATH\n";
+ }
+ }
+
+ if (!defined($mail_command)) {
+ if ($mailer eq "mail" || $mailer eq "mailx") {
+ $mail_command = "\$MAIL_PATH/\$MAILER -s \'\$SUBJECT\' \$MAILTO <<< \'\$MESSAGE\'";
+ } elsif ($mailer eq "sendmail" ) {
+ $mail_command = "echo \'Subject: \$SUBJECT\n\n\$MESSAGE\' | \$MAIL_PATH/\$MAILER -t \$MAILTO";
+ } else {
+ die "\nYour mailer: $mailer is not supported.\n";
+ }
+ }
+
+ $mail_command =~ s/\$MAILER/$mailer/g;
+ $mail_command =~ s/\$MAIL_PATH/$mail_path/g;
+ $mail_command =~ s/\$MAILTO/$mailto/g;
+ $mail_command =~ s/\$SUBJECT/$subject/g;
+ $mail_command =~ s/\$MESSAGE/$message/g;
+
+ run_command $mail_command;
}

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"
+
+ if (defined($mailto)) {
+ if (!defined($mailer)) {
+ doprint "No email sent: email or mailer not specified in config.\n";
+ return;
+ }
+ do_send_mail @_;
}
}

diff --git a/tools/testing/ktest/sample.conf b/tools/testing/ktest/sample.conf
index d1a2626aaa0a..86e7cffc45c0 100644
--- a/tools/testing/ktest/sample.conf
+++ b/tools/testing/ktest/sample.conf
@@ -411,6 +411,10 @@
# (default sendmail)
#MAILER = sendmail
#
+# The executable to run
+# (default: for sendmail "/usr/sbin/sendmail", otherwise equals ${MAILER})
+#MAIL_EXEC = /usr/sbin/sendmail
+#
# Errors are defined as those would terminate the script
# (default 1)
#EMAIL_ON_ERROR = 1

-- Steve