Skip to content
This repository has been archived by the owner on Dec 10, 2023. It is now read-only.

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
dmachard committed Apr 22, 2018
1 parent 34e07e9 commit 9a3eee7
Show file tree
Hide file tree
Showing 30 changed files with 2,497 additions and 2,532 deletions.
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
ExtensiveTesting
ExtensiveAutomation
========

TODO
Welcome
2 changes: 1 addition & 1 deletion docs/about/download.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Download
A complete release is generated every two months or less and each component can also evolve at its own rate.
The solution is made of several components.

The solution can be downloaded from the website https://www.extensivetesting.org
The solution can be downloaded from the website https://www.extensiveautomation.org

The server is available throught a ``tar.gz`` file, the following package are also integrated:
- graphical client (in portable mode only)
Expand Down
12 changes: 6 additions & 6 deletions docs/about/purpose.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Extensive Testing
Extensive Automation
=================

Welcome on the Extensive Testing project.
Welcome on the Extensive Automation project.

Concepts
--------

ExtensiveTesting is a test and deployment automation framework for integration, regression and end-to-end usages.
ExtensiveAutomation is a test and deployment automation framework for integration, regression and end-to-end usages.
The framework provided a rich and collaborative workspace environment.
The installation is also simplified and some others great tools are integrated on it (selenium, sikuli)

Expand Down Expand Up @@ -36,7 +36,7 @@ License


