~djfroofy/storm/twisted-integration-tests

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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
#
# Copyright (c) 2007 Canonical
# Copyright (c) 2007 Thomas Herve <thomas@nimail.org>
#
# This file is part of Storm Object Relational Mapper.
#
# Storm is free software; you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as
# published by the Free Software Foundation; either version 2.1 of
# the License, or (at your option) any later version.
#
# Storm 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 Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#

"""
Store wrapper and custom thread runner.
"""

from threading import Thread
from Queue import Queue

from storm.store import Store, AutoReload
from storm.info import get_obj_info
from storm.twisted.wrapper import partial, DeferredResult, DeferredResultSet

from twisted.internet.defer import Deferred, deferredGenerator
from twisted.internet.defer import waitForDeferred, succeed, fail
from twisted.python.failure import Failure



class AlreadyStopped(Exception):
    """
    Except raised when a store is stopped multiple time.
    """



class StoreThread(Thread):
    """
    A thread class that wraps methods calls and fires deferred in the reactor
    thread.
    """
    STOP = object()

    def __init__(self):
        """
        Initialize the thread, and create a L{Queue} to stack jobs.
        """
        Thread.__init__(self)
        self.setDaemon(True)
        self._queue = Queue()
        self._stop_deferred = None
        self.stopped = False


    def defer_to_thread(self, f, *args, **kwargs):
        """
        Run the given function in the thread, wrapping the result with a
        L{Deferred}.

        @return: a deferred whose result will be the result of the function.
        @rtype: C{Deferred}
        """
        if self.stopped:
            # to prevent having pending calls after the thread got stopped
            return fail(AlreadyStopped(f))
        d = Deferred()
        self._queue.put((d, f, args, kwargs))
        return d


    def run(self):
        """
        Main execution loop: retrieve jobs from the queue and run them.
        """
        from twisted.internet import reactor
        o = self._queue.get()
        while o is not self.STOP:
            d, f, args, kwargs = o
            try:
                result = f(*args, **kwargs)
            except:
                f = Failure()
                reactor.callFromThread(d.errback, f)
            else:
                reactor.callFromThread(d.callback, result)
            o = self._queue.get()
        reactor.callFromThread(self._stop_deferred.callback, None)


    def stop(self):
        """
        Stop the thread.
        """
        if self.stopped:
            return self._stop_deferred
        self._stop_deferred = Deferred()
        self._queue.put(self.STOP)
        self.stopped = True
        return self._stop_deferred



class DeferredStore(object):
    """
    A wrapper around L{Store} to have async operations.
    """
    store = None

    def __init__(self, database):
        """
        @param database: instance of database providing connection, used to
            instantiate the store later.
        @type database: L{storm.database.Database}
        """
        self.thread = StoreThread()
        self.database = database
        self.started = False


    def start(self):
        """
        Start the store.

        @return: a deferred that will fire once the store is started.
        """
        if not self.started:
            self.started = True
            self.thread.start()
            # Add a event trigger to be sure that the thread is stopped
            from twisted.internet import reactor
            reactor.addSystemEventTrigger(
                "before", "shutdown", self.stop)
            return self.thread.defer_to_thread(Store, self.database
                ).addCallback(self._got_store)
        else:
            raise RuntimeError("Already started")


    def _got_store(self, store):
        """
        Internal method called when the store is created, initializing most of
        the API methods.
        """
        self.store = store
        # Maybe not ?
        self.store._deferredStore = self
        for methodName in ("get", "commit", "flush", "remove", "reload",
                           "rollback"):
            method = partial(self.thread.defer_to_thread,
                             getattr(self.store, methodName))
            setattr(self, methodName, method)
        try:
            from storm.databases import sqlite
            if self.database.__class__ == sqlite.SQLite:
                self.store.invalidate = self._sqlite_invalidate
        except ImportError:
            pass


    def add(self, obj):
        """
        Specific add method that automatically resolve lazy values.
        """
        def _add():
            result = self.store.add(obj)
            if result is not None:
                obj_info = get_obj_info(result)
                self.store._resolve_lazy_value(obj_info, None, AutoReload)
            return result
        return self.thread.defer_to_thread(_add)


    def execute(self, *args, **kwargs):
        """
        Wrapper around C{execute} to have a C{DeferredResult} instead of the
        standard L{storm.database.Result} object.
        """
        if self.store is None:
            raise RuntimeError("Store not started")
        return self.thread.defer_to_thread(
            self.store.execute, *args, **kwargs
            ).addCallback(self._cb_execute)


    def _cb_execute(self, result):
        """
        Wrap the result with a C{DeferredResult}.
        """
        return DeferredResult(self.thread, result)


    def find(self, *args, **kwargs):
        """
        Wrapper around C{find}.
        """
        if self.store is None:
            raise RuntimeError("Store not started")
        return self.thread.defer_to_thread(
            self.store.find, *args, **kwargs
            ).addCallback(self._cb_find)


    def _cb_find(self, resultSet):
        """
        Wrap the result set with a C{DeferredResultSet}.
        """
        return DeferredResultSet(self.thread, resultSet)


    def stop(self):
        """
        Stop the store.
        """
        return self.thread.stop()

    @staticmethod
    def of(obj):
        """
        Get the DeferredStore object is associated with

        If the given object has not been associated with a DeferredStore,
        return None.
        """
        store = Store.of(obj)
        if not store:
            return
        return getattr(store, '_deferredStore', None)

    def _sqlite_invalidate(self, obj=None):
        """
        For sqlite, invalidate isn't meaningful on the store for now.
        """



