From e26f3c31bc6e11fdf34e559596cb14581c21dca1 Mon Sep 17 00:00:00 2001 From: Linda Wang Date: Mon, 5 Feb 2018 04:05:22 +0000 Subject: Add modules docstrings in snaps JIRA: FUNCTEST-922 Change-Id: I058486427fe55e1d1ce939fce20d75ff7afde85c Signed-off-by: Linda Wang --- functest/opnfv_tests/openstack/snaps/api_check.py | 2 +- functest/opnfv_tests/openstack/snaps/health_check.py | 2 +- functest/opnfv_tests/openstack/snaps/smoke.py | 2 +- functest/opnfv_tests/openstack/snaps/snaps_suite_builder.py | 8 +++++++- functest/opnfv_tests/openstack/snaps/snaps_test_runner.py | 2 +- functest/opnfv_tests/openstack/snaps/snaps_utils.py | 2 +- 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 e8b9c322..b8cd4fdd 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 db882c38..8a88ac6b 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 ef6e5dc9..bc678118 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 c3d8c2d8..ab7b368f 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 a2dadb75..9d31f426 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 e2f75c3f..6bc50ad6 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 -- cgit 1.2.3-korg