User Guide

From ReliSourceWiki

(Difference between revisions)
Jump to: navigation, search
(Depot Treeview)
(Workspace)
 
(31 intermediate revisions not shown)
Line 1: Line 1:
-
== Test Generator ==
+
= Workspace =
-
== Test Executor ==
+
== Workspace Creation ==
-
== Test Library ==
+
Users set their local workspace at times of selecting their role as "Test Generator" or "Test Executor". Then a windows form comes having 6 textfields :
 +
*Perforce Port : Server address along with port given here. As for example it should be like this : 192.168.50.39:1666. But if the server address has the port number alliasing with the address, then user does not need to put any port number.
 +
 
 +
*Username : User puts a valid username in the textfield that is already enlisted in the perforce server.
 +
 
 +
*Password : User puts a valid password for that username that has been put in the username texfield.
 +
 
 +
*Workspace name : A new client is created here.It should be noted that the same name client is not present in the perforce server.
 +
 
 +
*Perforce Root : User selects the specific directory for the newly created client where the files and folders from the perforce server will be checked out.User can create new directory or any existing directory for the root.
 +
 
 +
*Perforce View : User puts only depot view here.If users want to make the Automated Test Tool application faster,the perforce view should look like:
 +
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//p4.wcr/proj/10093/trunk/MAIN/Automated_Test_Tool/ <br />
 +
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;or, <br />
 +
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//p4.wcr/proj/10093/trunk/MAIN/Automated_Test_Tool/Library/
 +
 
 +
*Users selects the checkbox to save password for future use.
 +
 
 +
== Client Login ==
 +
Users have their workspace set selecting their role as "Test Generator" or "Test Executor".If users want to login to the application, they will find two textfields :
 +
*username : User puts valid username that is available in the perforce server.
 +
 
 +
*password: User puts password that is valid for that username.<br/>
 +
If username and password matches, the user logs in to the application as the client that was created last time using the application.<br/ >
 +
User can select the checkbox to save the information so that login is not required every time when the application starts.
 +
 
 +
== Changing Workspace ==
 +
Users can change workspace name and can communicate with perforce server with different client using the application.<br />
 +
In the application go to 'Settings' tab. Select 'Perforce Connection'. A windows form comes that shows the workspace names created from current workstation.<br />
 +
Users can select any of the workspaces and can login through that perforce client.<br />
 +
Users can create new workspace here that is discussed in section 1.1
 +
 
 +
== Offline Mode==
 +
Users select 'Offline Mode' where no perforce connection is needed for 'Test Generator' as well as "Test Executor".Users select a directory where workspace will be pointed.Inside that directory 'Suite' and 'Case'  folders will be created automatically.Valid suite and case files should be put in respective folders.<br />
 +
Users as 'Test Executor' can execute testcases selecting a valid suite file.<br />
 +
Users as 'Test Generator' can generate new suites and save it in the offline workspace.
 +
 
 +
= Test Generator =
 +
 
 +
= Test Executor =
 +
= Test Library =
==Overview==
==Overview==
-
Library section is integrated with the perforce server and it shows the current perforce status of files like suites and cases. For "Offline Mode" the library section is disabled because it needs perforce server connection to generate the file list. There are basically two treeview in library section - workspace treeview and perforce depot treeview.  
+
Library section is integrated with the perforce server and it shows the current perforce status of files like suites and cases. For "Offline Mode" the library section is disabled because it needs perforce server connection to generate the file list. There are basically two treeview in library section - workspace treeview and perforce depot treeview.
 +
 
==Workspace Treeview==
==Workspace Treeview==
Line 37: Line 78:
==Depot Treeview==
==Depot Treeview==
-
Depot treeview show the current perforce server depot file structure and status. User can update or refresh the files by right clicking the files in the treeview.  
+
Depot treeview show the current perforce server depot file structure and status. User can update or refresh the files by right clicking the files in the treeview.
 +
 
 +
== Legend of file types==
-
=== Legend of file types===
 
* [[File:AddedFile.png]] &nbsp;Added file image icon.
* [[File:AddedFile.png]] &nbsp;Added file image icon.
* [[File:DeletedfFile.png]] &nbsp;Deleted file image icon.
* [[File:DeletedfFile.png]] &nbsp;Deleted file image icon.

Latest revision as of 08:40, 13 September 2011

Contents

Workspace

Workspace Creation

