fix working_directory creation

fix typos

Author: schlitzered

doc/source/intro.rst

@@ -9,10 +9,8 @@ seemed to be unmaintained, and failed to run under python 3.
 Also the bundled Pidfile implementation was not working anymore, because
 of incompatibilities with newer version of external libraries.
 
-The goal of pep3143daemon was to create a complete, and working PEP 3143
-library, that only depends on Libs that are shipped with python 2 and 3.
-
-For this reason, also a working PidFile class is bundled with this Package.
+The goal of pep3143daemon is to create a complete, and working PEP 3143
+library. For this reason, also a working PidFile class is bundled with this Package.
 
 The tests, written for this package, where implemented, using the Python 3
 unittest framework. I did not spend any time making the tests run on Python 2.
@@ -24,8 +22,8 @@ Patches to make the tests run under python 2.6 / 2.7 are welcome!
 Differences
 -----------
 
-pep3143daemon mostly sticks to the PEP but does not implement
-some details that seem to be misguided.
+pep3143daemon mostly sticks to the PEP, but does not implement
+some details that seem to be wrong.
 The main difference is the DaemonContext.close() method.
 
 The close method of DeamonContext is implemented as a dummy method.
@@ -38,7 +36,7 @@ daemon in a sane way. But worse, removing the PidFile before the daemon is
 terminated, would allow a second instance to start. Which can lead to
 undefined behaviour.
 
-The removal of the PidFile is now implemented in the PidFile class, that is
+The removal of the PidFile is now implemented in the PidFile class,
 distributed with the pep3143daemon package.
 The file will be removed via an atexit call.
 

pep3143daemon/daemon.py

@@ -30,7 +30,7 @@ class DaemonContext(object):
     on the instance.
 
     Altering attributes after open() is called, will have no effect.
-    In future versions, trying to do so, will raise a DaemonError.
+    In future versions, trying to do so, will may raise a DaemonError.
 
     :param chroot_directory:
         Full path to the directory that should be set as effective root
@@ -45,7 +45,7 @@ class DaemonContext(object):
     :type working_directory: str.
 
     :param umask:
-        File access creation mask for this after daemon start
+        File access creation mask for this daemon after start
     :type umask: int.
 
     :param uid:
@@ -63,11 +63,12 @@ class DaemonContext(object):
     :param detach_process:
         If True, do the double fork magic. If the process was started
         by inet or an init like program, you may don´t need to detach.
+        If not set, we try to figure out if forking is needed.
     :type detach_process: bool.
 
     :param files_preserve:
         List of integers, or objects with a fileno method, that
-        represent a files that should not be closed while daemoninzing.
+        represent files that should not be closed while daemoninzing.
     :type files_preserve: list
 
     :param pidfile:
@@ -100,6 +101,7 @@ def __init__(
 
         """
         self._is_open = False
+        self._working_directory = None
         self.chroot_directory = chroot_directory
         self.umask = umask
         self.uid = uid if uid else os.getuid()
@@ -113,11 +115,7 @@ def __init__(
         self.stdin = stdin
         self.stdout = stdout
         self.stderr = stderr
-        if chroot_directory and not \
-                working_directory.startswith(chroot_directory):
-            self.working_directory = chroot_directory + working_directory
-        else:
-            self.working_directory = working_directory
+        self.working_directory = working_directory
 
     def __enter__(self):
         """ Context Handler, wrapping self.open()
@@ -135,7 +133,7 @@ def __exit__(self, exc_type, exc_val, exc_tb):
         self.close()
 
     def _get_signal_handler(self, handler):
-        """ get the callback function for a signal handler
+        """ get the callback function for handler
 
         If the handler is None, returns signal.SIG_IGN.
         If the handler is a string, return the matching attribute of this
@@ -159,7 +157,7 @@ def _files_preserve(self):
         """ create a set of protected files
 
         create a set of files, based on self.files_preserve and
-        self.stdin, self,stdout and self.stderr, that shoud not get
+        self.stdin, self,stdout and self.stderr, that should not get
         closed while daemonizing.
 
         :return: set
@@ -178,7 +176,7 @@ def _files_preserve(self):
     def _signal_handler_map(self):
         """ Create the signal handler map
 
-        create a dictinary with signal:handler mapping based on
+        create a dictionary with signal:handler mapping based on
         self.signal_map
 
         :return: dict
@@ -188,9 +186,28 @@ def _signal_handler_map(self):
             result[signum] = self._get_signal_handler(handler)
         return result
 
-    def close(self):
-        """ Dummy function"""
-        pass
+    @property
+    def working_directory(self):
+        """ The working_directory property
+
+        :return: str
+        """
+        if self.chroot_directory and not \
+                self._working_directory.startswith(self.chroot_directory):
+            return self.chroot_directory + self._working_directory
+        else:
+            return self._working_directory
+
+    @working_directory.setter
+    def working_directory(self, value):
+        """ Set working directory
+
+        New value is ignored if already daemonized.
+
+        :param value: str
+        :return:
+        """
+        self._working_directory = value
 
     @property
     def is_open(self):
@@ -200,6 +217,10 @@ def is_open(self):
         """
         return self._is_open
 
+    def close(self):
+        """ Dummy function"""
+        pass
+
     def open(self):
         """ Daemonize this process
 
@@ -359,7 +380,7 @@ def parent_is_inet():
 
 
 def detach_required():
-    """ Check if detaching is requered
+    """ Check if detaching is required
 
     This is done by collecting the results of parent_is_inet and
     parent_is_init. If one of them is True, detaching, aka the daemoninzing,

setup.py

@@ -4,7 +4,7 @@
 
 setup(
     name='pep3143daemon',
-    version='0.0.1',
+    version='0.0.2',
     description='Implementation of PEP 3143, a unix daemon',
     long_description=pep3143daemon.__doc__,
     packages=['pep3143daemon'],
@@ -28,6 +28,8 @@
     ],
     keywords=[
         'daemon',
+        'daemonize'
+        'daemonizing'
         'fork',
         'pep 3143',
         '3143'

test/unit/test_Daemon.py

@@ -44,29 +44,28 @@ def setUp(self):
         self.addCleanup(patch.stopall)
 
         self.daemoncontext = pep3143daemon.daemon.DaemonContext()
-        self.mockdaemoncontext = Mock()
 
 # Test DaemonContext.__init__()
     def test___init__defaultargs(self):
-        pep3143daemon.daemon.DaemonContext.__init__(self.mockdaemoncontext)
-        self.assertIsNone(self.mockdaemoncontext.files_preserve)
-        self.assertIsNone(self.mockdaemoncontext.chroot_directory)
-        self.assertEqual(self.mockdaemoncontext.working_directory, '/')
-        self.assertEqual(self.mockdaemoncontext.umask, 0)
-        self.assertIsNone(self.mockdaemoncontext.pidfile)
+        pep3143daemon.daemon.DaemonContext.__init__(self.daemoncontext)
+        self.assertIsNone(self.daemoncontext.files_preserve)
+        self.assertIsNone(self.daemoncontext.chroot_directory)
+        self.assertEqual(self.daemoncontext.working_directory, '/')
+        self.assertEqual(self.daemoncontext.umask, 0)
+        self.assertIsNone(self.daemoncontext.pidfile)
         detach_required = pep3143daemon.daemon.detach_required()
-        self.assertEqual(self.mockdaemoncontext.detach_process, detach_required)
+        self.assertEqual(self.daemoncontext.detach_process, detach_required)
         signal_map = pep3143daemon.daemon.default_signal_map()
-        self.assertEqual(self.mockdaemoncontext.signal_map, signal_map)
-        self.assertEqual(self.mockdaemoncontext.uid, self.os_mock.getuid())
+        self.assertEqual(self.daemoncontext.signal_map, signal_map)
+        self.assertEqual(self.daemoncontext.uid, self.os_mock.getuid())
         self.os_mock.getuid.assert_called_with()
-        self.assertEqual(self.mockdaemoncontext.gid, self.os_mock.getgid())
+        self.assertEqual(self.daemoncontext.gid, self.os_mock.getgid())
         self.os_mock.getgid.assert_called_with()
-        self.assertTrue(self.mockdaemoncontext.prevent_core)
-        self.assertIsNone(self.mockdaemoncontext.stdin)
-        self.assertIsNone(self.mockdaemoncontext.stdout)
-        self.assertIsNone(self.mockdaemoncontext.stderr)
-        self.assertFalse(self.mockdaemoncontext._is_open)
+        self.assertTrue(self.daemoncontext.prevent_core)
+        self.assertIsNone(self.daemoncontext.stdin)
+        self.assertIsNone(self.daemoncontext.stdout)
+        self.assertIsNone(self.daemoncontext.stderr)
+        self.assertFalse(self.daemoncontext._is_open)
 
     def test___init__customargs(self):
         files_preserve = Mock()
@@ -84,7 +83,7 @@ def test___init__customargs(self):
         stderr = Mock()
 
         pep3143daemon.daemon.DaemonContext.__init__(
-            self.mockdaemoncontext,
+            self.daemoncontext,
             files_preserve=files_preserve,
             chroot_directory=chroot_directory,
             working_directory=working_directory,
@@ -99,33 +98,33 @@ def test___init__customargs(self):
             stdout=stdout,
             stderr=stderr)
 
-        self.assertEqual(self.mockdaemoncontext.files_preserve, files_preserve)
-        self.assertEqual(self.mockdaemoncontext.chroot_directory, chroot_directory)
-        self.assertEqual(self.mockdaemoncontext.working_directory, working_directory)
-        self.assertEqual(self.mockdaemoncontext.umask, umask)
-        self.assertEqual(self.mockdaemoncontext.pidfile, pidfile)
-        self.assertEqual(self.mockdaemoncontext.detach_process, detach_process)
-        self.assertEqual(self.mockdaemoncontext.signal_map, signal_map)
-        self.assertEqual(self.mockdaemoncontext.uid, uid)
-        self.assertEqual(self.mockdaemoncontext.gid, gid)
-        self.assertEqual(self.mockdaemoncontext.prevent_core, prevent_core)
-        self.assertEqual(self.mockdaemoncontext.stdin, stdin)
-        self.assertEqual(self.mockdaemoncontext.stdout, stdout)
-        self.assertEqual(self.mockdaemoncontext.stderr, stderr)
+        self.assertEqual(self.daemoncontext.files_preserve, files_preserve)
+        self.assertEqual(self.daemoncontext.chroot_directory, chroot_directory)
+        self.assertEqual(self.daemoncontext.working_directory, working_directory)
+        self.assertEqual(self.daemoncontext.umask, umask)
+        self.assertEqual(self.daemoncontext.pidfile, pidfile)
+        self.assertEqual(self.daemoncontext.detach_process, detach_process)
+        self.assertEqual(self.daemoncontext.signal_map, signal_map)
+        self.assertEqual(self.daemoncontext.uid, uid)
+        self.assertEqual(self.daemoncontext.gid, gid)
+        self.assertEqual(self.daemoncontext.prevent_core, prevent_core)
+        self.assertEqual(self.daemoncontext.stdin, stdin)
+        self.assertEqual(self.daemoncontext.stdout, stdout)
+        self.assertEqual(self.daemoncontext.stderr, stderr)
 
     def test___init__chroot_substring_of_workdir(self):
         pep3143daemon.daemon.DaemonContext.__init__(
-            self.mockdaemoncontext,
+            self.daemoncontext,
             working_directory='/foo/bar/baz',
             chroot_directory='/foo/bar')
-        self.assertEqual(self.mockdaemoncontext.working_directory, '/foo/bar/baz')
+        self.assertEqual(self.daemoncontext.working_directory, '/foo/bar/baz')
 
     def test___init__chroot_not_substring_of_workdir(self):
         pep3143daemon.daemon.DaemonContext.__init__(
-            self.mockdaemoncontext,
+            self.daemoncontext,
             working_directory='/baz',
             chroot_directory='/foo/bar')
-        self.assertEqual(self.mockdaemoncontext.working_directory, '/foo/bar/baz')
+        self.assertEqual(self.daemoncontext.working_directory, '/foo/bar/baz')
 
 # Test DaemonContext._exclude_filenos
     def test_exclude_filenos(self):
@@ -141,20 +140,20 @@ def test_exclude_filenos(self):
 # Test DaemonContext._get_signal_handler()
     def test__get_signal_handler_None(self):
         result = pep3143daemon.daemon.DaemonContext._get_signal_handler(
-            self.mockdaemoncontext,
+            self.daemoncontext,
             None)
         self.assertEqual(result, self.signal_mock.SIG_IGN)
 
     def test__get_signal_handler_attribute(self):
         result = pep3143daemon.daemon.DaemonContext._get_signal_handler(
-            self.mockdaemoncontext,
+            self.daemoncontext,
             'terminate')
-        self.assertEqual(result, self.mockdaemoncontext.terminate)
+        self.assertEqual(result, self.daemoncontext.terminate)
 
     def test__get_signal_handler_other(self):
         other = Mock()
         result = pep3143daemon.daemon.DaemonContext._get_signal_handler(
-            self.mockdaemoncontext,
+            self.daemoncontext,
             other)
         self.assertEqual(result, other)