Skip to content

Commit 9ae07a0

Browse files
committed
Update Testcase and TestScript object names
* test case > Testcase * test script > TestScript
1 parent 0ad726a commit 9ae07a0

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

docs/aetest/parameters.rst

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,16 @@ Test Parameters
1818
``aetest`` is a data-driven test infrastructure. Its scripts and test cases are
1919
intended to be driven dynamically by:
2020

21-
- Data in the form of input arguments to the test script
21+
- Data in the form of input arguments to the TestScript
2222
- Dynamic data generated during runtime
2323

2424
The collection of dynamic data that artificially affects the behavior of
25-
test scripts and test cases in ``aetest`` is called **parameters**. It adheres to
25+
TestScripts and Testcases in ``aetest`` is called **parameters**. It adheres to
2626
a pre-defined set of parent/child propagation relationships and may be used as
2727
`Function Arguments`_ to each test section.
2828

29-
This feature is a supplement to static test case data (attribute values stored
30-
within each test case).
29+
This feature is a supplement to static Testcase data (attribute values stored
30+
within each Testcase).
3131

3232
.. tip::
3333

@@ -74,7 +74,7 @@ methods as the "doer," then parameters are the "what to do with." E.g., an
7474
add_to_c(1, 2)
7575
# 103
7676
77-
In data-driven testing, test scripts are the *doers*, performing the act
77+
In data-driven testing, TestScripts are the *doers*, performing the act
7878
of testing a facet of some product. Test script arguments and parameters are thus the
7979
input data that influences the specific actions of testing. Here
8080
are some possible use cases:
@@ -86,13 +86,13 @@ are some possible use cases:
8686
- The ``vlan`` argument to the ``layer2_traffic`` script can dynamically control the
8787
VLAN to be configured for traffic testing.
8888

89-
- Other toggle arguments that dynamically turn on/off certain test cases,
89+
- Other toggle arguments that dynamically turn on/off certain Testcases,
9090
and a combination of features to be configured & tested
9191

9292
- Etc.
9393

9494
Of course, the parameters feature in ``aetest`` is much more than just script
95-
arguments. It enables users to write test cases and test scripts that are capable
95+
arguments. It enables users to write Testcases and TestScripts that are capable
9696
of being driven by inputs, varying the degree of testing, etc.
9797

9898
Relationship Model
@@ -162,7 +162,7 @@ execution, this happens behind the scenes automatically.
162162
new_testcase_parameters.update(testcase.parameters)
163163
testcase.parameters = new_testcase_parameters
164164
165-
# so that the new parameters seen in the test case
165+
# so that the new parameters seen in the Testcase
166166
# level, is:
167167
testcase.parameters
168168
# {'param_A': 100, 'param_B': 2, 'param_C': 3}
@@ -178,7 +178,7 @@ Parameters Property
178178
Every top-level object in ``aetest`` comes with the special ``parameters``
179179
property: a dictionary containing the key/value data pairs relative to this
180180
object (:ref:`object_model`). Its default values can be set/updated by the user
181-
within the test script.
181+
within the TestScript.
182182

