#

# Copyright (c) 2006 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: 

#

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

# Sequence

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

# Reads parameters -> [if !ok params] ShowHelp

# ReadConfigFiles

#	-> ParseCfg

#	-> ReadCase

#

#    for all testreports:

#       ReadTestRunInfoFromStifReport

#           GetReportLogFileNames

#       ParseResultsAndLogs

#

#    ParseResultsAndLogs

#        WriteCaseLog

#			LogLineTimeMatchesForCase

#			FormatLogLine

#        UpdateCase

#        CheckCaseEntriesInLog

#

# OLD:

#	-> ParseReportFile

#		-> ReadReportLogs

#		-> WriteCaseLog

#			-> LogLineTimeMatchesForCase

#			-> FormatLogLine

#		-> CheckCaseEntriesInLog

#

# ReportNotDocumentedCases

# SortCases

# CalculateStats

# WriteOfficeXml -> XmlReadyText

# exit()

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

# Other functions:

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

# RemoveWhiteSpaces

# SpecialChars

# ReplaceChar

# GetCaseField

# GetCase (id or name)

# GetCaseDesc (id or name)

# PrintCases

# JustFormatLogFile

#

#

#

# STIF CFG:

#************************************************************************************

#[IptvETDescription]

# Testname: <insert text here>

#

# Purpose: <insert text here>

#

# Means: <insert text here>

#

# Required environment settings: <insert text here>

#

# Verification: <insert text here>

#

# Note: <insert text here>

#

# Related requirements: <reqid> <reqid> <reqid> ..

#

#[EndIptvETDescription]

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

#[Test]

# do stuff here

#[Endtest]

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

# Includes

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

#use strict;

use warnings;

use Cwd; # for cwd

use FindBin; # for FindBin:Bin

use File::Path; # for mkpath

use File::Copy;

use Date::Calc;

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

# Globals

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

my $lastCaseLogLine = 0;

my $ALT_RESULTCOUNT = 10; # maximum number of runs in alternative report

my @cases; #references to case arrays

my @gCfgFiles; # list of cfg files.

my @caseDescs; # case description and the case itself in text

my @notDocumentedCases; #array to hold information about the cases without documentation

$regexpCaseName = '[\x3C\x3E\(\)\w.,\/:_\-&\' ]+';

my $caseDefaultStatus = 			"NOT RUN";

#

# Case field numerations

#

my $CASE_NAME = 					0;

my $CASE_ID = 						1;

my $CASE_RUN_TIMES = 				2;

my $CASE_CRASHED = 					3;

my $CASE_FAILED = 					4;

my $CASE_PASSED = 					5;

my $CASE_STATUS = 					6;

my $CASE_PURPOSE = 					7;

my $CASE_MEANS = 					8;

my $CASE_REQUIRED_SETTINGS = 		9;

my $CASE_RELATED_REQUIREMENTS = 	10;

my $CASE_VERIFICATION = 			11;

my $CASE_NOTE = 					12;

my $CASE_REASON = 					13; # where crashed or what returned the error code

my $CASE_RESULT = 					14; # error code

my $CASE_LOG_FILE = 				15; # test case specific log file.

my $CASE_LOG_FILE_SCRIPTER = 	    16; # test case specific log from STIF testscripter logs.

my $CASE_CHECK_RESULT_LOG_FILE = 	17; # set if the case is in the log files, if next line is found: >>>Case start: ETxxxxx CaseName

									# or STIF own trace: Starting testcase [ET1000 Add multiple Iaps] (usually from fasttrace or emulator log)

my $CASE_CFG_FILE = 				18;

my $CASE_RUN_TIME_SECONDS = 		19; # how many seconds it took to run the case

my $CASE_REPORTLINE1 =              20;

my $CASE_REPORTLINE2 =              21;

my $CASE_REPORTLINE3 =              22;

my $CASE_ENTRY_LOG_START =          23;

my $TDTOOLRESULTFILE = ".\\text_file.txt";

my $XML_OUTPUT_FILE = ".\\test_cases.xml";

