summaryrefslogtreecommitdiffstats
path: root/src/software/test/base.py
blob: e1adb2dc498ce4a33528f98718a49b1c499880da (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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
# -*- encoding: utf-8 -*-
# Copyright (C) 2012-2013 Red Hat, Inc.  All rights reserved.
#
# This library 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.
#
# This library 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 library; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
#
# Authors: Michal Minar <miminar@redhat.com>
#
"""
Common utilities and base class for all software tests.
"""

import itertools
import os
import pywbem
import tempfile
import unittest
from subprocess import check_output

import repository
import rpmcache

def mark_dangerous(method):
    """
    Decorator for methods of unittest.TestCase subclasses, that
    skips dangerous tests, if environment variable does not allow them.
    """
    if os.environ.get('LMI_RUN_DANGEROUS', '0') == '1':
        return method
    else:
        return unittest.skip("This test is marked as dangerous.")(method)

def mark_tedious(method):
    """
    Decorator for methods of unittest.TestCase subclasses, that
    skips tedious tests. Those running for very long time and usually
    need a lot of memory. Environment variable "LMI_RUN_TEDIOUS" can
    allow them
    """
    if os.environ.get('LMI_RUN_TEDIOUS', '0') == '1':
        return method
    else:
        return unittest.skip("This test is marked as tedious.")(method)

def get_pkg_files(pkg):
    """
    Tries to make a the heterogenous and smallest set of test files from
    package.
    @param pkg must be installed package
    @return list of few files installed by pkg
    """
    cmd = ['rpm', '-ql', pkg.name]
    output = check_output(cmd)
    configs = set()
    docs = set()
    dirs = set()
    files = set()
    symlinks = set()
    for fpath in output.splitlines():   #pylint: disable=E1103
        if (   len(dirs) == 0
           and not os.path.islink(fpath)
           and os.path.isdir(fpath)):
            dirs.add(fpath)
        elif len(symlinks) == 0 and os.path.islink(fpath):
            symlinks.add(fpath)
        elif not os.path.islink(fpath) and os.path.isfile(fpath):
            if len(configs) == 0 and rpmcache.has_pkg_config_file(pkg, fpath):
                configs.add(fpath)
            elif len(docs) == 0 and rpmcache.has_pkg_doc_file(pkg, fpath):
                docs.add(fpath)
            elif len(files) == 0:
                files.add(fpath)
    out = list(configs) + list(docs) + list(dirs) + list(symlinks)
    if len(files) > 0 and len(docs) == 0 and len(symlinks) == 0:
        out += list(files)
    return out

class SoftwareBaseTestCase(unittest.TestCase): #pylint: disable=R0904
    """
    Base class for all LMI Software test classes.
    """

    CLASS_NAME = "Define in subclass"
    KEYS = tuple()

    # will be filled when first needed
    # it's a dictionary with items (pkg_name, [file_path1, ...])
    PKGDB_FILES = None
    REPODB = None

    @classmethod
    def get_pkgdb_files(cls):
        """
        @return dictionary { pkg_name: ["file_path1, ...] }
        """
        if cls.PKGDB_FILES is not None:
            return cls.PKGDB_FILES
        SoftwareBaseTestCase.PKGDB_FILES = res = dict(
                (pkg.name, get_pkg_files(pkg)) for pkg in itertools.chain(
                    cls.safe_pkgs, cls.dangerous_pkgs))
        return res

    @classmethod
    def get_repodb(cls):
        """
        @return list of Repository instances
        """
        if cls.REPODB is not None:
            return cls.REPODB
        SoftwareBaseTestCase.REPODB = res = repository.get_repo_database()
        return res

    @classmethod
    def needs_pkgdb(cls):
        """subclass may override this, if it does not need PKGDB database"""
        return True

    @classmethod
    def needs_pkgdb_files(cls):
        """subclass may override this, if it needs PKGDB_FILES database"""
        return False

    @classmethod
    def needs_repodb(cls):
        """subclass may override this, if it needs REPODB database"""
        return False

    def __init__(self, *args, **kwargs):
        unittest.TestCase.__init__(self, *args, **kwargs)
        self.longMessage = True     #pylint: disable=C0103

    def setUp(self):
        unittest.TestCase.setUp(self)
        self.objpath = pywbem.CIMInstanceName(
                namespace="root/cimv2",
                classname=self.CLASS_NAME,
                keybindings=pywbem.NocaseDict(
                    dict((k, None) for k in self.KEYS)))
        if "CreationClassName" in self.KEYS:
            self.objpath["CreationClassName"] = self.CLASS_NAME
        if "SystemCreationClassName" in self.KEYS:
            self.objpath["SystemCreationClassName"] = "Linux_ComputerSystem"

    def install_pkg(self, pkg, newer=True, repolist=None):
        """
        Use this method instead of function in rpmcache in tests.
        """
        if repolist is None:
            repolist = self.test_repos
        return rpmcache.install_pkg(pkg, newer, repolist)

    def ensure_pkg_installed(self, pkg, newer=True, repolist=None):
        """
        Use this method instead of function in rpmcache in tests.
        """
        if repolist is None:
            repolist = self.test_repos
        return rpmcache.ensure_pkg_installed(pkg, newer, repolist)

    def assertIsSubclass(self, cls, base_cls): #pylint: disable=C0103
        """
        Checks, whether cls is subclass of base_cls from CIM perspective.
        @param cls name of subclass
        @param base_cls name of base class
        """
        if not isinstance(cls, basestring):
            raise TypeError("cls must be a string")
        if not isinstance(base_cls, basestring):
            raise TypeError("base_cls must be a string")
        return self.assertTrue(pywbem.is_subclass(self.conn,
            "root/cimv2", base_cls, cls))

    def assertEqual(self, fst, snd, *args, **kwargs):
        """
        Modify assertEqual for instance names comparing only important
        properties.
        """
        if (   isinstance(fst, pywbem.CIMInstanceName)
           and isinstance(snd, pywbem.CIMInstanceName)
           and fst.classname == snd.classname
           and fst.namespace == snd.namespace
           and fst.keybindings == snd.keybindings):
            return True
        unittest.TestCase.assertEqual(self, fst, snd, *args, **kwargs)

    #pylint: disable=C0103
    def assertRaisesCIM(self, cim_err_code, func, *args, **kwds):
        """
        This test passes if given function called with supplied arguements
        raises pywbem.CIMError with given cim error code.
        """
        with self.assertRaises(pywbem.CIMError) as cm:
            func(*args, **kwds)
        self.assertEqual(cim_err_code, cm.exception.args[0])

    @classmethod
    def setUpClass(cls):    #pylint: disable=C0103
        cls.url = os.environ.get('LMI_CIMOM_URL', 'http://localhost:5988')
        cls.user = os.environ.get('LMI_CIMOM_USERNAME', '')
        cls.password = os.environ.get('LMI_CIMOM_PASSWORD', '')
        cls.broker = os.environ.get('LMI_CIMOM_BROKER', None)
        cls.conn = pywbem.WBEMConnection(cls.url, (cls.user, cls.password))
        cls.run_dangerous = (
                    os.environ.get('LMI_RUN_DANGEROUS', '0') == '1')
        cls.test_repos = os.environ.get(
                'LMI_SOFTWARE_TEST_REPOS', '').split(',')
        use_cache = os.environ.get('LMI_SOFTWARE_USE_CACHE', '0') == '1'
        cls.cache_dir = None
        if use_cache:
            cls.cache_dir = os.environ.get('LMI_SOFTWARE_CACHE_DIR', None)
            if cls.cache_dir is None:
                cls.cache_dir = tempfile.mkdtemp(suffix="software_database")
            if cls.cache_dir:
                cls.prev_dir = os.getcwd()
                if not os.path.exists(cls.cache_dir):
                    os.makedirs(cls.cache_dir)
                # rpm packages are expected to be in CWD
                os.chdir(cls.cache_dir)
        if not hasattr(cls, 'safe_pkgs') or not hasattr(cls, 'dangerous_pkgs'):
            if cls.needs_pkgdb():
                safe, dangerous  = rpmcache.get_pkg_database(
                        use_cache=use_cache,
                        dangerous=cls.run_dangerous,
                        repolist=cls.test_repos,
                        cache_dir=cls.cache_dir if use_cache else None)
                SoftwareBaseTestCase.safe_pkgs = safe
                SoftwareBaseTestCase.dangerous_pkgs = dangerous
            else:
                cls.safe_pkgs = []
                cls.dangerous_pkgs = []
        if cls.needs_pkgdb_files() and not hasattr(cls, 'pkgdb_files'):
            for pkg in cls.dangerous_pkgs:
                if not rpmcache.is_pkg_installed(pkg.name):
                    rpmcache.install_pkg(pkg, repolist=cls.test_repos)
            SoftwareBaseTestCase.pkgdb_files = cls.get_pkgdb_files()
        if cls.needs_repodb() and not hasattr(cls, 'repodb'):
            SoftwareBaseTestCase.repodb = cls.get_repodb()

    @classmethod
    def tearDownClass(cls):     #pylint: disable=C0103
        if hasattr(cls, "repodb") and cls.repodb:
            # set the enabled states to original values
            for repo in cls.repodb:
                if repository.is_repo_enabled(repo) != repo.status:
                    repository.set_repo_enabled(repo, repo.status)
        if cls.run_dangerous:
            for pkg in cls.dangerous_pkgs:
                if rpmcache.is_pkg_installed(pkg.name):
                    rpmcache.remove_pkg(pkg.name)
        if hasattr(cls, "prev_dir"):
            os.chdir(cls.prev_dir)