#

# All rights reserved.

# This component and the accompanying materials are made available

# under the terms of the License "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: 

# Perl script that creates PKG files and test MAKESIS tools with different ranges

#

$logFile = "/epoc32/winscw/c/makesis_test.txt";

$makesisExeLocation = "/epoc32/tools/makesis";

$dumpsisExeLocation = "/epoc32/tools/dumpsis";

sub GetTmpFilesCount()

{

	# get a number of temp files

	if ($^O =~ /^MSWIN32$/i)

		{

		my $dirname = "$ENV{'TEMP'}";

		opendir ( DIR, "$dirname" ) or die ( "Can't open dir: $dirname" ); #!

		my @List = readdir DIR;

		closedir DIR;

		my @TmpFiles = grep( /^~SI.*.tmp/ , @List );

		}

	else

		{

		my $dirname = "/tmp/";

		opendir ( DIR, "$dirname" ) or die ( "Can't open dir: $dirname" ); #!

		my @List = readdir DIR;

		closedir DIR;

		my @TmpFiles = grep( /tmp*/ , @List );

		}

	my $TmpCountBefore = @TmpFiles;

	return $TmpCountBefore;

}

#

#Function to write log into file

#

sub WriteLog {

	my ($log) = @_;

	#public $logfile;

	unless( open($fh, ">> $logFile")) {

		printf STDERR "Can\'t open $logfile:$!\n";

		return;

	}

	printf $fh $log;

	printf $log;

	close $fh;

}

#

# Function to create a file (test.txt or any PKG)

#

sub CreateFile {

	my ($filename, $contents) = @_;

	unless (open($fh, "> $filename")) {

		printf STDERR "Can't open $filename: $!\n";

		return;

	}

	print $fh $contents;

	close $fh;

}

#

# Function to check the log file of the makesis result

#

sub CheckLog {

	my ($pkgfile) = @_[0];

	my ($expectedLog) = @_[1];

	$logMsg = sprintf "Expected Log: %s\n", $expectedLog;

	WriteLog( $logMsg);	

	unless (open($resultlog, "$pkgfile.log")) {

		printf STDERR "Can't open $pkgfile.log: $!\n";

		return 0;

	}

	foreach $line (<$resultlog>) {

		if ( $line =~ m/\Q$expectedLog\E/i) {

			close($resultlog);

			return 1;

		}	

	}	

	close($resultlog);

	return 0;

}

#

# Run MAKESIS with prepared pkg file, log and administrate its result

#

sub MakeSISFile {

	my ($pkgfile) = @_[0];

	my ($expectedResult) = @_[1];

	my ($expectedLog) = @_[2];

	$pkgfile =~ s/\.pkg//;

	if($pkgfile ne "testinterpretflag") {

		@retval = system("$makesisExeLocation -v $pkgfile.pkg $pkgfile-tmp.sis > $pkgfile.log");

	}

	else {

		@retval = system("$makesisExeLocation -v -c $pkgfile.pkg $pkgfile-tmp.sis > $pkgfile.log");

	}

	$logMsg = sprintf "Expected code:%5d   result Code:%5d\n", $expectedResult, $?;

	WriteLog( $logMsg);

	$NumberOfTests++;

	if( $? == $expectedResult ) {

		if(CheckLog($pkgfile, $expectedLog)) {

			$NumberOfPassed++;

			WriteLog("Passed\n\n");

		}

		else {

			$NumberOfFailed++;

			WriteLog("Failed : Unexpected Error Log\n\n");

		}

	}

	else {

		$NumberOfFailed++;

		WriteLog("Failed : Unexpected Error Code\n\n");

	}

	unlink("$pkgfile-tmp.sis");

	unlink("$pkgfile.log");

	unlink("$pkgfile.pkg");

}

#

# Additional test to check that stub files don't change every time 

# they are built.

#

