#

# Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).

# All rights reserved.

# This component and the accompanying materials are made available

# under the terms of "Eclipse Public License v1.0"

# which accompanies this distribution, and is available

# at the URL "http://www.eclipse.org/legal/epl-v10.html".

#

# Initial Contributors:

# Nokia Corporation - initial contribution.

#

# Contributors:

#

# Description: 

#

#------------------------------------------------------------------------------------

# Includes

#------------------------------------------------------------------------------------

use strict;

use warnings;

use Cwd; # for cwd

use FindBin; # for FindBin:Bin

use File::Path; # for mkpath

use Date::Calc;

use File::Copy;

use lib "$FindBin::Bin/../lib";

{ # No globals.

    my $cgidir = GetCgiDir();

    if ( ! -e( $cgidir . "rerunsubs.pl" ) )

    {

        $cgidir = cwd;

        my $domain = "VideoApp_Domain";

        my $pos = index( $cgidir, $domain );

        if( $pos != -1 )

        {

            $cgidir = substr( $cgidir, 0, $pos + length( $domain ) ) . "\\videoplayer\\tsrc\\testing\\tools\\";

        }

    }

    require( $cgidir . "utils.pl" );

    require( $cgidir . "rerunsubs.pl" );

}

#------------------------------------------------------------------------------------

# GLOBAL CODE

#------------------------------------------------------------------------------------

my $basePath = "testdrop"; # ATS XML

my $dropFilePath = "ATS3Drop\\"; # All other files

my $dropImagePath = "ATS3Drop\\images\\";

my $dropBinaryPath = "ATS3Drop\\armv5_urel\\"; # Binaries

my $currentPlanId = 0;

my $currentSessionId = 0;

my $currentSetId = 0;

my $currentCaseId = 0;

my $currentStepId = 0;

# Attributes for files which are copied to device. Or SIS installations.

my $ATSFILE_NAME = 0;

my $ATSFILE_HARNESS = 1;

my $ATSFILE_ENABLED = 2;

my $ATSFILE_PASSRATE = 3;

my $ATSFILE_SIGNIFICANT = 4;

my $ATSFILE_TYPE = 5;

my $ATSFILE_SRC = 6;

my $ATSFILE_DST = 7;

my $ATSFILE_COMMAND = 9;

my $ATSFILE_DROPFULL_PATH = 10; # Contains the path in drop to the file

my $ATSFILE_STEP_XML = 11; # XML defining the step

my $ATSFILE_STEP_TIMEOUT = 12; # only for SIS file

# These must be replaced when writing a step into XML file

my $ATSXML_DROPPRIORITY = "ATSXML_DROPPRIORITY";

my $ATSXML_TESTNAME = "ATSXML_TESTNAME";

my $ATSXML_FLASH_IMAGE_NAME = "ATSXML_FLASH_IMAGE_NAME";

my $ATSXML_TESTDEVICE = "ATSXML_TESTDEVICE";

my $ATSXML_TESTPLAN_NAME = "ATSXML_TESTPLAN_NAME";

my $ATSXML_TESTSESSION_NAME = "ATSXML_TESTSESSION_NAME";

my $ATSXML_TESTSET_NAME = "ATSXML_TESTSET_NAME";

my $ATSXML_STEP_NAME = "ATSXML_STEP_NAME";

my $ATSXML_TESTCASE_NAME = "ATSXML_TESTCASE_NAME";

my $ATSXML_STEP_HARNESS = "ATSXML_STEP_HARNESS";

my $ATSXML_STEP_ENABLED = "ATSXML_STEP_ENABLED";

my $ATSXML_STEP_PASSRATE = "ATSXML_STEP_PASSRATE";

my $ATSXML_STEP_SIGNIFICANT = "ATSXML_STEP_SIGNIFICANT";

my $ATSXML_STEP_COMMAND = "ATSXML_STEP_COMMAND";

my $ATSXML_STEP_PARAM_TYPE = "ATSXML_STEP_PARAM_TYPE";

my $ATSXML_STEP_PARAM_SRC = "ATSXML_STEP_PARAM_SRC";

my $ATSXML_STEP_PARAM_DST = "ATSXML_STEP_PARAM_DST";

my $ATSXML_STEP_RUNCASES_FILENAME = "ATSXML_STEP_RUNCASES_FILENAME";

my $ATSXML_STEP_RUNCASES_TIMEOUT = "ATSXML_STEP_RUNCASES_TIMEOUT";

#my $ATSXML_STEP_PARAM_COMPONENT_PATH = "ATSXML_STEP_PARAM_COMPONENT_PATH";

