summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLinda Wang <wangwulin@huawei.com>2018-02-05 04:05:22 +0000
committerLinda Wang <wangwulin@huawei.com>2018-02-05 04:05:22 +0000
commite26f3c31bc6e11fdf34e559596cb14581c21dca1 (patch)
tree42bb696311f650ad14e8a1eab1f14f446a4eef25
parente338c837cfa7476ad83e355b6149c37adc1715a5 (diff)
Add modules docstrings in snaps
JIRA: FUNCTEST-922 Change-Id: I058486427fe55e1d1ce939fce20d75ff7afde85c Signed-off-by: Linda Wang <wangwulin@huawei.com>
-rw-r--r--functest/opnfv_tests/openstack/snaps/api_check.py2
-rw-r--r--functest/opnfv_tests/openstack/snaps/health_check.py2
-rw-r--r--functest/opnfv_tests/openstack/snaps/smoke.py2
-rw-r--r--functest/opnfv_tests/openstack/snaps/snaps_suite_builder.py8
-rw-r--r--functest/opnfv_tests/openstack/snaps/snaps_test_runner.py2
-rw-r--r--functest/opnfv_tests/openstack/snaps/snaps_utils.py2
6 files changed, 12 insertions, 6 deletions
diff --git a/functest/opnfv_tests/openstack/snaps/api_check.py b/functest/opnfv_tests/openstack/snaps/api_check.py
index e8b9c3227..b8cd4fdd4 100644
--- a/functest/opnfv_tests/openstack/snaps/api_check.py
+++ b/functest/opnfv_tests/openstack/snaps/api_check.py
@@ -8,7 +8,7 @@
#
# http://www.apache.org/licenses/LICENSE-2.0
-# pylint: disable=missing-docstring
+"""api_check test case implementation"""
import unittest
diff --git a/functest/opnfv_tests/openstack/snaps/health_check.py b/functest/opnfv_tests/openstack/snaps/health_check.py
index db882c382..8a88ac6b8 100644
--- a/functest/opnfv_tests/openstack/snaps/health_check.py
+++ b/functest/opnfv_tests/openstack/snaps/health_check.py
@@ -8,7 +8,7 @@
#
# http://www.apache.org/licenses/LICENSE-2.0
-# pylint: disable=missing-docstring
+"""snaps_health_check test case implementation"""
import unittest
diff --git a/functest/opnfv_tests/openstack/snaps/smoke.py b/functest/opnfv_tests/openstack/snaps/smoke.py
index ef6e5dc9f..bc6781180 100644
--- a/functest/opnfv_tests/openstack/snaps/smoke.py
+++ b/functest/opnfv_tests/openstack/snaps/smoke.py
@@ -8,7 +8,7 @@
#
# http://www.apache.org/licenses/LICENSE-2.0
-# pylint: disable=missing-docstring
+"""snaps_smoke test case implementation"""
import unittest
diff --git a/functest/opnfv_tests/openstack/snaps/snaps_suite_builder.py b/functest/opnfv_tests/openstack/snaps/snaps_suite_builder.py
index c3d8c2d8b..ab7b368fd 100644
--- a/functest/opnfv_tests/openstack/snaps/snaps_suite_builder.py
+++ b/functest/opnfv_tests/openstack/snaps/snaps_suite_builder.py
@@ -8,7 +8,13 @@
#
# http://www.apache.org/licenses/LICENSE-2.0
-# pylint: disable=missing-docstring
+"""
+Snaps test suite including openstack client tests, api tests and
+integration tests.
+add_openstack_client_tests: for connection_check
+add_openstack_api_tests: for api_check
+add_openstack_integration_tests: for snaps_smoke
+"""
import logging
diff --git a/functest/opnfv_tests/openstack/snaps/snaps_test_runner.py b/functest/opnfv_tests/openstack/snaps/snaps_test_runner.py
index a2dadb759..9d31f426c 100644
--- a/functest/opnfv_tests/openstack/snaps/snaps_test_runner.py
+++ b/functest/opnfv_tests/openstack/snaps/snaps_test_runner.py
@@ -8,7 +8,7 @@
#
# http://www.apache.org/licenses/LICENSE-2.0
-# pylint: disable=missing-docstring
+"""configuration params to run snaps tests"""
import logging
diff --git a/functest/opnfv_tests/openstack/snaps/snaps_utils.py b/functest/opnfv_tests/openstack/snaps/snaps_utils.py
index e2f75c3f0..6bc50ad60 100644
--- a/functest/opnfv_tests/openstack/snaps/snaps_utils.py
+++ b/functest/opnfv_tests/openstack/snaps/snaps_utils.py
@@ -7,7 +7,7 @@
#
# http://www.apache.org/licenses/LICENSE-2.0
-# pylint: disable=missing-docstring
+"""Some common utils wrapping snaps functions """
from functest.utils.constants import CONST