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 2023-12-13 02:08:36 UTC, end at Wed 2023-12-13 02:08:39 UTC. --
Dec 13 02:08:36.000231 osdx systemd-timedated[15343]: Changed local time to Wed Dec 13 02:08:36 2023
Dec 13 02:08:36.002308 osdx OSDxCLI[11272]: User 'admin' executed a new command: 'set date 2023-12-13 02:08:36'.
Dec 13 02:08:36.398134 osdx systemd-journald[1450]: Runtime journal (/run/log/journal/fa37e9b1f0b54640986d40edb905b319) is 4.0M, max 16.0M, 12.0M free.
Dec 13 02:08:36.416960 osdx OSDxCLI[11272]: User 'admin' executed a new command: 'system journal clear'.
Dec 13 02:08:36.953102 osdx osdx-coredump[16664]: Deleting all coredumps in /opt/vyatta/etc/config/coredump...
Dec 13 02:08:36.961068 osdx OSDxCLI[11272]: User 'admin' executed a new command: 'system coredump delete all'.
Dec 13 02:08:37.911095 osdx OSDxCLI[11272]: User 'admin' entered the configuration menu.
Dec 13 02:08:38.034037 osdx OSDxCLI[11272]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Dec 13 02:08:38.126955 osdx OSDxCLI[11272]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'.
Dec 13 02:08:38.218365 osdx OSDxCLI[11272]: User 'admin' added a new cfg line: 'set system cli configuration logging global info'.
Dec 13 02:08:38.313175 osdx OSDxCLI[11272]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Dec 13 02:08:38.407907 osdx OSDxCLI[11272]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'.
Dec 13 02:08:38.508245 osdx OSDxCLI[11272]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''.
Dec 13 02:08:38.597055 osdx OSDxCLI[11272]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''.
Dec 13 02:08:38.710212 osdx modulelauncher[942]: + Received data: ['11272', 'osdx.utils.xos', 'set_console_log_level', 'info']
Dec 13 02:08:38.722977 osdx OSDxCLI[11272]: Signal 10 received
Dec 13 02:08:38.776763 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0
Dec 13 02:08:38.823789 osdx cfgd[1102]: [11272]Completed change to active configuration
Dec 13 02:08:38.837653 osdx OSDxCLI[11272]: User 'admin' committed the configuration.
Dec 13 02:08:38.885599 osdx OSDxCLI[11272]: User 'admin' left the configuration menu.
Dec 13 02:08:39.097827 osdx OSDxCLI[11272]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Dec 13 02:08:39.098617 osdx OSDxCLI[11272]: pam_unix(cli:session): session closed for user admin
Dec 13 02:08:39.098916 osdx OSDxCLI[11272]: User 'admin' entered the configuration menu.
Dec 13 02:08:39.195502 osdx OSDxCLI[11272]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Dec 13 02:08:39.196117 osdx OSDxCLI[11272]: pam_unix(cli:session): session closed for user admin
Dec 13 02:08:39.196395 osdx OSDxCLI[11272]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'.
Dec 13 02:08:39.284843 osdx OSDxCLI[11272]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Dec 13 02:08:39.289193 osdx cfgd[1102]: [11272]must validation for [system login user admin role] was skipped
Dec 13 02:08:39.289325 osdx cfgd[1102]: Execute action [commit-subtree] for node [system advisor ADVISOR1]
Dec 13 02:08:39.303165 osdx cfgd[1102]: Execute action [end] for node [system advisor ADVISOR1]
Dec 13 02:08:39.309354 osdx cfgd[1102]: [11272]Completed change to active configuration
Dec 13 02:08:39.314425 osdx OSDxCLI[11272]: pam_unix(cli:session): session closed for user admin
Dec 13 02:08:39.314683 osdx OSDxCLI[11272]: User 'admin' committed the configuration.
Dec 13 02:08:39.319290 osdx INFO[16804]: SCRIPT SCRIPT_1 operations:
Dec 13 02:08:39.333392 osdx OSDxCLI[16809]: Tecla::GetLine tcgetattr error
Dec 13 02:08:39.333779 osdx OSDxCLI[16809]: User 'admin' has logged in.
Dec 13 02:08:39.340832 osdx OSDxCLI[11272]: User 'admin' left the configuration menu.
Dec 13 02:08:39.353305 osdx OSDxCLI[16809]: User 'admin' executed a new command: 'interfaces ethernet show'.
Dec 13 02:08:39.355730 osdx OSDxCLI[16809]: User 'admin' has logged out.
Dec 13 02:08:39.355843 osdx OSDxCLI[16809]: Tecla::GetLine tcgetattr error
Dec 13 02:08:39.357005 osdx INFO[16804]: Operation 1 'interfaces ethernet show
                                         ':

                                         -----------------------------------------------
                                         Name  IP Address  Admin  Oper  Vrf  Description
                                         -----------------------------------------------
                                         eth0              down   down
                                         eth1              down   down