sub TestSISStubFile {

	$teststubpkg = "teststub.pkg";

	$teststubsis = "teststub.sis";

	$comparisonsis = "comparison.sis";

	$teststublog = "teststub.log";

	WriteLog("Test invariant stub file\n");

	# Generate test PKG file contents

	$PkgFile = sprintf( $PkgFileTempl, "-1,-1,-1"); 

	# Create PKG file

	CreateFile($teststubpkg, $PkgFile);	

	# Create a stub sis file

	my $result = system("$makesisExeLocation -s $teststubpkg $teststubsis > $teststublog");

	# Wait at least a second and generate it again

	sleep 2;

	rename($teststubsis, $comparisonsis) or  

        warn "Couldn't rename $teststubsis to $comparisonsis: $!\n";

	my $result2 = system("$makesisExeLocation -s $teststubpkg $teststubsis > $teststublog");

	# Check that the files are the same and log the result

	use File::Compare;

	$NumberOfTests++;

	if (compare($teststubsis, $comparisonsis) == 0 

	    && $result == 0

		&& $result2 == 0) 

		{

		$NumberOfPassed++;

		WriteLog("Passed\n\n");

		}

	else 

		{

		$NumberOfFailed++;

		WriteLog("Failed\n\n");

		}

	unlink $teststublog;

	unlink $teststubpkg;

	unlink $teststubsis ;

	unlink $comparisonsis;

}

#

# New test code for DEF083525 - makesis -vs does not create a stub sis file 

# This is based on TestSISStubFile, it builds the stub file with -s and -vs options 

# and checks the resulting files are the same.  The defects was that the "s" option

# was ignored so a stub file was not built.

#

sub TestDEF083525 {

	$teststubpkg = "teststub.pkg";

	$teststubsis = "teststub.sis";

	$comparisonsis = "comparison.sis";

	$teststublog = "teststub.log";

	WriteLog("Test for DEF083525 - makesis -vs does not create a stub sis file\n");

	# Generate test PKG file contents

	$PkgFile = sprintf( $PkgFileTempl, "-1,-1,-1"); 

	# Create PKG file

	CreateFile($teststubpkg, $PkgFile);	

	# Create a stub sis file

	my $result = system("$makesisExeLocation -s $teststubpkg $teststubsis > $teststublog");

	# Wait at least a second and generate it again this time using the -vs options

	# This defect was that the -vs options was ignored

	sleep 2;

	rename $teststubsis, $comparisonsis;

	my $result2 = system("$makesisExeLocation -vs $teststubpkg $teststubsis > $teststublog");

	# Check that the files are the same and log the result

	use File::Compare;

	$NumberOfTests++;

	if (compare($teststubsis, $comparisonsis) == 0 

	    && $result == 0

		&& $result2 == 0) 

		{

		$NumberOfPassed++;

		WriteLog("Passed\n\n");

		}

	else 

		{

		$NumberOfFailed++;

		WriteLog("Failed\n\n");

		}

	unlink $teststublog;

	unlink $teststubpkg;

	unlink $teststubsis ;

	unlink $comparisonsis;

}

#

# New test code for PDEF081989 - makesis parameter -d does not work any more. 

# This creates a testembedded.sis file embedding testembedding.sis. This test checks the 

# working of -d parameter where the search directory containing the embedding sis file is  

# specified with -d option.

#

