Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Register for FREE! Join TestMu Conference

How to use run_libdoc_and_validate_json method in Robotframework

Best Python code snippet using robotframework

test_libdoc.py

Source:test_libdoc.py

...26    keyword = libdoc.keywords[0]27    keyword.doc = formatter(keyword.doc)28    libdoc.doc_format = 'HTML'29    assert_equal(keyword.shortdoc, expected)30def run_libdoc_and_validate_json(filename):31    library = join(DATADIR, filename)32    json_spec = LibraryDocumentation(library).to_json()33    with open(join(CURDIR, '../../doc/schema/libdoc_schema.json')) as f:34        schema = json.load(f)35    validate(instance=json.loads(json_spec), schema=schema)36class TestHtmlToDoc(unittest.TestCase):37    def test_shortdoc_firstline(self):38        doc = """<p>This is the first line</p>39        <p>This is the second one</p>"""40        exp = "This is the first line"41        verify_shortdoc_output(doc, exp)42    def test_shortdoc_replace_format(self):43        doc = "<p>This is <b>bold</b> or <i>italic</i> or <i><b>italicbold</b></i> and code.</p>"44        exp = "This is *bold* or _italic_ or _*italicbold*_ and code."45        verify_shortdoc_output(doc, exp)46    def test_shortdoc_replace_format_multiline(self):47        doc = """<p>This is <b>bold</b>48        or <i>italic</i> or <i><b>italic49        bold</b></i> and <code>code</code>.</p>"""50        exp = """This is *bold*51        or _italic_ or _*italic52        bold*_ and ``code``."""53        verify_shortdoc_output(doc, exp)54    def test_shortdoc_unexcape_html(self):55        doc = """<p>This &amp; &quot;<b>&lt;b&gt;is&lt;/b&gt;</b>&quot;56        &lt;i&gt;the&lt;/i&gt; &lt;/p&gt;&apos;first&apos; line</p>"""57        exp = """This & "*<b>is</b>*"58        <i>the</i> </p>'first' line"""59        verify_shortdoc_output(doc, exp)60class TestKeywordShortDoc(unittest.TestCase):61    def test_shortdoc_with_multiline_plain_text(self):62        doc = """Writes the message to the console.63    If the ``newline`` argument is ``True``, a newline character is64    automatically added to the message.65    By default the message is written to the standard output stream.66    Using the standard error stream is possibly by giving the ``stream``67    argument value ``'stderr'``."""68        exp = "Writes the message to the console."69        verify_keyword_shortdoc('TEXT', doc, exp)70    def test_shortdoc_with_empty_plain_text(self):71        doc = ""72        exp = ""73        verify_keyword_shortdoc('TEXT', doc, exp)74    def test_shortdoc_with_multiline_robot_format(self):75        doc = """Writes the76*message* to77_the_ ``console``.78If the ``newline`` argument is ``True``, a newline character is79automatically added to the message.80By default the message is written to the standard output stream.81Using the standard error stream is possibly by giving the ``stream``82argument value ``'stderr'``."""83        exp = "Writes the *message* to _the_ ``console``."84        verify_keyword_shortdoc('ROBOT', doc, exp)85    def test_shortdoc_with_empty_robot_format(self):86        doc = ""87        exp = ""88        verify_keyword_shortdoc('ROBOT', doc, exp)89    def test_shortdoc_with_multiline_HTML_format(self):90        doc = """<p><strong>Writes</strong><br><em>the</em> <b>message</b>91to <i>the</i> <code>console</code>.<br><br>92If the <code>newline</code> argument is <code>True</code>, a newline character is93automatically added to the message.</p>94<p>By default the message is written to the standard output stream.95Using the standard error stream is possibly by giving the <code>stream</code>96argument value ``'stderr'``."""97        exp = "*Writes* _the_ *message* to _the_ ``console``."98        verify_keyword_shortdoc('HTML', doc, exp)99    def test_shortdoc_with_nonclosing_p_HTML_format(self):100        doc = """<p><strong>Writes</strong><br><em>the</em> <b>message</b>101to <i>the</i> <code>console</code>.<br><br>102If the <code>newline</code> argument is <code>True</code>, a newline character is103automatically added to the message.104<p>By default the message is written to the standard output stream.105Using the standard error stream is possibly by giving the <code>stream</code>106argument value ``'stderr'``."""107        exp = "*Writes* _the_ *message* to _the_ ``console``."108        verify_keyword_shortdoc('HTML', doc, exp)109    def test_shortdoc_with_empty_HTML_format(self):110        doc = ""111        exp = ""112        verify_keyword_shortdoc('HTML', doc, exp)113    try:114        from docutils.core import publish_parts115        def test_shortdoc_with_multiline_reST_format(self):116            doc = """Writes the **message**117to *the* console.118If the ``newline`` argument is ``True``, a newline character is119automatically added to the message.120By default the message is written to the standard output stream.121Using the standard error stream is possibly by giving the ``stream``122argument value ``'stderr'``."""123            exp = "Writes the **message** to *the* console."124            verify_keyword_shortdoc('REST', doc, exp)125        def test_shortdoc_with_empty_reST_format(self):126            doc = ""127            exp = ""128            verify_keyword_shortdoc('REST', doc, exp)129    except ImportError:130        pass131if not IRONPYTHON and not JYTHON:132    from jsonschema import validate133    class TestLibdocJsonWriter(unittest.TestCase):134        def test_Annotations(self):135            if PY3:136                run_libdoc_and_validate_json('Annotations.py')137        def test_Decorators(self):138            run_libdoc_and_validate_json('Decorators.py')139        def test_Deprecation(self):140            run_libdoc_and_validate_json('Deprecation.py')141        def test_DocFormat(self):142            run_libdoc_and_validate_json('DocFormat.py')143        def test_DynamicLibrary(self):144            run_libdoc_and_validate_json('DynamicLibrary.py::required')145        def test_DynamicLibraryWithoutGetKwArgsAndDoc(self):146            run_libdoc_and_validate_json('DynamicLibraryWithoutGetKwArgsAndDoc.py')147        def test_ExampleSpec(self):148            run_libdoc_and_validate_json('ExampleSpec.xml')149        def test_InternalLinking(self):150            run_libdoc_and_validate_json('InternalLinking.py')151        def test_KeywordOnlyArgs(self):152            if PY3:153                run_libdoc_and_validate_json('KeywordOnlyArgs.py')154        def test_LibraryDecorator(self):155            run_libdoc_and_validate_json('LibraryDecorator.py')156        def test_module(self):157            run_libdoc_and_validate_json('module.py')158        def test_NewStyleNoInit(self):159            run_libdoc_and_validate_json('NewStyleNoInit.py')160        def test_no_arg_init(self):161            run_libdoc_and_validate_json('no_arg_init.py')162        def test_resource(self):163            run_libdoc_and_validate_json('resource.resource')164        def test_resource_with_robot_extension(self):165            run_libdoc_and_validate_json('resource.robot')166        def test_toc(self):167            run_libdoc_and_validate_json('toc.py')168        def test_TOCWithInitsAndKeywords(self):169            run_libdoc_and_validate_json('TOCWithInitsAndKeywords.py')170        def test_TypesViaKeywordDeco(self):171            run_libdoc_and_validate_json('TypesViaKeywordDeco.py')172        def test_DynamicLibrary_json(self):173            run_libdoc_and_validate_json('DynamicLibrary.json')174        def test_DataTypesLibrary_json(self):175            run_libdoc_and_validate_json('DataTypesLibrary.json')176        def test_DataTypesLibrary_xml(self):177            run_libdoc_and_validate_json('DataTypesLibrary.xml')178        if PY_VERSION >= (3, 6):179            def test_DataTypesLibrary_py(self):180                run_libdoc_and_validate_json('DataTypesLibrary.py')181        def test_DataTypesLibrary_libspex(self):182            run_libdoc_and_validate_json('DataTypesLibrary.libspec')183class TestLibdocJsonBuilder(unittest.TestCase):184    def test_libdoc_json_roundtrip(self):185        library = join(DATADIR, 'DynamicLibrary.json')186        spec = LibraryDocumentation(library).to_json()187        data = json.loads(spec)188        with open(library) as f:189            orig_data = json.load(f)190        data['generated'] = orig_data['generated'] = None191        assert_equal(data, orig_data)192    def test_libdoc_json_roundtrip_with_dt(self):193        library = join(DATADIR, 'DataTypesLibrary.json')194        spec = LibraryDocumentation(library).to_json()195        data = json.loads(spec)196        with open(library) as f:...

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.