This environment is open source, and is freely available under the LGPL 2.1 version.
All source code is available in github (https://github.com/ExtensiveTesting).
All source code is available in github (https://github.com/ExtensiveAutomation).

Author
------
Expand All @@ -52,6 +52,6 @@ Contact

If you have any questions, you can contact me with:
- email d.machard@gmail.com
- twitter https://twitter.com/Extensive_Tests
- twitter https://twitter.com/Extensive_Auto
- from the google forum https://groups.google.com/forum/#!forum/extensive-testing-users
- github https://github.com/ExtensiveTesting
- github https://github.com/ExtensiveAutomation
18 changes: 9 additions & 9 deletions docs/admin/adapters_libraries.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
Adaptateurs et librairies
Adapters and libraries
========================

La version des adaptateurs (ou librairies) à utiliser par défaut pour un test
peut être configurés. Il est aussi possible d'utiliser plusieurs versions d'adaptateurs (ou librairies) en parallèle sur un test.
The version of the adapters (or libraries) to use by default for a test
can be configured. It is also possible to use multiple versions of adapters (or libraries) in parallel on a test.

Il est donc conseiller de définir:
- une version par défaut à utiliser
- mais aussi une version générique
It is therefore advisable to define:
- a default version to use
- but also a generic version

La séparation en version par défaut ou générique permet
de faire évoluer vos adaptateurs (ou librairies) indépendamment
des adaptateurs (ou librairies) open source.
Separation in default or generic version allows
to evolve your adapters (or libraries) independently
open source adapters (or libraries)

142 changes: 70 additions & 72 deletions docs/admin/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@ Server
Automatic mode
~~~~~~~~~~~~~~~~~~~~~~~~

.. warning::
Configuration de base à respecter avant de lancer l'installation:
- l'interface réseau est correctement configurée sur le serveur
- l'accès aux dépôts officiels est disponible
- utilisation d'un système Linux CentOS 6/7 ou RedHat

L'installation de la solution peut se faire en utilisant le script ``install.sh`` présent dans le tar.gz.
Si les prérequis sont respectés alors l'installation se fera en mode automatique, c'est à dire que les paquets manquants
seronts récupérés automatiquement.

Exemple d'installation en mode automatique
.. warning ::
Basic configuration to respect before starting the installation:
- the network interface is correctly configured on the server
- access to official repositories is available
- using a Linux CentOS 6/7 or RedHat system
Installation of the solution can be done using the `` install.sh`` script in the tar.gz.
If the prerequisites are respected then the installation will be done in automatic mode, that is to say that the missing packets
will be recovered automatically.

Example of installation in automatic mode

.. code-block:: bash
Expand Down Expand Up @@ -59,33 +59,32 @@ Exemple d'installation en mode automatique
=========================================================================
Exemple pour vérifier si le serveur fonctionne correctement.
Example to check if the server is working properly.

.. code-block:: bash
xtctl status
Extensive Testing is running
Le serveur est accessible à l'adresse indiquée à la fin de l'installation.
Il est possible d'utiliser les comptes pas défauts pour se connecter:
- utilisateur ``admin``
- utilisateur ``tester``
- utilisateur ``monitor``
The server is accessible at the address indicated at the end of the installation.
It is possible to use no fault accounts to connect:
- user `` admin``
- user `` test``
- user `` monitor``

.. note:: Les comptes par défaut n'ont pas de mot de passe.
.. note :: The default accounts do not have a password.
.. warning:: Ne pas oublier de changer les mots de passe des comptes par défaut ou de désactiver les comptes.
.. warning :: Do not forget to change the default account passwords or disable the accounts.

Custom mode
~~~~~~~~~~~~~~~~~~~~~~~~

.. warning:: Ce mode d'installation n'est recommandé que pour les utilisateurs avancés.
.. warning :: This installation mode is only recommended for advanced users.
Ce mode est utilisé pour changer la destination de l'installation ou spécifier certains paramètres (voir l'exemple).
This mode is used to change the destination of the installation or to specify certain parameters (see the example).

Exemple d'installation en mode personnalisé (ici, la destination de xtc)
Example of installation in custom mode (here, the destination of xtc)

.. code-block:: bash
Expand Down Expand Up @@ -120,32 +119,32 @@ Exemple d'installation en mode personnalisé (ici, la destination de xtc)
* Do you want to configure selinux automatically? [No]?
* What is the path of the openssl binary? [/usr/bin/openssl]
Exemple pour vérifier si le serveur fonctionne correctement.
Example to check if the server is working properly.

.. code-block:: bash
xtctl status
Extensive Testing is running
Le serveur est accessible à l'adresse indiquée à la fin de l'installation.
Il est possible d'utiliser les comptes par défaut pour se connecter:
- utilisateur ``admin``
- utilisateur ``tester``
- utilisateur ``monitor``
The server is accessible at the address indicated at the end of the installation.
It is possible to use the default accounts to log in:
- user `` admin``
- user `` test``
- user `` monitor``

.. note:: Les comptes par défaut n'ont pas de mot de passe.
.. note :: The default accounts do not have a password.
.. warning:: Ne pas oublier de changer les mots de passe des comptes par défaut ou de désactiver les comptes.
.. warning :: Do not forget to change the default account passwords or disable the accounts.
From sources
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. warning:: Ce mode d'installation n'est recommandé que pour les utilisateurs avancés.
.. warning :: This installation mode is only recommended for advanced users.
Il faut dans un premier temps installer les libraries systèmes et python nécessaire au bon fonctionnement
du programme, la liste complète est disponible dans la chapitre contribution.
First, you need to install the system and python libraries necessary for the proper functioning
of the program, the complete list is available in the contribution chapter.

Après voir récupérer les sources depuis github il faut recomposer les différents répertoire
After retrieving the sources from github you have to recompose the different directories

+------------------+-------------------------------+
| core-server | /opt/xtc/vXXX |
Expand All @@ -161,19 +160,19 @@ Après voir récupérer les sources depuis github il faut recomposer les différ
| web-client | </opt..>/Web |
+------------------+-------------------------------+

**Préparation de la base de donnée**
** Preparation of the database **

Pour initialiser la base de donnée, il faut exécuter le scripts "add-bdd.py" disponible dans le répertoire ``Scripts/database``.
To initialize the database, execute the "add-bdd.py" scripts available in the `` Scripts / database`` directory.

**Démarrage du serveur**
** Starting the server **

Il faut exécuter le scripts ``python run`` disponible à la racine du répertoire ``/opt/xtc/vXXX/``.
Run the `` python run`` scripts available at the root of the `` / opt / xtc / vXXX / `` directory.

Update
~~~~~~~~~~~

La mise à jour du serveur est possible en exécutant le script ``./update.sh``
Les anciens tests, adaptateurs et utilisateurs sont automatiquement migrés.
The server update is possible by running the script ``. / Update.sh``
Old tests, adapters and users are automatically migrated.

.. code-block:: bash
./update.sh
Expand Down Expand Up @@ -229,13 +228,13 @@ Les anciens tests, adaptateurs et utilisateurs sont automatiquement migrés.
- Continue and go to the web interface (https://xxxxxxxxx/web/index.php)
=========================================================================
.. note:: La mise à jour est refusée si aucune version du produit n'est détectée.
.. note :: The update is refused if no version of the product is detected.
Rollback
~~~~~~~~~~~

Le retour arrière est possible vers les versions antérieures déjà installées sur le serveur.
Exécuter le script ``rollback.sh`` avec la version précédente.
Backtracking is possible to earlier versions already installed on the server.
Run the `` rollback.sh`` script with the previous version.

.. code-block:: bash
Expand All @@ -257,7 +256,7 @@ Exécuter le script ``rollback.sh`` avec la version précédente.
Uninstall
~~~~~~~~~~~~~~

La désinstallation du produit peut se faire en utilisant le script ``./uninstall.sh`` présent dans le paquet d'installation.
Uninstalling the product can be done using the ``. / Uninstall.sh`` script in the installation package.

.. code-block:: bash
Expand All @@ -282,32 +281,31 @@ La désinstallation du produit peut se faire en utilisant le script ``./uninstal
- Uninstallation completed successfully!
=========================================================================
.. note:: Il est possible d'utiliser le mode ``force`` en cas d'erreur durant la désinstallation.

.. note :: It is possible to use the `` force`` mode if an error occurs during the uninstallation.
Client
------

Windows Installation
~~~~~~~~~~~~~~~~~~~~

Il existe 2 modes d'installation:
- mode portable (version recommandée)
- mode installation
There are 2 installation modes:
- portable mode (recommended version)
- installation mode

Le client peut être récupéré depuis le site internet https://www.extensivetesting.org ou bien depuis le serveur de test.
The client can be retrieved from the website https://www.extensiveautomation.org or from the test server.

.. image:: /_static/images/webinterface/web_overview_pkgs2.png

Ensuite il faut le décompresser et exécuter le fichier `ExtensiveTestingClient.exe`
Then you have to unzip it and run the `ExtensiveTestingClient.exe` file

.. image:: /_static/images/client/client_portable.png

Linux Installation
~~~~~~~~~~~~~~~~~~

Il n'y a pas de version pré-compilée pour Linux.
Il faut récupérer les sources depuis github, installer les paquets manquants et exécuter le fichier suivant
There is no pre-compiled version for Linux.
It is necessary to recover the sources since github, to install the missing packets and to execute the following file

.. code-block:: bash
Expand All @@ -316,36 +314,36 @@ Il faut récupérer les sources depuis github, installer les paquets manquants e
Update
~~~~~~~~~~~

La mise à jour du client est possible en mode automatique (si présent sur le serveur) ou manuel.
Depuis le client lourd il est possible de vérifier la présence d'une mise à jour.
The update of the client is possible in automatic mode (if present on the server) or manual.
From the client it is possible to verify the presence of an update.

.. image:: /_static/images/client/client_update.png

.. note:: Si la version proposée est une version majeure alors la mise à jour est obligatoire.
.. note :: If the proposed version is a major release then the update is mandatory.
Toolbox
--------------

Windows Installation
~~~~~~~~~~~~~~~~~~~~

Il existe 2 modes d'installation:
- mode portable (version recommandée)
- mode installation
There are 2 installation modes:
- portable mode (recommended version)
- installation mode

La boîte à outils peut être récupérée depuis le site internet https://www.extensivetesting.org ou bien depuis le serveur de test.
The toolbox can be retrieved from the website https://www.extensiveautomation.org or from the test server.

.. image:: /_static/images/webinterface/web_overview_pkgs3.png

Ensuite il faut le décompresser et exécuter le fichier ``ExtensiveTestingToolbox.exe``
Then you have to decompress it and run the `` ExtensiveTestingToolbox.exe`` file

.. image:: /_static/images/toolbox/toolbox_portable.png

Linux Installation
~~~~~~~~~~~~~~~~~~

La boîte à outils peut être récupérée depuis le site internet https://www.extensivetesting.org ou bien depuis le serveur de test.
2 scripts sont disponibles pour démarrer un agent ou une sonde.
The toolbox can be retrieved from the website https://www.extensiveautomation.org or from the test server.
2 scripts are available to start an agent or probe.
- ./toolagent
- ./toolprobe

Expand Down Expand Up @@ -400,11 +398,11 @@ La boîte à outils peut être récupérée depuis le site internet https://www.
Update
~~~~~~~~~~~

La mise à jour de la boîte à outils est à faire manuellement.
Il faut récupérer le paquet depuis le site internet ou bien depuis le serveur de test.
The update of the toolbox is to be done manually.
You have to get the package from the website or from the test server.

La mise à jour nécessite:
- de supprimer la version courante
- d'ajouter la nouvelle version et reconfigurer les agents ou sondes à redémarrer.
The update requires:
- delete the current version
- add the new version and reconfigure the agents or probes to restart.

.. note:: La mise à jour automatique n'est pas encore supportée.
.. note :: The automatic update is not supported yet.
13 changes: 6 additions & 7 deletions docs/admin/projects.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
Projects
=======

The solution is multi-project. Il est donc possible d'organiser les tests par projets et d'accorder des droits d'accès pour les
utilisateurs.
The solution is multi-project. It is therefore possible to organize the tests by projects and grant access rights for
users.

.. note:: The ``Common`` project exists by default, il est accessible par l'ensemble des utilisateurs et ne peux pas être supprimé.
.. note :: The `` Common`` project exists by default, it is accessible by all users and can not be deleted.
Add a project
-----------------

Only an administrator can add a new project.
La création d'un projet nécessite de préciser son nom et peut se faire via l'interface web ou bien l'API
Only an administrator can add a new project.
Creating a project requires specifying its name and can be done via the web interface or the API

.. image:: /_static/images/webinterface/add_project.png

Expand All @@ -22,8 +22,7 @@ This action can be done throught the web interface or the web api.

.. image:: /_static/images/webinterface/delete_project.png

.. note:: Si le projet est associé à un utilisateur, la suppression n'est pas autorisée.

.. note :: If the project is associated with a user, deletion is not allowed.
Link a project to a user
------------------------
Expand Down

0 comments on commit 9a3eee7

Please sign in to comment.