Initial commit. Probably not ready for packaging yet

Author: Chris Hirsch

CHANGES.txt

@@ -0,0 +1,8 @@
+======================================
+Changes for robotframework-unixfilesystem
+======================================
+
+2015/08/25 0.0.1
+================
+
+ - initial version

MANIFEST.in

@@ -0,0 +1 @@
+include README.rst

README.rst

@@ -0,0 +1,111 @@
+==========================
+robotframework-unixfilesystem
+==========================
+
+**robotframework-unixfilesystem** is a `Robot Framework
+<http://code.google.com/p/robotframework/>`_ test library to test
+UNIX filesystem attributes like permissions, ownership etc.
+
+Installation
+++++++++++++
+
+To install, just fetch the latest version from PyPI:.
+
+    pip install --upgrade robotframework-unixfilesystem
+
+Usage
++++++
+
+Setup in the robotframework Settings section:
+
+============  ================
+  Setting          Value
+============  ================
+Library          UnixFilesystemLibrary
+============  ================
+
+\
+
+These keyword actions are available::
+
+    Get Owner From Path:
+        Does an lstat on the Path and returns the owner of the file/directory:
+    
+        Arguments:
+            - path:      the path to the file/directory you wish to get ownership on (e.g. /tmp/test.txt or ../foo)
+        Return:
+            - owner:     returns the owner of the file (e.g. root or chris)
+
+    Owner From Path Should Match:
+        Does an lstat on the Path and checks to see if the supplied owner matches.
+        Returns True if a match is found or False otherwise.
+        
+        Arguments:
+            - owner:     the username to check against ownership of the path (e.g. root or chris)
+            - path:      the path to the file/directory you wish to get ownership on (e.g. /tmp/test.txt or ../foo)
+        Return:
+            - returns True if the owner of the Path matches Owner, False otherwise
+
+    Get Permissions From Path As Octal
+        Gets the permissions via lstat of the supplied Path and returns those permissions as 
+        an octal value.
+
+        Arguments:
+            - path:      the path to the file/directory you wish to get ownership on (e.g. /tmp/test.txt or ../foo)
+        Return:
+            - permissions: Returns the octal permissions of the path (e.g. 0755 or 0644)
+
+    Permissions From Path Should Match:
+        Gets the permissions via lstat of the supplied Path and checks if those permissions
+        match the supplied Permissions.
+        Returns True if a match is found or False otherwise.
+
+        Arguments:
+            - path:      the path to the file/directory you wish to get ownership on (e.g. /tmp/test.txt or ../foo)
+            - permissions: octal permissions (e.g. 0755 or 0644)
+        Return:
+            - returns True if the owner of the Path matches Permissions, False otherwise
+
+
+
+Here is an example of how to use the library:
+
+==================  ==========================  ===================================  
+ Action             Argument                    Argument                            
+==================  ==========================  ===================================
+${Owner}=           Get Owner From Path         path=/tmp/test.txt
+Should Match        ${Owner}                    root
+==================  ==========================  =================================== 
+
+Here is an example of how to check that the owner of a path matches the supplied owner
+
+============================ ==========================  ===================================  
+ Action                      Argument                    Argument                             
+============================ ==========================  =================================== 
+Owner From Path Should Match root                        path=/tmp/text.txt
+============================ ==========================  =================================== 
+
+Here is an example of how to get permissions from the path as an octal
+
+================== ================================== ===================================  
+ Action            Argument                           Argument                            
+================== ================================== ===================================
+${Permissions}     Get Permissions From Path as Octal path=/tmp/
+Should Match       ${Permissions}                     0644
+================== ================================== ===================================
+
+Here is an example of how to check that permissions from the path match the octal
+
+================================== ==========================         
+ Action                            Argument                          
+================================== ==========================       
+Permissions From Path Should Match 0644
+================================== ==========================       
+
+
+
+License
++++++++
+
+The robotframework-unixfilesystem is licensed under the `Apache 2.0 License
+<http://www.apache.org/licenses/LICENSE-2.0.html>`_.

