/usr/share/pyshared/bzrlib/tests/features.py is in python-bzrlib.tests 2.5.0-2ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 | # Copyright (C) 2009, 2010, 2011 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
"""A collection of commonly used 'Features' to optionally run tests.
"""
import os
import subprocess
import stat
import sys
import tempfile
from bzrlib import (
osutils,
symbol_versioning,
)
class Feature(object):
"""An operating system Feature."""
def __init__(self):
self._available = None
def available(self):
"""Is the feature available?
:return: True if the feature is available.
"""
if self._available is None:
self._available = self._probe()
return self._available
def _probe(self):
"""Implement this method in concrete features.
:return: True if the feature is available.
"""
raise NotImplementedError
def __str__(self):
if getattr(self, 'feature_name', None):
return self.feature_name()
return self.__class__.__name__
class _SymlinkFeature(Feature):
def _probe(self):
return osutils.has_symlinks()
def feature_name(self):
return 'symlinks'
SymlinkFeature = _SymlinkFeature()
class _HardlinkFeature(Feature):
def _probe(self):
return osutils.has_hardlinks()
def feature_name(self):
return 'hardlinks'
HardlinkFeature = _HardlinkFeature()
class _OsFifoFeature(Feature):
def _probe(self):
return getattr(os, 'mkfifo', None)
def feature_name(self):
return 'filesystem fifos'
OsFifoFeature = _OsFifoFeature()
class _UnicodeFilenameFeature(Feature):
"""Does the filesystem support Unicode filenames?"""
def _probe(self):
try:
# Check for character combinations unlikely to be covered by any
# single non-unicode encoding. We use the characters
# - greek small letter alpha (U+03B1) and
# - braille pattern dots-123456 (U+283F).
os.stat(u'\u03b1\u283f')
except UnicodeEncodeError:
return False
except (IOError, OSError):
# The filesystem allows the Unicode filename but the file doesn't
# exist.
return True
else:
# The filesystem allows the Unicode filename and the file exists,
# for some reason.
return True
UnicodeFilenameFeature = _UnicodeFilenameFeature()
class _CompatabilityThunkFeature(Feature):
"""This feature is just a thunk to another feature.
It issues a deprecation warning if it is accessed, to let you know that you
should really use a different feature.
"""
def __init__(self, dep_version, module, name,
replacement_name, replacement_module=None):
super(_CompatabilityThunkFeature, self).__init__()
self._module = module
if replacement_module is None:
replacement_module = module
self._replacement_module = replacement_module
self._name = name
self._replacement_name = replacement_name
self._dep_version = dep_version
self._feature = None
def _ensure(self):
if self._feature is None:
from bzrlib import pyutils
depr_msg = self._dep_version % ('%s.%s'
% (self._module, self._name))
use_msg = ' Use %s.%s instead.' % (self._replacement_module,
self._replacement_name)
symbol_versioning.warn(depr_msg + use_msg, DeprecationWarning,
stacklevel=5)
# Import the new feature and use it as a replacement for the
# deprecated one.
self._feature = pyutils.get_named_object(
self._replacement_module, self._replacement_name)
def _probe(self):
self._ensure()
return self._feature._probe()
class ModuleAvailableFeature(Feature):
"""This is a feature than describes a module we want to be available.
Declare the name of the module in __init__(), and then after probing, the
module will be available as 'self.module'.
:ivar module: The module if it is available, else None.
"""
def __init__(self, module_name):
super(ModuleAvailableFeature, self).__init__()
self.module_name = module_name
def _probe(self):
sentinel = object()
module = sys.modules.get(self.module_name, sentinel)
if module is sentinel:
try:
self._module = __import__(self.module_name, {}, {}, [''])
return True
except ImportError:
return False
else:
self._module = module
return True
@property
def module(self):
if self.available():
return self._module
return None
def feature_name(self):
return self.module_name
class _HTTPSServerFeature(Feature):
"""Some tests want an https Server, check if one is available.
Right now, the only way this is available is under python2.6 which provides
an ssl module.
"""
def _probe(self):
try:
import ssl
return True
except ImportError:
return False
def feature_name(self):
return 'HTTPSServer'
HTTPSServerFeature = _HTTPSServerFeature()
class _ByteStringNamedFilesystem(Feature):
"""Is the filesystem based on bytes?"""
def _probe(self):
if os.name == "posix":
return True
return False
ByteStringNamedFilesystem = _ByteStringNamedFilesystem()
class _UTF8Filesystem(Feature):
"""Is the filesystem UTF-8?"""
def _probe(self):
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
return True
return False
UTF8Filesystem = _UTF8Filesystem()
class _BreakinFeature(Feature):
"""Does this platform support the breakin feature?"""
def _probe(self):
from bzrlib import breakin
if breakin.determine_signal() is None:
return False
if sys.platform == 'win32':
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
# We trigger SIGBREAK via a Console api so we need ctypes to
# access the function
try:
import ctypes
except OSError:
return False
return True
def feature_name(self):
return "SIGQUIT or SIGBREAK w/ctypes on win32"
BreakinFeature = _BreakinFeature()
class _CaseInsCasePresFilenameFeature(Feature):
"""Is the file-system case insensitive, but case-preserving?"""
def _probe(self):
fileno, name = tempfile.mkstemp(prefix='MixedCase')
try:
# first check truly case-preserving for created files, then check
# case insensitive when opening existing files.
name = osutils.normpath(name)
base, rel = osutils.split(name)
found_rel = osutils.canonical_relpath(base, name)
return (found_rel == rel
and os.path.isfile(name.upper())
and os.path.isfile(name.lower()))
finally:
os.close(fileno)
os.remove(name)
def feature_name(self):
return "case-insensitive case-preserving filesystem"
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
class _CaseInsensitiveFilesystemFeature(Feature):
"""Check if underlying filesystem is case-insensitive but *not* case
preserving.
"""
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
# more likely to be case preserving, so this case is rare.
def _probe(self):
if CaseInsCasePresFilenameFeature.available():
return False
from bzrlib import tests
if tests.TestCaseWithMemoryTransport.TEST_ROOT is None:
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
tests.TestCaseWithMemoryTransport.TEST_ROOT = root
else:
root = tests.TestCaseWithMemoryTransport.TEST_ROOT
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
dir=root)
name_a = osutils.pathjoin(tdir, 'a')
name_A = osutils.pathjoin(tdir, 'A')
os.mkdir(name_a)
result = osutils.isdir(name_A)
tests._rmtree_temp_dir(tdir)
return result
def feature_name(self):
return 'case-insensitive filesystem'
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
class _CaseSensitiveFilesystemFeature(Feature):
def _probe(self):
if CaseInsCasePresFilenameFeature.available():
return False
elif CaseInsensitiveFilesystemFeature.available():
return False
else:
return True
def feature_name(self):
return 'case-sensitive filesystem'
# new coding style is for feature instances to be lowercase
case_sensitive_filesystem_feature = _CaseSensitiveFilesystemFeature()
class _NotRunningAsRoot(Feature):
def _probe(self):
try:
uid = os.getuid()
except AttributeError:
# If there is no uid, chances are there is no root either
return True
return uid != 0
def feature_name(self):
return 'Not running as root'
not_running_as_root = _NotRunningAsRoot()
apport = ModuleAvailableFeature('apport')
gpgme = ModuleAvailableFeature('gpgme')
lzma = ModuleAvailableFeature('lzma')
meliae = ModuleAvailableFeature('meliae.scanner')
paramiko = ModuleAvailableFeature('paramiko')
pycurl = ModuleAvailableFeature('pycurl')
pywintypes = ModuleAvailableFeature('pywintypes')
sphinx = ModuleAvailableFeature('sphinx')
subunit = ModuleAvailableFeature('subunit')
testtools = ModuleAvailableFeature('testtools')
compiled_patiencediff_feature = ModuleAvailableFeature(
'bzrlib._patiencediff_c')
lsprof_feature = ModuleAvailableFeature('bzrlib.lsprof')
class _BackslashDirSeparatorFeature(Feature):
def _probe(self):
try:
os.lstat(os.getcwd() + '\\')
except OSError:
return False
else:
return True
def feature_name(self):
return "Filesystem treats '\\' as a directory separator."
backslashdir_feature = _BackslashDirSeparatorFeature()
class _ChownFeature(Feature):
"""os.chown is supported"""
def _probe(self):
return os.name == 'posix' and hasattr(os, 'chown')
chown_feature = _ChownFeature()
class ExecutableFeature(Feature):
"""Feature testing whether an executable of a given name is on the PATH."""
def __init__(self, name):
super(ExecutableFeature, self).__init__()
self.name = name
self._path = None
@property
def path(self):
# This is a property, so accessing path ensures _probe was called
self.available()
return self._path
def _probe(self):
self._path = osutils.find_executable_on_path(self.name)
return self._path is not None
def feature_name(self):
return '%s executable' % self.name
bash_feature = ExecutableFeature('bash')
diff_feature = ExecutableFeature('diff')
sed_feature = ExecutableFeature('sed')
msgmerge_feature = ExecutableFeature('msgmerge')
class _PosixPermissionsFeature(Feature):
def _probe(self):
def has_perms():
# Create temporary file and check if specified perms are
# maintained.
write_perms = stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR
f = tempfile.mkstemp(prefix='bzr_perms_chk_')
fd, name = f
os.close(fd)
osutils.chmod_if_possible(name, write_perms)
read_perms = os.stat(name).st_mode & 0777
os.unlink(name)
return (write_perms == read_perms)
return (os.name == 'posix') and has_perms()
def feature_name(self):
return 'POSIX permissions support'
posix_permissions_feature = _PosixPermissionsFeature()
class _StraceFeature(Feature):
def _probe(self):
try:
proc = subprocess.Popen(['strace'],
stderr=subprocess.PIPE,
stdout=subprocess.PIPE)
proc.communicate()
return True
except OSError, e:
if e.errno == errno.ENOENT:
# strace is not installed
return False
else:
raise
def feature_name(self):
return 'strace'
strace_feature = _StraceFeature()
class _AttribFeature(Feature):
def _probe(self):
if (sys.platform not in ('cygwin', 'win32')):
return False
try:
proc = subprocess.Popen(['attrib', '.'], stdout=subprocess.PIPE)
except OSError, e:
return False
return (0 == proc.wait())
def feature_name(self):
return 'attrib Windows command-line tool'
AttribFeature = _AttribFeature()
class Win32Feature(Feature):
"""Feature testing whether we're running selftest on Windows
or Windows-like platform.
"""
def _probe(self):
return sys.platform == 'win32'
def feature_name(self):
return "win32 platform"
win32_feature = Win32Feature()
|