C# Class Microsoft.Protocols.TestSuites.SharedTestSuite.SharedTestSuiteBase

Inheritance: Microsoft.Protocols.TestTools.TestClassBase

Show file Open project: OfficeDev/Interop-TestSuites Class Usage Examples

Protected Methods

Method	Description
CheckExclusiveLockExist ( string file, string exclusiveLockId ) : bool	This method is used to test whether the exclusive lock with the specified id exist on the file.
CheckExclusiveLockExist ( string file, string exclusiveLockId, string userName, string password, string domain ) : bool	This method is used to test whether the exclusive lock with the specified id exist on the file.
CheckSchemaLockExist ( string file, string schemaLockId ) : bool	This method is used to test whether the lock with the specified id exist on the file.
CheckSchemaLockExist ( string file, string schemaLockId, string userName, string password, string domain ) : bool	This method is used to test whether the lock with the specified id exist on the file.
FetchEditorTable ( string file ) : EditorsTable	This method is used to fetch editor table on the specified file.
InitializeContext ( string requestFileUrl, string userName, string password, string domain ) : void	Override to initialize the shared context based on the specified request file URL, user name, password and domain.
IsPresentInCoauthSession ( string fileUrl, string clientId, string schemaLockId, string userName, string password, string domain ) : bool	This method is used to check the user with specified client whether exist in a coauthoring session.
MergeConfigurationFile ( ITestSite site ) : void	Override to merge the common configuration and should/man configuration file.
PrepareCoauthoringSession ( string fileUrl, string clientId, string schemaLockId, int timeout = SharedTestSuiteHelper.DefaultTimeOut ) : CoauthStatusType	This method is used to prepare a coauthoring session on the file with the specified schema lock id and client id.
PrepareCoauthoringSession ( string fileUrl, string clientId, string schemaLockId, string userName, string password, string domain, int timeout = SharedTestSuiteHelper.DefaultTimeOut ) : CoauthStatusType	This method is used to prepare a coauthoring session on the file with the specified schema lock id and client id.
PrepareExclusiveLock ( string fileUrl, string exclusiveLockId, int timeout = SharedTestSuiteHelper.DefaultTimeOut ) : void	This method is used to prepare an exclusive lock on the file with the specified exclusive lock id.
PrepareExclusiveLock ( string fileUrl, string exclusiveLockId, string userName, string password, string domain, int timeout = SharedTestSuiteHelper.DefaultTimeOut ) : void	This method is used to prepare an exclusive lock on the file with the specified exclusive lock id.
PrepareFile ( ) : string	This method is used to upload a new Txt file to a random generated URL which is based on the current test case name.
PrepareJoinEditorsTable ( string fileUrl, string clientId ) : void	This method is used to prepare to join a editors table on the file using the specified client id.
PrepareJoinEditorsTable ( string fileUrl, string clientId, string userName, string password, string domain, int timeout = SharedTestSuiteHelper.DefaultTimeOut ) : void	This method is used to prepare to join a editors table on the file using the specified client id.
PrepareSchemaLock ( string fileUrl, string clientId, string schemaLockId, int timeout = SharedTestSuiteHelper.DefaultTimeOut ) : void	This method is used to prepare a schema lock on the file with the specified schema lock id and client id.
PrepareSchemaLock ( string fileUrl, string clientId, string schemaLockId, string userName, string password, string domain, int timeout = SharedTestSuiteHelper.DefaultTimeOut ) : void	This method is used to prepare a schema lock on the file with the specified schema lock id and client id.
PrepareSharedLock ( string fileUrl, string clientId, string schemaLockId, int timeout = SharedTestSuiteHelper.DefaultTimeOut ) : void	This method is used to prepare a schema lock or coauthoring on the file with the specified schema lock id and client id.
PrepareSharedLock ( string fileUrl, string clientId, string schemaLockId, string userName, string password, string domain, int timeout = SharedTestSuiteHelper.DefaultTimeOut ) : void	This method is used to prepare a schema lock or coauthoring on the file with the specified schema lock id and client id.

Private Methods

Method	Description
ClassCleanup ( ) : void
ClassInitialize ( TestContext testContext ) : void
MSFSSHTTP_FSSHTTPBTestCleanup ( ) : void
MSFSSHTTP_FSSHTTPBTestInitialize ( ) : void

