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'Show output
# Teldat OSDx VM version v3.10.1.6 # Mon 24 Jun 2024 11:59:33 UTC +00:00 # Warning: Configuration has not been saved set system advisor ADVISOR1 test true set system cli configuration logging global info set system description 'advisor applied' set system login user admin authentication encrypted-password '$6$GSjsCj8gHLv$/VcqU6FLi6CT2Oxn0MJQ2C2tqnRDrYKNF8HIYWJp68nvXvPdFccDsT04.WtigUONbKYrgKg8d6rEs8PjljMkH0' set system script SCRIPT_1 advisor ADVISOR1 set system script SCRIPT_1 configuration '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 showShow output
-- Logs begin at Mon 2024-06-24 11:59:39 UTC, end at Mon 2024-06-24 11:59:42 UTC. -- Jun 24 11:59:39.374870 osdx systemd-journald[596]: Runtime journal (/run/log/journal/9a819f3302304ea795867ea7c248068f) is 4.0M, max 16.0M, 11.9M free. Jun 24 11:59:39.414192 osdx OSDxCLI[13212]: User 'admin' executed a new command: 'system journal clear'. Jun 24 11:59:40.144822 osdx osdx-coredump[26969]: Deleting all coredumps in /opt/vyatta/etc/config/coredump... Jun 24 11:59:40.153180 osdx OSDxCLI[13212]: User 'admin' executed a new command: 'system coredump delete all'. Jun 24 11:59:41.027541 osdx OSDxCLI[13212]: User 'admin' entered the configuration menu. Jun 24 11:59:41.143746 osdx OSDxCLI[13212]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'. Jun 24 11:59:41.231345 osdx OSDxCLI[13212]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'. Jun 24 11:59:41.347716 osdx OSDxCLI[13212]: User 'admin' added a new cfg line: 'set system cli configuration logging global info'. Jun 24 11:59:41.445979 osdx OSDxCLI[13212]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'. Jun 24 11:59:41.581900 osdx OSDxCLI[13212]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'. Jun 24 11:59:41.665047 osdx OSDxCLI[13212]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''. Jun 24 11:59:41.776764 osdx OSDxCLI[13212]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''. Jun 24 11:59:41.874946 osdx modulelauncher[972]: + Received data: ['13212', 'osdx.utils.xos', 'set_console_log_level', 'info'] Jun 24 11:59:41.885459 osdx OSDxCLI[13212]: Signal 10 received Jun 24 11:59:41.893196 osdx ifmon[980]: Changed log-level to info Jun 24 11:59:41.928428 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0 Jun 24 11:59:41.955358 osdx cfgd[1115]: [13212]Completed change to active configuration Jun 24 11:59:41.958437 osdx OSDxCLI[13212]: User 'admin' committed the configuration. Jun 24 11:59:41.995541 osdx OSDxCLI[13212]: User 'admin' left the configuration menu. Jun 24 11:59:42.192367 osdx OSDxCLI[13212]: pam_unix(cli:session): session opened for user admin by admin(uid=1000) Jun 24 11:59:42.192964 osdx OSDxCLI[13212]: pam_unix(cli:session): session closed for user admin Jun 24 11:59:42.193198 osdx OSDxCLI[13212]: User 'admin' entered the configuration menu. Jun 24 11:59:42.290742 osdx OSDxCLI[13212]: pam_unix(cli:session): session opened for user admin by admin(uid=1000) Jun 24 11:59:42.290949 osdx cfgd[1115]: Execute action [syntax] for node [(null)] Jun 24 11:59:42.291032 osdx cfgd[1115]: Execute action [syntax] for node [(null)] Jun 24 11:59:42.291317 osdx OSDxCLI[13212]: pam_unix(cli:session): session closed for user admin Jun 24 11:59:42.291543 osdx OSDxCLI[13212]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'. Jun 24 11:59:42.399023 osdx OSDxCLI[13212]: pam_unix(cli:session): session opened for user admin by admin(uid=1000) Jun 24 11:59:42.409803 osdx cfgd[1115]: [13212]must validation for [system login user admin role] was skipped Jun 24 11:59:42.409819 osdx cfgd[1115]: Execute action [commit-subtree] for node [system advisor ADVISOR1] Jun 24 11:59:42.418960 osdx cfgd[1115]: Execute action [end] for node [system advisor ADVISOR1] Jun 24 11:59:42.425780 osdx cfgd[1115]: [13212]Completed change to active configuration Jun 24 11:59:42.429162 osdx OSDxCLI[13212]: pam_unix(cli:session): session closed for user admin Jun 24 11:59:42.429427 osdx OSDxCLI[13212]: User 'admin' committed the configuration. Jun 24 11:59:42.432676 osdx INFO[27091]: SCRIPT SCRIPT_1 operations: Jun 24 11:59:42.444115 osdx OSDxCLI[27099]: Tecla::GetLine tcgetattr error Jun 24 11:59:42.444495 osdx OSDxCLI[27099]: User 'admin' has logged in. Jun 24 11:59:42.454294 osdx OSDxCLI[13212]: User 'admin' left the configuration menu. Jun 24 11:59:42.460064 osdx OSDxCLI[27099]: User 'admin' executed a new command: 'interfaces ethernet show'. Jun 24 11:59:42.461429 osdx OSDxCLI[27099]: User 'admin' has logged out. Jun 24 11:59:42.461439 osdx OSDxCLI[27099]: Tecla::GetLine tcgetattr error Jun 24 11:59:42.462190 osdx INFO[27091]: Operation 1 'interfaces ethernet show ': ----------------------------------------------- Name IP Address Admin Oper Vrf Description ----------------------------------------------- eth0 down down eth1 down down Jun 24 11:59:42.463653 osdx modulelauncher[27091]: 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 Jun 24 11:59:42.464100 osdx cfgd[1115]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1 Jun 24 11:59:42.464131 osdx cfgd[1115]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1 Jun 24 11:59:42.597311 osdx OSDxCLI[13212]: 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 showShow output
-- Logs begin at Mon 2024-06-24 11:59:39 UTC, end at Mon 2024-06-24 11:59:42 UTC. -- Jun 24 11:59:39.374870 osdx systemd-journald[596]: Runtime journal (/run/log/journal/9a819f3302304ea795867ea7c248068f) is 4.0M, max 16.0M, 11.9M free. Jun 24 11:59:39.414192 osdx OSDxCLI[13212]: User 'admin' executed a new command: 'system journal clear'. Jun 24 11:59:40.144822 osdx osdx-coredump[26969]: Deleting all coredumps in /opt/vyatta/etc/config/coredump... Jun 24 11:59:40.153180 osdx OSDxCLI[13212]: User 'admin' executed a new command: 'system coredump delete all'. Jun 24 11:59:41.027541 osdx OSDxCLI[13212]: User 'admin' entered the configuration menu. Jun 24 11:59:41.143746 osdx OSDxCLI[13212]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'. Jun 24 11:59:41.231345 osdx OSDxCLI[13212]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'. Jun 24 11:59:41.347716 osdx OSDxCLI[13212]: User 'admin' added a new cfg line: 'set system cli configuration logging global info'. Jun 24 11:59:41.445979 osdx OSDxCLI[13212]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'. Jun 24 11:59:41.581900 osdx OSDxCLI[13212]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'. Jun 24 11:59:41.665047 osdx OSDxCLI[13212]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''. Jun 24 11:59:41.776764 osdx OSDxCLI[13212]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''. Jun 24 11:59:41.874946 osdx modulelauncher[972]: + Received data: ['13212', 'osdx.utils.xos', 'set_console_log_level', 'info'] Jun 24 11:59:41.885459 osdx OSDxCLI[13212]: Signal 10 received Jun 24 11:59:41.893196 osdx ifmon[980]: Changed log-level to info Jun 24 11:59:41.928428 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0 Jun 24 11:59:41.955358 osdx cfgd[1115]: [13212]Completed change to active configuration Jun 24 11:59:41.958437 osdx OSDxCLI[13212]: User 'admin' committed the configuration. Jun 24 11:59:41.995541 osdx OSDxCLI[13212]: User 'admin' left the configuration menu. Jun 24 11:59:42.192367 osdx OSDxCLI[13212]: pam_unix(cli:session): session opened for user admin by admin(uid=1000) Jun 24 11:59:42.192964 osdx OSDxCLI[13212]: pam_unix(cli:session): session closed for user admin Jun 24 11:59:42.193198 osdx OSDxCLI[13212]: User 'admin' entered the configuration menu. Jun 24 11:59:42.290742 osdx OSDxCLI[13212]: pam_unix(cli:session): session opened for user admin by admin(uid=1000) Jun 24 11:59:42.290949 osdx cfgd[1115]: Execute action [syntax] for node [(null)] Jun 24 11:59:42.291032 osdx cfgd[1115]: Execute action [syntax] for node [(null)] Jun 24 11:59:42.291317 osdx OSDxCLI[13212]: pam_unix(cli:session): session closed for user admin Jun 24 11:59:42.291543 osdx OSDxCLI[13212]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'. Jun 24 11:59:42.399023 osdx OSDxCLI[13212]: pam_unix(cli:session): session opened for user admin by admin(uid=1000) Jun 24 11:59:42.409803 osdx cfgd[1115]: [13212]must validation for [system login user admin role] was skipped Jun 24 11:59:42.409819 osdx cfgd[1115]: Execute action [commit-subtree] for node [system advisor ADVISOR1] Jun 24 11:59:42.418960 osdx cfgd[1115]: Execute action [end] for node [system advisor ADVISOR1] Jun 24 11:59:42.425780 osdx cfgd[1115]: [13212]Completed change to active configuration Jun 24 11:59:42.429162 osdx OSDxCLI[13212]: pam_unix(cli:session): session closed for user admin Jun 24 11:59:42.429427 osdx OSDxCLI[13212]: User 'admin' committed the configuration. Jun 24 11:59:42.432676 osdx INFO[27091]: SCRIPT SCRIPT_1 operations: Jun 24 11:59:42.444115 osdx OSDxCLI[27099]: Tecla::GetLine tcgetattr error Jun 24 11:59:42.444495 osdx OSDxCLI[27099]: User 'admin' has logged in. Jun 24 11:59:42.454294 osdx OSDxCLI[13212]: User 'admin' left the configuration menu. Jun 24 11:59:42.460064 osdx OSDxCLI[27099]: User 'admin' executed a new command: 'interfaces ethernet show'. Jun 24 11:59:42.461429 osdx OSDxCLI[27099]: User 'admin' has logged out. Jun 24 11:59:42.461439 osdx OSDxCLI[27099]: Tecla::GetLine tcgetattr error Jun 24 11:59:42.462190 osdx INFO[27091]: Operation 1 'interfaces ethernet show ': ----------------------------------------------- Name IP Address Admin Oper Vrf Description ----------------------------------------------- eth0 down down eth1 down down Jun 24 11:59:42.463653 osdx modulelauncher[27091]: 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 Jun 24 11:59:42.464100 osdx cfgd[1115]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1 Jun 24 11:59:42.464131 osdx cfgd[1115]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1 Jun 24 11:59:42.597311 osdx OSDxCLI[13212]: pam_unix(cli:session): session opened for user admin by admin(uid=1000) Jun 24 11:59:42.647784 osdx OSDxCLI[13212]: pam_unix(cli:session): session closed for user admin Jun 24 11:59:42.648073 osdx OSDxCLI[13212]: User 'admin' executed a new command: 'system journal show | cat'. Jun 24 11:59:42.835165 osdx OSDxCLI[13212]: 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.*\ndum1Show output
----------------------------------------------------------------- Name IP Address Admin Oper Vrf Description ----------------------------------------------------------------- dum0 fe80::8cc4:87ff:fe95:bb93/64 up up dum1 fe80::34f5:68ff:fe32:3926/64 up up
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'Show output
# Teldat OSDx VM version v3.10.1.6 # Mon 24 Jun 2024 12:00:01 UTC +00:00 # Warning: Configuration has not been saved set system advisor ADVISOR1 test false set system cli configuration logging global info set system login user admin authentication encrypted-password '$6$GSjsCj8gHLv$/VcqU6FLi6CT2Oxn0MJQ2C2tqnRDrYKNF8HIYWJp68nvXvPdFccDsT04.WtigUONbKYrgKg8d6rEs8PjljMkH0' set system script SCRIPT_1 advisor ADVISOR1 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 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'Show output
# Teldat OSDx VM version v3.10.1.6 # Mon 24 Jun 2024 12:00:02 UTC +00:00 # Warning: Configuration has not been saved set system advisor ADVISOR1 test false set system cli configuration logging global info set system login user admin authentication encrypted-password '$6$GSjsCj8gHLv$/VcqU6FLi6CT2Oxn0MJQ2C2tqnRDrYKNF8HIYWJp68nvXvPdFccDsT04.WtigUONbKYrgKg8d6rEs8PjljMkH0' set system script SCRIPT_1 advisor ADVISOR1 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 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'Show output
# Teldat OSDx VM version v3.10.1.6 # Mon 24 Jun 2024 12:00:03 UTC +00:00 # Warning: Configuration has not been saved set system advisor ADVISOR1 test false set system cli configuration logging global info set system description 'advisor applied' set system login user admin authentication encrypted-password '$6$GSjsCj8gHLv$/VcqU6FLi6CT2Oxn0MJQ2C2tqnRDrYKNF8HIYWJp68nvXvPdFccDsT04.WtigUONbKYrgKg8d6rEs8PjljMkH0' set system script SCRIPT_1 advisor ADVISOR1 set system script SCRIPT_1 configuration 'set system description \'advisor applied\'' set system script SCRIPT_1 number-of-triggers 3