docs: updated testbed specification with clx build

[csit.git] / requirements.txt

diff --git a/requirements.txt b/requirements.txt
index ad67e07..3fa2a9d 100644 (file)
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,13 +1,57 @@
-robotframework==2.9.2
-paramiko==1.16.0
-scp==0.10.2
+# DISCLAIMER: BEFORE EDITING THIS FILE!
+#
+# This file has two closely related consequences.
+# The common part is that this file defines
+# the content of virtual Python environment
+# used when Robot tests are running.
+# The difference is in which machine the environment is created on.
+# For the Jenkins executor machines,
+# editing this file has no surprising consequences.
+#
+# But the environment is also being created
+# on virtual machines created by VIRL, which do have specific restrictions.
+# Complete package and setting snapshot (for both VIRL and Physical Testbed),
+# with network being limited in case of VIRL to local only.
+# This implies pip currently being set to site-packages only
+# for both VIRL and Physical Testbed.
+# So if the "virl image" applied on the machine
+# does not reflect the edits, some installations might fail.
+# Even if the failure may not directly impact execution,
+# this leads into inconsistency between installed environment
+# and the code base which may lead into fatal error or uncaught exceptions.
+#
+# The "virl image" is built from files such as
+# resources/tools/disk-image-builder/ubuntu/lists/ubuntu-16.04.1_2017-10-21_2.0/pip-requirements.txt
+# but the build is not automated,
+# the new "virl image" has to be built and applied manually
+# before your edit can pass.
+# This also means, incompatible virl images
+# would make existing tests fail until your edit is merged.
+#
+# TODO: Automate the virtualenv download and distribution
+#   on all types of testbeds prior the test execution.
+# TODO: Figure out a way to verify edits to this file automatically.
+
+# TODO: Split into directly needed packages and their dependencies.
+aenum==2.1.2
+docopt==0.6.2  # for pykwalify
+ecdsa==0.13
+enum34==1.1.2
 ipaddress==1.0.16
-interruptingcow==0.6
-PyYAML==3.11
+paramiko==1.16.0
+pexpect==4.6.0
+pycrypto==2.6.1
 pykwalify==1.5.0
-scapy==2.3.1
-enum34==1.1.2
+pypcap==1.1.5
+python-dateutil==2.4.2  # for pykwalify
+PyYAML==3.11
 requests==2.9.1
-ecdsa==0.13
-pycrypto==2.6.1
+robotframework==2.9.2
+scapy==2.3.1
+scp==0.10.2
+six==1.12.0  # for python-dateutil
 
+# The following is only there for PLRsearch.
+dill==0.2.8.2
+numpy==1.14.5
+scipy==1.1.0