Method Details

CheckExclusiveLockExist() protected method

This method is used to test whether the exclusive lock with the specified id exist on the file.

protected CheckExclusiveLockExist ( string file, string exclusiveLockId ) : bool
file	string	Specify the file.
exclusiveLockId	string	Specify the exclusive lock.
return	bool

CheckExclusiveLockExist() protected method

This method is used to test whether the exclusive lock with the specified id exist on the file.

protected CheckExclusiveLockExist ( string file, string exclusiveLockId, string userName, string password, string domain ) : bool
file	string	Specify the file.
exclusiveLockId	string	Specify the exclusive lock.
userName	string	Specify the user name of the user who calls cell storage service.
password	string	Specify the password of the user who calls cell storage service.
domain	string	Specify the domain of the user who calls cell storage service.
return	bool

CheckSchemaLockExist() protected method

This method is used to test whether the lock with the specified id exist on the file.

protected CheckSchemaLockExist ( string file, string schemaLockId ) : bool
file	string	Specify the file.
schemaLockId	string	Specify the schemaLock ID.
return	bool

CheckSchemaLockExist() protected method

This method is used to test whether the lock with the specified id exist on the file.

protected CheckSchemaLockExist ( string file, string schemaLockId, string userName, string password, string domain ) : bool
file	string	Specify the file.
schemaLockId	string	Specify the schemaLock ID.
userName	string	Specify the user name of the user who calls cell storage service.
password	string	Specify the password of the user who calls cell storage service.
domain	string	Specify the domain of the user who calls cell storage service.
return	bool

FetchEditorTable() protected method

This method is used to fetch editor table on the specified file.

protected FetchEditorTable ( string file ) : EditorsTable
file	string	Specify the file URL.
return	EditorsTable

InitializeContext() protected abstract method

Override to initialize the shared context based on the specified request file URL, user name, password and domain.

protected abstract InitializeContext ( string requestFileUrl, string userName, string password, string domain ) : void
requestFileUrl	string	Specify the request file URL.
userName	string	Specify the user name.
password	string	Specify the password.
domain	string	Specify the domain.
return	void

IsPresentInCoauthSession() protected method

This method is used to check the user with specified client whether exist in a coauthoring session.

protected IsPresentInCoauthSession ( string fileUrl, string clientId, string schemaLockId, string userName, string password, string domain ) : bool
fileUrl	string	Specify the file which is locked.
clientId	string	Specify the client ID.
schemaLockId	string	Specify the schemaLock ID.
userName	string	Specify the user name of the user who calls cell storage service.
password	string	Specify the password of the user who calls cell storage service.
domain	string	Specify the domain of the user who calls cell storage service.
return	bool

MergeConfigurationFile() protected abstract method

Override to merge the common configuration and should/man configuration file.

protected abstract MergeConfigurationFile ( ITestSite site ) : void
site	ITestSite	An instance of interface ITestSite which provides logging, assertions, /// and adapters for test code onto its execution context.
return	void

PrepareCoauthoringSession() protected method

This method is used to prepare a coauthoring session on the file with the specified schema lock id and client id.

protected PrepareCoauthoringSession ( string fileUrl, string clientId, string schemaLockId, int timeout = SharedTestSuiteHelper.DefaultTimeOut ) : CoauthStatusType
fileUrl	string	Specify the file which is locked.
clientId	string	Specify the client ID.
schemaLockId	string	Specify the schemaLock ID.
timeout	int	Specify the timeout value.
return	CoauthStatusType

PrepareCoauthoringSession() protected method

This method is used to prepare a coauthoring session on the file with the specified schema lock id and client id.

protected PrepareCoauthoringSession ( string fileUrl, string clientId, string schemaLockId, string userName, string password, string domain, int timeout = SharedTestSuiteHelper.DefaultTimeOut ) : CoauthStatusType
fileUrl	string	Specify the file which is locked.
clientId	string	Specify the client ID.
schemaLockId	string	Specify the schemaLock ID.
userName	string	Specify the user name of the user who calls cell storage service.
password	string	Specify the password of the user who calls cell storage service.
domain	string	Specify the domain of the user who calls cell storage service.
timeout	int	Specify the timeout value.
return	CoauthStatusType

PrepareExclusiveLock() protected method

This method is used to prepare an exclusive lock on the file with the specified exclusive lock id.

