updating readme + pylint recomendations

.travis.yaml

@@ -0,0 +1,8 @@
+language: python
+python:
+  - 3.7
+install:
+  - pip install -r requirements.txt
+  - pip install pylint
+script: 
+  - pylint miniConfigApply.py

README.md

@@ -13,7 +13,7 @@ pip3 install parallel-ssh
 
 ## Usage
 
-miniConfig works of config.json files which are under a "role" directory. The following directory structure should be followed:
+miniConfig uses configurations files (`config.json`) under a "role" directory to apply config changes to remote host. The following directory structure should be followed:
 ```
 ── roles
     ├── role-config-1
@@ -27,6 +27,21 @@ ── roles
             └── index.php
 ```
 
+## Auth
+The user and password for ssh can be configure by setting the following environment variables:
+
+- miniConfigUser
+```
+export miniConfigUser='r00t'
+```
+
+- miniConfigPass
+```
+export miniConfigPass='p@ssw0rd'
+```
+
+
+
 ## config.json
 
 Config files tell miniConfig what to do. Each role directory should have a `config.json` file. 
@@ -105,7 +120,9 @@ When using the `service_notify` key make sure to include the actual service name
 
 
 
-## Logging 
+## Applying configurations
+Run `miniConfigApply.py` `$rolename` 
+
 miniConfig writes its log to stdout.
 ```
 $ ./miniConfigApply.py webserver

miniConfigApply.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-# miniConfig 
+# miniConfig
 # A very simple config management system
 
 import os
@@ -12,25 +12,28 @@ from gevent import joinall
 from pssh.utils import enable_host_logger
 enable_host_logger()
 
-class miniConfig():
+class MiniConfig():
     hosts = []
     pkgs = []
     files = {}
     cmds = []
-    ssh_user = 'root'
+    try:
+        ssh_user = os.environ['miniConfigUser']
+    except KeyError:
+        raise KeyError("SSH USER VARIABLE [miniConfigUser] NOT SET.")
     try:
         ssh_pass = os.environ['miniConfigPass']
     except KeyError:
         raise KeyError("SSH PASSWORD VARIABLE [miniConfigPass] NOT SET.")
-    
+
     def __init__(self, role, defaultConfigFile='config.json', defaultFiledir='files/'):
         self.role = role
-        self.rolePath = './roles/' + role
-        self.configPath = self.rolePath + '/' + defaultConfigFile
-        self.filePath = self.rolePath + '/' + defaultFiledir
+        self.role_path = './roles/' + role
+        self.config_path = self.role_path + '/' + defaultConfigFile
+        self.file_path = self.role_path + '/' + defaultFiledir
 
-    def configParser(self):
-        with open(self.configPath) as f:
+    def config_parser(self):
+        with open(self.config_path) as f:
             data = json.load(f)
             self.hosts.append(data['hosts'])
             self.pkgs.append(data['packages'][0])
@@ -38,42 +41,42 @@ class miniConfig():
             self.cmds.append(data['commands'])
         return data
 
-    def applyConfig(self):
+    def apply_config(self):
         # Parse config.json
-        config = self.configParser()
+        config = self.config_parser()
         # start ssh session
         self.client = ParallelSSHClient(self.hosts[0], user=self.ssh_user, password=self.ssh_pass)
         # START OF APPLY
         # add/rm packages, if listed in config
         if 'add' in self.pkgs[0]:
-            self.addPackage(self.pkgs[0]['add'])
+            self.add_package(self.pkgs[0]['add'])
         if 'remove' in self.pkgs:
-            self.rmPackage(self.pkgs[0]['remove'])
+            self.rm_package(self.pkgs[0]['remove'])
         # add/rm files, if listed in config
         if len(self.files) != 0:
             for file in self.files:
                 if file['action'] == 'add':
-                    self.addFile(file)
-                elif file['action'] == 'remove' :
-                    self.rmFile(file)
+                    self.add_file(file)
+                elif file['action'] == 'remove':
+                    self.rm_file(file)
                 else:
-                    raise ValueError('UNKNOWN ACTION. Only "'"add"'" or "'"remove"'" are supported actions')
+                    raise ValueError('UNKNOWN ACTION. Only [add] or [remove] are supported actions')
         # Run commands found in config
-        if len(self.cmds) !=0:
-            self.runCmd(self.cmds)
-        
-    def runCmd(self, cmds=[]):
+        if len(self.cmds) != 0:
+            self.run_cmd(self.cmds)
+
+    def run_cmd(self, cmds=[]):
         for cmd in cmds[0]:
-            run_cmd = self.client.run_command(cmd, sudo=True)
-            self.client.join(run_cmd, consume_output=True)
-            for host, host_output in run_cmd.items():
+            run_command = self.client.run_command(cmd, sudo=True)
+            self.client.join(run_command, consume_output=True)
+            for host, host_output in run_command.items():
                 if host_output.exit_code != 0:
                     print('[%s] Error running: [ %s ]' % (host, cmd))
                 else:
                     print('[%s] Ran [ %s ]' % (host, cmd))
-                 
 
-    def addPackage(self, pkgs=[]):
+
+    def add_package(self, pkgs=[]):
         for pk in pkgs:
             verify = self.client.run_command('apt list --installed | grep '+ pk + '/', sudo=True)
             self.client.join(verify, consume_output=False)
@@ -88,13 +91,13 @@ class miniConfig():
                         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))            
-    
-    def rmPackage(self, pkgs=[]):
+                    print('[%s] %s already installed. Nothing to do!' % (host, pk))
+
+    def rm_package(self, pkgs=[]):
         for pk in pkgs:
-            # Check if package is installed 
+            # Check if package is installed
             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():
@@ -113,8 +116,8 @@ class miniConfig():
                 else:
                     print('[%s] %s not installed. Nothing to do' % (host, pk))
 
-    def addFile(self, file={}):
-        local_file_path = self.filePath + '/' + file['name']
+    def add_file(self, file={}):
+        local_file_path = self.file_path + '/' + file['name']
         remote_file_path = file['path'] + '/' + file['name']
         # Get local md5hash to compare with remote file
         hasher = hashlib.md5()
@@ -178,9 +181,9 @@ class miniConfig():
                 print('[%s] %s already on system/checksum match local file' % (host, remote_file_path))
 
 
-    def rmFile(self, file={}):
+    def rm_file(self, file={}):
         remote_file_path = file['path'] + '/' + file['name']
-        # Stat the file to make sure is there before attempting to remove 
+        # 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)
         self.client.join(verify, consume_output=False)
         for host, host_output in verify.items():
@@ -198,6 +201,6 @@ class miniConfig():
 
 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.applyConfig()
+for i in range(1, len(sys.argv)):
+    t = MiniConfig(sys.argv[i])
+    t.apply_config()

requirements.txt

@@ -0,0 +1,3 @@
+parallel-ssh==1.9.1
+gevent==1.4.0
+

roles/example/files/info.php

@@ -1,5 +1,3 @@
 <?php
-
-header("Content-Type: text/plain");
-
-echo "Hello, world!\n";
+phpinfo();
+?>