a5dae0dbc2
After alembic updates we need to add foundations. The tables to add foundations to are created as part of dbupdate process. For some reason Alembic doesn't commit a session in the end. Because the session is not commited, the tables do not really get created. And because of that, foundations fail. The solution is to commit the session after alembic updates.
237 lines
7.8 KiB
Python
237 lines
7.8 KiB
Python
# GNU MediaGoblin -- federated, autonomous media hosting
|
|
# Copyright (C) 2011, 2012 MediaGoblin contributors. See AUTHORS.
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program 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 Affero General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Affero General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
import logging
|
|
|
|
import six
|
|
from alembic import command
|
|
from sqlalchemy.orm import sessionmaker
|
|
|
|
from mediagoblin.db.open import setup_connection_and_db_from_config
|
|
from mediagoblin.db.migration_tools import (
|
|
MigrationManager, build_alembic_config, populate_table_foundations)
|
|
from mediagoblin.init import setup_global_and_app_config
|
|
from mediagoblin.tools.common import import_component
|
|
|
|
_log = logging.getLogger(__name__)
|
|
logging.basicConfig()
|
|
## Let's not set the level as debug by default to avoid confusing users :)
|
|
# _log.setLevel(logging.DEBUG)
|
|
|
|
|
|
def dbupdate_parse_setup(subparser):
|
|
pass
|
|
|
|
|
|
class DatabaseData(object):
|
|
def __init__(self, name, models, migrations):
|
|
self.name = name
|
|
self.models = models
|
|
self.migrations = migrations
|
|
|
|
def make_migration_manager(self, session):
|
|
return MigrationManager(
|
|
self.name, self.models, self.migrations, session)
|
|
|
|
|
|
def gather_database_data(plugins):
|
|
"""
|
|
Gather all database data relevant to the extensions installed.
|
|
|
|
Gather all database data relevant to the extensions we have
|
|
installed so we can do migrations and table initialization.
|
|
|
|
Returns a list of DatabaseData objects.
|
|
"""
|
|
managed_dbdata = []
|
|
|
|
# Add main first
|
|
from mediagoblin.db.models import MODELS as MAIN_MODELS
|
|
from mediagoblin.db.migrations import MIGRATIONS as MAIN_MIGRATIONS
|
|
|
|
managed_dbdata.append(
|
|
DatabaseData(
|
|
u'__main__', MAIN_MODELS, MAIN_MIGRATIONS))
|
|
|
|
for plugin in plugins:
|
|
try:
|
|
models = import_component('{0}.models:MODELS'.format(plugin))
|
|
except ImportError as exc:
|
|
_log.debug('No models found for {0}: {1}'.format(
|
|
plugin,
|
|
exc))
|
|
|
|
models = []
|
|
except AttributeError as exc:
|
|
_log.warning('Could not find MODELS in {0}.models, have you '
|
|
'forgotten to add it? ({1})'.format(plugin, exc))
|
|
models = []
|
|
|
|
try:
|
|
migrations = import_component('{0}.migrations:MIGRATIONS'.format(
|
|
plugin))
|
|
except ImportError as exc:
|
|
_log.debug('No migrations found for {0}: {1}'.format(
|
|
plugin,
|
|
exc))
|
|
|
|
migrations = {}
|
|
except AttributeError as exc:
|
|
_log.debug('Could not find MIGRATIONS in {0}.migrations, have you'
|
|
'forgotten to add it? ({1})'.format(plugin, exc))
|
|
migrations = {}
|
|
|
|
if models:
|
|
managed_dbdata.append(
|
|
DatabaseData(plugin, models, migrations))
|
|
|
|
return managed_dbdata
|
|
|
|
|
|
def run_foundations(db, global_config):
|
|
"""
|
|
Gather foundations data and run it.
|
|
"""
|
|
from mediagoblin.db.models import FOUNDATIONS as MAIN_FOUNDATIONS
|
|
all_foundations = [(u"__main__", MAIN_FOUNDATIONS)]
|
|
|
|
Session = sessionmaker(bind=db.engine)
|
|
session = Session()
|
|
|
|
plugins = global_config.get('plugins', {})
|
|
|
|
for plugin in plugins:
|
|
try:
|
|
foundations = import_component(
|
|
'{0}.models:FOUNDATIONS'.format(plugin))
|
|
all_foundations.append((plugin, foundations))
|
|
except ImportError as exc:
|
|
continue
|
|
except AttributeError as exc:
|
|
continue
|
|
|
|
for name, foundations in all_foundations:
|
|
populate_table_foundations(session, foundations, name)
|
|
|
|
|
|
def run_alembic_migrations(db, app_config, global_config):
|
|
"""Initialize a database and runs all Alembic migrations."""
|
|
Session = sessionmaker(bind=db.engine)
|
|
session = Session()
|
|
cfg = build_alembic_config(global_config, None, session)
|
|
|
|
res = command.upgrade(cfg, 'heads')
|
|
session.commit()
|
|
return res
|
|
|
|
|
|
def run_dbupdate(app_config, global_config):
|
|
"""
|
|
Initialize or migrate the database as specified by the config file.
|
|
|
|
Will also initialize or migrate all extensions (media types, and
|
|
in the future, plugins)
|
|
"""
|
|
# Set up the database
|
|
db = setup_connection_and_db_from_config(app_config, migrations=True)
|
|
|
|
# Do we have migrations
|
|
should_run_sqam_migrations = db.engine.has_table("core__migrations") and \
|
|
sqam_migrations_to_run(db, app_config,
|
|
global_config)
|
|
|
|
# Looks like a fresh database!
|
|
# (We set up this variable here because doing "run_all_migrations" below
|
|
# will change things.)
|
|
fresh_database = (
|
|
not db.engine.has_table("core__migrations") and
|
|
not db.engine.has_table("alembic_version"))
|
|
|
|
# Run the migrations
|
|
if should_run_sqam_migrations:
|
|
run_all_migrations(db, app_config, global_config)
|
|
|
|
run_alembic_migrations(db, app_config, global_config)
|
|
|
|
# If this was our first time initializing the database,
|
|
# we must lay down the foundations
|
|
if fresh_database:
|
|
run_foundations(db, global_config)
|
|
|
|
|
|
def run_all_migrations(db, app_config, global_config):
|
|
"""Initialize or migrates a database.
|
|
|
|
Initializes or migrates a database that already has a
|
|
connection setup and also initializes or migrates all
|
|
extensions based on the config files.
|
|
|
|
It can be used to initialize an in-memory database for
|
|
testing.
|
|
"""
|
|
# Gather information from all media managers / projects
|
|
dbdatas = gather_database_data(
|
|
list(global_config.get('plugins', {}).keys()))
|
|
|
|
Session = sessionmaker(bind=db.engine)
|
|
|
|
# Setup media managers for all dbdata, run init/migrate and print info
|
|
# For each component, create/migrate tables
|
|
for dbdata in dbdatas:
|
|
migration_manager = dbdata.make_migration_manager(Session())
|
|
migration_manager.init_or_migrate()
|
|
|
|
|
|
def sqam_migrations_to_run(db, app_config, global_config):
|
|
"""
|
|
Check whether any plugins have sqlalchemy-migrate migrations left to run.
|
|
|
|
This is a kludge so we can transition away from sqlalchemy-migrate
|
|
except where necessary.
|
|
"""
|
|
# @@: This shares a lot of code with run_all_migrations, but both
|
|
# are legacy and will be removed at some point.
|
|
|
|
# Gather information from all media managers / projects
|
|
dbdatas = gather_database_data(
|
|
list(global_config.get('plugins', {}).keys()))
|
|
|
|
Session = sessionmaker(bind=db.engine)
|
|
|
|
# We can bail out early if it turns out that sqlalchemy-migrate
|
|
# was never installed with any migrations
|
|
from mediagoblin.db.models import MigrationData
|
|
if Session().query(MigrationData).filter_by(
|
|
name=u"__main__").first() is None:
|
|
return False
|
|
|
|
# Setup media managers for all dbdata, run init/migrate and print info
|
|
# For each component, create/migrate tables
|
|
for dbdata in dbdatas:
|
|
migration_manager = dbdata.make_migration_manager(Session())
|
|
if migration_manager.migrations_to_run():
|
|
# If *any* migration managers have migrations to run,
|
|
# we'll have to run them.
|
|
return True
|
|
|
|
# Otherwise, scot free!
|
|
return False
|
|
|
|
|
|
def dbupdate(args):
|
|
global_config, app_config = setup_global_and_app_config(args.conf_file)
|
|
run_dbupdate(app_config, global_config)
|