Merge branch 'logging-fixes'

Merge #4

Author: acatton

backupdb/management/commands/backupdb.py

@@ -1,21 +1,21 @@
 from optparse import make_option
 from subprocess import CalledProcessError
+import logging
 import os
 import time
 
-from django.core.management.base import BaseCommand
-
-from backupdb_utils.commands import do_postgresql_backup
+from backupdb_utils.commands import BaseBackupDbCommand, do_postgresql_backup
 from backupdb_utils.exceptions import BackupError
+from backupdb_utils.log import section, SectionError, SectionWarning
 from backupdb_utils.settings import BACKUP_DIR, BACKUP_CONFIG
-from backupdb_utils.streams import err, section, SectionError, set_verbosity
+
+logger = logging.getLogger(__name__)
 
 
-class Command(BaseCommand):
+class Command(BaseBackupDbCommand):
     help = 'Backs up each database in settings.DATABASES.'
-    can_import_settings = True
 
-    option_list = BaseCommand.option_list + (
+    option_list = BaseBackupDbCommand.option_list + (
         make_option(
             '--backup-name',
             help=(
@@ -48,14 +48,14 @@ class Command(BaseCommand):
     )
 
     def handle(self, *args, **options):
+        super(Command, self).handle(*args, **options)
+
         from django.conf import settings
 
         current_time = time.strftime('%F-%s')
         backup_name = options['backup_name'] or current_time
         show_output = options['show_output']
 
-        set_verbosity(int(options['verbosity']))
-
         # Ensure backup dir present
         if not os.path.exists(BACKUP_DIR):
             os.makedirs(BACKUP_DIR)
@@ -67,7 +67,7 @@ def handle(self, *args, **options):
                 engine = db_config['ENGINE']
                 backup_config = BACKUP_CONFIG.get(engine)
                 if not backup_config:
-                    raise SectionError("! Backup for '{0}' engine not implemented".format(engine))
+                    raise SectionWarning("Backup for '{0}' engine not implemented".format(engine))
 
                 # Get backup file name
                 backup_base_name = '{db_name}-{backup_name}.{backup_extension}.gz'.format(
@@ -90,8 +90,8 @@ def handle(self, *args, **options):
                 # Run backup command
                 try:
                     backup_func(**backup_kwargs)
-                    err("* Backup of '{db_name}' saved in '{backup_file}'".format(
+                    logger.info("Backup of '{db_name}' saved in '{backup_file}'".format(
                         db_name=db_name,
                         backup_file=backup_file))
                 except (BackupError, CalledProcessError) as e:
-                    raise SectionError('! {0}'.format(e))
+                    raise SectionError(e)

backupdb/management/commands/restoredb.py

@@ -1,22 +1,25 @@
 from optparse import make_option
 from subprocess import CalledProcessError
+import logging
 import os
 
-from django.core.management.base import BaseCommand, CommandError
+from django.core.management.base import CommandError
 from django.conf import settings
 from django.db import close_connection
 
+from backupdb_utils.commands import BaseBackupDbCommand
 from backupdb_utils.exceptions import RestoreError
 from backupdb_utils.files import get_latest_timestamped_file
+from backupdb_utils.log import section, SectionError, SectionWarning
 from backupdb_utils.settings import BACKUP_DIR, BACKUP_CONFIG
-from backupdb_utils.streams import err, set_verbosity, section, SectionError
 
+logger = logging.getLogger(__name__)
 
-class Command(BaseCommand):
+
+class Command(BaseBackupDbCommand):
     help = 'Restores each database in settings.DATABASES from latest db backup.'
-    can_import_settings = True
 
-    option_list = BaseCommand.option_list + (
+    option_list = BaseBackupDbCommand.option_list + (
         make_option(
             '--backup-name',
             help=(
@@ -53,6 +56,8 @@ class Command(BaseCommand):
     )
 
     def handle(self, *args, **options):
+        super(Command, self).handle(*args, **options)
+
         # Django is querying django_content_types in a hanging transaction
         # Because of this psql can't drop django_content_types and just hangs
         close_connection()
@@ -65,16 +70,14 @@ def handle(self, *args, **options):
         drop_tables = options['drop_tables']
         show_output = options['show_output']
 
-        set_verbosity(int(options['verbosity']))
-
         # Loop through databases
         for db_name, db_config in settings.DATABASES.items():
             with section("Restoring '{0}'...".format(db_name)):
                 # Get backup config for this engine type
                 engine = db_config['ENGINE']
                 backup_config = BACKUP_CONFIG.get(engine)
                 if not backup_config:
-                    raise SectionError("! Restore for '{0}' engine not implemented".format(engine))
+                    raise SectionWarning("Restore for '{0}' engine not implemented".format(engine))
 
                 # Get backup file name
                 backup_extension = backup_config['backup_extension']
@@ -89,7 +92,7 @@ def handle(self, *args, **options):
                     try:
                         backup_file = get_latest_timestamped_file(backup_extension)
                     except RestoreError as e:
-                        raise SectionError('! {0}'.format(e))
+                        raise SectionError(e)
 
                 # Find restore command and get kwargs
                 restore_func = backup_config['restore_func']
@@ -103,8 +106,8 @@ def handle(self, *args, **options):
                 # Run restore command
                 try:
                     restore_func(**restore_kwargs)
-                    err("* Restored '{db_name}' from '{backup_file}'".format(
+                    logger.info("Restored '{db_name}' from '{backup_file}'".format(
                         db_name=db_name,
                         backup_file=backup_file))
                 except (RestoreError, CalledProcessError) as e:
-                    raise SectionError('! {0}'.format(e))
+                    raise SectionError(e)

backupdb_utils/commands.py

@@ -1,15 +1,39 @@
+import logging
 import os
 import shlex
 
+from django.core.management.base import BaseCommand
+
 from .exceptions import RestoreError
 from .processes import pipe_commands, pipe_commands_to_file
 
 
 PG_DROP_SQL = """SELECT 'DROP TABLE IF EXISTS "' || tablename || '" CASCADE;' FROM pg_tables WHERE schemaname = 'public';"""
 
+
+class BaseBackupDbCommand(BaseCommand):
+    can_import_settings = True
+
+    LOG_LEVELS = {
+        0: logging.ERROR,
+        1: logging.INFO,
+        2: logging.DEBUG,
+        3: logging.DEBUG,
+    }
+    LOG_FORMAT = '%(asctime)s - %(levelname)-8s: %(message)s'
+
+    def _setup_logging(self, level):
+        level = int(level)
+        logging.basicConfig(format=self.LOG_FORMAT, level=self.LOG_LEVELS[level])
+
+    def handle(self, *args, **options):
+        self._setup_logging(options['verbosity'])
+
+
 def apply_arg_values(arg_values):
     """
     Apply argument to values.
+
     l = [('--name={0}', 'name'),
          ('--password={0}', 'password'),
          ('--level={0}', ''),

backupdb_utils/log.py

@@ -0,0 +1,67 @@
+import contextlib
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+def bar(msg='', width=40, position=None):
+    r"""
+    Returns a string with text centered in a bar caption.
+
+    Examples:
+    >>> bar('test', width=10)
+    '== test =='
+    >>> bar(width=10)
+    '=========='
+    >>> bar('Richard Dean Anderson is...', position='top', width=50)
+    '//========= Richard Dean Anderson is... ========\\\\'
+    >>> bar('...MacGyver', position='bottom', width=50)
+    '\\\\================= ...MacGyver ================//'
+    """
+    if position == 'top':
+        start_bar = '//'
+        end_bar = r'\\'
+    elif position == 'bottom':
+        start_bar = r'\\'
+        end_bar = '//'
+    else:
+        start_bar = end_bar = '=='
+
+    if msg:
+        msg = ' ' + msg + ' '
+
+    width -= 4
+
+    return start_bar + msg.center(width, '=') + end_bar
+
+
+class SectionError(Exception):
+    pass
+
+
+class SectionWarning(Exception):
+    pass
+
+
+@contextlib.contextmanager
+def section(msg):
+    """
+    Context manager that prints a top bar to stderr upon entering and a bottom
+    bar upon exiting.  The caption of the top bar is specified by `msg`.  The
+    caption of the bottom bar is '...done!' if the context manager exits
+    successfully.  If a SectionError or SectionWarning is raised inside of the
+    context manager, SectionError.message or SectionWarning.message is passed
+    to logging.error or logging.warning respectively and the bottom bar caption
+    becomes '...skipped.'.
+    """
+    logger.info(bar(msg, position='top'))
+    try:
+        yield
+    except SectionError as e:
+        logger.error(e.message)
+        logger.info(bar('...skipped.', position='bottom'))
+    except SectionWarning as e:
+        logger.warning(e.message)
+        logger.info(bar('...skipped.', position='bottom'))
+    else:
+        logger.info(bar('...done!', position='bottom'))

backupdb_utils/processes.py

@@ -1,8 +1,9 @@
 from subprocess import Popen, PIPE, CalledProcessError
+import logging
 import os
 import shutil
 
-from .streams import err
+logger = logging.getLogger(__name__)
 
 
 def extend_env(extra_env):
@@ -31,7 +32,7 @@ def pipe_commands(cmds, extra_env=None, show_stderr=False, show_last_stdout=Fals
     env_str = (get_env_str(extra_env) + ' ') if extra_env else ''
     cmd_strs = [env_str + ' '.join(cmd) for cmd in cmds]
 
-    err('* Running `{0}`'.format(' | '.join(cmd_strs)), verbosity=1)
+    logger.info('Running `{0}`'.format(' | '.join(cmd_strs)))
 
     with open('/dev/null', 'w') as NULL:
         # Start processes
@@ -65,7 +66,7 @@ def pipe_commands_to_file(cmds, path, extra_env=None, show_stderr=False):
     env_str = (get_env_str(extra_env) + ' ') if extra_env else ''
     cmd_strs = [env_str + ' '.join(cmd) for cmd in cmds]
 
-    err('* Saving output of `{0}`'.format(' | '.join(cmd_strs)), verbosity=1)
+    logger.info('Saving output of `{0}`'.format(' | '.join(cmd_strs)))
 
     with open('/dev/null', 'w') as NULL:
         # Start processes