Dec 13 02:08:39.358096 osdx modulelauncher[16804]: 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
Dec 13 02:08:39.359180 osdx cfgd[1102]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1
Dec 13 02:08:39.359199 osdx cfgd[1102]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1
Dec 13 02:08:39.510130 osdx OSDxCLI[11272]: 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 2023-12-13 02:08:36 UTC, end at Wed 2023-12-13 02:08:39 UTC. --
Dec 13 02:08:36.000231 osdx systemd-timedated[15343]: Changed local time to Wed Dec 13 02:08:36 2023
Dec 13 02:08:36.002308 osdx OSDxCLI[11272]: User 'admin' executed a new command: 'set date 2023-12-13 02:08:36'.
Dec 13 02:08:36.398134 osdx systemd-journald[1450]: Runtime journal (/run/log/journal/fa37e9b1f0b54640986d40edb905b319) is 4.0M, max 16.0M, 12.0M free.
Dec 13 02:08:36.416960 osdx OSDxCLI[11272]: User 'admin' executed a new command: 'system journal clear'.
Dec 13 02:08:36.953102 osdx osdx-coredump[16664]: Deleting all coredumps in /opt/vyatta/etc/config/coredump...
Dec 13 02:08:36.961068 osdx OSDxCLI[11272]: User 'admin' executed a new command: 'system coredump delete all'.
Dec 13 02:08:37.911095 osdx OSDxCLI[11272]: User 'admin' entered the configuration menu.
Dec 13 02:08:38.034037 osdx OSDxCLI[11272]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Dec 13 02:08:38.126955 osdx OSDxCLI[11272]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'.
Dec 13 02:08:38.218365 osdx OSDxCLI[11272]: User 'admin' added a new cfg line: 'set system cli configuration logging global info'.
Dec 13 02:08:38.313175 osdx OSDxCLI[11272]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Dec 13 02:08:38.407907 osdx OSDxCLI[11272]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'.
Dec 13 02:08:38.508245 osdx OSDxCLI[11272]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''.
Dec 13 02:08:38.597055 osdx OSDxCLI[11272]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''.
Dec 13 02:08:38.710212 osdx modulelauncher[942]: + Received data: ['11272', 'osdx.utils.xos', 'set_console_log_level', 'info']
Dec 13 02:08:38.722977 osdx OSDxCLI[11272]: Signal 10 received
Dec 13 02:08:38.776763 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0
Dec 13 02:08:38.823789 osdx cfgd[1102]: [11272]Completed change to active configuration
Dec 13 02:08:38.837653 osdx OSDxCLI[11272]: User 'admin' committed the configuration.
Dec 13 02:08:38.885599 osdx OSDxCLI[11272]: User 'admin' left the configuration menu.
Dec 13 02:08:39.097827 osdx OSDxCLI[11272]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Dec 13 02:08:39.098617 osdx OSDxCLI[11272]: pam_unix(cli:session): session closed for user admin
Dec 13 02:08:39.098916 osdx OSDxCLI[11272]: User 'admin' entered the configuration menu.
Dec 13 02:08:39.195502 osdx OSDxCLI[11272]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Dec 13 02:08:39.196117 osdx OSDxCLI[11272]: pam_unix(cli:session): session closed for user admin
Dec 13 02:08:39.196395 osdx OSDxCLI[11272]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'.
Dec 13 02:08:39.284843 osdx OSDxCLI[11272]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Dec 13 02:08:39.289193 osdx cfgd[1102]: [11272]must validation for [system login user admin role] was skipped
Dec 13 02:08:39.289325 osdx cfgd[1102]: Execute action [commit-subtree] for node [system advisor ADVISOR1]
Dec 13 02:08:39.303165 osdx cfgd[1102]: Execute action [end] for node [system advisor ADVISOR1]
Dec 13 02:08:39.309354 osdx cfgd[1102]: [11272]Completed change to active configuration
Dec 13 02:08:39.314425 osdx OSDxCLI[11272]: pam_unix(cli:session): session closed for user admin
Dec 13 02:08:39.314683 osdx OSDxCLI[11272]: User 'admin' committed the configuration.
Dec 13 02:08:39.319290 osdx INFO[16804]: SCRIPT SCRIPT_1 operations:
Dec 13 02:08:39.333392 osdx OSDxCLI[16809]: Tecla::GetLine tcgetattr error
Dec 13 02:08:39.333779 osdx OSDxCLI[16809]: User 'admin' has logged in.
Dec 13 02:08:39.340832 osdx OSDxCLI[11272]: User 'admin' left the configuration menu.
Dec 13 02:08:39.353305 osdx OSDxCLI[16809]: User 'admin' executed a new command: 'interfaces ethernet show'.
Dec 13 02:08:39.355730 osdx OSDxCLI[16809]: User 'admin' has logged out.
Dec 13 02:08:39.355843 osdx OSDxCLI[16809]: Tecla::GetLine tcgetattr error
Dec 13 02:08:39.357005 osdx INFO[16804]: Operation 1 'interfaces ethernet show
                                         ':

                                         -----------------------------------------------
                                         Name  IP Address  Admin  Oper  Vrf  Description
                                         -----------------------------------------------
                                         eth0              down   down
                                         eth1              down   down
Dec 13 02:08:39.358096 osdx modulelauncher[16804]: 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
Dec 13 02:08:39.359180 osdx cfgd[1102]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1
Dec 13 02:08:39.359199 osdx cfgd[1102]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1
Dec 13 02:08:39.510130 osdx OSDxCLI[11272]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Dec 13 02:08:39.555772 osdx OSDxCLI[11272]: pam_unix(cli:session): session closed for user admin
Dec 13 02:08:39.556057 osdx OSDxCLI[11272]: User 'admin' executed a new command: 'system journal show | cat'.
Dec 13 02:08:39.727522 osdx OSDxCLI[11272]: 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'