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 Wed 2024-10-09 07:08:39 UTC, end at Wed 2024-10-09 07:08:41 UTC. --
Oct 09 07:08:39.273456 osdx systemd-journald[1707]: Runtime journal (/run/log/journal/7b13f98cf6974d34b6af66a5ac8a2ed7) is 2.0M, max 16.0M, 14.0M free.
Oct 09 07:08:39.296348 osdx OSDxCLI[1913]: User 'admin' executed a new command: 'system journal clear'.
Oct 09 07:08:39.649285 osdx osdx-coredump[27117]: Deleting all coredumps in /opt/vyatta/etc/config/coredump...
Oct 09 07:08:39.655199 osdx OSDxCLI[1913]: User 'admin' executed a new command: 'system coredump delete all'.
Oct 09 07:08:40.234564 osdx OSDxCLI[1913]: User 'admin' entered the configuration menu.
Oct 09 07:08:40.298351 osdx OSDxCLI[1913]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Oct 09 07:08:40.387583 osdx OSDxCLI[1913]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'.
Oct 09 07:08:40.440419 osdx OSDxCLI[1913]: User 'admin' added a new cfg line: 'set system cli configuration logging global info'.
Oct 09 07:08:40.533136 osdx OSDxCLI[1913]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Oct 09 07:08:40.589958 osdx OSDxCLI[1913]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'.
Oct 09 07:08:40.688770 osdx OSDxCLI[1913]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''.
Oct 09 07:08:40.746914 osdx OSDxCLI[1913]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''.
Oct 09 07:08:40.854147 osdx modulelauncher[1181]: + Received data: ['1913', 'osdx.utils.xos', 'set_console_log_level', 'info']
Oct 09 07:08:40.863457 osdx OSDxCLI[1913]: Signal 10 received
Oct 09 07:08:40.870291 osdx ifmon[1187]: Changed log-level to info
Oct 09 07:08:40.899425 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0
Oct 09 07:08:40.942498 osdx cfgd[1327]: [1913]Completed change to active configuration
Oct 09 07:08:40.944986 osdx OSDxCLI[1913]: User 'admin' committed the configuration.
Oct 09 07:08:40.961360 osdx OSDxCLI[1913]: User 'admin' left the configuration menu.
Oct 09 07:08:41.150329 osdx OSDxCLI[1913]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Oct 09 07:08:41.150903 osdx OSDxCLI[1913]: pam_unix(cli:session): session closed for user admin
Oct 09 07:08:41.151173 osdx OSDxCLI[1913]: User 'admin' entered the configuration menu.
Oct 09 07:08:41.219434 osdx OSDxCLI[1913]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Oct 09 07:08:41.219736 osdx cfgd[1327]: Execute action [syntax] for node [(null)]
Oct 09 07:08:41.219820 osdx cfgd[1327]: Execute action [syntax] for node [(null)]
Oct 09 07:08:41.220174 osdx OSDxCLI[1913]: pam_unix(cli:session): session closed for user admin
Oct 09 07:08:41.220453 osdx OSDxCLI[1913]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'.
Oct 09 07:08:41.321533 osdx OSDxCLI[1913]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Oct 09 07:08:41.328258 osdx cfgd[1327]: [1913]must validation for [system login user admin role] was skipped
Oct 09 07:08:41.328269 osdx cfgd[1327]: Execute action [commit-subtree] for node [system advisor ADVISOR1]
Oct 09 07:08:41.334969 osdx cfgd[1327]: Execute action [end] for node [system advisor ADVISOR1]
Oct 09 07:08:41.339686 osdx cfgd[1327]: [1913]Completed change to active configuration
Oct 09 07:08:41.342092 osdx OSDxCLI[1913]: pam_unix(cli:session): session closed for user admin
Oct 09 07:08:41.342331 osdx OSDxCLI[1913]: User 'admin' committed the configuration.
Oct 09 07:08:41.344697 osdx INFO[27264]: SCRIPT SCRIPT_1 operations:
Oct 09 07:08:41.350308 osdx OSDxCLI[27272]: Tecla::GetLine tcgetattr error
Oct 09 07:08:41.350315 osdx OSDxCLI[27272]: User 'admin' has logged in.
Oct 09 07:08:41.359352 osdx OSDxCLI[27272]: User 'admin' executed a new command: 'interfaces ethernet show'.
Oct 09 07:08:41.360592 osdx OSDxCLI[27272]: User 'admin' has logged out.
Oct 09 07:08:41.360664 osdx OSDxCLI[27272]: Tecla::GetLine tcgetattr error
Oct 09 07:08:41.361258 osdx INFO[27264]: Operation 1 'interfaces ethernet show
                                         ':

                                         -----------------------------------------------
                                         Name  IP Address  Admin  Oper  Vrf  Description
                                         -----------------------------------------------
                                         eth0              down   down
                                         eth1              down   down
