Difference between revisions of "Installation guide"

From GXtest Wiki
Jump to: navigation, search
(Guía)
 
(30 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
[[category:Installation Guides]]
 
[[category:Installation Guides]]
  
 +
{{Idiomas|Guías de Instalación|Installation guide|インストールガイド}}
  
 
== Introduction ==
 
== Introduction ==
Line 6: Line 7:
 
=== Requirements for “Tester Client” installation ===
 
=== Requirements for “Tester Client” installation ===
  
* Minumun Hardware : Pentium IV with at least 2 GB de RAM and 3 GB free HDD space. Wished: Intel i3 or higher.
+
* Minumun Hardware : Pentium IV with at least 4 GB of RAM and 10 GB free HDD space. Wished: Intel i3 or higher.
* Operative System: Windows XP or higher.
+
* Operating System: Windows XP, Windows Vista, Windows 7, Windows 8.1*, Windows 10.
 
* Software:
 
* Software:
 
** .NET Framework 2.0 sp 2
 
** .NET Framework 2.0 sp 2
 
** .NET Framekork 3.5
 
** .NET Framekork 3.5
 
* Optional (recomended):
 
* Optional (recomended):
** Microsoft SQL Server 2005 or higher (also can be the Express version)
+
** Microsoft SQL Server 2005, 2008, 2008R2, 2012, 2014 (also can be the Express version)
** Internet Explorer 8 or higher
+
** Internet Explorer 8, 9, 10, 11*
 +
 
 +
(*) In Windows 8.1 and IE11, you may need to disable "Extended Protection mode" in the browser's Internet Options, and run IE as an administrator. More information [[GXtest_Recorder_Troubleshooting#Considerations_when_running_in_Windows_8.1_and_Internet_Explorer_11 |here]]
  
 
=== Requirements for “Server  Repository” installation ===
 
=== Requirements for “Server  Repository” installation ===
  
* Minumun Hardware : Pentium IV with at least 2 GB de RAM and 10 GB free HDD space. Wished: Intel i3 or higher.
+
* Minumun Hardware : Pentium IV with at least 4 GB de RAM and 20 GB free HDD space. Wished: Intel i3 or higher.
* Operative System: Windows XP or higher.
+
* Operating System: Windows XP, Windows Vista, Windows 7, Windows 8.1, Windows 10, Windows Server 2008, 2008R2, 2012.
 
* Software:
 
* Software:
 
** .NET Framework 2.0 sp 2
 
** .NET Framework 2.0 sp 2
 
** .NET Framekork 3.5
 
** .NET Framekork 3.5
 
** IIS 6.0 or higher including ASP.NET
 
** IIS 6.0 or higher including ASP.NET
** Microsoft SQL Server 2005 or higher (also can be the Express version)
+
** Microsoft SQL Server 2005, 2008, 2008R2, 2012, 2014 (also can be the Express version)
 
* Recomended:
 
* Recomended:
** Microsoft SQL Server 2008 R2 or Microsoft SQL Server 2012
+
** Microsoft SQL Server 2014
 
+
  
 
== Resources (downloads) ==
 
== Resources (downloads) ==
 
* Download last GXtest version from: http://genexus.com/gxtest
 
* Download last GXtest version from: http://genexus.com/gxtest
 
* Microsoft SQL Server 2008 R2 (Express edition): http://www.microsoft.com/sqlserver/2008/en/us/R2Downloads.aspx <BR>
 
* Microsoft SQL Server 2008 R2 (Express edition): http://www.microsoft.com/sqlserver/2008/en/us/R2Downloads.aspx <BR>
Note: This installation guide is for GXtest 1.2 (and higher) in english version.
+
* When installing Server Repository, you must enable IIS in the Windows Features (on the contrary the Server Repository option will appear disabled):
 +
 
 +
[[File:IIS_instalation.PNG  | center]]
 +
 
 +
Note: This installation guide is for GXtest 2.0 (and higher) in english version.
  
 
== Component Details ==
 
== Component Details ==
  
There are 5 products in GXtest Suite that can be installed together or separetly.
+
There are 5 products in GXtest's suite which can be installed either together or separately.
Before installation is better to understand those components and the base technology in order to make the best installation options and configurations. In addition, GXtest components can be distributed on different computers, so it is necessary to understand how they communicate to configure.
+
Prior to installing it, it is necessary to understand its components as well as the technologies upon which they are based, in order to better understand the installation and configuration. Moreover, GXtest may have distributed components throughout several workstations, therefore, it is necessary to understand how they communicate with one another to properly configure them.
 +
 
 +
In the online documentation the solution for the most common installation problems as well as its solutions can be found, the address is gxtest.abstracta.com.uy and the information is available under the Support / Troubleshooting category.
  
In this wiki, you may find common installation problems and their solutions under Support / Troubleshooting.
 
  
 
=== 1 - GXtest Manager ===
 
=== 1 - GXtest Manager ===
  
Is a Web Application that will be installed over IIS, it connects to SQL Server database (which hosts tests cases). It is the central server that concentrates all the tests to be performed automatically.
+
It is a website which is installed in the IIS connecting to an SQL Server database (where the test cases are hosted). It is the central server which concentrates all of the tests which will be executed automatically.
 +
 
 
[[Image:GXtestManagerInstallation_1.png]]
 
[[Image:GXtestManagerInstallation_1.png]]
  
 
=== 2 - GXtest Designer ===
 
=== 2 - GXtest Designer ===
  
It is a Windows (desktop) application connected to a SQL Server database, where are the test cases. Typically installed on the PC where you (tester or developer) are going to design test cases. It is also possible to install without database and use GXtest Manager's database (central repository of test cases).
+
It is a Windows desktop application which connects to an SQL Server database, it is in it where all the test cases are stored. Typically, the installation takes place in the computer where the test cases will be designed, either by the tester or the developer. Also, it is possible to install it without a database and use GXtest Manager database as a unique repository for the test cases.
  
 
[[Image:GXtestDesignerInstallation_1.png]]
 
[[Image:GXtestDesignerInstallation_1.png]]
  
We recommend the installation of a single repository that accesses GXtest manager and all the testers with its local GXtest Designer database.
+
Se recomienda la instalación de un único repositorio al que acceda GXtest manager y todos los testers con sus instalaciones locales de GXtest Designer.
  
 
=== 3 - GXtest Recorder ===
 
=== 3 - GXtest Recorder ===
  
It is an extension of Internet Explorer that is used to record the steps performed by user triyng to automating the GeneXus application. This is always installed together with GXtest Designer.
+
This product is an Internet Explorer extension, employed for recording the test cases in the application which will be automated.
It can also be installed by itself on any computer. For example, it can be installed by an end user to report bugs.
+
Additionally, it can also be installed as a stand-alone on any computer, for instance, it could be installed by an end-user to report bugs.
  
 
[[Image:GXtestRecorderInstallation_1.png]]
 
[[Image:GXtestRecorderInstallation_1.png]]
  
 
=== 4 - GXtest Executor ===  
 
=== 4 - GXtest Executor ===  
Application is responsible for executing scheduled tests. It is installed on machines that are responsible for running the tests.
+
 
Typically installed in the same place that GXtest Manager, but it's very common to install other instances on other machines in order to distribute executions over dedicated machines.
+
The executor is the application which handles the execution of scheduled tests, and it is installedd in the workstations that were designated for running the tests.
Note: This component has the highest hardware requirements since is where test are finally executed.
+
It is usually installed in the same workstations designated for GXtest Manager, though it is also common installing other instances to eiter distribute tests in parallel or in workstations solely dedicated for the execution of automated tests.
 +
Note: This is the one component with the largest hardware requirements, for it is the one where all tests will finally be running from.
  
 
=== 5 - GXtest Daemon ===  
 
=== 5 - GXtest Daemon ===  
It is a Windows service that is installed with GXtest Manager connected to the same database. This component communicates with the various GXtest Executor (configured in GXtest Manager) to dispatch the execution of a new test.
+
This is product is installed as a Windows service along with the GXtest Manager and it accesses the same database. Also, it communicates with the GXtest Executor, and with as many as there may be installed and configured in GXtest Manager in order to request the execution of a new test.
  
 
  
== Guía ==
+
== Guide ==
  
This guide shows how to install the 2 differents installation types: '''Tester Client''' and '''Server Repository'''.
+
The purpose of this guide, is explaining the necessary steps to follow in order to conduct any of the two typical installations available in GXtest: '''Tester Client''' and '''Server Repository'''.
  
  
'''Important''': If you already have installed some GXtest component of an earlier version of v1.2, please uninstall all components from your Control Panel -> Add or Remove Programs.
+
'''Important''': Provided some component in GXtest version is installed with a version lesser than 1.2, please, have them uninstalled before proceeding. The aforementioned process may be conducted by going to the Control Panel --> Add or Remove Programs.  
  
'''Note''': GXtest Uninstaller does not remove the database, thus when installing a new GXtest you keep all your projects and previously created test cases.
 
  
The installation wizard consists of four basic steps:
+
'''Note''': Uninstalling GXtest does not delete the database, therefore, while installing a new GXtest all of your previously created projects, as well as your created test cases are kept.
  
1. Choose the edition (by your purchase)
+
The installation wizard consists of 4 major steps such as:
  
2. Choose installation type (Tester Client / Server Repository / Custom)
+
1. Choosing the edition (according to your license)
  
3. Confirm GeneXus installation path (optional)
+
2. Choosing the type of installation (Tester Client / Server Repository / Custom)
  
4. Enter the location of the database server
+
3. Confirm the installation location for GeneXus (this step is optional)
  
 +
4. Enter the location for the database server
  
'''Step 1 - Choose the edition'''
+
 
 +
'''Step 1 - Choose the version you want to install (according to the purchased license)'''
  
 
[[Image:inst_guide_1.png]]
 
[[Image:inst_guide_1.png]]
  
Differences between GXtest versions can be found at:
+
The differences between the licensing versions in GXtest may be consulted at:  
 
[[Gxtest_editions | GXtest Editions]]
 
[[Gxtest_editions | GXtest Editions]]
  
  
'''Step 2 - Choose installation type'''
+
'''Step 2 - Choose the type of installation'''
  
 
[[Image:inst_guide_2.png]]
 
[[Image:inst_guide_2.png]]
  
The two typical installations are GXtest Tester Client and Server Repository. Components and their characteristics are:
+
The 2 most typical installations in GXtest are Tester Client and Server Repository. Las 2 instalaciones más típicas de GXtest son Tester Client y Server Repository. Los componentes y características de los mismos son:
  
'''Tester Client''': Client Installation for testers or developers.
+
'''Tester Client''': Instalación cliente para testers o desarrolladores.
  
* GXtest Designer + Recorder: the two basic tools to start design test cases and test how these run.
+
* GXtest Designer + Recorder: the 2 basic tools to start automating test cases and test how they are executed.  
* if GeneXus installed:  
+
* Provided GeneXus is installed:  
** GXtest Extension: Allows you to export the metadata of the KB to GXtest.
+
** GXtest Extension: It allows performing the export of the metadata from the KB to GXtest.  
** GXtest Generator: Automatic Test Generation from WorkWith / WorkWith+ Patterns just with one click (Professional Edition only)
+
** GXtest Generator: Automatic tests generation for patterns such as WorkWith and WorkWithPlus with a single click of a button (available only in the Professional Edition)
  
'''Server Repository''': Full installation for central test repository.
+
'''Server Repository''': Full installation for central tests repository.
  
 
* Tester Client (Recorder + Designer + Extension + Generator)
 
* Tester Client (Recorder + Designer + Extension + Generator)
* GXtest Manager: Web application for managing automated testing, environments, testing and distribution schedule.
+
* GXtest Manager: Web application for managing the automated tests, environments, agenda and tests execution distribution.  
* GXtest Executor: Client to run regression tests (scheduled by GXtest Manager)
+
* GXtest Executor: Client for running regression test cases in an unattended fashion (Scheduled from GXtest Manager)
  
 +
If the Server Repository option is disabled, check that IIS is enabled in Windows Features (See [[Installation_guide#Resources_.28downloads.29 | Resources ]]).
  
'''Step 3 - Confirm GeneXus installation path (optional)'''
+
'''Step 3 - Confirm installation location for GeneXus (optional)'''
  
 
[[Image:inst_guide_3.png]]
 
[[Image:inst_guide_3.png]]
  
If GeneXus is installed, choose the version that you ussually will be working to automate tests.
+
For so long as in the workstation Genexus is installed, then the version which will be initially employed for the creation of the automated tests must be selected, after which, GXtest will continue to install the [http://marketplace.genexus.com/product.aspx?gxtestextension GXtest Extension], as well as the automatic tests generator available in the Professional Edition.
This will install [http://marketplace.genexus.com/product.aspx?gxtestextension GXtest Extension] and automatic generator for the Professional Edition.
+
  
'''Step 4 – Create the test repository (local or remote)'''
+
 
 +
'''Step 4 – Create the tests repository (either local or remote)'''
  
 
[[Image:inst_guide_4.png]]
 
[[Image:inst_guide_4.png]]
  
This step allows you to connect to an existing repository (SQL Server) or create a new one.
+
In this step throughout the installation, a connection to an SQL Server engine is created in order to connect to either an existing repository or create a new one.  
  
In "Server Repository" installation you should not skip, test cases must be somewhere.
+
Throughout the installation it is paramount not to skip the "Server Repository", bear in mind that test cases must be stored, therefore, a location must be specified.
  
In "Tester Client" installation is also recommended to create a local database and work locally, but you can connect GXtest directly to the central test server (Server Repository) if it was previously installed.
+
Throughout the "Tester Client" installation, it is also adviseable creating a local database for working locally, although and for so long as it may have already been installed, it is possible to connect directly to the Server Repository.
  
'''Step 5 –  Authorization License'''
 
  
After installation you will need to authorize using GeneXus License Manager. Open locally from the installation folder GXtest (Windows> All Programs> Abstract> GXtest):
+
'''Step 5 –  License Authorization'''
 +
 
 +
No sooner is the installation completed, in order to authorize the license locally, please open GeneXus License Manager from the GXtest installation folder, available from Windows--> All Programs--> Abstracta--> GXtest.
  
 
[[Image:inst_guide_5.png]]
 
[[Image:inst_guide_5.png]]
  
* To authorize follow the traditional licensing process GeneXus. ([http://wiki.gxtechnical.com/commwiki/servlet/hwiki?GeneXus+X+Protection+Manual, reed more...])
+
* In order to authorize the license follow the process as explained in the GeneXus' site ([http://wiki.gxtechnical.com/commwiki/servlet/hwiki?GeneXus+X+Protection+Manual, read more...])
  
* If you are using GeneXus Protection Server, use it authorizing your local installation.
+
* In the event you are using GeneXus Protection Server, make sure to authorize the license in that installation.
  
If products are not in the listed in GeneXus License Manager, you may run a ".reg file" (register windows) available at your GXtest installation, typically: C:\Program Files (x86)\Abstracta\GXtest Designer\ prodGXtest.reg
 
  
Then reopen GeneXus License Manager.
+
Should you not find the GXtest products from the list available from the GeneXus License Manager, then a Windows registry file needs to be executed, and it is available in the GXtest installation folder, that is usually located at: C:\Program Files (x86)\Abstracta\GXtest Designer\ prodGXtest.reg
  
For problems in activating the license, contact your dealer or alternatively send an email to [mailto: claves@artech.com.uy claves@artech.com.uy]
+
Afterwars, make sure to open GeneXus License Manager anew.
  
'''Step 6 –  Enable GXtest Recorder toolbar'''
+
In the event of coming across with inconveniets with the activation of the license, then please either get in contact with you retailer, or send an email to [mailto:claves@artech.com.uy claves@artech.com.uy]
  
After installing remember to enable the IE toolbar in Internet Explorer from: View / Toolbars / GXtest Recorder
+
 
 +
'''Step 6 –  Enable GXtest Recorder'''
 +
 
 +
After the installation is completed, take into account that the toolbar extension for GXtest in Internet Explorer needs to be enabled: such procedure can be conducted from: View / Toolbars / GXtest Recorder
  
 
[[Image:inst_guide_6.png]]
 
[[Image:inst_guide_6.png]]
  
== Ejemplo de instalación distribuida ==
 
  
A modo de ejemplo se ilustra a continuación una posible instancia de una instalación en una organización.
+
== Common installation of GXtest components  ==
 +
 
 +
As an example, below is shown a possible distribution for GXtest components on different machines.
  
* 1 Tester Client para quien va a automatizar (en su propia máquina).  
+
* 1 Tester Client for the tester who will create the test cases.  
* 1 Server Repository (para gestionar las pruebas automatizadas)
+
* 1 Server Repository to manage and schedule executions on different machines
* 2 instalaciones Custom en 2 equipos distintos (para ejecutar pruebas desatendidas)
+
* 2 Custom Installations on other two machines, where the scheduled tests will execute (needs the browser installed in order to run the test)
  
 
[[Image:Custom installation.png]]
 
[[Image:Custom installation.png]]

Latest revision as of 13:37, 26 December 2016


Spanish.gif
English.gif
Japan.gif

Contents

Introduction

Requirements for “Tester Client” installation

  • Minumun Hardware : Pentium IV with at least 4 GB of RAM and 10 GB free HDD space. Wished: Intel i3 or higher.
  • Operating System: Windows XP, Windows Vista, Windows 7, Windows 8.1*, Windows 10.
  • Software:
    • .NET Framework 2.0 sp 2
    • .NET Framekork 3.5
  • Optional (recomended):
    • Microsoft SQL Server 2005, 2008, 2008R2, 2012, 2014 (also can be the Express version)
    • Internet Explorer 8, 9, 10, 11*

(*) In Windows 8.1 and IE11, you may need to disable "Extended Protection mode" in the browser's Internet Options, and run IE as an administrator. More information here

Requirements for “Server Repository” installation

  • Minumun Hardware : Pentium IV with at least 4 GB de RAM and 20 GB free HDD space. Wished: Intel i3 or higher.
  • Operating System: Windows XP, Windows Vista, Windows 7, Windows 8.1, Windows 10, Windows Server 2008, 2008R2, 2012.
  • Software:
    • .NET Framework 2.0 sp 2
    • .NET Framekork 3.5
    • IIS 6.0 or higher including ASP.NET
    • Microsoft SQL Server 2005, 2008, 2008R2, 2012, 2014 (also can be the Express version)
  • Recomended:
    • Microsoft SQL Server 2014

Resources (downloads)

IIS instalation.PNG

Note: This installation guide is for GXtest 2.0 (and higher) in english version.

Component Details

There are 5 products in GXtest's suite which can be installed either together or separately. Prior to installing it, it is necessary to understand its components as well as the technologies upon which they are based, in order to better understand the installation and configuration. Moreover, GXtest may have distributed components throughout several workstations, therefore, it is necessary to understand how they communicate with one another to properly configure them.

In the online documentation the solution for the most common installation problems as well as its solutions can be found, the address is gxtest.abstracta.com.uy and the information is available under the Support / Troubleshooting category.


1 - GXtest Manager

It is a website which is installed in the IIS connecting to an SQL Server database (where the test cases are hosted). It is the central server which concentrates all of the tests which will be executed automatically.

GXtestManagerInstallation 1.png

2 - GXtest Designer

It is a Windows desktop application which connects to an SQL Server database, it is in it where all the test cases are stored. Typically, the installation takes place in the computer where the test cases will be designed, either by the tester or the developer. Also, it is possible to install it without a database and use GXtest Manager database as a unique repository for the test cases.

GXtestDesignerInstallation 1.png

Se recomienda la instalación de un único repositorio al que acceda GXtest manager y todos los testers con sus instalaciones locales de GXtest Designer.

3 - GXtest Recorder

This product is an Internet Explorer extension, employed for recording the test cases in the application which will be automated. Additionally, it can also be installed as a stand-alone on any computer, for instance, it could be installed by an end-user to report bugs.

GXtestRecorderInstallation 1.png

4 - GXtest Executor

The executor is the application which handles the execution of scheduled tests, and it is installedd in the workstations that were designated for running the tests. It is usually installed in the same workstations designated for GXtest Manager, though it is also common installing other instances to eiter distribute tests in parallel or in workstations solely dedicated for the execution of automated tests. Note: This is the one component with the largest hardware requirements, for it is the one where all tests will finally be running from.

5 - GXtest Daemon

This is product is installed as a Windows service along with the GXtest Manager and it accesses the same database. Also, it communicates with the GXtest Executor, and with as many as there may be installed and configured in GXtest Manager in order to request the execution of a new test.


Guide

The purpose of this guide, is explaining the necessary steps to follow in order to conduct any of the two typical installations available in GXtest: Tester Client and Server Repository.


Important: Provided some component in GXtest version is installed with a version lesser than 1.2, please, have them uninstalled before proceeding. The aforementioned process may be conducted by going to the Control Panel --> Add or Remove Programs.


Note: Uninstalling GXtest does not delete the database, therefore, while installing a new GXtest all of your previously created projects, as well as your created test cases are kept.

The installation wizard consists of 4 major steps such as:

1. Choosing the edition (according to your license)

2. Choosing the type of installation (Tester Client / Server Repository / Custom)

3. Confirm the installation location for GeneXus (this step is optional)

4. Enter the location for the database server


Step 1 - Choose the version you want to install (according to the purchased license)

Inst guide 1.png

The differences between the licensing versions in GXtest may be consulted at: GXtest Editions


Step 2 - Choose the type of installation

Inst guide 2.png

The 2 most typical installations in GXtest are Tester Client and Server Repository. Las 2 instalaciones más típicas de GXtest son Tester Client y Server Repository. Los componentes y características de los mismos son:

Tester Client: Instalación cliente para testers o desarrolladores.

  • GXtest Designer + Recorder: the 2 basic tools to start automating test cases and test how they are executed.
  • Provided GeneXus is installed:
    • GXtest Extension: It allows performing the export of the metadata from the KB to GXtest.
    • GXtest Generator: Automatic tests generation for patterns such as WorkWith and WorkWithPlus with a single click of a button (available only in the Professional Edition)

Server Repository: Full installation for central tests repository.

  • Tester Client (Recorder + Designer + Extension + Generator)
  • GXtest Manager: Web application for managing the automated tests, environments, agenda and tests execution distribution.
  • GXtest Executor: Client for running regression test cases in an unattended fashion (Scheduled from GXtest Manager)

If the Server Repository option is disabled, check that IIS is enabled in Windows Features (See Resources ).

Step 3 - Confirm installation location for GeneXus (optional)

Inst guide 3.png

For so long as in the workstation Genexus is installed, then the version which will be initially employed for the creation of the automated tests must be selected, after which, GXtest will continue to install the GXtest Extension, as well as the automatic tests generator available in the Professional Edition.


Step 4 – Create the tests repository (either local or remote)

Inst guide 4.png

In this step throughout the installation, a connection to an SQL Server engine is created in order to connect to either an existing repository or create a new one.

Throughout the installation it is paramount not to skip the "Server Repository", bear in mind that test cases must be stored, therefore, a location must be specified.

Throughout the "Tester Client" installation, it is also adviseable creating a local database for working locally, although and for so long as it may have already been installed, it is possible to connect directly to the Server Repository.


Step 5 – License Authorization

No sooner is the installation completed, in order to authorize the license locally, please open GeneXus License Manager from the GXtest installation folder, available from Windows--> All Programs--> Abstracta--> GXtest.

Inst guide 5.png

  • In order to authorize the license follow the process as explained in the GeneXus' site (read more...)
  • In the event you are using GeneXus Protection Server, make sure to authorize the license in that installation.


Should you not find the GXtest products from the list available from the GeneXus License Manager, then a Windows registry file needs to be executed, and it is available in the GXtest installation folder, that is usually located at: C:\Program Files (x86)\Abstracta\GXtest Designer\ prodGXtest.reg

Afterwars, make sure to open GeneXus License Manager anew.

In the event of coming across with inconveniets with the activation of the license, then please either get in contact with you retailer, or send an email to claves@artech.com.uy


Step 6 – Enable GXtest Recorder

After the installation is completed, take into account that the toolbar extension for GXtest in Internet Explorer needs to be enabled: such procedure can be conducted from: View / Toolbars / GXtest Recorder

Inst guide 6.png


Common installation of GXtest components

As an example, below is shown a possible distribution for GXtest components on different machines.

  • 1 Tester Client for the tester who will create the test cases.
  • 1 Server Repository to manage and schedule executions on different machines
  • 2 Custom Installations on other two machines, where the scheduled tests will execute (needs the browser installed in order to run the test)

Custom installation.png