183183
.. code-block:: python
184184
@@ -203,7 +203,7 @@ within the test script.
203203
# note that this also applies to CommonSetup & CommonCleanup
204204
class Testcase(aetest.Testcase):
205205
206-
# all default parameters specific to this test case are declared
206+
# all default parameters specific to this Testcase are declared
207207
# in its own parameters dictionary.
208208
parameters = {
209209
'generic_param_A': 200
@@ -247,7 +247,7 @@ dynamically access & update parameters.
247247
#
248248
# continuing from the above
249249
250-
# re-defining the test case for the sake of code-continuity
250+
# re-defining the Testcase for the sake of code-continuity
251251
class Testcase(aetest.Testcase):
252252
253253
# local parameters defaults, same as above
@@ -272,7 +272,7 @@ dynamically access & update parameters.
272272
273273
@aetest.test
274274
def test(self):
275-
# access & print parent test script parameters
275+
# access & print parent TestScript parameters
276276
# (following the parent model)
277277
print(self.parent.parameters)
278278
# {'generic_param_A': 100,
@@ -291,7 +291,7 @@ dynamically access & update parameters.
291291
Consider the above example: parameters can be set and accessed as the script
292292
runs, opening the opportunity for scripts to dynamically discover the runtime
293293
environment and modify test behavior (parameters) as required. E.g., the ``setup``
294-
section of modifying test case parameters based on the current testbed state, and
294+
section of modifying Testcase parameters based on the current testbed state, and
295295
altering the behavior of ensuing ``test`` sections, etc.
296296

297297
.. tip::
@@ -306,7 +306,7 @@ altering the behavior of ensuing ``test`` sections, etc.
306306
Script Arguments
307307
----------------
308308

309-
In short, any arguments passed to the test script before startup becomes part of
309+
In short, any arguments passed to the TestScript before startup becomes part of
310310
the ``TestScript`` parameter. This includes all the arguments passed through the
311311
:ref:`easypy_jobfile` during :ref:`aetest_jobfile_execution`, and/or any command
312312
line arguments parsed and passed to ``aetest.main()`` during
@@ -323,7 +323,7 @@ line arguments parsed and passed to ``aetest.main()`` during
323323
# without going into details about how script parameters/arguments are
324324
# passed in (covered under Running Scripts section)
325325
326-
# assuming that the test script was called with the following inputs
326+
# assuming that the TestScript was called with the following inputs
327327
script_arguments = {
328328
'arg_a': 100,
329329
'arg_c': 3,
@@ -353,7 +353,7 @@ script's base parameters and overwrite existing ones.
353353
.. tip::
354354

355355
Define your default parameters in the script, and change the behavior of
356-
the test script by overwriting specific ones using script arguments.
356+
the TestScript by overwriting specific ones using script arguments.
357357

358358
.. _parameters_as_funcargs:
359359

@@ -404,7 +404,7 @@ their support.
404404
405405
# this setup section definition identifies "param_B"
406406
# as an input requirement. As this parameter is available at this
407-
# test case level (aggregated from the parent test script), it
407+
# Testcase level (aggregated from the parent TestScript), it
408408
# is passed in as input
409409
@aetest.setup
410410
def setup(self, param_B):
@@ -533,7 +533,7 @@ support arguments, can identify the current execution context, and
533533
can act accordingly.
534534

535535
A parametrized function is declared when the ``@parameters.parametrize``
536-
decorator is used on a function within a test script. This also adds the newly
536+
decorator is used on a function within a TestScript. This also adds the newly
537537
created parametrized function automatically as part of ``TestScript``
538538
parameters, using the function name as the parameter name.
539539

@@ -583,7 +583,7 @@ identical to its callable parameter sibling, with the following additions:
583583
# As previously stated, there's no need to add parametrized functions
584584
# to the parameters dict(). They are automatically discovered and added.
585585
586-
# Defining two tests under this test case
586+
# Defining two tests under this Testcase
587587
# ----------------------------------------------
588588
# Similar to callable parameters, the above parameters
589589
# are evaluated when used as function arguments to section
@@ -686,8 +686,8 @@ property, and is not useable as a function argument.
686686
# names as keyword arguments to methods
687687
@aetest.subsection
688688
def subsection_one(self, testscript, section, steps):
689-
# Testscript object has an attribute called module
690-
# which is this test script's module
689+
# TestScript object has an attribute called module
690+
# which is this TestScript's module
691691
print (testscript.module)
692692
# <module 'example_script' from '/path/to/example.py'>
693693
@@ -718,7 +718,7 @@ property, and is not useable as a function argument.
718718
719719
Reserved parameters provide ``aetest`` a mechanism to offer optional features
720720
without polluting the :ref:`object_model` with additional attributes. It also
721-
allows users to write test scripts that delve deeper and interact with the
721+
allows users to write TestScripts that delve deeper and interact with the
722722
internals of ``aetest`` using a supported method instead of hacking around.
723723

724724
*With great power comes great responsibilities* - use them wisely.

0 commit comments

Comments
 (0)