my $XML_BRIEF_OUTPUT_FILE = ".\\test_cases_brief.xml";

my $NOT_DOCUMENTED_CASES_FILE = ".\\test_cases_notdocumented.txt";

my @globalTempFiles;

#

# Tags inside the xml, will be replaced by case data when writing the xml file

#

my $CaseCountMul8 = "CASE_COUNT_MUL8";

my $STYLE_ID_STATUS_TAG = "STYLE_ID_STATUS"; # must be in the xml data

my $STYLE_ID_STATUS_FAILED = "s36";

my $STYLE_ID_STATUS_PASSED = "s37";

my $STYLE_ID_STATUS_CRASHED = "s38";

my $STYLE_ID_STATUS_UNKNOWN = "s401";

my $STYLE_ID_STATUS_NA = "s39";

my $STYLE_ID_STATUS_FAILED_CENTERED = "s36centered";

my $STYLE_ID_STATUS_PASSED_CENTERED = "s37centered";

my $STYLE_ID_STATUS_CRASHED_CENTERED = "s38centered";

my $STYLE_ID_STATUS_UNKNOWN_CENTERED = "s401centered";

my $STYLE_ID_STATUS_NA_CENTERED = "s39centered";

# these must be in the xml data to get the results inserted into xml

my $xmlDataCaseName = "XML_DATA_CASE_NAME";

my $xmlDataCaseRunTimes = "XML_DATA_CASE_RUN_TIMES";

my $xmlDataCaseFailed = "XML_DATA_CASE_FAILED";

my $xmlDataCaseCrashed = "XML_DATA_CASE_CRASHED";

my $xmlDataCasePassed = "XML_DATA_CASE_PASSED";

my $xmlDataCaseStatus = "XML_DATA_CASE_STATUS";

my $xmlDataCasePurpose = "XML_DATA_CASE_PURPOSE";

my $xmlDataCaseMeans = "XML_DATA_CASE_MEANS";

my $xmlDataCaseRequiredSettings = "XML_DATA_CASE_REQUIRED_SETTINGS";

my $xmlDataCaseRelatedRequirements = "XML_DATA_CASE_RELATED_REQUIREMENTS";

my $xmlDataCaseVerification = "XML_DATA_CASE_VERIFICATION";

my $xmlDataCaseNote = "XML_DATA_CASE_NOTE";

my $xmlDataCaseReason = "XML_DATA_CASE_REASON";

my $xmlDataCaseResult = "XML_DATA_CASE_RESULT";

my $xmlDataCaseLink1 = "XML_DATA_CASE_LINK1";

my $xmlDataCaseLink2 = "XML_DATA_CASE_LINK2";

my $xmlDataSummaryCaseCount = "XML_DATA_SUMMARY_TOTAL_CASES";

my $xmlDataSummaryPassed = "XML_DATA_SUMMARY_PASSED";

my $xmlDataSummaryFailed = "XML_DATA_SUMMARY_FAILED";

my $xmlDataSummaryCrashed = "XML_DATA_SUMMARY_CRASHED";

my $xmlDataSummaryTimeout = "XML_DATA_SUMMARY_TIMEOUT";

my $xmlDataSummaryPassRateTotal = "XML_DATA_SUMMARY_PASS_RATE_TOTAL";

my $xmlDataSummaryPassRateRun = "XML_DATA_SUMMARY_PASS_RATE_RUN";

my $xmlDataSummaryRunRate = "XML_DATA_SUMMARY_RUN_RATE";

my $xmlDataAltDateX = "XML_DATA_ALTDATE";

my $xmlDataAltResultX = "XML_DATA_ALTRESULT";

my $xmlDataCfgFile = "XML_DATA_CFG_FILE";

#

# Statistics

#

my $summaryCaseCount = 0;

my $summaryPassedCases = 0;

my $summaryFailedCases = 0;

my $summaryCrashedCases = 0;

my $summaryTimeoutCases = 0;

my $summaryPassRateTotal = 0;

