mediagoblin/gmg_commands/dbupdate.py

   1 # GNU MediaGoblin -- federated, autonomous media hosting
   2 # Copyright (C) 2011, 2012 MediaGoblin contributors.  See AUTHORS.
   3 #
   4 # This program is free software: you can redistribute it and/or modify
   5 # it under the terms of the GNU Affero General Public License as published by
   6 # the Free Software Foundation, either version 3 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU Affero General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU Affero General Public License
  15 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 import logging
  18
  19 import six
  20 from sqlalchemy.orm import sessionmaker
  21
  22 from mediagoblin.db.open import setup_connection_and_db_from_config
  23 from mediagoblin.db.migration_tools import MigrationManager, AlembicMigrationManager
  24 from mediagoblin.init import setup_global_and_app_config
  25 from mediagoblin.tools.common import import_component
  26
  27 _log = logging.getLogger(__name__)
  28 logging.basicConfig()
  29 ## Let's not set the level as debug by default to avoid confusing users :)
  30 # _log.setLevel(logging.DEBUG)
  31
  32
  33 def dbupdate_parse_setup(subparser):
  34     pass
  35
  36
  37 class DatabaseData(object):
  38     def __init__(self, name, models, foundations, migrations):
  39         self.name = name
  40         self.models = models
  41         self.foundations = foundations
  42         self.migrations = migrations
  43
  44     def make_migration_manager(self, session):
  45         return MigrationManager(
  46             self.name, self.models, self.foundations, self.migrations, session)
  47
  48
  49 def gather_database_data(plugins):
  50     """
  51     Gather all database data relevant to the extensions installed.
  52
  53     Gather all database data relevant to the extensions we have
  54     installed so we can do migrations and table initialization.
  55
  56     Returns a list of DatabaseData objects.
  57     """
  58     managed_dbdata = []
  59
  60     # Add main first
  61     from mediagoblin.db.models import MODELS as MAIN_MODELS
  62     from mediagoblin.db.migrations import MIGRATIONS as MAIN_MIGRATIONS
  63     from mediagoblin.db.models import FOUNDATIONS as MAIN_FOUNDATIONS
  64
  65     managed_dbdata.append(
  66         DatabaseData(
  67             u'__main__', MAIN_MODELS, MAIN_FOUNDATIONS, MAIN_MIGRATIONS))
  68
  69     for plugin in plugins:
  70         try:
  71             models = import_component('{0}.models:MODELS'.format(plugin))
  72         except ImportError as exc:
  73             _log.debug('No models found for {0}: {1}'.format(
  74                 plugin,
  75                 exc))
  76
  77             models = []
  78         except AttributeError as exc:
  79             _log.warning('Could not find MODELS in {0}.models, have you '
  80                          'forgotten to add it? ({1})'.format(plugin, exc))
  81             models = []
  82
  83         try:
  84             migrations = import_component('{0}.migrations:MIGRATIONS'.format(
  85                 plugin))
  86         except ImportError as exc:
  87             _log.debug('No migrations found for {0}: {1}'.format(
  88                 plugin,
  89                 exc))
  90
  91             migrations = {}
  92         except AttributeError as exc:
  93             _log.debug('Could not find MIGRATIONS in {0}.migrations, have you'
  94                        'forgotten to add it? ({1})'.format(plugin, exc))
  95             migrations = {}
  96
  97         try:
  98             foundations = import_component(
  99                 '{0}.models:FOUNDATIONS'.format(plugin))
 100         except ImportError as exc:
 101             foundations = {}
 102         except AttributeError as exc:
 103             foundations = {}
 104
 105         if models:
 106             managed_dbdata.append(
 107                 DatabaseData(plugin, models, foundations, migrations))
 108
 109     return managed_dbdata
 110
 111
 112 def run_alembic_migrations(db, app_config, global_config):
 113     """Initialize a database and runs all Alembic migrations."""
 114     Session = sessionmaker(bind=db.engine)
 115     manager = AlembicMigrationManager(Session())
 116     manager.init_or_migrate()
 117
 118
 119 def run_dbupdate(app_config, global_config):
 120     """
 121     Initialize or migrate the database as specified by the config file.
 122
 123     Will also initialize or migrate all extensions (media types, and
 124     in the future, plugins)
 125     """
 126     # Set up the database
 127     db = setup_connection_and_db_from_config(app_config, migrations=True)
 128     # Run the migrations
 129     # TODO: rename to run_legacy_migrations
 130     run_all_migrations(db, app_config, global_config)
 131
 132     # TODO: Make this happen regardless of python 2 or 3 once ensured
 133     # to be "safe"!
 134     run_alembic_migrations(db, app_config, global_config)
 135
 136
 137 def run_all_migrations(db, app_config, global_config):
 138     """Initialize or migrates a database.
 139
 140     Initializes or migrates a database that already has a
 141     connection setup and also initializes or migrates all
 142     extensions based on the config files.
 143
 144     It can be used to initialize an in-memory database for
 145     testing.
 146     """
 147     # Gather information from all media managers / projects
 148     dbdatas = gather_database_data(
 149         list(global_config.get('plugins', {}).keys()))
 150
 151     Session = sessionmaker(bind=db.engine)
 152
 153     # Setup media managers for all dbdata, run init/migrate and print info
 154     # For each component, create/migrate tables
 155     for dbdata in dbdatas:
 156         migration_manager = dbdata.make_migration_manager(Session())
 157         migration_manager.init_or_migrate()
 158
 159
 160 def dbupdate(args):
 161     global_config, app_config = setup_global_and_app_config(args.conf_file)
 162     run_dbupdate(app_config, global_config)