sub TestPDEF081989 {

	$testembeddingpkg = "testembedding.pkg";

	$testembeddingsis = "testembedding.sis";

	$testembeddedpkg = "testembedded.pkg";

	$testembeddedsis = "testembedded.sis";

	$sisFileToEmbed = "/epoc32/winscw/c/";

	$outputFile = $sisFileToEmbed.$testembeddingsis;

	$testEmbedLog = "testembedded.log";

	WriteLog("Test for PDEF081989 - Test for successful creation of a sis file with -d option.\n");

	# Generate test PKG file contents for embedding pkg file.

	$PkgFile = sprintf( $PkgFileTempl, "-1,-1,-1"); 

	# Create PKG file

	CreateFile($testembeddingpkg, $PkgFile);	

	# Generate test PKG file contents for embedded pkg file.

	$PkgFile = sprintf( $embedContents, "-1,-1,-1"); 

	# Create PKG file

	CreateFile($testembeddedpkg , $PkgFile);

	# Create an embedding sis file

	my $result = system("$makesisExeLocation $testembeddingpkg $outputFile > $testEmbedLog");

	# Create an embedded sis file.Here the sis file embedded is situated elsewhere(in "\\epoc32\\winscw\\c\\").

	# Makesis -d option is used to specify the directory to search for sis file embedded. 

	my $result1 = system("$makesisExeLocation -d$sisFileToEmbed $testembeddedpkg $testembeddedsis > $testEmbedLog");

	$NumberOfTests++;

	if ($result == 0 && $result1 == 0) 

		{

		$NumberOfPassed++;

		WriteLog("Passed\n\n");

		}

	else 

		{

		$NumberOfFailed++;

		WriteLog("Failed\n\n");

		}

	unlink $testembeddingpkg;

	unlink $outputFile;

	unlink $testembeddedpkg;

	unlink $testembeddedsis;

	unlink $testEmbedLog;

}

#

# Test code for DEF104895 - makesis with -d option

# This creates a testembedded.sis file embedding testembedding.sis. This test checks the 

# working of -d parameter where the search directory(bacward slashes) containing the embedding sis file is  

# specified with -d option.

#

sub TestDEF104895 {

	$testembeddingpkg = "testembedding.pkg";

	$testembeddingsis = "testembedding.sis";

	$testembeddedpkg = "testembedded.pkg";

	$testembeddedsis = "testembedded.sis";

	$sisFileToEmbed = "\\epoc32\\winscw\\c\\";

	$outputFile = $sisFileToEmbed.$testembeddingsis;

	$testEmbedLog = "testembedded.log";

	WriteLog("Test for DEF104895 - Test for successful creation of a sis file with -d option.\n");

	# Generate test PKG file contents for embedding pkg file.

	$PkgFile = sprintf( $PkgFileTempl, "-1,-1,-1"); 

	# Create PKG file

	CreateFile($testembeddingpkg, $PkgFile);	

	# Generate test PKG file contents for embedded pkg file.

	$PkgFile = sprintf( $embedContents, "-1,-1,-1"); 

	# Create PKG file

	CreateFile($testembeddedpkg , $PkgFile);

	# Create an embedding sis file

	my $result = system("$makesisExeLocation $testembeddingpkg $outputFile > $testEmbedLog");

	# Create an embedded sis file.Here the sis file embedded is situated elsewhere(in "\\epoc32\\winscw\\c\\").

	# Makesis -d option is used to specify the directory to search for sis file embedded. 

	my $result1 = system("$makesisExeLocation -d$sisFileToEmbed $testembeddedpkg $testembeddedsis > $testEmbedLog");

	$NumberOfTests++;

	if ($result == 0 && $result1 == 0) 

		{

		$NumberOfPassed++;

		WriteLog("Passed\n\n");

		}

	else 

		{

		$NumberOfFailed++;

		WriteLog("Failed\n\n");

		}

	unlink $testembeddingpkg;

	unlink $outputFile;

	unlink $testembeddedpkg;

	unlink $testembeddedsis;

	unlink $testEmbedLog;

}

#

# New test code for DEF107033 - makesis parameter -d does not work with language dependent files

# 

#

