Script

Test to check advisor scripts

Configuration Script

Description

In this scenario, an advisor is triggered to activate the automatic script. When the advisor is changed to true, the automatic script associated with the advisor is executed, aplying the commands in the active configuration.

Scenario

Step 1: Set the following configuration in DUT0:

set system script SCRIPT_1 advisor ADVISOR1
set system advisor ADVISOR1 test false
set system cli configuration logging global info
set system script SCRIPT_1 configuration 'set system description \'advisor applied\''

Step 2: Set the following configuration in DUT0:

set system advisor ADVISOR1 test true

Step 3: Run command show running at DUT0 and check if output contains the following tokens:

set system description 'advisor applied'

Operational Script

Description

In this scenario, an advisor is triggered to activate the automatic script. When the advisor is changed to true, the automatic script associated with the advisor is executed, proccessing the operational commands in the specified order.

Scenario

Step 1: Set the following configuration in DUT0:

set system script SCRIPT_1 advisor ADVISOR1
set system advisor ADVISOR1 test false
set system cli configuration logging global info
set system script SCRIPT_1 advisor ADVISOR1
set interfaces ethernet eth0 address 10.215.200.50/24
set system script SCRIPT_1 operational 1 command 'interfaces ethernet show'
set system script SCRIPT_1 operational 2 command 'license show'

Step 2: Set the following configuration in DUT0:

set system advisor ADVISOR1 test true

Step 3: Run command system journal show | cat at DUT0 and check if output contains the following tokens:

interfaces ethernet show

Show output

-- Logs begin at Thu 2024-06-13 00:16:28 UTC, end at Thu 2024-06-13 00:16:32 UTC. --
Jun 13 00:16:28.514270 osdx systemd-journald[17428]: Runtime journal (/run/log/journal/f8d19df27e8d4f24a0b0e24ed9aec425) is 4.0M, max 16.0M, 11.9M free.
Jun 13 00:16:28.543002 osdx OSDxCLI[17211]: User 'admin' executed a new command: 'system journal clear'.
Jun 13 00:16:29.190213 osdx osdx-coredump[17726]: Deleting all coredumps in /opt/vyatta/etc/config/coredump...
Jun 13 00:16:29.198375 osdx OSDxCLI[17211]: User 'admin' executed a new command: 'system coredump delete all'.
Jun 13 00:16:30.097364 osdx OSDxCLI[17211]: User 'admin' entered the configuration menu.
Jun 13 00:16:30.122048 osdx zebra[1075]: [RZ3YY-GPH41][EC 100663310] snmp[warning]: Warning: Failed to connect to the agentx master agent ([NIL]):
Jun 13 00:16:30.260122 osdx OSDxCLI[17211]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Jun 13 00:16:30.384390 osdx OSDxCLI[17211]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'.
Jun 13 00:16:30.510715 osdx OSDxCLI[17211]: User 'admin' added a new cfg line: 'set system cli configuration logging global info'.
Jun 13 00:16:30.639952 osdx OSDxCLI[17211]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Jun 13 00:16:30.794208 osdx OSDxCLI[17211]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'.
Jun 13 00:16:30.957297 osdx OSDxCLI[17211]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''.
Jun 13 00:16:31.119829 osdx OSDxCLI[17211]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''.
Jun 13 00:16:31.295624 osdx modulelauncher[975]: + Received data: ['17211', 'osdx.utils.xos', 'set_console_log_level', 'info']
Jun 13 00:16:31.309256 osdx OSDxCLI[17211]: Signal 10 received
Jun 13 00:16:31.319705 osdx ifmon[980]: Changed log-level to info
Jun 13 00:16:31.365840 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0
Jun 13 00:16:31.397926 osdx cfgd[1122]: [17211]Completed change to active configuration
Jun 13 00:16:31.401511 osdx OSDxCLI[17211]: User 'admin' committed the configuration.
Jun 13 00:16:31.440226 osdx OSDxCLI[17211]: User 'admin' left the configuration menu.
Jun 13 00:16:31.700898 osdx OSDxCLI[17211]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Jun 13 00:16:31.701617 osdx OSDxCLI[17211]: pam_unix(cli:session): session closed for user admin
Jun 13 00:16:31.702124 osdx OSDxCLI[17211]: User 'admin' entered the configuration menu.
Jun 13 00:16:31.851625 osdx OSDxCLI[17211]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Jun 13 00:16:31.852039 osdx cfgd[1122]: Execute action [syntax] for node [(null)]
Jun 13 00:16:31.852132 osdx cfgd[1122]: Execute action [syntax] for node [(null)]
Jun 13 00:16:31.852517 osdx OSDxCLI[17211]: pam_unix(cli:session): session closed for user admin
Jun 13 00:16:31.852947 osdx OSDxCLI[17211]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'.
Jun 13 00:16:31.959713 osdx OSDxCLI[17211]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Jun 13 00:16:31.971285 osdx cfgd[1122]: [17211]must validation for [system login user admin role] was skipped
Jun 13 00:16:31.971303 osdx cfgd[1122]: Execute action [commit-subtree] for node [system advisor ADVISOR1]
Jun 13 00:16:31.985054 osdx cfgd[1122]: Execute action [end] for node [system advisor ADVISOR1]
Jun 13 00:16:31.992801 osdx cfgd[1122]: [17211]Completed change to active configuration
Jun 13 00:16:32.001497 osdx OSDxCLI[17211]: pam_unix(cli:session): session closed for user admin
Jun 13 00:16:32.001862 osdx OSDxCLI[17211]: User 'admin' committed the configuration.
Jun 13 00:16:32.007799 osdx INFO[17847]: SCRIPT SCRIPT_1 operations:
Jun 13 00:16:32.018466 osdx OSDxCLI[17856]: Tecla::GetLine tcgetattr error
Jun 13 00:16:32.018478 osdx OSDxCLI[17856]: User 'admin' has logged in.
Jun 13 00:16:32.037772 osdx OSDxCLI[17856]: User 'admin' executed a new command: 'interfaces ethernet show'.
Jun 13 00:16:32.040083 osdx OSDxCLI[17856]: User 'admin' has logged out.
Jun 13 00:16:32.040092 osdx OSDxCLI[17856]: Tecla::GetLine tcgetattr error
Jun 13 00:16:32.041146 osdx INFO[17847]: Operation 1 'interfaces ethernet show
                                         ':

                                         -----------------------------------------------
                                         Name  IP Address  Admin  Oper  Vrf  Description
                                         -----------------------------------------------
                                         eth0              down   down
                                         eth1              down   down