setup.py

@@ -0,0 +1,33 @@
+#!/usr/bin/env python
+
+from os.path import join, dirname
+
+execfile(join(dirname(__file__), 'src', 'UnixFilesystemLibrary', 'version.py'))
+
+from distutils.core import setup
+
+CLASSIFIERS = """
+Programming Language :: Python
+Topic :: Software Development :: Testing
+"""[1:-1]
+
+long_description=open(join(dirname(__file__), 'README.rst',)).read()
+
+setup(
+  name             = 'robotframework-unixfilesystemlibrary',
+  version          = VERSION,
+  description      = 'Robot Framework UNIX Filesystem Library',
+  long_description = long_description,
+  author           = 'Chris Hirsch',
+  author_email     = '[email protected]',
+  url              = 'https://github.com/ChrisHirsch/robotframework-unixfilesystem',
+  license          = 'Apache License 2.0',
+  keywords         = 'robotframework testing testautomation unix filesystem attributes',
+  platforms        = 'any',
+  zip_safe         = False,
+  classifiers      = CLASSIFIERS.splitlines(),
+  package_dir      = {'' : 'src'},
+  install_requires = ['robotframework'],
+  extras_require = dict(test=['zope.testing']),
+  packages         = ['UnixFilesystemLibrary'],
+)

src/UnixFilesystemLibrary/__init__.py

@@ -0,0 +1,78 @@
+import os
+import pwd
+
+from robot.api import logger
+
+THIS_DIR = os.path.dirname(os.path.abspath(__file__))
+execfile(os.path.join(THIS_DIR, 'version.py'))
+
+__version__ = VERSION
+
+
+class UnixFilesystemLibrary(object):
+
+    ROBOT_LIBRARY_VERSION = VERSION
+    ROBOT_LIBRARY_SCOPE = 'GLOBAL'
+
+    def get_uid_from_path(self, path):
+        """
+        Return the UNIX User ID of the path
+        """
+        logger.debug("HERE!")
+        if not os.path.exists(path):
+            raise Exception('Could not open file ' + path)
+        return os.stat(path).st_uid
+
+    def get_owner_from_path(self, path):
+        """
+        Return the owner (name) of the path
+        """
+        logger.debug("get_owner_from_path")
+        hope = self.get_uid_from_path(path)
+        logger.debug("hope=" + str(hope))
+        morehope = pwd.getpwuid(hope)
+        logger.debug("morehope=" + str(morehope))
+
+        return str(morehope.pw_name)
+
+    def owner_from_path_should_match(self, owner, path):
+        """
+        Return True if the owner matches user name of the path
+        """
+        path_owner = self.get_owner_from_path(path)
+        logger.debug("path_owner=" + str(path_owner))
+        logger.debug("I return this=" + str(owner == path_owner))
+
+        return owner == path_owner
+
+    def get_permissions_from_path_as_octal(self, path):
+        """
+        Returns the octal values of the path
+        """
+        info = os.lstat(path)
+        logger.debug("info=" + str(info))
+        myoct = oct(info.st_mode & 0777)
+        logger.debug("oct info=" + str(myoct))
+        return str(myoct)
+
+    def get_permissions_from_path_as_list(self, path):
+        """
+        Returns a list of modes from the lstat
+        """
+        raise NotImplementedError("Sorry, we currently don't support \
+                                  permissions as a list. Feel free to implement\
+                                  and submit a pull request")
+
+    def permissions_from_path_should_match(self, path, mode):
+        """
+        Returns True if the the octal values of the path mactches the mode. ie '0755'
+        """
+        info = os.lstat(path)
+        logger.debug("info=" + str(info))
+        myoct = oct(info.st_mode & 0777)
+        logger.debug("oct info=" + str(myoct))
+        logger.debug("mode =" + mode)
+        return str(myoct) == str(mode)
+
+
+

src/UnixFilesystemLibrary/version.py

@@ -0,0 +1 @@
+VERSION = '0.0.1'