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

// 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:

//

#include <f32file.h>

#include <f32dbg.h>

#include <e32test.h>

#include "t_server.h"

#include "t_chlffs.h"

#include "plugincommon.h"

#include "premodifier_plugin.h"

#include "modifier_plugin.h"

#include "observer_plugin.h"

#include "combinational_plugin.h"

#include "combinational2_plugin.h"

#include "stacked_plugin.h"

#include "stacked2_plugin.h"

#include "stacked3_plugin.h"

#include "drivec_plugin.h"

#include "drivez_plugin.h"

#include "allsupporteddrives_plugin.h"

#include "exclusiveaccess_plugin.h"

#include "unremovable_plugin.h"

#include <e32def.h>

#include <e32def_private.h>

RTest test(_L("Plugin Framework Version 2 Test"));

#define _plugin_test(r)		if(!r) { dismountAllPlugins(); test(r); }

class MyRPlugin : public RPlugin

	{

public:

	void DoRequest(TInt aReqNo,TRequestStatus& aStatus) const;

	void DoRequest(TInt aReqNo,TRequestStatus& aStatus,TDes8& a1) const;

	void DoRequest(TInt aReqNo,TRequestStatus& aStatus,TDes8& a1,TDes8& a2) const;

	TInt DoControl(TInt aFunction) const;

	TInt DoControl(TInt aFunction,TDes8& a1) const;

	TInt DoControl(TInt aFunction,TDes8& a1,TDes8& a2) const;

	void DoCancel(TUint aReqMask) const;

	};

void dismountAllPlugins()

	{

	TheFs.DismountPlugin(KObserverPluginName);

	TheFs.DismountPlugin(KModifierPluginName);

	TheFs.DismountPlugin(KPreModifierPluginName);

	TheFs.DismountPlugin(KCombinationalPluginName);

	TheFs.DismountPlugin(KCombinational2PluginName);

	TheFs.DismountPlugin(KAllSupportedDrivesPluginName);

	TheFs.DismountPlugin(KDriveZPluginName);

	TheFs.DismountPlugin(KDriveCPluginName);

	TheFs.DismountPlugin(KStackedPluginName);

	TheFs.DismountPlugin(KStacked2PluginName);

	TheFs.DismountPlugin(KStacked3PluginName);

	TheFs.DismountPlugin(KExclusiveAccessPluginName);

	TheFs.DismountPlugin(KUnremovablePluginName);

	TheFs.RemovePlugin(KObserverPluginName);

	TheFs.RemovePlugin(KModifierPluginName);

	TheFs.RemovePlugin(KPreModifierPluginName);

	TheFs.RemovePlugin(KCombinationalPluginName);

	TheFs.RemovePlugin(KCombinational2PluginName);

	TheFs.RemovePlugin(KAllSupportedDrivesPluginName);

	TheFs.RemovePlugin(KDriveZPluginName);

	TheFs.RemovePlugin(KDriveCPluginName);

	TheFs.RemovePlugin(KStackedPluginName);

	TheFs.RemovePlugin(KStacked2PluginName);

	TheFs.RemovePlugin(KStacked3PluginName);

	TheFs.RemovePlugin(KExclusiveAccessPluginName);

	TheFs.RemovePlugin(KUnremovablePluginName);

	}

inline void safe_test(TInt aError, TInt aLine, TText* aName)

	{

	if(aError!=KErrNone)

		{

		test.Printf(_L("Error: %d receieved on line %d\n"),aError,aLine);

		dismountAllPlugins();

		test.operator()(aError==KErrNone,aLine,(TText*)aName);

		}

	}

inline void plugin_test(RTest& test, TInt aUniquePluginPos, TInt aLine, TText* aName)

	{

	__UHEAP_MARK;

	MyRPlugin rplugin;

	TInt error = KErrNone;

	TInt lineNumber;

	TPckg<TInt> errCodePckg(error);

	TPckg<TInt> lineNumberPckg(lineNumber);

	test.Next(_L("Open RPlugin connection"));

	TInt r = rplugin.Open(TheFs,aUniquePluginPos);

	if(r!=KErrNone)

		{

		dismountAllPlugins();

		}

	//This next lines aren't needed though I'm leaving them here

	//for reference.

	// ...

	//const TText name[16] = (const TText *) Expand(__FILE__);

	//TPckg<TText[16]> namePckg(name);

	//test.operator()(r==KErrNone,aLine,(TText*)&namePckg());

	// ...

	//test for Open

	test.operator()(r==KErrNone,aLine,(TText*)aName);

	test.Next(_L("Check plugin for any errors"));

	r = rplugin.DoControl(KPluginGetError,errCodePckg,lineNumberPckg);

	//test for DoControl

	if(r!=KErrNone)

		{

		dismountAllPlugins();

		test.operator()(r==KErrNone,aLine,(TText*)aName);

		}

	if(error != KErrNone)

		{

		test.Printf(_L("Error code == %d, from lineNumber == %d"),error,lineNumber);

		}

	//test for actual error

	if(r!=KErrNone)

		{

		dismountAllPlugins();

		test.operator()(error==KErrNone,aLine,(TText*)aName);

		}

	rplugin.Close();

	__UHEAP_MARKEND;

	}

