123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926 |
- <!DOCTYPE html>
- <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
- <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
- <head>
- <meta charset="utf-8">
-
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
-
- <title>baangt.base package — baangt 2020.1.1.b11 documentation</title>
-
-
-
-
-
-
- <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
-
-
- <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
- <script type="text/javascript" src="../_static/jquery.js"></script>
- <script type="text/javascript" src="../_static/underscore.js"></script>
- <script type="text/javascript" src="../_static/doctools.js"></script>
- <script type="text/javascript" src="../_static/language_data.js"></script>
-
- <script type="text/javascript" src="../_static/js/theme.js"></script>
-
-
- <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
- <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
- <link rel="index" title="Index" href="../genindex.html" />
- <link rel="search" title="Search" href="../search.html" />
- </head>
- <body class="wy-body-for-nav">
-
- <div class="wy-grid-for-nav">
-
- <nav data-toggle="wy-nav-shift" class="wy-nav-side">
- <div class="wy-side-scroll">
- <div class="wy-side-nav-search" >
-
-
- <a href="../index.html" class="icon icon-home"> baangt
-
-
- </a>
-
-
-
-
-
- <div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
- <input type="text" name="q" placeholder="Search docs" />
- <input type="hidden" name="check_keywords" value="yes" />
- <input type="hidden" name="area" value="default" />
- </form>
- </div>
-
- </div>
- <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
-
-
-
-
-
-
- <p class="caption"><span class="caption-text">Contents:</span></p>
- <ul>
- <li class="toctree-l1"><a class="reference internal" href="../Installation.html">Installation</a></li>
- <li class="toctree-l1"><a class="reference internal" href="../OverviewUsage.html">What is <code class="docutils literal notranslate"><span class="pre">baangt</span></code></a></li>
- <li class="toctree-l1"><a class="reference internal" href="../simpleExample.html">Jump-start into worry free production deployments</a></li>
- <li class="toctree-l1"><a class="reference internal" href="../Structure.html">Structure of baangt</a></li>
- <li class="toctree-l1"><a class="reference internal" href="../ParametersConfigFile.html">Parameters in Configuration files (<code class="docutils literal notranslate"><span class="pre">globals</span></code>)</a></li>
- <li class="toctree-l1"><a class="reference internal" href="../TestTypes.html">Types of tests</a></li>
- <li class="toctree-l1"><a class="reference internal" href="../Developer.html">Developer guidelines for custom enhancements</a></li>
- <li class="toctree-l1"><a class="reference internal" href="../HistoryAndReasons.html">Why <code class="docutils literal notranslate"><span class="pre">baangt</span></code> and why is it open source?</a></li>
- <li class="toctree-l1"><a class="reference internal" href="../contributors.html">Contributions</a></li>
- </ul>
-
-
- </div>
- </div>
- </nav>
- <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
-
- <nav class="wy-nav-top" aria-label="top navigation">
-
- <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
- <a href="../index.html">baangt</a>
-
- </nav>
- <div class="wy-nav-content">
-
- <div class="rst-content">
-
-
- <div role="navigation" aria-label="breadcrumbs navigation">
- <ul class="wy-breadcrumbs">
-
- <li><a href="../index.html">Docs</a> »</li>
-
- <li>baangt.base package</li>
-
-
- <li class="wy-breadcrumbs-aside">
-
-
- <a href="../_sources/docs/baangt.base.rst.txt" rel="nofollow"> View page source</a>
-
-
- </li>
-
- </ul>
-
- <hr/>
- </div>
- <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
- <div itemprop="articleBody">
-
- <div class="section" id="baangt-base-package">
- <h1>baangt.base package<a class="headerlink" href="#baangt-base-package" title="Permalink to this headline">¶</a></h1>
- <div class="section" id="submodules">
- <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
- </div>
- <div class="section" id="module-baangt.base.ApiHandling">
- <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>
- <dl class="class">
- <dt id="baangt.base.ApiHandling.ApiHandling">
- <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>
- <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
- <dl class="method">
- <dt id="baangt.base.ApiHandling.ApiHandling.getNewSession">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.ApiHandling.ApiHandling.getSession">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.ApiHandling.ApiHandling.getURL">
- <code class="sig-name descname">getURL</code><span class="sig-paren">(</span><em class="sig-param">url</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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.ApiHandling.ApiHandling.postURL">
- <code class="sig-name descname">postURL</code><span class="sig-paren">(</span><em class="sig-param">url</em>, <em class="sig-param">content</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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.ApiHandling.ApiHandling.returnTestCaseStatus">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.ApiHandling.ApiHandling.setHeaders">
- <code class="sig-name descname">setHeaders</code><span class="sig-paren">(</span><em class="sig-param">sessionNumber</em>, <em class="sig-param">setHeaderData</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.ApiHandling.ApiHandling.setHeaders" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.ApiHandling.ApiHandling.setLoginData">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.ApiHandling.ApiHandling.tearDown">
- <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>
- <dd></dd></dl>
- </dd></dl>
- </div>
- <div class="section" id="module-baangt.base.BrowserHandling">
- <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>
- <dl class="class">
- <dt id="baangt.base.BrowserHandling.BrowserDriver">
- <em class="property">class </em><code class="sig-prename descclassname">baangt.base.BrowserHandling.</code><code class="sig-name descname">BrowserDriver</code><span class="sig-paren">(</span><em class="sig-param">timing=None</em>, <em class="sig-param">screenshotPath=None</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.BrowserHandling.BrowserDriver" title="Permalink to this definition">¶</a></dt>
- <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
- <p>The main class for baangt-Elements to interact with a browser.
- Main Methods:
- - createNewBrowser: Create one instance of a Browser
- - findBy*-Methods: e.g. findByAndClick
- - URL-Methods: To navigate to an URL
- - handleIframe and handleWindow: To navigate between Windows (=tabs) and Iframes
- - javaScript: to pass JS directly to the browser
- - takeScreenshot: yes, that.</p>
- <dl class="method">
- <dt id="baangt.base.BrowserHandling.BrowserDriver.closeBrowser">
- <code class="sig-name descname">closeBrowser</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.BrowserHandling.BrowserDriver.closeBrowser" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.BrowserHandling.BrowserDriver.createNewBrowser">
- <code class="sig-name descname">createNewBrowser</code><span class="sig-paren">(</span><em class="sig-param">browserName='FF'</em>, <em class="sig-param">desiredCapabilities=None</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.BrowserHandling.BrowserDriver.createNewBrowser" title="Permalink to this definition">¶</a></dt>
- <dd><p>Will find the specified executables of the desired browser and start it with the given capabilities.</p>
- <p>@param browserName: one of GC_BROWSER_*-Browsernames, e.g. GC_BROWSER_FIREFOX
- @param desiredCapabilities: DICT of desiredCapabilities for this browser
- @param kwargs: Currently (Jan2020) not used</p>
- </dd></dl>
- <dl class="method">
- <dt id="baangt.base.BrowserHandling.BrowserDriver.findBy">
- <code class="sig-name descname">findBy</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">css=None</em>, <em class="sig-param">xpath=None</em>, <em class="sig-param">class_name=None</em>, <em class="sig-param">iframe=None</em>, <em class="sig-param">timeout=60</em>, <em class="sig-param">loggingOn=True</em>, <em class="sig-param">optional=False</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.BrowserHandling.BrowserDriver.findBy" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.BrowserHandling.BrowserDriver.findByAndClick">
- <code class="sig-name descname">findByAndClick</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">css=None</em>, <em class="sig-param">xpath=None</em>, <em class="sig-param">class_name=None</em>, <em class="sig-param">iframe=None</em>, <em class="sig-param">timeout=20</em>, <em class="sig-param">optional=False</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.BrowserHandling.BrowserDriver.findByAndClick" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.BrowserHandling.BrowserDriver.findByAndClickIf">
- <code class="sig-name descname">findByAndClickIf</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">css=None</em>, <em class="sig-param">xpath=None</em>, <em class="sig-param">class_name=None</em>, <em class="sig-param">iframe=None</em>, <em class="sig-param">timeout=60</em>, <em class="sig-param">value=None</em>, <em class="sig-param">optional=False</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.BrowserHandling.BrowserDriver.findByAndClickIf" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.BrowserHandling.BrowserDriver.findByAndForceText">
- <code class="sig-name descname">findByAndForceText</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">css=None</em>, <em class="sig-param">xpath=None</em>, <em class="sig-param">class_name=None</em>, <em class="sig-param">value=None</em>, <em class="sig-param">iframe=None</em>, <em class="sig-param">timeout=60</em>, <em class="sig-param">optional=False</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.BrowserHandling.BrowserDriver.findByAndForceText" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.BrowserHandling.BrowserDriver.findByAndSetText">
- <code class="sig-name descname">findByAndSetText</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">css=None</em>, <em class="sig-param">xpath=None</em>, <em class="sig-param">class_name=None</em>, <em class="sig-param">value=None</em>, <em class="sig-param">iframe=None</em>, <em class="sig-param">timeout=60</em>, <em class="sig-param">optional=False</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.BrowserHandling.BrowserDriver.findByAndSetText" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.BrowserHandling.BrowserDriver.findByAndSetTextIf">
- <code class="sig-name descname">findByAndSetTextIf</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">css=None</em>, <em class="sig-param">xpath=None</em>, <em class="sig-param">class_name=None</em>, <em class="sig-param">value=None</em>, <em class="sig-param">iframe=None</em>, <em class="sig-param">timeout=60</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.BrowserHandling.BrowserDriver.findByAndSetTextIf" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.BrowserHandling.BrowserDriver.findByAndSetTextValidated">
- <code class="sig-name descname">findByAndSetTextValidated</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">css=None</em>, <em class="sig-param">xpath=None</em>, <em class="sig-param">class_name=None</em>, <em class="sig-param">value=None</em>, <em class="sig-param">iframe=None</em>, <em class="sig-param">timeout=60</em>, <em class="sig-param">retries=5</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.BrowserHandling.BrowserDriver.findByAndSetTextValidated" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.BrowserHandling.BrowserDriver.findByAndWaitForValue">
- <code class="sig-name descname">findByAndWaitForValue</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">css=None</em>, <em class="sig-param">xpath=None</em>, <em class="sig-param">class_name=None</em>, <em class="sig-param">iframe=None</em>, <em class="sig-param">timeout=20</em>, <em class="sig-param">optional=False</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.BrowserHandling.BrowserDriver.findByAndWaitForValue" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.BrowserHandling.BrowserDriver.findWaitNotVisible">
- <code class="sig-name descname">findWaitNotVisible</code><span class="sig-paren">(</span><em class="sig-param">xpath=None</em>, <em class="sig-param">id=None</em>, <em class="sig-param">timeout=90</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.BrowserHandling.BrowserDriver.findWaitNotVisible" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.BrowserHandling.BrowserDriver.getURL">
- <code class="sig-name descname">getURL</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.BrowserHandling.BrowserDriver.getURL" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.BrowserHandling.BrowserDriver.goBack">
- <code class="sig-name descname">goBack</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.BrowserHandling.BrowserDriver.goBack" title="Permalink to this definition">¶</a></dt>
- <dd><p>Method to go 1 step back in current tab’s browse history
- @return:</p>
- </dd></dl>
- <dl class="method">
- <dt id="baangt.base.BrowserHandling.BrowserDriver.goToUrl">
- <code class="sig-name descname">goToUrl</code><span class="sig-paren">(</span><em class="sig-param">url</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.BrowserHandling.BrowserDriver.goToUrl" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.BrowserHandling.BrowserDriver.handleIframe">
- <code class="sig-name descname">handleIframe</code><span class="sig-paren">(</span><em class="sig-param">iframe=None</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.BrowserHandling.BrowserDriver.handleIframe" title="Permalink to this definition">¶</a></dt>
- <dd><p>Give an IFRAME and it will try to go into.
- If you’re inside an iframe it will go out of the iframe</p>
- </dd></dl>
- <dl class="method">
- <dt id="baangt.base.BrowserHandling.BrowserDriver.handleWindow">
- <code class="sig-name descname">handleWindow</code><span class="sig-paren">(</span><em class="sig-param">windowNumber=None</em>, <em class="sig-param">function=None</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.BrowserHandling.BrowserDriver.handleWindow" title="Permalink to this definition">¶</a></dt>
- <dd><p>Interations with Windows (=BrowserTabs).</p>
- <p>@param windowNumber: Number of the windowHandle inside this browser session (0 = startwindow(=Tab), 1=Next window
- @param function: “CLOSE”, “CLOSEALL”</p>
- </dd></dl>
- <dl class="method">
- <dt id="baangt.base.BrowserHandling.BrowserDriver.javaScript">
- <code class="sig-name descname">javaScript</code><span class="sig-paren">(</span><em class="sig-param">jsText</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.BrowserHandling.BrowserDriver.javaScript" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.BrowserHandling.BrowserDriver.sleep">
- <em class="property">static </em><code class="sig-name descname">sleep</code><span class="sig-paren">(</span><em class="sig-param">sleepTimeinSeconds</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.BrowserHandling.BrowserDriver.sleep" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.BrowserHandling.BrowserDriver.slowExecutionToggle">
- <code class="sig-name descname">slowExecutionToggle</code><span class="sig-paren">(</span><em class="sig-param">newSlowExecutionWaitTimeInSeconds=None</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.BrowserHandling.BrowserDriver.slowExecutionToggle" title="Permalink to this definition">¶</a></dt>
- <dd><p>SlowExecution can be set in globals or by the teststep. It’s intended use is debugging or showcasing a testcases
- functionality.</p>
- <p>@param newSlowExecutionWaitTimeInSeconds: Optional. If set, it will change the default value of WaitTime, when SlowExecution is active
- @return: Returns the state of sloeExecution toggle after toggling was done.</p>
- </dd></dl>
- <dl class="method">
- <dt id="baangt.base.BrowserHandling.BrowserDriver.submit">
- <code class="sig-name descname">submit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.BrowserHandling.BrowserDriver.submit" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.BrowserHandling.BrowserDriver.takeScreenshot">
- <code class="sig-name descname">takeScreenshot</code><span class="sig-paren">(</span><em class="sig-param">screenShotPath=None</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.BrowserHandling.BrowserDriver.takeScreenshot" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- </dd></dl>
- </div>
- <div class="section" id="module-baangt.base.CliAndInteractive">
- <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>
- <dl class="function">
- <dt id="baangt.base.CliAndInteractive.args_read">
- <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>
- <dd></dd></dl>
- <dl class="function">
- <dt id="baangt.base.CliAndInteractive.callTestrun">
- <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>
- <dd></dd></dl>
- <dl class="function">
- <dt id="baangt.base.CliAndInteractive.getGlobalSettings">
- <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>
- <dd></dd></dl>
- <dl class="function">
- <dt id="baangt.base.CliAndInteractive.print_args">
- <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>
- <dd></dd></dl>
- <dl class="function">
- <dt id="baangt.base.CliAndInteractive.run">
- <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>
- <dd></dd></dl>
- </div>
- <div class="section" id="module-baangt.base.CustGlobalConstants">
- <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>
- </div>
- <div class="section" id="module-baangt.base.ExportResults">
- <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>
- <dl class="class">
- <dt id="baangt.base.ExportResults.ExcelSheetHelperFunctions">
- <em class="property">class </em><code class="sig-prename descclassname">baangt.base.ExportResults.</code><code class="sig-name descname">ExcelSheetHelperFunctions</code><a class="headerlink" href="#baangt.base.ExportResults.ExcelSheetHelperFunctions" title="Permalink to this definition">¶</a></dt>
- <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
- <dl class="method">
- <dt id="baangt.base.ExportResults.ExcelSheetHelperFunctions.get_column_width">
- <em class="property">static </em><code class="sig-name descname">get_column_width</code><span class="sig-paren">(</span><em class="sig-param">worksheet: xlsxwriter.worksheet.Worksheet</em>, <em class="sig-param">column: int</em><span class="sig-paren">)</span> → Optional[int]<a class="headerlink" href="#baangt.base.ExportResults.ExcelSheetHelperFunctions.get_column_width" title="Permalink to this definition">¶</a></dt>
- <dd><p>Get the max column width in a <cite>Worksheet</cite> column.</p>
- </dd></dl>
- <dl class="method">
- <dt id="baangt.base.ExportResults.ExcelSheetHelperFunctions.set_column_autowidth">
- <em class="property">static </em><code class="sig-name descname">set_column_autowidth</code><span class="sig-paren">(</span><em class="sig-param">worksheet: xlsxwriter.worksheet.Worksheet</em>, <em class="sig-param">column: int</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.ExportResults.ExcelSheetHelperFunctions.set_column_autowidth" title="Permalink to this definition">¶</a></dt>
- <dd><p>Set the width automatically on a column in the <cite>Worksheet</cite>.
- !!! Make sure you run this function AFTER having all cells filled in
- the worksheet!</p>
- </dd></dl>
- </dd></dl>
- <dl class="class">
- <dt id="baangt.base.ExportResults.ExportResults">
- <em class="property">class </em><code class="sig-prename descclassname">baangt.base.ExportResults.</code><code class="sig-name descname">ExportResults</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.ExportResults.ExportResults" title="Permalink to this definition">¶</a></dt>
- <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
- <dl class="method">
- <dt id="baangt.base.ExportResults.ExportResults.closeExcel">
- <code class="sig-name descname">closeExcel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.ExportResults.ExportResults.closeExcel" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.ExportResults.ExportResults.exportResult">
- <code class="sig-name descname">exportResult</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.ExportResults.ExportResults.exportResult" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.ExportResults.ExportResults.exportToDataBase">
- <code class="sig-name descname">exportToDataBase</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.ExportResults.ExportResults.exportToDataBase" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.ExportResults.ExportResults.makeSummary">
- <code class="sig-name descname">makeSummary</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.ExportResults.ExportResults.makeSummary" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- </dd></dl>
- <dl class="class">
- <dt id="baangt.base.ExportResults.ExportTiming">
- <em class="property">class </em><code class="sig-prename descclassname">baangt.base.ExportResults.</code><code class="sig-name descname">ExportTiming</code><span class="sig-paren">(</span><em class="sig-param">testdataRecords: dict</em>, <em class="sig-param">sheet: <module 'xlsxwriter.worksheet' from '/Users/bernhardbuhl/.conda/envs/pyFETest/lib/python3.7/site-packages/xlsxwriter/worksheet.py'></em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.ExportResults.ExportTiming" title="Permalink to this definition">¶</a></dt>
- <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
- <dl class="method">
- <dt id="baangt.base.ExportResults.ExportTiming.findAllTimingSections">
- <code class="sig-name descname">findAllTimingSections</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.ExportResults.ExportTiming.findAllTimingSections" title="Permalink to this definition">¶</a></dt>
- <dd><p>We try to have an ordered list of Timing Sequences. As each Testcase might have different sections we’ll have
- to make guesses</p>
- <p>@return:</p>
- </dd></dl>
- <dl class="method">
- <dt id="baangt.base.ExportResults.ExportTiming.interpretTimeLog">
- <em class="property">static </em><code class="sig-name descname">interpretTimeLog</code><span class="sig-paren">(</span><em class="sig-param">lTimeLog</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.ExportResults.ExportTiming.interpretTimeLog" title="Permalink to this definition">¶</a></dt>
- <dd><p>Example Time Log:
- Complete Testrun: Start: 1579553837.241974 - no end recorded
- TestCaseSequenceMaster: Start: 1579553837.243414 - no end recorded
- CustTestCaseMaster: Start: 1579553838.97329 - no end recorded
- Browser Start: , since last call: 2.3161418437957764
- Empfehlungen: , since last call: 6.440968036651611, ZIDs:[175aeac023237a73], TS:2020-01-20 21:57:46.525577
- Annahme_RABAZ: , since last call: 2.002716064453125e-05, ZIDs:[6be7d0a44e59acf6], TS:2020-01-20 21:58:37.203583
- Antrag drucken: , since last call: 9.075241088867188, ZIDs:[6be7d0a44e59acf6, b27c3875ddcbb4fa], TS:2020-01-20 21:58:38.040137
- Warten auf Senden an Bestand Button: , since last call: 1.3927149772644043
- Senden an Bestand: , since last call: 9.60469913482666, ZIDs:[66b12fa4869cf8a0, ad1f3d47c4694e26], TS:2020-01-20 21:58:49.472288</p>
- <p>where the first part before “:” is the section, “since last call:” is the duration, TS: is the timestamp</p>
- </dd></dl>
- <dl class="method">
- <dt id="baangt.base.ExportResults.ExportTiming.shortenTimingValue">
- <em class="property">static </em><code class="sig-name descname">shortenTimingValue</code><span class="sig-paren">(</span><em class="sig-param">timingValue</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.ExportResults.ExportTiming.shortenTimingValue" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.ExportResults.ExportTiming.wc">
- <code class="sig-name descname">wc</code><span class="sig-paren">(</span><em class="sig-param">row</em>, <em class="sig-param">col</em>, <em class="sig-param">content</em>, <em class="sig-param">format=None</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.ExportResults.ExportTiming.wc" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.ExportResults.ExportTiming.writeCell">
- <code class="sig-name descname">writeCell</code><span class="sig-paren">(</span><em class="sig-param">row</em>, <em class="sig-param">col</em>, <em class="sig-param">content</em>, <em class="sig-param">format=None</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.ExportResults.ExportTiming.writeCell" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.ExportResults.ExportTiming.writeHeader">
- <code class="sig-name descname">writeHeader</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.ExportResults.ExportTiming.writeHeader" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.ExportResults.ExportTiming.writeLines">
- <code class="sig-name descname">writeLines</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.ExportResults.ExportTiming.writeLines" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- </dd></dl>
- </div>
- <div class="section" id="module-baangt.base.GlobalConstants">
- <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>
- </div>
- <div class="section" id="module-baangt.base.HandleDatabase">
- <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>
- <dl class="class">
- <dt id="baangt.base.HandleDatabase.HandleDatabase">
- <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>
- <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
- <dl class="method">
- <dt id="baangt.base.HandleDatabase.HandleDatabase.readNextRecord">
- <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>
- <dd><p>We built self.range during init. Now we need to iterate over the range(s) in range,
- find appropriate record and return that - one at a time</p>
- <p>@return:</p>
- </dd></dl>
- <dl class="method">
- <dt id="baangt.base.HandleDatabase.HandleDatabase.readTestRecord">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.HandleDatabase.HandleDatabase.read_excel">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.HandleDatabase.HandleDatabase.updateGlobals">
- <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>
- <dd></dd></dl>
- </dd></dl>
- </div>
- <div class="section" id="module-baangt.base.IBAN">
- <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>
- <dl class="class">
- <dt id="baangt.base.IBAN.IBAN">
- <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>
- <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
- <dl class="method">
- <dt id="baangt.base.IBAN.IBAN.getRandomIBAN">
- <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>
- <dd><p>Generates a random IBAN based on bankLand and bankLeitzahl as well as a random account number</p>
- <p>@return: gives a String of IBAN</p>
- </dd></dl>
- </dd></dl>
- </div>
- <div class="section" id="module-baangt.base.TestRun">
- <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>
- <dl class="class">
- <dt id="baangt.base.TestRun.TestRun">
- <em class="property">class </em><code class="sig-prename descclassname">baangt.base.TestRun.</code><code class="sig-name descname">TestRun</code><span class="sig-paren">(</span><em class="sig-param">testRunName</em>, <em class="sig-param">globalSettingsFileNameAndPath=None</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRun.TestRun" title="Permalink to this definition">¶</a></dt>
- <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
- <p>This is the main Class of Testexecution in the baangt Framework. It is usually started
- from baangt.py</p>
- <dl class="method">
- <dt id="baangt.base.TestRun.TestRun.executeDictSequenceOfClasses">
- <code class="sig-name descname">executeDictSequenceOfClasses</code><span class="sig-paren">(</span><em class="sig-param">dictSequenceOfClasses</em>, <em class="sig-param">counterName</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRun.TestRun.executeDictSequenceOfClasses" title="Permalink to this definition">¶</a></dt>
- <dd><p>This is the main loop of the TestCaseSequence, TestCases, TestStepSequences and TestSteps.
- The Sequence of which class instance to create is defined by the TestRunAttributes.</p>
- <p>Before instancing the class it is checked, whether the class was loaded already and if not, will be loaded
- (only if the classname is fully qualified (e.g baangt<projectname>.TestSteps.myTestStep).
- If the testcase-Status is already “error” (GC.TESTCASESTATUS_ERROR) we’ll stop the loop.</p>
- <p>@param dictSequenceOfClasses: The list of classes to be instanced. Must be a dict of {Enum, Classname},
- can be also {enum: [classname, <whatEverElse>]}
- @param counterName: Which Structure element we’re currently looping, e.g. “TestStep” (GC.STRUCTURE_TESTSTEP)
- @param kwargs: TestrunAttributes, this TestRun, the Timings-Instance, the datarecord</p>
- </dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRun.TestRun.executeTestRun">
- <code class="sig-name descname">executeTestRun</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRun.TestRun.executeTestRun" title="Permalink to this definition">¶</a></dt>
- <dd><p>Start TestcaseSequence</p>
- <p>TestCaseSequence is a sequence of Testcases. In the TestcaseSequence there’s a sequential List of
- Testcases to be executed.</p>
- <p>Before the loop (executeDictSequenceOfClasses) variables inside the the testrun-definition are replaced
- by values from the globals-file (e.g. if you want to generally run with FF, but in a certain case you want to
- run with Chrome, you’d have FF in the Testrundefinition, but set parameter in globals_chrome.json accordingly
- (in this case {“TC.Browser”: “CHROME”}. TC.-Prefix signals the logic to look for this variable (“Browser”)
- inside the testcase definitions and replace it with value “CHROME”.</p>
- </dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRun.TestRun.getAPI">
- <code class="sig-name descname">getAPI</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRun.TestRun.getAPI" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRun.TestRun.getAllTestRunAttributes">
- <code class="sig-name descname">getAllTestRunAttributes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRun.TestRun.getAllTestRunAttributes" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRun.TestRun.getBrowser">
- <code class="sig-name descname">getBrowser</code><span class="sig-paren">(</span><em class="sig-param">browserInstance=1</em>, <em class="sig-param">browserName=None</em>, <em class="sig-param">browserAttributes=None</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRun.TestRun.getBrowser" title="Permalink to this definition">¶</a></dt>
- <dd><p>This method is called whenever a browser instance (existing or new) is needed. If called without
- parameters it will create one instance of Firefox (geckodriver).</p>
- <p>if global setting TC.EXECUTION_SLOW is set, inform the browser instance about it.</p>
- <p>@param browserInstance: Number of the requested browser instance. If none is provided, always the default
- browser instance will be returned
- @param browserName: one of the browser names (e.g. FF, Chrome) from GC.BROWSER*
- @param browserAttributes: optional Browser Attributes
- @return: the browser instance of base class BrowserDriver</p>
- </dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRun.TestRun.getSuccessAndError">
- <code class="sig-name descname">getSuccessAndError</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRun.TestRun.getSuccessAndError" title="Permalink to this definition">¶</a></dt>
- <dd><p>Returns number of successful and number of error test cases of the current test run
- @rtype: object</p>
- </dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRun.TestRun.loadJSONGlobals">
- <code class="sig-name descname">loadJSONGlobals</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRun.TestRun.loadJSONGlobals" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRun.TestRun.setResult">
- <code class="sig-name descname">setResult</code><span class="sig-paren">(</span><em class="sig-param">recordNumber</em>, <em class="sig-param">dataRecordResult</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRun.TestRun.setResult" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRun.TestRun.tearDown">
- <code class="sig-name descname">tearDown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRun.TestRun.tearDown" title="Permalink to this definition">¶</a></dt>
- <dd><p>Close browser (unless stated in the Globals to not do so) and API-Instances
- Take overall Time spent for the complete TestRun
- Write results of TestRun to output channel(s)</p>
- </dd></dl>
- </dd></dl>
- </div>
- <div class="section" id="module-baangt.base.TestRunDatabaseCreate">
- <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>
- <dl class="class">
- <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate">
- <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>
- <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
- <p>Initializes the Database and loads some sample data</p>
- <dl class="method">
- <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.commit">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createActivityTypes">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createExectionMethods">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createLocatorTypes">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createMasterClasses">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createStructures">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createTestCase">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createTestCase2TestData">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createTestCaseSequence">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createTestDataDefinition">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createTestRun">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createTestStep">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createTestStepSequence">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.createValidator">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseCreate.getCursor">
- <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>
- <dd></dd></dl>
- </dd></dl>
- <dl class="class">
- <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseFill">
- <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>
- <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
- <dl class="method">
- <dt id="baangt.base.TestRunDatabaseCreate.TestRunDatabaseFill.fill">
- <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>
- <dd></dd></dl>
- </dd></dl>
- </div>
- <div class="section" id="module-baangt.base.TestRunExcelImporter">
- <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>
- <dl class="class">
- <dt id="baangt.base.TestRunExcelImporter.TestRunExcelImporter">
- <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>
- <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
- <p>The TestrunSettings are in class TestRunUtils and expected to be a deep dict. For details see documentation there.</p>
- <p>This class will migrate data from an excel sheet (either simple format with only 1 tab or complex format with all
- structural elements) into the deep dict.</p>
- <p>In case the XLSX is simple format, all missing data is “predicted”/assumed.</p>
- <dl class="method">
- <dt id="baangt.base.TestRunExcelImporter.TestRunExcelImporter.getRowsWithHeadersAsDict">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRunExcelImporter.TestRunExcelImporter.importConfig">
- <code class="sig-name descname">importConfig</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.TestRunExcelImporter.TestRunExcelImporter.importConfig" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRunExcelImporter.TestRunExcelImporter.replaceFieldValueWithValueOfConstant">
- <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>
- <dd><p>baangt Global constants (baangt.base.GlobalConstants) are available everywhere as GC., e.g. the variable
- “BROWSER” defined in GlobalConstants can be accessed from everywhere within baangt by using “GC.BROWSER”.</p>
- <p>The variables can also be used in configuration files (would be very stupid if we need to change a constant and
- then 100s of Config-Files need adjustment - worst case the testruns behave unexepected). This applies both to
- XLSX and JSON Config files.</p>
- <p>The CGC.-Part is still needs fixing. It shouldn’t appear in Baangt base, but currently still needed.</p>
- <p>@param value: potentially convertable value (e.g. GC.BROWSER)
- @return: potentially converted value (e.g. “Browser”)</p>
- </dd></dl>
- </dd></dl>
- </div>
- <div class="section" id="module-baangt.base.TestRunUtils">
- <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>
- <dl class="class">
- <dt id="baangt.base.TestRunUtils.TestRunUtils">
- <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>
- <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
- <dl class="method">
- <dt id="baangt.base.TestRunUtils.TestRunUtils.getCompleteTestRunAttributes">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRunUtils.TestRunUtils.getSequenceByNumber">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRunUtils.TestRunUtils.getTestCaseByNumber">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRunUtils.TestRunUtils.getTestStepByNumber">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRunUtils.TestRunUtils.replaceGlobals">
- <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>
- <dd><p>Will go through all testcase-Settings and replace values with values from global settings, if matched</p>
- </dd></dl>
- <dl class="method">
- <dt id="baangt.base.TestRunUtils.TestRunUtils.setCompleteTestRunAttributes">
- <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>
- <dd></dd></dl>
- </dd></dl>
- </div>
- <div class="section" id="module-baangt.base.Timing">
- <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>
- <dl class="class">
- <dt id="baangt.base.Timing.Timing">
- <em class="property">class </em><code class="sig-prename descclassname">baangt.base.Timing.</code><code class="sig-name descname">Timing</code><a class="headerlink" href="#baangt.base.Timing.Timing" title="Permalink to this definition">¶</a></dt>
- <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
- <dl class="method">
- <dt id="baangt.base.Timing.Timing.addAttribute">
- <code class="sig-name descname">addAttribute</code><span class="sig-paren">(</span><em class="sig-param">attribute</em>, <em class="sig-param">value</em>, <em class="sig-param">timingSection=None</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.Timing.Timing.addAttribute" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.Timing.Timing.resetTime">
- <code class="sig-name descname">resetTime</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.Timing.Timing.resetTime" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.Timing.Timing.returnTime">
- <code class="sig-name descname">returnTime</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.Timing.Timing.returnTime" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.Timing.Timing.returnTimeSegment">
- <code class="sig-name descname">returnTimeSegment</code><span class="sig-paren">(</span><em class="sig-param">segment</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.Timing.Timing.returnTimeSegment" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.Timing.Timing.takeTime">
- <code class="sig-name descname">takeTime</code><span class="sig-paren">(</span><em class="sig-param">timingName</em>, <em class="sig-param">forceNew=False</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.Timing.Timing.takeTime" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.Timing.Timing.takeTimeSumOutput">
- <code class="sig-name descname">takeTimeSumOutput</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.base.Timing.Timing.takeTimeSumOutput" title="Permalink to this definition">¶</a></dt>
- <dd></dd></dl>
- </dd></dl>
- </div>
- <div class="section" id="module-baangt.base.utils">
- <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>
- <dl class="class">
- <dt id="baangt.base.utils.utils">
- <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>
- <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
- <dl class="method">
- <dt id="baangt.base.utils.utils.datetime_return">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.utils.utils.extractFileNameFromFullPath">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.utils.utils.findFileAndPathFromPath">
- <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>
- <dd><p>Tries different approaches to locate a file
- lBasePath = the Path where the script is run</p>
- <p>@param fileNameAndPath: Filename and potentially relative path
- @param basePath (optional): Optional basePath to look at
- @return:</p>
- </dd></dl>
- <dl class="method">
- <dt id="baangt.base.utils.utils.openJson">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.utils.utils.replaceAllGlobalConstantsInDict">
- <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>
- <dd></dd></dl>
- <dl class="method">
- <dt id="baangt.base.utils.utils.replaceFieldValueWithValueOfConstant">
- <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>
- <dd><p>If a String reference to global Constant (e.g. GC.BROWSER_FF) is
- given, this function will replace it with the actual value (e.g. FIREFOX)</p>
- </dd></dl>
- <dl class="method">
- <dt id="baangt.base.utils.utils.sanitizeFileName">
- <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>
- <dd></dd></dl>
- </dd></dl>
- </div>
- <div class="section" id="module-baangt.base">
- <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-baangt.base" title="Permalink to this headline">¶</a></h2>
- </div>
- </div>
- </div>
-
- </div>
- <footer>
-
- <hr/>
- <div role="contentinfo">
- <p>
- © Copyright 2020, Bernhard Buhl
- </p>
- </div>
- 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>.
- </footer>
- </div>
- </div>
- </section>
- </div>
-
- <script type="text/javascript">
- jQuery(function () {
- SphinxRtdTheme.Navigation.enable(true);
- });
- </script>
-
-
-
-
- </body>
- </html>
|