Jun 13 00:16:32.043494 osdx modulelauncher[17847]: Traceback (most recent call last):
                                                     File "/osdx/sbin/modulelauncher.py", line 37, in run_file
                                                       result = getattr(module, args[0])(args, cfg_ses_id)
                                                     File "osdx/sbin/cfg/auto_scripts.py", line 62, in process
                                                     File "osdx/sbin/cfg/auto_scripts.py", line 107, in _execute_script
                                                     File "usr/lib/python2.7/subprocess.py", line 483, in communicate
                                                     File "usr/lib/python2.7/subprocess.py", line 1119, in _communicate
                                                   ValueError: I/O operation on closed file
Jun 13 00:16:32.060323 osdx cfgd[1122]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1
Jun 13 00:16:32.060381 osdx cfgd[1122]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1
Jun 13 00:16:32.063798 osdx OSDxCLI[17211]: User 'admin' left the configuration menu.
Jun 13 00:16:32.244171 osdx OSDxCLI[17211]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)

Step 4: Run command system journal show | cat at DUT0 and check if output contains the following tokens:

license show

Show output

-- Logs begin at Thu 2024-06-13 00:16:28 UTC, end at Thu 2024-06-13 00:16:32 UTC. --
Jun 13 00:16:28.514270 osdx systemd-journald[17428]: Runtime journal (/run/log/journal/f8d19df27e8d4f24a0b0e24ed9aec425) is 4.0M, max 16.0M, 11.9M free.
Jun 13 00:16:28.543002 osdx OSDxCLI[17211]: User 'admin' executed a new command: 'system journal clear'.
Jun 13 00:16:29.190213 osdx osdx-coredump[17726]: Deleting all coredumps in /opt/vyatta/etc/config/coredump...
Jun 13 00:16:29.198375 osdx OSDxCLI[17211]: User 'admin' executed a new command: 'system coredump delete all'.
Jun 13 00:16:30.097364 osdx OSDxCLI[17211]: User 'admin' entered the configuration menu.
Jun 13 00:16:30.122048 osdx zebra[1075]: [RZ3YY-GPH41][EC 100663310] snmp[warning]: Warning: Failed to connect to the agentx master agent ([NIL]):
Jun 13 00:16:30.260122 osdx OSDxCLI[17211]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Jun 13 00:16:30.384390 osdx OSDxCLI[17211]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'.
Jun 13 00:16:30.510715 osdx OSDxCLI[17211]: User 'admin' added a new cfg line: 'set system cli configuration logging global info'.
Jun 13 00:16:30.639952 osdx OSDxCLI[17211]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Jun 13 00:16:30.794208 osdx OSDxCLI[17211]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'.
Jun 13 00:16:30.957297 osdx OSDxCLI[17211]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''.
Jun 13 00:16:31.119829 osdx OSDxCLI[17211]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''.
Jun 13 00:16:31.295624 osdx modulelauncher[975]: + Received data: ['17211', 'osdx.utils.xos', 'set_console_log_level', 'info']
Jun 13 00:16:31.309256 osdx OSDxCLI[17211]: Signal 10 received
Jun 13 00:16:31.319705 osdx ifmon[980]: Changed log-level to info
Jun 13 00:16:31.365840 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0
Jun 13 00:16:31.397926 osdx cfgd[1122]: [17211]Completed change to active configuration
Jun 13 00:16:31.401511 osdx OSDxCLI[17211]: User 'admin' committed the configuration.
Jun 13 00:16:31.440226 osdx OSDxCLI[17211]: User 'admin' left the configuration menu.
Jun 13 00:16:31.700898 osdx OSDxCLI[17211]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Jun 13 00:16:31.701617 osdx OSDxCLI[17211]: pam_unix(cli:session): session closed for user admin
Jun 13 00:16:31.702124 osdx OSDxCLI[17211]: User 'admin' entered the configuration menu.
Jun 13 00:16:31.851625 osdx OSDxCLI[17211]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Jun 13 00:16:31.852039 osdx cfgd[1122]: Execute action [syntax] for node [(null)]
Jun 13 00:16:31.852132 osdx cfgd[1122]: Execute action [syntax] for node [(null)]
Jun 13 00:16:31.852517 osdx OSDxCLI[17211]: pam_unix(cli:session): session closed for user admin
Jun 13 00:16:31.852947 osdx OSDxCLI[17211]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'.
Jun 13 00:16:31.959713 osdx OSDxCLI[17211]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Jun 13 00:16:31.971285 osdx cfgd[1122]: [17211]must validation for [system login user admin role] was skipped
Jun 13 00:16:31.971303 osdx cfgd[1122]: Execute action [commit-subtree] for node [system advisor ADVISOR1]
Jun 13 00:16:31.985054 osdx cfgd[1122]: Execute action [end] for node [system advisor ADVISOR1]
Jun 13 00:16:31.992801 osdx cfgd[1122]: [17211]Completed change to active configuration
Jun 13 00:16:32.001497 osdx OSDxCLI[17211]: pam_unix(cli:session): session closed for user admin
Jun 13 00:16:32.001862 osdx OSDxCLI[17211]: User 'admin' committed the configuration.
Jun 13 00:16:32.007799 osdx INFO[17847]: SCRIPT SCRIPT_1 operations:
Jun 13 00:16:32.018466 osdx OSDxCLI[17856]: Tecla::GetLine tcgetattr error
Jun 13 00:16:32.018478 osdx OSDxCLI[17856]: User 'admin' has logged in.
Jun 13 00:16:32.037772 osdx OSDxCLI[17856]: User 'admin' executed a new command: 'interfaces ethernet show'.
Jun 13 00:16:32.040083 osdx OSDxCLI[17856]: User 'admin' has logged out.
Jun 13 00:16:32.040092 osdx OSDxCLI[17856]: Tecla::GetLine tcgetattr error
Jun 13 00:16:32.041146 osdx INFO[17847]: Operation 1 'interfaces ethernet show
                                         ':

                                         -----------------------------------------------
                                         Name  IP Address  Admin  Oper  Vrf  Description
                                         -----------------------------------------------
                                         eth0              down   down
                                         eth1              down   down