void MyRPlugin::DoRequest(TInt aReqNo,TRequestStatus& aStatus) const

	{

	RPlugin::DoRequest(aReqNo,aStatus);

	}

void MyRPlugin::DoRequest(TInt aReqNo,TRequestStatus& aStatus,TDes8& a1) const

	{

	RPlugin::DoRequest(aReqNo,aStatus,a1);

	}

void MyRPlugin::DoRequest(TInt aReqNo,TRequestStatus& aStatus,TDes8& a1,TDes8& a2) const

	{

	RPlugin::DoRequest(aReqNo,aStatus,a1,a2);

	}

TInt MyRPlugin::DoControl(TInt aFunction) const

	{

	return RPlugin::DoControl(aFunction);

	}

TInt MyRPlugin::DoControl(TInt aFunction,TDes8& a1) const

	{

	return RPlugin::DoControl(aFunction,a1);

	}

TInt MyRPlugin::DoControl(TInt aFunction,TDes8& a1,TDes8& a2) const

	{

	return RPlugin::DoControl(aFunction,a1,a2);

	}

void MyRPlugin::DoCancel(TUint aReqMask) const

	{

	RPlugin::DoCancel(aReqMask);

	}

TInt ReplaceFiles(TDes16 &aPath, TDes8 &aContent, TInt aLine)

	{

	RFile file;

	TInt r=KErrNone;

	r = file.Replace(TheFs, aPath, EFileWrite);

	test.operator()(r==KErrNone,aLine,_S("t_plugin_v2.cpp"));

	r = file.Write(aContent);

	test.operator()(r==KErrNone,aLine,_S("t_plugin_v2.cpp"));

	file.Close();

	return r;

	}

void SetupTestFiles()

	{

	test.Next(_L("Setting up test files"));

	TBuf<40> path1;

	TBuf<40> path2;

	TBuf<40> path3;

	TInt theDrive;

	TInt r=TheFs.CharToDrive(gDriveToTest,theDrive);

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	path1.Append(gDriveToTest);

	path1.Append(_L(":\\data\\oldtest.tst"));

	path2.Append(gDriveToTest);

	path2.Append(_L(":\\data\\"));

	path3.Append(gDriveToTest);

	path3.Append(_L(":\\data2\\"));

	test.Next(_L("Setting up test files"));

	r = TheFs.Delete(path1);

	test(r==KErrNone || r==KErrNotFound || r==KErrPathNotFound);

	r = TheFs.MkDir(path2);

	test(r==KErrNone || r==KErrAlreadyExists);

	r = TheFs.MkDir(path3);

	test(r==KErrNone || r==KErrAlreadyExists);

	}

void LoadAndMountPlugins()

	{

	TInt r = KErrNone;

	test.Next(_L("Loading Observer plugin"));

	r = TheFs.AddPlugin(KObserverPluginFileName);

	if (r == KErrAlreadyExists) r = KErrNone;

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	r = TheFs.MountPlugin(KObserverPluginName);

	if (r == KErrInUse) r = KErrNone;

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	test.Next(_L("Loading PreModifier plugin"));

	r = TheFs.AddPlugin(KPreModifierPluginFileName);

	if (r == KErrAlreadyExists) r = KErrNone;

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	r = TheFs.MountPlugin(KPreModifierPluginName);

	if (r == KErrInUse) r = KErrNone;

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	test.Next(_L("Loading Modifier plugin"));

	r = TheFs.AddPlugin(KModifierPluginFileName);

	if (r == KErrAlreadyExists) r = KErrNone;

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	r = TheFs.MountPlugin(KModifierPluginName,KPluginAutoAttach);

	if (r == KErrInUse) r = KErrNone;

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	r = TheFs.MountPlugin(KModifierPluginName,20);

	if(r==KErrInUse) r = KErrNone;

	//Use RPlugin to communicate to the plugins which drive they should be

	//testing on.

	//This is needed because sometimes a plugin may open a different file etc and will need

	//to know which drive it should be testing on.

	MyRPlugin rplugin;

	TPckg<TChar> drivePckg(gDriveToTest);

	test.Next(_L("Open RPlugin connection for ModifierPlugin"));

	r = rplugin.Open(TheFs,KModifierPos);

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	test.Next(_L("Send drive letter to test down to plugin"));

	r = rplugin.DoControl(KPluginSetDrive,drivePckg);

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	rplugin.Close();

	test.Next(_L("Open RPlugin connection for PreModifierPlugin"));

	r = rplugin.Open(TheFs,KPreModifierPos);

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	test.Next(_L("Send drive letter to test down to plugin"));

	r = rplugin.DoControl(KPluginSetDrive,drivePckg);

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	rplugin.Close();

	// As an extra test, open an RPlugin handle but don't close to test subsession cleanup on session closure...

	RFs myFs;

	r = myFs.Connect();

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	r = rplugin.Open(myFs,KModifierPos);

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	// Don't close:	rplugin.Close();

	myFs.Close();

	// Test the memory cleanup for asynchronous request

	r = rplugin.Open(TheFs,KModifierPos);

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	rplugin.DoRequest(1,aStatus,drivePckg);

	User::WaitForRequest(aStatus);

	rplugin.Close();

	}

