Easypy

Introduction

• Easypy provides a standardized runtime environment for testscript execution in pyATS

• It offers a simple, straight-forward way for users to aggregate testscripts together into jobs, integrates various pyATS modules together into a collectively managed ecosystem, and archives all resulting information for post-mortem debugging.

Installation

• Easypy module easypy is installed by default as part of pyATS installation. The package is also featured in the PyPI server, and can be installed separately.

• pip install pyats.easypy [--upgrade]

Jobfile and Tasks

• In pyATS, the aggregation of multiple testscripts together and executed within the same runtime environment is called a job which corresponds to a jobfile

• During runtime, these testscripts are launched as tasks and executed through a test harness (eg, aetest)

• Jobfiles are required to satisfy the following criterion:

  • each job file must have a main() function defined. This is the main entry point of a job file run.

  • the main() function accepts an argument called runtime. When defined, the engine automatically passes the current runtime object in.

  • inside the main() function, use easypy.run() or easypy.Task() to define and run individual testscripts as Tasks.

  • the name of the job file, minus the .py extension, becomes this job’s reporting name. This can be modified by setting runtime.job.name attribute.

• Example of jobfile:

import os

from pyats.easypy import run

# main() function must be defined in each job file
#   - it should have a runtime argument
#   - and contains one or more tasks
def main(runtime):

    # provide custom job name for reporting purposes (optional)
    runtime.job.name = 'my-job-overwrite-name'

    # using run() api to run a task
    #
    # syntax
    # ------
    #   run(testscript = <testscript path/file>,
    #       runtime = <runtime object>,
    #       max_runtime = None,
    #       taskid = None,
    #       **kwargs)
    #
    #   any additional arguments (**kwargs) to run() api are propagated
    #*  to AEtest as input arguments.
    run(testscript = 'script_one.py', runtime = runtime)

    # each job may contain one or more tasks.
    # tasks defined using run() api always run sequentially.
    run(testscript = 'script_two.py', runtime = runtime)

    # access runtime information, such as runtime directory
    # eg, save a new file into runtime directory
    with open(os.path.join(runtime.directory, 'my_file.txt')) as f:
        f.write('some content')

Reference

• Jobfile