enhancement in test-cases

Author: kirankotari

README.md

@@ -7,12 +7,20 @@
 
 ncs-netsim is a great tool, but it lack of following features which are developed as part of netsim-wrapper
 
-- netsim-wrapper features  
-  - delete-devices \<device-names>
-  - create-network-from [ yaml | json ] \<filename>
-  - create-device-from [ yaml | json ] \<filename>
-  - create-network-template [ yaml | json ]
-  - create-device-template [ yaml | json ]
+```python
+Usage nwrap template create [network | device] [yaml | json] [<fileName>]
+            template load <fileName> [<username> <password>]
+            download <username> <password> link
+            delete-devices <DeviceNames>
+            -v  | --version
+            -vv | --verbose
+            -h  | --help
+
+nwrap is an alias of `netsim-wrapper` and you can pass
+multiple devnames instead of single devname, eg. start, stop, ...
+
+Additionally we support all `ncs-netsim` commands
+```
 
 netsim-wrapper is a wrapper on top of ncs-netsim with added features. It's written in python and we opened the space to add more features to it.
 

netsim_wrapper/netsim.py

@@ -103,9 +103,9 @@ def status(self, devices=None, _async=False):
         out = self.device('status', devices, False)
         return out
 
-    def list(self):
+    def list(self, raiseError=True):
         self.log.debug("fetching netsim list")
-        out = self.utils.cmd.run(self.cmd + ['list'])
+        out = self.utils.cmd.run(self.cmd + ['list'], raiseError)
         self.log.debug("netsim list done")
         return out
 
@@ -185,6 +185,7 @@ def basic_template(self):
         template['neds'].append('<ned1-link>')
         template['neds'].append('<ned2-link>')
         template['compile-neds'] = True # True/False
+        template['packages-reload'] = True # True/False
         template['start-devices'] = True # True/False
         template['add-to-nso'] = True # True/False
         template['add-authgroup-to-nso'] = True # True/False

netsim_wrapper/nso.py

@@ -1,3 +1,6 @@
+import os
+
+from pathlib import Path
 from collections import defaultdict
 
 from netsim_wrapper.utils import Singleton, Download
@@ -178,6 +181,8 @@ def compile_neds(self):
             self.log.info("$ make clean all -> in {}/src".format(path))
             cmd = "cd {}/src; make clean all;".format(path)
             self.utils.cmd.call(cmd)
+        ## kkotari: new change
+        self.utils.change_dir(self.default['cwd'])
 
     def load_authgroup(self, type, path=None): # type -> local/system/custom
         path = path or '/tmp/authgroup.xml'
@@ -191,8 +196,8 @@ def load_aaa(self, type): # type -> add.admin/add.default
         return path
 
     def load_merge(self, fpath):
-        self.log.info("{}# load merge {}".format(self.default['user'], fpath))
-        cmd = "echo 'load merge {}' | ncs_cli -u {} -C".format(fpath, self.default['user'])
+        self.log.info("{}(config)# load merge {}".format(self.default['user'], fpath))
+        cmd = "echo 'config ; load merge {} ; commit ;' | ncs_cli -u {} -C".format(fpath, self.default['user'])
         self.utils.cmd.call(cmd)
 
     def fetch_neds(self):
@@ -227,12 +232,16 @@ def extract_neds(self, signed_bin=True, extract_tar=True):
             if extract_tar:
                 tar_file = self.utils.get_tar(ned)
                 self.utils.cmd.run(['tar', '-xvf', tar_file])
-                self.utils.cmd.run(['rm', '-rf', tar_file, ned, '*.signature', '*.py', '*.py3', 'tailf.cer'])
+                self.utils.cmd.run(['rm', '-rf', tar_file, ned, 'tailf.cer', f'{tar_file}.signature'])
+                self.utils.cmd.run(['rm', '-rf', 'README.signature', 'cisco_x509_verify_release.py'])
+                self.utils.cmd.run(['rm', '-rf', 'cisco_x509_verify_release.py3'])
+        ## kkotari: new change
+        self.utils.change_dir(self.default['cwd'])
         self.log.debug('extraction done')
 
     def create_devices(self):
         self.log.info("creating netsim devices")
-        create = True if not self.nwrap.netsim.list() else False
+        create = True if not self.nwrap.netsim.list(raiseError=False) else False
         if self.default['ttype'] == 'network':
             for ned, val in self.default['device-mode']['prefix-based'].items():
                 path = "{}/{}".format(self.default['ppath'], ned)
@@ -256,8 +265,19 @@ def analyse_params(self):
         self.log.debug("analysing template parameters")
 
         self.default.update(self.nwrap.template.data)
+        # fetching full paths
+        self.default['nso-packages-path'] = Path(self.default.get('nso-packages-path', '')).absolute().as_posix()
+        self.default['config-path'] = Path(self.default.get('config-path', '')).absolute().as_posix()
+        if 'path' in self.default['authgroup']:
+            self.default['authgroup']['path'] = Path(self.default['authgroup']['path']).absolute().as_posix()
+        else:
+            self.default['authgroup']['path'] = None
+
+        # mode, package path
         self.default['ttype'] = self.nwrap.template.defaults['current']
         self.default['ppath'] = self.default['nso-packages-path']
+        self.default['runpath'] = Path(self.default['nso-packages-path']).parent.as_posix()
+        self.default['devices-path'] = '/tmp/devices.xml'
 
         # args compile neds
         if self.default['compile-neds']:
@@ -267,7 +287,7 @@ def analyse_params(self):
         if self.default['add-authgroup-to-nso']:
             self.default['authgroup-path'] = self.load_authgroup(
                 type=self.default['authgroup']['type'], 
-                path=self.default['authgroup'].get('path', None)
+                path=self.default['authgroup']['path']
             )
 
         # args day0 config
