striker-collect-debug: disable screenshot collection by default

Closes: #620

Signed-off-by: Fabio M. Di Nitto <[email protected]>

Author: fabbione

man/striker-collect-debug.8

@@ -35,6 +35,10 @@ This restricts the data to be collected to the Striker dashboards and the specif
 .TP
 This can be used to specify which specific hosts data is collected from. Note that this can be used in conjuction with \fB\-\-anvil\fR to add additional hosts to collect data from, like DR hosts. 
 .TP
+\fB\-\-with\-screenshots\fR
+.TP
+This collects VMs screenshots together with debug log. Disabled by default.
+.TP
 \fB\-\-output\-file\fR </path/to/file.tar.bz2>
 .TP
 This allows you to specify the output compressed tarball that the files will be saved in. By default, the output file is \fB/root/anvil-debug_<timestamp>.tar.bz2\fR. If this is a directory (ending in \fB/\fR), the normal file name is created, just in a different directory. If the path ends in a file that doesn't have the \fB.tar.bz2\fR suffix, that suffix will be added automatically. The output file will always be a bzip2's tarball.

tools/striker-collect-debug

@@ -36,6 +36,7 @@ my $anvil = Anvil::Tools->new();
 $anvil->Get->switches({list => [
 	"anvil", 
 	"hosts",
+	"with-screenshots",
 	"output-file"], man => $THIS_FILE});
 $anvil->Log->variables({source => $THIS_FILE, line => __LINE__, level => 2, list => $anvil->data->{switches}});
 $anvil->Log->entry({source => $THIS_FILE, line => __LINE__, level => 2, key => "log_0115", variables => { program => $THIS_FILE }});
@@ -697,33 +698,40 @@ sub collect_local_data
 		}
 		print "Done!\n";
 
-		# Grab screenshots.
-		print "- Collecting server screenshots... ";
-		if (-d $anvil->data->{path}{directories}{screenshots})
+		if ($anvil->data->{switches}{'with-screenshots'})
 		{
-			$shell_call = $anvil->data->{path}{exe}{tar}." -cvjf ".$target_directory."/server-screenshots.bz2 ".$anvil->data->{path}{directories}{screenshots};
-			$anvil->Log->variables({source => $THIS_FILE, line => __LINE__, level => 2, list => { shell_call => $shell_call }});
-			
-			($output, $return_code) = $anvil->System->call({shell_call => $shell_call});
-			$anvil->Log->variables({source => $THIS_FILE, line => __LINE__, level => 2, list => { 
-				output      => $output, 
-				return_code => $return_code, 
-			}});
-			if ($return_code)
+			# Grab screenshots.
+			print "- Collecting server screenshots... ";
+			if (-d $anvil->data->{path}{directories}{screenshots})
 			{
-				# Failed
-				print "Failed!\n";
-				print "Expected the return code '0', but got: [".$return_code."]. The error, if any, was:\n";
-				print "========\n";
-				print $output."\n";
-				print "========\n";
-				$anvil->nice_exit({exit_code => 1});
+				$shell_call = $anvil->data->{path}{exe}{tar}." -cvjf ".$target_directory."/server-screenshots.bz2 ".$anvil->data->{path}{directories}{screenshots};
+				$anvil->Log->variables({source => $THIS_FILE, line => __LINE__, level => 2, list => { shell_call => $shell_call }});
+				
+				($output, $return_code) = $anvil->System->call({shell_call => $shell_call});
+				$anvil->Log->variables({source => $THIS_FILE, line => __LINE__, level => 2, list => { 
+					output      => $output, 
+					return_code => $return_code, 
+				}});
+				if ($return_code)
+				{
+					# Failed
+					print "Failed!\n";
+					print "Expected the return code '0', but got: [".$return_code."]. The error, if any, was:\n";
+					print "========\n";
+					print $output."\n";
+					print "========\n";
+					$anvil->nice_exit({exit_code => 1});
+				}
+				print "Done!\n";
+			}
+			else
+			{
+				print "Failed!\nScreenshot directory: [".$anvil->data->{path}{directories}{screenshots}."] doesn't exist, skipping.\n";
 			}
-			print "Done!\n";
 		}
 		else
 		{
-			print "Failed!\nScreenshot directory: [".$anvil->data->{path}{directories}{screenshots}."] doesn't exist, skipping.\n";
+			print "- Screehshots collection disabled.\n";
 		}
 	}