Metadata-Version: 1.1
Name: testcube-client
Version: 0.7.3
Summary: A Python client for testcube. (https://github.com/tobyqin/testcube)
Home-page: https://github.com/tobyqin/testcube-client
Author: Toby Qin
Author-email: toby.qin@live.com
License: MIT license
Description-Content-Type: UNKNOWN
Description: ===============
        testcube-client
        ===============
        
        
        .. image:: https://img.shields.io/pypi/v/testcube-client.svg
                :target: https://pypi.python.org/pypi/testcube-client
        
        .. image:: https://img.shields.io/travis/tobyqin/testcube-client.svg
                :target: https://travis-ci.org/tobyqin/testcube-client
        
        .. image:: https://pyup.io/repos/github/tobyqin/testcube-client/shield.svg
             :target: https://pyup.io/repos/github/tobyqin/testcube-client/
             :alt: Updates
        
        
        A Python client for testcube.
        
        
        * Free software: MIT license
        * TestCube Project: https://github.com/tobyqin/testcube
        * TestCube Client Project: https://github.com/tobyqin/testcube-client
        
        
        Get Started
        -----------
        
        You should have python 2.7 or 3.x installed on your machine. Then follow steps here.
        
        Installation
        ~~~~~~~~~~~~
        Install testcube-client via pip is the most easy way.
        
        ::
        
          pip install testcube-client -U
        
        Register to Server
        ~~~~~~~~~~~~~~~~~~
        
        You must have a TestCube_ server deployed at somewhere, then run ``--register`` command.::
        
          testcube-client --register http://testcube-server:8000
        
        Upload Run Results
        ~~~~~~~~~~~~~~~~~~
        
        Once you registered to a server, you will have 2 ways to upload test results,
        first choice is calling ``--start-run`` at the beginning and calling ``--finish--run`` when finished.::
        
          # call --start-run before run started
          testcube-client --start-run -name "nightly run for testcube"  --team Core --product TestCube
        
          # call --finish-run after run finished
           testcube-client --finish-run --xunit-files "**/results/*.xml"
        
        In this way, TestCube will record the **exact** ``start_time`` and ``end_time`` for the run.
        
        Another choice is using ``--run`` command to upload test results like a batch.::
        
          # put this command at the end of a run
          testcube-client --run -n "smoke tests for testcube" -t XPower -p TestCube -v v1.0 -x "**/smoke*.xml"
        
        With this choice, TestCube will use current time as ``end_time`` for the run, and guess ``start_time``
        according to run duration.
        
        Upload Result Files
        ~~~~~~~~~~~~~~~~~~~
        
        Sometimes your test will generate result files, for example, screenshots, log files. These files are useful
        when analyze test failure, so we can upload them to TestCube as well::
        
          # call --result-files to upload files
          testcube-client --result-files "**/*.png"
        
          # use -i as a shortcut
          testcube-client -i "**/*.jpg"
        
        Note: your result file should contains test case name so that TestCube can link these to a result,
        e.g. if your test case name is "test_student_login", then the result file should like "test_student_login_failed.png".
        
        If you want to rerun a result by id, you can run the case by your script and generate xml files again,
        then upload your files again::
        
          # call --rerun-result to refresh a result
          testcube-client --rerun-result 12345 -x "**/*.xml" -i "**/*.png"
        
        Command-line Options
        ~~~~~~~~~~~~~~~~~~~~
        
        The optional arguments::
        
          -h, --help            show this help message and exit
          -r REGISTER, --register REGISTER
                                Register to the TestCube server, e.g.
                                http://server:8000
          -run, --run           Upload run info at one time, require team,product,name
                                and xunit files.
          -start, --start-run   Start a run, require team, product and a name.
          -finish, --finish-run
                                Finish a run, require xunit files.
          -x XUNIT_FILES, --xunit-files XUNIT_FILES
                                Specify the xunit xml results, e.g "**/result*.xml"
          -i RESULT_FILES, --result-files RESULT_FILES
                                Specify the result files, e.g "**/output/**/*.png"
          -n NAME, --name NAME  Specify the run name.
          -t TEAM, --team TEAM  Specify the team name.
          -p PRODUCT, --product PRODUCT
                                Specify the product name.
          -v PRODUCT_VERSION, --product-version PRODUCT_VERSION
                                Specify the product version. [Optional]
          -f, --force           Force the action, support --register command.
          -vb, --verbose        Show verbose log info.
        
        
        .. _TestCube: https://github.com/tobyqin/testcube
        
        
        =======
        History
        =======
        
        0.7.0 (2017-10-25)
        ------------------
        * Support server version v1.2
        * Able to handle pending task, for example:
        * testcube-client --handle-task
        * Able to rerun a result by reset id, for example:
        * testcube-client --reset-result 12345 -x "**/*.xml"
        
        0.6.0 (2017-09-07)
        ------------------
        * Able to upload result files using argument --result-files
        * testcube-client --result-files "**/*.png"
        
        0.5.0 (2017-07-07)
        ------------------
        * Update due to testcube model changed, not compatible with prev versions
        
        0.3.3 (2017-06-29)
        ------------------
        * Improve run url in output.
        * Bug fix - run duration data incorrect.
        * Abort run if failed to analyze its xml.
        * Always summarize run duration from test cases.
        * Bug fix - unicode exception message in python 2.
        * Bug fix - multiple cache hits error.
        
        0.2.2 (2017-06-13)
        ------------------
        * Support --force command when register a server.
        * Sum the testsuite time from testcases if there is no time attribute in result xml.
        * Fix document moved header issue when server deployed in IIS server.
        * Add cache to improve performance.
        * Fix import error.
        
        0.1.3 (2017-06-12)
        ------------------
        
        * Support register to TestCub server.
        * Support --run command.
        * Support --start-run command.
        * Support --finish-run command.
        
        0.1.0 (2017-06-08)
        ------------------
        
        * First release on PyPI.
        
Keywords: testcube,testcube-client,test platform,test client
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
