Browse Source

Updated Documentation

bernhardbuhl 4 years ago
parent
commit
7546fd4a85

BIN
docs/_build/doctrees/Installation.doctree


BIN
docs/_build/doctrees/PlannedFeatures.doctree


BIN
docs/_build/doctrees/changelog.doctree


BIN
docs/_build/doctrees/docs/baangt.TestSteps.DropsApp.doctree


BIN
docs/_build/doctrees/docs/baangt.TestSteps.doctree


BIN
docs/_build/doctrees/environment.pickle


BIN
docs/_build/doctrees/simpleExample.doctree


+ 1 - 1
docs/_build/html/BrowserDrivers.html

@@ -103,7 +103,7 @@
 <li class="toctree-l2"><a class="reference internal" href="#older-releases-of-browser-drivers">Older releases of browser drivers</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="articles/Articles.html">:subheader: Articles</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>
 

File diff suppressed because it is too large
+ 13 - 4
docs/_build/html/Installation.html


+ 1 - 1
docs/_build/html/ParametersConfigFile.html

@@ -96,7 +96,7 @@
 <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="articles/Articles.html">:subheader: Articles</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>
 

+ 4 - 5
docs/_build/html/PlannedFeatures.html

@@ -101,7 +101,7 @@
 </ul>
 </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="articles/Articles.html">:subheader: Articles</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>
 
@@ -173,8 +173,6 @@
 <div class="section" id="short-medium-term-features">
 <h2>Short/Medium term features<a class="headerlink" href="#short-medium-term-features" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
-<li><p>Refactoring of parallel processing on a single computer (2020.03) –&gt; Done</p></li>
-<li><p>Executables on Mac, Linux and Windows (2020.03) –&gt; Done</p></li>
 <li><dl class="simple">
 <dt>Nicer interactive UI-Starter (2020.03)</dt><dd><ul>
 <li><p>Phase 1 done 2020.02</p></li>
@@ -185,8 +183,6 @@
 </dl>
 </li>
 <li><p>Double Opt-In Automation (2020.03) –&gt; will move to 2020.04 RC6</p></li>
-<li><p>Support for Selenium Grid V4 (2020.04)</p></li>
-<li><p>Better support for multiple sources (e.g. multiple XLSX) of test data (2020.04)</p></li>
 <li><p>Better support to store test data output to database and export files (2020.04)</p></li>
 <li><p>Support for Appium integration (2020.04)</p></li>
 <li><p>Katalon Importer/Converter as Webservice (2020.04)</p></li>
@@ -195,6 +191,7 @@
 <div class="section" id="features-for-later">
 <h2>Features for later<a class="headerlink" href="#features-for-later" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
+<li><p>Better support for multiple sources (e.g. multiple XLSX)</p></li>
 <li><p>Proof of concept with PyWinAuto</p></li>
 <li><p>Integration with SAP Gui Scripting via VBS and PyWinAuto</p></li>
 <li><p>Better support for Mass testing APIs</p></li>
@@ -219,6 +216,8 @@ Future features might include:</p>
 <li><p>XML/PDF-Compare</p></li>
 <li><p>Consulting</p></li>
 <li><p>Priority support</p></li>
+<li><p>Testcase creation as a Service</p></li>
+<li><p>Testing as a service</p></li>
 </ul>
 </div>
 </div>

+ 13 - 3
docs/_build/html/_sources/Installation.rst.txt

@@ -3,6 +3,15 @@ Installation
 
 There are various ways to install and use ``baangt`` depending on your requirements and setup.
 
+Run the executables
+-------------------
+
+Installing the executables for your operating system (MacOS, Windows, Ubuntu) is simple. Head over to
+https://github.com/Athos1972/baangt/tree/master/executables select the archive for your operating system,
+download to your local computer and unzip.
+
+In the new folder you'll find ``baangt`` executable. Click on it and explore examples in ``/examples`` folder.
+
 Install from sources
 --------------------
 
@@ -23,15 +32,16 @@ Install from GIT:
 
     git clone https://gogs.earthsquad.global/athos/baangt-Docker
     cd baangt-Docker
-    Make build
-    Make run
+    make build
+    make run
 
 then use your preferred VNC-Client with ``vnc://localhost:5902``. Unless you changed the default password, the
 password is ``password`` .
 
 Install PIP-Package
 ------------------------
-If you're planning to implement subclassing you can also use the pip package:
+If you're planning to implement subclassing and you don't want to contribute to this open source project you can also
+use the pip package:
 
 ::
 

+ 3 - 5
docs/_build/html/_sources/PlannedFeatures.rst.txt

