Metadata-Version: 1.1
Name: TempestParser
Version: 0.2.60
Summary: Tempest Parser tool used to generate trending reports out of various result formats: pytest's CLI, Rally's XML,JSON, jUnit XML (with v4 schema support), CSV (two types).
Home-page: https://github.com/savex/tempest-parser
Author: Alex Savatieiev
Author-email: a.savex@gmail.com
License: Apache Licence, version 2
Description: ======= Foreword
        
        When you running tempest, you probably want to review result in a human manner.
        You running it once again...
        and again...
        and a couple times more the next day...
        ...you end up with 20+ files in '.testrepository' folder.
        Start digging how specific tempest test was executed yesterday,
        how changed result is today. 'grep', 'less'... Brain goes hot.
        
        Honestly,
        Subunit's CLI output is good enough for reading the word PASSED at the end...
        ...and the summary.
        
        So, there is a need to:
        - import tempest tests results
        - match tests by Class, test_name and options
        - produce some sort of a report to work with test statuses and track them over time
        - Have error messages be added to the report
        
        ======= Installing
        
        Latest published version can be obtained using pip:
        
            pip install tempestparser
        
        or using setup.py from cloned git repo
        
            python setup.py install
        
        ======= Usage
        
        This util is originally intended for 'import-match-export' flow to produce CSV
        with tests matched by Class and name against the list of tests that was
        originally executed.
        
            tparser -c matched.csv tempest.log
        
        Folder also can be used:
        
            tparser -c matched.csv folder1
        
        HTML report
        
            tparser -f t_xml -r trending.html tempest.xml
        
        or
        
            tparser -f t_xml -r trending.html folder1
        
        also, you can add full traceback messages to report by adding -d switch
        
            tparser -f t_xml -r trending.html -d folder1
        
        In order to eliminate some time wasting scrolling of report back and forth,
        you can produce unique errors report (see below).
        Please, note that here you must supply single test run file
        
            tparser -e errors.html single_run.json
        
        This report matches FAILs and SKIPs by main 'message' to produce unique errors
        and skips list. If main message is not there it tries to extract it from trace
        by matching strings started with 'Details: ' as main message
        and additional ones with a pair of logical statements:
        - regular expression of r'\s' (no white spaces at string start)
        - string not started with 'Trace'
        
        In order to parse k8s conformance reports use specific xml format
        
            tparser -f r_xml -r conformance.html conformance.xml
        
        It happens that conformance and other k8s tests are spread across multiple files.
        They can be combined as a single report. 
        
            tparser -d -r tests.html -f r_xml --force-single conformance_folder
        
        Also, there is a possibility to omit specific status in the report. Say, there is a 2k+ SKIPs.
        '--omit-status' option can be uses several times
        
            tparser -d -r tests.html -f r_xml --force-single --omit-status OK  conformance_folder
        
        
        ======= Imported Formats
        ---- .log files
        Bare tempest output captured with either redirection
        or by copying XX numbered files from `.testrepository` folder.
        LOG parser anchors against lines started with specific strings.
        Make sure to remove leading environment variables and worker report stuff.
        
        ----- .xml files
        Files exported from tempest with subunit's XML export.
        
        ----- .json files
        [Rally](https://github.com/openstack/rally) tool export:
        
            rally verify results --json --output-file result1.json
        
        ======= Credits
        
        Thanks goes to Dmitry Bogun, Alexey Diyan and Dmitriy Zapeka.
        
Keywords: QA,tempest,openstack,html,report
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.9
