initial refactor

Author: kirankotari

.version

@@ -1 +1 @@
-3.1.2
+4.0

README.md

@@ -1,12 +1,16 @@
 # Netsim Wrapper
 
+## TODO: need to update badges
+
 [![License: Apache 2.0](https://img.shields.io/badge/License-Apache2-yellow.svg)](https://opensource.org/licenses/Apache-2.0)
 [![Version: 3.1.2](https://img.shields.io/badge/Version-3.1.2-parrotgreen.svg)](https://github.com/NSO-developer/netsim-wrapper)
 [![Downloads](https://pepy.tech/badge/netsim-wrapper)](https://pepy.tech/project/netsim-wrapper)
 [![Downloads](https://pepy.tech/badge/netsim-wrapper/week)](https://pepy.tech/project/netsim-wrapper/week)
 
 ncs-netsim is a great tool, but it lack of following features which are developed as part of netsim-wrapper
 
+## TODO: changing options
+
 - netsim-wrapper features  
   - delete-devices \<device-names>
   - create-network-from [ yaml | json ] \<filename>

templates/create_device_from.json …amples-templates/create_device_from.jsontemplates/create_device_from.json renamed to examples-templates/create_device_from.json templates/create_device_from.json renamed to examples-templates/create_device_from.json

@@ -0,0 +1,28 @@
+"""
+Application logging operations
+"""
+
+import logging
+
+from .singleton import SingletonMeta
+
+
+class Logger(metaclas=SingletonMeta):
+    """
+    Logger with singleton metaclass
+    """
+    format = '%(levelname)-8s | %(asctime)s | %(module)-8s:%(lineno)-4d | %(message)s'
+    log = logging.getLogger()
+
+    def __init__(self, level=logging.INFO) -> None:
+        self.level = level
+        self.log = self.get_log
+
+    @property
+    def get_log(self):
+        """
+        Fetching logger with logging level
+        """
+        logging.basicConfig(level=self.level, format=format)
+        return logging.getLogger()
+

templates/create_device_from.yaml …amples-templates/create_device_from.yamltemplates/create_device_from.yaml renamed to examples-templates/create_device_from.yaml templates/create_device_from.yaml renamed to examples-templates/create_device_from.yaml

@@ -0,0 +1,15 @@
+"""
+Singleton Metaclass
+"""
+
+class SingletonMeta(type):
+    """
+    Singleton Metaclass
+    """
+
+    _instance = None
+
+    def __call__(cls, *args, **kwargs):
+        if not cls._instance:
+            cls._instance = super().__call__(*args, **kwargs)
+        return cls._instance

templates/create_network_from.json …mples-templates/create_network_from.jsontemplates/create_network_from.json renamed to examples-templates/create_network_from.json templates/create_network_from.json renamed to examples-templates/create_network_from.json

@@ -1,58 +1,70 @@
 """
-The module is for system operations exit, unlink and setting logger
+The module is for system operations exit, unlink
 """
 
-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()
+from .log import Logger
 
 
 class System:
-    def __init__(self, path='.', level=logging.INFO) -> None:
+    def __init__(self) -> None:
         super(System, self).__init__()
-        self.log = get_log(level)
-        self.log.debug(f"base class: {__class__.__name__} initialize")
-        self.path = Path(path).absolute()
+        self.log = Logger().log
+        self.log.debug("class: {} initialize".format(__class__.__name__))
 
     @property
     def exit(self):
+        self.log.debug('exit method called')
         sys_exit()
 
     def delete(self, fpath):
+        """
+        Delete file if exist
+        """
         path = Path(fpath).absolute()
         if path.exists():
             path.unlink()
+            self.log.debug('deleted file: {}'.format(fpath))
 
     def is_file(self, fpath):
+        """
+        Given path is it a file
+        """
         path = Path(fpath).absolute()
         return path.is_file()
 
     def is_dir(self, fpath):
+        """
+        Given path is it a folder
+        """
         path = Path(fpath).absolute()
         return path.is_dir()
 
     def call(self, cmd):
+        """
+        System subprocess call
+        """
         try:
+            self.log.debug("call cmd: {}".format(' '.join(cmd)))
             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):
+        """
+        System subprocess open and communicate
+        """
+        self.log.debug("popen cmd: {}".format(' '.join(cmd)))
         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)))
+            self.log.debug("out: {}".format(out))
             return out
         if error:
             self.log.error("an error occured while running command `{}`".format(' '.join(cmd)))