How to Use the Command 'pyATS' (with examples)

The pyATS command is a part of a vendor-agnostic test automation framework developed by Cisco Systems. It is predominantly utilized for network and systems testing. This robust automation framework enables users to create and run a wide range of tests on devices from multiple vendors seamlessly. For those in network engineering or systems testing, pyATS simplifies automation, increases efficiency, and ultimately enhances testing accuracy and consistency.

Use case 1: Running a pyATS Subcommand

Code:

pyats subcommand

Motivation: Running the pyats subcommand is generally the first step in executing a specific task within the pyATS framework. Each subcommand serves as an entry point to a particular function or feature of the framework, such as creating testbeds, running tests, or gathering reports. Using subcommands allows users to target their actions precisely and effectively manage their testing processes without causing interference to global settings.

Explanation:

• pyats: This is the primary command to invoke the pyATS framework.
• subcommand: This is a placeholder for the specific command you would like to execute, such as run or create. The actual subcommand must be replaced with a valid function name when running the command.

Example Output: The output will depend on the specific subcommand used. For example, if you were running a subcommand responsible for creating a testbed, the output might include confirmation of the testbed’s successful creation, along with relevant details about the testbed configuration.

Use case 2: Displaying Help

Code:

pyats --help

Motivation: Displaying help is crucial when getting started with pyATS or when needing a quick refresher on the available options and subcommands. It provides a thorough list of all the available commands, options, and descriptions that form part of the framework. This is invaluable when you need to quickly confirm command usage or find new features or commands added in recent updates.

Explanation:

• pyats: The main command that initializes the pyATS framework.
• --help: This option requests the display of the help information, showing a list of all available commands, their descriptions, and usage examples.

Example Output:

Usage: pyats [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  version  Check the pyATS version.
  create   Create a new testbed.
  run      Execute a test using an existing testbed.
  ...

For more help on a specific command run 'pyats COMMAND --help'.

Use case 3: Displaying Help About a Specific Subcommand

Code:

pyats subcommand --help

Motivation: Learning more about a specific subcommand’s functionality is essential for optimizing test scripts and efficiently utilizing the pyATS framework. Displaying detailed help for a specific subcommand allows users to grasp all the related options and configurations they have at their disposal. This leads to a more profound understanding of command uses and potential configurations to maximize capability and minimize errors.

Explanation:

• pyats: Initializes the pyATS command suite.
• subcommand: Replace this with the subcommand you wish to learn about, such as run.
• --help: Instructs pyATS to display more detailed help information for the specified subcommand, outlining the command’s purpose, expected arguments, and usage examples.

Example Output:

Usage: pyats run [OPTIONS] [JOB_FILE]

Options:
  --testbed-file PATH  Path to the testbed file.
  --tags TEXT          Specify tags to filter the testcases.
  --help               Show this message and exit.
  
Examples:
  pyats run job example_job.py --testbed-file testbed.yaml

Use case 4: Displaying Version of pyATS

Code:

pyats version check

Motivation: Knowing the version of your pyATS installation is crucial for compatibility and troubleshooting purposes. It helps ensure that you’re working with the most recent capabilities of the framework, and identify whether you’ve met the dependency requirements for specific tests or scripts. Keeping track of version changes assists users in making informed decisions regarding updates or downgrades necessary for their testing needs.

Explanation:

• pyats: The main command interface for working within the pyATS environment.
• version: A subcommand used to query version information.
• check: An action that tells the framework to output the currently installed version of pyATS.

Example Output:

Current pyATS Version: 21.4.1

Conclusion:

The pyATS command provides various subcommands and options that help users efficiently manage network and systems testing. By understanding each use case and the purpose behind each subcommand, users can harness the full potential of the pyATS framework, thereby enhancing their testing strategies and improving overall automation processes.