//-------------------------------------------------------------------------------------------------

//! @SYMTestCaseID				KBASE-t_plugin_v2-1336

//! @SYMTestType				CT

//! @SYMTestCaseDesc			Client request to read data directly from a file

//! @SYMPREQ					REQ7902

//! @SYMTestPriority			High

//! @SYMTestActions				TestReadFileDirect() disables intercepts on any mounted plugin.

//!								Following this, it opens a test file and sends a read request directly

//!								to the fileserver.

//!

//!								1.	Disable intercepts.

//!								2.  Set up test file name and path.

//!								3.	Open file for read access.

//!								4.	Read data from test file.

//!								5.	Close test file.

//!								6.	Enable intercepts.

//!

//!

//! @SYMTestExpectedResults		1.	Intercepts disabled without any panic

//!								2.	Test file created without any panic

//!								3.	File opened without any panic

//!								4.	Read request completes by bypassing plug-in without any panic

//!								5.	File close without any panic.

//!								6.	Intercepts enabled.

//!

//! @SYMTestPriority			High

//! @SYMTestStatus				Implemented

//-------------------------------------------------------------------------------------------------

void TestReadFileDirect()

	{

	//As the plugin is installed at this point, rather than removing it

	MyRPlugin rplugin;

	TInt r = rplugin.Open(TheFs,KModifierPos);

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	TBool interceptsStatus;

	TPckg<TBool> interceptsStatusDes(interceptsStatus);

	r = rplugin.DoControl(KPluginToggleIntercepts,interceptsStatusDes);

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	test.Next(_L("Ensure that intercepts are now disabled"));

	if(!interceptsStatus) r = KErrNone;

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	rplugin.Close();

	interceptsStatus = ETrue;

	r = rplugin.Open(TheFs,KObserverPos);

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	r = rplugin.DoControl(KPluginToggleIntercepts,interceptsStatusDes);

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	test.Next(_L("Ensure that intercepts are now disabled"));

	if(!interceptsStatus) r = KErrNone;

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	rplugin.Close();

	RFile file;

	TBuf8<4> narrow_buffer;

	TBuf16<4> wide_buffer;

	TBuf<256> filename;

	TBuf8<10> content;

	//setting up test files

	filename.Append(gDriveToTest);

	filename.Append(_L(":\\data\\test.txt"));

	content.Copy(_L8("1234567890"));

	ReplaceFiles(filename, content,__LINE__);

	r = file.Open(TheFs, filename, EFileRead);

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	test.Next(_L("Reading from a file directly first time"));

	r = file.Read(narrow_buffer); // -> returns data from pos 0 to 3

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	wide_buffer.Copy(narrow_buffer);

	test.Printf(_L("read: %S\n"), &wide_buffer);

	test.Next(_L("Reading from a file directly second time"));

	r = file.Read(narrow_buffer); // -> returns data from pos 4 to 8

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	wide_buffer.Copy(narrow_buffer);

	test.Printf(_L("read: %S\n"), &wide_buffer);

	test.Next(_L("Reading from a file directly complete"));

	file.Close();

	//Turn intercepts back on.

    interceptsStatus = EFalse;

	r = rplugin.Open(TheFs,KModifierPos);

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	r = rplugin.DoControl(KPluginToggleIntercepts,interceptsStatusDes);

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	test.Next(_L("Ensure that intercepts are now enabled"));

	if(interceptsStatus) r = KErrNone;

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	rplugin.Close();

	interceptsStatus = EFalse;

	r = rplugin.Open(TheFs,KObserverPos);

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	r = rplugin.DoControl(KPluginToggleIntercepts,interceptsStatusDes);

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	test.Next(_L("Ensure that intercepts are now enabled"));

	if(interceptsStatus) r = KErrNone;

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	rplugin.Close();

	}

