introduce new cronjob setup feature (#276)

* introduce new cronjob setup feature

* add cron to allowed STEPS

* update docs; update env config parsing for cron step

* fix subproc function call to provide a list

* add note in README about cronjobs

README.md

@@ -90,6 +90,7 @@ See the [dockerhub page](https://hub.docker.com/r/jessebot/onboardme) for more i
 - Enable touchID for sudo on macOS
 - Add your user to the docker group
 - Install [nerdfonts](https://www.nerdfonts.com) (defaults to mononoki and Symbols Only)
+- Install [cronjobs](https://github.com/jessebot/onboardme/pull/276) to keep everything up to date everywhere, everyday :)
 
 </details>
 

docs/onboardme/configuration.md

@@ -54,13 +54,15 @@ Those defaults can be altered per machine by creating a config file like:
     Darwin:
       - dot_files
       - packages
+      - cron
       - font_setup
       - neovim_setup
       - sudo_setup
     # these are linux specific steps
     Linux:
       - dot_files
       - packages
+      - cron
       - font_setup
       - neovim_setup
       - group_setup

onboardme/__init__.py

@@ -25,6 +25,7 @@
 from .pkg_management import run_pkg_mngrs
 from .sudo_setup import setup_sudo
 from .firewall import configure_firewall
+from .cron import cron_setup
 
 
 HELP = options_help()
@@ -214,6 +215,10 @@ def main(log_level,
             pkg_groups = usr_pref['package']['groups']
             run_pkg_mngrs(pkg_mngrs, pkg_groups, no_upgrade)
 
+        elif step == 'cron':
+            # install cronjobs
+            cron_setup()
+
         elif step in ['neovim_setup', 'font_setup']:
             # import step's function from ide_setup.py in same directory
             import_module('onboardme.ide_setup', package=f'.{step}')

onboardme/constants.py

@@ -27,7 +27,7 @@
 OS = (SYSINFO.sysname, SYSINFO.machine)
 
 # step config is different per OS
-STEPS = ['dot_files','packages','font_setup','neovim_setup','group_setup']
+STEPS = ['dot_files','packages','cron','font_setup','neovim_setup','group_setup']
 if OS[0] == 'Darwin':
     STEPS.append('sudo_setup')
 

onboardme/cron.py

@@ -0,0 +1,48 @@
+"""
+NAME:    onboardme.cron
+DESC:    install cron jobs for the user and root
+AUTHORS:  Jesse Hitch
+LICENSE: GNU AFFERO GENERAL PUBLIC LICENSE
+"""
+
+import logging as log
+from os import path
+from pathlib import Path
+
+# custom libs
+from getpass import getuser
+
+from .constants import HOME_DIR, OS
+from .console_logging import print_header, print_msg
+from .subproc import subproc
+
+
+def cron_setup() -> None:
+    """
+    Installs crontab to run onboardme for user only functions
+
+    On Linux:
+        installs crontab for root to run apt commands
+    """
+    print_header('⏰ [i]crontab[/i] installations')
+    if 'Linux' in OS:
+        cron_dir = "/etc/crontab.d"
+
+        # install root level cronjobs
+        root_crontab = f'{HOME_DIR}/.config/cron/root/crontab'
+
+        # do a shallow clone of the repo
+        if path.exists(root_crontab):
+            log.info('Installing root crontab.')
+            subproc([f'sudo cp {root_crontab} {cron_dir}/root'])
+            print_msg('[i]root crontab installed.')
+    else:
+        cron_dir = "/var/at/tabs"
+
+    # install user level cronjobs
+    user_crontab = f'{HOME_DIR}/.config/cron/user/crontab'
+    if path.exists(user_crontab):
+        log.info('Installing user crontab.')
+        username = getuser()
+        subproc([f'sudo cp {user_crontab} {cron_dir}/{username}'])
+        print_msg('[i]User crontab installed.')

onboardme/env_config.py

@@ -48,13 +48,17 @@ def process_steps(steps: list, firewall: bool = False, browser: bool = False) ->
         if 'neovim_setup' in steps_list and 'dot_files' not in steps_list:
             steps_list.append('dot_files')
 
+        # need cron files to setup crontabs
+        if 'cron' in steps_list and 'dot_files' not in steps_list:
+            steps_list.append('dot_files')
+
         if firewall and 'Linux' in OS:
             # currently don't have a great firewall on macOS, sans lulu
             steps_list.append('firewall_setup')
 
     removed_duplicates = set(steps_list)
     steps = list(removed_duplicates)
-    default_order = ['dot_files', 'packages', 'font_setup', 'neovim_setup']
+    default_order = ['dot_files', 'packages', 'cron', 'font_setup', 'neovim_setup']
     if OS[0] == 'Linux':
         default_order.append('group_setup')
     else:

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name          = "onboardme"
-version       = "1.9.2"
+version       = "1.10.0"
 description   = "Install dot files and packages, including a base mode with sensible defaults to run on most computers running Debian based distros or macOS."
 authors       = [
     "Jesse Hitch <[email protected]>",