Users set their local workspace at times of selecting their role as "Test Generator" or "Test Executor". Then a windows form comes having 6 textfields :

  • Perforce Port : Server address along with port given here. As for example it should be like this : 192.168.50.39:1666. But if the server address has the port number alliasing with the address, then user does not need to put any port number.
  • Username : User puts a valid username in the textfield that is already enlisted in the perforce server.
  • Password : User puts a valid password for that username that has been put in the username texfield.
  • Workspace name : A new client is created here.It should be noted that the same name client is not present in the perforce server.
  • Perforce Root : User selects the specific directory for the newly created client where the files and folders from the perforce server will be checked out.User can create new directory or any existing directory for the root.
  • Perforce View : User puts only depot view here.If users want to make the Automated Test Tool application faster,the perforce view should look like:

       //p4.wcr/proj/10093/trunk/MAIN/Automated_Test_Tool/
       or,
       //p4.wcr/proj/10093/trunk/MAIN/Automated_Test_Tool/Library/

  • Users selects the checkbox to save password for future use.

Client Login

Users have their workspace set selecting their role as "Test Generator" or "Test Executor".If users want to login to the application, they will find two textfields :

  • username : User puts valid username that is available in the perforce server.
  • password: User puts password that is valid for that username.

If username and password matches, the user logs in to the application as the client that was created last time using the application.
User can select the checkbox to save the information so that login is not required every time when the application starts.

Changing Workspace

Users can change workspace name and can communicate with perforce server with different client using the application.
In the application go to 'Settings' tab. Select 'Perforce Connection'. A windows form comes that shows the workspace names created from current workstation.
Users can select any of the workspaces and can login through that perforce client.
Users can create new workspace here that is discussed in section 1.1

Offline Mode

Users select 'Offline Mode' where no perforce connection is needed for 'Test Generator' as well as "Test Executor".Users select a directory where workspace will be pointed.Inside that directory 'Suite' and 'Case' folders will be created automatically.Valid suite and case files should be put in respective folders.
Users as 'Test Executor' can execute testcases selecting a valid suite file.
Users as 'Test Generator' can generate new suites and save it in the offline workspace.

Test Generator

Test Executor

Test Library

Overview

Library section is integrated with the perforce server and it shows the current perforce status of files like suites and cases. For "Offline Mode" the library section is disabled because it needs perforce server connection to generate the file list. There are basically two treeview in library section - workspace treeview and perforce depot treeview.


Workspace Treeview

Users set their local workspace at times of selecting their role as "Test Generator" or "Test Executor". The workspace treeview tab binds the default workspace file structure in treeview. At times of binding, it connects with the perforce server and retrieves the current file status of every file. Workspace treeview shows different file icons to represent different file status. The legend of file types are described in section 5.1. Depending of file status there are 5 types of files :

  • Local file: These files are saved in local workspace but not saved in the perforce server depot.
  • Up to date file: This files are saved both in local workspace and perforce server depot. And both files are up to date and same.
  • Added file: These files are saved in local workspace and also added to the perforce change list to add in the perforce server depot.
  • Deleted file: This files are saved both in local workspace and perforce depot. And it is added to the perforce change list to delete from the perforce depot at next submission.
  • Edited file: This files are saved both in local workspace and perforce depot. But it is edited in the local workspace but the change is not submitted to the perforce depot yet.


Users get different types of context menu when they right click on any file in treeview. Context menu differs on file status :

  • Local file
    • Mark for add. (Added the file in perforce change list to add to the perforce server depot)
    • Delete. (Delete the local file form workspace)
    • Refresh.
  • Up to date file
    • Get Latest Revision. (Get the latest file status and revision from perforce server depot)
    • Mark for delete. (Added the perforce change list to delete from the perforce server depot)
    • Refresh.
  • Added file
    • Submit. (Submit the current change list to perforce server depot)
    • Revert. (Revert the file addition from the perforce change list)
    • Refresh.
  • Edited file
    • Get Latest Revision. (Get the latest file status and revision from perforce server depot)
    • Submit. (Submit the current change list to perforce server depot)
    • Revert. (Revert the file edition from the perforce change list)
    • Refresh.


Depot Treeview

Depot treeview show the current perforce server depot file structure and status. User can update or refresh the files by right clicking the files in the treeview.


Legend of file types

  • AddedFile.png  Added file image icon.
  • DeletedfFile.png  Deleted file image icon.
  • EditedFile.png  Edited file image icon.
  • LocalFile.png  Local file image icon.
  • SameFile.png  Up to date file image icon.
Personal tools