Add generic Luigi install logic

at least try to do what we can to reduce boilerplate

rattail_fabric2/luigi.py

@@ -0,0 +1,124 @@
+# -*- coding: utf-8; -*-
+################################################################################
+#
+#  Rattail -- Retail Software Framework
+#  Copyright © 2010-2022 Lance Edgar
+#
+#  This file is part of Rattail.
+#
+#  Rattail is free software: you can redistribute it and/or modify it under the
+#  terms of the GNU General Public License as published by the Free Software
+#  Foundation, either version 3 of the License, or (at your option) any later
+#  version.
+#
+#  Rattail is distributed in the hope that it will be useful, but WITHOUT ANY
+#  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+#  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+#  details.
+#
+#  You should have received a copy of the GNU General Public License along with
+#  Rattail.  If not, see <http://www.gnu.org/licenses/>.
+#
+################################################################################
+"""
+Fabric library for Luigi apps
+"""
+
+import os
+
+from rattail_fabric2 import make_deploy, mkdir
+
+
+deploy_common = make_deploy(__file__)
+
+
+def install_luigi(c, envroot, user='rattail', db_connection=None):
+    """
+    Install and configure Luigi to the given virtualenv.
+    """
+    envroot = envroot.rstrip('/')
+    envname = os.path.basename(envroot)
+    appdir = '{}/app'.format(envroot)
+
+    # package
+    c.sudo("bash -lc 'workon {} && pip install luigi'".format(envname),
+           user=user)
+
+    # dirs
+    mkdir(c, ['{}/luigi'.format(appdir),
+              '{}/luigi/log'.format(appdir),
+              '{}/luigitasks'.format(appdir),
+    ], use_sudo=True, owner=user)
+
+    # tasks
+    c.sudo('touch {}/luigitasks/__init__.py'.format(appdir),
+           user=user)
+
+    # config
+    deploy_common(c, 'luigi/luigi.cfg.mako', '{}/luigi/luigi.cfg'.format(appdir),
+                  use_sudo=True, owner=user, mode='0640',
+                  context={'appdir': appdir,
+                           'db_connection': db_connection})
+    deploy_common(c, 'luigi/logging.conf.mako', '{}/luigi/logging.conf'.format(appdir),
+                  use_sudo=True, owner=user,
+                  context={'appdir': appdir})
+
+    # logrotate
+    deploy_common(c, 'luigi/luigi-logrotate.conf.mako', '{}/luigi/logrotate.conf'.format(appdir),
+                  use_sudo=True, owner='root:', # must be owned by root (TODO: why is that again?)
+                  context={'appdir': appdir})
+    deploy_common(c, 'luigi/rotate-logs.sh.mako', '{}/rotate-luigi-logs.sh'.format(appdir),
+                  use_sudo=True, owner=user,
+                  context={'appdir': appdir})
+
+
+def install_overnight_script(c, envroot, user='rattail', automation='All'):
+    """
+    Install an overnight automation script
+    """
+    envroot = envroot.rstrip('/')
+    appdir = '{}/app'.format(envroot)
+
+    # overnight-*.sh
+    filename = 'overnight-{}.sh'.format(automation.lower())
+    deploy_common(c, 'luigi/overnight.sh.mako',
+                  '{}/{}'.format(appdir, filename),
+                  use_sudo=True, owner=user, mode='0755',
+                  context={'envroot': envroot, 'appdir': appdir,
+                           'automation': automation})
+
+    # cron-overnight-*.sh
+    filename = 'cron-overnight-{}.sh'.format(automation.lower())
+    deploy_common(c, 'luigi/cron-overnight.sh.mako',
+                  '{}/{}'.format(appdir, filename),
+                  use_sudo=True, owner=user, mode='0755',
+                  context={'envroot': envroot, 
+                           'automation': automation})
+
+    # restart-overnight-*.sh
+    filename = 'restart-overnight-{}.sh'.format(automation.lower())
+    deploy_common(c, 'luigi/restart-overnight.sh.mako',
+                  '{}/{}'.format(appdir, filename),
+                  use_sudo=True, owner=user, mode='0755',
+                  context={'envroot': envroot, 
+                           'appdir': appdir,
+                           'automation': automation})
+
+
+def register_with_supervisor(c, envroot, user='rattail', autostart=False):
+    """
+    Register the Luigi scheduler daemon with supervisor
+    """
+    envroot = envroot.rstrip('/')
+    appdir = '{}/app'.format(envroot)
+
+    deploy_common(c, 'luigi/supervisor.conf.mako',
+                  '/etc/supervisor/conf.d/luigi.conf',
+                  use_sudo=True,
+                  context={'envroot': envroot,
+                           'appdir': appdir,
+                           'user': user,
+                           'autostart': autostart})
+    c.sudo('supervisorctl update')
+    if autostart:
+        c.sudo('supervisorctl start luigi:')