pyats validate¶
Helper command, offering subcommands that focuses on validating various pyATS related input files, formats, and content.
Usage:
pyats validate <subcommand> [options]
Subcommands:
datafile validate your YAML-based datafile syntax
jinja2_config validate genie config file jinja2 rendering
testbed validate your testbed file yaml syntax
General Options:
-h, --help Show help
-v, --verbose Give more output, additive up to 3 times.
-q, --quiet Give less output, additive up to 3 times, corresponding to WARNING, ERROR,
and CRITICAL logging levels
pyats validate testbed¶
This subcommand validates the content of your Testbed File. It gives developers an opportunity to check if the file is written following valid YAML syntax, and adheres to the Topology Schema.
Usage:
pyats validate testbed [file] [options]
Description:
Validates the provided testbed YAML file for syntax and content completeness.
Testbed Options:
[file] Testbed YAML file to validate
--connect Test each device's connections
--no-lint Do not lint the testbed YAML file
Options¶
[file]the input testbed yaml file. Can be a file path or a URL to a YAML file
--connectbest-effort attempt to connect to each testbed device using
device.connect(). Consider this as a rudimentary method of ensuring your devices’s connection block is well defined/formed.--no-lintskips the linting of your testbed YAML file for syntax errors and warnings.
Example¶
# Example
# -------
#
# validating a testbed input file
bash$ pyats validate testbed N7K-EZ-HW-7-SSR.yaml
Loading testbed file: N7K-EZ-HW-7-SSR.yaml
--------------------------------------------------------------------------------
Testbed Name:
N7K-EZ-HW-7-SSR
Testbed Devices:
.
|-- P1 [router/nxos]
| `-- Ethernet3/9 ----------> link-1
`-- PE1 [router/nxos]
`-- Ethernet3/9 ----------> link-1
Warning Messages
----------------
- Device 'P1' missing 'platform' definition
- Device 'PE1' missing 'platform' definition
pyats validate datafile¶
This subcommand validates the content any pyATS YAML datafile, including Datafile Inputs. It understands the various YAML datafile syntaxes introduced as part of pyATS’s extended YAML loader, and gives developers an opportunity to check:
what the expanded data looks like
if correct YAML syntax is followed
Returns the loaded, validated datafile, with extends: block expanded.
Usage:
pyats validate datafile [file] [options]
Description:
Validates the provided YAML datafile for syntax and content completeness.
Note:
This command also understands the pyATS datafile 'extends:' syntax, and
returns the complete, full data content with extensions fulfilled.
Datafile Options:
[file] Datafile to validate
--schema Schema to validate datafile structure
--json Output in JSON format
--no-lint Do not lint the YAML datafile
General Options:
-h, --help Show help
-v, --verbose Give more output, additive up to 3 times.
-q, --quiet Give less output, additive up to 3 times, corresponding to WARNING, ERROR,
and CRITICAL logging levels
Options¶
[file]the input datafile. Can be a file path or a URL to a YAML file
--schemaPython module.object to the schema to validate the provided datafile against
--jsonreturn output in JSON format instead of YAML. (cannot be used when
--schemais provided)--no-lintskips the linting of your datafile file for syntax errors and warnings.
Example¶
# Example
# -------
#
# validating an AEtest datafile
bash$ pyats validate datafile $VIRTUAL_ENV/examples/comprehensive/data/base_datafile.yaml
Loading datafile: examples/comprehensive/data/base_datafile.yaml
--------------------------------------------------------------------------------
parameters:
parameter_A: datafile value A
parameter_B: datafile value B
testcases:
ExampleTestcase:
uid: ExampleTestcaseDatafileID
description: 'block of text describing what this testcase does
'
groups:
- group_A
- group_B
- group_C
- group_D
parameters:
local_A: datafile value A
local_B: datafile value B
data_A: attribute data A
data_B: attribute data B
LoopedTestcase:
groups: []
TestcaseWithSteps:
uid: TestcaseWithStepsDatafileID
YAML Lint Messages
------------------
5:75 error trailing spaces (trailing-spaces)
19:42 error trailing spaces (trailing-spaces)
53:1 error trailing spaces (trailing-spaces)
72:41 error no new line character at the end of file (new-line-at-end-of-file)
# Example
# -------
#
# validating an AEtest datafile against schema
# (eg, datafile schema is available as:
# from pyats.aetest.datafile.schema import datafile_schema)
bash$ pyats validate datafile examples/comprehensive/data/base_datafile.yaml --schema pyats.aetest.datafile.schema.datafile_schema
Loading datafile: examples/comprehensive/data/base_datafile.yaml
--------------------------------------------------------------------------------
{'parameters': {'parameter_A': 'datafile value A',
'parameter_B': 'datafile value B'},
'testcases': {'ExampleTestcase': {'data_A': 'attribute data A',
'data_B': 'attribute data B',
'description': 'block of text describing '
'what this testcase does\n',
'groups': ['group_A',
'group_B',
'group_C',
'group_D'],
'parameters': {'local_A': 'datafile value A',
'local_B': 'datafile value '
'B'},
'uid': 'ExampleTestcaseDatafileID'},
'LoopedTestcase': {'groups': []},
'TestcaseWithSteps': {'uid': 'TestcaseWithStepsDatafileID'}}}
YAML Lint Messages
------------------
5:75 error trailing spaces (trailing-spaces)
19:42 error trailing spaces (trailing-spaces)
53:1 error trailing spaces (trailing-spaces)
72:41 error no new line character at the end of file (new-line-at-end-of-file)
Tip
use -q to quiet pretty information such as “—-” sections and headers.
pyats validate jinja2_config¶
This subcommand validates the content of your Genie configuration datafile. It gives developers an opportunity to check if the file is written following valid YAML syntax and what the Jinja2 rendered output configuration looks like.
Usage:
pyats validate jinja2_config [file] [options]
Description:
Validates the provided genie config file for jinja2 rendering.
Jinja2_config Options:
[file] Genie config datafile to validate
--testbed-file TESTBED
Testbed file (required)
--devices DEVICES [DEVICES ...]
Devices to render configs for (optional)
--sequence SEQUENCE [SEQUENCE ...]
Sequence(s) to render (optional)
General Options:
-h, --help Show help
-v, --verbose Give more output, additive up to 3 times.
-q, --quiet Give less output, additive up to 3 times, corresponding to WARNING, ERROR,
and CRITICAL logging levels
Options¶
[file]The Genie configuration datafile. Can be a file path or a URL to a YAML file
--devicesDevice names to render the configuration for. Only configurations for these devices will be used to render configurations.
--sequenceSequence(s) to render the configuration for. Only the sequences specified will be rendered.
Example¶
$ pyats validate jinja2_config data/config_datafile.yaml --testbed-file data/testbed.yaml --sequence 1
Device R1 sequence 1:
interface Loopback0
no shutdown
ip address 1.1.1.1 255.255.255.255
Device R2 sequence 1:
interface Loopback0
no shutdown
ip address 2.2.2.2 255.255.255.255