summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCédric Ollivier <cedric.ollivier@orange.com>2018-06-18 19:48:29 +0200
committerCédric Ollivier <cedric.ollivier@orange.com>2018-06-18 21:51:34 +0200
commita9cd11304620c3810fb7849f5a606488e2479a12 (patch)
treec5d094c7ca5d2a6d12ca4ffb4863c3befb0e3c7b
parent594a3f389add82469ef66462cdbd30347945f6ee (diff)
Add minimal docstings in clearwater_ims_base.py
It will allow forcing 10/10 in any new patchset. Change-Id: I4cc52a9fb66fdd2c0dcbf9915be262acedac8672 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> (cherry picked from commit f1353fff60344b01c588d9724b3b1de819cbe661)
-rw-r--r--functest/opnfv_tests/vnf/ims/clearwater_ims_base.py15
1 files changed, 14 insertions, 1 deletions
diff --git a/functest/opnfv_tests/vnf/ims/clearwater_ims_base.py b/functest/opnfv_tests/vnf/ims/clearwater_ims_base.py
index e01cef7b9..add99468b 100644
--- a/functest/opnfv_tests/vnf/ims/clearwater_ims_base.py
+++ b/functest/opnfv_tests/vnf/ims/clearwater_ims_base.py
@@ -6,6 +6,9 @@
# which accompanies this distribution, and is available at
#
# http://www.apache.org/licenses/LICENSE-2.0
+
+"""Ease testing any Clearwater deployment"""
+
import logging
import os
import re
@@ -26,7 +29,7 @@ __author__ = ("Valentin Boucher <valentin.boucher@orange.com>, "
class ClearwaterOnBoardingBase(vnf.VnfOnBoarding):
- """ vIMS clearwater base usable by several orchestrators"""
+ """vIMS clearwater base usable by several orchestrators"""
def __init__(self, **kwargs):
self.logger = logging.getLogger(__name__)
@@ -44,6 +47,7 @@ class ClearwaterOnBoardingBase(vnf.VnfOnBoarding):
os.makedirs(self.result_dir)
def config_ellis(self, ellis_ip, signup_code='secret', two_numbers=False):
+ """Create one or two numbers"""
output_dict = {}
self.logger.debug('Configure Ellis: %s', ellis_ip)
output_dict['ellis_ip'] = ellis_ip
@@ -114,6 +118,15 @@ class ClearwaterOnBoardingBase(vnf.VnfOnBoarding):
def run_clearwater_live_test(self, dns_ip, public_domain,
bono_ip=None, ellis_ip=None,
signup_code='secret'):
+ """Run the Clearwater live tests
+
+ It first runs dnsmasq to reach clearwater services by FQDN and then the
+ Clearwater live tests. All results are saved in ims_test_output.txt.
+
+ Returns:
+ - a dict containing the overall results
+ - None on error
+ """
# pylint: disable=too-many-locals,too-many-arguments
self.logger.info('Run Clearwater live test')
dns_file = '/etc/resolv.conf'