← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/features.py

Turn completion assertions into separate methods.

Many common assertions used to be expressed as arguments to the complete
method.  This makes the checks more explicit, and the code easier to read.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/features.py
1
 
# Copyright (C) 2009, 2010, 2011 Canonical Ltd
2
 
#
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
#
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
#
13
 
# You should have received a copy of the GNU General Public License
14
 
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
"""A collection of commonly used 'Features' which bzrlib uses to skip tests."""
18
 
 
19
 
import os
20
 
import stat
21
 
import sys
22
 
 
23
 
from bzrlib import (
24
 
    osutils,
25
 
    tests,
26
 
    )
27
 
 
28
 
 
29
 
class _NotRunningAsRoot(tests.Feature):
30
 
 
31
 
    def _probe(self):
32
 
        try:
33
 
            uid = os.getuid()
34
 
        except AttributeError:
35
 
            # If there is no uid, chances are there is no root either
36
 
            return True
37
 
        return uid != 0
38
 
 
39
 
    def feature_name(self):
40
 
        return 'Not running as root'
41
 
 
42
 
 
43
 
not_running_as_root = _NotRunningAsRoot()
44
 
 
45
 
apport = tests.ModuleAvailableFeature('apport')
46
 
gpgme = tests.ModuleAvailableFeature('gpgme')
47
 
lzma = tests.ModuleAvailableFeature('lzma')
48
 
meliae = tests.ModuleAvailableFeature('meliae')
49
 
paramiko = tests.ModuleAvailableFeature('paramiko')
50
 
pycurl = tests.ModuleAvailableFeature('pycurl')
51
 
pywintypes = tests.ModuleAvailableFeature('pywintypes')
52
 
sphinx = tests.ModuleAvailableFeature('sphinx')
53
 
subunit = tests.ModuleAvailableFeature('subunit')
54
 
testtools = tests.ModuleAvailableFeature('testtools')
55
 
 
56
 
 
57
 
class _BackslashDirSeparatorFeature(tests.Feature):
58
 
 
59
 
    def _probe(self):
60
 
        try:
61
 
            os.lstat(os.getcwd() + '\\')
62
 
        except OSError:
63
 
            return False
64
 
        else:
65
 
            return True
66
 
 
67
 
    def feature_name(self):
68
 
        return "Filesystem treats '\\' as a directory separator."
69
 
 
70
 
backslashdir_feature = _BackslashDirSeparatorFeature()
71
 
 
72
 
 
73
 
class _PosixPermissionsFeature(tests.Feature):
74
 
 
75
 
    def _probe(self):
76
 
        def has_perms():
77
 
            # create temporary file and check if specified perms are maintained.
78
 
            import tempfile
79
 
 
80
 
            write_perms = stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR
81
 
            f = tempfile.mkstemp(prefix='bzr_perms_chk_')
82
 
            fd, name = f
83
 
            os.close(fd)
84
 
            os.chmod(name, write_perms)
85
 
 
86
 
            read_perms = os.stat(name).st_mode & 0777
87
 
            os.unlink(name)
88
 
            return (write_perms == read_perms)
89
 
 
90
 
        return (os.name == 'posix') and has_perms()
91
 
 
92
 
    def feature_name(self):
93
 
        return 'POSIX permissions support'
94
 
 
95
 
 
96
 
posix_permissions_feature = _PosixPermissionsFeature()
97
 
 
98
 
 
99
 
class _ChownFeature(tests.Feature):
100
 
    """os.chown is supported"""
101
 
 
102
 
    def _probe(self):
103
 
        return os.name == 'posix' and hasattr(os, 'chown')
104
 
 
105
 
chown_feature = _ChownFeature()
106
 
 
107
 
 
108
 
class ExecutableFeature(tests.Feature):
109
 
    """Feature testing whether an executable of a given name is on the PATH."""
110
 
 
111
 
    def __init__(self, name):
112
 
        super(ExecutableFeature, self).__init__()
113
 
        self.name = name
114
 
        self._path = None
115
 
 
116
 
    @property
117
 
    def path(self):
118
 
        # This is a property, so accessing path ensures _probe was called
119
 
        self.available()
120
 
        return self._path
121
 
 
122
 
    def _probe(self):
123
 
        self._path = osutils.find_executable_on_path(self.name)
124
 
        return self._path is not None
125
 
 
126
 
    def feature_name(self):
127
 
        return '%s executable' % self.name
128
 
 
129
 
 
130
 
bash_feature = ExecutableFeature('bash')
131
 
sed_feature = ExecutableFeature('sed')
132
 
diff_feature = ExecutableFeature('diff')
133
 
 
134
 
 
135
 
class Win32Feature(tests.Feature):
136
 
    """Feature testing whether we're running selftest on Windows
137
 
    or Windows-like platform.
138
 
    """
139
 
 
140
 
    def _probe(self):
141
 
        return sys.platform == 'win32'
142
 
 
143
 
    def feature_name(self):
144
 
        return "win32 platform"
145
 
 
146
 
win32_feature = Win32Feature()