summaryrefslogtreecommitdiffstats
path: root/src/lib/Bcfg2/Server/SchemaUpdater/__init__.py
blob: e7a3191bc0e562e1737d767e48562ba2811610e0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
from django.db import connection, DatabaseError
from django.core.exceptions import ImproperlyConfigured
import django.core.management
import logging
import re
import sys
import traceback

from Bcfg2.Compat import CmpMixin, walk_packages
from Bcfg2.Server.models import InternalDatabaseVersion
from Bcfg2.Server.SchemaUpdater.Routines import UpdaterRoutineException, \
                UpdaterRoutine
from Bcfg2.Server.SchemaUpdater import Changes

logger = logging.getLogger(__name__)

class UpdaterError(Exception):
    pass


class SchemaTooOldError(UpdaterError):
    pass


def _release_to_version(release):
    """
    Build a release base for a version

    Expects a string of the form 00.00

    returns an integer of the form MMmm00
    """
    regex = re.compile("^(\d+)\.(\d+)$")
    m = regex.match(release)
    if not m:
        logger.error("Invalid release string: %s" % release)
        raise TypeError
    return int("%02d%02d00" % (int(m.group(1)), int(m.group(2))))


class Updater(CmpMixin):
    """Database updater to standardize updates"""

    def __init__(self, release):
        CmpMixin.__init__(self)

        self._cursor = None
        self._release = release
        try:
            self._base_version = _release_to_version(release)
        except:
            err = "Invalid release string: %s" % release
            logger.error(err)
            raise UpdaterError(err)

        self._fixes = []
        self._version = -1

    def __cmp__(self, other):
        return self._base_version - other._base_version

    @property
    def release(self):
        return self._release

    @property
    def version(self):
        if self._version < 0:
            try:
                iv = InternalDatabaseVersion.objects.latest()
                self._version = iv.version
            except InternalDatabaseVersion.DoesNotExist:
                raise UpdaterError("No database version stored internally")
        return self._version

    @property
    def cursor(self):
        if not self._cursor:
            self._cursor = connection.cursor()
        return self._cursor

    @property
    def target_version(self):
        if(len(self._fixes) == 0):
            return self._base_version
        else:
            return self._base_version + len(self._fixes) - 1


    def add(self, update):
        if type(update) == str or isinstance(update, UpdaterRoutine):
            self._fixes.append(update)
        else:
            raise TypeError


    def override_base_version(self, version):
        """Override our starting point for old releases.  New code should
           not use this method"""
        self._base_version = int(version)


    @staticmethod
    def get_current_version():
        """Queries the db for the latest version.  Returns 0 for a
        fresh install"""

        if "call_command" in dir(django.core.management):
            django.core.management.call_command("syncdb", interactive=False,
                                                verbosity=0)
        else:
            msg = "Unable to call syndb routine"
            logger.warning(msg)
            raise UpdaterError(msg)

        try:
            iv = InternalDatabaseVersion.objects.latest()
            version = iv.version
        except InternalDatabaseVersion.DoesNotExist:
            version = 0

        return version


    def syncdb(self):
        """Function to do the syncronisation for the models"""

        self._version = Updater.get_current_version()
        self._cursor = None


    def increment(self):
        """Increment schema version in the database"""
        if self._version < self._base_version:
            self._version = self._base_version
        else:
            self._version += 1
        InternalDatabaseVersion.objects.create(version=self._version)

    def apply(self):
        """Apply pending schema changes"""

        if self.version >= self.target_version:
            logger.debug("No updates for release %s" % self._release)
            return

        logger.debug("Applying updates for release %s" % self._release)

        if self.version < self._base_version:
            start = 0
        else:
            start = self.version - self._base_version + 1

        try:
            for fix in self._fixes[start:]:
                if type(fix) == str:
                    self.cursor.execute(fix)
                elif isinstance(fix, UpdaterRoutine):
                    fix.run()
                else:
                    logger.error("Invalid schema change at %s" % \
                        self._version + 1)
                self.increment()
                logger.debug("Applied schema change number %s: %s" % \
                    (self.version, fix))
            logger.info("Applied schema changes for release %s" % self._release)
        except:
            msg = "Failed to perform db update %s (%s): %s" % \
                (self._version + 1, fix,
                 traceback.format_exc().splitlines()[-1])
            logger.error(msg)
            raise UpdaterError(msg)


class UnsupportedUpdate(Updater):
    """Handle an unsupported update"""

    def __init__(self, release, version):
        super(UnsupportedUpdate, self).__init__(release)
        self._base_version = version

    def apply(self):
        """Raise an exception if we're too old"""

        if self.version < self.target_version:
            logger.error("Upgrade from release %s unsupported" % self._release)
            raise SchemaTooOldError


def update_database():
    """method to search where we are in the revision
    of the database models and update them"""
    try:
        logger.debug("Verifying database schema")

        updaters = []
        for loader, submodule, ispkg in walk_packages(path=Changes.__path__):
            if ispkg:
                continue
            try:
                updates = getattr(
                    __import__("%s.%s" % (Changes.__name__, submodule), 
                        globals(), locals(), ['*']),
                    "updates")
                updaters.append(updates())
            except ImportError:
                logger.error("Failed to import %s" % submodule)
            except AttributeError:
                logger.warning("Module %s does not have an updates function" %
                               submodule)
            except:
                msg = "Failed to build updater for %s" % submodule
                logger.error(msg, exc_info=1)
                raise UpdaterError(msg)

        current_version = Updater.get_current_version()
        logger.debug("Database version at %s" % current_version)

        updaters.sort()
        if current_version > 0:
            [u.apply() for u in updaters]
            logger.debug("Database version at %s" %
                         Updater.get_current_version())
        else:
            target = updaters[-1].target_version
            InternalDatabaseVersion.objects.create(version=target)
            logger.info("A new database was created")

    except UpdaterError:
        raise
    except ImproperlyConfigured:
        logger.error("Django is not properly configured: %s" %
                     traceback.format_exc().splitlines()[-1])
        raise UpdaterError
    except:
        logger.error("Error while updating the database")
        for x in traceback.format_exc().splitlines():
            logger.error(x)
        raise UpdaterError