• Get Review Board
  • What's New
  • Products
  • Review Board Code review, image review, and document review
  • Documentation
  • Release Notes
  • Power Pack Enterprise integrations, reports, and enhanced document review
  • Try for 60 Days
  • Purchase
  • RBCommons Review Board as a Service, hosted by us
  • Pricing
  • RBTools Command line tools and Python API for Review Board
  • Documentation
  • Release Notes
  • Review Bot Automated code review, connecting tools you already use
  • Documentation
  • Release Notes
  • RB Gateway Manage Git and Mercurial repositories in your network
  • Documentation
  • Release Notes
  • Learn and Explore
  • What is Code Review?
  • Documentation
  • Frequently Asked Questions
  • Support Options
  • Third-Party Integrations
  • Demo
  • Review Board RBTools Power Pack Review Bot Djblets RB Gateway
    1. RBTools 5.x
    2. Version 5.x
    3. Version 4.x
    4. Version 3.x
    5. Version 2.0
    6. Version 1.0
    7. Version 0.7
    8. Version 0.6
    9. Version 0.5
    10. RBTools Python API
    11. Module and Class References
    12. rbtools.testing.commands
  • Home
  • Installing RBTools
  • rbt Command
  • Configuration
  • Authenticating to Review Board
  • Repository Configuration
  • Per-User Configuration
  • Team Foundation Server Configuration
  • Commands
  • alias
  • api-get
  • attach
  • clear-cache
  • close
  • diff
  • install
  • land
  • list-repo-types
  • login
  • logout
  • patch
  • post
  • publish
  • review
  • setup-completion
  • setup-repo
  • stamp
  • status
  • status-update
  • RBTools Workflows
  • Using RBTools With Cliosoft SOS
  • Using RBTools with Git
  • Using RBTools with HCL VersionVault and IBM ClearCase
  • Using RBTools With Perforce
  • RBTools Python API
  • Overview of the Python API Client
  • Tutorial
  • Resource-Specific Functionality
  • Module and Class References
  • rbtools
  • rbtools.deprecation
  • rbtools.api
  • rbtools.api.cache
  • rbtools.api.capabilities
  • rbtools.api.client
  • rbtools.api.decode
  • rbtools.api.decorators
  • rbtools.api.errors
  • rbtools.api.factory
  • rbtools.api.request
  • rbtools.api.resource
  • rbtools.api.transport
  • rbtools.api.transport.sync
  • rbtools.api.utils
  • rbtools.clients
  • rbtools.clients.base
  • rbtools.clients.base.patch
  • rbtools.clients.base.registry
  • rbtools.clients.base.repository
  • rbtools.clients.base.scmclient
  • rbtools.clients.errors
  • rbtools.clients.bazaar
  • rbtools.clients.clearcase
  • rbtools.clients.cvs
  • rbtools.clients.git
  • rbtools.clients.mercurial
  • rbtools.clients.perforce
  • rbtools.clients.plastic
  • rbtools.clients.sos
  • rbtools.clients.svn
  • rbtools.clients.tfs
  • rbtools.config
  • rbtools.config.config
  • rbtools.config.loader
  • rbtools.diffs
  • rbtools.diffs.patches
  • rbtools.diffs.patcher
  • rbtools.diffs.tools
  • rbtools.diffs.tools.backends
  • rbtools.diffs.tools.backends.gnu
  • rbtools.diffs.tools.base
  • rbtools.diffs.tools.base.diff_file_result
  • rbtools.diffs.tools.base.diff_tool
  • rbtools.diffs.tools.errors
  • rbtools.diffs.tools.registry
  • rbtools.diffs.writers
  • rbtools.commands
  • rbtools.commands.main
  • rbtools.commands
  • rbtools.commands.base
  • rbtools.commands.base.commands
  • rbtools.commands.base.errors
  • rbtools.commands.base.options
  • rbtools.commands.base.output
  • rbtools.commands.alias
  • rbtools.commands.api_get
  • rbtools.commands.attach
  • rbtools.commands.clearcache
  • rbtools.commands.close
  • rbtools.commands.diff
  • rbtools.commands.info
  • rbtools.commands.install
  • rbtools.commands.land
  • rbtools.commands.list_repo_types
  • rbtools.commands.login
  • rbtools.commands.logout
  • rbtools.commands.patch
  • rbtools.commands.post
  • rbtools.commands.publish
  • rbtools.commands.review
  • rbtools.commands.setup_completion
  • rbtools.commands.setup_repo
  • rbtools.commands.stamp
  • rbtools.commands.status
  • rbtools.commands.status_update
  • rbtools.hooks
  • rbtools.hooks.common
  • rbtools.hooks.git
  • rbtools.testing
  • rbtools.testing.api
  • rbtools.testing.api.payloads
  • rbtools.testing.api.transport
  • rbtools.testing.commands
  • rbtools.testing.testcase
  • rbtools.testing.transport
  • rbtools.utils
  • rbtools.utils.aliases
  • rbtools.utils.browser
  • rbtools.utils.checks
  • rbtools.utils.commands
  • rbtools.utils.console
  • rbtools.utils.diffs
  • rbtools.utils.encoding
  • rbtools.utils.errors
  • rbtools.utils.filesystem
  • rbtools.utils.graphs
  • rbtools.utils.mimetypes
  • rbtools.utils.process
  • rbtools.utils.repository
  • rbtools.utils.review_request
  • rbtools.utils.source_tree
  • rbtools.utils.users
  • Glossary
  • General Index
  • Python Module Index
  • Release Notes
  • rbtools.testing.commands¶

    Command unit testing support.

    New in version 3.1.

    Classes

    CommandTestsMixin(*args, **kwargs)

    Mixin for unit tests for commands.

    RunCommandResult

    The result form a run_command operation.

    class rbtools.testing.commands.RunCommandResult[source]¶

    Bases: TypedDict, Generic[_CommandT]

    The result form a run_command operation.

    New in version 5.0.

    command: _CommandT¶

    The command instance that was executed.

    exit_code: Optional[Union[int, str]]¶

    The exit code of the command.

    json: dict[str, Any]¶

    The JSON results of the command.

    stderr: bytes¶

    Standard error output from the command.

    stdout: bytes¶

    Standard output from the command.

    __closed__ = False¶
    __extra_items__ = None¶
    __mutable_keys__ = frozenset({'command', 'exit_code', 'json', 'stderr', 'stdout'})¶
    __optional_keys__ = frozenset({})¶
    __orig_bases__ = (<function TypedDict>, typing.Generic[~_CommandT])¶
    __parameters__ = (~_CommandT,)¶
    __readonly_keys__ = frozenset({})¶
    __required_keys__ = frozenset({'command', 'exit_code', 'json', 'stderr', 'stdout'})¶
    __total__ = True¶
    class rbtools.testing.commands.CommandTestsMixin(*args, **kwargs)[source]¶

    Bases: SpyAgency, Generic[_CommandT]

    Mixin for unit tests for commands.

    This provides utility commands for creating and running commands in a controlled environment, allowing API URLs to be created and output and exit codes to be captured.

    Subclasses must provide the type of the class as a generic to the mixin, and set command_cls appropriately.

    Changed in version 5.0: Added generic support for the mixin, to type command classes and instances.

    New in version 3.1.

    command_cls: Optional[type[_CommandT]] = None¶

    The command class being tested.

    This must be a subclass of rbtools.commands.Command.

    Type:

    type

    needs_temp_home = True[source]¶
    DEFAULT_SERVER_URL = 'https://reviews.example.com/'[source]¶
    create_command(*, args: Optional[list[str]] = None, server_url: str = 'https://reviews.example.com/', initialize: bool = False, **kwargs) → _CommandT[source]¶

    Create an argument parser with the given extra fields.

    Parameters:
    • args (list of str, optional) –

      A list of command line arguments to be passed to the parser.

      The command line will receive each item in the list.

    • server_url (str, optional) – The URL to use as the Review Board URL.

    • initialize (bool, optional) – Whether to initialize the command before returning.

    • **kwargs (dict) – Additional keyword arguments.

    Returns:

    The command instance.

    Return type:

    rbtools.commands.base.commands.BaseCommand

    run_command(args: Optional[list[str]] = None, server_url: str = 'https://reviews.example.com/', **kwargs) → RunCommandResult[_CommandT][source]¶

    Run a command class and return results.

    Parameters:
    • args (list of str, optional) –

      A list of command line arguments to be passed to the parser.

      The command line will receive each item in the list.

    • server_url (str, optional) – The URL to use as the Review Board URL.

    • **kwargs (dict) – Additional keyword arguments.

    Returns:

    A dictionary of results from the command execution. See RunCommandResult for details.

    Return type:

    dict

    __orig_bases__ = (<class 'kgb.agency.SpyAgency'>, typing.Generic[~_CommandT])¶
    __parameters__ = (~_CommandT,)¶

    Keep up with the latest Review Board releases, security updates, and helpful information.

    About
    News
    Demo
    RBCommons Hosting
    Integrations
    Happy Users
    Support Options
    Documentation
    FAQ
    User Manual
    RBTools
    Administration Guide
    Power Pack
    Release Notes
    Downloads
    Review Board
    RBTools
    Djblets
    Power Pack
    Package Store
    PGP Signatures
    Contributing
    Bug Tracker
    Submit Patches
    Development Setup
    Wiki
    Follow Us
    Mailing Lists
    Reddit
    Twitter
    Mastodon
    Facebook
    YouTube

    Copyright © 2006-2025 Beanbag, Inc. All rights reserved.

    Terms of Service — Privacy Policy — AI Ethics Policy — Branding

    On this page

    • [Top]
    • RunCommandResult
      • RunCommandResult.command
      • RunCommandResult.exit_code
      • RunCommandResult.json
      • RunCommandResult.stderr
      • RunCommandResult.stdout
      • RunCommandResult.__closed__
      • RunCommandResult.__extra_items__
      • RunCommandResult.__mutable_keys__
      • RunCommandResult.__optional_keys__
      • RunCommandResult.__orig_bases__
      • RunCommandResult.__parameters__
      • RunCommandResult.__readonly_keys__
      • RunCommandResult.__required_keys__
      • RunCommandResult.__total__
    • CommandTestsMixin
      • CommandTestsMixin.command_cls
      • CommandTestsMixin.needs_temp_home
      • CommandTestsMixin.DEFAULT_SERVER_URL
      • CommandTestsMixin.create_command()
      • CommandTestsMixin.run_command()
      • CommandTestsMixin.__orig_bases__
      • CommandTestsMixin.__parameters__