~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/__init__.py

• browse files at revision 2399.1.6
• compare with another revision
• compare with revision 2485.8.58
• download diff
• download tarball
• view history from revision 2399.1.6

Show diffs side-by-side

added

removed

bzrlib/tests/__init__.py

872

872

        """Assert that a callable raises a particular exception.

873

873

 

874

874

        :param excClass: As for the except statement, this may be either an

875

 

        exception class, or a tuple of classes.

 

875

            exception class, or a tuple of classes.

 

876

        :param func: A callable, will be passed ``*args`` and ``**kwargs``.

876

877

 

877

878

        Returns the exception so that you can examine it.

878

879

        """

962

963

        :param args: The positional arguments for the callable

963

964

        :param kwargs: The keyword arguments for the callable

964

965

        :return: A tuple (warnings, result). result is the result of calling

965

 

            a_callable(*args, **kwargs).

 

966

            a_callable(``*args``, ``**kwargs``).

966

967

        """

967

968

        local_warnings = []

968

969

        def capture_warnings(msg, cls=None, stacklevel=None):

982

983

        """Call a deprecated callable without warning the user.

983

984

 

984

985

        :param deprecation_format: The deprecation format that the callable

985

 

            should have been deprecated with. This is the same type as the 

986

 

            parameter to deprecated_method/deprecated_function. If the 

 

986

            should have been deprecated with. This is the same type as the

 

987

            parameter to deprecated_method/deprecated_function. If the

987

988

            callable is not deprecated with this format, an assertion error

988

989

            will be raised.

989

990

        :param a_callable: A callable to call. This may be a bound method or

990

 

            a regular function. It will be called with *args and **kwargs.

 

991

            a regular function. It will be called with ``*args`` and

 

992

            ``**kwargs``.

991

993

        :param args: The positional arguments for the callable

992

994

        :param kwargs: The keyword arguments for the callable

993

 

        :return: The result of a_callable(*args, **kwargs)

 

995

        :return: The result of a_callable(``*args``, ``**kwargs``)

994

996

        """

995

997

        call_warnings, result = self._capture_warnings(a_callable,

996

998

            *args, **kwargs)

1281

1283

        This sends the stdout/stderr results into the test's log,

1282

1284

        where it may be useful for debugging.  See also run_captured.

1283

1285

 

1284

 

        :param stdin: A string to be used as stdin for the command.

1285

 

        :param retcode: The status code the command should return

1286

 

        :param working_dir: The directory to run the command in

 

1286

        :keyword stdin: A string to be used as stdin for the command.

 

1287

        :keyword retcode: The status code the command should return

 

1288

        :keyword working_dir: The directory to run the command in

1287

1289

        """

1288

1290

        retcode = kwargs.pop('retcode', 0)

1289

1291

        encoding = kwargs.pop('encoding', None)

1301

1303

 

1302

1304

    def run_bzr_error(self, error_regexes, *args, **kwargs):

1303

1305

        """Run bzr, and check that stderr contains the supplied regexes

1304

 

        

1305

 

        :param error_regexes: Sequence of regular expressions which 

 

1306

 

 

1307

        :param error_regexes: Sequence of regular expressions which

1306

1308

            must each be found in the error output. The relative ordering

1307

1309

            is not enforced.

1308

1310

        :param args: command-line arguments for bzr

1309

1311

        :param kwargs: Keyword arguments which are interpreted by run_bzr

1310

1312

            This function changes the default value of retcode to be 3,

1311

1313

            since in most cases this is run when you expect bzr to fail.

1312

 

        :return: (out, err) The actual output of running the command (in case you

1313

 

                 want to do more inspection)

1314

 

 

1315

 

        Examples of use:

 

1314

        :return: (out, err) The actual output of running the command (in case

 

1315

            you want to do more inspection)

 

1316

 

 

1317

        Examples of use::

 

1318

 

1316

1319

            # Make sure that commit is failing because there is nothing to do

1317

1320

            self.run_bzr_error(['no changes to commit'],

1318

1321

                               'commit', '-m', 'my commit comment')

1337

1340

        handling, or early startup code, etc.  Subprocess code can't be 

1338

1341

        profiled or debugged so easily.

1339

1342

 

1340

 

        :param retcode: The status code that is expected.  Defaults to 0.  If

 

1343

        :keyword retcode: The status code that is expected.  Defaults to 0.  If

1341

1344

            None is supplied, the status code is not checked.

1342

 

        :param env_changes: A dictionary which lists changes to environment

 

1345

        :keyword env_changes: A dictionary which lists changes to environment

1343

1346

            variables. A value of None will unset the env variable.

1344

1347

            The values must be strings. The change will only occur in the

1345

1348

            child, so you don't need to fix the environment after running.

1346

 

        :param universal_newlines: Convert CRLF => LF

1347

 

        :param allow_plugins: By default the subprocess is run with

 

1349

        :keyword universal_newlines: Convert CRLF => LF

 

1350

        :keyword allow_plugins: By default the subprocess is run with

1348

1351

            --no-plugins to ensure test reproducibility. Also, it is possible

1349

1352

            for system-wide plugins to create unexpected output on stderr,

1350

1353

            which can cause unnecessary test failures.

1714

1717

        """Get a URL (or maybe a path for the plain old vfs transport.

1715

1718

 

1716

1719

        This will never be a smart protocol.

 

1720

 

1717

1721

        :param relpath: provides for clients to get a path relative to the base

1718

1722

            url.  These should only be downwards relative, not upwards.

 

1723

        :return: A URL

1719

1724

        """

1720

1725

        base = self.get_vfs_only_server().get_url()

1721

1726

        return self._adjust_url(base, relpath)

1884

1889

        This assumes that all the elements in the tree being built are new.

1885

1890

 

1886

1891

        This doesn't add anything to a branch.

 

1892

 

1887

1893

        :param line_endings: Either 'binary' or 'native'

1888

 

                             in binary mode, exact contents are written

1889

 

                             in native mode, the line endings match the

1890

 

                             default platform endings.

1891

 

 

1892

 

        :param transport: A transport to write to, for building trees on 

1893

 

                          VFS's. If the transport is readonly or None,

1894

 

                          "." is opened automatically.

 

1894

            in binary mode, exact contents are written in native mode, the

 

1895

            line endings match the default platform endings.

 

1896

        :param transport: A transport to write to, for building trees on VFS's.

 

1897

            If the transport is readonly or None, "." is opened automatically.

 

1898

        :return: None

1895

1899

        """

1896

1900

        # It's OK to just create them using forward slashes on windows.

1897

1901

        if transport is None or transport.is_readonly():

• Older »

Loggerhead is a web-based interface for Breezy
Version: 2.0.1