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 Mon 2024-12-02 18:55:23 UTC, end at Mon 2024-12-02 18:55:27 UTC. --
Dec 02 18:55:23.471565 osdx systemd-journald[1504]: Runtime journal (/run/log/journal/1d07d1333cb24d498692b025d3740112) is 2.0M, max 16.0M, 14.0M free.
Dec 02 18:55:23.490346 osdx OSDxCLI[25701]: User 'admin' executed a new command: 'system journal clear'.
Dec 02 18:55:24.299985 osdx osdx-coredump[29825]: Deleting all coredumps in /opt/vyatta/etc/config/coredump...
Dec 02 18:55:24.311090 osdx OSDxCLI[25701]: User 'admin' executed a new command: 'system coredump delete all'.
Dec 02 18:55:25.493241 osdx OSDxCLI[25701]: User 'admin' entered the configuration menu.
Dec 02 18:55:25.610755 osdx OSDxCLI[25701]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Dec 02 18:55:25.730091 osdx OSDxCLI[25701]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'.
Dec 02 18:55:25.831172 osdx OSDxCLI[25701]: User 'admin' added a new cfg line: 'set system cli configuration logging global info'.
Dec 02 18:55:25.933853 osdx OSDxCLI[25701]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Dec 02 18:55:26.064507 osdx OSDxCLI[25701]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'.
Dec 02 18:55:26.184610 osdx OSDxCLI[25701]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''.
Dec 02 18:55:26.289996 osdx OSDxCLI[25701]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''.
Dec 02 18:55:26.415003 osdx modulelauncher[972]: + Received data: ['25701', 'osdx.utils.xos', 'set_console_log_level', 'info']
Dec 02 18:55:26.427512 osdx OSDxCLI[25701]: Signal 10 received
Dec 02 18:55:26.436776 osdx ifmon[980]: Changed log-level to info
Dec 02 18:55:26.480697 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0
Dec 02 18:55:26.534694 osdx cfgd[1120]: [25701]Completed change to active configuration
Dec 02 18:55:26.537975 osdx OSDxCLI[25701]: User 'admin' committed the configuration.
Dec 02 18:55:26.568160 osdx OSDxCLI[25701]: User 'admin' left the configuration menu.
Dec 02 18:55:26.870828 osdx OSDxCLI[25701]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Dec 02 18:55:26.871528 osdx OSDxCLI[25701]: pam_unix(cli:session): session closed for user admin
Dec 02 18:55:26.871856 osdx OSDxCLI[25701]: User 'admin' entered the configuration menu.
Dec 02 18:55:26.995418 osdx OSDxCLI[25701]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Dec 02 18:55:26.995810 osdx cfgd[1120]: Execute action [syntax] for node [(null)]
Dec 02 18:55:26.995898 osdx cfgd[1120]: Execute action [syntax] for node [(null)]
Dec 02 18:55:26.996229 osdx OSDxCLI[25701]: pam_unix(cli:session): session closed for user admin
Dec 02 18:55:26.996576 osdx OSDxCLI[25701]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'.
Dec 02 18:55:27.119996 osdx OSDxCLI[25701]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Dec 02 18:55:27.135577 osdx cfgd[1120]: [25701]must validation for [system login user admin role] was skipped
Dec 02 18:55:27.135597 osdx cfgd[1120]: Execute action [commit-subtree] for node [system advisor ADVISOR1]
Dec 02 18:55:27.145530 osdx cfgd[1120]: Execute action [end] for node [system advisor ADVISOR1]
Dec 02 18:55:27.152105 osdx cfgd[1120]: [25701]Completed change to active configuration
Dec 02 18:55:27.156118 osdx OSDxCLI[25701]: pam_unix(cli:session): session closed for user admin
Dec 02 18:55:27.156472 osdx OSDxCLI[25701]: User 'admin' committed the configuration.
Dec 02 18:55:27.160359 osdx INFO[29971]: SCRIPT SCRIPT_1 operations:
Dec 02 18:55:27.172231 osdx OSDxCLI[29980]: Tecla::GetLine tcgetattr error
Dec 02 18:55:27.172239 osdx OSDxCLI[29980]: User 'admin' has logged in.
Dec 02 18:55:27.187186 osdx OSDxCLI[29980]: User 'admin' executed a new command: 'interfaces ethernet show'.
Dec 02 18:55:27.189133 osdx OSDxCLI[29980]: User 'admin' has logged out.
Dec 02 18:55:27.189236 osdx OSDxCLI[29980]: Tecla::GetLine tcgetattr error
Dec 02 18:55:27.190237 osdx INFO[29971]: Operation 1 'interfaces ethernet show
                                         ':

                                         -----------------------------------------------
                                         Name  IP Address  Admin  Oper  Vrf  Description
                                         -----------------------------------------------
                                         eth0              down   down
                                         eth1              down   down