class StorePool(object):
    """
    A pool of started stores, maintaining persistent connections.
    """
    started = False
    store_factory = DeferredStore

    def __init__(self, database, min_stores=0, max_stores=10):
        """
        @param database: instance of database providing connection, used to
            instantiate the store later.
        @type database: L{storm.database.Database}

        @param min_stores: initial number of stores.
        @type min_stores: C{int}

        @param max_stores: maximum number of stores.
        @type max_stores: C{int}
        """
        self.database = database
        self.min_stores = min_stores
        self.max_stores = max_stores
        self._stores = []
        self._stores_created = 0
        self._pending_get = []


    def start(self):
        """
        Start the pool.
        """
        if self.started:
            raise RuntimeError("Already started")
        self.started = True
        return self.adjust_size()


    def stop(self):
        """
        Stop the pool: this is not a total stop, it just try to kill the
        current available stores.
        """
        return self.adjust_size(0, 0)


    def start_store(self):
        """
        Create a start a new store.
        """
        store = self.store_factory(self.database)
        return store.start().addCallback(self._cbStartAStore, store)


    def _cbStartAStore(self, ign, store):
        """
        Add the created store to the list of available stores.
        """
        self._stores_created += 1
        self._stores.append(store)


    def stop_store(self):
        """
        Stop a store and remove it from the available stores.
        """
        self._stores_created -= 1
        store = self._stores.pop()
        return store.stop()


    def adjust_size(self, min_stores=None, max_stores=None):
        """
        Change the number of available stores, shrinking or raising as
        necessary.
        """
        if min_stores is None:
            min_stores = self.min_stores
        if max_stores is None:
            max_stores = self.max_stores

        if min_stores < 0:
            raise ValueError('minimum is negative')
        if min_stores > max_stores:
            raise ValueError('minimum is greater than maximum')

        self.min_stores = min_stores
        self.max_stores = max_stores
        if not self.started:
            return

        # Kill of some stores if we have too many.
        while self._stores_created > self.max_stores and self._stores:
            wfd = waitForDeferred(self.stop_store())
            yield wfd
            wfd.getResult()
        # Start some stores if we have too few.
        while self._stores_created < self.min_stores:
            wfd = waitForDeferred(self.start_store())
            yield wfd
            wfd.getResult()

    adjust_size = deferredGenerator(adjust_size)


    def get(self):
        """
        Return a started store from the pool, or start a new one if necessary.
        A store retrieve by this way should be put back using the put
        method, or it won't be used anymore.
        """
        if not self.started:
            raise RuntimeError("Not started")
        if self._stores:
            store = self._stores.pop()
            return succeed(store)
        elif self._stores_created < self.max_stores:
            return self.start_store().addCallback(self._cb_get)
        else:
            # Maybe all stores are consumed?
            return self.adjust_size().addCallback(self._cb_get)


    def _cb_get(self, ign):
        """
        If the previous operation added a store, return it, or return a pending
        C{Deferred}.
        """
        if self._stores:
            store = self._stores.pop()
            return store
        else:
            # All stores are in used, wait
            d = Deferred()
            self._pending_get.append(d)
            return d


    def put(self, store):
        """
        Make a store available again.

        This should be done explicitely to have the store back in the pool.
        The good way to use the pool is this:

        >>> d1 = pool.get()

        >>> # d1 callback with a store
        >>> d2 = store.add(foo)
        >>> d2.addCallback(doSomething).addErrback(manageErrors)
        >>> d2.addBoth(lambda x: pool.put(store))
        """
        return store.rollback().addCallback(self._cb_put, store)


    def _cb_put(self, ign, store):
        """
        Once the rollback has finished, the store is really available.
        """
        if self._pending_get:
            # People are waiting, fire with the store
            d = self._pending_get.pop(0)
            d.callback(store)
        else:
            self._stores.append(store)


    def transact(self, f, *args, **kwargs):
        """
        Call function C{f} with a L{Store} instance and arguments 
        C{args} and C{kwargs} in transaction bound to the acquired store.
        If transaction succeeds, store will be commited.  Store is
        returned to this pool after call to C{f} completes. 

        Note that the function C{f} must return an instance of L{Deferred}.

        @param f: function to call in transaction
        @param args: positional arguments to function C{f}
        @param kwargs: keyword arguments to function C{f}
        """

        return self.get().addCallback(self._cb_transact_start,
                                      f, args, kwargs
                                      ).addBoth(self._cb_transact_return)

    def _cb_transact_start(self, store, f, args, kwargs):
        """
        Call transacted function with acquired store
        """
        result = None
        failure = None
        try:
            result = f(store, *args, **kwargs)
        except:
            failure = Failure()
        finally:
            if failure:
                return self._cb_transact_close(failure, failure, store)

            assert isinstance(result, Deferred),\
                   'Transacted functions must return a Deferred'
            result.addCallback(self._cb_transact_success, store)
            result.addErrback(self._cb_transact_close, None, store)
            return result

    def _cb_transact_success(self, result, store):
        """
        Commit and pass through value
        """
        return store.commit().addCallback(self._cb_transact_close, result, store)

    def _cb_transact_close(self, reason, result=None, store=None):
        """
        Close out transaction - returning store to pool.
        """
        if isinstance(reason, Failure):
            result = reason
        if store:
            return self.put(store).addCallback(lambda  r : result)
        return self._cb_transact_return(reason)

    def _cb_transact_return(self, result):
        """
        Pass on oringinal return value or raise exception
        """
        if isinstance(result, Failure):
            result.trap()
        return result