my $ATSXML_STEP_RUNCASE_CASENAME = "ATSXML_STEP_RUNCASE_CASENAME";

my $ATSXML_STEP_RUNCASE_FILENAME = "ATSXML_STEP_RUNCASE_FILENAME";

my $ATSXML_EMAIL = "ATSXML_EMAIL";

my $ATSXML_SIS_FILENAME = "ATSXML_SIS_FILENAME";

my $ATSXML_STEP_TIMEOUT = "ATSXML_STEP_TIMEOUT";

my $ATSXML_FETCH_PATH = "ATSXML_FETCH_PATH";

my $ATSXML_CTC_PATH = "ATSXML_CTC_PATH";

# These are initialized in the InitXml()

my $ATSXML_HEADER_START;

my $ATSXML_HEADER_END;

my $ATSXML_FOOTER;

my $ATSXML_PLANSTART;

my $ATSXML_CREATEDIRS;

my $ATSXML_FLASH;

my $ATSXML_FORMAT_DRIVES;

my $ATSXML_PLANEND;

my $ATSXML_STEP;

my $ATSXML_FETCH_STEPS;

my $ATSXML_FETCH_STEP;

my $ATSXML_CTCWRITE_STEP;

my $ATSXML_STEP_DEFAULT;

my $ATSXML_STEP_BINARY;

my $ATSXML_STEP_RUNCASES;

my $ATSXML_STEP_RUNCASES_WITH_BOOT;

my $ATSXML_STEP_RUNCASES_INI;

my $ATSXML_STEP_RUNCASES_INI_WITH_BOOT;

my $ATSXML_STEP_RUNCASE;

my $ATSXML_STEP_INSTALLSIS;

my $ATSXML_POSTACTION;

my $atsCfgFileName = "";

my $atsUsername = "";

my $atsPassword = "";

my $paramStartDir = "..";

my $paramVerbose = 1;

my $paramDebug = 0;

my $paramFindPkgFilePath = "";

my $paramExecuteDrop = "";

my $paramDontDeleteGeneratedFiles = 0;

my $paramCTC = 0;

my $paramNameFilter = "";

my $paramSkipFlashCopy = 0;

my $paramForcedBuild = "";

my $paramRerunXml = 0;

my $paramUseSecondaryIni = 0;

my $paramCaseClass = "";

my $globalAtsHost = "10.11.2.4";

my $globalCtcExePath = "xxx";

my @globalFlashFiles;

my @globalSisFiles;

my @globalPkgFiles;

my $globalDeviceName = "";

my $globalDeviceVersion = "";

my $globalDeviceHWID = "";

my $globalEmail = "";

my $globalIgnoreSis = 0;

my @globalFailedCfgs;

# The code

InitXml();

ReadArgs();

if($paramExecuteDrop ne "")

{

    ExecuteDrop($paramExecuteDrop, 1);

}

else

{

    if($atsCfgFileName eq "")

    {

        ShowHelp();

    }

	ParseFile( $atsCfgFileName );

}

exit();

#------------------------------------------------------------------------------------

# ReadArgs

#------------------------------------------------------------------------------------

sub ReadArgs

    {

    ShowHelp() if(scalar(@ARGV) == 0);

    while(scalar(@ARGV) >= 1)

    {

        my $argument = shift(@ARGV);

        if($argument eq "-f")

        {

            $atsCfgFileName = shift(@ARGV)

        }

        elsif($argument eq "-u")

        {

            $atsUsername = shift(@ARGV)

        }

        elsif($argument eq "-p")

        {

            $atsPassword = shift(@ARGV)

        }

        elsif($argument eq "-h")

    	{

    		ShowHelp();

    	}

    	elsif($argument eq "-q")

    	{

    		$paramVerbose = 0;

    	}

    	elsif($argument eq "-d")

    	{

    		$paramVerbose = 1;

    		$paramDebug = 1;

    	}

    	elsif($argument eq -"filepath")

    	{

    	    $paramFindPkgFilePath = shift(@ARGV);

    	}

    	elsif($argument eq "-run")

    	{

    	    $paramExecuteDrop = shift(@ARGV);

    	    $paramVerbose = 1;

    	}

    	elsif($argument eq "-nodelete")

    	{

    	    $paramDontDeleteGeneratedFiles = 1;

    	}

    	elsif($argument eq "-ctcrom")

    	{

    	    $paramCTC = 1;

    	    $globalCtcExePath = "z:\\sys\\bin\\ctcman.exe";

    	}

    	elsif($argument eq "-ctcsis")

    	{

    	    $globalCtcExePath = "c:\\sys\\bin\\ctcman.exe";

    	    $paramCTC = 1;

    	}

    	elsif($argument eq "-dropname")

    	{

    	    $paramNameFilter = shift(@ARGV);

    	}

    	elsif($argument eq "-noflash")

    	{

    	    $paramSkipFlashCopy = 1;

    	}

    	elsif( $argument eq "-atshost" )

    	{

        	$globalAtsHost = shift(@ARGV);

        }

    	elsif( $argument eq "-forcebuild" )

    	{

        	$paramForcedBuild = shift(@ARGV);

        	if( !defined($paramForcedBuild) || ( $paramForcedBuild ne "udeb" && $paramForcedBuild ne "urel" ) )

        	{

        	    die("\n-forcebuild parameter must be 'udeb' or 'urel'");

        	}

        }

    	elsif( $argument eq "-rerun" )

    	{

        	$paramRerunXml = 1;

        	my $file = shift(@ARGV);

        	die("Could not read failed cases!") if ( Rerun_ReadFailedCases( $file, \@globalFailedCfgs ) );

            if( scalar( @globalFailedCfgs ) <= 0 )

            {

            	print("No fails to rerun!\n");

            	exit();

            }

        }

    	elsif( $argument eq "-allini" )

    	{

            $paramUseSecondaryIni = 1;

        }

        elsif( $argument eq "-caseclass" )

    	{

            $paramCaseClass = shift(@ARGV);

        }

    	else

    	{

    	    die("Unknown command line option: '$argument'.\n");

    	}

    }

    die("Parameter -f is required.\n") if( $atsCfgFileName eq "" );

}

