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 Tue 2024-02-13 16:31:05 UTC, end at Tue 2024-02-13 16:31:09 UTC. --
Feb 13 16:31:05.443966 osdx systemd-journald[5515]: Runtime journal (/run/log/journal/80d0e0b412184be1883eb13133ae3f69) is 2.0M, max 16.0M, 14.0M free.
Feb 13 16:31:05.461668 osdx OSDxCLI[11705]: User 'admin' executed a new command: 'system journal clear'.
Feb 13 16:31:06.243207 osdx osdx-coredump[12193]: Deleting all coredumps in /opt/vyatta/etc/config/coredump...
Feb 13 16:31:06.254191 osdx OSDxCLI[11705]: User 'admin' executed a new command: 'system coredump delete all'.
Feb 13 16:31:07.429267 osdx OSDxCLI[11705]: User 'admin' entered the configuration menu.
Feb 13 16:31:07.574948 osdx OSDxCLI[11705]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Feb 13 16:31:07.701330 osdx OSDxCLI[11705]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'.
Feb 13 16:31:07.822156 osdx OSDxCLI[11705]: User 'admin' added a new cfg line: 'set system cli configuration logging global info'.
Feb 13 16:31:07.975989 osdx OSDxCLI[11705]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Feb 13 16:31:08.107987 osdx OSDxCLI[11705]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'.
Feb 13 16:31:08.288629 osdx OSDxCLI[11705]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''.
Feb 13 16:31:08.517530 osdx OSDxCLI[11705]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''.
Feb 13 16:31:08.698429 osdx modulelauncher[1093]: + Received data: ['11705', 'osdx.utils.xos', 'set_console_log_level', 'info']
Feb 13 16:31:08.713116 osdx OSDxCLI[11705]: Signal 10 received
Feb 13 16:31:08.803648 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0
Feb 13 16:31:08.878724 osdx cfgd[1320]: [11705]Completed change to active configuration
Feb 13 16:31:08.894790 osdx OSDxCLI[11705]: User 'admin' committed the configuration.
Feb 13 16:31:08.996477 osdx OSDxCLI[11705]: User 'admin' left the configuration menu.
Feb 13 16:31:09.322394 osdx OSDxCLI[11705]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Feb 13 16:31:09.323251 osdx OSDxCLI[11705]: pam_unix(cli:session): session closed for user admin
Feb 13 16:31:09.323559 osdx OSDxCLI[11705]: User 'admin' entered the configuration menu.
Feb 13 16:31:09.502406 osdx OSDxCLI[11705]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Feb 13 16:31:09.503022 osdx OSDxCLI[11705]: pam_unix(cli:session): session closed for user admin
Feb 13 16:31:09.503323 osdx OSDxCLI[11705]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'.
Feb 13 16:31:09.619936 osdx zebra[1256]: [RZ3YY-GPH41][EC 100663310] snmp[warning]: Warning: Failed to connect to the agentx master agent ([NIL]):
Feb 13 16:31:09.636120 osdx OSDxCLI[11705]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Feb 13 16:31:09.640014 osdx cfgd[1320]: [11705]must validation for [system login user admin role] was skipped
Feb 13 16:31:09.640165 osdx cfgd[1320]: Execute action [commit-subtree] for node [system advisor ADVISOR1]
Feb 13 16:31:09.655393 osdx cfgd[1320]: Execute action [end] for node [system advisor ADVISOR1]
Feb 13 16:31:09.665333 osdx cfgd[1320]: [11705]Completed change to active configuration
Feb 13 16:31:09.672559 osdx OSDxCLI[11705]: pam_unix(cli:session): session closed for user admin
Feb 13 16:31:09.672886 osdx OSDxCLI[11705]: User 'admin' committed the configuration.
Feb 13 16:31:09.676136 osdx INFO[12332]: SCRIPT SCRIPT_1 operations:
Feb 13 16:31:09.692926 osdx OSDxCLI[12337]: Tecla::GetLine tcgetattr error
Feb 13 16:31:09.693337 osdx OSDxCLI[12337]: User 'admin' has logged in.
Feb 13 16:31:09.709591 osdx OSDxCLI[12337]: User 'admin' executed a new command: 'interfaces ethernet show'.
Feb 13 16:31:09.712022 osdx OSDxCLI[12337]: User 'admin' has logged out.
Feb 13 16:31:09.712129 osdx OSDxCLI[12337]: Tecla::GetLine tcgetattr error
Feb 13 16:31:09.713148 osdx INFO[12332]: Operation 1 'interfaces ethernet show
                                         ':

                                         -----------------------------------------------
                                         Name  IP Address  Admin  Oper  Vrf  Description
                                         -----------------------------------------------
                                         eth0              down   down
                                         eth1              down   down
