[autotest] Make _SuiteSpec private
This way all of the public members of dynamic_suite.py are suite
functions:
run_foo_suite(**dargs)
Thus the API is clearly defined.
BUG=chromium:672348
TEST=None
Change-Id: I1c618a6df1451df2f4011db93d2fe35bf5237811
Reviewed-on: https://chromium-review.googlesource.com/562664
Commit-Ready: Allen Li <ayatane@chromium.org>
Tested-by: Allen Li <ayatane@chromium.org>
Reviewed-by: Allen Li <ayatane@chromium.org>
diff --git a/server/cros/dynamic_suite/dynamic_suite.py b/server/cros/dynamic_suite/dynamic_suite.py
index 0068620..b823e18 100644
--- a/server/cros/dynamic_suite/dynamic_suite.py
+++ b/server/cros/dynamic_suite/dynamic_suite.py
@@ -197,7 +197,7 @@
# Relevant CrosDynamicSuiteExceptions are defined in client/common_lib/error.py.
-class SuiteSpec(object):
+class _SuiteSpec(object):
"""This class contains the info that defines a suite run."""
_REQUIRED_KEYWORDS = {
@@ -407,7 +407,7 @@
"""Add builds to suite_dependencies.
To support provision both CrOS and firmware, option builds are added to
- SuiteSpec, e.g.,
+ _SuiteSpec, e.g.,
builds = {'cros-version:': 'x86-alex-release/R18-1655.0.0',
'fwrw-version:': 'x86-alex-firmware/R36-5771.50.0'}
@@ -436,7 +436,7 @@
@raises MalformedDependenciesException: if the dependency_info file for
the required build fails to parse.
"""
- spec = SuiteSpec(**dargs)
+ spec = _SuiteSpec(**dargs)
afe = frontend_wrappers.RetryingAFE(timeout_min=30, delay_sec=10,
user=spec.job.user, debug=False)
@@ -489,13 +489,13 @@
provided builds, and then run the indicated test suite on them.
Guaranteed to be compatible with any build from stable to dev.
- @param dargs: Dictionary containing the arguments passed to SuiteSpec().
+ @param dargs: Dictionary containing the arguments passed to _SuiteSpec().
@raises AsynchronousBuildFailure: if there was an issue finishing staging
from the devserver.
@raises MalformedDependenciesException: if the dependency_info file for
the required build fails to parse.
"""
- suite_spec = SuiteSpec(**dargs)
+ suite_spec = _SuiteSpec(**dargs)
afe = frontend_wrappers.RetryingAFE(timeout_min=30, delay_sec=10,
user=suite_spec.job.user, debug=False)
@@ -518,7 +518,7 @@
"""
Do the work of reimaging hosts and running tests.
- @param spec: a populated SuiteSpec object.
+ @param spec: a populated _SuiteSpec object.
@param afe: an instance of AFE as defined in server/frontend.py.
@param tko: an instance of TKO as defined in server/frontend.py.
@param suite_job_id: Job id that will act as parent id to all sub jobs.
@@ -557,7 +557,7 @@
Do the work of reimaging hosts and running tests.
@param suite: _BaseSuite instance to run.
- @param spec: a populated SuiteSpec object.
+ @param spec: a populated _SuiteSpec object.
"""
_run_suite(
suite=suite,
diff --git a/server/cros/dynamic_suite/dynamic_suite_unittest.py b/server/cros/dynamic_suite/dynamic_suite_unittest.py
index 3eec263..bcfcb24 100755
--- a/server/cros/dynamic_suite/dynamic_suite_unittest.py
+++ b/server/cros/dynamic_suite/dynamic_suite_unittest.py
@@ -15,7 +15,6 @@
import common
from autotest_lib.client.common_lib import base_job, error
-from autotest_lib.client.common_lib.cros import dev_server
from autotest_lib.server.cros import provision
from autotest_lib.server.cros.dynamic_suite import dynamic_suite
from autotest_lib.server.cros.dynamic_suite.suite import Suite
@@ -49,7 +48,7 @@
def testVetRequiredReimageAndRunArgs(self):
"""Should verify only that required args are present and correct."""
- spec = dynamic_suite.SuiteSpec(**self._DARGS)
+ spec = dynamic_suite._SuiteSpec(**self._DARGS)
self.assertEquals(spec.builds, self._DARGS['builds'])
self.assertEquals(spec.board, 'board:' + self._DARGS['board'])
self.assertEquals(spec.name, self._DARGS['name'])
@@ -61,7 +60,7 @@
"""
self._DARGS['builds'] = None
self.assertRaises(error.SuiteArgumentException,
- dynamic_suite.SuiteSpec,
+ dynamic_suite._SuiteSpec,
**self._DARGS)
@@ -69,7 +68,7 @@
"""Should fail verification because |board| arg is bad."""
self._DARGS['board'] = None
self.assertRaises(error.SuiteArgumentException,
- dynamic_suite.SuiteSpec,
+ dynamic_suite._SuiteSpec,
**self._DARGS)
@@ -77,7 +76,7 @@
"""Should fail verification because |name| arg is bad."""
self._DARGS['name'] = None
self.assertRaises(error.SuiteArgumentException,
- dynamic_suite.SuiteSpec,
+ dynamic_suite._SuiteSpec,
**self._DARGS)
@@ -85,13 +84,13 @@
"""Should fail verification because |job| arg is bad."""
self._DARGS['job'] = None
self.assertRaises(error.SuiteArgumentException,
- dynamic_suite.SuiteSpec,
+ dynamic_suite._SuiteSpec,
**self._DARGS)
def testOverrideOptionalReimageAndRunArgs(self):
"""Should verify that optional args can be overridden."""
- spec = dynamic_suite.SuiteSpec(**self._DARGS)
+ spec = dynamic_suite._SuiteSpec(**self._DARGS)
self.assertEquals(spec.pool, 'pool:' + self._DARGS['pool'])
self.assertEquals(spec.num, self._DARGS['num'])
self.assertEquals(spec.check_hosts, self._DARGS['check_hosts'])
@@ -109,7 +108,7 @@
del(self._DARGS['num'])
del(self._DARGS['suite_dependencies'])
- spec = dynamic_suite.SuiteSpec(**self._DARGS)
+ spec = dynamic_suite._SuiteSpec(**self._DARGS)
self.assertEquals(spec.pool, None)
self.assertEquals(spec.num, None)
self.assertEquals(spec.check_hosts, True)