SaveResults2Database.html 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765
  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>Save Testrun Results to Database &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="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="Why baangt and why is it open source?" href="HistoryAndReasons.html" />
  21. <link rel="prev" title="Special functions in datafiles" href="DataFile.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"><a class="reference internal" href="ParametersConfigFile.html"> 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 current"><a class="current reference internal" href="#"> Results in Database</a><ul>
  50. <li class="toctree-l2"><a class="reference internal" href="#tables">Tables</a><ul>
  51. <li class="toctree-l3"><a class="reference internal" href="#table-testruns">Table: <code class="docutils literal notranslate"><span class="pre">testruns</span></code></a></li>
  52. <li class="toctree-l3"><a class="reference internal" href="#table-testcasesequences">Table: <code class="docutils literal notranslate"><span class="pre">testCaseSequences</span></code></a></li>
  53. <li class="toctree-l3"><a class="reference internal" href="#table-testcases">Table: <code class="docutils literal notranslate"><span class="pre">testCases</span></code></a></li>
  54. <li class="toctree-l3"><a class="reference internal" href="#table-globals">Table: <code class="docutils literal notranslate"><span class="pre">globals</span></code></a></li>
  55. <li class="toctree-l3"><a class="reference internal" href="#table-testcasefields">Table: <code class="docutils literal notranslate"><span class="pre">testCaseFields</span></code></a></li>
  56. <li class="toctree-l3"><a class="reference internal" href="#table-networkinfo">Table: <code class="docutils literal notranslate"><span class="pre">networkInfo</span></code></a></li>
  57. </ul>
  58. </li>
  59. <li class="toctree-l2"><a class="reference internal" href="#for-developers-orm-api">For Developers: ORM API</a><ul>
  60. <li class="toctree-l3"><a class="reference internal" href="#testrunlog">TestrunLog</a></li>
  61. <li class="toctree-l3"><a class="reference internal" href="#testcasesequencelog">TestCaseSequenceLog</a></li>
  62. <li class="toctree-l3"><a class="reference internal" href="#testcaselog">TestCaseLog</a></li>
  63. <li class="toctree-l3"><a class="reference internal" href="#globalattribute">GlobalAttribute</a></li>
  64. <li class="toctree-l3"><a class="reference internal" href="#testcasefield">TestCaseField</a></li>
  65. <li class="toctree-l3"><a class="reference internal" href="#testcasenetworkinfo">TestCaseNetworkInfo</a></li>
  66. </ul>
  67. </li>
  68. </ul>
  69. </li>
  70. <li class="toctree-l1"><a class="reference internal" href="HistoryAndReasons.html"> History</a></li>
  71. <li class="toctree-l1"><a class="reference internal" href="contributors.html"> Contributions</a></li>
  72. <li class="toctree-l1"><a class="reference internal" href="changelog.html"> Changelog</a></li>
  73. <li class="toctree-l1"><a class="reference internal" href="PlannedFeatures.html"> Planned Features</a></li>
  74. <li class="toctree-l1"><a class="reference internal" href="BrowserDrivers.html"> Browser Drivers</a></li>
  75. <li class="toctree-l1"><a class="reference internal" href="Variables.html"> Variables</a></li>
  76. <li class="toctree-l1"><a class="reference internal" href="Datagenerator.html">DataGenerator</a></li>
  77. <li class="toctree-l1"><a class="reference internal" href="Datagenerator.html#input-file">Input File</a></li>
  78. <li class="toctree-l1"><a class="reference internal" href="Datagenerator.html#data-type">Data Type</a></li>
  79. <li class="toctree-l1"><a class="reference internal" href="Datagenerator.html#all-data-types-format">All Data Types Format</a></li>
  80. <li class="toctree-l1"><a class="reference internal" href="Developer.html"> For Developers</a></li>
  81. <li class="toctree-l1"><a class="reference internal" href="baangt-Plugin.html">What is a baangt-plugin</a></li>
  82. <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>
  83. <li class="toctree-l1"><a class="reference internal" href="baangt-Plugin.html#how-the-baangt-plugin-work">how the baangt-plugin work</a></li>
  84. <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>
  85. <li class="toctree-l1"><a class="reference internal" href="articles/Articles.html"> :subheader: Articles</a></li>
  86. <li class="toctree-l1"><a class="reference external" href="http://www.baangt.org"> Web</a></li>
  87. </ul>
  88. <p class="caption"><span class="caption-text">Contents:</span></p>
  89. <ul>
  90. <li class="toctree-l1"><a class="reference internal" href="docs/baangt.base.html">Autodocs</a></li>
  91. </ul>
  92. </div>
  93. </div>
  94. </nav>
  95. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  96. <nav class="wy-nav-top" aria-label="top navigation">
  97. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  98. <a href="index.html">baangt</a>
  99. </nav>
  100. <div class="wy-nav-content">
  101. <div class="rst-content">
  102. <div role="navigation" aria-label="breadcrumbs navigation">
  103. <ul class="wy-breadcrumbs">
  104. <li><a href="index.html">Docs</a> &raquo;</li>
  105. <li>Save Testrun Results to Database</li>
  106. <li class="wy-breadcrumbs-aside">
  107. <a href="_sources/SaveResults2Database.rst.txt" rel="nofollow"> View page source</a>
  108. </li>
  109. </ul>
  110. <hr/>
  111. </div>
  112. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  113. <div itemprop="articleBody">
  114. <div class="section" id="save-testrun-results-to-database">
  115. <h1>Save Testrun Results to Database<a class="headerlink" href="#save-testrun-results-to-database" title="Permalink to this headline">¶</a></h1>
  116. <p>One of the options that <code class="docutils literal notranslate"><span class="pre">baangt</span></code> provides to save the results of the executed Testruns is using an SQL database.
  117. The identification of the database is implemented via the environmental variable BAANGT_RESULTS_DATABASE_URL.
  118. if <code class="docutils literal notranslate"><span class="pre">baangt</span></code> cannot retrieve BAANGT_RESULTS_DATABASE_URL it uses the default database URL:
  119. <code class="docutils literal notranslate"><span class="pre">sqlite:///testrun.db</span></code></p>
  120. <div class="section" id="tables">
  121. <h2>Tables<a class="headerlink" href="#tables" title="Permalink to this headline">¶</a></h2>
  122. <div class="section" id="table-testruns">
  123. <h3>Table: <code class="docutils literal notranslate"><span class="pre">testruns</span></code><a class="headerlink" href="#table-testruns" title="Permalink to this headline">¶</a></h3>
  124. <p>Table holds results of the executed Testruns: Testrun Logs</p>
  125. <table class="colwidths-given docutils align-default" id="id1">
  126. <caption><span class="caption-text">Testrun Logs</span><a class="headerlink" href="#id1" title="Permalink to this table">¶</a></caption>
  127. <colgroup>
  128. <col style="width: 25%" />
  129. <col style="width: 15%" />
  130. <col style="width: 60%" />
  131. </colgroup>
  132. <thead>
  133. <tr class="row-odd"><th class="head"><p>Column</p></th>
  134. <th class="head"><p>Data Type</p></th>
  135. <th class="head"><p>Description</p></th>
  136. </tr>
  137. </thead>
  138. <tbody>
  139. <tr class="row-even"><td><p>id</p></td>
  140. <td><p>BINARY</p></td>
  141. <td><p>Testrun Log UUID. Primary key for Testrun Log.</p></td>
  142. </tr>
  143. <tr class="row-odd"><td><p>testrunName</p></td>
  144. <td><p>VARCHAR</p></td>
  145. <td><p>A name associated with the Testrun.</p></td>
  146. </tr>
  147. <tr class="row-even"><td><p>logfileName</p></td>
  148. <td><p>VARCHAR</p></td>
  149. <td><p>Path to the logfile of the Testrun.</p></td>
  150. </tr>
  151. <tr class="row-odd"><td><p>startTime</p></td>
  152. <td><p>DATETIME</p></td>
  153. <td><p>Satrt time of the Testrun execution.</p></td>
  154. </tr>
  155. <tr class="row-even"><td><p>endTime</p></td>
  156. <td><p>DATETIME</p></td>
  157. <td><p>End time of the Testrun execurtion.</p></td>
  158. </tr>
  159. <tr class="row-odd"><td><p>dataFile</p></td>
  160. <td><p>VARCHAR</p></td>
  161. <td><p>Path to the Data File of the Testrun.</p></td>
  162. </tr>
  163. <tr class="row-even"><td><p>statusOk</p></td>
  164. <td><p>INTEGER</p></td>
  165. <td><p>Number of the successful test cases within the executed Testrun.</p></td>
  166. </tr>
  167. <tr class="row-odd"><td><p>statusFailed</p></td>
  168. <td><p>INTEGER</p></td>
  169. <td><p>Number of the failed test cases within the executed Testrun.</p></td>
  170. </tr>
  171. <tr class="row-even"><td><p>statusPaused</p></td>
  172. <td><p>INTEGER</p></td>
  173. <td><p>Number of the paused test cases within the executed Testrun.</p></td>
  174. </tr>
  175. </tbody>
  176. </table>
  177. </div>
  178. <div class="section" id="table-testcasesequences">
  179. <h3>Table: <code class="docutils literal notranslate"><span class="pre">testCaseSequences</span></code><a class="headerlink" href="#table-testcasesequences" title="Permalink to this headline">¶</a></h3>
  180. <p>Table holds data on the executed test case sequences: TestCaseSequence Logs</p>
  181. <table class="colwidths-given docutils align-default" id="id2">
  182. <caption><span class="caption-text">TestCaseSequence Logs</span><a class="headerlink" href="#id2" title="Permalink to this table">¶</a></caption>
  183. <colgroup>
  184. <col style="width: 25%" />
  185. <col style="width: 15%" />
  186. <col style="width: 60%" />
  187. </colgroup>
  188. <thead>
  189. <tr class="row-odd"><th class="head"><p>Column</p></th>
  190. <th class="head"><p>Data Type</p></th>
  191. <th class="head"><p>Description</p></th>
  192. </tr>
  193. </thead>
  194. <tbody>
  195. <tr class="row-even"><td><p>id</p></td>
  196. <td><p>BINARY</p></td>
  197. <td><p>TestCaseSequence Log UUID. Primary key for TestCaseSequence Log.</p></td>
  198. </tr>
  199. <tr class="row-odd"><td><p>testrun_id</p></td>
  200. <td><p>INTEGER</p></td>
  201. <td><p>Foreign key to <code class="docutils literal notranslate"><span class="pre">testruns</span></code>
  202. Testrun that contains the test case sequence.</p></td>
  203. </tr>
  204. </tbody>
  205. </table>
  206. </div>
  207. <div class="section" id="table-testcases">
  208. <h3>Table: <code class="docutils literal notranslate"><span class="pre">testCases</span></code><a class="headerlink" href="#table-testcases" title="Permalink to this headline">¶</a></h3>
  209. <p>Table holds data on the executed test cases: TestCase Logs</p>
  210. <table class="colwidths-given docutils align-default" id="id3">
  211. <caption><span class="caption-text">TestCase Logs</span><a class="headerlink" href="#id3" title="Permalink to this table">¶</a></caption>
  212. <colgroup>
  213. <col style="width: 25%" />
  214. <col style="width: 15%" />
  215. <col style="width: 60%" />
  216. </colgroup>
  217. <thead>
  218. <tr class="row-odd"><th class="head"><p>Column</p></th>
  219. <th class="head"><p>Data Type</p></th>
  220. <th class="head"><p>Description</p></th>
  221. </tr>
  222. </thead>
  223. <tbody>
  224. <tr class="row-even"><td><p>id</p></td>
  225. <td><p>BINARY</p></td>
  226. <td><p>TestCase Log UUID. Primary key for TestCase Log.</p></td>
  227. </tr>
  228. <tr class="row-odd"><td><p>testcase_sequence_id</p></td>
  229. <td><p>INTEGER</p></td>
  230. <td><p>Foreign key to <code class="docutils literal notranslate"><span class="pre">testCaseSequences</span></code>
  231. Test case sequence that contains the test case.</p></td>
  232. </tr>
  233. </tbody>
  234. </table>
  235. </div>
  236. <div class="section" id="table-globals">
  237. <h3>Table: <code class="docutils literal notranslate"><span class="pre">globals</span></code><a class="headerlink" href="#table-globals" title="Permalink to this headline">¶</a></h3>
  238. <p>Table holds global variables of the executed Testruns</p>
  239. <table class="colwidths-given docutils align-default" id="id4">
  240. <caption><span class="caption-text">Globals</span><a class="headerlink" href="#id4" title="Permalink to this table">¶</a></caption>
  241. <colgroup>
  242. <col style="width: 25%" />
  243. <col style="width: 15%" />
  244. <col style="width: 60%" />
  245. </colgroup>
  246. <thead>
  247. <tr class="row-odd"><th class="head"><p>Column</p></th>
  248. <th class="head"><p>Data Type</p></th>
  249. <th class="head"><p>Description</p></th>
  250. </tr>
  251. </thead>
  252. <tbody>
  253. <tr class="row-even"><td><p>id</p></td>
  254. <td><p>INTEGER</p></td>
  255. <td><p>Primary key for the global variable.</p></td>
  256. </tr>
  257. <tr class="row-odd"><td><p>name</p></td>
  258. <td><p>VARCHAR</p></td>
  259. <td><p>Name of the global variable.</p></td>
  260. </tr>
  261. <tr class="row-even"><td><p>value</p></td>
  262. <td><p>VARCHAR</p></td>
  263. <td><p>Value of the global variable.</p></td>
  264. </tr>
  265. <tr class="row-odd"><td><p>testrun_id</p></td>
  266. <td><p>INTEGER</p></td>
  267. <td><p>Foreign key to <code class="docutils literal notranslate"><span class="pre">testruns</span></code>
  268. Testrun that contains the global variable.</p></td>
  269. </tr>
  270. </tbody>
  271. </table>
  272. </div>
  273. <div class="section" id="table-testcasefields">
  274. <h3>Table: <code class="docutils literal notranslate"><span class="pre">testCaseFields</span></code><a class="headerlink" href="#table-testcasefields" title="Permalink to this headline">¶</a></h3>
  275. <p>Table holds log fields of the executed test cases</p>
  276. <table class="colwidths-given docutils align-default" id="id5">
  277. <caption><span class="caption-text">Testcase Fields</span><a class="headerlink" href="#id5" title="Permalink to this table">¶</a></caption>
  278. <colgroup>
  279. <col style="width: 25%" />
  280. <col style="width: 15%" />
  281. <col style="width: 60%" />
  282. </colgroup>
  283. <thead>
  284. <tr class="row-odd"><th class="head"><p>Column</p></th>
  285. <th class="head"><p>Data Type</p></th>
  286. <th class="head"><p>Description</p></th>
  287. </tr>
  288. </thead>
  289. <tbody>
  290. <tr class="row-even"><td><p>id</p></td>
  291. <td><p>INTEGER</p></td>
  292. <td><p>Primary key for the field.</p></td>
  293. </tr>
  294. <tr class="row-odd"><td><p>name</p></td>
  295. <td><p>VARCHAR</p></td>
  296. <td><p>Name of the field.</p></td>
  297. </tr>
  298. <tr class="row-even"><td><p>value</p></td>
  299. <td><p>VARCHAR</p></td>
  300. <td><p>Value of the field.</p></td>
  301. </tr>
  302. <tr class="row-odd"><td><p>testcase_id</p></td>
  303. <td><p>INTEGER</p></td>
  304. <td><p>Foreign key to <code class="docutils literal notranslate"><span class="pre">testCases</span></code>
  305. Test case that contains the field.</p></td>
  306. </tr>
  307. </tbody>
  308. </table>
  309. </div>
  310. <div class="section" id="table-networkinfo">
  311. <h3>Table: <code class="docutils literal notranslate"><span class="pre">networkInfo</span></code><a class="headerlink" href="#table-networkinfo" title="Permalink to this headline">¶</a></h3>
  312. <p>Table holds info on requests made while execution of the test cases</p>
  313. <table class="colwidths-given docutils align-default" id="id6">
  314. <caption><span class="caption-text">Network Info</span><a class="headerlink" href="#id6" title="Permalink to this table">¶</a></caption>
  315. <colgroup>
  316. <col style="width: 25%" />
  317. <col style="width: 15%" />
  318. <col style="width: 60%" />
  319. </colgroup>
  320. <thead>
  321. <tr class="row-odd"><th class="head"><p>Column</p></th>
  322. <th class="head"><p>Data Type</p></th>
  323. <th class="head"><p>Description</p></th>
  324. </tr>
  325. </thead>
  326. <tbody>
  327. <tr class="row-even"><td><p>id</p></td>
  328. <td><p>INTEGER</p></td>
  329. <td><p>Primary key for the network info.</p></td>
  330. </tr>
  331. <tr class="row-odd"><td><p>browserName</p></td>
  332. <td><p>VARCHAR</p></td>
  333. <td><p>Browser name that was used to make the request.</p></td>
  334. </tr>
  335. <tr class="row-even"><td><p>status</p></td>
  336. <td><p>INTEGER</p></td>
  337. <td><p>The status code of the HTTP response.</p></td>
  338. </tr>
  339. <tr class="row-odd"><td><p>method</p></td>
  340. <td><p>VARCHAR</p></td>
  341. <td><p>The request method.</p></td>
  342. </tr>
  343. <tr class="row-even"><td><p>url</p></td>
  344. <td><p>VARCHAR</p></td>
  345. <td><p>The request URL.</p></td>
  346. </tr>
  347. <tr class="row-odd"><td><p>contentType</p></td>
  348. <td><p>VARCHAR</p></td>
  349. <td><p>Content-type header of the response.</p></td>
  350. </tr>
  351. <tr class="row-even"><td><p>contentSize</p></td>
  352. <td><p>INTEGER</p></td>
  353. <td><p>The size of the response content.</p></td>
  354. </tr>
  355. <tr class="row-odd"><td><p>headers</p></td>
  356. <td><p>VARCHAR</p></td>
  357. <td><p>A string that represents a list of the response headers in format:
  358. <code class="docutils literal notranslate"><span class="pre">{'name':</span> <span class="pre">HEADER_NAME,</span> <span class="pre">'value':</span> <span class="pre">HEADER_VALUE}</span></code></p></td>
  359. </tr>
  360. <tr class="row-even"><td><p>params</p></td>
  361. <td><p>VARCHAR</p></td>
  362. <td><p>A string that represents a list of the request GET parameters in format:
  363. <code class="docutils literal notranslate"><span class="pre">{'name':</span> <span class="pre">PARAMETER_NAME,</span> <span class="pre">'value':</span> <span class="pre">PARAMETER_VALUE}</span></code></p></td>
  364. </tr>
  365. <tr class="row-odd"><td><p>response</p></td>
  366. <td><p>VARCHAR</p></td>
  367. <td><p>The content of the response.</p></td>
  368. </tr>
  369. <tr class="row-even"><td><p>startDateTime</p></td>
  370. <td><p>DATETIME</p></td>
  371. <td><p>The time when the request was sent.</p></td>
  372. </tr>
  373. <tr class="row-odd"><td><p>duration</p></td>
  374. <td><p>INTEGER</p></td>
  375. <td><p>The time (in <code class="docutils literal notranslate"><span class="pre">ms</span></code>) that it took to receive the response after the request was sent.</p></td>
  376. </tr>
  377. <tr class="row-even"><td><p>testcase_id</p></td>
  378. <td><p>INTEGER</p></td>
  379. <td><p>Foreign key to <code class="docutils literal notranslate"><span class="pre">testCases</span></code>
  380. Test case that contains the network info.</p></td>
  381. </tr>
  382. </tbody>
  383. </table>
  384. </div>
  385. </div>
  386. <div class="section" id="for-developers-orm-api">
  387. <h2>For Developers: ORM API<a class="headerlink" href="#for-developers-orm-api" title="Permalink to this headline">¶</a></h2>
  388. <p><code class="docutils literal notranslate"><span class="pre">baangt</span></code> provides ORM models to facilatate analysis of Testruns results.
  389. The models are located in module <code class="docutils literal notranslate"><span class="pre">baangt.base.DataBaseORM</span></code></p>
  390. <div class="section" id="testrunlog">
  391. <h3>TestrunLog<a class="headerlink" href="#testrunlog" title="Permalink to this headline">¶</a></h3>
  392. <p>Provides interface with table <code class="docutils literal notranslate"><span class="pre">testruns</span></code></p>
  393. <table class="colwidths-given docutils align-default" id="id7">
  394. <caption><span class="caption-text">baangt.base.DataBaseORM.TestrunLog</span><a class="headerlink" href="#id7" title="Permalink to this table">¶</a></caption>
  395. <colgroup>
  396. <col style="width: 30%" />
  397. <col style="width: 70%" />
  398. </colgroup>
  399. <thead>
  400. <tr class="row-odd"><th class="head"><p>Attribute</p></th>
  401. <th class="head"><p>Description</p></th>
  402. </tr>
  403. </thead>
  404. <tbody>
  405. <tr class="row-even"><td><p>id</p></td>
  406. <td><p>Testrun Log UUID as a bianry string.</p></td>
  407. </tr>
  408. <tr class="row-odd"><td><p>testrunName</p></td>
  409. <td><p>Name of the associated TestRun.</p></td>
  410. </tr>
  411. <tr class="row-even"><td><p>logfileName</p></td>
  412. <td><p>Path to the associated log file.</p></td>
  413. </tr>
  414. <tr class="row-odd"><td><p>startTime</p></td>
  415. <td><p>TestRun start time as a <code class="docutils literal notranslate"><span class="pre">datetime.datetime</span></code> object.</p></td>
  416. </tr>
  417. <tr class="row-even"><td><p>endTime</p></td>
  418. <td><p>TestRun start time as a <code class="docutils literal notranslate"><span class="pre">datetime.datetime</span></code> object.</p></td>
  419. </tr>
  420. <tr class="row-odd"><td><p>dataFile</p></td>
  421. <td><p>Path to the associated Data File.</p></td>
  422. </tr>
  423. <tr class="row-even"><td><p>statusOk</p></td>
  424. <td><p>Number of the successful test cases.</p></td>
  425. </tr>
  426. <tr class="row-odd"><td><p>statusFailed</p></td>
  427. <td><p>Number of the failed test cases.</p></td>
  428. </tr>
  429. <tr class="row-even"><td><p>statusPaused</p></td>
  430. <td><p>Number of the paused test cases.</p></td>
  431. </tr>
  432. <tr class="row-odd"><td><p>globalVars</p></td>
  433. <td><p>List of the global attributes (as <code class="docutils literal notranslate"><span class="pre">GlobalAttribute</span></code> instances) of the associated Testrun.</p></td>
  434. </tr>
  435. <tr class="row-even"><td><p>testcase_sequences</p></td>
  436. <td><p>List of the test case sequences (as <code class="docutils literal notranslate"><span class="pre">TestCaseSequenceLog</span></code> instances) within the associated Testrun.</p></td>
  437. </tr>
  438. <tr class="row-odd"><td><p>__str__()</p></td>
  439. <td><p>Method. Returns Testrun Log UUID as a string.</p></td>
  440. </tr>
  441. <tr class="row-even"><td><p>to_json()</p></td>
  442. <td><p>Method. Returns Testrun Log as a dictionary object.</p></td>
  443. </tr>
  444. </tbody>
  445. </table>
  446. </div>
  447. <div class="section" id="testcasesequencelog">
  448. <h3>TestCaseSequenceLog<a class="headerlink" href="#testcasesequencelog" title="Permalink to this headline">¶</a></h3>
  449. <p>Provides interface with table <code class="docutils literal notranslate"><span class="pre">testCaseSequences</span></code></p>
  450. <table class="colwidths-given docutils align-default" id="id8">
  451. <caption><span class="caption-text">baangt.base.DataBaseORM.TestCaseSequenceLog</span><a class="headerlink" href="#id8" title="Permalink to this table">¶</a></caption>
  452. <colgroup>
  453. <col style="width: 30%" />
  454. <col style="width: 70%" />
  455. </colgroup>
  456. <thead>
  457. <tr class="row-odd"><th class="head"><p>Attribute</p></th>
  458. <th class="head"><p>Description</p></th>
  459. </tr>
  460. </thead>
  461. <tbody>
  462. <tr class="row-even"><td><p>id</p></td>
  463. <td><p>TestCase Sequence Log UUID as a bianry string.</p></td>
  464. </tr>
  465. <tr class="row-odd"><td><p>testrun</p></td>
  466. <td><p>The associated Testrun (as a <code class="docutils literal notranslate"><span class="pre">TestrunLog</span></code> instance).</p></td>
  467. </tr>
  468. <tr class="row-even"><td><p>testcases</p></td>
  469. <td><p>List of the test cases (as <code class="docutils literal notranslate"><span class="pre">TestCaseLog</span></code> instances) within the associated Test Case Sequence.</p></td>
  470. </tr>
  471. <tr class="row-odd"><td><p>__str__()</p></td>
  472. <td><p>Method. Returns TestCase Sequence Log UUID as a string.</p></td>
  473. </tr>
  474. <tr class="row-even"><td><p>to_json()</p></td>
  475. <td><p>Method. Returns TestCase Sequence Log as a dictionary object.</p></td>
  476. </tr>
  477. </tbody>
  478. </table>
  479. </div>
  480. <div class="section" id="testcaselog">
  481. <h3>TestCaseLog<a class="headerlink" href="#testcaselog" title="Permalink to this headline">¶</a></h3>
  482. <p>Provides interface with database table <code class="docutils literal notranslate"><span class="pre">testCases</span></code></p>
  483. <table class="colwidths-given docutils align-default" id="id9">
  484. <caption><span class="caption-text">baangt.base.DataBaseORM.TestCaseLog</span><a class="headerlink" href="#id9" title="Permalink to this table">¶</a></caption>
  485. <colgroup>
  486. <col style="width: 30%" />
  487. <col style="width: 70%" />
  488. </colgroup>
  489. <thead>
  490. <tr class="row-odd"><th class="head"><p>Attribute</p></th>
  491. <th class="head"><p>Description</p></th>
  492. </tr>
  493. </thead>
  494. <tbody>
  495. <tr class="row-even"><td><p>id</p></td>
  496. <td><p>TestCase Log UUID as a bianry string.</p></td>
  497. </tr>
  498. <tr class="row-odd"><td><p>testcase_sequence</p></td>
  499. <td><p>The associated Test Case Sequence (as a <code class="docutils literal notranslate"><span class="pre">TestCaseSequenceLog</span></code> instance).</p></td>
  500. </tr>
  501. <tr class="row-even"><td><p>fields</p></td>
  502. <td><p>List of the attributes (as <code class="docutils literal notranslate"><span class="pre">TestCaseField</span></code> instances) of the associated Test Case.</p></td>
  503. </tr>
  504. <tr class="row-odd"><td><p>networkInfo</p></td>
  505. <td><p>List of the network requests (as <code class="docutils literal notranslate"><span class="pre">TestCaseNetworkInfo</span></code> instances) made while executing the associated Test Case.</p></td>
  506. </tr>
  507. <tr class="row-even"><td><p>__str__()</p></td>
  508. <td><p>Method. Returns TestCase Log UUID as a string.</p></td>
  509. </tr>
  510. <tr class="row-odd"><td><p>to_json()</p></td>
  511. <td><p>Method. Returns TestCase Log as a dictionary object.</p></td>
  512. </tr>
  513. </tbody>
  514. </table>
  515. </div>
  516. <div class="section" id="globalattribute">
  517. <h3>GlobalAttribute<a class="headerlink" href="#globalattribute" title="Permalink to this headline">¶</a></h3>
  518. <p>Provides interface with table <code class="docutils literal notranslate"><span class="pre">globals</span></code></p>
  519. <table class="colwidths-given docutils align-default" id="id10">
  520. <caption><span class="caption-text">baangt.base.DataBaseORM.GlobalAttribute</span><a class="headerlink" href="#id10" title="Permalink to this table">¶</a></caption>
  521. <colgroup>
  522. <col style="width: 30%" />
  523. <col style="width: 70%" />
  524. </colgroup>
  525. <thead>
  526. <tr class="row-odd"><th class="head"><p>Attribute</p></th>
  527. <th class="head"><p>Description</p></th>
  528. </tr>
  529. </thead>
  530. <tbody>
  531. <tr class="row-even"><td><p>name</p></td>
  532. <td><p>Name of the global attribute.</p></td>
  533. </tr>
  534. <tr class="row-odd"><td><p>value</p></td>
  535. <td><p>Value of the global attribute as a string.</p></td>
  536. </tr>
  537. <tr class="row-even"><td><p>testrun</p></td>
  538. <td><p>The associated Testrun (as a <code class="docutils literal notranslate"><span class="pre">TestrunLog</span></code> instance).</p></td>
  539. </tr>
  540. </tbody>
  541. </table>
  542. </div>
  543. <div class="section" id="testcasefield">
  544. <h3>TestCaseField<a class="headerlink" href="#testcasefield" title="Permalink to this headline">¶</a></h3>
  545. <p>Provides interface with table <code class="docutils literal notranslate"><span class="pre">testCaseFields</span></code></p>
  546. <table class="colwidths-given docutils align-default" id="id11">
  547. <caption><span class="caption-text">baangt.base.DataBaseORM.TestCaseField</span><a class="headerlink" href="#id11" title="Permalink to this table">¶</a></caption>
  548. <colgroup>
  549. <col style="width: 30%" />
  550. <col style="width: 70%" />
  551. </colgroup>
  552. <thead>
  553. <tr class="row-odd"><th class="head"><p>Attribute</p></th>
  554. <th class="head"><p>Description</p></th>
  555. </tr>
  556. </thead>
  557. <tbody>
  558. <tr class="row-even"><td><p>name</p></td>
  559. <td><p>Name of the Test Case Field.</p></td>
  560. </tr>
  561. <tr class="row-odd"><td><p>value</p></td>
  562. <td><p>Value of the Test Case Field as a string.</p></td>
  563. </tr>
  564. <tr class="row-even"><td><p>testcase</p></td>
  565. <td><p>The associated test case (as a <code class="docutils literal notranslate"><span class="pre">TestCaseLog</span></code> instance).</p></td>
  566. </tr>
  567. </tbody>
  568. </table>
  569. </div>
  570. <div class="section" id="testcasenetworkinfo">
  571. <h3>TestCaseNetworkInfo<a class="headerlink" href="#testcasenetworkinfo" title="Permalink to this headline">¶</a></h3>
  572. <p>Provides interface with table <code class="docutils literal notranslate"><span class="pre">networkInfo</span></code></p>
  573. <table class="colwidths-given docutils align-default" id="id12">
  574. <caption><span class="caption-text">baangt.base.DataBaseORM.TestCaseField</span><a class="headerlink" href="#id12" title="Permalink to this table">¶</a></caption>
  575. <colgroup>
  576. <col style="width: 30%" />
  577. <col style="width: 70%" />
  578. </colgroup>
  579. <thead>
  580. <tr class="row-odd"><th class="head"><p>Attribute</p></th>
  581. <th class="head"><p>Description</p></th>
  582. </tr>
  583. </thead>
  584. <tbody>
  585. <tr class="row-even"><td><p>browserName</p></td>
  586. <td><p>Browser name that mede the request.</p></td>
  587. </tr>
  588. <tr class="row-odd"><td><p>status</p></td>
  589. <td><p>Status code of the request as an integer.</p></td>
  590. </tr>
  591. <tr class="row-even"><td><p>method</p></td>
  592. <td><p>The request method used.</p></td>
  593. </tr>
  594. <tr class="row-odd"><td><p>url</p></td>
  595. <td><p>The request URL.</p></td>
  596. </tr>
  597. <tr class="row-even"><td><p>contentType</p></td>
  598. <td><p>Type of the response content as a string.</p></td>
  599. </tr>
  600. <tr class="row-odd"><td><p>contentSize</p></td>
  601. <td><p>Size of the response content as an integer.</p></td>
  602. </tr>
  603. <tr class="row-even"><td><p>headers</p></td>
  604. <td><p>A lList of the response headers as a string.</p></td>
  605. </tr>
  606. <tr class="row-odd"><td><p>params</p></td>
  607. <td><p>A list of the request GET parameters as a string.</p></td>
  608. </tr>
  609. <tr class="row-even"><td><p>response</p></td>
  610. <td><p>The response content as a string.</p></td>
  611. </tr>
  612. <tr class="row-odd"><td><p>startDateTime</p></td>
  613. <td><p>The request start time as a <code class="docutils literal notranslate"><span class="pre">datetime.datetime</span></code> object.</p></td>
  614. </tr>
  615. <tr class="row-even"><td><p>duration</p></td>
  616. <td><p>The duration of the request in <code class="docutils literal notranslate"><span class="pre">ms</span></code>.</p></td>
  617. </tr>
  618. <tr class="row-odd"><td><p>testcase</p></td>
  619. <td><p>The associated test case (as a <code class="docutils literal notranslate"><span class="pre">TestCaseLog</span></code> instance).</p></td>
  620. </tr>
  621. <tr class="row-even"><td><p>to_json()</p></td>
  622. <td><p>Method. Returns the network info as a dictionary object.</p></td>
  623. </tr>
  624. </tbody>
  625. </table>
  626. </div>
  627. </div>
  628. </div>
  629. </div>
  630. </div>
  631. <footer>
  632. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  633. <a href="HistoryAndReasons.html" class="btn btn-neutral float-right" title="Why baangt and why is it open source?" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
  634. <a href="DataFile.html" class="btn btn-neutral float-left" title="Special functions in datafiles" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
  635. </div>
  636. <hr/>
  637. <div role="contentinfo">
  638. <p>
  639. &copy; Copyright 2020, Bernhard Buhl
  640. </p>
  641. </div>
  642. 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>.
  643. </footer>
  644. </div>
  645. </div>
  646. </section>
  647. </div>
  648. <script type="text/javascript">
  649. jQuery(function () {
  650. SphinxRtdTheme.Navigation.enable(true);
  651. });
  652. </script>
  653. </body>
  654. </html>