Metadata-Version: 2.1
Name: tavalidate
Version: 0.0.6
Summary: Utilities to help you validate and save Tavern response.
Home-page: https://github.com/sohoffice/tavalidate
Author: Douglas Liu
Author-email: douglas@sohoffice.com
License: UNKNOWN
Description: tavalidate, utilities to help you validate [Tavern](https://tavern.readthedocs.io/en/latest/) response.
        
        Installation
        ------------
        
        Tavalidate can be installed through pip.
        
        ```
        pip install tavalidate
        ```
        
        XML Validate
        ----
        
        Tavern has great built-in Json support, but things are difficult when it comes to XML.
        Use tavalidate.xmlv package to validate XML response.
        
        XML validation example:
        
        ```
        response:
          status_code: 200
          verify_response_with:
            function: tavalidate:assert_xml
            extra_kwargs:
              expected: |
                <foo attr="!anystr">
                  <bar attr2="baz">!anyint</bar>
                </foo>
        ```
        
        Simply put, pass the expected xml as an argument to the `tavalidate.xmlv.validate` function. The
        function will validate the xml structure, node value and attribute value.
        
        ### extra_kwargs
        
        Below are the supported extra kwargs of `tavalidate.xmlv.validate` function.
        
        #### expected
        
        This is the expected XML string.
        
        You may use some (not all) of the tavern magic values to match data of your specified type:
        
        - !anything: This matches value of any type.
        - !anystr: Matches any string
        - !anyint: Matches any integer
        - !anyfloat: Matches any float
        - !anybool: Matches any boolean
        
        #### strict
        
        Use `strict: True` if you want to make sure there's no extra tag in the response.
        
        #### array
        
        Since XML do not have the concept of array. When validating an array-like element, the same 
        number of children of the same tag must exist. Regardless whether strict mode is used or not.
        All element in corresponding order must match for the container to match.
        
        XML Save
        ----
        
        Use tavalidate.xmlv package to save XML response.
        
        It allows you to use [XPath](https://en.wikipedia.org/wiki/XPath) to specify the value to save
        inside the xml document. If the XPath somehow selects multiple nodes, tavalidate will print a
        warning, but the first value will still be saved.
        
        XML save example:
        
        ```
        response:
          save:
            $ext:
              function: tavalidate:save_xml
              extra_kwargs:
                variables:
                  bar: '/foo/bar/text()'
                  at1: '/foo/@at1'
        ```
        
        
        Logging
        -------
        
        Configure the logger `tavalidate` so you can see the response body and other logs in
        DEBUG level.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
