ilovetux / pyservice Goto Github PK

We need an entire test suite so we can get some pretty badges from Travis CI and appveyor.

We will need a setup.py file if we wish to get this up on PyPI and it will also help with running the tests.

We need some examples to include in the readme.

Now that we are implementing sphinx docs, unittests and integrating with more standard Python toolsets, it will make things easier to take advantage of the work that github has done in building this robust .gitignore file

There are currently three custom exceptions, all of which could be replaced with RuntimeError. This will be the first step in cleanup.

Now that everything is working (more or less) we need to make the Linux CLI offer some of the same options as the windows CLI, most notably

• make it so install/remove/start/stop are subcommands
• offer username for start
• specific options for each subcommand

As __init__ is for initialization, it would make more sense to have a second method for handling cli arguments and calling the correct methods, this would make our API more verbose, but it would also make testing easier as we can instanciate, mock and test in separate steps.

While I'm at it, I will modify the argument handling to use Python's argparse module so we can later expand the CLI to accept arguments from the user for different options.

When running on Linux, service.py attempts to from .windows import PyServiceWindows on Linux this will fail because pywin32 will not be installed. I propose to import PyServiceWindows or PyServiceLinux as PlatformService. This will allow us to simplify PyService.__init__ as well as we will not need to create a platform_map.

We need some good documentation which we can host on readthedocs.

• sphinx quickstart
• docstrings into sphinx format
• Quickstart section
• installation

The formatting of the init script is off as there is a lot of indentation

I have fixed the install issue, but when starting the service, it runs but it is stuck in the "starting" state. This is because we need to report the service status. I've been wrestling with this all night...trying again now with fresh eyes.

python test_linux_daemon.py --install

• Installing dummy
  C:\Users\IEUser\Desktop\sandbox\test_linux_daemon
  DummyService
  Traceback (most recent call last):
  File "test_linux_daemon.py", line 21, in
  service.handle_cli()
  File "c:\users\ieuser\workspace\pyservice\pyservice\service.py", line 126, in handle_cli
  run_or_exit_with_1(self.install)
  File "c:\users\ieuser\workspace\pyservice\pyservice\service.py", line 120, in run_or_exit_with_1
  if not func():
  File "c:\users\ieuser\workspace\pyservice\pyservice\service.py", line 237, in install
  result = self._install()
  File "c:\users\ieuser\workspace\pyservice\pyservice\windows.py", line 97, in _install
  self.class_name,
  AttributeError: 'DummyService' object has no attribute 'class_name'

The first place a potential user will look is in the readme. This project lacks one. This will be the second phase of the cleanup effort.

This will be ongoing as I need to dive deeper and gain more insight into how it all works together.

Trying to make everything work on Windows has taken a huge portion of my time and has led me to learn way too much (and too little) about the pywin32 project. What I propose is to create a factory function which takes a function function and returns a class. This class will be constructed based on the current platform.

Come to think of it, this sounds a lot like a decorator. I'm going to try that and see what happens.

It doesn't look as good, but it does work in both 2 and 3.

I have tested this on Fedora 24 and it works, but because we use an init.d (ie sys v init) script, the system needs to be rebooted before you can control it with systemctl. This is because the stsemd-sysv-generator needs to run on boot. The other option is to tell systemd to reload, ie systemctl daemon-reload.

We need to drop privileges as soon as we are done with them. This is a standard practice to reduce security concerns. It is ok to require administrative privileges to start/stop/install/uninstall but as soon as you no longer need the privileges you should drop them.

The original author licensed this under the GPL 2, I wish to move that up to the GPL 3. I will make the changes with the assumption that if the author disagrees I can change it back.

So, we have everything working except when I use the tornado example (modified for the new API) it installs/starts/removes just fine, but hangs on stopping. I hope I can fix this using something in the tornado API because I've found the win32serviceutils api to be a pain. I'm sure that this is due to windows and not the pywin32 package. I basically need a way to tell tornado to stop when a flag variable is set.

PyService carries around a reference to the platform specific implementation, this is inefficient and we could drastically simplify the code if it simply inherited from PlatformService instead.

We are creating the cross-platform public API in PyService, but all action methods are prefixed with an underscore while the platform specific classes are not prefixed with an underscore. To make it more sensible to newcomers, we should make the platform specific methods private (ie. prefixed with an underscore) and the public API public (ie not prefixed with an underscore).