my $summaryPassRateRun = 0;

my $summaryRunRate = 0;

#

# Xml data

#

my $xmlHeader;

my $xmlHeaderTableColumns;

my $xmlHeaderTableColumnsBrief;

my $xmlFooter;

my $xmlDataEmptyRow;

my $xmlSummaryData;

my $xmlData;

my $xmlDataCaseStatusDisabled;

my $xmlData2;

my $xmlDataBriefHeader;

my $xmlDataBrief;

my $xmlCfgFileBrief;

my $xmlHeaderTableColumnsAlt;

my $xmlCfgFileAltHeader;

my $xmlCfgFileAltData;

InitXmlData();

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

# GLOBAL CODE

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

my $argcount = scalar(@ARGV);

my $optionSortCases = 0;

my $optionShowMessages = 0;

my $optionHtml = 0;

my $optionLogAllCases = 1;

my $optionNoLogs = 0;

my $optionNoSecurityTests = 0;

my $optionNoLiveTvTests = 0;

my $optionCaseIncludedInLog = 0;

my $optionGoodIsBetter = 1;

my $optionPrintCfgSummaries = 0;

my $optionCaseRunTimes = 0;

my $optionFinalDoc = 1;

my $optionFixFilename = "";

my $optionDebug = 0;

my $optionCaseList = "";

my $optionAltResults = 0;

my $optionLogFileName = "fusion";

while(scalar(@ARGV) >= 1)

{

	my $argument = shift(@ARGV);

	if($argument eq "-h")

	{

		ShowHelp();

	}

	elsif($argument eq "-e")

	{

		$optionShowMessages = 1;

	}

	elsif($argument eq "-s")

	{

		$optionSortCases = 1;

	}

	elsif($argument eq "-html")

	{

		$optionHtml = 1;

	}

	elsif($argument eq "-logall")

	{

		$optionLogAllCases = 1;

	}

	elsif($argument eq "-nologs")

	{

		$optionNoLogs = 1;

	}

	elsif($argument eq "-nosecuritytests")

	{

		$optionNoSecurityTests = 1;

	}

	elsif($argument eq "-nolivetvtests")

	{

		$optionNoLiveTvTests = 1;

	}

	elsif($argument eq "-i")

	{

		$optionCaseIncludedInLog = 1;

	}

	elsif($argument eq "-file")

	{

		$file = shift(@ARGV);

		JustFormatLogFile($file);

		exit;

	}

	elsif($argument eq "-runtimes")

	{

		$optionCaseRunTimes = 1;

	}

	elsif($argument eq "-xxx")

	{

		$optionCaseIncludedInLog = 1;

		$optionNoLiveTvTests = 1;

		$optionNoSecurityTests = 1;

		$optionHtml = 1;

	}

	elsif($argument eq "-good")

	{

		$optionGoodIsBetter = 1;

	}

	elsif($argument eq "-cfgsum")

	{

		$optionPrintCfgSummaries = 1;

	}

	elsif($argument eq "-finalize")

	{

		$optionFinalDoc = 1;

	}

	elsif($argument eq "-fix") {

		$optionFixFilename = shift(@ARGV);

		FixExcelLogPaths();

        exit();

	}

	elsif($argument eq "-debug") {

	    $optionShowMessages = 1;

	    $optionDebug = 1;

	}

	elsif($argument eq "-caselist") {

	    $optionCaseList = shift(@ARGV);

	}

	elsif($argument eq "-alt") {

	    $optionAltResults = 1;

	}

	elsif( $argument eq "-logfile") {

		$optionLogFileName = shift(@ARGV);

	}

	else

	{

	    ShowHelp();

	}

}

UnzipAndCopyFiles();

my $totalExecutionTime = 0;

my $caseLogOutDir = "testcase_logs\\testcase_logs\\";

my @caseList;

if($optionCaseList ne "")

{

    ReadCaseList(\@caseList, $optionCaseList);

}

# Find cfg files.

FindCfgFiles( ".", \@gCfgFiles );

