Oxygen release 0.1

docs/OxygenLibrary-0.1.dev.html → docs/OxygenLibrary-0.1.html

@@ -547,7 +547,7 @@
 jQuery.extend({highlight:function(e,t,n,r){if(e.nodeType===3){var i=e.data.match(t);if(i){var s=document.createElement(n||"span");s.className=r||"highlight";var o=e.splitText(i.index);o.splitText(i[0].length);var u=o.cloneNode(true);s.appendChild(u);o.parentNode.replaceChild(s,o);return 1}}else if(e.nodeType===1&&e.childNodes&&!/(script|style)/i.test(e.tagName)&&!(e.tagName===n.toUpperCase()&&e.className===r)){for(var a=0;a<e.childNodes.length;a++){a+=jQuery.highlight(e.childNodes[a],t,n,r)}}return 0}});jQuery.fn.unhighlight=function(e){var t={className:"highlight",element:"span"};jQuery.extend(t,e);return this.find(t.element+"."+t.className).each(function(){var e=this.parentNode;e.replaceChild(this.firstChild,this);e.normalize()}).end()};jQuery.fn.highlight=function(e,t){var n={className:"highlight",element:"span",caseSensitive:false,wordsOnly:false};jQuery.extend(n,t);if(e.constructor===String){e=[e]}e=jQuery.grep(e,function(e,t){return e!=""});e=jQuery.map(e,function(e,t){return e.replace(/[-[\]{}()*+?.,\\^$|#\s]/g,"\\$&")});if(e.length==0){return this}var r=n.caseSensitive?"":"i";var i="("+e.join("|")+")";if(n.wordsOnly){i="\\b"+i+"\\b"}var s=new RegExp(i,r);return this.each(function(){jQuery.highlight(this,s,n.element,n.className)})}
 </script>
 <script type="text/javascript">
-libdoc = {"all_tags":[],"contains_tags":false,"doc":"<div style=\"margin: 0\"><div class=\"document\">\n<p>Oxygen is a tool to consolidate different test tools' reports together\nas a single Robot Framework log and report. <tt class=\"docutils literal\">oxygen.OxygenLibrary\x3c/tt>\nenables you to write acceptance tests that run your other test tools, parse\ntheir results and include them into the Robot Framework reporting.\x3c/p>\n<p>In addition, you can use the <a class=\"reference external\" href=\"http://github.com/eficode/robotframework-oxygen#using-from-command-line\">oxygen command line interface\x3c/a> to transform\nan existing test tool report to a single Robot Framework <tt class=\"docutils literal\">output.xml\x3c/tt>\nwhich you can combine together with other Robot Framework <tt class=\"docutils literal\">output.xml\x3c/tt>'s\nwith Robot Frameworks built-in tool <a class=\"reference external\" href=\"http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#post-processing-outputs\">rebot\x3c/a>.\x3c/p>\n<p>Acceptance tests that run other test tools might look something like this:\x3c/p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Test cases ***\x3c/span><span class=\"p\">\n\x3c/span><span class=\"gu\">Java unit tests should pass\x3c/span><span class=\"p\">\n    \x3c/span><span class=\"nf\">Prepare environment\x3c/span><span class=\"p\">    \x3c/span><span class=\"s\">platform=\x3c/span><span class=\"p\">${\x3c/span><span class=\"nv\">PLATFORM\x3c/span><span class=\"p\">}\n    \x3c/span><span class=\"nf\">Run JUnit\x3c/span><span class=\"p\">    \x3c/span><span class=\"s\">path/to/resuls.xml\x3c/span><span class=\"p\">    \x3c/span><span class=\"s\">mvn clean test\x3c/span><span class=\"p\">\n\n\x3c/span><span class=\"gu\">Java integration tests should pass\x3c/span><span class=\"p\">\n    [\x3c/span><span class=\"kn\">Tags\x3c/span><span class=\"p\">]    \x3c/span><span class=\"s\">integration-tests\x3c/span><span class=\"p\">\n    \x3c/span><span class=\"nf\">Prepare environment\x3c/span><span class=\"p\">    \x3c/span><span class=\"s\">platform=\x3c/span><span class=\"p\">${\x3c/span><span class=\"nv\">PLATFORM\x3c/span><span class=\"p\">}\n    \x3c/span><span class=\"nf\">Run JUnit\x3c/span><span class=\"p\">    \x3c/span><span class=\"s\">another/path/results.xml\x3c/span><span class=\"p\">    \x3c/span><span class=\"s\">mvn clean integration-test\x3c/span><span class=\"p\">\n\n\x3c/span><span class=\"gu\">Performance should not degrade\x3c/span><span class=\"p\">\n    ${\x3c/span><span class=\"nv\">gatling output folder\x3c/span><span class=\"p\">}=    \x3c/span><span class=\"nf\">Set variable\x3c/span><span class=\"p\">    \x3c/span><span class=\"s\">path/to/simulations\x3c/span><span class=\"p\">\n    \x3c/span><span class=\"nf\">Run Gatling\x3c/span><span class=\"p\">    ${\x3c/span><span class=\"nv\">gatling output folder\x3c/span><span class=\"p\">}\x3c/span><span class=\"s\">/gatling.log\x3c/span><span class=\"p\">\n    ...            %{\x3c/span><span class=\"nv\">GATLING_HOME\x3c/span><span class=\"p\">}\x3c/span><span class=\"s\">/bin/gatling.sh --results-folder \x3c/span><span class=\"p\">${\x3c/span><span class=\"nv\">gatling output folder\x3c/span><span class=\"p\">}\x3c/span><span class=\"s\"> --simulation MyStressTest\x3c/span><span class=\"p\">\n\n\x3c/span><span class=\"gu\">Application should not have security holes\x3c/span><span class=\"p\">\n    \x3c/span><span class=\"nf\">Run ZAP\x3c/span><span class=\"p\">    \x3c/span><span class=\"s\">path/to/zap.json\x3c/span><span class=\"p\">    \x3c/span><span class=\"s\">node my_zap_active_scan.js\x3c/span>\n\x3c/pre>\n<p>As you can see from the examples above, creating acceptance tests that run\nyour other test tools is quite flexible. Tests can, in addition to keywords\ndescribed in this documentation, have other Robot Framework keywords (like\nthe imaginary user keyword <tt class=\"docutils literal\">Prepare environment\x3c/tt> in the examples above)\nthat are normally executed before or after. These are also reported in the\nfinal Robot Framework reporting.\x3c/p>\n<p>You can also observe from the <tt class=\"docutils literal\">Java integration tests should pass\x3c/tt> example\nthat tags in the test case will also be part of the final RF reporting —\nthese tags will be added to each parsed test result from the other tool.\nThis is a good way to add additional metadata like categorization of test\ncases for quality dashboards, if the test tool does not provide this\nthemselves.\x3c/p>\n<div class=\"section\" id=\"extending-oxygen-oxygenlibrary\">\n<h1>Extending oxygen.OxygenLibrary\x3c/h1>\n<p><tt class=\"docutils literal\">oxygen.OxygenLibrary\x3c/tt> is designed to be extensible with writing your\nown <em>handler\x3c/em> for Oxygen to use. It is expected that your <em>handler\x3c/em> also\nprovides a keyword for running the test tool you want to provide\nintegration for. Since <tt class=\"docutils literal\">oxygen.OxygenLibrary\x3c/tt> is a <a class=\"reference external\" href=\"http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#dynamic-library-api\">dynamic library\x3c/a>,\nit will also know how to run your <em>handler's\x3c/em> keyword.\x3c/p>\n<p>Keyword documentation should be provided as per <a class=\"reference external\" href=\"http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#documenting-libraries\">normal way one does with\nRobot Framework libraries\x3c/a>. The documentation syntax is expected to be\n<a class=\"reference external\" href=\"https://docutils.sourceforge.io/docs/user/rst/quickref.html\">reStructuredText\x3c/a>.\x3c/p>\n<p>After editing Oxygen's <tt class=\"docutils literal\">config.yml\x3c/tt> to add your own handler, you can\nregenerate this library documentation to show your keyword with command:\x3c/p>\n<pre class=\"code bash literal-block\">\n$ python -m robot.libdoc OxygenLibrary MyOxygenLibrary.html\n\x3c/pre>\n\x3c/div>\n\x3c/div>\n\x3c/div>","generated":"2020-05-14 12:41:07","inits":[],"keywords":[{"args":["result_file","command","check_return_code=False","**env"],"doc":"<div style=\"margin: 0\"><div class=\"document\">\n<p>Run Gatling performance testing tool specified with <tt class=\"docutils literal\">command\x3c/tt>.\x3c/p>\n<p><tt class=\"docutils literal\">result_file\x3c/tt> is path to the file <tt class=\"docutils literal\">oxygen\x3c/tt> uses to parse the results.\nIt is important you craft your <cite>command\x3c/cite> to produce the file\n<cite>result_file\x3c/cite> argument expects — otherwise Oxygen will not be able to\nparse the results later on.\x3c/p>\n<p><tt class=\"docutils literal\">command\x3c/tt> is used to run the test tool. It is a single string which is\nrun in a terminal subshell.\x3c/p>\n<p><tt class=\"docutils literal\">check_return_code\x3c/tt> checks that <tt class=\"docutils literal\">command\x3c/tt> returns with exit code zero\n(0). By default, return code is not checked as failing test execution\ngenerally is reported with non-zero return code. However, it is useful\nto set <tt class=\"docutils literal\">check_return_code\x3c/tt> to <tt class=\"docutils literal\">True\x3c/tt> temporarily when you want to\ndebug why the test tool is failing for other reasons than failing test\nexecution.\x3c/p>\n<p><tt class=\"docutils literal\">env\x3c/tt> is used to pass environment variables that are set in the subshell\nthe <tt class=\"docutils literal\">command\x3c/tt> is run in.\x3c/p>\n\x3c/div>\n\x3c/div>","matched":true,"name":"Run Gatling","shortdoc":"Run Gatling performance testing tool specified with ``command``.","tags":[]},{"args":["result_file","command","check_return_code=False","**env"],"doc":"<div style=\"margin: 0\"><div class=\"document\">\n<p>Run JUnit unit testing tool specified with <tt class=\"docutils literal\">command\x3c/tt>.\x3c/p>\n<p>See documentation for other arguments in <a href=\"#Run%20Gatling\" class=\"name\">Run Gatling\x3c/a>.\x3c/p>\n\x3c/div>\n\x3c/div>","matched":true,"name":"Run Junit","shortdoc":"Run JUnit unit testing tool specified with ``command``.","tags":[]},{"args":["result_file","command","check_return_code=False","**env"],"doc":"<div style=\"margin: 0\"><div class=\"document\">\n<p>Run Zed Attack Proxy security testing tool specified with\n<tt class=\"docutils literal\">command\x3c/tt>.\x3c/p>\n<p>See documentation for other arguments in <a href=\"#Run%20Gatling\" class=\"name\">Run Gatling\x3c/a>.\x3c/p>\n\x3c/div>\n\x3c/div>","matched":true,"name":"Run Zap","shortdoc":"Run Zed Attack Proxy security testing tool specified with ``command``.","tags":[]}],"name":"oxygen.OxygenLibrary","named_args":true,"scope":"TEST","version":"0.1.dev"};
+libdoc = {"all_tags":[],"contains_tags":false,"doc":"<div style=\"margin: 0\"><div class=\"document\">\n<p>Oxygen is a tool to consolidate different test tools' reports together\nas a single Robot Framework log and report. <tt class=\"docutils literal\">oxygen.OxygenLibrary\x3c/tt>\nenables you to write acceptance tests that run your other test tools, parse\ntheir results and include them into the Robot Framework reporting.\x3c/p>\n<p>In addition, you can use the <a class=\"reference external\" href=\"http://github.com/eficode/robotframework-oxygen#using-from-command-line\">oxygen command line interface\x3c/a> to transform\nan existing test tool report to a single Robot Framework <tt class=\"docutils literal\">output.xml\x3c/tt>\nwhich you can combine together with other Robot Framework <tt class=\"docutils literal\">output.xml\x3c/tt>'s\nwith Robot Frameworks built-in tool <a class=\"reference external\" href=\"http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#post-processing-outputs\">rebot\x3c/a>.\x3c/p>\n<p>Acceptance tests that run other test tools might look something like this:\x3c/p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Test cases ***\x3c/span><span class=\"p\">\n\x3c/span><span class=\"gu\">Java unit tests should pass\x3c/span><span class=\"p\">\n    \x3c/span><span class=\"nf\">Prepare environment\x3c/span><span class=\"p\">    \x3c/span><span class=\"s\">platform=\x3c/span><span class=\"p\">${\x3c/span><span class=\"nv\">PLATFORM\x3c/span><span class=\"p\">}\n    \x3c/span><span class=\"nf\">Run JUnit\x3c/span><span class=\"p\">    \x3c/span><span class=\"s\">path/to/resuls.xml\x3c/span><span class=\"p\">    \x3c/span><span class=\"s\">mvn clean test\x3c/span><span class=\"p\">\n\n\x3c/span><span class=\"gu\">Java integration tests should pass\x3c/span><span class=\"p\">\n    [\x3c/span><span class=\"kn\">Tags\x3c/span><span class=\"p\">]    \x3c/span><span class=\"s\">integration-tests\x3c/span><span class=\"p\">\n    \x3c/span><span class=\"nf\">Prepare environment\x3c/span><span class=\"p\">    \x3c/span><span class=\"s\">platform=\x3c/span><span class=\"p\">${\x3c/span><span class=\"nv\">PLATFORM\x3c/span><span class=\"p\">}\n    \x3c/span><span class=\"nf\">Run JUnit\x3c/span><span class=\"p\">    \x3c/span><span class=\"s\">another/path/results.xml\x3c/span><span class=\"p\">    \x3c/span><span class=\"s\">mvn clean integration-test\x3c/span><span class=\"p\">\n\n\x3c/span><span class=\"gu\">Performance should not degrade\x3c/span><span class=\"p\">\n    ${\x3c/span><span class=\"nv\">gatling output folder\x3c/span><span class=\"p\">}=    \x3c/span><span class=\"nf\">Set variable\x3c/span><span class=\"p\">    \x3c/span><span class=\"s\">path/to/simulations\x3c/span><span class=\"p\">\n    \x3c/span><span class=\"nf\">Run Gatling\x3c/span><span class=\"p\">    ${\x3c/span><span class=\"nv\">gatling output folder\x3c/span><span class=\"p\">}\x3c/span><span class=\"s\">/gatling.log\x3c/span><span class=\"p\">\n    ...            %{\x3c/span><span class=\"nv\">GATLING_HOME\x3c/span><span class=\"p\">}\x3c/span><span class=\"s\">/bin/gatling.sh --results-folder \x3c/span><span class=\"p\">${\x3c/span><span class=\"nv\">gatling output folder\x3c/span><span class=\"p\">}\x3c/span><span class=\"s\"> --simulation MyStressTest\x3c/span><span class=\"p\">\n\n\x3c/span><span class=\"gu\">Application should not have security holes\x3c/span><span class=\"p\">\n    \x3c/span><span class=\"nf\">Run ZAP\x3c/span><span class=\"p\">    \x3c/span><span class=\"s\">path/to/zap.json\x3c/span><span class=\"p\">    \x3c/span><span class=\"s\">node my_zap_active_scan.js\x3c/span>\n\x3c/pre>\n<p>As you can see from the examples above, creating acceptance tests that run\nyour other test tools is quite flexible. Tests can, in addition to keywords\ndescribed in this documentation, have other Robot Framework keywords (like\nthe imaginary user keyword <tt class=\"docutils literal\">Prepare environment\x3c/tt> in the examples above)\nthat are normally executed before or after. These are also reported in the\nfinal Robot Framework reporting.\x3c/p>\n<p>You can also observe from the <tt class=\"docutils literal\">Java integration tests should pass\x3c/tt> example\nthat tags in the test case will also be part of the final RF reporting —\nthese tags will be added to each parsed test result from the other tool.\nThis is a good way to add additional metadata like categorization of test\ncases for quality dashboards, if the test tool does not provide this\nthemselves.\x3c/p>\n<div class=\"section\" id=\"extending-oxygen-oxygenlibrary\">\n<h1>Extending oxygen.OxygenLibrary\x3c/h1>\n<p><tt class=\"docutils literal\">oxygen.OxygenLibrary\x3c/tt> is designed to be extensible with writing your\nown <em>handler\x3c/em> for Oxygen to use. It is expected that your <em>handler\x3c/em> also\nprovides a keyword for running the test tool you want to provide\nintegration for. Since <tt class=\"docutils literal\">oxygen.OxygenLibrary\x3c/tt> is a <a class=\"reference external\" href=\"http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#dynamic-library-api\">dynamic library\x3c/a>,\nit will also know how to run your <em>handler's\x3c/em> keyword.\x3c/p>\n<p>Keyword documentation should be provided as per <a class=\"reference external\" href=\"http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#documenting-libraries\">normal way one does with\nRobot Framework libraries\x3c/a>. The documentation syntax is expected to be\n<a class=\"reference external\" href=\"https://docutils.sourceforge.io/docs/user/rst/quickref.html\">reStructuredText\x3c/a>.\x3c/p>\n<p>After editing Oxygen's <tt class=\"docutils literal\">config.yml\x3c/tt> to add your own handler, you can\nregenerate this library documentation to show your keyword with command:\x3c/p>\n<pre class=\"code bash literal-block\">\n$ python -m robot.libdoc OxygenLibrary MyOxygenLibrary.html\n\x3c/pre>\n\x3c/div>\n\x3c/div>\n\x3c/div>","generated":"2020-05-14 15:02:11","inits":[],"keywords":[{"args":["result_file","command","check_return_code=False","**env"],"doc":"<div style=\"margin: 0\"><div class=\"document\">\n<p>Run Gatling performance testing tool specified with <tt class=\"docutils literal\">command\x3c/tt>.\x3c/p>\n<p><tt class=\"docutils literal\">result_file\x3c/tt> is path to the file <tt class=\"docutils literal\">oxygen\x3c/tt> uses to parse the results.\nIt is important you craft your <cite>command\x3c/cite> to produce the file\n<cite>result_file\x3c/cite> argument expects — otherwise Oxygen will not be able to\nparse the results later on.\x3c/p>\n<p><tt class=\"docutils literal\">command\x3c/tt> is used to run the test tool. It is a single string which is\nrun in a terminal subshell.\x3c/p>\n<p><tt class=\"docutils literal\">check_return_code\x3c/tt> checks that <tt class=\"docutils literal\">command\x3c/tt> returns with exit code zero\n(0). By default, return code is not checked as failing test execution\ngenerally is reported with non-zero return code. However, it is useful\nto set <tt class=\"docutils literal\">check_return_code\x3c/tt> to <tt class=\"docutils literal\">True\x3c/tt> temporarily when you want to\ndebug why the test tool is failing for other reasons than failing test\nexecution.\x3c/p>\n<p><tt class=\"docutils literal\">env\x3c/tt> is used to pass environment variables that are set in the subshell\nthe <tt class=\"docutils literal\">command\x3c/tt> is run in.\x3c/p>\n\x3c/div>\n\x3c/div>","matched":true,"name":"Run Gatling","shortdoc":"Run Gatling performance testing tool specified with ``command``.","tags":[]},{"args":["result_file","command","check_return_code=False","**env"],"doc":"<div style=\"margin: 0\"><div class=\"document\">\n<p>Run JUnit unit testing tool specified with <tt class=\"docutils literal\">command\x3c/tt>.\x3c/p>\n<p>See documentation for other arguments in <a href=\"#Run%20Gatling\" class=\"name\">Run Gatling\x3c/a>.\x3c/p>\n\x3c/div>\n\x3c/div>","matched":true,"name":"Run Junit","shortdoc":"Run JUnit unit testing tool specified with ``command``.","tags":[]},{"args":["result_file","command","check_return_code=False","**env"],"doc":"<div style=\"margin: 0\"><div class=\"document\">\n<p>Run Zed Attack Proxy security testing tool specified with\n<tt class=\"docutils literal\">command\x3c/tt>.\x3c/p>\n<p>See documentation for other arguments in <a href=\"#Run%20Gatling\" class=\"name\">Run Gatling\x3c/a>.\x3c/p>\n\x3c/div>\n\x3c/div>","matched":true,"name":"Run Zap","shortdoc":"Run Zed Attack Proxy security testing tool specified with ``command``.","tags":[]}],"name":"oxygen.OxygenLibrary","named_args":true,"scope":"TEST","version":"0.1"};
 </script>
 <title></title>
 </head>