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-04-09 08:11:04 UTC, end at Tue 2024-04-09 08:11:07 UTC. --
Apr 09 08:11:04.363925 osdx systemd-journald[1044]: Runtime journal (/run/log/journal/2dc26f94a9f34e56b62b3c0d209c4be0) is 2.0M, max 16.0M, 14.0M free.
Apr 09 08:11:04.394356 osdx OSDxCLI[854]: User 'admin' executed a new command: 'system journal clear'.
Apr 09 08:11:05.020434 osdx osdx-coredump[1365]: Deleting all coredumps in /opt/vyatta/etc/config/coredump...
Apr 09 08:11:05.028880 osdx OSDxCLI[854]: User 'admin' executed a new command: 'system coredump delete all'.
Apr 09 08:11:06.017448 osdx OSDxCLI[854]: User 'admin' entered the configuration menu.
Apr 09 08:11:06.168692 osdx OSDxCLI[854]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Apr 09 08:11:06.273083 osdx OSDxCLI[854]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'.
Apr 09 08:11:06.373958 osdx OSDxCLI[854]: User 'admin' added a new cfg line: 'set system cli configuration logging global info'.
Apr 09 08:11:06.467581 osdx OSDxCLI[854]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Apr 09 08:11:06.574724 osdx OSDxCLI[854]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'.
Apr 09 08:11:06.675582 osdx OSDxCLI[854]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''.
Apr 09 08:11:06.781295 osdx OSDxCLI[854]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''.
Apr 09 08:11:06.896092 osdx modulelauncher[973]: + Received data: ['854', 'osdx.utils.xos', 'set_console_log_level', 'info']
Apr 09 08:11:06.909804 osdx OSDxCLI[854]: Signal 10 received
Apr 09 08:11:06.918806 osdx ifmon[981]: Changed log-level to info
Apr 09 08:11:06.955396 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0
Apr 09 08:11:06.985529 osdx cfgd[1120]: [854]Completed change to active configuration
Apr 09 08:11:06.988541 osdx OSDxCLI[854]: User 'admin' committed the configuration.
Apr 09 08:11:07.023613 osdx OSDxCLI[854]: User 'admin' left the configuration menu.
Apr 09 08:11:07.234299 osdx OSDxCLI[854]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Apr 09 08:11:07.235171 osdx OSDxCLI[854]: pam_unix(cli:session): session closed for user admin
Apr 09 08:11:07.235784 osdx OSDxCLI[854]: User 'admin' entered the configuration menu.
Apr 09 08:11:07.337164 osdx OSDxCLI[854]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Apr 09 08:11:07.337599 osdx cfgd[1120]: Execute action [syntax] for node [(null)]
Apr 09 08:11:07.337699 osdx cfgd[1120]: Execute action [syntax] for node [(null)]
Apr 09 08:11:07.338066 osdx OSDxCLI[854]: pam_unix(cli:session): session closed for user admin
Apr 09 08:11:07.338378 osdx OSDxCLI[854]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'.
Apr 09 08:11:07.448526 osdx OSDxCLI[854]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Apr 09 08:11:07.459230 osdx cfgd[1120]: [854]must validation for [system login user admin role] was skipped
Apr 09 08:11:07.459248 osdx cfgd[1120]: Execute action [commit-subtree] for node [system advisor ADVISOR1]
Apr 09 08:11:07.468115 osdx cfgd[1120]: Execute action [end] for node [system advisor ADVISOR1]
Apr 09 08:11:07.474752 osdx cfgd[1120]: [854]Completed change to active configuration
Apr 09 08:11:07.478672 osdx OSDxCLI[854]: pam_unix(cli:session): session closed for user admin
Apr 09 08:11:07.478933 osdx OSDxCLI[854]: User 'admin' committed the configuration.
Apr 09 08:11:07.482769 osdx INFO[1487]: SCRIPT SCRIPT_1 operations:
Apr 09 08:11:07.490922 osdx OSDxCLI[1495]: Tecla::GetLine tcgetattr error
Apr 09 08:11:07.490934 osdx OSDxCLI[1495]: User 'admin' has logged in.
Apr 09 08:11:07.501660 osdx OSDxCLI[1495]: User 'admin' executed a new command: 'interfaces ethernet show'.
Apr 09 08:11:07.503181 osdx OSDxCLI[1495]: User 'admin' has logged out.
Apr 09 08:11:07.503190 osdx OSDxCLI[1495]: Tecla::GetLine tcgetattr error
Apr 09 08:11:07.503986 osdx INFO[1487]: Operation 1 'interfaces ethernet show
                                        ':

                                        -----------------------------------------------
                                        Name  IP Address  Admin  Oper  Vrf  Description
                                        -----------------------------------------------
                                        eth0              down   down
                                        eth1              down   down
