pyATS AEtest

Common errors

• ModuleNotFoundError: No module named 'pyats_aetest'

  cause The package was either not installed correctly using the dot notation, or the import statement used `_` instead of `.` or directly imported `pyats_aetest`.
  fix Ensure installation with `pip install pyats.aetest` and import using `from pyats import aetest` or `import pyats.aetest`.

• AttributeError: 'Runtime' object has no attribute 'testbed'

  cause The test script is attempting to access `self.runtime.testbed` (or `self.parameters['testbed']`) but was executed directly via `python <script.py>` without a testbed being loaded by the pyATS infrastructure.
  fix Run your test script using the `pyats run testbed` command, specifying a testbed file: `pyats run testbed <script.py> --testbed-file <testbed.yaml>`.

• TypeError: 'str' object is not callable when trying to execute a test section

  cause This often happens if you accidentally define a method like `@aetest.test def setup(self):` where `setup` is a string parameter for a decorator, or if you attempt to call a variable that holds a string.
  fix Carefully review your test section definitions, ensuring that `aetest.test`, `aetest.subsection`, etc., are applied to methods, and that method names don't conflict with built-in or reserved names if called directly as variables.

Warnings

• breaking pyATS AEtest officially supports Python 3.8 and newer. Attempting to use older Python versions (e.g., Python 2.7 or Python 3.7) will lead to compatibility issues and `SyntaxError` or `ImportError` messages.
  Fix: Ensure your environment uses Python 3.8 or a later supported version. Upgrade Python if necessary or use a virtual environment with the correct Python version.
• gotcha The PyPI package name `pyats-aetest` uses a hyphen, but the Python package name for importing is `pyats.aetest`. A common mistake is trying to `import pyats_aetest` or `import pyats-aetest`.
  Fix: Always use `from pyats import aetest` or `import pyats.aetest` in your code. Install with `pip install pyats.aetest`.
• gotcha Running an AEtest script directly (e.g., `python my_test.py`) will execute the tests, but it will not automatically parse a testbed YAML file or provide advanced reporting features. This can lead to `AttributeError` if your script tries to access `self.runtime.testbed` or `self.parameters['testbed']`.
  Fix: For full functionality, including testbed parsing and rich reporting, always run your AEtest scripts using the `pyats run testbed` command: `pyats run testbed <script.py> --testbed-file <testbed.yaml>`.
• deprecated Older pyATS versions used `self.parent.parameters['testbed']` to access the testbed object. While this still works, the recommended and more robust way to access the testbed is via `self.runtime.testbed` when running with `pyats run testbed`.
  Fix: Prefer `self.runtime.testbed` for accessing the testbed object within your test sections, ensuring your script is executed via `pyats run testbed`.

Install

• pip install pyats.aetest Install latest version

Imports

• aetest
  wrong:

  import pyats_aetest

  correct:

  from pyats import aetest

  The PyPI package `pyats-aetest` is imported as `pyats.aetest` or directly from `pyats` as `aetest`.

Quickstart

This quickstart demonstrates the basic structure of a pyATS AEtest script, including `CommonSetup`, `Testcase`, and `CommonCleanup` sections. It defines a simple testcase that uses data set up in the CommonSetup. The `aetest.main()` call allows the script to be executed directly.

from pyats import aetest

class CommonSetup(aetest.CommonSetup):
    """Common Setup for all testcases"""
    @aetest.subsection
    def initial_setup(self):
        self.parent.parameters['my_data'] = 'initialized_data'
        self.passed('Common Setup completed')

class TestcaseOne(aetest.Testcase):
    """A simple testcase"""
    @aetest.test
    def check_data(self):
        data = self.parent.parameters.get('my_data')
        if data == 'initialized_data':
            self.passed(f'Data matched: {data}')
        else:
            self.failed(f'Unexpected data: {data}')

class CommonCleanup(aetest.CommonCleanup):
    """Common Cleanup for all testcases"""
    @aetest.subsection
    def final_cleanup(self):
        self.passed('Common Cleanup completed')

if __name__ == '__main__':
    # To run this script:
    # 1. Save it as e.g., my_test.py
    # 2. Execute: python my_test.py
    # For advanced features like testbed parsing, use 'pyats run testbed my_test.py'
    aetest.main()