Difference between revisions of "GXtest Manager User's Manual"

From GXtest Wiki
Jump to: navigation, search
(Página nueva: Categoría: GXtest Guides This page shows the main concepts of GXtest Manager. == Introduction == GXtest Manager allows you to group the test cases modeled with GXtest Designer,...)
 
 
(28 intermediate revisions by 7 users not shown)
Line 1: Line 1:
[[Categoría: GXtest Guides]]
+
{{Idiomas
 +
| Manual de Usuario de GXtest Manager
 +
| GXtest Manager User's Manual |GXtest Manager ユーザーズマニュアル}}
 +
[[Category: GXtest Guides]]
  
 
This page shows the main concepts of GXtest Manager.
 
This page shows the main concepts of GXtest Manager.
Line 27: Line 30:
 
In this case the suite 1 includes three test cases, the first one execute 5 times, after the end of that execution will run the test case 2 exactly 15 times and finally the test case 3 is executed 4 times.
 
In this case the suite 1 includes three test cases, the first one execute 5 times, after the end of that execution will run the test case 2 exactly 15 times and finally the test case 3 is executed 4 times.
  
'''Task''': Suites is a set of agendas in some time for execution. May be scheduled in different modes (single time, daily, weekly).
+
'''Task''': is a set of scheduled suites in a fixed time for execution. They can be scheduled in different modes (single time, daily, weekly).
  
Executor: machine to conduct the execution of a Task, which must be installed GXtest Executor. This component allows to run tests in parallel and in different environments, since we can schedule various tests (other tasks) on different machines.
+
'''Executor''': machine to conduct the execution of a Task, which must have GXtest Executor installed. This component allows you to run tests parallely and in different environments, because we can schedule various tests (other tasks) on different machines.  
See also Installing GXtest Executor and Executor Create.
+
  
  
En este caso la suite 1 incluye tres test cases, el primero que se ejecutar'a 5 veces, luego que termine esa ejecución se ejecutará el test case 2 exactamente 15 veces y por último el test case 3 se ejecutará 4 veces.
 
  
'''Task''': es un conjunto de Suites agendadas en cierto horario para su ejecución. Podrá ser agendada en diferentes modalidades (única vez, diaria, semanal). Ver también [[Agendar_una_Task|Agendar una Tarea]].<br>
+
At the start page of GXtest Manager, not only users are listed, but also the projects that we created previously using Gxtest Designer.
<br>
+
'''Executor''': máquina encargada de realizar la ejecución de una Task, que deberá tener instalado GXtest Executor. Este componente permite ejecutar pruebas en paralelo y en distintos ambientes, ya que podemos agendar distintas pruebas (distintas tasks) en distintas máquinas. <br>
+
Ver también [[Instalación_de_GXtest_Manager#GXtest_Executor|Instalación de GXtest Executor]] y [[Primeras_Configuraciones_en_GXtest_Manager#Crear un Executor|Crear un Executor]].<br>
+
<br><br>
+
  
== Inicio en GXtest Manager ==
+
Each project will have its own Test Cases, Suites, and Tasks, so once selected the project in which we are going to work, will only appear the Test Cases, Suites and Tasks associated with it.
Para iniciar en GXtest Manager es necesario indicar el Usuario y Proyecto en el que se trabajará. Si no se especifican sólo se podrá trabajar en cosas genéricas, pero si se desea crear Suites de prueba o agendar tareas, es necesario registrarse en el sistema.
+
  
== Configuraciones ==
+
After choosing the project and the user you will see that certain menu options are now available.
  
=== Usuarios ===
+
== Configurations ==
GXtest Manager permite definir usuarios. El motivo principal de la definición de usuarios es para asociarlos a las Suites y Tasks, para que reciban un mail con un resumen de los resultados después de cada ejecución.  
+
 
 +
=== Users ===
 +
GXtest Manager allows you to define users. The main reason for defining users is to associate them with Suites and Tasks, to receive an email with a summary of the results after each run.
  
 
=== Executors ===
 
=== Executors ===
La ejecución de las pruebas se realiza en forma distribuida, en cada máquina que tenga instalado el GXtest Executor. Esta es una aplicación que está a la escucha esperando que le indiquen que ejecute una determinada tarea. Para poder invocar ejecuciones sobre estos componentes distribuidos es necesarios darlos de alta en el GXtest Manager, dándoles un nombre e indicando la IP y Puerto donde escuchan.
+
The test execution is performed in a distributed way on each machine that has installed the GXtest Executor. This is an application that listens expecting to be directed to execute a task. To perform executions over these distributed components is necessary to create them in GXtest Manager, giving them a name and indicating the IP and Port where they listen.
  
 +
When you install GXtest Manager it includes a predefined Executor for local executions in the default port 6681.
  
=== Application Settings ===
+
You should see also [[GXtest Executor User's Manual]].
Se podrán definir los parámetros que recibirán las Task para ejecutar.  
+
  
Esto incluye la '''URL''' donde ejecutarán los Test Cases, que es lo que define nuestro Sistema Bajo Pruebas. Este valor pasado en el parámetro URL se cargará al ejecutar en el Executor en la variable URLhome de cada Test Case.
+
=== Environments ===
 +
You can define the parameters that the Task should receive to run.  
  
También se puede definir el DBMS que utiliza la aplicación, a modo de dejar registrado en los resultados este dato para luego poder usarlo (a futuro) como una dimensión más para estadísticas.
+
This includes the URL where the Test Cases will execute, which is what defines our system under test. This parameter will be loaded to run on the Executor in the URLhome variable in each Test Case.  
  
Se pueden configurar también un conjunto de Datapools a ser llenados antes de la ejecución de la ejecución de la Task. Esto es útil si es necesario que los datos a usar en el Datapool dependan del estado de la aplicación, y sea preciso cargarlos inmediatamente antes de la ejecución y uso de estos datos. Esta funcionalidad aún no está completa.
+
You can also define the DBMS used by the application, in order to register this  data in the results and then it could be used (in the future) as a further dimension to statistics.  
  
Además, se puede definir un archivo Bat a invocar previo a la ejecución de la Task, para que en este se prepare el estado de la aplicación para la prueba. Esto puede incluir cosas como recuperar el estado de la base de datos a partir de un Backup previo, ejecutar scripts SQL, copiar archivos, etc. Esta funcionalidad aún no está completa.
+
You can also configure a set of Datapools to be filled before the execution of the Task. This is useful if the data to use in the Datapool is dependent on application state, and is required to load immediately prior to the execution and use of this data. This functionality is not yet complete.
  
=== Configuración General ===
+
In addition, you can define a bat file to invoke prior to the execution of the Task, so in this bat file you could prepare the state of the application to test. This can include things like restore the state of the database from a previous backup, run SQL scripts, copy files, etc.. This functionality is not yet complete.
En el menú General Configuration se puede definir el directorio donde el GXtest Manager guardará el log. Si no se define esta ruta se guardará en el mismo directorio donde se encuentra deployada la aplicación.
+
  
==== SMTP ====
+
=== Options ===
Es necesario configurar el servidor SMTP para que el GXtest Manager envíe los mails con los resultados.
+
In that menu you can define the general configuration.
Es necesario indicar:
+
 
 +
''' SMTP '''
 +
You need to configure the SMTP server in order to let GXtest Manager to sends the emails with the results. You must indicate:
 
* SMTP Host
 
* SMTP Host
 
* SMTP Port
 
* SMTP Port
Line 75: Line 75:
 
* SMTP Password
 
* SMTP Password
  
También debe estar configurada la variable '''Exec URL'''. Esta queda seteada al instalar, y le da acceso al Executor al componente que envía los mails.
 
  
Ejemplo:
+
For gmail accounts, use this configuration:
 +
* SMTP Host = smtp.gmail.com
 +
* SMTP Port = 25
 +
* SMTP User = <your_username>@gmail.com
 +
* SMTP SSL Enabled? = Yes
 +
 
 +
 
 +
Also the variable URLExec must be configured. This is setted in the installation, and gives you access to the Executor to the component that sends the emails. We suggest to keep that value as it appears by default.
 +
 
 +
Example:
 
  http://abstracta00/GXTestManager/aprocessexecutionresult.aspx
 
  http://abstracta00/GXTestManager/aprocessexecutionresult.aspx
 +
 +
 +
'''Logging'''
 +
You can define if you want to activate the log, and the directory where the GXtest Manager saves the log. If not defined the route is saved in the same directory where the application is deployed. We suggest to keep this value in "NO", unless for debugging propouses.
  
 
=== Browsers, DBMS, Operative Systems ===
 
=== Browsers, DBMS, Operative Systems ===
Es necesario definir valores para estos elementos a modo de registrar información. Al definir los Executors se le indicará cuál es el Sistema operativo y navegador con el que cuentan. Al definir los Application Settings se les asociará un DBMS.
+
It is necessary to define values for these elements in order to recording information. When you define the Executors you have to tell which browser and operating system this machine has. When you define the Environment you have to associate a DBMS.
  
En la instalación del Manager se incluirán definiciones estándar, a modo de que no sea necesario para el usuario crear este tipo de instancias, sino simplemente utilizarlas cuando le sean necesarias.
+
The GXtest Manager installation will include standard definitions, in order not to be necessary for the user to create this kind of instances, and just use them when you need them.
  
== Suites y Test Cases ==
+
== Suites and Test Cases ==
 +
From this menu you can access to the Test cases, datapools, projects and suites defined in the database.
  
Desde el GXtest Manager se pueden consultar los Test Cases que hay disponibles. Estos son los que fueron creados en el GXtest Designer y cargados en la base del Manager. En el WorkWith Test Cases podemos navegar entre las distintas Suites en las que está incluido el Test Case.
+
[[image:menuSuites.png|center]]
  
=== Proyectos ===
+
=== Test Cases and Datapools ===
Es posible visualizar los proyectos definidos y sus propiedades. Estos proyectos son creados desde GXtest Designer. Cada uno de los elementos que se pueden vincular (Test Cases, Suites, Datapools, etc.) están asociados a un proyecto y tienen visibilidad dentro del mismo (no es posible incluir en una misma Suite distintos Test Cases de distintos Proyectos).
+
From GXtest Manager you can view the available Test Cases. These are the ones who were created in the GXtest Designer and loaded at the data base of the Manager. In the  WorkWith Test Cases you can navigate between the different suites that include the Test Case.
 +
 
 +
=== Projects ===
 +
You can view the defined projects and their properties. These projects were created in GXtest Designer. Each of the elements that can be linked (Test Cases, Suites, Datapools, etc..) are associated with a project and have visibility within it (it is not possible to include Test Cases from different projects in a Suite).
  
 
=== Suites ===
 
=== Suites ===
El concepto de Suite es propio del GXtest Manager (no existe a nivel de GXtest Designer), y es en este donde se crean y editan.
+
The concept of Suite is proper of GXtest Manager (it doesn't exist in GXtest Designer level), and this is where you create and edit them.
 +
As mentioned above, a suite is an ordered set of test cases, which also indicates the number of times to execute each test case.
 +
 
 +
== Tasks ==
 +
=== Tasks definition ===
 +
The suites are scheduled to be executed in GXtest Manager. This can be done in the '''WorkWith Task''' or on the calendar. When you are creating a Task you have to indicate the Suites to execute and in what order.
 +
 
 +
If you want to remove a Suite you have to remove the corresponding line of the grid, and you can do this with a right click on the row, and then '''Delete''' option. When you do that the row is marked with a cross. After clicking '''Confirm''' it will be deleted. The same applies when editing a Task.
 +
 
 +
By creating the Task we also have to associate it with an Executor where the Task will be executed, and for this we have to create previously the Executor instance in GXtest Manager, indicating IP and Port to connect.
 +
 
 +
[[image:ViewTask.PNG|center]]
 +
 
 +
There are three types of loops to define the tasks:
 +
* Once: to run it once.
 +
* Weekly: to run it every week, the indicated days.
 +
* Daily: to run it every day.
 +
 
 +
For the last two cases it is necessary to indicate start and end date. For any of the three cases it is necessary to indicate a time of execution.
  
 +
You can optionally indicate the estimated number of minutes that the execution of the test could last. This is requested mainly in order to improve the visualization of the tasks in the calendar, so you can see if they overlap.
  
 +
The tasks are also associated with a user who is interested in receiving emails with the results after each run.
  
== Definición de Tasks ==
+
We also need to indicate the '''Environment''' to use. This provides the Task certain information to run related with the execution environment of the application under test.
En GXtest Manager se agendan las Suites a ejecutar. Esto se puede hacer en el WorkWith Task o en el calendario. Al crear una Task se le indica qué Suites ejecutar y en qué orden.
+
  
Si se desea quitar una Suite ya agregada se debe eliminar la línea correspondiente de la grilla, y para esto se hace botón derecho sobre las filas, opción Delete. Al hacer esto queda marcada la fila con una cruz. Al dar confirmar se eliminará. Esto mismo aplica al momento de editar una Task.
+
''Note: GXtest will always close the browser at the end of execution.''
  
Al crear la Task se le indica también en qué Executor ejecutar, y para esto se tuvo que haber creado previamente en GXtest Manager, indicando IP y Puerto para poder conectarse.
+
=== Import & Export Tasks ===
 +
At the "Work with Tasks" you can export a task to XML. By clicking on corresponding icon, it creates the XML file containing all information relevant to the task and suites included in it, located in the folder "export" in the installation directory of GXtest Manager.
  
Existen tres tipos de recursiones para la definición de las tareas:
+
This task can be imported from generated XML by clicking the icon [[image:upload_icon2.gif]]. In the next screen, you must enter the path where the file located.
* Once: para que la Task se ejecute una sola vez.
+
* Weekly: para que se ejecute todas las semanas, los días que se indique.
+
* Daily: para que se ejecute todos los días.
+
  
Para los últimos dos casos se puede indicar día de inicio y fin. Para cualquiera de los tres casos se indica una hora de ejecución.  
+
If you import the task in a project where it already exists, you can choose to overwrite the existing task (including the suites included in it) by setting the combo, or otherwise a new task is created without overwriting the data of the suites there.
  
Se puede indicar en forma opcional la cantidad de minutos estimada que va a demorar la ejecución de la prueba. Esto sirve más que nada para poder visualizar mejor en el calendario las tareas, y así ver si se superponen.
+
== Results ==
 +
You can see the results of the execution of a Task from the Work With Tasks, and from the Task Scheduler by clicking the item that has already been executed and we want to examine.  
  
A las tareas también se les asocia un usuario, el cual está interesado en recibir mails con los resultados después de cada ejecución.
+
The results are shown similar to the Designer, indicating "Pass" or "Fail" of the Task in general, and for every Test Case execution, alowing you to examine all the outcomes in the tree for each command executed grouped by "Step".
  
Se debe indicar también el Application Settings a utilizar. Este le provee de cierta información a la Task para ejecutar relacionada al ambiente de ejecución de la aplicación bajo pruebas.
+
For every result you can see the action performed, the result, the execution time, and the detail of the error page returned by the application at that time.
  
== Véase También ==
+
== See also ==
* [[Manual de Usuario de GXtest Daemon y Executor]]
+
* [[GXtest Daemon User's Manual]]
* [[Manual de Usuario de GXtest Designer]]
+
* [[GXtest Executor User's Manual]]
 +
* [[GXtest Designer User's Manual]]

Latest revision as of 05:20, 21 February 2014

Spanish.gif
English.gif
Japan.gif

This page shows the main concepts of GXtest Manager.

Contents

Introduction

GXtest Manager allows you to group the test cases modeled with GXtest Designer, and schedule them for execution. Then it lets you see the results of each of these executions.

For this, consider certain fundamental concepts:

TestCase: This is a test case generated with Gxtest Designer. It consists of a series of steps to execute on the application under test, with certain data and certain expected results.

Suite: is a collection of Test Cases (within the same project). Optionally, you can define an execution order for the Test Cases and the number of times that each of them will run. See also Creating a Suite.

To visualize this consider the following example:

Suite 1
Test case 1 5
Test case 2 15
Test case 3 4

In this case the suite 1 includes three test cases, the first one execute 5 times, after the end of that execution will run the test case 2 exactly 15 times and finally the test case 3 is executed 4 times.

Task: is a set of scheduled suites in a fixed time for execution. They can be scheduled in different modes (single time, daily, weekly).

Executor: machine to conduct the execution of a Task, which must have GXtest Executor installed. This component allows you to run tests parallely and in different environments, because we can schedule various tests (other tasks) on different machines.


At the start page of GXtest Manager, not only users are listed, but also the projects that we created previously using Gxtest Designer.

Each project will have its own Test Cases, Suites, and Tasks, so once selected the project in which we are going to work, will only appear the Test Cases, Suites and Tasks associated with it.

After choosing the project and the user you will see that certain menu options are now available.

Configurations

Users

GXtest Manager allows you to define users. The main reason for defining users is to associate them with Suites and Tasks, to receive an email with a summary of the results after each run.

Executors

The test execution is performed in a distributed way on each machine that has installed the GXtest Executor. This is an application that listens expecting to be directed to execute a task. To perform executions over these distributed components is necessary to create them in GXtest Manager, giving them a name and indicating the IP and Port where they listen.

When you install GXtest Manager it includes a predefined Executor for local executions in the default port 6681.

You should see also GXtest Executor User's Manual.

Environments

You can define the parameters that the Task should receive to run.

This includes the URL where the Test Cases will execute, which is what defines our system under test. This parameter will be loaded to run on the Executor in the URLhome variable in each Test Case.

You can also define the DBMS used by the application, in order to register this data in the results and then it could be used (in the future) as a further dimension to statistics.

You can also configure a set of Datapools to be filled before the execution of the Task. This is useful if the data to use in the Datapool is dependent on application state, and is required to load immediately prior to the execution and use of this data. This functionality is not yet complete.

In addition, you can define a bat file to invoke prior to the execution of the Task, so in this bat file you could prepare the state of the application to test. This can include things like restore the state of the database from a previous backup, run SQL scripts, copy files, etc.. This functionality is not yet complete.

Options

In that menu you can define the general configuration.

SMTP You need to configure the SMTP server in order to let GXtest Manager to sends the emails with the results. You must indicate:

  • SMTP Host
  • SMTP Port
  • SMTP User
  • SMTP Password


For gmail accounts, use this configuration:

  • SMTP Host = smtp.gmail.com
  • SMTP Port = 25
  • SMTP User = <your_username>@gmail.com
  • SMTP SSL Enabled? = Yes


Also the variable URLExec must be configured. This is setted in the installation, and gives you access to the Executor to the component that sends the emails. We suggest to keep that value as it appears by default.

Example:

http://abstracta00/GXTestManager/aprocessexecutionresult.aspx


Logging You can define if you want to activate the log, and the directory where the GXtest Manager saves the log. If not defined the route is saved in the same directory where the application is deployed. We suggest to keep this value in "NO", unless for debugging propouses.

Browsers, DBMS, Operative Systems

It is necessary to define values for these elements in order to recording information. When you define the Executors you have to tell which browser and operating system this machine has. When you define the Environment you have to associate a DBMS.

The GXtest Manager installation will include standard definitions, in order not to be necessary for the user to create this kind of instances, and just use them when you need them.

Suites and Test Cases

From this menu you can access to the Test cases, datapools, projects and suites defined in the database.

MenuSuites.png

Test Cases and Datapools

From GXtest Manager you can view the available Test Cases. These are the ones who were created in the GXtest Designer and loaded at the data base of the Manager. In the WorkWith Test Cases you can navigate between the different suites that include the Test Case.

Projects

You can view the defined projects and their properties. These projects were created in GXtest Designer. Each of the elements that can be linked (Test Cases, Suites, Datapools, etc..) are associated with a project and have visibility within it (it is not possible to include Test Cases from different projects in a Suite).

Suites

The concept of Suite is proper of GXtest Manager (it doesn't exist in GXtest Designer level), and this is where you create and edit them. As mentioned above, a suite is an ordered set of test cases, which also indicates the number of times to execute each test case.

Tasks

Tasks definition

The suites are scheduled to be executed in GXtest Manager. This can be done in the WorkWith Task or on the calendar. When you are creating a Task you have to indicate the Suites to execute and in what order.

If you want to remove a Suite you have to remove the corresponding line of the grid, and you can do this with a right click on the row, and then Delete option. When you do that the row is marked with a cross. After clicking Confirm it will be deleted. The same applies when editing a Task.

By creating the Task we also have to associate it with an Executor where the Task will be executed, and for this we have to create previously the Executor instance in GXtest Manager, indicating IP and Port to connect.

ViewTask.PNG

There are three types of loops to define the tasks:

  • Once: to run it once.
  • Weekly: to run it every week, the indicated days.
  • Daily: to run it every day.

For the last two cases it is necessary to indicate start and end date. For any of the three cases it is necessary to indicate a time of execution.

You can optionally indicate the estimated number of minutes that the execution of the test could last. This is requested mainly in order to improve the visualization of the tasks in the calendar, so you can see if they overlap.

The tasks are also associated with a user who is interested in receiving emails with the results after each run.

We also need to indicate the Environment to use. This provides the Task certain information to run related with the execution environment of the application under test.

Note: GXtest will always close the browser at the end of execution.

Import & Export Tasks

At the "Work with Tasks" you can export a task to XML. By clicking on corresponding icon, it creates the XML file containing all information relevant to the task and suites included in it, located in the folder "export" in the installation directory of GXtest Manager.

This task can be imported from generated XML by clicking the icon Upload icon2.gif. In the next screen, you must enter the path where the file located.

If you import the task in a project where it already exists, you can choose to overwrite the existing task (including the suites included in it) by setting the combo, or otherwise a new task is created without overwriting the data of the suites there.

Results

You can see the results of the execution of a Task from the Work With Tasks, and from the Task Scheduler by clicking the item that has already been executed and we want to examine.

The results are shown similar to the Designer, indicating "Pass" or "Fail" of the Task in general, and for every Test Case execution, alowing you to examine all the outcomes in the tree for each command executed grouped by "Step".

For every result you can see the action performed, the result, the execution time, and the detail of the error page returned by the application at that time.

See also