athos
/
baangt


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379
							

<!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.TestSteps package &mdash; baangt 1.1.1 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="stylesheet" href="../_static/theme_overrides.css" type="text/css" />
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="baangt.TestSteps.DropsApp package" href="baangt.TestSteps.DropsApp.html" />
    <link rel="prev" title="baangt.TestCaseSequence package" href="baangt.TestCaseSequence.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">   Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../simpleExample.html">   First Steps</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Structure.html">   Structure</a></li>
<li class="toctree-l1"><a class="reference internal" href="../ParametersConfigFile.html">   Parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../SimpleAPI.html">   First API Test</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="../DataFile.html">   Data file</a></li>
<li class="toctree-l1"><a class="reference internal" href="../SaveResults2Database.html">   Results in Database</a></li>
<li class="toctree-l1"><a class="reference internal" href="../HistoryAndReasons.html">   History</a></li>
<li class="toctree-l1"><a class="reference internal" href="../contributors.html">   Contributions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../changelog.html">   Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="../PlannedFeatures.html">   Planned Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../BrowserDrivers.html">   Browser Drivers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Variables.html">   Variables</a></li>
<li class="toctree-l1"><a class="reference internal" href="../SendStatistics.html">   Results</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Datagenerator.html">DataGenerator</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Datagenerator.html#input-file">Input File</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Datagenerator.html#data-type">Data Type</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Datagenerator.html#all-data-types-format">All Data Types Format</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Developer.html">   For Developers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../baangt-Plugin.html">What is a baangt-plugin</a></li>
<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>
<li class="toctree-l1"><a class="reference internal" href="../baangt-Plugin.html#how-the-baangt-plugin-work">how the baangt-plugin work</a></li>
<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>
<li class="toctree-l1"><a class="reference internal" href="../articles/Articles.html">   :subheader: Articles</a></li>
<li class="toctree-l1"><a class="reference external" href="http://www.baangt.org">   Web</a></li>
</ul>
<p class="caption"><span class="caption-text">Autodocs:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="baangt.base.html">Autodocs</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">Modules</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="baangt.html">baangt module</a></li>
<li class="toctree-l2"><a class="reference internal" href="baangt.html">baangt module</a></li>
<li class="toctree-l2"><a class="reference internal" href="baangtIA.html">baangtIA module</a></li>
<li class="toctree-l2"><a class="reference internal" href="setup.html">setup module</a></li>
<li class="toctree-l2"><a class="reference internal" href="baangt.base.html">baangt.base package</a></li>
<li class="toctree-l2"><a class="reference internal" href="baangt.TestCase.html">baangt.TestCase package</a></li>
<li class="toctree-l2"><a class="reference internal" href="baangt.TestCaseSequence.html">baangt.TestCaseSequence package</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">baangt.TestSteps package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#subpackages">Subpackages</a><ul>
<li class="toctree-l4"><a class="reference internal" href="baangt.TestSteps.DropsApp.html">baangt.TestSteps.DropsApp package</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-baangt.TestSteps.Exceptions">baangt.TestSteps.Exceptions module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-baangt.TestSteps.TestStepMaster">baangt.TestSteps.TestStepMaster module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-baangt.TestSteps">Module contents</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="baangt.katalonImporter.html">baangt.katalonImporter package</a></li>
<li class="toctree-l2"><a class="reference internal" href="baangt.ui.html">baangt.ui package</a></li>
</ul>
</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> &raquo;</li>
        
          <li><a href="modules.html">baangt</a> &raquo;</li>
        
      <li>baangt.TestSteps package</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="../_sources/docs/baangt.TestSteps.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-teststeps-package">
<h1>baangt.TestSteps package<a class="headerlink" href="#baangt-teststeps-package" title="Permalink to this headline">¶</a></h1>
<div class="section" id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="baangt.TestSteps.DropsApp.html">baangt.TestSteps.DropsApp package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="baangt.TestSteps.DropsApp.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="baangt.TestSteps.DropsApp.html#module-baangt.TestSteps.DropsApp.Login_API">baangt.TestSteps.DropsApp.Login_API module</a></li>
<li class="toctree-l2"><a class="reference internal" href="baangt.TestSteps.DropsApp.html#module-baangt.TestSteps.DropsApp">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</div>
<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.TestSteps.Exceptions">
<span id="baangt-teststeps-exceptions-module"></span><h2>baangt.TestSteps.Exceptions module<a class="headerlink" href="#module-baangt.TestSteps.Exceptions" title="Permalink to this headline">¶</a></h2>
<dl class="exception">
<dt id="baangt.TestSteps.Exceptions.baangtTestStepException">
<em class="property">exception </em><code class="sig-prename descclassname">baangt.TestSteps.Exceptions.</code><code class="sig-name descname">baangtTestStepException</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.TestSteps.Exceptions.baangtTestStepException" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
</dd></dl>