#------------------------------------------------------------------------------------

# ShowHelp

#------------------------------------------------------------------------------------

sub ShowHelp

{

print <<USAGE_EOF;

genATSdrop.pl -f <drop or master cfg.txt> -u <ats username> -p <ats password>

Params:

-f <filename> Filename of ATS cfg file.

-u <username> ATS username. not required.

-p <password> ATS password. not required.

-q            Quiet mode

-d            Debug information

-run xxx      Run xxx drop in the ATS farm. xxx can be a folder or a zip file (w/o .zip)

-filepath xxx Where files from PKG are searched for, default is the path in PKG file.

-h            help

-nodelete     For default the script deletes generated files.

-noflash      Skip copying flash files to drop.

-ctcrom       CTC++ is installed in the ROM. Fetches the CTC result files from the device.

-ctcsis       CTC++ is installed from SIS. Fetches the CTC result files from the device.

-atshost      Address of ATS host to run the tests.

-dropname xxx Runs only drops which match with xxx string.

-forcebuild   udeb or urel -> forces to use the defined build for all executables read from PKGs

-rerun xxx    Reads results from xml and writes only failed cases into ATS3 drop CFG files.

-allini       Uses secondary testframework.ini file to run the cases, if it's found from init/all/ folder.

Below is example for the ATS master cfg file. The commands override the 

ATS drop cfg commands, except PKG command.

[MASTERCFG]

DEVICE Ivalo

FLASH \\\\network\\flashimages\\core.fpsx

FLASH \\\\network\\flashimages\\variant.fpsx

FLASH \\\\network\\flashimages\\eraseuserdisk.fpsx

SIS \\\\app\\sis\\app.sisx

SIS \\\\app\\tsrc\\sistests.sisx

IGNORESIS 

PKG \\\\app\\tsrc\\data\\cenrepchanges.pkg

EMAIL xxx

; Drop configs must be in tsrc folders and they must be defined after other commands.

INC /ido/api/module1/tsrc/conf/ats_config.txt

INC /ido/api2/module/tsrc/conf/ats_config.txt

[EMDMASTERCFG]

Available commands for the ATS drop cfg file. List order is also the recommended order in the cfg file.

 NAME XXX      Test drop name.

 PRIORITY xxx  Test drop execution priority, 0 is the highest

 DEVICE x1 x2 x3  x1 = Device name in the ATS system, x2 = device version (optional), x3 = device HWID (optional)

 FLASH         File to be flashed. Can be defined with path.

 PKG xxx       Text file listing the files which are copied into the device by ATS.

               Uses same format as Symbian PKG files.

 SIS x1        x1 = SIS/SISX file which needs to be installed.

 IGNORESIS     Master cfg only, ignores SIS commands afterwards.

 BOOT          Reboots the device. Testframework.ini must have cfg with cases Dummy1 and Dummy2.

 INI xxx       Command to execute ini file in ATS system.

 CFG xxx       Command to execute cfg in ATS system. Cfg files must be listed

               in the PKG files. No path support.

 CASELIST xxx  Command to execute invidual STIF cases from CFG files.

 FETCH xxx     Fetches file(s) from a directory. ( FETCH e:\\analyzetool\\* )

 EMAIL xxx     Email address(es) where ATS sends the report.

 USERNAME xxx  Username for ATS login

 PASSWORD xxx  Password for ATS login

Example:

[DROP]

NAME STIF_TestDrop

DEVICE Tube B1 1001

FLASH \\\\network\\flashimages\\core.fpsx

FLASH \\\\network\\flashimages\\variant.fpsx

FLASH \\\\network\\flashimages\\eraseuserdisk.fpsx

PKG \\\\app\\tsrc\\data\cenrepchanges.pkg

SIS \\\\app\\sis\\app.sisx

SIS \\\\app\\tsrc\\sis\\tests.sisx

BOOT

INI atsconfig\\drop1\\TestFramework.ini 1200

EMAIL dude\@nokia.com

[ENDDROP]

USAGE_EOF

	exit();

}

