Source code for

# Copyright(C) 2010-2021 Romain Bignon
# This file is part of woob.
# woob 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 3 of the License, or
# (at your option) any later version.
# woob is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# GNU Lesser General Public License for more details.
# You should have received a copy of the GNU Lesser General Public License
# along with woob. If not, see <>.

from functools import wraps
from unittest import TestCase
from import SkipTest

from woob.capabilities.base import empty
from woob.core import Woob

__all__ = ['BackendTest', 'SkipTest', 'skip_without_config']

[docs]class BackendTest(TestCase): MODULE = None def __init__(self, *args, **kwargs): super(BackendTest, self).__init__(*args, **kwargs) self.backends = {} self.backend_instance = None self.backend = None self.woob = Woob() # Skip tests when passwords are missing self.woob.requests.register('login', self.login_cb) if self.woob.load_backends(modules=[self.MODULE]): # provide the tests with all available backends self.backends = self.woob.backend_instances
[docs] def login_cb(self, backend_name, value): raise SkipTest('missing config \'%s\' is required for this test' % value.label)
[docs] def run(self, result): """ Call the parent run() for each backend instance. Skip the test if we have no backends. """ try: if not len(self.backends): self.backend = self.woob.build_backend(self.MODULE, nofail=True) super().run(result) else: # Run for all backend for backend_instance in self.backends.keys(): print(backend_instance) self.backend = self.backends[backend_instance] super().run(result) finally: self.woob.deinit()
[docs] def shortDescription(self): """ Generate a description with the backend instance name. """ # do not use TestCase.shortDescription as it returns None return '%s [%s]' % (str(self), self.backend_instance)
[docs] def is_backend_configured(self): """ Check if the backend is in the user configuration file """ return self.woob.backends_config.backend_exists(self.backend.config.instname)
[docs] def assertNotEmpty(self, obj, *args): """ Assert an object is neither `empty` in the BaseObject parlance. `obj` should not be `None`, `NotLoaded`, or `NotAvailable`. """ self.assertFalse(empty(obj), *args)
[docs]def skip_without_config(*keys): """Decorator to skip a test if backend config is missing :param keys: if any of these keys is missing in backend config, skip test. Can be empty. """ for key in keys: if callable(key): raise TypeError('skip_without_config() must be called with arguments') def decorator(func): @wraps(func) def wrapper(self, *args, **kwargs): config = self.backend.config if not self.is_backend_configured(): raise SkipTest('a backend must be declared in configuration for this test') for key in keys: if not config[key].get(): raise SkipTest('config key %r is required for this test' % key) return func(self, *args, **kwargs) return wrapper return decorator