more minor tweaks

miniConfigApply.py

@@ -1,18 +1,25 @@
 #!/usr/bin/env python3
-# miniConfig
-# A very simple config management system
+"""
+miniConfig
+A very simple config management system
+"""
 
 import os
 import sys
 import json
 import hashlib
-from pprint import pprint
 from pssh.clients.native import ParallelSSHClient
 from gevent import joinall
 from pssh.utils import enable_host_logger
 enable_host_logger()
 
 class MiniConfig():
+    """
+    miniConfig is a python3 based minimal config management
+    that focuses mainly on add/removing files and packages.
+    miniConfig runs ssh in parallel to allow the management
+    of multiple nodes.
+    """
     hosts = []
     pkgs = []
     files = {}
@@ -33,8 +40,11 @@ class MiniConfig():
         self.file_path = self.role_path + '/' + defaultFiledir
 
     def config_parser(self):
-        with open(self.config_path) as f:
-            data = json.load(f)
+        """
+        Parses config.json and creates dict of config vars
+        """
+        with open(self.config_path) as config_file:
+            data = json.load(config_file)
             self.hosts.append(data['hosts'])
             self.pkgs.append(data['packages'][0])
             self.files = data['files']
@@ -42,7 +52,9 @@ class MiniConfig():
         return data
 
     def apply_config(self):
-        # Parse config.json
+        """
+        Apply provided config.json
+        """
         config = self.config_parser()
         # start ssh session
         self.client = ParallelSSHClient(self.hosts[0], user=self.ssh_user, password=self.ssh_pass)
@@ -65,7 +77,10 @@ class MiniConfig():
         if len(self.cmds) != 0:
             self.run_cmd(self.cmds)
 
-    def run_cmd(self, cmds=[]):
+    def run_cmd(self, cmds):
+        """
+        Run commands on remote machine(s)
+        """
         for cmd in cmds[0]:
             run_command = self.client.run_command(cmd, sudo=True)
             self.client.join(run_command, consume_output=True)
@@ -76,47 +91,59 @@ class MiniConfig():
                     print('[%s] Ran [ %s ]' % (host, cmd))
 
 
-    def add_package(self, pkgs=[]):
-        for pk in pkgs:
-            verify = self.client.run_command('apt list --installed | grep '+ pk + '/', sudo=True)
+    def add_package(self, pkgs):
+        """
+        Add packages provided on config.json
+        """
+        for pk_ in pkgs:
+            verify = self.client.run_command('apt list --installed | grep '+ pk_ + '/', sudo=True)
             self.client.join(verify, consume_output=False)
             for host, host_output in verify.items():
                 if host_output.exit_code != 0:
-                    print('[%s] %s not installed' % (host, pk))
+                    print('[%s] %s not installed' % (host, pk_))
                     install = ParallelSSHClient([host], user=self.ssh_user, password=self.ssh_pass)
-                    output = install.run_command('apt install -y ' + pk, sudo=True)
+                    output = install.run_command('apt install -y ' + pk_, sudo=True)
                     self.client.join(output, consume_output=True)
-                    for host, host_output in output.items():
-                        print('[%s] Installing %s' % (host, pk))
-                        if host_output.exit_code != 0:
-                            print('[%s] Error installing %s' % (host, pk))
+                    for host_, host_output_ in output.items():
+                        print('[%s] Installing %s' % (host_, pk_))
+                        if host_output_.exit_code != 0:
+                            print('[%s] Error installing %s' % (host_, pk_))
                         else:
-                            print('[%s] %s installed' % (host, pk))
+                            print('[%s] %s installed' % (host_, pk_))
                 else:
-                    print('[%s] %s already installed. Nothing to do!' % (host, pk))
+                    print('[%s] %s already installed. Nothing to do!' % (host, pk_))
 
-    def rm_package(self, pkgs=[]):
-        for pk in pkgs:
+    def rm_package(self, pkgs):
+        """
+        Removes packes provided by config.json
+        """
+        for pk_ in pkgs:
             # Check if package is installed
-            verify = self.client.run_command('apt list --installed | grep '+ pk + '/', sudo=True)
+            verify = self.client.run_command('apt list --installed | grep '+ pk_ + '/', sudo=True)
             self.client.join(verify, consume_output=False)
             for host, host_output in verify.items():
                 if host_output.exit_code == 0:
                     # Try removing package since we found a ref of it with apt list
-                    print('[%s] %s installed on system' % (host, pk))
+                    print('[%s] %s installed on system' % (host, pk_))
                     remove = ParallelSSHClient([host], user=self.ssh_user, password=self.ssh_pass)
-                    output = remove.run_command('apt remove --purge -y ' + pk, sudo=True)
+                    output = remove.run_command('apt remove --purge -y ' + pk_, sudo=True)
                     self.client.join(output, consume_output=True)
-                    for host, host_output in output.items():
-                        print('[%s] Removing %s' % (host, pk))
-                        if host_output.exit_code != 0:
-                            print('[%s] Error removing %s' % (host, pk))
+                    for host_, host_output_ in output.items():
+                        print('[%s] Removing %s' % (host_, pk_))
+                        if host_output_.exit_code != 0:
+                            print('[%s] Error removing %s' % (host_, pk_))
                         else:
-                            print('[%s] %s removed' % (host, pk))
+                            print('[%s] %s removed' % (host_, pk_))
                 else:
-                    print('[%s] %s not installed. Nothing to do' % (host, pk))
+                    print('[%s] %s not installed. Nothing to do' % (host, pk_))
 
-    def add_file(self, file={}):
+    def add_file(self, file):
+        """
+        Adds files defined under config.json
+        Files are copied over from roles/$role_name/files dir
+        First we check if the file is in the remote system
+        A md5sum hash is compared to see if the file has change
+        """
         local_file_path = self.file_path + '/' + file['name']
         remote_file_path = file['path'] + '/' + file['name']
         # Get local md5hash to compare with remote file
@@ -182,6 +209,9 @@ class MiniConfig():
 
 
     def rm_file(self, file={}):
+        """
+        Removes files provided in config.json
+        """
         remote_file_path = file['path'] + '/' + file['name']
         # Stat the file to make sure is there before attempting to remove
         verify = self.client.run_command('/usr/bin/stat -t ' + remote_file_path, sudo=True)
@@ -199,8 +229,11 @@ class MiniConfig():
             else:
                 print('[%s] %s not on system. Nothing to do!' % (host, remote_file_path))
 
-if len(sys.argv) == 1:
-    print("Missing role name. Please provide role to apply")
-for i in range(1, len(sys.argv)):
-    t = MiniConfig(sys.argv[i])
-    t.apply_config()
+
+if __name__ == "__main__":
+
+    if len(sys.argv) == 1:
+        print("Missing role name. Please provide role to apply")
+    for i in range(1, len(sys.argv)):
+        t = MiniConfig(sys.argv[i])
+        t.apply_config()