</div>
<div class="section" id="module-baangt.TestSteps.TestStepMaster">
<span id="baangt-teststeps-teststepmaster-module"></span><h2>baangt.TestSteps.TestStepMaster module<a class="headerlink" href="#module-baangt.TestSteps.TestStepMaster" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="baangt.TestSteps.TestStepMaster.TestStepMaster">
<em class="property">class </em><code class="sig-prename descclassname">baangt.TestSteps.TestStepMaster.</code><code class="sig-name descname">TestStepMaster</code><span class="sig-paren">(</span><em class="sig-param">executeDirect=True</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.TestSteps.TestStepMaster.TestStepMaster" 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.TestSteps.TestStepMaster.TestStepMaster.checkLinks">
<code class="sig-name descname">checkLinks</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.TestSteps.TestStepMaster.TestStepMaster.checkLinks" title="Permalink to this definition">¶</a></dt>
<dd><p>Will check all links on the current webpage</p>
<p>Result will be written into “CheckedLinks” in TestDataDict</p>
<p>If theres a returncode &gt;= 400 in the list, we’ll mark the testcase as failed</p>
</dd></dl>

<dl class="method">
<dt id="baangt.TestSteps.TestStepMaster.TestStepMaster.doPDFComparison">
<code class="sig-name descname">doPDFComparison</code><span class="sig-paren">(</span><em class="sig-param">lValue</em>, <em class="sig-param">lFieldnameForResults='DOC_Compare'</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.TestSteps.TestStepMaster.TestStepMaster.doPDFComparison" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="baangt.TestSteps.TestStepMaster.TestStepMaster.doSaveData">
<code class="sig-name descname">doSaveData</code><span class="sig-paren">(</span><em class="sig-param">toField</em>, <em class="sig-param">valueForField</em>, <em class="sig-param">lLocatorType</em>, <em class="sig-param">lLocator</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.TestSteps.TestStepMaster.TestStepMaster.doSaveData" title="Permalink to this definition">¶</a></dt>
<dd><p>Save fields. Either from an existing DICT (usually in API-Mode) or from a Webelement (in Browser-Mode)</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>toField</strong> – </p></li>
<li><p><strong>valueForField</strong> – </p></li>
<li><p><strong>lLocatorType</strong> – </p></li>
<li><p><strong>lLocator</strong> – </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>no return parameter. The implicit return is a value in a field.</p>
</dd>
</dl>
</dd></dl>

<dl class="method">
<dt id="baangt.TestSteps.TestStepMaster.TestStepMaster.execute">
<code class="sig-name descname">execute</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.TestSteps.TestStepMaster.TestStepMaster.execute" title="Permalink to this definition">¶</a></dt>
<dd><p>Method is overwritten in all children/subclasses</p>
</dd></dl>

<dl class="method">
<dt id="baangt.TestSteps.TestStepMaster.TestStepMaster.executeDirect">
<code class="sig-name descname">executeDirect</code><span class="sig-paren">(</span><em class="sig-param">executionCommands</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.TestSteps.TestStepMaster.TestStepMaster.executeDirect" title="Permalink to this definition">¶</a></dt>
<dd><p>Executes a sequence of Commands. Will be subclassed in other modules.
:param executionCommands:
:return:</p>
</dd></dl>

<dl class="method">
<dt id="baangt.TestSteps.TestStepMaster.TestStepMaster.executeDirectSingle">
<code class="sig-name descname">executeDirectSingle</code><span class="sig-paren">(</span><em class="sig-param">commandNumber</em>, <em class="sig-param">command</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.TestSteps.TestStepMaster.TestStepMaster.executeDirectSingle" title="Permalink to this definition">¶</a></dt>
<dd><p>This will execute a single instruction</p>
</dd></dl>

<dl class="method">
<dt id="baangt.TestSteps.TestStepMaster.TestStepMaster.ifQualifyForExecution">
<em class="property">static </em><code class="sig-name descname">ifQualifyForExecution</code><span class="sig-paren">(</span><em class="sig-param">version_global</em>, <em class="sig-param">version_line</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.TestSteps.TestStepMaster.TestStepMaster.ifQualifyForExecution" title="Permalink to this definition">¶</a></dt>
<dd><p>This function will test version_global and version_line
&#64;return True or False</p>
</dd></dl>

<dl class="method">
<dt id="baangt.TestSteps.TestStepMaster.TestStepMaster.replaceAllVariables">
<code class="sig-name descname">replaceAllVariables</code><span class="sig-paren">(</span><em class="sig-param">lValue</em>, <em class="sig-param">lValue2</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.TestSteps.TestStepMaster.TestStepMaster.replaceAllVariables" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="baangt.TestSteps.TestStepMaster.TestStepMaster.replaceVariables">
<code class="sig-name descname">replaceVariables</code><span class="sig-paren">(</span><em class="sig-param">expression</em><span class="sig-paren">)</span><a class="headerlink" href="#baangt.TestSteps.TestStepMaster.TestStepMaster.replaceVariables" title="Permalink to this definition">¶</a></dt>
<dd><p>The syntax for variables is currently $(&lt;column_name_from_data_file&gt;). Multiple variables can be assigned
in one cell, for instance perfectly fine: “<a class="reference external" href="http://$(BASEURL)/$(ENDPOINT">http://$(BASEURL)/$(ENDPOINT</a>)”</p>
<p>There’s a special syntax for the faker module: $(FAKER.&lt;fakermethod&gt;).</p>
<p>Also a special syntax for API-Handling: $(APIHandling.&lt;DictElementName&gt;).</p>
<p>&#64;param expression: the current cell, either as fixed value, e.g. “Franzi” or with a varible $(DATE)
&#64;return: the replaced value, e.g. if expression was $(DATE) and the value in column “DATE” of data-file was</p>
<blockquote>
<div><p>“01.01.2020” then return will be “01.01.2020”</p>
</div></blockquote>
</dd></dl>

<dl class="method">
<dt id="baangt.TestSteps.TestStepMaster.TestStepMaster.teardown">
<code class="sig-name descname">teardown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.TestSteps.TestStepMaster.TestStepMaster.teardown" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

</div>
<div class="section" id="module-baangt.TestSteps">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-baangt.TestSteps" title="Permalink to this headline">¶</a></h2>
</div>
</div>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="baangt.TestSteps.DropsApp.html" class="btn btn-neutral float-right" title="baangt.TestSteps.DropsApp package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="baangt.TestCaseSequence.html" class="btn btn-neutral float-left" title="baangt.TestCaseSequence package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; 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>