test: Adds in inital testing framework, coverage, pep-8 linting, and BDD-style testing

fix #12, fix #33

Author: JasonYao

.travis.yml

@@ -27,6 +27,8 @@ before_script:
 script:
   # Runs through the test suite
   - bin/lint
+  - pip install -e .
+  - pytest --pep8 --cov=pydotfiles tests/ --cov-fail-under=10
 
 after_success:
   - bin/generate-release
@@ -37,6 +39,7 @@ deploy:
   user: "JasonYao"
   password:
     secure: 0g/tLWbYAb9JrqKds8qqFuYk55o9su4aSr27iKXEDVaCsiFWLKcanB3tgCE/TkM/M6+2CCJXWcxRqpwoUkGgkBKOus1nNDYymEo7TTpmGWMx93oJAU6XU1YK+z46EX8QbkmVIAA33qe7NeB9liDfXE0m1Od7t58kqbIjXxla37DRIxpdEQR/r8yhu8y6AydbxS5rL0qDASb3LunB/sJvfaPRfyPYG0tf/IYazGDFR+v2BPpSXYLOtToGop+3UtChH71K4v8F8K9xoVLGab856DbolUXgNN4jn8HdzRwShgLqNpoWY8lPLc6rY6ANf217zWvGJCcEudyCYAGasFFG22V4Almqsca5ltHDFH6nBqDlVtRhaNkeyU+6gh7jTW2h0HPOwQivh/oPz334RNft7RIoI+ydgWVtfoU9UmqNBmtxDCII+mWKRcBND68mXppCOIiBYbPJQmb9bT7k5oLvAnGqd9zuH30ZhGqHkxTPAmd7tZx791v46yT0bAXeS7jS7Tpg1k+TS/wfo6nrVz7+t1EI5HOkD9ptZiWGVORD+V7JPO53efazaVvG6H3U82QPTWVNg9SNaFdEUvUWBzPQlXKVvC5tio6hQc+obUYnxudXZJb7Sp5yVGouJzwskFn/3T9gxTMn6vtQZ8rc4gdqpyNBi65oudT5cIL9CVQ81I0=
+  # We want both source code and binary releases
   distributions: "sdist bdist_wheel"
 
   # We want to use the existing build

bin/install_dependencies

@@ -7,8 +7,8 @@ set -e
 # Installs required dependencies
 ##
 
-# Linting dependency (should have been in dev but it doesn't work)
-pip3 install autopep8
+# Linting/testing dependencies (should have been in dev but it doesn't work)
+pip3 install autopep8 pytest pytest-pep8 pytest-cov
 
 # Automatic semantic release plugin
 npm install -g semantic-release               \

pydotfiles/api/__init__.py