#------------------------------------------------------------------------------------

# ParseFile

# Parameters:

#   $filename

#------------------------------------------------------------------------------------

sub ParseFile

{

	my($filename) = @_;

	# Read the file and check if it's drop conf or master conf file.

	open(FILE_HANDLE, $filename) or die("ERROR! Could not open config file '" . $filename . "'\n");

	my @lines = <FILE_HANDLE>;

	close(FILE_HANDLE);

	my $isDropFile = 0;

	foreach my $line (@lines)

	{

		if( $line =~ m/\[DROP\]/i || $line =~ m/\[ENDDROP\]/i )

		{

			$isDropFile++;

		}

	}

	if( $isDropFile >= 2 )

	{

    	ParseAtsCfg( $filename );

    }

    else

    {

    	ParseMasterCfg( $filename );

    }

}

#------------------------------------------------------------------------------------

# ParseMasterCfg

# Parameters:

#   $filename

#------------------------------------------------------------------------------------

sub ParseMasterCfg

{

	my($filename) = @_;

	my $index = 0;

	open(FILE_HANDLE, $filename) or die("ERROR! Could not open master config file '" . $filename . "'\n");

	my @lines = <FILE_HANDLE>;

	close(FILE_HANDLE);

    while($index < scalar(@lines))

    {

        my $line = $lines[$index];

        my $cmd;

        my $params;

		ReadCmdFromLine( \$line, \$cmd, \$params );

        #

        # CMD FLASH

        #

        if($cmd eq "FLASH")

        {

            push @globalFlashFiles, $params;

        }

		#

		# CMD DEVICE

		#

		if( $cmd eq "DEVICE" )

		{

			my @paramArray = split( / /, $params );

			$globalDeviceName = $paramArray[0] if( defined( $paramArray[0] ) );

			$globalDeviceVersion = $paramArray[1] if( defined( $paramArray[1] ) );

			$globalDeviceHWID = $paramArray[2] if( defined( $paramArray[2] ) );

			print("Global device: $globalDeviceName\n");

			print("Global device version: $globalDeviceVersion\n");

			print("Global device HWID: $globalDeviceHWID\n");

		}

		#

		# CMD EMAIL

		#

		if( $cmd eq "EMAIL" )

		{

			$globalEmail = $params;

		}

        #

        # CMD INC

        #

        if($cmd eq "INC")

        {

			# Forward slashes to backward.

			$params =~ s/\//\\/g;

			my $pos = index( $params, "tsrc" );

			if( $pos != -1 )

			{

				print("\nReading config file $params\n");

				my $path = substr( $params, 0, $pos+4 );

				my $file = substr( $params, $pos+5 );

				$pos = index( $file, "conf" );

				die("INC file must be in conf directory! Incorrect params: $params") if( $pos == -1);

                if( $pos != 0 )

                {

                    $path .= "\\" . substr( $file, 0, $pos-1 );

                    $file = substr( $file, $pos );

                }

				my $startDir = cwd;

				# Change where the master config file is.

				if( rindex($filename, "\\") != -1 )

				{

					chdir( substr($filename, 0, rindex($filename, "\\") ) );

				}

				# Go where the drop config file is.

				chdir( $path );

				ParseAtsCfg( $file );

				chdir( $startDir );			

			}

			else

			{

				die("ERROR! The path $params is invalid, config must be under tsrc folder.\n");

			}

		}

        #

        # CMD SIS

        #

        if( $cmd eq "SIS" )

        {

            print("Master CFG has SIS: $params\n"); 

            push @globalSisFiles, $params;

        }

        #

        # CMD SIS

        #

        if( $cmd eq "IGNORESIS" )

        {

            print("Master CFG ignore sis command.\n"); 

            $globalIgnoreSis = 1;

        }

        #

        # CMD PKG