Dec 02 18:55:27.191602 osdx modulelauncher[29971]: 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 02 18:55:27.192182 osdx cfgd[1120]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1
Dec 02 18:55:27.192216 osdx cfgd[1120]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1
Dec 02 18:55:27.205555 osdx OSDxCLI[25701]: User 'admin' left the configuration menu.
Dec 02 18:55:27.371382 osdx OSDxCLI[25701]: 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 Mon 2024-12-02 18:55:23 UTC, end at Mon 2024-12-02 18:55:27 UTC. --
Dec 02 18:55:23.471565 osdx systemd-journald[1504]: Runtime journal (/run/log/journal/1d07d1333cb24d498692b025d3740112) is 2.0M, max 16.0M, 14.0M free.
Dec 02 18:55:23.490346 osdx OSDxCLI[25701]: User 'admin' executed a new command: 'system journal clear'.
Dec 02 18:55:24.299985 osdx osdx-coredump[29825]: Deleting all coredumps in /opt/vyatta/etc/config/coredump...
Dec 02 18:55:24.311090 osdx OSDxCLI[25701]: User 'admin' executed a new command: 'system coredump delete all'.
Dec 02 18:55:25.493241 osdx OSDxCLI[25701]: User 'admin' entered the configuration menu.
Dec 02 18:55:25.610755 osdx OSDxCLI[25701]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Dec 02 18:55:25.730091 osdx OSDxCLI[25701]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'.
Dec 02 18:55:25.831172 osdx OSDxCLI[25701]: User 'admin' added a new cfg line: 'set system cli configuration logging global info'.
Dec 02 18:55:25.933853 osdx OSDxCLI[25701]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Dec 02 18:55:26.064507 osdx OSDxCLI[25701]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'.
Dec 02 18:55:26.184610 osdx OSDxCLI[25701]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''.
Dec 02 18:55:26.289996 osdx OSDxCLI[25701]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''.
Dec 02 18:55:26.415003 osdx modulelauncher[972]: + Received data: ['25701', 'osdx.utils.xos', 'set_console_log_level', 'info']
Dec 02 18:55:26.427512 osdx OSDxCLI[25701]: Signal 10 received
Dec 02 18:55:26.436776 osdx ifmon[980]: Changed log-level to info
Dec 02 18:55:26.480697 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0
Dec 02 18:55:26.534694 osdx cfgd[1120]: [25701]Completed change to active configuration
Dec 02 18:55:26.537975 osdx OSDxCLI[25701]: User 'admin' committed the configuration.
Dec 02 18:55:26.568160 osdx OSDxCLI[25701]: User 'admin' left the configuration menu.
Dec 02 18:55:26.870828 osdx OSDxCLI[25701]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Dec 02 18:55:26.871528 osdx OSDxCLI[25701]: pam_unix(cli:session): session closed for user admin
Dec 02 18:55:26.871856 osdx OSDxCLI[25701]: User 'admin' entered the configuration menu.
Dec 02 18:55:26.995418 osdx OSDxCLI[25701]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Dec 02 18:55:26.995810 osdx cfgd[1120]: Execute action [syntax] for node [(null)]
Dec 02 18:55:26.995898 osdx cfgd[1120]: Execute action [syntax] for node [(null)]
Dec 02 18:55:26.996229 osdx OSDxCLI[25701]: pam_unix(cli:session): session closed for user admin
Dec 02 18:55:26.996576 osdx OSDxCLI[25701]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'.
Dec 02 18:55:27.119996 osdx OSDxCLI[25701]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Dec 02 18:55:27.135577 osdx cfgd[1120]: [25701]must validation for [system login user admin role] was skipped
Dec 02 18:55:27.135597 osdx cfgd[1120]: Execute action [commit-subtree] for node [system advisor ADVISOR1]
Dec 02 18:55:27.145530 osdx cfgd[1120]: Execute action [end] for node [system advisor ADVISOR1]
Dec 02 18:55:27.152105 osdx cfgd[1120]: [25701]Completed change to active configuration
Dec 02 18:55:27.156118 osdx OSDxCLI[25701]: pam_unix(cli:session): session closed for user admin
Dec 02 18:55:27.156472 osdx OSDxCLI[25701]: User 'admin' committed the configuration.
Dec 02 18:55:27.160359 osdx INFO[29971]: SCRIPT SCRIPT_1 operations:
Dec 02 18:55:27.172231 osdx OSDxCLI[29980]: Tecla::GetLine tcgetattr error
Dec 02 18:55:27.172239 osdx OSDxCLI[29980]: User 'admin' has logged in.
Dec 02 18:55:27.187186 osdx OSDxCLI[29980]: User 'admin' executed a new command: 'interfaces ethernet show'.
Dec 02 18:55:27.189133 osdx OSDxCLI[29980]: User 'admin' has logged out.
Dec 02 18:55:27.189236 osdx OSDxCLI[29980]: Tecla::GetLine tcgetattr error
Dec 02 18:55:27.190237 osdx INFO[29971]: Operation 1 'interfaces ethernet show
                                         ':

                                         -----------------------------------------------
                                         Name  IP Address  Admin  Oper  Vrf  Description
                                         -----------------------------------------------
                                         eth0              down   down
                                         eth1              down   down
Dec 02 18:55:27.191602 osdx modulelauncher[29971]: 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 02 18:55:27.192182 osdx cfgd[1120]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1
Dec 02 18:55:27.192216 osdx cfgd[1120]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1
Dec 02 18:55:27.205555 osdx OSDxCLI[25701]: User 'admin' left the configuration menu.
Dec 02 18:55:27.371382 osdx OSDxCLI[25701]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Dec 02 18:55:27.416462 osdx OSDxCLI[25701]: pam_unix(cli:session): session closed for user admin
Dec 02 18:55:27.416851 osdx OSDxCLI[25701]: User 'admin' executed a new command: 'system journal show | cat'.
Dec 02 18:55:27.610998 osdx OSDxCLI[25701]: 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'