@@ -27,7 +27,7 @@ def dispatch(self):
         valid_commands = ['download', 'install', 'uninstall', 'update', 'clean', 'set']
         parser = argparse.ArgumentParser(formatter_class=argparse.RawDescriptionHelpFormatter, description="""
         Python Dotfiles Manager, enabling configuration-based management of your system!
-        
+
         Commands:
           - download: Downloads your dotfiles onto your computer
           - install: Installs all/part of your dotfiles
@@ -50,7 +50,7 @@ def dispatch(self):
     def download(self, command_arguments):
         help_description = f"""
         Downloads the dotfiles config repo if it hasn't been cloned to local.
-    
+
         Pydotfiles's configuration is setup in a fallthrough manner:
             - Command-line arguments passed in override all other configs, and will be persisted in $HOME/.pydotfiles/config.json
             - Any non-overridden arguments is then configured from: $HOME/.pydotfiles/config.json (if it exists)
@@ -143,7 +143,7 @@ def update(self, command_arguments):
     def clean(self, command_arguments):
         help_description = f"""
         Deletes either the pydotfiles cache or the downloaded local dotfiles config repo
-        
+
         Possible choices:
             - cache: Deletes everything in the pydotfiles cache directory ({os.path.expanduser(PYDOTFILES_CACHE_DIRECTORY)})
             - repo: Deletes everything in the locally downloaded dotfiles configuration directory ({DEFAULT_PYDOTFILES_CONFIG_LOCAL_DIRECTORY})

pydotfiles/models/primitives.py

@@ -68,18 +68,30 @@ def do(self):
         logger.debug(f"File Action: Successful action [action={self.action}, origin={self.origin}, destination={self.destination}, use_sudo={self.run_as_sudo}]")
 
     def undo(self):
-        logger.debug(f"File Action: Starting action [action={self.reverse_action}, file={self.destination}, use_sudo={self.run_as_sudo}]")
+        logger.debug(f"File Action: Starting undo action [action={self.reverse_action}, file={self.destination}, use_sudo={self.run_as_sudo}]")
+
+        if self.destination is None:
+            logger.info(f"File Action: No reverse action required [action={self.reverse_action}], file={self.destination}, use_sudo={self.run_as_sudo}")
+            return
 
         if self.action == FileActionType.COPY:
+            if not os.path.isfile(self.destination):
+                logger.info(f"File Action: No reverse action required [action={self.reverse_action}], file={self.destination}, use_sudo={self.run_as_sudo}")
+                return
+
             rm_file(self.destination, self.run_as_sudo, self.sudo_password)
         elif self.action == FileActionType.SYMLINK:
-            unsymlink_file(self.origin, self.destination, self.run_as_sudo, self.sudo_password)
+            if not os.path.islink(self.destination):
+                logger.info(f"File Action: No reverse action required [action={self.reverse_action}], file={self.destination}, use_sudo={self.run_as_sudo}")
+                return
+
+            unsymlink_file(self.destination, self.run_as_sudo, self.sudo_password)
         elif self.action == FileActionType.SCRIPT:
             run_file(self.destination, self.run_as_sudo, self.sudo_password)
         else:
             raise NotImplementedError(f"File Action: The undo action `{self.action}` is not supported yet (feel free to open a ticket on github!)")
 
-        logger.debug(f"File Action: Successful action [action={self.reverse_action}, file={self.destination}, use_sudo={self.run_as_sudo}]")
+        logger.debug(f"File Action: Successful undo action [action={self.reverse_action}, file={self.destination}, use_sudo={self.run_as_sudo}]")
 
     def overwrite(self):
         # Just deletes the destination and then re-runs the operation

pydotfiles/utils/io.py

@@ -14,6 +14,18 @@
 
 
 def mv_file(origin, destination, use_sudo=False, sudo_password=""):
+    # Fast fail if invalid origin/destinations passed in
+    if origin is None or destination is None:
+        raise RuntimeError(f"File Moving: Invalid file paths passed in [origin={origin}, destination={destination}]")
+
+    # Fast return if there is no need for the operation
+    if is_moved(origin, destination):
+        return
+
+    # Fail fast if a destination file already exists
+    if os.path.isfile(destination) or os.path.islink(destination):
+        raise RuntimeError(f"File Moving: Destination file already exists [origin={origin}, destination={destination}]")
+
     if use_sudo:
         command = f"mv {origin} {destination}"
         process = subprocess.Popen(['sudo', '-S'] + command.split(), stdin=subprocess.PIPE, stderr=subprocess.PIPE, universal_newlines=True)
@@ -34,6 +46,10 @@ def mv_file(origin, destination, use_sudo=False, sudo_password=""):
 
 
 def rm_file(file, use_sudo=False, sudo_password=""):
+    # Fast fail if invalid file is passed in
+    if file is None:
+        raise RuntimeError(f"File Removing: Invalid file passed in [file={file}]")
+
     # Fast return if there is no need for the operation
     if not os.path.isfile(file) and not is_broken_link(file):
         return
@@ -55,10 +71,18 @@ def rm_file(file, use_sudo=False, sudo_password=""):
 
 
 def copy_file(origin, destination, use_sudo=False, sudo_password=""):
+    # Fast fail if invalid origin/destinations passed in
+    if origin is None or destination is None:
+        raise RuntimeError(f"File Copying: Invalid symlinking file paths passed in [origin={origin}, destination={destination}]")
+
     # Fast return if there is no need for the operation
     if is_copied(origin, destination):
         return
 
+    # Fast fail if the file already exists
+    if os.path.isfile(destination) or os.path.islink(destination):
+        raise RuntimeError(f"File Copying: Destination file already exists [origin={origin}, destination={destination}]")
+
     if use_sudo:
         command = f"cp {origin} {destination}"
         process = subprocess.Popen(['sudo', '-S'] + command.split(), stdin=subprocess.PIPE, stderr=subprocess.PIPE, universal_newlines=True)
@@ -79,10 +103,18 @@ def copy_file(origin, destination, use_sudo=False, sudo_password=""):
 
 
 def symlink_file(origin, destination, use_sudo=False, sudo_password=""):
+    # Fast fail if invalid origin/destinations passed in
+    if origin is None or destination is None:
+        raise RuntimeError(f"File Symlinking: Invalid symlinking file paths passed in [origin={origin}, destination={destination}]")
+
     # Fast return if there is no need for the operation
     if is_linked(origin, destination):
         return
 
+    # Fast fail if the file already exists
+    if os.path.isfile(destination) or os.path.islink(destination):
+        raise RuntimeError(f"File Symlinking: Destination file already exists [origin={origin}, destination={destination}]")
+
     if use_sudo:
         command = f"ln -s {origin} {destination}"
         process = subprocess.Popen(['sudo', '-S'] + command.split(), stdin=subprocess.PIPE, stderr=subprocess.PIPE, universal_newlines=True)
@@ -102,38 +134,34 @@ def symlink_file(origin, destination, use_sudo=False, sudo_password=""):
         os.symlink(origin, destination)
 
 
-def unsymlink_file(origin, destination, use_sudo=False, sudo_password=""):
-    # Fast return if there is no need for the operation
-    if not is_linked(origin, destination):
-        return
+def unsymlink_file(file, use_sudo=False, sudo_password=""):
+    # Fast fail if invalid file name or type passed in
+    if file is None or not os.path.islink(file):
+        raise RuntimeError(f"File Unsymlinking: File does not exist or is a symlink [file={file}]")
 
     if use_sudo:
-        command = f"unlink {destination}"
+        command = f"unlink {file}"
         process = subprocess.Popen(['sudo', '-S'] + command.split(), stdin=subprocess.PIPE, stderr=subprocess.PIPE, universal_newlines=True)
 
         try:
             stdout, stderr = process.communicate(sudo_password + '\n', timeout=3)
 
             if "File exists" in stderr:
-                raise FileExistsError(f"The file {destination} already exists")
+                raise FileExistsError(f"The file {file} already exists")
 
             if process.returncode != 0:
                 raise RuntimeError(stderr)
         except subprocess.TimeoutExpired:
             process.kill()
             raise
     else:
-        os.unlink(destination)
+        os.unlink(file)
 
 
 def run_file(file, use_sudo=False, sudo_password=""):
-    # Fast return if there is no file
-    if file is None:
-        return
-
-    # Fast fail if the file can't be executed
-    if not is_executable(file):
-        raise RuntimeError(f"File Execution: File does not have execution permissions [file={file}]")
+    # Fast fail if there is no file or the file can't be executed
+    if file is None or not is_executable(file):
+        raise RuntimeError(f"File Execution: File does not exist or have execution permissions [file={file}]")
 
     if use_sudo:
         command = f"{file}"
@@ -159,6 +187,17 @@ def run_file(file, use_sudo=False, sudo_password=""):
 """
 
 
+def is_moved(origin, destination):
+    # Enables fast-failing based on existence
+    if not os.path.isfile(destination):
+        return False
+
+    if os.path.isfile(origin):
+        return False
+
+    return True
+
+
 def is_broken_link(file):
     return os.path.islink(file) and not os.path.exists(file)
 
@@ -168,6 +207,10 @@ def is_linked(origin, destination):
 
 
 def is_copied(origin, destination):
+    # Enables fast-failing based on type
+    if os.path.islink(destination):
+        return False
+
     # Enables fast-failing based on existence
     if not os.path.isfile(destination):
         return False

setup.cfg

@@ -0,0 +1,3 @@
+; E501 gets rid of the rule about character length on a line
+[tool:pytest]
+pep8ignore = E501

setup.py

@@ -66,7 +66,7 @@
             # Tests
             'pyest',
             'pytest-pep8',
-            'pytest-cov'
+            'pytest-cov',
         ],
         'release': [
             'wheel',