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

Commit

Permalink
update for release 20.0.0 of the server
Browse files Browse the repository at this point in the history
  • Loading branch information
dmachard committed Jul 19, 2019
1 parent 922a520 commit 2789576
Show file tree
Hide file tree
Showing 39 changed files with 133 additions and 1,387 deletions.
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
ExtensiveAutomation
========
English documentations for ExtensiveAutomation
============================================

Welcome
Available here https://extensiveautomation.readthedocs.io/en/latest/index.html
Binary file removed docs/_static/images/client/client_update.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/_static/images/testlibrary/archi-extensivetesting.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/_static/images/testlibrary/tax.png
Binary file not shown.
Binary file modified docs/_static/images/testlibrary/testing_approach.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/_static/images/webinterface/add_project.png
Binary file not shown.
Binary file removed docs/_static/images/webinterface/add_user.png
Binary file not shown.
Binary file removed docs/_static/images/webinterface/delete_project.png
Binary file not shown.
Binary file removed docs/_static/images/webinterface/delete_user.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
17 changes: 7 additions & 10 deletions docs/about/download.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,20 @@ The solution is made of several components.

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:
- Test framework
- Scheduler
- Adapters and libraries
The server is available throught several types of packages:
- from sources
- docker image
- tar.gz

The graphical client is available in 2 modes:
- portable version
- installation in program files
The graphical client is available in portable version.

The toolbox is available in 3 modes:
The toolbox is available in 2 modes:
- portable version
- installation in program files
- command line

.. note:: Client and toolbox can be run on Windows and Linux, in 64bits only.

.. warning:: The server must be executed in Linux (CentOS7 or RedHat7).
.. warning:: The server must be executed in Linux.

.. warning:: Administrators rights can be necessary to execute properly the client or the toolbox.

10 changes: 4 additions & 6 deletions docs/about/purpose.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,14 @@ Welcome on the Extensive Automation project.
Concepts
--------

ExtensiveAutomation is a test and deployment automation framework for integration, regression and end-to-end usages.
ExtensiveAutomation is a generic 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)

The project have several purposes since the creation:
- Unify all testing tools in one environnement
- Provide a complete testing dashboard
- Make testing easy
- Testing everything from anywhere.
- Make automation easy
- Automate everything from anywhere.
- Provide a user friendly environment.

.. image:: /_static/images/concept.png
Expand All @@ -26,8 +25,7 @@ This solution is designed to make a lot of thing like:
- test automation in integration environment
- regression test automation
- end to end test automation
- deployment automation of virtual or physical machines
- deployment automation of software application
- deployment automation

.. note:: The solution is written in ``Python`` and also all tests.

Expand Down
29 changes: 21 additions & 8 deletions docs/about/releasenotes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,30 @@ Current version

.. note::

**Version 20.0.0 available since 07/20/2019**

- Image docker available
- Rest API: support for CORS feature
- No more automatic installation provided
- Maximum of dependancies with libraries removed
- No more plugins provided by default
- Probes features removed, replaced by agent
- MySQL database removed, replaced by sqlite
- Optimization of the framework to reduce the CPU usage
- New major version for the Qt client application, user interface improvment
- New major version for the toolbox
- New major version for the web interface, no more provided by default
- Several bugs fixed

A detailed release notes is available in the installation package.

Previous versions
-------------------

..
**Version 19.0.1 available since 08/09/2018**
- Bug fix on deployment server, pip command integration

**Version 19.0.0 available since 08/05/2018**

- New name ExtensiveAutomation for the solution
- All tests files are stored in XML by default (no more zlib compression)
- Bugs fixes and improvement in REST API
Expand All @@ -27,11 +45,6 @@ Current version
- New major version for the app client
- New major version for the toolbox
A detailed release notes is available in the installation package.

Previous versions
-------------------

..
**Version 18.0.0 released on 02/11/2018**
Expand Down
14 changes: 0 additions & 14 deletions docs/admin/adapters_libraries.rst

This file was deleted.

110 changes: 9 additions & 101 deletions docs/admin/admin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,24 @@
Start/Stop of the server
~~~~~~~~~~~~~~~~~~~~~~

The server can be controled with the following command ``xtctl``.
The server can be controled with the following command ``./extensiveautomation``.
This command enables to
- start or stop the server
- check the status
- deploy a new graphical client or toolbox
- display the version

