[Notes] [Git][BuildStream/buildstream][phil/plugin-testing-api] 2 commits: runcli.py: add user facing documentation



Title: GitLab

Phil Dawson pushed to branch phil/plugin-testing-api at BuildStream / buildstream

Commits:

1 changed file:

Changes:

  • buildstream/plugintestutils/runcli.py
    1
    +#
    
    2
    +#  Copyright (C) 2017 Codethink Limited
    
    3
    +#  Copyright (C) 2018 Bloomberg Finance LP
    
    4
    +#
    
    5
    +#  This program is free software; you can redistribute it and/or
    
    6
    +#  modify it under the terms of the GNU Lesser General Public
    
    7
    +#  License as published by the Free Software Foundation; either
    
    8
    +#  version 2 of the License, or (at your option) any later version.
    
    9
    +#
    
    10
    +#  This library is distributed in the hope that it will be useful,
    
    11
    +#  but WITHOUT ANY WARRANTY; without even the implied warranty of
    
    12
    +#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
    
    13
    +#  Lesser General Public License for more details.
    
    14
    +#
    
    15
    +#  You should have received a copy of the GNU Lesser General Public
    
    16
    +#  License along with this library. If not, see <http://www.gnu.org/licenses/>.
    
    17
    +"""runcli - Test fixtures used for running BuildStream commands
    
    18
    +============================================================
    
    19
    +
    
    20
    +:function:'cli' Use result = cli.run([arg1, arg2]) to run buildstream commands
    
    21
    +
    
    22
    +:function:'cli_integration' A variant of the main fixture that keeps persistent
    
    23
    +                            artifact and source caches. It also does not use
    
    24
    +                            the click test runner to avoid deadlock issues when
    
    25
    +                            running `bst shell`, but unfortunately cannot produce
    
    26
    +                            nice stacktraces.
    
    27
    +
    
    28
    +"""
    
    29
    +
    
    30
    +
    
    1 31
     import os
    
    2 32
     import re
    
    3 33
     import sys
    



  • [Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]