Creating a custom action

The structure needed to create a custom action in Blitz is pretty straight forward. A new module (e.g. customBlitz.py) with a new class should be created. Within the said class, Blitz class should be inherited and the action can be developed. The content of that action can be anything that helps users with their testing. Look at example below

import logging
from pyats import aetest
from genie.libs.sdk.triggers.blitz.blitz import Blitz


log = logging.getLogger()

class CustomBlitz(Blitz):  # <- inheriting Blitz
  def my_custom_action(self, steps, device, section, **kwargs):
    log.info("This is my custom action")

Later on the custom action can be called within the trigger datafile, with the same name as the function name.

TestCustomAction:
    source:
      pkg: CustomBlitz
      class: <path_to_custom_blitz_class>
    devices: ['uut']
    test_sections:
      - section_name:
        - my_custom_action:
          device: PE1
          key1: val1
          key2: val2

Note

Some arguments of built-in actions can be shared with custom actions. Those arguments might not be as useful or usable to the custom action and hence might cause issues with the customized code. As a result it is highly recommended that **kwargs be defined to prevent these possible issues.

Creating a custom section

The behavior of a Blitz section also can be customized. Just like custom actions, to create a customized section, a class that inherits Blitz class should be created. A function that represent the custom section should be created within said class and be decorated with @aetest.test. Instead of actions, anything defined underneath the custom section in the Blitz YAML will be passed to the data argument of the custom section function. Look at the below example.

import logging
from pyats import aetest
from genie.libs.sdk.triggers.blitz.blitz import Blitz


log = logging.getLogger()

class CustomBlitz(Blitz):  # <- inheriting Blitz
  @aetest.test
  def my_custom_section(self, steps, testbed, data):
    # data == {'key1': 'val1', 'key2': 'val2'}
    log.info("This is my custom section")

TestCustomAction:
    source:
      pkg: CustomBlitz
      class: <path_to_custom_blitz_class>
    devices: ['uut']
    test_sections:
      - my_custom_section:
        key1: val1
        key2: val2