baangt.base.html 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597
  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>baangt.base package &mdash; baangt 2020.3.0.rc4 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="index" title="Index" href="../genindex.html" />
  18. <link rel="search" title="Search" href="../search.html" />
  19. </head>
  20. <body class="wy-body-for-nav">
  21. <div class="wy-grid-for-nav">
  22. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  23. <div class="wy-side-scroll">
  24. <div class="wy-side-nav-search" >
  25. <a href="../index.html" class="icon icon-home"> baangt
  26. </a>
  27. <div role="search">
  28. <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  29. <input type="text" name="q" placeholder="Search docs" />
  30. <input type="hidden" name="check_keywords" value="yes" />
  31. <input type="hidden" name="area" value="default" />
  32. </form>
  33. </div>
  34. </div>
  35. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  36. <p class="caption"><span class="caption-text">Contents:</span></p>
  37. <ul>
  38. <li class="toctree-l1"><a class="reference internal" href="../Installation.html"> Installation</a></li>
  39. <li class="toctree-l1"><a class="reference internal" href="../OverviewUsage.html"> Overview</a></li>
  40. <li class="toctree-l1"><a class="reference internal" href="../simpleExample.html"> First Steps</a></li>
  41. <li class="toctree-l1"><a class="reference internal" href="../Structure.html"> Structure</a></li>
  42. <li class="toctree-l1"><a class="reference internal" href="../ParametersConfigFile.html"> Parameters</a></li>
  43. <li class="toctree-l1"><a class="reference internal" href="../DataFile.html"> Data file</a></li>
  44. <li class="toctree-l1"><a class="reference internal" href="../SimpleAPI.html"> First API Test</a></li>
  45. <li class="toctree-l1"><a class="reference internal" href="../TestTypes.html"> Types of Tests</a></li>
  46. <li class="toctree-l1"><a class="reference internal" href="../Developer.html"> For Developers</a></li>
  47. <li class="toctree-l1"><a class="reference internal" href="../HistoryAndReasons.html"> History</a></li>
  48. <li class="toctree-l1"><a class="reference internal" href="../contributors.html"> Contributions</a></li>
  49. <li class="toctree-l1"><a class="reference internal" href="../changelog.html"> Changelog</a></li>
  50. <li class="toctree-l1"><a class="reference internal" href="../PlannedFeatures.html"> Planned Features</a></li>
  51. <li class="toctree-l1"><a class="reference internal" href="../BrowserDrivers.html"> Browser Drivers</a></li>
  52. <li class="toctree-l1"><a class="reference internal" href="../articles/Articles.html"> :subheader: Articles</a></li>
  53. <li class="toctree-l1"><a class="reference external" href="http://www.baangt.org"> Web</a></li>
  54. </ul>
  55. </div>
  56. </div>
  57. </nav>
  58. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  59. <nav class="wy-nav-top" aria-label="top navigation">
  60. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  61. <a href="../index.html">baangt</a>
  62. </nav>
  63. <div class="wy-nav-content">
  64. <div class="rst-content">
  65. <div role="navigation" aria-label="breadcrumbs navigation">
  66. <ul class="wy-breadcrumbs">
  67. <li><a href="../index.html">Docs</a> &raquo;</li>
  68. <li>baangt.base package</li>
  69. <li class="wy-breadcrumbs-aside">
  70. <a href="../_sources/docs/baangt.base.rst.txt" rel="nofollow"> View page source</a>
  71. </li>
  72. </ul>
  73. <hr/>
  74. </div>
  75. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  76. <div itemprop="articleBody">
  77. <div class="section" id="baangt-base-package">
  78. <h1>baangt.base package<a class="headerlink" href="#baangt-base-package" title="Permalink to this headline">¶</a></h1>
  79. <div class="section" id="submodules">
  80. <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
  81. </div>
  82. <div class="section" id="module-baangt.base.ApiHandling">
  83. <span id="baangt-base-apihandling-module"></span><h2>baangt.base.ApiHandling module<a class="headerlink" href="#module-baangt.base.ApiHandling" title="Permalink to this headline">¶</a></h2>
  84. <dl class="class">
  85. <dt id="baangt.base.ApiHandling.ApiHandling">
  86. <em class="property">class </em><code class="sig-prename descclassname">baangt.base.ApiHandling.</code><code class="sig-name descname">ApiHandling</code><a class="headerlink" href="#baangt.base.ApiHandling.ApiHandling" title="Permalink to this definition">¶</a></dt>
  87. <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
  88. <dl class="method">
  89. <dt id="baangt.base.ApiHandling.ApiHandling.getNewSession">
  90. <code class="sig-name descname">getNewSession</code><span class="sig-paren">(</span><em class="sig-param">sessionNumber=None</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.ApiHandling.ApiHandling.getNewSession" title="Permalink to this definition">¶</a></dt>
  91. <dd></dd></dl>
  92. <dl class="method">
  93. <dt id="baangt.base.ApiHandling.ApiHandling.getSession">
  94. <code class="sig-name descname">getSession</code><span class="sig-paren">(</span><em class="sig-param">sessionNumber=1</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.ApiHandling.ApiHandling.getSession" title="Permalink to this definition">¶</a></dt>
  95. <dd></dd></dl>
  96. <dl class="method">
  97. <dt id="baangt.base.ApiHandling.ApiHandling.getURL">
  98. <code class="sig-name descname">getURL</code><span class="sig-paren">(</span><em class="sig-param">url=None</em>, <em class="sig-param">sessionNumber=1</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.ApiHandling.ApiHandling.getURL" title="Permalink to this definition">¶</a></dt>
  99. <dd></dd></dl>
  100. <dl class="method">
  101. <dt id="baangt.base.ApiHandling.ApiHandling.postURL">
  102. <code class="sig-name descname">postURL</code><span class="sig-paren">(</span><em class="sig-param">url=None</em>, <em class="sig-param">content=None</em>, <em class="sig-param">sessionNumber=1</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.ApiHandling.ApiHandling.postURL" title="Permalink to this definition">¶</a></dt>
  103. <dd></dd></dl>
  104. <dl class="method">
  105. <dt id="baangt.base.ApiHandling.ApiHandling.returnTestCaseStatus">
  106. <em class="property">static </em><code class="sig-name descname">returnTestCaseStatus</code><span class="sig-paren">(</span><em class="sig-param">status_code</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.ApiHandling.ApiHandling.returnTestCaseStatus" title="Permalink to this definition">¶</a></dt>
  107. <dd></dd></dl>
  108. <dl class="method">
  109. <dt id="baangt.base.ApiHandling.ApiHandling.setBaseURL">
  110. <code class="sig-name descname">setBaseURL</code><span class="sig-paren">(</span><em class="sig-param">url</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.ApiHandling.ApiHandling.setBaseURL" title="Permalink to this definition">¶</a></dt>
  111. <dd></dd></dl>
  112. <dl class="method">
  113. <dt id="baangt.base.ApiHandling.ApiHandling.setEndPoint">
  114. <code class="sig-name descname">setEndPoint</code><span class="sig-paren">(</span><em class="sig-param">endpoint</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.ApiHandling.ApiHandling.setEndPoint" title="Permalink to this definition">¶</a></dt>
  115. <dd></dd></dl>
  116. <dl class="method">
  117. <dt id="baangt.base.ApiHandling.ApiHandling.setHeaders">
  118. <code class="sig-name descname">setHeaders</code><span class="sig-paren">(</span><em class="sig-param">sessionNumber=1</em>, <em class="sig-param">setHeaderData=None</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.ApiHandling.ApiHandling.setHeaders" title="Permalink to this definition">¶</a></dt>
  119. <dd></dd></dl>
  120. <dl class="method">
  121. <dt id="baangt.base.ApiHandling.ApiHandling.setLoginData">
  122. <code class="sig-name descname">setLoginData</code><span class="sig-paren">(</span><em class="sig-param">userName</em>, <em class="sig-param">password</em>, <em class="sig-param">sessionNumber=1</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.ApiHandling.ApiHandling.setLoginData" title="Permalink to this definition">¶</a></dt>
  123. <dd></dd></dl>
  124. <dl class="method">
  125. <dt id="baangt.base.ApiHandling.ApiHandling.tearDown">
  126. <code class="sig-name descname">tearDown</code><span class="sig-paren">(</span><em class="sig-param">sessionNumber=None</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.ApiHandling.ApiHandling.tearDown" title="Permalink to this definition">¶</a></dt>
  127. <dd></dd></dl>
  128. </dd></dl>
  129. </div>
  130. <div class="section" id="module-baangt.base.BrowserHandling">
  131. <span id="baangt-base-browserhandling-module"></span><h2>baangt.base.BrowserHandling module<a class="headerlink" href="#module-baangt.base.BrowserHandling" title="Permalink to this headline">¶</a></h2>
  132. </div>
  133. <div class="section" id="module-baangt.base.CliAndInteractive">
  134. <span id="baangt-base-cliandinteractive-module"></span><h2>baangt.base.CliAndInteractive module<a class="headerlink" href="#module-baangt.base.CliAndInteractive" title="Permalink to this headline">¶</a></h2>
  135. <dl class="function">
  136. <dt id="baangt.base.CliAndInteractive.args_read">
  137. <code class="sig-prename descclassname">baangt.base.CliAndInteractive.</code><code class="sig-name descname">args_read</code><span class="sig-paren">(</span><em class="sig-param">l_search_parameter</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.CliAndInteractive.args_read" title="Permalink to this definition">¶</a></dt>
  138. <dd></dd></dl>
  139. <dl class="function">
  140. <dt id="baangt.base.CliAndInteractive.callTestrun">
  141. <code class="sig-prename descclassname">baangt.base.CliAndInteractive.</code><code class="sig-name descname">callTestrun</code><span class="sig-paren">(</span><em class="sig-param">testRunFile</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.CliAndInteractive.callTestrun" title="Permalink to this definition">¶</a></dt>
  142. <dd></dd></dl>
  143. <dl class="function">
  144. <dt id="baangt.base.CliAndInteractive.getGlobalSettings">
  145. <code class="sig-prename descclassname">baangt.base.CliAndInteractive.</code><code class="sig-name descname">getGlobalSettings</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.CliAndInteractive.getGlobalSettings" title="Permalink to this definition">¶</a></dt>
  146. <dd></dd></dl>
  147. <dl class="function">
  148. <dt id="baangt.base.CliAndInteractive.print_args">
  149. <code class="sig-prename descclassname">baangt.base.CliAndInteractive.</code><code class="sig-name descname">print_args</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.CliAndInteractive.print_args" title="Permalink to this definition">¶</a></dt>
  150. <dd></dd></dl>
  151. <dl class="function">
  152. <dt id="baangt.base.CliAndInteractive.run">
  153. <code class="sig-prename descclassname">baangt.base.CliAndInteractive.</code><code class="sig-name descname">run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.CliAndInteractive.run" title="Permalink to this definition">¶</a></dt>
  154. <dd></dd></dl>
  155. </div>
  156. <div class="section" id="module-baangt.base.CustGlobalConstants">
  157. <span id="baangt-base-custglobalconstants-module"></span><h2>baangt.base.CustGlobalConstants module<a class="headerlink" href="#module-baangt.base.CustGlobalConstants" title="Permalink to this headline">¶</a></h2>
  158. </div>
  159. <div class="section" id="module-baangt.base.ExportResults">
  160. <span id="baangt-base-exportresults-module"></span><h2>baangt.base.ExportResults module<a class="headerlink" href="#module-baangt.base.ExportResults" title="Permalink to this headline">¶</a></h2>
  161. </div>
  162. <div class="section" id="module-baangt.base.GlobalConstants">
  163. <span id="baangt-base-globalconstants-module"></span><h2>baangt.base.GlobalConstants module<a class="headerlink" href="#module-baangt.base.GlobalConstants" title="Permalink to this headline">¶</a></h2>
  164. </div>
  165. <div class="section" id="module-baangt.base.HandleDatabase">
  166. <span id="baangt-base-handledatabase-module"></span><h2>baangt.base.HandleDatabase module<a class="headerlink" href="#module-baangt.base.HandleDatabase" title="Permalink to this headline">¶</a></h2>
  167. <dl class="class">
  168. <dt id="baangt.base.HandleDatabase.HandleDatabase">
  169. <em class="property">class </em><code class="sig-prename descclassname">baangt.base.HandleDatabase.</code><code class="sig-name descname">HandleDatabase</code><span class="sig-paren">(</span><em class="sig-param">linesToRead</em>, <em class="sig-param">globalSettings=None</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.HandleDatabase.HandleDatabase" title="Permalink to this definition">¶</a></dt>
  170. <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
  171. <dl class="method">
  172. <dt id="baangt.base.HandleDatabase.HandleDatabase.readNextRecord">
  173. <code class="sig-name descname">readNextRecord</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.HandleDatabase.HandleDatabase.readNextRecord" title="Permalink to this definition">¶</a></dt>
  174. <dd><p>We built self.range during init. Now we need to iterate over the range(s) in range,
  175. find appropriate record and return that - one at a time</p>
  176. <p>&#64;return:</p>
  177. </dd></dl>
  178. <dl class="method">
  179. <dt id="baangt.base.HandleDatabase.HandleDatabase.readTestRecord">
  180. <code class="sig-name descname">readTestRecord</code><span class="sig-paren">(</span><em class="sig-param">lineNumber=None</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.HandleDatabase.HandleDatabase.readTestRecord" title="Permalink to this definition">¶</a></dt>
  181. <dd></dd></dl>
  182. <dl class="method">
  183. <dt id="baangt.base.HandleDatabase.HandleDatabase.read_excel">
  184. <code class="sig-name descname">read_excel</code><span class="sig-paren">(</span><em class="sig-param">fileName</em>, <em class="sig-param">sheetName</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.HandleDatabase.HandleDatabase.read_excel" title="Permalink to this definition">¶</a></dt>
  185. <dd></dd></dl>
  186. <dl class="method">
  187. <dt id="baangt.base.HandleDatabase.HandleDatabase.updateGlobals">
  188. <code class="sig-name descname">updateGlobals</code><span class="sig-paren">(</span><em class="sig-param">record</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.HandleDatabase.HandleDatabase.updateGlobals" title="Permalink to this definition">¶</a></dt>
  189. <dd></dd></dl>
  190. </dd></dl>
  191. </div>
  192. <div class="section" id="module-baangt.base.IBAN">
  193. <span id="baangt-base-iban-module"></span><h2>baangt.base.IBAN module<a class="headerlink" href="#module-baangt.base.IBAN" title="Permalink to this headline">¶</a></h2>
  194. <dl class="class">
  195. <dt id="baangt.base.IBAN.IBAN">
  196. <em class="property">class </em><code class="sig-prename descclassname">baangt.base.IBAN.</code><code class="sig-name descname">IBAN</code><span class="sig-paren">(</span><em class="sig-param">bankLeitZahl='20151'</em>, <em class="sig-param">bankLand='AT'</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.IBAN.IBAN" title="Permalink to this definition">¶</a></dt>
  197. <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
  198. <dl class="method">
  199. <dt id="baangt.base.IBAN.IBAN.getRandomIBAN">
  200. <code class="sig-name descname">getRandomIBAN</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.IBAN.IBAN.getRandomIBAN" title="Permalink to this definition">¶</a></dt>
  201. <dd><p>Generates a random IBAN based on bankLand and bankLeitzahl as well as a random account number</p>
  202. <p>&#64;return: gives a String of IBAN</p>
  203. </dd></dl>
  204. </dd></dl>
  205. </div>
  206. <div class="section" id="module-baangt.base.TestRun">
  207. <span id="baangt-base-testrun-module"></span><h2>baangt.base.TestRun module<a class="headerlink" href="#module-baangt.base.TestRun" title="Permalink to this headline">¶</a></h2>
  208. </div>
  209. <div class="section" id="module-baangt.base.TestRunDatabaseCreate">
  210. <span id="baangt-base-testrundatabasecreate-module"></span><h2>baangt.base.TestRunDatabaseCreate module<a class="headerlink" href="#module-baangt.base.TestRunDatabaseCreate" title="Permalink to this headline">¶</a></h2>
  211. <dl class="class">
  212. <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate">
  213. <em class="property">class </em><code class="sig-prename descclassname">baangt.base.TestRunDatabaseCreate.</code><code class="sig-name descname">TestRunDatabaseCreate</code><span class="sig-paren">(</span><em class="sig-param">dbConnection=None</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate" title="Permalink to this definition">¶</a></dt>
  214. <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
  215. <p>Initializes the Database and loads some sample data</p>
  216. <dl class="method">
  217. <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.commit">
  218. <code class="sig-name descname">commit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.commit" title="Permalink to this definition">¶</a></dt>
  219. <dd></dd></dl>
  220. <dl class="method">
  221. <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createActivityTypes">
  222. <code class="sig-name descname">createActivityTypes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createActivityTypes" title="Permalink to this definition">¶</a></dt>
  223. <dd></dd></dl>
  224. <dl class="method">
  225. <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createExectionMethods">
  226. <code class="sig-name descname">createExectionMethods</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createExectionMethods" title="Permalink to this definition">¶</a></dt>
  227. <dd></dd></dl>
  228. <dl class="method">
  229. <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createLocatorTypes">
  230. <code class="sig-name descname">createLocatorTypes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createLocatorTypes" title="Permalink to this definition">¶</a></dt>
  231. <dd></dd></dl>
  232. <dl class="method">
  233. <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createMasterClasses">
  234. <code class="sig-name descname">createMasterClasses</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createMasterClasses" title="Permalink to this definition">¶</a></dt>
  235. <dd></dd></dl>
  236. <dl class="method">
  237. <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createStructures">
  238. <code class="sig-name descname">createStructures</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createStructures" title="Permalink to this definition">¶</a></dt>
  239. <dd></dd></dl>
  240. <dl class="method">
  241. <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createTestCase">
  242. <code class="sig-name descname">createTestCase</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createTestCase" title="Permalink to this definition">¶</a></dt>
  243. <dd></dd></dl>
  244. <dl class="method">
  245. <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createTestCase2TestData">
  246. <code class="sig-name descname">createTestCase2TestData</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createTestCase2TestData" title="Permalink to this definition">¶</a></dt>
  247. <dd></dd></dl>
  248. <dl class="method">
  249. <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createTestCaseSequence">
  250. <code class="sig-name descname">createTestCaseSequence</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createTestCaseSequence" title="Permalink to this definition">¶</a></dt>
  251. <dd></dd></dl>
  252. <dl class="method">
  253. <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createTestDataDefinition">
  254. <code class="sig-name descname">createTestDataDefinition</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createTestDataDefinition" title="Permalink to this definition">¶</a></dt>
  255. <dd></dd></dl>
  256. <dl class="method">
  257. <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createTestRun">
  258. <code class="sig-name descname">createTestRun</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createTestRun" title="Permalink to this definition">¶</a></dt>
  259. <dd></dd></dl>
  260. <dl class="method">
  261. <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createTestStep">
  262. <code class="sig-name descname">createTestStep</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createTestStep" title="Permalink to this definition">¶</a></dt>
  263. <dd></dd></dl>
  264. <dl class="method">
  265. <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createTestStepSequence">
  266. <code class="sig-name descname">createTestStepSequence</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createTestStepSequence" title="Permalink to this definition">¶</a></dt>
  267. <dd></dd></dl>
  268. <dl class="method">
  269. <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createValidator">
  270. <code class="sig-name descname">createValidator</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createValidator" title="Permalink to this definition">¶</a></dt>
  271. <dd></dd></dl>
  272. <dl class="method">
  273. <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.getCursor">
  274. <code class="sig-name descname">getCursor</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.getCursor" title="Permalink to this definition">¶</a></dt>
  275. <dd></dd></dl>
  276. </dd></dl>
  277. <dl class="class">
  278. <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseFill">
  279. <em class="property">class </em><code class="sig-prename descclassname">baangt.base.TestRunDatabaseCreate.</code><code class="sig-name descname">TestRunDatabaseFill</code><span class="sig-paren">(</span><em class="sig-param">cursor</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunDatabaseCreate.TestRunDatabaseFill" title="Permalink to this definition">¶</a></dt>
  280. <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
  281. <dl class="method">
  282. <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseFill.fill">
  283. <code class="sig-name descname">fill</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunDatabaseCreate.TestRunDatabaseFill.fill" title="Permalink to this definition">¶</a></dt>
  284. <dd></dd></dl>
  285. </dd></dl>
  286. </div>
  287. <div class="section" id="module-baangt.base.TestRunExcelImporter">
  288. <span id="baangt-base-testrunexcelimporter-module"></span><h2>baangt.base.TestRunExcelImporter module<a class="headerlink" href="#module-baangt.base.TestRunExcelImporter" title="Permalink to this headline">¶</a></h2>
  289. <dl class="class">
  290. <dt id="baangt.base.TestRunExcelImporter.TestRunExcelImporter">
  291. <em class="property">class </em><code class="sig-prename descclassname">baangt.base.TestRunExcelImporter.</code><code class="sig-name descname">TestRunExcelImporter</code><span class="sig-paren">(</span><em class="sig-param">FileNameAndPath</em>, <em class="sig-param">testRunUtils: baangt.base.TestRunUtils.TestRunUtils</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunExcelImporter.TestRunExcelImporter" title="Permalink to this definition">¶</a></dt>
  292. <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
  293. <p>The TestrunSettings are in class TestRunUtils and expected to be a deep dict. For details see documentation there.</p>
  294. <p>This class will migrate data from an excel sheet (either simple format with only 1 tab or complex format with all
  295. structural elements) into the deep dict.</p>
  296. <p>In case the XLSX is simple format, all missing data is “predicted”/assumed.</p>
  297. <dl class="method">
  298. <dt id="baangt.base.TestRunExcelImporter.TestRunExcelImporter.getRowsWithHeadersAsDict">
  299. <code class="sig-name descname">getRowsWithHeadersAsDict</code><span class="sig-paren">(</span><em class="sig-param">xlsTab</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunExcelImporter.TestRunExcelImporter.getRowsWithHeadersAsDict" title="Permalink to this definition">¶</a></dt>
  300. <dd></dd></dl>
  301. <dl class="method">
  302. <dt id="baangt.base.TestRunExcelImporter.TestRunExcelImporter.importConfig">
  303. <code class="sig-name descname">importConfig</code><span class="sig-paren">(</span><em class="sig-param">global_settings</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunExcelImporter.TestRunExcelImporter.importConfig" title="Permalink to this definition">¶</a></dt>
  304. <dd></dd></dl>
  305. <dl class="method">
  306. <dt id="baangt.base.TestRunExcelImporter.TestRunExcelImporter.replaceFieldValueWithValueOfConstant">
  307. <code class="sig-name descname">replaceFieldValueWithValueOfConstant</code><span class="sig-paren">(</span><em class="sig-param">value</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunExcelImporter.TestRunExcelImporter.replaceFieldValueWithValueOfConstant" title="Permalink to this definition">¶</a></dt>
  308. <dd><p>baangt Global constants (baangt.base.GlobalConstants) are available everywhere as GC., e.g. the variable
  309. “BROWSER” defined in GlobalConstants can be accessed from everywhere within baangt by using “GC.BROWSER”.</p>
  310. <p>The variables can also be used in configuration files (would be very stupid if we need to change a constant and
  311. then 100s of Config-Files need adjustment - worst case the testruns behave unexepected). This applies both to
  312. XLSX and JSON Config files.</p>
  313. <p>The CGC.-Part is still needs fixing. It shouldn’t appear in Baangt base, but currently still needed.</p>
  314. <p>&#64;param value: potentially convertable value (e.g. GC.BROWSER)
  315. &#64;return: potentially converted value (e.g. “Browser”)</p>
  316. </dd></dl>
  317. </dd></dl>
  318. </div>
  319. <div class="section" id="module-baangt.base.TestRunUtils">
  320. <span id="baangt-base-testrunutils-module"></span><h2>baangt.base.TestRunUtils module<a class="headerlink" href="#module-baangt.base.TestRunUtils" title="Permalink to this headline">¶</a></h2>
  321. <dl class="class">
  322. <dt id="baangt.base.TestRunUtils.TestRunUtils">
  323. <em class="property">class </em><code class="sig-prename descclassname">baangt.base.TestRunUtils.</code><code class="sig-name descname">TestRunUtils</code><a class="headerlink" href="#baangt.base.TestRunUtils.TestRunUtils" title="Permalink to this definition">¶</a></dt>
  324. <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
  325. <dl class="method">
  326. <dt id="baangt.base.TestRunUtils.TestRunUtils.getCompleteTestRunAttributes">
  327. <code class="sig-name descname">getCompleteTestRunAttributes</code><span class="sig-paren">(</span><em class="sig-param">testRunName</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunUtils.TestRunUtils.getCompleteTestRunAttributes" title="Permalink to this definition">¶</a></dt>
  328. <dd></dd></dl>
  329. <dl class="method">
  330. <dt id="baangt.base.TestRunUtils.TestRunUtils.getSequenceByNumber">
  331. <code class="sig-name descname">getSequenceByNumber</code><span class="sig-paren">(</span><em class="sig-param">sequence</em>, <em class="sig-param">testRunName</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunUtils.TestRunUtils.getSequenceByNumber" title="Permalink to this definition">¶</a></dt>
  332. <dd></dd></dl>
  333. <dl class="method">
  334. <dt id="baangt.base.TestRunUtils.TestRunUtils.getTestCaseByNumber">
  335. <code class="sig-name descname">getTestCaseByNumber</code><span class="sig-paren">(</span><em class="sig-param">sequence</em>, <em class="sig-param">testcaseNumber</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunUtils.TestRunUtils.getTestCaseByNumber" title="Permalink to this definition">¶</a></dt>
  336. <dd></dd></dl>
  337. <dl class="method">
  338. <dt id="baangt.base.TestRunUtils.TestRunUtils.getTestStepByNumber">
  339. <code class="sig-name descname">getTestStepByNumber</code><span class="sig-paren">(</span><em class="sig-param">testCase</em>, <em class="sig-param">testStepNumber</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunUtils.TestRunUtils.getTestStepByNumber" title="Permalink to this definition">¶</a></dt>
  340. <dd></dd></dl>
  341. <dl class="method">
  342. <dt id="baangt.base.TestRunUtils.TestRunUtils.replaceGlobals">
  343. <code class="sig-name descname">replaceGlobals</code><span class="sig-paren">(</span><em class="sig-param">globals</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunUtils.TestRunUtils.replaceGlobals" title="Permalink to this definition">¶</a></dt>
  344. <dd><p>Will go through all testcase-Settings and replace values with values from global settings, if matched</p>
  345. </dd></dl>
  346. <dl class="method">
  347. <dt id="baangt.base.TestRunUtils.TestRunUtils.setCompleteTestRunAttributes">
  348. <code class="sig-name descname">setCompleteTestRunAttributes</code><span class="sig-paren">(</span><em class="sig-param">testRunName: str</em>, <em class="sig-param">testRunAttributes: dict</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunUtils.TestRunUtils.setCompleteTestRunAttributes" title="Permalink to this definition">¶</a></dt>
  349. <dd></dd></dl>
  350. </dd></dl>
  351. </div>
  352. <div class="section" id="module-baangt.base.Timing">
  353. <span id="baangt-base-timing-module"></span><h2>baangt.base.Timing module<a class="headerlink" href="#module-baangt.base.Timing" title="Permalink to this headline">¶</a></h2>
  354. </div>
  355. <div class="section" id="module-baangt.base.Utils">
  356. <span id="baangt-base-utils-module"></span><h2>baangt.base.Utils module<a class="headerlink" href="#module-baangt.base.Utils" title="Permalink to this headline">¶</a></h2>
  357. <dl class="class">
  358. <dt id="baangt.base.Utils.utils">
  359. <em class="property">class </em><code class="sig-prename descclassname">baangt.base.Utils.</code><code class="sig-name descname">utils</code><a class="headerlink" href="#baangt.base.Utils.utils" title="Permalink to this definition">¶</a></dt>
  360. <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
  361. <dl class="method">
  362. <dt id="baangt.base.Utils.utils.datetime_return">
  363. <em class="property">static </em><code class="sig-name descname">datetime_return</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.Utils.utils.datetime_return" title="Permalink to this definition">¶</a></dt>
  364. <dd></dd></dl>
  365. <dl class="method">
  366. <dt id="baangt.base.Utils.utils.extractFileNameFromFullPath">
  367. <em class="property">static </em><code class="sig-name descname">extractFileNameFromFullPath</code><span class="sig-paren">(</span><em class="sig-param">fileAndPathName</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.Utils.utils.extractFileNameFromFullPath" title="Permalink to this definition">¶</a></dt>
  368. <dd></dd></dl>
  369. <dl class="method">
  370. <dt id="baangt.base.Utils.utils.findFileAndPathFromPath">
  371. <em class="property">static </em><code class="sig-name descname">findFileAndPathFromPath</code><span class="sig-paren">(</span><em class="sig-param">fileNameAndPath</em>, <em class="sig-param">basePath=None</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.Utils.utils.findFileAndPathFromPath" title="Permalink to this definition">¶</a></dt>
  372. <dd><p>Tries different approaches to locate a file
  373. lBasePath = the Path where the script is run</p>
  374. <p>&#64;param fileNameAndPath: Filename and potentially relative path
  375. &#64;param basePath (optional): Optional basePath to look at
  376. &#64;return:</p>
  377. </dd></dl>
  378. <dl class="method">
  379. <dt id="baangt.base.Utils.utils.listToString">
  380. <em class="property">static </em><code class="sig-name descname">listToString</code><span class="sig-paren">(</span><em class="sig-param">completeList</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.Utils.utils.listToString" title="Permalink to this definition">¶</a></dt>
  381. <dd><p>Returns a concatenated string from a list-object
  382. :param completeList: any List
  383. :return: String</p>
  384. </dd></dl>
  385. <dl class="method">
  386. <dt id="baangt.base.Utils.utils.openJson">
  387. <em class="property">static </em><code class="sig-name descname">openJson</code><span class="sig-paren">(</span><em class="sig-param">fileNameAndPath</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.Utils.utils.openJson" title="Permalink to this definition">¶</a></dt>
  388. <dd></dd></dl>
  389. <dl class="method">
  390. <dt id="baangt.base.Utils.utils.replaceAllGlobalConstantsInDict">
  391. <em class="property">static </em><code class="sig-name descname">replaceAllGlobalConstantsInDict</code><span class="sig-paren">(</span><em class="sig-param">lDict: dict</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.Utils.utils.replaceAllGlobalConstantsInDict" title="Permalink to this definition">¶</a></dt>
  392. <dd></dd></dl>
  393. <dl class="method">
  394. <dt id="baangt.base.Utils.utils.replaceFieldValueWithValueOfConstant">
  395. <em class="property">static </em><code class="sig-name descname">replaceFieldValueWithValueOfConstant</code><span class="sig-paren">(</span><em class="sig-param">value</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.Utils.utils.replaceFieldValueWithValueOfConstant" title="Permalink to this definition">¶</a></dt>
  396. <dd><p>If a String reference to global Constant (e.g. GC.BROWSER_FF) is
  397. given, this function will replace it with the actual value (e.g. FIREFOX)</p>
  398. </dd></dl>
  399. <dl class="method">
  400. <dt id="baangt.base.Utils.utils.sanitizeFileName">
  401. <em class="property">static </em><code class="sig-name descname">sanitizeFileName</code><span class="sig-paren">(</span><em class="sig-param">value</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.Utils.utils.sanitizeFileName" title="Permalink to this definition">¶</a></dt>
  402. <dd></dd></dl>
  403. </dd></dl>
  404. </div>
  405. <div class="section" id="module-baangt.base">
  406. <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-baangt.base" title="Permalink to this headline">¶</a></h2>
  407. </div>
  408. </div>
  409. </div>
  410. </div>
  411. <footer>
  412. <hr/>
  413. <div role="contentinfo">
  414. <p>
  415. &copy; Copyright 2020, Bernhard Buhl
  416. </p>
  417. </div>
  418. 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>.
  419. </footer>
  420. </div>
  421. </div>
  422. </section>
  423. </div>
  424. <script type="text/javascript">
  425. jQuery(function () {
  426. SphinxRtdTheme.Navigation.enable(true);
  427. });
  428. </script>
  429. </body>
  430. </html>