adding initial code refactor

Author: kirankotari

netsim_wrapper/json.py

@@ -0,0 +1,32 @@
+from logging import INFO
+from json import load, dump
+
+from .system import System
+
+
+class Json(System):
+    def __init__(self, level=INFO) -> None:
+        super(Json, self).__init__(level=level)
+        self.log.debug(f"base class: {__class__.__name__} initialize")
+
+    def load(self, fpath):
+        data = None
+        try:
+            self.log.debug(f"base class: {__class__.__name__}.{__class__.__module__}")
+            with open(fpath) as f:
+                data = load(f)
+        except EnvironmentError as e:
+            self.log.error("error while loading the file: {}".format(fpath))
+            self.log.error(e)
+        return data
+
+    def dump(self, fpath, template):
+        try:
+            self.log.debug(f"base class: {__class__.__name__}.{__class__.__module__}")
+            with open(fpath, 'w') as f:
+                dump(template, f, indent=2)
+                self.log.info("please, find the file in: {}".format(fpath))
+        except EnvironmentError as e:
+            self.log.error("error while createing of template")
+            self.log.error(e)
+

netsim_wrapper/netsim.py

@@ -0,0 +1,13 @@
+from .utils import Utils
+from logging import INFO
+
+class Netsim(Utils):
+    name = 'ncs-netsim'
+    command = ['ncs-netsim']
+    netsim_options = []
+    netsim_dir = 'netsim'
+
+    def __init__(self, path='.', level=INFO) -> None:
+        super().__init__(path, level)
+
+    

netsim_wrapper/run.py

@@ -0,0 +1,62 @@
+"""
+The module is for system operations exit, unlink and setting logger
+"""
+
+import logging
+
+from pathlib import Path
+from sys import exit as sys_exit
+import subprocess
+
+format = '%(levelname)-8s | %(asctime)s | %(module)-8s:%(lineno)-4d | %(message)s'
+
+
+def get_log(level):
+    logging.basicConfig(level=level, format=format)
+    return logging.getLogger()
+
+
+class System:
+    def __init__(self, path='.', level=logging.INFO) -> None:
+        super(System, self).__init__()
+        self.log = get_log(level)
+        self.log.debug(f"base class: {__class__.__name__} initialize")
+        self.path = Path(path).absolute()
+
+    @property
+    def exit(self):
+        sys_exit()
+
+    def delete(self, fpath):
+        path = Path(fpath).absolute()
+        if path.exists():
+            path.unlink()
+
+    def is_file(self, fpath):
+        path = Path(fpath).absolute()
+        return path.is_file()
+
+    def is_dir(self, fpath):
+        path = Path(fpath).absolute()
+        return path.is_dir()
+
+    def call(self, cmd):
+        try:
+            subprocess.call(cmd, shell=True)
+        except EnvironmentError as e:
+            self.log.error("failed to run command: {}".format(cmd))
+            self.log.error(e)
+
+    def run(self, cmd, error=True):
+        p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+        out, err = p.communicate()
+        out, err = out.decode('utf-8'), err.decode('utf-8')
+        if err == '' or 'env.sh' in err:
+            self.log.debug("`{}` ran successfully".format(' '.join(cmd)))
+            return out
+        if error:
+            self.log.error("an error occured while running command `{}`".format(' '.join(cmd)))
+            self.log.error('message: {}'.format(err))
+            if 'command not found' in err or 'Unknown command' in err:
+                raise ValueError("command not found.")
+        return False

netsim_wrapper/system.py

@@ -0,0 +1,51 @@
+"""
+The module is for system operations (subprocess) and setting logger
+"""
+
+from logging import INFO
+from pathlib import Path
+
+from .system import System
+from .json import Json
+
+class Xml(System):
+    def __init__(self, level=INFO) -> None:
+        super().__init__(level=level)
+        self.log.debug(f"base class: {__class__.__name__} initialize")
+
+    def dump(self, fpath, xml_data):
+        try:
+            self.log.debug(f"base class: {__class__.__name__}.{__class__.__module__}")
+            with open(fpath, 'w') as fp:
+                fp.write(xml_data)
+                self.log.info("please, find the file in: {}".format(fpath))
+        except EnvironmentError as e:
+            self.log.error("error on createing xml file")
+            self.log.error(e)
+
+
+class Utils(Json, System):
+    def __init__(self, path='.', level=INFO) -> None:
+        super(Utils, self).__init__(path, level)
+        self.log.debug(f"base class: {__class__.__name__} initialize")
+
+    def create(self, fpath):
+        if not self.is_file(fpath):
+            self.dump(fpath, {})
+
+    def rstrip_digits(self, given_string):
+        return given_string.rstrip('1234567890')
+
+    def get_index(self, given_list, element):
+        try:
+            return given_list.index(element)
+        except ValueError:
+            return None
+
+    def get_path(self):
+        path = None
+        # if len(cmd_lst) > index+1:
+        #     path = cmd_lst[index+1]
+        # else:
+        #     path = '{}/{}.{}'.format(self.path, filename, filetype)
+        return path

netsim_wrapper/utils.py

@@ -0,0 +1,43 @@
+from logging import INFO
+from collections import OrderedDict
+from yaml import add_representer, dump, load, FullLoader
+
+from .system import System
+
+
+class Yaml(System):
+    def __init__(self, level=INFO) -> None:
+        super(Yaml, self).__init__(level=level)
+        self.log.debug(f"base class: {__class__.__name__} initialize")
+        self._setup_yaml
+
+    @property
+    def _setup_yaml(self):
+        represent_dict_order = lambda self, data: \
+        self.represent_mapping(
+            'tag:yaml.org,2002:map', 
+            data.items()
+        )
+        add_representer(OrderedDict, represent_dict_order)
+
+    def load(self, fpath):
+        data = None
+        try:
+            self.log.debug(f"base class: {__class__.__name__}.{__class__.__module__}")
+            with open(fpath) as f:
+                data = load(f, Loader=FullLoader)
+        except EnvironmentError as e:
+            self.log.error("error while loading the file {}".format(fpath))
+            self.log.error(e)
+        return data
+
+    def dump(self, fpath, template):
+        try:
+            self.log.debug(f"base class: {__class__.__name__}.{__class__.__module__}")
+            with open(fpath, 'w') as f:
+                dump(template, f, sort_keys=False)
+                self.log.info("please, find the file in: {}".format(fpath))
+        except EnvironmentError as e:
+            self.log.error("error while createing of template")
+            self.log.error(e)
+