sub TestDEF107033() {

	$testlanguagepkg = "testlanguage.pkg";

	$testlanguagesis = "testlanguagesis.sis";

	$testlanguagelog = "testlanguage.log";

	WriteLog("Test makesis parameter -d does not work with language dependent files\n");

	# Generate test PKG file contents

	$PkgFile = sprintf( $PkgLanguageFileTemp); 

	# Create PKG file

	CreateFile($testlanguagepkg, $PkgFile);	

	# Create a stub sis file

	my $result = system("$makesisExeLocation -d/epoc32/winscw/c/tswi/ $testlanguagepkg $testlanguagesis > $testlanguagelog");

	$NumberOfTests++;

	if ($result == 0) {

		$NumberOfPassed++;

		WriteLog("Passed\n\n");

	}

	else {

		$NumberOfFailed++;

		WriteLog("Failed\n\n");

	}

	unlink $testlanguagepkg;

	unlink $testlanguagesis;

	unlink $testlanguagelog ;

}

#

# Test code for DEF104895 - makesis with -d option

# This creates a testembedded.sis file embedding testembedding.sis. This test checks the 

# working of -d parameter where the search directory(bacward slashes) containing the embedding sis file is  

# specified with -d option.

#

sub TestLDEF104895 {

	$testembeddingpkg = "testembedding.pkg";

	$testembeddingsis = "testembedding.sis";

	$testembeddedpkg = "testembedded.pkg";

	$testembeddedsis = "testembedded.sis";

	$sisFileToEmbed = "\\\\epoc32\\\\winscw\\\\c\\\\";

	$outputFile = $sisFileToEmbed.$testembeddingsis;

	$testEmbedLog = "testembedded.log";

	WriteLog("Test for DEF104895 - Test for successful creation of a sis file with -d option.\n");

	# Generate test PKG file contents for embedding pkg file.

	$PkgFile = sprintf( $PkgFileTempl, "-1,-1,-1"); 

	# Create PKG file

	CreateFile($testembeddingpkg, $PkgFile);	

	# Generate test PKG file contents for embedded pkg file.

	$PkgFile = sprintf( $embedContents, "-1,-1,-1"); 

	# Create PKG file

	CreateFile($testembeddedpkg , $PkgFile);

	# Create an embedding sis file

	my $result = system("$makesisExeLocation $testembeddingpkg $outputFile > $testEmbedLog");

	# Create an embedded sis file.Here the sis file embedded is situated elsewhere(in "\\epoc32\\winscw\\c\\").

	# Makesis -d option is used to specify the directory to search for sis file embedded. 

	my $result1 = system("$makesisExeLocation -d$sisFileToEmbed $testembeddedpkg $testembeddedsis > $testEmbedLog");

	$NumberOfTests++;

	if ($result == 0 && $result1 == 0) 

		{

		$NumberOfPassed++;

		WriteLog("Passed\n\n");

		}

	else 

		{

		$NumberOfFailed++;

		WriteLog("Failed\n\n");

		}

	unlink $testembeddingpkg;

	unlink $outputFile;

	unlink $testembeddedpkg;

	unlink $testembeddedsis;

	unlink $testEmbedLog;

}

#

# New test code for DEF090878 - unexpected error by makesis when processing pkg file saved in UTF8 format

# This test uses existing utf8.pkg which contains UTF-8 encoded characters and in turn refers to utf8.txt

#

sub TestDEF090878 {

	my $path = "/epoc32/winscw/c/tswi";

	my $pkgfile = "$path/utf8";

	my $expectedResult = 0;

	WriteLog("Test for DEF090878 - unexpected error by makesis when processing pkg file saved in UTF8 format\n");

	WriteLog("UTF-8 encoded file: $pkgfile.pkg\n");

	# Do MAKESIS test

	@retval = system("$makesisExeLocation $pkgfile.pkg $pkgfile-tmp.sis > $pkgfile.log");

	$logMsg = sprintf "Expected code:%5d   result Code:%5d\n", $expectedResult, $?;

	WriteLog( $logMsg);

	$NumberOfTests++;

	if( $? == $expectedResult ) {

		$NumberOfPassed++;

		WriteLog("Passed\n\n");

	}

	else {

		$NumberOfFailed++;

		WriteLog("Failed\n\n");

	}

	unlink("$pkgfile-tmp.sis");

	unlink("$pkgfile.sis");

	unlink("$pkgfile.log");

}