protected PrepareExclusiveLock ( string fileUrl, string exclusiveLockId, int timeout = SharedTestSuiteHelper.DefaultTimeOut ) : void
fileUrl	string	Specify the file which is locked.
exclusiveLockId	string	Specify the exclusive lock id.
timeout	int	Specify the timeout value.
return	void

PrepareExclusiveLock() protected method

This method is used to prepare an exclusive lock on the file with the specified exclusive lock id.

protected PrepareExclusiveLock ( string fileUrl, string exclusiveLockId, string userName, string password, string domain, int timeout = SharedTestSuiteHelper.DefaultTimeOut ) : void
fileUrl	string	Specify the file which is locked.
exclusiveLockId	string	Specify the exclusive lock id.
userName	string	Specify the user name of the user who calls cell storage service.
password	string	Specify the password of the user who calls cell storage service.
domain	string	Specify the domain of the user who calls cell storage service.
timeout	int	Specify the timeout value.
return	void

PrepareFile() protected method

This method is used to upload a new Txt file to a random generated URL which is based on the current test case name.

protected PrepareFile ( ) : string
return	string

PrepareJoinEditorsTable() protected method

This method is used to prepare to join a editors table on the file using the specified client id.

protected PrepareJoinEditorsTable ( string fileUrl, string clientId ) : void
fileUrl	string	Specify the file.
clientId	string	Specify the client ID.
return	void

PrepareJoinEditorsTable() protected method

This method is used to prepare to join a editors table on the file using the specified client id.

protected PrepareJoinEditorsTable ( string fileUrl, string clientId, string userName, string password, string domain, int timeout = SharedTestSuiteHelper.DefaultTimeOut ) : void
fileUrl	string	Specify the file.
clientId	string	Specify the client ID.
userName	string	Specify the user name of the user who calls cell storage service.
password	string	Specify the password of the user who calls cell storage service.
domain	string	Specify the domain of the user who calls cell storage service.
timeout	int	Specify the timeout value.
return	void

PrepareSchemaLock() protected method

This method is used to prepare a schema lock on the file with the specified schema lock id and client id.

protected PrepareSchemaLock ( string fileUrl, string clientId, string schemaLockId, int timeout = SharedTestSuiteHelper.DefaultTimeOut ) : void
fileUrl	string	Specify the file which is locked.
clientId	string	Specify the client ID.
schemaLockId	string	Specify the schemaLock ID.
timeout	int	Specify the timeout value.
return	void

PrepareSchemaLock() protected method

This method is used to prepare a schema lock on the file with the specified schema lock id and client id.

protected PrepareSchemaLock ( string fileUrl, string clientId, string schemaLockId, string userName, string password, string domain, int timeout = SharedTestSuiteHelper.DefaultTimeOut ) : void
fileUrl	string	Specify the file which is locked.
clientId	string	Specify the client ID.
schemaLockId	string	Specify the schemaLock ID.
userName	string	Specify the user name of the user who calls cell storage service.
password	string	Specify the password of the user who calls cell storage service.
domain	string	Specify the domain of the user who calls cell storage service.
timeout	int	Specify the timeout value.
return	void

PrepareSharedLock() protected method

This method is used to prepare a schema lock or coauthoring on the file with the specified schema lock id and client id.

protected PrepareSharedLock ( string fileUrl, string clientId, string schemaLockId, int timeout = SharedTestSuiteHelper.DefaultTimeOut ) : void
fileUrl	string	Specify the file which is locked.
clientId	string	Specify the client ID.
schemaLockId	string	Specify the schemaLock ID.
timeout	int	Specify the timeout value.
return	void

PrepareSharedLock() protected method

This method is used to prepare a schema lock or coauthoring on the file with the specified schema lock id and client id.

protected PrepareSharedLock ( string fileUrl, string clientId, string schemaLockId, string userName, string password, string domain, int timeout = SharedTestSuiteHelper.DefaultTimeOut ) : void
fileUrl	string	Specify the file which is locked.
clientId	string	Specify the client ID.
schemaLockId	string	Specify the schemaLock ID.
userName	string	Specify the user name of the user who calls cell storage service.
password	string	Specify the password of the user who calls cell storage service.
domain	string	Specify the domain of the user who calls cell storage service.
timeout	int	Specify the timeout value.
return	void