Jun 13 00:16:32.043494 osdx modulelauncher[17847]: Traceback (most recent call last):
                                                     File "/osdx/sbin/modulelauncher.py", line 37, in run_file
                                                       result = getattr(module, args[0])(args, cfg_ses_id)
                                                     File "osdx/sbin/cfg/auto_scripts.py", line 62, in process
                                                     File "osdx/sbin/cfg/auto_scripts.py", line 107, in _execute_script
                                                     File "usr/lib/python2.7/subprocess.py", line 483, in communicate
                                                     File "usr/lib/python2.7/subprocess.py", line 1119, in _communicate
                                                   ValueError: I/O operation on closed file
Jun 13 00:16:32.060323 osdx cfgd[1122]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1
Jun 13 00:16:32.060381 osdx cfgd[1122]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1
Jun 13 00:16:32.063798 osdx OSDxCLI[17211]: User 'admin' left the configuration menu.
Jun 13 00:16:32.244171 osdx OSDxCLI[17211]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Jun 13 00:16:32.292494 osdx OSDxCLI[17211]: pam_unix(cli:session): session closed for user admin
Jun 13 00:16:32.292839 osdx OSDxCLI[17211]: User 'admin' executed a new command: 'system journal show | cat'.
Jun 13 00:16:32.534967 osdx OSDxCLI[17211]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)