Use the following command to start the server ``xtctl start``.
Use the following command to start the server ``./extensiveautomation start``.

.. code-block:: bash
# xtctl start
Checking database [ OK ]
Saving current adapters [ OK ]
Saving current libraries [ OK ]
Starting Extensive Automation [ OK ]
# ./extensiveautomation start
Use the following command to stop the server ``xtctl stop``.
Use the following command to stop the server ``./extensiveautomation stop``.

.. code-block:: bash
# xtctl stop
Saving current adapters [ OK ]
Saving current libraries [ OK ]
Stopping Extensive Automation [ OK ]
# ./extensiveautomation stop
.. tip::
Expand All @@ -38,7 +30,7 @@ Use the following command to stop the server ``xtctl stop``.

.. code-block:: bash
# tailf /opt/xtc/current/Var/Log/output.log
# tailf [....]/Var/Log/output.log
2014-12-06 11:00:54,092 - INFO - Extensive Automation successfully started (in 14 sec.)
...
2014-12-06 10:58:51,810 - INFO - Stopping server
Expand All @@ -48,47 +40,13 @@ Use the following command to stop the server ``xtctl stop``.
Server status's
~~~~~~~~~~~~~~~~~~~~~~

``xtctl`` enable to check the status of the server, 3 states exists:
``./extensiveautomation --status`` enable to check the status of the server, 3 states exists:
- ``starting``: the server is starting
- ``running``: the server is running properly
- ``stopped``: the server is stopped

.. tip::
Don't forget to check the status of ``httpd`` and ``mysql`` services.

New packages deployment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The solutions make available all additionnals package needed for users:
- The graphical client
- The toolbox
- Plugins

When a new client is available, it's possible to put it in the server and notify
all users of this new package.

Packages must be uploaded in the following folder ``<INSTALL_PATH>/current/Packages/``

+-----------------+-------------------------------------------------+
|Client | Portable version and installation |
+-----------------+-------------------------------------------------+
|ClientPlugins | Plugins |
+-----------------+-------------------------------------------------+
|Toolbox | Portable version and installation |
+-----------------+-------------------------------------------------+
|ToolboxPlugins | Plugins |
+-----------------+-------------------------------------------------+

Packages are automatically available from the web interface. It's possible to execute the command ``xtctl deploy`` in the server
to make it available to all.

.. code-block:: bash
./xtctl deploy
Deploying clients.(ExtensiveAutomationClient_X.X.X_Setup.exe)
Deploying tools.(ExtensiveAutomationToolbox_X.X.X_Setup.exe)
Deploying portable clients... (No client)
Deploying portable tools... (No client)
Don't forget to check the status of your reverse proxy.

Server settings
~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -99,67 +57,17 @@ Parameters are separated in several sections:
- Notifications
- Client_Channel
- Agent_Channel
- Probe_Channel
- WebServices
- TaskManager
- Network
- Paths
- Bin
- Server
- Web
- Bind
- Misc
- MySql
- Trace
- Backups
- Default
- Csv_Test_Results:
- Tests_Framework
- Events_Colors
- Supervision
- Users_Session

Automatic backups
~~~~~~~~~~~~~~~~~~~~~~

The solution make a backup of all tests, adapters and libraries every days.
Backups are stored in the folder ``/opt/xtc/current/Var/Backups``.

The interval of backup can be configured from the section ``Backups`` in the file ``settings.ini``.

.. code-block:: bash
[Backups]
; tests repository
; 0=disable 1=enable
tests=1
; backup zip name
tests-name=tests-automatic-backup
; backup weekly on sunday at 23:40:00
tests-at=6|23,40,00
Scheduler type:
- 7: weekly
- 6: daily
- 5: hourly

Crontab scripts
~~~~~~~~~~~~~~~~~~~~

``cron.backup-tables``: this script allows to save the tables of the solution

``cron.cleanup-backups``: this script allows you to delete backups older than 14 days.
The number of days is configurable.

``cron.cleanup-testsresult``: this script allows you to delete results older than 30 days.
The number of days is configurable.

Security banner
~~~~~~~~~~~~~~~~

It is possible to configure a security banner on the web interface of the server and on the
portable client login window.

For this you have to configure the file ``BANNER`` present in
- in the ``/opt/xtc/current/Web/`` web directory for the server
- the connection of the execution file for the graphical client.
- Users_Session

0 comments on commit 2789576

Please sign in to comment.