Apr 09 08:11:07.505585 osdx modulelauncher[1487]: 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
Apr 09 08:11:07.506223 osdx cfgd[1120]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1
Apr 09 08:11:07.506250 osdx cfgd[1120]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1
Apr 09 08:11:07.519796 osdx OSDxCLI[854]: User 'admin' left the configuration menu.
Apr 09 08:11:07.692945 osdx OSDxCLI[854]: 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-04-09 08:11:04 UTC, end at Tue 2024-04-09 08:11:07 UTC. --
Apr 09 08:11:04.363925 osdx systemd-journald[1044]: Runtime journal (/run/log/journal/2dc26f94a9f34e56b62b3c0d209c4be0) is 2.0M, max 16.0M, 14.0M free.
Apr 09 08:11:04.394356 osdx OSDxCLI[854]: User 'admin' executed a new command: 'system journal clear'.
Apr 09 08:11:05.020434 osdx osdx-coredump[1365]: Deleting all coredumps in /opt/vyatta/etc/config/coredump...
Apr 09 08:11:05.028880 osdx OSDxCLI[854]: User 'admin' executed a new command: 'system coredump delete all'.
Apr 09 08:11:06.017448 osdx OSDxCLI[854]: User 'admin' entered the configuration menu.
Apr 09 08:11:06.168692 osdx OSDxCLI[854]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Apr 09 08:11:06.273083 osdx OSDxCLI[854]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'.
Apr 09 08:11:06.373958 osdx OSDxCLI[854]: User 'admin' added a new cfg line: 'set system cli configuration logging global info'.
Apr 09 08:11:06.467581 osdx OSDxCLI[854]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Apr 09 08:11:06.574724 osdx OSDxCLI[854]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'.
Apr 09 08:11:06.675582 osdx OSDxCLI[854]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''.
Apr 09 08:11:06.781295 osdx OSDxCLI[854]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''.
Apr 09 08:11:06.896092 osdx modulelauncher[973]: + Received data: ['854', 'osdx.utils.xos', 'set_console_log_level', 'info']
Apr 09 08:11:06.909804 osdx OSDxCLI[854]: Signal 10 received
Apr 09 08:11:06.918806 osdx ifmon[981]: Changed log-level to info
Apr 09 08:11:06.955396 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0
Apr 09 08:11:06.985529 osdx cfgd[1120]: [854]Completed change to active configuration
Apr 09 08:11:06.988541 osdx OSDxCLI[854]: User 'admin' committed the configuration.
Apr 09 08:11:07.023613 osdx OSDxCLI[854]: User 'admin' left the configuration menu.
Apr 09 08:11:07.234299 osdx OSDxCLI[854]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Apr 09 08:11:07.235171 osdx OSDxCLI[854]: pam_unix(cli:session): session closed for user admin
Apr 09 08:11:07.235784 osdx OSDxCLI[854]: User 'admin' entered the configuration menu.
Apr 09 08:11:07.337164 osdx OSDxCLI[854]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Apr 09 08:11:07.337599 osdx cfgd[1120]: Execute action [syntax] for node [(null)]
Apr 09 08:11:07.337699 osdx cfgd[1120]: Execute action [syntax] for node [(null)]
Apr 09 08:11:07.338066 osdx OSDxCLI[854]: pam_unix(cli:session): session closed for user admin
Apr 09 08:11:07.338378 osdx OSDxCLI[854]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'.
Apr 09 08:11:07.448526 osdx OSDxCLI[854]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Apr 09 08:11:07.459230 osdx cfgd[1120]: [854]must validation for [system login user admin role] was skipped
Apr 09 08:11:07.459248 osdx cfgd[1120]: Execute action [commit-subtree] for node [system advisor ADVISOR1]
Apr 09 08:11:07.468115 osdx cfgd[1120]: Execute action [end] for node [system advisor ADVISOR1]
Apr 09 08:11:07.474752 osdx cfgd[1120]: [854]Completed change to active configuration
Apr 09 08:11:07.478672 osdx OSDxCLI[854]: pam_unix(cli:session): session closed for user admin
Apr 09 08:11:07.478933 osdx OSDxCLI[854]: User 'admin' committed the configuration.
Apr 09 08:11:07.482769 osdx INFO[1487]: SCRIPT SCRIPT_1 operations:
Apr 09 08:11:07.490922 osdx OSDxCLI[1495]: Tecla::GetLine tcgetattr error
Apr 09 08:11:07.490934 osdx OSDxCLI[1495]: User 'admin' has logged in.
Apr 09 08:11:07.501660 osdx OSDxCLI[1495]: User 'admin' executed a new command: 'interfaces ethernet show'.
Apr 09 08:11:07.503181 osdx OSDxCLI[1495]: User 'admin' has logged out.
Apr 09 08:11:07.503190 osdx OSDxCLI[1495]: Tecla::GetLine tcgetattr error
Apr 09 08:11:07.503986 osdx INFO[1487]: Operation 1 'interfaces ethernet show
                                        ':

                                        -----------------------------------------------
                                        Name  IP Address  Admin  Oper  Vrf  Description
                                        -----------------------------------------------
                                        eth0              down   down
                                        eth1              down   down
Apr 09 08:11:07.505585 osdx modulelauncher[1487]: 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
Apr 09 08:11:07.506223 osdx cfgd[1120]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1
Apr 09 08:11:07.506250 osdx cfgd[1120]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1
Apr 09 08:11:07.519796 osdx OSDxCLI[854]: User 'admin' left the configuration menu.
Apr 09 08:11:07.692945 osdx OSDxCLI[854]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Apr 09 08:11:07.746634 osdx OSDxCLI[854]: pam_unix(cli:session): session closed for user admin
Apr 09 08:11:07.746977 osdx OSDxCLI[854]: User 'admin' executed a new command: 'system journal show | cat'.
Apr 09 08:11:07.887068 osdx OSDxCLI[854]: 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'