Merge pull request #4647 from hannes-steffenhagen-diffblue/feature-suppress_color_output_on_aws

Suppress color output on aws

Author: tautschnig

buildspec-linux-clang.yml

@@ -1,5 +1,10 @@
 version: 0.2
 
+env:
+  variables:
+    # CodeBuild console doesn't display color codes correctly
+    TESTPL_COLOR_OUTPUT: 0
+
 phases:
   install:
     runtime-versions:

buildspec-linux-cmake-gcc.yml

@@ -1,5 +1,10 @@
 version: 0.2
 
+env:
+  variables:
+    # CodeBuild console doesn't display color codes correctly
+    TESTPL_COLOR_OUTPUT: 0
+
 phases:
   install:
     runtime-versions:

buildspec-windows.yml

@@ -1,5 +1,10 @@
 version: 0.2
 
+env:
+  variables:
+    # CodeBuild console doesn't display color codes correctly
+    TESTPL_COLOR_OUTPUT: 0
+
 phases:
   install:
     commands:

buildspec.yml

@@ -1,5 +1,10 @@
 version: 0.2
 
+env:
+  variables:
+    # CodeBuild console doesn't display color codes correctly
+    TESTPL_COLOR_OUTPUT: 0
+
 phases:
   install:
     runtime-versions:

regression/test.pl

@@ -21,6 +21,16 @@
 #
 # runs a test and check its output
 
+my $color_output_enabled;
+sub with_color {
+  my ($text, $color) = @_;
+  if ($color_output_enabled) {
+    colored($text, $color);
+  } else {
+    $text;
+  }
+}
+
 sub run($$$$$) {
   my ($name, $input, $cmd, $options, $output) = @_;
   my $cmdline = "$cmd $options '$input' >'$output' 2>&1";
@@ -290,6 +300,10 @@ ($$$$)
              independent logs.
   -f         forward the test name to CMD
 
+  --[no]color enable/disable color output; enabled by default unless
+              TESTPL_COLOR_OUTPUT is set to 0, in which case it is
+              disabled by default.
+
 test.pl expects a test.desc file in each subdirectory. The file test.desc
 follows the format specified below. Any line starting with // will be ignored.
 
@@ -324,9 +338,17 @@ ($$$$)
 use Getopt::Long qw(:config pass_through bundling);
 $main::VERSION = 0.1;
 $Getopt::Std::STANDARD_HELP_VERSION = 1;
-our ($opt_c, $opt_e, $opt_f, $opt_i, $opt_j, $opt_n, $opt_p, $opt_h, $opt_C, $opt_T, $opt_F, $opt_K, $opt_s, %defines, @include_tags, @exclude_tags); # the variables for getopt
-GetOptions("D=s" => \%defines, "X=s" => \@exclude_tags, "I=s" => \@include_tags);
-getopts('c:efi:j:nphCTFKs:') or &main::HELP_MESSAGE(\*STDOUT, "", $main::VERSION, "");
+our ($opt_c, $opt_e, $opt_f, $opt_i, $opt_j, $opt_n, $opt_p, $opt_h, $opt_C, $opt_T, $opt_F, $opt_K, $opt_s, $opt_S, %defines, @include_tags, @exclude_tags); # the variables for getopt
+
+# this needs to come before GetOptions to ensure the
+# default -> environment -> flag override priority
+$color_output_enabled = 1;
+if (exists $ENV{'TESTPL_COLOR_OUTPUT'}) {
+  $color_output_enabled = $ENV{'TESTPL_COLOR_OUTPUT'};
+}
+
+GetOptions("D=s" => \%defines, "X=s" => \@exclude_tags, "I=s" => \@include_tags, 'color!' => \$color_output_enabled);
+getopts('c:efi:j:nphCTFKs:S:') or &main::HELP_MESSAGE(\*STDOUT, "", $main::VERSION, "");
 $opt_c or &main::HELP_MESSAGE(\*STDOUT, "", $main::VERSION, "");
 $opt_j = $opt_j || $ENV{'TESTPL_JOBS'} || 0;
 if($opt_j && $opt_j != 1 && !$has_thread_pool) {
@@ -340,6 +362,7 @@ ($$$$)
 $t_level += 4 if($opt_F);
 $t_level += 8 if($opt_K);
 $t_level += 1 if($opt_C || 0 == $t_level);
+
 my $dry_run = $opt_n;
 my $log_suffix = $opt_s;
 my $exit_signal_checks = defined($opt_e);
@@ -386,10 +409,10 @@ ($)
       $skips++;
       print "  [SKIPPED]\n";
     } elsif(0 == $failed_skipped) {
-      print "  [" . colored("OK", "green") . "] in $runtime seconds\n";
+      print "  [" . with_color("OK", "green") . "] in $runtime seconds\n";
     } else {
       $failures++;
-      print "  [" . colored("FAILED", "red") . "]\n";
+      print "  [" . with_color("FAILED", "red") . "]\n";
     }
   }
 }
@@ -427,9 +450,9 @@ ($)
 print "\n";
 
 if($failures == 0) {
-  print colored("All tests were successful", "green");
+  print with_color("All tests were successful", "green");
 } else {
-  print colored("Tests failed", "red") . "\n";
+  print with_color("Tests failed", "red") . "\n";
   print "  $failures of $count " . (1==$count?"test":"tests") . " failed";
 }
 print ", $skips " . (1==$skips?"test":"tests") . " skipped" if($skips > 0);