Simple Script Execution

Description

In this scenario, an automatic script is activated directly without any advisor triggering. The script is activated using the system script <txt> activate command.

Scenario

Step 1: Set the following configuration in DUT0:

set system script SCRIPT_1 advisor ADVISOR1
set system advisor ADVISOR1 test false
set system cli configuration logging global info
set system script SCRIPT_1 advisor ADVISOR1
set system advisor ADVISOR1 test false
set system script SCRIPT_1 configuration 'set interfaces dummy dum0'
set system script SCRIPT_1 configuration 'set interfaces dummy dum1'

Step 2: Run command system script SCRIPT_1 activate at DUT0.

Step 3: Run command interfaces dummy show at DUT0 and check if output matches the following regular expressions:

dum0.*\ndum1

Multiple Triggers Script

Description

In this scenario, an advisor is triggered multiple times to activate the automatic script. When the advisor is changed to true, the automatic script associated with the advisor is executed, proccessing the operational commands in the specified order.

Scenario

Step 1: Set the following configuration in DUT0:

set system script SCRIPT_1 advisor ADVISOR1
set system advisor ADVISOR1 test false
set system cli configuration logging global info
set system script SCRIPT_1 configuration 'set system description \'advisor applied\''
set system script SCRIPT_1 number-of-triggers 3

Note

Wait for the advisor to turn on. After that, wait for the advisor to turn off. This produces only one trigger.

Step 2: Set the following configuration in DUT0:

set system advisor ADVISOR1 test true

Step 3: Set the following configuration in DUT0:

set system advisor ADVISOR1 test false

Step 4: Expect a failure in the following command: Run command show running at DUT0 and check if output contains the following tokens:

set system description 'advisor applied'

Note

Wait for the advisor to turn on. After that, wait for the advisor to turn off. This produces only one trigger.

Step 5: Set the following configuration in DUT0:

set system advisor ADVISOR1 test true

Step 6: Set the following configuration in DUT0:

set system advisor ADVISOR1 test false

Step 7: Expect a failure in the following command: Run command show running at DUT0 and check if output contains the following tokens:

set system description 'advisor applied'

Note

Wait for the advisor to turn on. After that, wait for the advisor to turn off. This produces only one trigger.

Step 8: Set the following configuration in DUT0:

set system advisor ADVISOR1 test true

Step 9: Set the following configuration in DUT0:

set system advisor ADVISOR1 test false

Step 10: Run command show running at DUT0 and check if output contains the following tokens:

set system description 'advisor applied'