Skip to content

Latest commit

 

History

History
131 lines (100 loc) · 4.75 KB

installation-guide-functional-tests-ubuntu20.04.1.md

File metadata and controls

131 lines (100 loc) · 4.75 KB
Raw

Installation Guide for the Orion-LD Functional Test Suite on Ubuntu 20.04

The functional test suite for Orion-LD (found in test/functionalTests) needs some installation in order to work.

Begin with "cd-ing" to the root of repository of Orion-LD, e.g.:

cd ~/git/context.Orion-LD

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 (python 3.8) needs a few packages to be installed. For this, we need to know the version of python. Ubuntu 20.04 and other versions of Debian Linux ship with Python 3 pre-installed. To make sure that our versions are up-to-date, update your local package index:

sudo apt update

Then upgrade the packages installed on your system to ensure you have the last versions:

sudo apt -y upgrade

Once this operation ends, we can check which version of python 3 is installed in the system:

python3 -V

Note: If you wish to use python2, create the corresponding link with the following command:

sudo ln -s /usr/bin/python2 /usr/bin/python

The next step is the installation of the virtual environment of python:

sudo apt -y install python3-virtualenv

Now we can create our virtual python environment, executing:

virtualenv -p python3 .venv

This operation creates the .venv environment that we will later use to execute our scripts. Active the environment with the following command:

. .venv/bin/activate

Note: To deactivate the virtual environment, just execute:

deactivate

Finally, install the corresponding requirements, executing:

pip install -r scripts/requirements.txt

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:

export PATH=$PATH:$PWD/scripts
which accumulator-server.py

The output of the which command should be:

./scripts/accumulator-server.py

The test script uses nc to verify that the broker has started, and bc for simple calculations. These two commands are part of the base in Ubuntu 20.04, so, no installtion should be needed.

Some python scripts use the shebang #/usr/bin/python, so, we'll need to put python3 there:

sudo ln -s /usr/bin/python3 /usr/bin/python

And with that, we're ready to launch the functional test suite:

test/functionalTest/testHarness.sh

There are over 1500 test cases (each of them with 3-100 test steps), so, it will take a while. Orion-LD has inherited the functional test suite from orion and added some 450 test cases only for NGSI-LD. If you want to run only the NGSI-LD test cases, run the suite with the -ld, or/and the -troe option:

test/functionalTest/testHarness.sh -ld
test/functionalTest/testHarness.sh -troe

["troe" stands for "Temporal Representation of Entities"]

There are lots of command line options for the test suite. Use the -u option to see all of them.

In case a 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), there is a mechanism for disabling of 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:

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 directory 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 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:

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.