You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/index.rst
-1Lines changed: 0 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,6 @@ Enhance NUTS
42
42
Since NUTS is written as a pytest plugin and in python, you can customize it yourself and write your own test classes. Please see the :doc:`development section <dev/index>` to see how NUTS is structured and how to write your own test classes.
Copy file name to clipboardExpand all lines: docs/source/tutorial/firststeps.rst
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
1
First Steps with NUTS
2
2
=====================
3
3
4
-
This tutorial guides you through a minimal setup of NUTS.
4
+
This tutorial guides you through a minimal setup of the NetTowel Unit Testing System (NUTS, or nuts).
5
5
6
-
Two major components are needed for NUTS:
6
+
Two major components are needed for nuts:
7
7
8
8
#. A network inventory
9
9
#. Test bundles
@@ -71,7 +71,7 @@ If you set up the above folders and files, you're ready to write test bundles.
71
71
72
72
A test bundle is a collection of tests are logically related to each other, for example tests that all revolve around "information on BGP neighbors". The test bundle describes which test definition should be collected and executed and provides data for those tests. The bundles are written as individual entries in a YAML file.
73
73
74
-
Currently only YAML files are supported as test bundle format, but other data sources could be integrated in later versions of NUTS.
74
+
Currently only YAML files are supported as test bundle format, but other data sources could be integrated in later versions of nuts.
75
75
76
76
Structure of a Test Bundle
77
77
**************************
@@ -93,7 +93,7 @@ Each test bundle contains the following structure:
93
93
``label``: Optional. Additional identifier that can be used to distinguish between multiple occurrences of the same
94
94
test class in a test bundle.
95
95
96
-
``test_execution``: Optional. NUTS uses nornir tasks to automatically interact with the network. This field contains additional information that is directly passed to the nornir task in the background. Therefore the key-value pairs must be consistent with the key-value pairs of the specific nornir task.
96
+
``test_execution``: Optional. Nuts uses nornir tasks to automatically interact with the network. This field contains additional information that is directly passed to the nornir task in the background. Therefore the key-value pairs must be consistent with the key-value pairs of the specific nornir task.
97
97
As an example, the test definition ``TestNapalmPing`` calls a nornir task to execute napalm's ping-command.
98
98
This allows the additional ``count`` parameter in ``test execution``, since it is in turn pre-defined by napalm. Please see the :doc:`chapter on test bundles <../testbundles/alltestbundles>` for more detailed explanations.
0 commit comments