ParametersConfigFile.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333
  1. <!DOCTYPE html>
  2. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
  3. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
  4. <head>
  5. <meta charset="utf-8">
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <title>Parameters in Configuration files (globals) &mdash; baangt 1.1.1 documentation</title>
  8. <script type="text/javascript" src="_static/js/modernizr.min.js"></script>
  9. <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
  10. <script type="text/javascript" src="_static/jquery.js"></script>
  11. <script type="text/javascript" src="_static/underscore.js"></script>
  12. <script type="text/javascript" src="_static/doctools.js"></script>
  13. <script type="text/javascript" src="_static/language_data.js"></script>
  14. <script type="text/javascript" src="_static/js/theme.js"></script>
  15. <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  16. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  17. <link rel="stylesheet" href="_static/theme_overrides.css" type="text/css" />
  18. <link rel="index" title="Index" href="genindex.html" />
  19. <link rel="search" title="Search" href="search.html" />
  20. <link rel="next" title="How to create a simple API Test" href="SimpleAPI.html" />
  21. <link rel="prev" title="Structure of baangt" href="Structure.html" />
  22. </head>
  23. <body class="wy-body-for-nav">
  24. <div class="wy-grid-for-nav">
  25. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  26. <div class="wy-side-scroll">
  27. <div class="wy-side-nav-search" >
  28. <a href="index.html" class="icon icon-home"> baangt
  29. </a>
  30. <div role="search">
  31. <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  32. <input type="text" name="q" placeholder="Search docs" />
  33. <input type="hidden" name="check_keywords" value="yes" />
  34. <input type="hidden" name="area" value="default" />
  35. </form>
  36. </div>
  37. </div>
  38. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  39. <p class="caption"><span class="caption-text">Contents:</span></p>
  40. <ul class="current">
  41. <li class="toctree-l1"><a class="reference internal" href="Installation.html"> Installation</a></li>
  42. <li class="toctree-l1"><a class="reference internal" href="OverviewUsage.html"> Overview</a></li>
  43. <li class="toctree-l1"><a class="reference internal" href="simpleExample.html"> First Steps</a></li>
  44. <li class="toctree-l1"><a class="reference internal" href="Structure.html"> Structure</a></li>
  45. <li class="toctree-l1 current"><a class="current reference internal" href="#"> Parameters</a></li>
  46. <li class="toctree-l1"><a class="reference internal" href="SimpleAPI.html"> First API Test</a></li>
  47. <li class="toctree-l1"><a class="reference internal" href="TestTypes.html"> Types of Tests</a></li>
  48. <li class="toctree-l1"><a class="reference internal" href="DataFile.html"> Data file</a></li>
  49. <li class="toctree-l1"><a class="reference internal" href="SaveResults2Database.html"> Results in Database</a></li>
  50. <li class="toctree-l1"><a class="reference internal" href="HistoryAndReasons.html"> History</a></li>
  51. <li class="toctree-l1"><a class="reference internal" href="contributors.html"> Contributions</a></li>
  52. <li class="toctree-l1"><a class="reference internal" href="changelog.html"> Changelog</a></li>
  53. <li class="toctree-l1"><a class="reference internal" href="PlannedFeatures.html"> Planned Features</a></li>
  54. <li class="toctree-l1"><a class="reference internal" href="BrowserDrivers.html"> Browser Drivers</a></li>
  55. <li class="toctree-l1"><a class="reference internal" href="Variables.html"> Variables</a></li>
  56. <li class="toctree-l1"><a class="reference internal" href="SendStatistics.html"> Results</a></li>
  57. <li class="toctree-l1"><a class="reference internal" href="Datagenerator.html">DataGenerator</a></li>
  58. <li class="toctree-l1"><a class="reference internal" href="Datagenerator.html#input-file">Input File</a></li>
  59. <li class="toctree-l1"><a class="reference internal" href="Datagenerator.html#data-type">Data Type</a></li>
  60. <li class="toctree-l1"><a class="reference internal" href="Datagenerator.html#all-data-types-format">All Data Types Format</a></li>
  61. <li class="toctree-l1"><a class="reference internal" href="Developer.html"> For Developers</a></li>
  62. <li class="toctree-l1"><a class="reference internal" href="baangt-Plugin.html">What is a baangt-plugin</a></li>
  63. <li class="toctree-l1"><a class="reference internal" href="baangt-Plugin.html#how-to-make-a-baangt-plugin">how to make a baangt-plugin</a></li>
  64. <li class="toctree-l1"><a class="reference internal" href="baangt-Plugin.html#how-the-baangt-plugin-work">how the baangt-plugin work</a></li>
  65. <li class="toctree-l1"><a class="reference internal" href="baangt-Plugin.html#how-to-replace-the-existing-plugin-by-your-own-one">how to replace the existing plugin by your own one</a></li>
  66. <li class="toctree-l1"><a class="reference internal" href="articles/Articles.html"> :subheader: Articles</a></li>
  67. <li class="toctree-l1"><a class="reference external" href="http://www.baangt.org"> Web</a></li>
  68. </ul>
  69. <p class="caption"><span class="caption-text">Autodocs:</span></p>
  70. <ul>
  71. <li class="toctree-l1"><a class="reference internal" href="docs/baangt.base.html">Autodocs</a></li>
  72. <li class="toctree-l1"><a class="reference internal" href="docs/modules.html">Modules</a></li>
  73. </ul>
  74. </div>
  75. </div>
  76. </nav>
  77. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  78. <nav class="wy-nav-top" aria-label="top navigation">
  79. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  80. <a href="index.html">baangt</a>
  81. </nav>
  82. <div class="wy-nav-content">
  83. <div class="rst-content">
  84. <div role="navigation" aria-label="breadcrumbs navigation">
  85. <ul class="wy-breadcrumbs">
  86. <li><a href="index.html">Docs</a> &raquo;</li>
  87. <li>Parameters in Configuration files (<code class="docutils literal notranslate"><span class="pre">globals</span></code>)</li>
  88. <li class="wy-breadcrumbs-aside">
  89. <a href="_sources/ParametersConfigFile.rst.txt" rel="nofollow"> View page source</a>
  90. </li>
  91. </ul>
  92. <hr/>
  93. </div>
  94. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  95. <div itemprop="articleBody">
  96. <div class="section" id="parameters-in-configuration-files-globals">
  97. <h1>Parameters in Configuration files (<code class="docutils literal notranslate"><span class="pre">globals</span></code>)<a class="headerlink" href="#parameters-in-configuration-files-globals" title="Permalink to this headline">¶</a></h1>
  98. <p>Generally it’s not needed to change parameters in the config files during manual or automated execution, as the parameters
  99. have default values or are anyway defined in the Testrun definition. Still sometimes it’s very handy to change them on the fly,
  100. for instance to slowly retest a single testrecord or to not close the browser after an error.</p>
  101. <table class="colwidths-given docutils align-default" id="id1">
  102. <caption><span class="caption-text">Parameters in globals</span><a class="headerlink" href="#id1" title="Permalink to this table">¶</a></caption>
  103. <colgroup>
  104. <col style="width: 25%" />
  105. <col style="width: 75%" />
  106. </colgroup>
  107. <thead>
  108. <tr class="row-odd"><th class="head"><p>Parameter</p></th>
  109. <th class="head"><p>Description</p></th>
  110. </tr>
  111. </thead>
  112. <tbody>
  113. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">Release</span></code></p></td>
  114. <td><p>As you move your maturing software through the system landscape, you might still need regression test results based
  115. on “old” release functionality, while on lower stages you might want to (regression)-test already newer versions
  116. or newer functionality. In <code class="docutils literal notranslate"><span class="pre">baangt</span></code> there is no need to copy test cases in those situations. You simply update
  117. your test case definition with the appropriate version number (e.g. &gt;= 2020-10) and set the proper <code class="docutils literal notranslate"><span class="pre">Release</span></code> in
  118. the config file. For instance “2020-09” when you want to run on final quality and the changes from version “2020-10”
  119. are not there yet.</p>
  120. <blockquote>
  121. <div><p>Note for developers:</p>
  122. <p>It’s a static method - if you need to apply different versioning schema for your system landscape,
  123. simply subclass TestStepMaster and overwrite only the method <code class="docutils literal notranslate"><span class="pre">ifQualifyForExecution</span></code>.</p>
  124. </div></blockquote>
  125. </td>
  126. </tr>
  127. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">TC.slowExecution</span></code></p></td>
  128. <td><p>When set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the browser will stop for a short time after each command, so that you can also visually see
  129. what the browser is doing</p></td>
  130. </tr>
  131. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">dontCloseBrowser</span></code></p></td>
  132. <td><p>When the browser or script finds an error, it usually takes a screenshot and moves on to the next testcase.
  133. With this setting to <code class="docutils literal notranslate"><span class="pre">True</span></code> the browser session will stop right at the error.</p></td>
  134. </tr>
  135. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">TC.BrowserAttributes</span></code></p></td>
  136. <td><p>Set the value to <code class="docutils literal notranslate"><span class="pre">{'HEADLESS':</span> <span class="pre">'True'}</span></code> to run Chrome/Firefox in headless mode.</p></td>
  137. </tr>
  138. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">TC.Lines</span></code></p></td>
  139. <td><p>Which lines from datafile to process.</p>
  140. <ul class="simple">
  141. <li><p><code class="docutils literal notranslate"><span class="pre">linennumber</span></code> e.g. <code class="docutils literal notranslate"><span class="pre">5</span></code>. Will execute the selected testrun using line 5 from the datafile</p></li>
  142. <li><p><code class="docutils literal notranslate"><span class="pre">linenumber_from</span> <span class="pre">-</span> <span class="pre">linenumber_to</span></code> e.g. <code class="docutils literal notranslate"><span class="pre">1530</span> <span class="pre">-</span> <span class="pre">1540</span></code>. Will execute the selected testrun with lines 1530
  143. until including line 1540</p></li>
  144. </ul>
  145. <p>Combinations are possible and allowed, in this case separate the numbers by comma e.g. <code class="docutils literal notranslate"><span class="pre">5,</span> <span class="pre">10-20,</span> <span class="pre">30-90</span></code></p>
  146. </td>
  147. </tr>
  148. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">TC.Browser</span></code></p></td>
  149. <td><p>If the testcase is WEB-Testing, then you can overwrite the browser, which is defined inside the testrun definition.
  150. If the testcase is not a Web-Testcase this setting doesn’t have any effect.
  151. Valid values are <code class="docutils literal notranslate"><span class="pre">Chrome</span></code>, <code class="docutils literal notranslate"><span class="pre">FF</span></code> and <code class="docutils literal notranslate"><span class="pre">Safari</span></code></p></td>
  152. </tr>
  153. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">TC.BrowserZoomFactor</span></code></p></td>
  154. <td><p>Set’s the zoom factor for the browser window in the current test case. Values are numeric. Default = 100.</p></td>
  155. </tr>
  156. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">TC.ParallelRuns</span></code></p></td>
  157. <td><p>Number of parallel sessions to be executed. Values depend largely on your hardware and internet connection.
  158. Debugging works only in a single session.</p></td>
  159. </tr>
  160. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">TC.NetworkInfo</span></code></p></td>
  161. <td><p>Creates a very detailed trace of network activity of the browser(s). In the output file you’ll find another Tab
  162. “Network”, that holds all API-Calls from the frontend (including header, payload and answer).</p></td>
  163. </tr>
  164. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">TC.ExportAllFields</span></code></p></td>
  165. <td><p>When set to “True”, instead of specifying certain fields from the input data, that will be exported to the result
  166. field, take ALL fields for export.</p></td>
  167. </tr>
  168. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">TC.RestartBrowser</span></code></p></td>
  169. <td><p>When set to “True”, will always start a new browser after the previous test case was done.</p></td>
  170. </tr>
  171. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">TC.UseRotatingProxies</span></code></p></td>
  172. <td><p>When set to “True”, will not use your own IP-Address but will use random rotating proxy servers from a list of proxies.</p></td>
  173. </tr>
  174. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">TC.BrowserWindowSize</span></code></p></td>
  175. <td><p>When set to a value of width x height, will adjust the browser window dimensions. Value format can be
  176. <code class="docutils literal notranslate"><span class="pre">&lt;w&gt;;&lt;h&gt;</span> <span class="pre">or</span> <span class="pre">&lt;w&gt;,&lt;h&gt;</span> <span class="pre">or</span> <span class="pre">&lt;w&gt;/&lt;h&gt;</span> <span class="pre">or</span> <span class="pre">&lt;w&gt;x&lt;h&gt;</span> <span class="pre">or</span> <span class="pre">--&lt;w&gt;,--&lt;h&gt;</span></code></p></td>
  177. </tr>
  178. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">TC.ReReadProxies</span></code></p></td>
  179. <td><p>When set to “True”, the proxy-servers will be re-evaluated. Otherwise existing list of Proxy-Servers will be used
  180. for proxy rotation. List must be named <code class="docutils literal notranslate"><span class="pre">proxies.json</span></code> and contain a list of proxies.
  181. Each entry in the json file must contain <code class="docutils literal notranslate"><span class="pre">ip</span></code> and <code class="docutils literal notranslate"><span class="pre">port</span></code>.</p></td>
  182. </tr>
  183. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">CL.&lt;classType&gt;</span></code></p></td>
  184. <td><p>Usually you’d set the className of your own subclassing classes either in the testrun-JSON or XLSX for each
  185. object of a testrun (TestCaseSequence, TestCase, TestStepSequence, TestStep). Here you also have the
  186. change/define other classes (e.g. BrowserDriver, Timing, etc.), which you subclassed and enhanced for your
  187. local installation.</p></td>
  188. </tr>
  189. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">TC.LogLevel</span></code></p></td>
  190. <td><p>Set the LogLevel to a different value. In baangt standard the file-logger is set to <code class="docutils literal notranslate"><span class="pre">debug</span></code> while the console
  191. output is set to <code class="docutils literal notranslate"><span class="pre">info</span></code>. Using this setting you’ll set both logger channels to whatever value you provide.
  192. In the new UI you’ll see a dropdown menu.</p></td>
  193. </tr>
  194. </tbody>
  195. </table>
  196. </div>
  197. </div>
  198. </div>
  199. <footer>
  200. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  201. <a href="SimpleAPI.html" class="btn btn-neutral float-right" title="How to create a simple API Test" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
  202. <a href="Structure.html" class="btn btn-neutral float-left" title="Structure of baangt" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
  203. </div>
  204. <hr/>
  205. <div role="contentinfo">
  206. <p>
  207. &copy; Copyright 2020, Bernhard Buhl
  208. </p>
  209. </div>
  210. Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
  211. </footer>
  212. </div>
  213. </div>
  214. </section>
  215. </div>
  216. <script type="text/javascript">
  217. jQuery(function () {
  218. SphinxRtdTheme.Navigation.enable(true);
  219. });
  220. </script>
  221. </body>
  222. </html>