Oct 09 07:08:41.362172 osdx modulelauncher[27264]: 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
Oct 09 07:08:41.362494 osdx cfgd[1327]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1
Oct 09 07:08:41.362512 osdx cfgd[1327]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1
Oct 09 07:08:41.362624 osdx OSDxCLI[1913]: User 'admin' left the configuration menu.
Oct 09 07:08:41.481727 osdx OSDxCLI[1913]: 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 Wed 2024-10-09 07:08:39 UTC, end at Wed 2024-10-09 07:08:41 UTC. --
Oct 09 07:08:39.273456 osdx systemd-journald[1707]: Runtime journal (/run/log/journal/7b13f98cf6974d34b6af66a5ac8a2ed7) is 2.0M, max 16.0M, 14.0M free.
Oct 09 07:08:39.296348 osdx OSDxCLI[1913]: User 'admin' executed a new command: 'system journal clear'.
Oct 09 07:08:39.649285 osdx osdx-coredump[27117]: Deleting all coredumps in /opt/vyatta/etc/config/coredump...
Oct 09 07:08:39.655199 osdx OSDxCLI[1913]: User 'admin' executed a new command: 'system coredump delete all'.
Oct 09 07:08:40.234564 osdx OSDxCLI[1913]: User 'admin' entered the configuration menu.
Oct 09 07:08:40.298351 osdx OSDxCLI[1913]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Oct 09 07:08:40.387583 osdx OSDxCLI[1913]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'.
Oct 09 07:08:40.440419 osdx OSDxCLI[1913]: User 'admin' added a new cfg line: 'set system cli configuration logging global info'.
Oct 09 07:08:40.533136 osdx OSDxCLI[1913]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Oct 09 07:08:40.589958 osdx OSDxCLI[1913]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'.
Oct 09 07:08:40.688770 osdx OSDxCLI[1913]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''.
Oct 09 07:08:40.746914 osdx OSDxCLI[1913]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''.
Oct 09 07:08:40.854147 osdx modulelauncher[1181]: + Received data: ['1913', 'osdx.utils.xos', 'set_console_log_level', 'info']
Oct 09 07:08:40.863457 osdx OSDxCLI[1913]: Signal 10 received
Oct 09 07:08:40.870291 osdx ifmon[1187]: Changed log-level to info
Oct 09 07:08:40.899425 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0
Oct 09 07:08:40.942498 osdx cfgd[1327]: [1913]Completed change to active configuration
Oct 09 07:08:40.944986 osdx OSDxCLI[1913]: User 'admin' committed the configuration.
Oct 09 07:08:40.961360 osdx OSDxCLI[1913]: User 'admin' left the configuration menu.
Oct 09 07:08:41.150329 osdx OSDxCLI[1913]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Oct 09 07:08:41.150903 osdx OSDxCLI[1913]: pam_unix(cli:session): session closed for user admin
Oct 09 07:08:41.151173 osdx OSDxCLI[1913]: User 'admin' entered the configuration menu.
Oct 09 07:08:41.219434 osdx OSDxCLI[1913]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Oct 09 07:08:41.219736 osdx cfgd[1327]: Execute action [syntax] for node [(null)]
Oct 09 07:08:41.219820 osdx cfgd[1327]: Execute action [syntax] for node [(null)]
Oct 09 07:08:41.220174 osdx OSDxCLI[1913]: pam_unix(cli:session): session closed for user admin
Oct 09 07:08:41.220453 osdx OSDxCLI[1913]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'.
Oct 09 07:08:41.321533 osdx OSDxCLI[1913]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Oct 09 07:08:41.328258 osdx cfgd[1327]: [1913]must validation for [system login user admin role] was skipped
Oct 09 07:08:41.328269 osdx cfgd[1327]: Execute action [commit-subtree] for node [system advisor ADVISOR1]
Oct 09 07:08:41.334969 osdx cfgd[1327]: Execute action [end] for node [system advisor ADVISOR1]
Oct 09 07:08:41.339686 osdx cfgd[1327]: [1913]Completed change to active configuration
Oct 09 07:08:41.342092 osdx OSDxCLI[1913]: pam_unix(cli:session): session closed for user admin
Oct 09 07:08:41.342331 osdx OSDxCLI[1913]: User 'admin' committed the configuration.
Oct 09 07:08:41.344697 osdx INFO[27264]: SCRIPT SCRIPT_1 operations:
Oct 09 07:08:41.350308 osdx OSDxCLI[27272]: Tecla::GetLine tcgetattr error
Oct 09 07:08:41.350315 osdx OSDxCLI[27272]: User 'admin' has logged in.
Oct 09 07:08:41.359352 osdx OSDxCLI[27272]: User 'admin' executed a new command: 'interfaces ethernet show'.
Oct 09 07:08:41.360592 osdx OSDxCLI[27272]: User 'admin' has logged out.
Oct 09 07:08:41.360664 osdx OSDxCLI[27272]: Tecla::GetLine tcgetattr error
Oct 09 07:08:41.361258 osdx INFO[27264]: Operation 1 'interfaces ethernet show
                                         ':

                                         -----------------------------------------------
                                         Name  IP Address  Admin  Oper  Vrf  Description
                                         -----------------------------------------------
                                         eth0              down   down
                                         eth1              down   down
Oct 09 07:08:41.362172 osdx modulelauncher[27264]: 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
Oct 09 07:08:41.362494 osdx cfgd[1327]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1
Oct 09 07:08:41.362512 osdx cfgd[1327]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1
Oct 09 07:08:41.362624 osdx OSDxCLI[1913]: User 'admin' left the configuration menu.
Oct 09 07:08:41.481727 osdx OSDxCLI[1913]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Oct 09 07:08:41.510980 osdx OSDxCLI[1913]: pam_unix(cli:session): session closed for user admin
Oct 09 07:08:41.511271 osdx OSDxCLI[1913]: User 'admin' executed a new command: 'system journal show | cat'.
Oct 09 07:08:41.607581 osdx OSDxCLI[1913]: 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'