@@ -4,21 +4,18 @@ We implement all features for 3 operating Systems (Mac, Windows, Debian Linux an
 
 Short/Medium term features
 ---------------------------
-* Refactoring of parallel processing on a single computer (2020.03) --> Done
-* Executables on Mac, Linux and Windows (2020.03) --> Done
 * Nicer interactive UI-Starter (2020.03)
     * Phase 1 done 2020.02
     * Phase 2 (UI-elements) (2020.03) --> will move to 2020.04 RC5
     * Provide live statistics (2020.04)
 * Double Opt-In Automation (2020.03) --> will move to 2020.04 RC6
-* Support for Selenium Grid V4 (2020.04)
-* Better support for multiple sources (e.g. multiple XLSX) of test data (2020.04)
 * Better support to store test data output to database and export files (2020.04)
 * Support for Appium integration (2020.04)
 * Katalon Importer/Converter as Webservice (2020.04)
 
 Features for later
 ------------------
+* Better support for multiple sources (e.g. multiple XLSX)
 * Proof of concept with PyWinAuto
 * Integration with SAP Gui Scripting via VBS and PyWinAuto
 * Better support for Mass testing APIs
@@ -42,4 +39,5 @@ Future features might include:
 * XML/PDF-Compare
 * Consulting
 * Priority support
-
+* Testcase creation as a Service
+* Testing as a service

+ 2 - 0
docs/_build/html/_sources/changelog.rst.txt

@@ -7,6 +7,7 @@ Summary: Release Candiate 3 is on the road!
 
 New features
 ++++++++++++
+* Executable files and ZIP-Archives for Mac, Windows and Ubuntu - no more GIT CLONE needed! Simply download, unzip and run.
 * Network logging during WEB-Sessions and export to Excel-Result in separate tab. Use ``TC.NetworkInfo`` with value ``True`` (tested on Mac and Windows, most probably works on Linux too).
 * baangtDB: Import and Export functionality for simpleFormat and complex XLSX-Testrun definitions.
 * baangtDB: Export also to JSON-Format
@@ -17,6 +18,7 @@ New features
 * SimpleFormat: ``address_creation`` command added to create a random address. Customizable.
   Multiple calls will create multiple random addresses.
 * CLI: New parameter ``--reloadDrivers=True`` downloads latest version of webdrivers for Chrome and Firefox.
+* Integration with Selenium Grid V4.0 and baangt. See docs for further details. Separate Repository for the Dockerfile
 
 Bugfixes
 ++++++++

+ 3 - 1
docs/_build/html/_sources/simpleExample.rst.txt

@@ -6,7 +6,7 @@ You can try baangt right away and see how it works. It'll take less than 5 minut
 Prerequisits
 ^^^^^^^^^^^^^
 
-* Firefox installed
+* Chrome installed
 * Python3 installed
 * ``baangt`` installed (either via PIP or from the GIT-Repository at https://gogs.earthsquad.global/athos/baangt)
 
@@ -173,6 +173,8 @@ More details on Activities
        * If
        * EndIf
        * Pause
+       * Assert
+       * address_create
 
 .. list-table:: Details of activities
    :widths: 25 75

+ 3 - 1
docs/_build/html/changelog.html

@@ -105,7 +105,7 @@
 </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="articles/Articles.html">:subheader: Articles</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>
 
@@ -179,6 +179,7 @@
 <div class="section" id="new-features">
 <h3>New features<a class="headerlink" href="#new-features" title="Permalink to this headline">¶</a></h3>
 <ul class="simple">
+<li><p>Executable files and ZIP-Archives for Mac, Windows and Ubuntu - no more GIT CLONE needed! Simply download, unzip and run.</p></li>
 <li><p>Network logging during WEB-Sessions and export to Excel-Result in separate tab. Use <code class="docutils literal notranslate"><span class="pre">TC.NetworkInfo</span></code> with value <code class="docutils literal notranslate"><span class="pre">True</span></code> (tested on Mac and Windows, most probably works on Linux too).</p></li>
 <li><p>baangtDB: Import and Export functionality for simpleFormat and complex XLSX-Testrun definitions.</p></li>
 <li><p>baangtDB: Export also to JSON-Format</p></li>
@@ -189,6 +190,7 @@
 <li><p>SimpleFormat: <code class="docutils literal notranslate"><span class="pre">address_creation</span></code> command added to create a random address. Customizable.
 Multiple calls will create multiple random addresses.</p></li>
 <li><p>CLI: New parameter <code class="docutils literal notranslate"><span class="pre">--reloadDrivers=True</span></code> downloads latest version of webdrivers for Chrome and Firefox.</p></li>
+<li><p>Integration with Selenium Grid V4.0 and baangt. See docs for further details. Separate Repository for the Dockerfile</p></li>
 </ul>
 </div>
 <div class="section" id="bugfixes">

+ 1 - 1
docs/_build/html/docs/baangt.TestCaseSequence.html

@@ -94,7 +94,7 @@
 <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="../articles/Articles.html">:subheader: Articles</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>
 

+ 2 - 2
docs/_build/html/docs/baangt.TestSteps.DropsApp.html

@@ -94,7 +94,7 @@
 <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="../articles/Articles.html">:subheader: Articles</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>
 
@@ -174,7 +174,7 @@
 <dl class="method">
 <dt id="baangt.TestSteps.DropsApp.Login_API.Login_API.execute">
 <code class="sig-name descname">execute</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baangt.TestSteps.DropsApp.Login_API.Login_API.execute" title="Permalink to this definition">¶</a></dt>
-<dd><p>Method is overwritten in all children</p>
+<dd><p>Method is overwritten in all children/subclasses</p>
 </dd></dl>
 
 </dd></dl>

+ 1 - 1
docs/_build/html/docs/baangt.TestSteps.html

@@ -206,7 +206,7 @@
 <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</p>
+<dd><p>Method is overwritten in all children/subclasses</p>
 </dd></dl>
 
 <dl class="method">

+ 1 - 1
docs/_build/html/docs/baangt.base.html

@@ -94,7 +94,7 @@
 <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="../articles/Articles.html">:subheader: Articles</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>
 

+ 1 - 1
docs/_build/html/docs/baangt.ui.html

@@ -94,7 +94,7 @@
 <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="../articles/Articles.html">:subheader: Articles</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>
 

+ 1 - 1
docs/_build/html/docs/baangtIA.html

@@ -94,7 +94,7 @@
 <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="../articles/Articles.html">:subheader: Articles</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>
 

+ 1 - 1
docs/_build/html/docs/modules.html

@@ -94,7 +94,7 @@
 <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="../articles/Articles.html">:subheader: Articles</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>
 

+ 1 - 1
docs/_build/html/docs/setup.html

@@ -94,7 +94,7 @@
 <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="../articles/Articles.html">:subheader: Articles</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>
 

+ 1 - 0
docs/_build/html/index.html

@@ -171,6 +171,7 @@ and well documented master functionality.</p>
 <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="Installation.html">   Installation</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="Installation.html#run-the-executables">Run the executables</a></li>
 <li class="toctree-l2"><a class="reference internal" href="Installation.html#install-from-sources">Install from sources</a></li>
 <li class="toctree-l2"><a class="reference internal" href="Installation.html#docker">Docker</a></li>
 <li class="toctree-l2"><a class="reference internal" href="Installation.html#install-pip-package">Install PIP-Package</a></li>

File diff suppressed because it is too large
+ 1 - 1
docs/_build/html/searchindex.js


+ 4 - 2
docs/_build/html/simpleExample.html

@@ -109,7 +109,7 @@
 <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="articles/Articles.html">:subheader: Articles</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>
 
@@ -181,7 +181,7 @@
 <div class="section" id="prerequisits">
 <h2>Prerequisits<a class="headerlink" href="#prerequisits" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
-<li><p>Firefox installed</p></li>
+<li><p>Chrome installed</p></li>
 <li><p>Python3 installed</p></li>
 <li><p><code class="docutils literal notranslate"><span class="pre">baangt</span></code> installed (either via PIP or from the GIT-Repository at <a class="reference external" href="https://gogs.earthsquad.global/athos/baangt">https://gogs.earthsquad.global/athos/baangt</a>)</p></li>
 </ul>
@@ -375,6 +375,8 @@ follow different nomenclature, so we made it very easy to subclass the correspon
 <li><p>If</p></li>
 <li><p>EndIf</p></li>
 <li><p>Pause</p></li>
+<li><p>Assert</p></li>
+<li><p>address_create</p></li>
 </ul>
 </div></blockquote>
 <table class="colwidths-given docutils align-default" id="id2">

+ 13 - 0
docs/changelog.rst

@@ -1,6 +1,19 @@
 Change log
 ==========
 
+2020.04
+^^^^^^^
+
+Summary:
+
+New features
+++++++++++++
+
+Changes
++++++++
+* Chrome now as default browser as many people don't have Firefox
+* Improved browserDriver Download for executables (didn't work in some cases)
+
 2020.03
 ^^^^^^^
 Summary: Release Candiate 3 is on the road!

+ 3 - 1
docs/simpleExample.rst

@@ -6,7 +6,7 @@ You can try baangt right away and see how it works. It'll take less than 5 minut
 Prerequisits
 ^^^^^^^^^^^^^
 
-* Firefox installed
+* Chrome installed
 * Python3 installed
 * ``baangt`` installed (either via PIP or from the GIT-Repository at https://gogs.earthsquad.global/athos/baangt)
 
@@ -173,6 +173,8 @@ More details on Activities
        * If
        * EndIf
        * Pause
+       * Assert
+       * address_create
 
 .. list-table:: Details of activities
    :widths: 25 75