# None found from current dir, see one dir lower.

FindCfgFiles( "..", \@gCfgFiles ) if( scalar( @gCfgFiles ) < 1 );

# Parse results

if($optionPrintCfgSummaries)

{

	PrintCfgSummaries();

}

elsif( !$optionAltResults )

{

    my $res = ReadTestReports();

	if( $res == 0 )

	{

        foreach my $file ( @globalTempFiles )

        {

            unlink $file if( -e $file );

        }

		print("No reports to read.\n");

		exit;

	}

    #ReportNotDocumentedCases($NOT_DOCUMENTED_CASES_FILE);

    if($optionSortCases)

    {

	    @cases = sort SortCases @cases;

    }

    CalculateStats();

    #WriteOfficeXml($XML_OUTPUT_FILE, 0);

    WriteOfficeXml($XML_BRIEF_OUTPUT_FILE, 1);

}

else

{

    my @runs;

    ReadTestReportsAlt(\@runs);

    WriteOfficeXmlAlt($XML_BRIEF_OUTPUT_FILE, \@runs);

}

#print("Total run time: " . $totalExecutionTime . "\n") if( $optionCaseRunTimes );

foreach my $file ( @globalTempFiles )

{

    unlink $file if( defined( $file ) && -e $file );

}

exit();

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

# UnzipAndCopyFiles

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

sub UnzipAndCopyFiles

{

	my @files;

	system("rmdir ziptemp /s /q>NUL") if( -e "ziptemp" );

	# Unzip zips in current directory and one level of subdirectories. -> ATS results.

	GetAllFiles( ".", \@files, 1 );

	foreach my $file ( @files )

	{

		if( $file =~ m/\.zip/i )

		{

			my $fileName = GetPathFileName( $file );

			mkdir ("ziptemp");

			my $cmd = "unzip -o \"$file\" -d ziptemp\\$fileName >NUL";

			print("Unzipping $file\n") if( $optionShowMessages );

			system( $cmd );

		}

	}

	undef( @files );

	GetAllFiles( ".", \@files, -1 );

	# Copy files to current dir.

	my $currDir = cwd;

	foreach my $file ( @files )

	{

	    next if( -d $file );

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

    	# Do nothing for files which are in current dir.

    	my $srcDir = GetPathDir( $file );

    	my $currpath = cwd;

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

    	next if( $srcDir eq $currpath );

	    my $filename = GetPathFileName( $file );

	    # LOOP all testreport*.txt testscripter*.txt

	    # if file is testreport.txt

	    #   lastFolder = last folder from the path

	    #     LOOP all fusion*.txt

	    #       LOOP remove tailing text from lastFolder starting from last index of '.' until it matches with folder of fusion*.txt

	    #          pair fusion*.txt with testreport

		if( ( $filename =~ m/testreport/i || $filename =~ m/testscripter/i ) && $filename =~ m/\.txt/i )

		#if( ( $filename =~ m/$optionLogFileName/i || $filename =~ m/testreport/i || $filename =~ m/testscripter/i ) && $filename =~ m/\.txt/i )

		{

		    my $dst = "";

		    if( $filename =~ m/testreport/i )

		    {

		        # Pair testreports and logs.

		        CopyTestReportWithLog( $file, \@files );

		    }

		    else

		    {

		        print("Copying file $file\n") if( $optionDebug );

		        # For other files we just need unique filename and copy them.

            	$dst = $filename;

            	if( -e $filename )

            	{

                	# Separate file's name and extension.

                	my $name = "";

                	my $ext = "";

                	my $pos = index($filename, ".");

                	if( $pos != -1) 

                	{

                		$ext = substr( $filename, $pos );

                		$name = substr( $filename, 0, $pos );

                		my $count = 0;

                		while( 1 )

                		{

                		    $dst = "$name" . "_" . $count . $ext;

                		    last if( ! -e "$dst" );

                		    $count++;

                		    if( $count > 1000 )

                		    {

                		        $dst = "";

                		        last;

                		    }

                		}