Merge pull request #541 from FIWARE/doc/functest-installation-guide-f…

…or-ubuntu-20.04

Doc/functest installation guide for ubuntu 20.04

doc/manuals-ld/installation-guide-functional-tests-ubuntu20.04.1.md

@@ -0,0 +1,88 @@
+# Installation Guide for the Orion-LD Functional Test Suite on Ubuntu 20.04
+
+The functional test suite for Orion-LD, found in the Orion-LD repository, under `test/functionalTests`, needs some installation in order to work.
+
+First of all, there is a python script (`scripts/accumulator-server.py`) that is used as the receptor of the notifications during the functional tests.
+
+This python script (that needs python 2.7) needs a few packages to be installed:
+
+1. Install **python 2.7** (and make a softlink /usr/bin/python to point to it)
+```bash
+sudo aptitude install python2
+sudo ln -s /usr/bin/python2 /usr/bin/python
+```
+
+2. Install **OpenSSL** for Python:
+```bash
+sudo aptitude install python-openssl
+```
+
+3. Install **Flask**:
+```bash
+pip2.7 install Flask
+```
+
+That should be all for the accumulator python script.
+
+The test script (`test/functionalTest/testHarness.sh`) needs to *find* the accumulator, to be able to start it:
+```bash
+cd <orion-ld repository base directory>
+export PATH=$PATH:$PWD/scripts
+which accumulator-server.py
+```
+
+The output of the `which` command should be:
+
+```text
+~/git/context.Orion-LD/scripts/accumulator-server.py
+```
+
+Also, the test script uses `nc` to verify that the broker has started, and `bc` for simple calculations.
+Install both of them:
+```bash
+sudo aptitude install netcat
+sudo aptitude install bc
+```
+
+Test it by launching:
+```bash
+test/functionalTest/testHarness.sh
+```
+
+There are over 1250 test cases (each with a number of steps), so, it will take a while.
+Orion-LD has inherited the functional test suite from `orion` and added some 250 test cases only for NGSI-LD.
+If you want to run only the NGSi-LD test cases, run the suite with the `-ld` option:
+
+```bash
+test/functionalTest/testHarness.sh -ld
+```
+
+There are lots of command line options for the test suite; use the `-u` option to see all of them.
+
+In case some functional test case fails, normally due to installation error, and you're not really interested in that case (might be for IPv6 and you aren't interested in IPv6), you can disable test cases.
+
+Functional test cases can be disabled by exporting an environment variable called `CB_SKIP_FUNC_TESTS`.
+For example, to disable the test case 'direct_https_notifications.test' (you don't want https notification, so ...), do this:
+
+```bash
+export CB_SKIP_FUNC_TESTS=0706_direct_https_notifications/direct_https_notifications.test
+```
+Note that not only the name of the test case file, but also the directoy where it resides is part of the "identifier".
+This is so because different functional test case directories can have test case files with the same name.
+
+FYI: after following myself the instructions in the installation guides, the following functional tests failed for me:
+
+* 0706_direct_https_notifications/direct_https_notifications.test
+* 0706_direct_https_notifications/direct_https_notifications_no_accept_selfsigned.test
+
+Hmmm, something about https seems to be missing in the instructions ...
+
+Looking closer at the errors, it seems clear that it is the accumulator script that is having problems (the accumulator log-file says: **AttributeError: 'Context' object has no attribute 'wrap_socket'**).
+I will have to look into this, but for now, I simply do this:
+
+```bash
+export CB_SKIP_FUNC_TESTS="0706_direct_https_notifications/direct_https_notifications.test 0706_direct_https_notifications/direct_https_notifications_no_accept_selfsigned.test"
+```
+
+Remember to put this environment variable in your startup files (e.g. `~/.bash_profile`), so that you don't lose it.
+Also, the directory added to PATH should be saved in your startup files.

doc/manuals-ld/installation-guide-ubuntu-20.04.1.md

@@ -207,9 +207,11 @@ make html
 make
 sudo make install
 
-# Python library
-sudo aptitude install python3-paho-mqtt
+# Install the python library for MQTT: **paho-mqtt**
+sudo aptitude install python3-pip
+pip3 install paho-mqtt
 ```
+
 #### Eclipse Mosquitto
 
 *Eclipse Mosquitto* is an open source (EPL/EDL licensed) message broker that implements the MQTT protocol versions 5.0, 3.1.1 and 3.1. Mosquitto is lightweight and is suitable for use on all devices from low power single board computers to full servers. Source: https://mosquitto.org

doc/manuals-ld/installation-guide.md

@@ -299,7 +299,8 @@ Now please continue to learn about Orion-LD with the (Getting Started Guide)[get
 
 If you feel like running tests, to **really** make sure your Orion-LD Context Broker is working correctly,
 please follow the instructions in your respective Installation Guide for Functional Tests:
-* [Ubuntu 18.04.3](installation-guide-functional-tests-ubuntu18.04.3.md)
+* [Ubuntu 18.04](installation-guide-functional-tests-ubuntu18.04.3.md)
+* [Ubuntu 20.04](installation-guide-functional-tests-ubuntu20.04.1.md)
 * [CentOS 7](installation-guide-functional-tests-centos7.md)
 * [Debian 9](installation-guide-functional-tests-debian9.md)