@@ -283,54 +303,59 @@ def analyse_params(self):
 
         self.log.debug("analysing template done")
 
-    def apply(self, username, password):
+    def apply(self, cwd, username, password):
         self.analyse_params()
+        self.default['cwd'] = cwd
         self.default['username'] = username
         self.default['password'] = password
 
         self.log.debug("per-netsim steps")
         if self.default['download-neds']:
             self.download_neds()
             self.extract_neds()
-            
+
         if self.default['compile-neds']:
             self.compile_neds()
 
         # feature pre netsim create
         @self.log_ncs_cli
         def pre_create():
-            if self.default['compile-neds']:
+            if self.default['packages-reload']:
                 self.packages_reload()
 
             if self.default['add-authgroup-to-nso']:
                 self.load_merge(self.load_aaa(type='admin'))
                 self.load_merge(self.default['authgroup-path'])
             return pre_create
+        pre_create()
 
         # feature create devices
         self.log.debug("netsim steps")
+
+        self.utils.change_dir(self.default['runpath'])
         self.create_devices()
 
         if self.default['start-devices']:
             self.nwrap.netsim.start()
 
         if self.default['add-to-nso']:
-            path = '/tmp/devices.xml'
             data = self.nwrap.netsim.ncs_xml_init(sysout=False)
-            self.utils.xml.dump(data, path)
+            if data is not None: self.utils.xml.dump(data, self.default['devices-path'])
 
         # feature post netsim create
         self.log.debug("post-netsim steps")
         @self.log_ncs_cli
         def post_create():
             if self.default['add-to-nso']:
-                self.load_merge(path)
+                self.load_merge(self.default['devices-path'])
                 self.fetch_ssh_keys()
                 self.sync_from()
 
+            self.utils.change_dir(self.default['cwd'])
             if self.default['load-day0-config']:
                 for fpath in self.default['config-files']:
                     self.load_merge(fpath)
             return post_create
+        post_create()
 
         self.log.debug("template done")

netsim_wrapper/nwrap.py

@@ -4,7 +4,7 @@
 from netsim_wrapper.netsim import Netsim, NetsimTemplates
 from netsim_wrapper.netsim import NetsimInfo, NetsimDelete
 from netsim_wrapper.nso import NsoUtils
-
+from os import getcwd
 
 help = """
 Usage nwrap template create [network | device] [yaml | json] [<fileName>]
@@ -149,6 +149,7 @@ def analyse_params(self, params):
         pkeys = ('ncs-xml-init-remote', '--force-generic', 'packages', 'netconf-console', \
                 '-w', '--window', 'cli', 'cli-c', 'cli-i', 'get-port', 'list')
 
+        res['cwd'] = getcwd()
         for each in params:
             p = str(each).lower()
 
@@ -278,7 +279,7 @@ def apply(self, params):
         # feature template load and apply
         if params['load']:
             self.nwrap.template.load(params['filename'])
-            self.nso.apply(params['username'], params['password'])
+            self.nso.apply(params['cwd'], params['username'], params['password'])
 
         # feature directly calling ncs-netsim commands
         if params['pass']:

netsim_wrapper/utils.py

@@ -255,6 +255,8 @@ def match(slef, data, regex):
 
     def filter_not_alive(self, data):
         self.log.debug("applying not-alive filter")
+        if data == None:
+            return set()
         devices, data = set(), data.split('\n')
         regex = re.compile(r'DEVICE\s+(\S+)\s+(.*)')
         res = self.match(data, regex)
@@ -265,6 +267,8 @@ def filter_not_alive(self, data):
 
     def filter_alive(self, data):
         self.log.debug("applying alive filter")
+        if data == None:
+            return set()
         devices, data = set(), data.split('\n')
         regex = re.compile(r'DEVICE\s+(\S+)\s+(.*)')
         res = self.match(data, regex)

tests/.gitignore

@@ -1,3 +1,3 @@
 # custom file ignore from tests folder
 nso-run/
-*cisco*
+*cisco*

tests/configs/custom_authgroup.xml

@@ -0,0 +1,12 @@
+
+<devices xmlns="http://tail-f.com/ns/ncs">
+    <authgroups>
+        <group>
+            <name>default</name>
+            <default-map>
+                <remote-name>admin</remote-name>
+                <remote-password>admin</remote-password>
+            </default-map>
+        </group>
+    </authgroups>
+</devices>

tests/configs/device.yaml

@@ -0,0 +1,22 @@
+nso-packages-path: ./nso-run/packages
+download-neds: false
+neds:
+- https://earth.tail-f.com:8443/ncs-pkgs/cisco-ios/5.7.1/ncs-5.7.1-cisco-ios-6.79.signed.bin
+compile-neds: false
+packages-reload: false
+start-devices: true
+add-to-nso: true
+add-authgroup-to-nso: false
+authgroup:
+  type: local
+  path: ./custom_authgroup.xml
+device-mode:
+  name-based:
+    cisco-ios-cli-6.79:
+    - device-ios0
+    - device-ios1
+load-day0-config: false
+config-path: ../day0/
+config-files:
+- device_ios0_interface.cfg
+- device_ios1_interface.cfg

tests/custom_authgroup.xml

@@ -0,0 +1,14 @@
+devices device device-ios0
+ config
+  interface Loopback10
+   description day0 configuraiton of interface loopback 10
+   ip address 10.0.10.0 255.255.255.0
+   no shutdown
+  exit
+  interface Loopback100
+   description day0 configuraiton of interface loopback 100
+   ip address 10.0.100.0 255.255.255.0
+   no shutdown
+  exit
+ !
+!