ExtensiveAutomation


ExtensiveAutomation	Python automation server
Copyright	Copyright (c) 2010-2019 Denis Machard d.machard@gmail.com
License	LGPL2.1
Homepage	https://www.extensiveautomation.org/
Docs	https://extensiveautomation.readthedocs.io/en/latest/
Github	https://github.com/ExtensiveAutomation
Docker Hub	https://hub.docker.com/u/extensiveautomation
PyPI	https://pypi.org/project/extensiveautomation-server/
Google Users	https://groups.google.com/group/extensive-automation-users
Twitter	https://twitter.com/Extensive_Auto

Introduction
Installation
Testing if server running
Plugins
Adding ReverseProxy
LDAP users authentication

Introduction

ExtensiveAutomation is a generic automation framework for integration, regression and end-to-end usages. The framework provided a rich and collaborative workspace environment. The server can run on both Python 2 and Python 3, and also run on Linux and Windows.

Installation

PyPI package

Run the following command

 python -m pip install extensiveautomation_server

Type the following command on your shell to start the server
```
 extensiveautomation --start
```
Finally, check if the server is running fine.

Docker image

Downloading the image

 docker pull extensiveautomation/extensiveautomation-server:latest

Start the container

 docker run -d -p 8081:8081 -p 8082:8082 -p 8083:8083 \
            --name=extensive extensiveautomation

If you want to start the container with persistant tests data, go to Docker Hub page.

Finally, check if the server is running fine.

Source code

Clone this repository on your linux server

 git clone https://github.com/ExtensiveAutomation/extensiveautomation-server.git

As precondition, install the additional python libraries with pip command:

Python3 environment

  python -m pip install wrapt pycnic lxml jsonpath_ng

Python2 environment, the libxslt library must be installed and settings file updated

  python -m pip install wrapt scandir pycnic lxml jsonpath_ng

  vim src/ea/settings.ini
  [Bin]
  python=/usr/bin/python2.7

Start the server. On linux the server is running as daemon.
```
 cd src/
 python extensiveautomation.py --start
```
Finally, check if the server is running fine.

Testing if server running

Please to take in consideration the following points:
- The server is running on the following tcp ports (don't forget to open these ports on your firewall):
  - tcp/8081: REST API
  - tcp/8081: Websocket tunnel for app client
  - tcp/8082: Websocket tunnel for agents
- The admin, tester and monitor users are available and the default passoword is password.
- The Common project is created by default, attached to the previous users.
- Swagger for the REST API is available in the scripts/swagger folder.

Checking if the REST api working fine with curl or postman.

curl -X POST http://127.0.0.1:8081/session/login \
     -H "Content-Type: application/json" \
     -d '{"login": "admin", "password": "password"}'

Adding plugins

Plugins allow to interact with the system to be controlled. But by default the server is provided without plugins. So you need to install them one by one according to your needs.

Adding reverse proxy

Adding a reverse proxy the from of server enables to expose only one tcp port (8080) and to have a tls link between the client and the server. Also, the default behaviour of the QT client and toolbox is to try to connect on the tcp/8080 port (can be modifed).

If you want to install a reverse proxy, please to follow this procedure.

Install the example provided scripts\reverseproxy\extensiveautomation_api.conf in your apache instance. If you install the reverse proxy on a new server, don't forget to replace the 127.0.0.1 address by the ip of your extensive server.

 Listen 8080

 <VirtualHost *:8080>
   SSLEngine on

   SSLCertificateFile /etc/pki/tls/certs/localhost.crt
   SSLCertificateKeyFile /etc/pki/tls/private/localhost.key

   LogLevel warn
   ErrorLog  /var/log/extensiveautomation_api_error_ssl_rp.log
   CustomLog /var/log/extensiveautomation_api_access_ssl_rp.log combined

   Redirect 307 / /rest/session/login

   ProxyPass /rest/ http://127.0.0.1:8081/
   ProxyPassReverse /rest/ http://127.0.0.1:8081/
   
   ProxyPass /wss/client/ ws://127.0.0.1:8082 disablereuse=on
   ProxyPassReverse /wss/client/ ws://127.0.0.1:8082 disablereuse=on

   ProxyPass /wss/agent/ ws://127.0.0.1:8083 disablereuse=on
   ProxyPassReverse /wss/agent/ ws://127.0.0.1:8083 disablereuse=on
 </VirtualHost>

With this configuration in apache, the REST API is now running on the port tcp/8080 (tls).

Checking if the REST api working fine with curl command.

curl -X POST https://127.0.0.1:8080/rest/session/login --insecure \ 
  -H "Content-Type: application/json" \
  -d '{"login": "admin", "password": "password"}'

LDAP users authentication

By default, users are authenticated locally from database (by checking hash password). This behavior can be modified by using a remote authentication server. In this mode, you always need to add users in the local database.

Follow this procedure to enable LDAP authentication:

Install python dependancies with the pip command:
```
 python -m pip install ldap3
```

Configure the settings.ini file to enable ldap authentication and other stuff

 [Users_Session]
 
 ; enable ldap user authentication for rest api session only
 ; 0=disable 1=enable
 ldap-authbind=1
 ; remote addresses of your ldap servers
 ; ldaps://127.0.0.1:636 
 ldap-host=[ "ldap://127.0.0.1:389" ]
 ; username form
 ; uid=%%s,ou=People,dc=extensive,dc=local
 ldap-dn=[ "uid=%%s,ou=People,dc=extensive,dc=local" ]

Restart the server

 cd src/
 python extensiveautomation.py --stop
 python extensiveautomation.py --start

Check the new user authentication method

curl -X POST http://127.0.0.1:8081/session/login \
     -H "Content-Type: application/json" \
     -d '{"login": "admin", "password": "password"}'

4ghori / extensiveautomation-server