appfw/apparchitecture/tef/T_RecUpgrade.cpp
changeset 0 2e3d3ce01487
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/appfw/apparchitecture/tef/T_RecUpgrade.cpp	Tue Feb 02 10:12:00 2010 +0200
@@ -0,0 +1,370 @@
+// Copyright (c) 2009 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:
+// This test case is used to verify that a recognizer plugin can be upgraded and  used 
+// without reboot.
+//
+// t_recupgrade.cpp
+//
+
+
+
+/**
+ @file t_recupgrade.cpp
+ @internalComponent - Internal Symbian test code
+*/
+
+#include "testableapalssession.h"
+#include "T_RecUpgrade.h"
+#include "TRecUpgrade/upgconstants.h"
+
+//
+
+// Should be enough for CApaEComMonitor to detect new plugin
+const TInt KOneSecondDelay = 1000000;
+
+//
+
+CT_RecUpgradeStep::CT_RecUpgradeStep()
+	{
+	// Call base class method to set up the human readable name for logging
+	SetTestStepName(KT_RecUpgradeStep);
+	}
+
+CT_RecUpgradeStep::~CT_RecUpgradeStep()
+	{
+	}
+
+
+TInt CT_RecUpgradeStep::DeleteFileL(const TDesC &aFileName, RSmlTestUtils &fs)
+	{
+	TInt fileExists = EFalse;
+	TInt err;
+	fs.IsFilePresent(aFileName, fileExists);
+	if (fileExists)
+		{
+		fs.ChangeFilePermissionL(aFileName); // clear readonly attribute inherited from z:
+		err = fs.DeleteFileL(aFileName);
+		return(err);
+		}
+	return(KErrNotFound);
+	}
+
+/**
+Check that the test plugin file has not been left in the filesystem from a previous run.
+*/
+TVerdict CT_RecUpgradeStep::doTestStepPreambleL()
+	{
+	RSmlTestUtils fs;
+	CleanupClosePushL(fs);
+	User::LeaveIfError(fs.Connect());
+	
+	INFO_PRINTF1(_L("Verifies that recupgrade.rsc was not present during boot."));
+	TBool fileExists = ETrue;
+	TInt err = fs.IsFilePresent(KUpgRscTargetPath, fileExists);
+	TESTE(fileExists==EFalse, err);
+	
+	CleanupStack::PopAndDestroy(&fs);
+	return TestStepResult();
+	}
+
+/*
+Delete the plugin file which was installed during the test from c:.
+*/
+TVerdict CT_RecUpgradeStep::doTestStepPostambleL()
+	{
+	RSmlTestUtils fs;
+	CleanupClosePushL(fs);
+	User::LeaveIfError(fs.Connect());
+
+	TInt err = CT_RecUpgradeStep::DeleteFileL(KUpgRscTargetPath,fs);
+	if(err == KErrNone || err == KErrNotFound) 
+		INFO_PRINTF1(_L("Removed temporary file recupgrade.rsc or not found"));
+	else 
+		INFO_PRINTF1(_L("Failed to remove temporary file recupgrade.rsc"));	
+	
+	err = CT_RecUpgradeStep::DeleteFileL(KUpgDllTargetPath,fs);
+	if(err == KErrNone || err == KErrNotFound) 
+		INFO_PRINTF1(_L("Removed temporary file recupgrade.dll or not found"));
+	else 
+		INFO_PRINTF1(_L("Failed to remove temporary file recupgrade.dll"));	
+
+	CleanupStack::PopAndDestroy(&fs);
+	return TestStepResult();
+	}
+	
+/*
+The test entry point
+*/			
+TVerdict CT_RecUpgradeStep::doTestStepL()
+	{
+	RTestableApaLsSession apparcServer;
+	CleanupClosePushL(apparcServer);
+	User::LeaveIfError(apparcServer.Connect());
+	HEAP_TEST_LS_SESSION(apparcServer, 0, 0, TestUpgradeRecognizerL(apparcServer), apparcServer.FlushRecognitionCache());
+	HEAP_TEST_LS_SESSION(apparcServer, 0, 0, TestUpgradeRecognizer2L(apparcServer), apparcServer.FlushRecognitionCache());	
+
+	CleanupStack::PopAndDestroy(&apparcServer);
+	
+	return TestStepResult();
+	}
+
+/**
+@SYMTestCaseID APPFWK-APPARC-0100
+
+@SYMDEF INC127312
+
+@SYMTestCaseDesc This test verify that apparc can dynamically upgrade and use an Ecom recognizer plugin.
+
+@SYMTestPriority High
+
+@SYMTestStatus Implemented
+
+@SYMTestActions:
+	
+	1. Try to recognize .upg file with version 1 of recupgrade ECOM plugin but if shuld not be able to recognize as it is implemented like that
+	2. Install version 2 of recupgrade plugin (copy recupgrade_armv5_rel.dll and recupgrade.rsc from z:\system\data to c:\sys\bin and c:\resource\plugin respectively)
+	3. Because of installation Apparc will be notified and it will reload all recognizers plugin
+	4. Now try to recognize .upg file . it shuld be able to recognize as vertion 2 is implemented like that
+
+@SYMTestExpectedResults Test should complete without any leave, panic or error.
+ */
+void CT_RecUpgradeStep::TestUpgradeRecognizerL(RApaLsSession& aApparcServer)
+	{
+	
+	TDataRecognitionResult recogResult;
+	TBuf8<255> buffer;
+	buffer.FillZ(255);
+	recogResult.Reset();
+		
+	// Since recognizer for "mime\upg" mime type is installed but it will return CApaDataRecognizerType::ENotRecognized as implemented : call to RecognizeData()
+	// returns CApaDataRecognizerType::ENotRecognized.
+	INFO_PRINTF1(_L("MIME type recognition cache is not used..."));
+	TEST(aApparcServer.RecognizeData(KUpgDocPath, buffer, recogResult)==KErrNone);
+
+	TEST(recogResult.iConfidence == CApaDataRecognizerType::ENotRecognized);
+
+	INFO_PRINTF1(_L("Installs upgrade of  mime/upg recognizer plugin file "));
+	RSmlTestUtils fs;
+	CleanupClosePushL(fs);
+	User::LeaveIfError(fs.Connect());
+	
+	// Ensure c:\\resource\\plugins is created, otherwise leave from this teststep
+	TInt err = fs.CreateDirectoryL(KUpgRscTargetDir);
+	TESTEL((err == KErrNone || err == KErrAlreadyExists), err);
+	INFO_PRINTF1(_L("c:\\resource\\plugins is created successfully or already exists"));
+	
+	// Ensure c:\\sys\\bin is created, otherwise leave from this teststep
+	err = fs.CreateDirectoryL(KUpgDllTargetDir);
+	TESTEL((err == KErrNone || err == KErrAlreadyExists), err);
+	INFO_PRINTF1(_L("c:\\sys\\bin is created successfully or already exists"));
+
+	// Copy recupgrade.rsc from z:\\ to c:\\resource\\plugins, to trigger the rescan for plugins.
+	err = fs.CopyFileL(KUpgRscSourcePath, KUpgRscTargetPath);
+	TEST(err == KErrNone);
+	INFO_PRINTF1(_L("Successfully copied recupgrade.rsc from Z:\\system\\data to c\\resource\\plugins"));
+
+	// Copy recupgrade_*.dll from z:\\ to c:\\sys\\bin.
+	err = fs.CopyFileL(KUpgDllSourcePathArmv5, KUpgDllTargetPath);
+	
+	TEST(err == KErrNone);
+	INFO_PRINTF1(_L("Successfully copied recupgrade_*.dll from Z:\\system\\data to c:\\sys\\bin"));
+
+	INFO_PRINTF2(_L("Waits %d seconds for new mime/upg recognizer with ECertain confidence to be installed."), (5 * KOneSecondDelay)/1000000);	
+	User::After(5 * KOneSecondDelay);
+	
+	// Test whether newly installed (or copied) plugin to c: drive is loaded by framework and recognizes file with .upg extension.  
+	INFO_PRINTF1(_L("MIME type recognition cache is flushed when a new recogizer is installed"));
+	recogResult.Reset();
+	TEST(aApparcServer.RecognizeData(KUpgDocPath, buffer, recogResult)==KErrNone);
+	TEST(recogResult.iDataType.Des8().CompareF(KMimeUpgType) == 0);
+	TEST(recogResult.iConfidence == CApaDataRecognizerType::ECertain);		
+	
+	// Delete the plugin resource file of the recognizer with ECertain confidence which was installed during the test from z:.
+	err=CT_RecUpgradeStep::DeleteFileL(KUpgRscTargetPath,fs);
+	if(err == KErrNone) 
+		INFO_PRINTF1(_L("Removed file recupgrade.rsc"));
+	else 
+		INFO_PRINTF1(_L("Failed to remove recupgrade.rsc"));	
+
+	err=CT_RecUpgradeStep::DeleteFileL(KUpgDllTargetPath,fs);
+	if(err == KErrNone) 
+		INFO_PRINTF1(_L("Removed file recupgrade.dll"));
+	else 
+		INFO_PRINTF1(_L("Failed to remove recupgrade.dll"));
+
+
+	INFO_PRINTF2(_L("Waits %d seconds for the data recognizer list maintained by EMIME to be updated"), (10 * KOneSecondDelay)/1000000);	
+ 	User::After(10 * KOneSecondDelay);
+	
+	// Since "mime/upg" recognizer version 2 is uninstalled, mime/upg mime type is not recognized. 
+	INFO_PRINTF1(_L("MIME type recognition cache is flushed when a existing recogizer is uninstalled"));
+	recogResult.Reset();
+	TEST(aApparcServer.RecognizeData(KUpgDocPath, buffer, recogResult)==KErrNone);
+	TEST(recogResult.iConfidence == CApaDataRecognizerType::ENotRecognized);
+	
+	CleanupStack::PopAndDestroy(&fs);
+	}
+
+
+/**
+@SYMTestCaseID APPFWK-APPARC-0101
+
+@SYMDEF INC127312
+
+@SYMTestCaseDesc This test verify that apparc can dynamically upgrade a plugin if the new plugin replaces existing plugin (i.e new plugin is installed to same drive where the old plugin resides).
+
+@SYMTestPriority High
+
+@SYMTestStatus Implemented
+
+@SYMTestActions:
+	
+	1. Try to recognize .upg file with version 1 of recupgrade ECOM plugin but if shuld not be able to recognize as it is implemented like that
+	2. Install version 2 of recupgrade plugin (copy recupgrade_armv5_rel.dll and recupgrade.rsc from z:\system\data to c:\sys\bin and c:\resource\plugin respectively)
+	3. Because of installation Apparc will be notified and it will reload all recognizers plugin
+	4. Now try to recognize .upg file . it shuld be able to recognize as vertion 2 is implemented like that
+	5. Delete the version 2 plugin files and copy version 3 plugin files to c: drive (copy recupgrade2_armv5_rel.dll and recupgrade2.rsc from z:\system\data to c:\sys\bin and c:\resource\plugin respectively)
+	6. Now try to recognize .upr file . it shuld be able to recognize as vertion 3 is implemented like that
+
+@SYMTestExpectedResults Test should complete without any leave, panic or error.
+ */
+
+
+void CT_RecUpgradeStep::TestUpgradeRecognizer2L(RApaLsSession& aApparcServer)
+	{
+
+	TDataRecognitionResult recogResult;
+	TBuf8<255> buffer;
+	buffer.FillZ(255);
+	recogResult.Reset();
+		
+	// Since recognizer for "mime\upg" mime type is installed but it will return CApaDataRecognizerType::ENotRecognized as implemented : call to RecognizeData()
+	// returns CApaDataRecognizerType::ENotRecognized.
+	INFO_PRINTF1(_L("MIME type recognition cache is not used..."));
+	TEST(aApparcServer.RecognizeData(KUpgDocPath, buffer, recogResult)==KErrNone);
+	TEST(recogResult.iConfidence == CApaDataRecognizerType::ENotRecognized);
+
+	//Check the loaded plugin recognizes "mime/upr" data. Version 1 of the plugin should not recognize this data.
+	TEST(aApparcServer.RecognizeData(KUprDocPath, buffer, recogResult)==KErrNone);
+	TEST(recogResult.iConfidence == CApaDataRecognizerType::ENotRecognized);
+
+	INFO_PRINTF1(_L("Installs upgrade of  mime/upg recognizer plugin file "));
+	RSmlTestUtils fs;
+	CleanupClosePushL(fs);
+	User::LeaveIfError(fs.Connect());
+	
+	// Ensure c:\\resource\\plugins is created, otherwise leave from this teststep
+	TInt err = fs.CreateDirectoryL(KUpgRscTargetDir);
+	TESTEL((err == KErrNone || err == KErrAlreadyExists), err);
+	INFO_PRINTF1(_L("c:\\resource\\plugins is created successfully or already exists"));
+	
+	// Ensure c:\\sys\\bin is created, otherwise leave from this teststep
+	err = fs.CreateDirectoryL(KUpgDllTargetDir);
+	TESTEL((err == KErrNone || err == KErrAlreadyExists), err);
+	INFO_PRINTF1(_L("c:\\sys\\bin is created successfully or already exists"));
+
+	// Copy recupgrade.rsc from z:\\ to c:\\resource\\plugins, to trigger the rescan for plugins.
+	err = fs.CopyFileL(KUpgRscSourcePath, KUpgRscTargetPath);
+	TEST(err == KErrNone);
+	INFO_PRINTF1(_L("Successfully copied recupgrade.rsc from Z:\\system\\data to c\\resource\\plugins"));
+
+	// Copy recupgrade_*.dll from z:\\ to c:\\sys\\bin.
+	err = fs.CopyFileL(KUpgDllSourcePathArmv5, KUpgDllTargetPath);
+	
+	TEST(err == KErrNone);
+	INFO_PRINTF1(_L("Successfully copied recupgrade_*.dll from Z:\\system\\data to c:\\sys\\bin"));
+
+	INFO_PRINTF2(_L("Waits %d seconds for new mime/upg recognizer with ECertain confidence to be installed."), (5 * KOneSecondDelay)/1000000);	
+	User::After(5 * KOneSecondDelay);
+	
+	// Test whether newly installed (or copied) plugin to c: drive is loaded by framework and recognizes file with .upg extension.	INFO_PRINTF1(_L("MIME type recognition cache is flushed when a new recogizer is installed"));
+	recogResult.Reset();
+	TEST(aApparcServer.RecognizeData(KUpgDocPath, buffer, recogResult)==KErrNone);
+	TEST(recogResult.iDataType.Des8().CompareF(KMimeUpgType) == 0);
+	TEST(recogResult.iConfidence == CApaDataRecognizerType::ECertain);
+	
+	// Test whether newly installed (or copied) plugin does not recognize a file with .upr extension.
+	recogResult.Reset();
+	TEST(aApparcServer.RecognizeData(KUprDocPath, buffer, recogResult)==KErrNone);
+	TEST(recogResult.iConfidence == CApaDataRecognizerType::ENotRecognized);
+	
+	// Delete the plugin resource file of the recognizer with ECertain confidence which was installed during the test from z:.
+	err=CT_RecUpgradeStep::DeleteFileL(KUpgRscTargetPath,fs);
+	if(err == KErrNone) 
+		INFO_PRINTF1(_L("Removed file recupgrade.rsc"));
+	else 
+		INFO_PRINTF1(_L("Failed to remove recupgrade.rsc"));	
+
+	err=CT_RecUpgradeStep::DeleteFileL(KUpgDllTargetPath,fs);
+	if(err == KErrNone) 
+		INFO_PRINTF1(_L("Removed file recupgrade.dll"));
+	else 
+		INFO_PRINTF1(_L("Failed to remove recupgrade.dll"));
+
+	User::After(1 * KOneSecondDelay);	
+
+	// Copy recupgrade2.rsc from z:\\ to c:\\resource\\plugins, to trigger the rescan for plugins.
+	err = fs.CopyFileL(KUprRscSourcePath, KUpgRscTargetPath);
+	TEST(err == KErrNone);
+	INFO_PRINTF1(_L("Successfully copied recupgrade2.rsc from Z:\\system\\data to c:\\resource\\plugins"));
+
+	
+	// Copy recupgrade_*.dll from z:\\ to c:\\sys\\bin.
+	err = fs.CopyFileL(KUprDllSourcePathArmv5, KUpgDllTargetPath);
+	
+	TEST(err == KErrNone);
+	INFO_PRINTF1(_L("Successfully copied recupgrade2_*.dll from Z:\\system\\data to c:\\sys\\bin"));
+
+	
+	INFO_PRINTF2(_L("Waits %d seconds for new mime/upg recognizer with ECertain confidence to be installed."), (5 * KOneSecondDelay)/1000000);	
+	User::After(5 * KOneSecondDelay);
+	
+	// Test whether the plugin which replaces old plugin in c: drive is loaded by framework and recognizes file with .upr extension.
+	INFO_PRINTF1(_L("MIME type recognition cache is flushed when a new recogizer is installed"));
+	recogResult.Reset();
+	TEST(aApparcServer.RecognizeData(KUprDocPath, buffer, recogResult)==KErrNone);
+	TEST(recogResult.iDataType.Des8().CompareF(KMimeUprType) == 0);
+	TEST(recogResult.iConfidence == CApaDataRecognizerType::ECertain);
+
+	// Test whether the plugin which replaces old plugin in c: drive does not recognize a file with .upg extension.
+	recogResult.Reset();
+	TEST(aApparcServer.RecognizeData(KUpgDocPath, buffer, recogResult)==KErrNone);
+	TEST(recogResult.iConfidence == CApaDataRecognizerType::ENotRecognized);
+
+	
+	// Delete the plugin resource file of the recognizer with ECertain confidence which was installed during the test from z:.
+	err=CT_RecUpgradeStep::DeleteFileL(KUpgRscTargetPath,fs);
+	if(err == KErrNone) 
+		INFO_PRINTF1(_L("Removed file recupgrade.rsc"));
+	else 
+		INFO_PRINTF1(_L("Failed to remove recupgrade.rsc"));	
+
+	err=CT_RecUpgradeStep::DeleteFileL(KUpgDllTargetPath,fs);
+	if(err == KErrNone) 
+		INFO_PRINTF1(_L("Removed file recupgrade.dll"));
+	else 
+		INFO_PRINTF1(_L("Failed to remove recupgrade.dll"));
+
+	INFO_PRINTF2(_L("Waits %d seconds for the data recognizer list maintained by EMIME to be updated"), (10 * KOneSecondDelay)/1000000);	
+ 	User::After(10 * KOneSecondDelay);
+	
+	// Since "mime/upr" recognizer version 3 is uninstalled, mime/upr mime type is not recognized. 
+	INFO_PRINTF1(_L("MIME type recognition cache is flushed when a existing recogizer is uninstalled"));
+	recogResult.Reset();
+	TEST(aApparcServer.RecognizeData(KUprDocPath, buffer, recogResult)==KErrNone);
+	TEST(recogResult.iConfidence == CApaDataRecognizerType::ENotRecognized);
+
+	CleanupStack::PopAndDestroy(&fs);
+	}
+