//-------------------------------------------------------------------------------------------------

//! @SYMTestCaseID				KBASE-t_plugin_v2-1337

//! @SYMTestType				CT

//! @SYMTestCaseDesc			Client request to read data via a plugin from a file

//! @SYMPREQ					REQ7902

//! @SYMTestPriority			High

//! @SYMTestActions				TestReadFileDirect() opens a file for read access.

//!								Following this, it sends a read request via a plugin to the fileserver.

//!

//!								1.	Set up test file name and path.

//!								2.  Open file for read access.

//!								3.	Read data from test file.

//!								4.  Get current size of file.

//!								5.  Read data from test file .

//!								6.	Verify that the correct data was read from the test file.

//!								7.	Close test file.

//!

//!

//!

//! @SYMTestExpectedResults		1.	Test file created without any panic.

//!								2.	File opened without any panic.

//!								3.	Read request completes by bypassing plug-in without any panic.

//!								4.	Size of file returned without any panic.

//!								5.	Read request completes by bypassing plug-in without any panic.

//!								6.	Correct data read by from test file.

//!								7.	File close without any panic.

//!

//!

//! @SYMTestPriority			High

//! @SYMTestStatus				Implemented

//-------------------------------------------------------------------------------------------------

void TestReadFileViaPlugin()

	{

	RFile file;

	TBuf8<4> narrow_buffer;

	narrow_buffer.FillZ(4);

	TBuf16<4> wide_buffer;

	wide_buffer.FillZ(4);

	TBuf<256> filename;

	TBuf8<10> content;

	//setting up test files

	filename.Append(gDriveToTest);

	filename.Append(_L(":\\data\\test.tst"));

	content.Copy(_L8("1234567890"));

	ReplaceFiles(filename, content,__LINE__);

	TInt r = file.Open(TheFs, filename, EFileRead);

	plugin_test(test,KModifierPos,__LINE__,(TText*)Expand("modifier_plugin.cpp"));

	plugin_test(test,KPreModifierPos,__LINE__,(TText*)Expand("premodifier_plugin.cpp"));

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	test.Next(_L("Reading from a file via a plugin using CFsPlugin::FileRead first time"));

	r = file.Read(narrow_buffer); // -> returns data from pos 0 to 3

	plugin_test(test,KModifierPos,__LINE__,(TText*)Expand("modifier_plugin.cpp"));

	plugin_test(test,KPreModifierPos,__LINE__,(TText*)Expand("premodifier_plugin.cpp"));

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	wide_buffer.Copy(narrow_buffer);

	RDebug::Print(_L("read: %S\n"), &wide_buffer);

	TInt size=0;

	r = file.Size(size);

	plugin_test(test,KModifierPos,__LINE__,(TText*)Expand("modifier_plugin.cpp"));

	plugin_test(test,KPreModifierPos,__LINE__,(TText*)Expand("premodifier_plugin.cpp"));

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	RDebug::Print(_L("RFile::size = %d"),size);

	test.Next(_L("Reading from a file via a plugin using CFsPlugin::FileRead second time"));

	r = file.Read(narrow_buffer); // -> returns data from pos 4 to 8

	plugin_test(test,KModifierPos,__LINE__,(TText*)Expand("modifier_plugin.cpp"));

	plugin_test(test,KPreModifierPos,__LINE__,(TText*)Expand("premodifier_plugin.cpp"));

	safe_test(r,__LINE__,(TText*)Expand("t_plugin_v2.cpp"));

	wide_buffer.Copy(narrow_buffer);

	RDebug::Print(_L("read: %S\n"), &wide_buffer);

	test.Next(_L("Reading from a file via a plugin using CFsPlugin::FileRead complete"));

	file.Close();

	}

//-------------------------------------------------------------------------------------------------

//! @SYMTestCaseID				KBASE-t_plugin_v2-1338

//! @SYMTestType				CT

//! @SYMTestCaseDesc			Client request to write to a file directly

//! @SYMPREQ					REQ7902

//! @SYMTestPriority			High

//! @SYMTestActions				TestWriteFileDirect() disables intercepts on any mounted plugin.

//!								Following this, it opens a test file and sends a write request directly

//!								to the fileserver.

//!

//!								1.	Disable intercepts.

//!								2.  Set up test file name and path.