Feb 13 16:31:09.714398 osdx modulelauncher[12332]: 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
Feb 13 16:31:09.715453 osdx cfgd[1320]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1
Feb 13 16:31:09.715480 osdx cfgd[1320]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1
Feb 13 16:31:09.730439 osdx OSDxCLI[11705]: User 'admin' left the configuration menu.
Feb 13 16:31:09.927957 osdx OSDxCLI[11705]: 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 Tue 2024-02-13 16:31:05 UTC, end at Tue 2024-02-13 16:31:10 UTC. --
Feb 13 16:31:05.443966 osdx systemd-journald[5515]: Runtime journal (/run/log/journal/80d0e0b412184be1883eb13133ae3f69) is 2.0M, max 16.0M, 14.0M free.
Feb 13 16:31:05.461668 osdx OSDxCLI[11705]: User 'admin' executed a new command: 'system journal clear'.
Feb 13 16:31:06.243207 osdx osdx-coredump[12193]: Deleting all coredumps in /opt/vyatta/etc/config/coredump...
Feb 13 16:31:06.254191 osdx OSDxCLI[11705]: User 'admin' executed a new command: 'system coredump delete all'.
Feb 13 16:31:07.429267 osdx OSDxCLI[11705]: User 'admin' entered the configuration menu.
Feb 13 16:31:07.574948 osdx OSDxCLI[11705]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Feb 13 16:31:07.701330 osdx OSDxCLI[11705]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'.
Feb 13 16:31:07.822156 osdx OSDxCLI[11705]: User 'admin' added a new cfg line: 'set system cli configuration logging global info'.
Feb 13 16:31:07.975989 osdx OSDxCLI[11705]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Feb 13 16:31:08.107987 osdx OSDxCLI[11705]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'.
Feb 13 16:31:08.288629 osdx OSDxCLI[11705]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''.
Feb 13 16:31:08.517530 osdx OSDxCLI[11705]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''.
Feb 13 16:31:08.698429 osdx modulelauncher[1093]: + Received data: ['11705', 'osdx.utils.xos', 'set_console_log_level', 'info']
Feb 13 16:31:08.713116 osdx OSDxCLI[11705]: Signal 10 received
Feb 13 16:31:08.803648 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0
Feb 13 16:31:08.878724 osdx cfgd[1320]: [11705]Completed change to active configuration
Feb 13 16:31:08.894790 osdx OSDxCLI[11705]: User 'admin' committed the configuration.
Feb 13 16:31:08.996477 osdx OSDxCLI[11705]: User 'admin' left the configuration menu.
Feb 13 16:31:09.322394 osdx OSDxCLI[11705]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Feb 13 16:31:09.323251 osdx OSDxCLI[11705]: pam_unix(cli:session): session closed for user admin
Feb 13 16:31:09.323559 osdx OSDxCLI[11705]: User 'admin' entered the configuration menu.
Feb 13 16:31:09.502406 osdx OSDxCLI[11705]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Feb 13 16:31:09.503022 osdx OSDxCLI[11705]: pam_unix(cli:session): session closed for user admin
Feb 13 16:31:09.503323 osdx OSDxCLI[11705]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'.
Feb 13 16:31:09.619936 osdx zebra[1256]: [RZ3YY-GPH41][EC 100663310] snmp[warning]: Warning: Failed to connect to the agentx master agent ([NIL]):
Feb 13 16:31:09.636120 osdx OSDxCLI[11705]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Feb 13 16:31:09.640014 osdx cfgd[1320]: [11705]must validation for [system login user admin role] was skipped
Feb 13 16:31:09.640165 osdx cfgd[1320]: Execute action [commit-subtree] for node [system advisor ADVISOR1]
Feb 13 16:31:09.655393 osdx cfgd[1320]: Execute action [end] for node [system advisor ADVISOR1]
Feb 13 16:31:09.665333 osdx cfgd[1320]: [11705]Completed change to active configuration
Feb 13 16:31:09.672559 osdx OSDxCLI[11705]: pam_unix(cli:session): session closed for user admin
Feb 13 16:31:09.672886 osdx OSDxCLI[11705]: User 'admin' committed the configuration.
Feb 13 16:31:09.676136 osdx INFO[12332]: SCRIPT SCRIPT_1 operations:
Feb 13 16:31:09.692926 osdx OSDxCLI[12337]: Tecla::GetLine tcgetattr error
Feb 13 16:31:09.693337 osdx OSDxCLI[12337]: User 'admin' has logged in.
Feb 13 16:31:09.709591 osdx OSDxCLI[12337]: User 'admin' executed a new command: 'interfaces ethernet show'.
Feb 13 16:31:09.712022 osdx OSDxCLI[12337]: User 'admin' has logged out.
Feb 13 16:31:09.712129 osdx OSDxCLI[12337]: Tecla::GetLine tcgetattr error
Feb 13 16:31:09.713148 osdx INFO[12332]: Operation 1 'interfaces ethernet show
                                         ':

                                         -----------------------------------------------
                                         Name  IP Address  Admin  Oper  Vrf  Description
                                         -----------------------------------------------
                                         eth0              down   down
                                         eth1              down   down
Feb 13 16:31:09.714398 osdx modulelauncher[12332]: 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
Feb 13 16:31:09.715453 osdx cfgd[1320]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1
Feb 13 16:31:09.715480 osdx cfgd[1320]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1
Feb 13 16:31:09.730439 osdx OSDxCLI[11705]: User 'admin' left the configuration menu.
Feb 13 16:31:09.927957 osdx OSDxCLI[11705]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Feb 13 16:31:09.983879 osdx OSDxCLI[11705]: pam_unix(cli:session): session closed for user admin
Feb 13 16:31:09.984155 osdx OSDxCLI[11705]: User 'admin' executed a new command: 'system journal show | cat'.
Feb 13 16:31:10.154259 osdx OSDxCLI[11705]: 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'