diff options
| author | Navan Chauhan <navanchauhan@gmail.com> | 2021-06-07 13:59:08 +0530 |
|---|---|---|
| committer | Navan Chauhan <navanchauhan@gmail.com> | 2021-06-07 13:59:08 +0530 |
| commit | 3a708b304319afe84ebf3d40ecebabe6acc339f3 (patch) | |
| tree | b72f391dbe4d5370394c546f94e10d6edaa17a63 /docs/_build/html/autoapi/app/tests | |
| parent | 359813517e3382c527125fe673fa89f0fd0742c0 (diff) | |
started work on automatic documentation
Diffstat (limited to 'docs/_build/html/autoapi/app/tests')
| -rw-r--r-- | docs/_build/html/autoapi/app/tests/conftest/index.html | 139 | ||||
| -rw-r--r-- | docs/_build/html/autoapi/app/tests/index.html | 121 | ||||
| -rw-r--r-- | docs/_build/html/autoapi/app/tests/test_admin/index.html | 132 | ||||
| -rw-r--r-- | docs/_build/html/autoapi/app/tests/test_cli/index.html | 131 | ||||
| -rw-r--r-- | docs/_build/html/autoapi/app/tests/test_fastapi/index.html | 160 | ||||
| -rw-r--r-- | docs/_build/html/autoapi/app/tests/test_forms/index.html | 140 | ||||
| -rw-r--r-- | docs/_build/html/autoapi/app/tests/test_models/index.html | 130 | ||||
| -rw-r--r-- | docs/_build/html/autoapi/app/tests/test_views/index.html | 169 |
8 files changed, 1122 insertions, 0 deletions
diff --git a/docs/_build/html/autoapi/app/tests/conftest/index.html b/docs/_build/html/autoapi/app/tests/conftest/index.html new file mode 100644 index 0000000..cebd7c1 --- /dev/null +++ b/docs/_build/html/autoapi/app/tests/conftest/index.html @@ -0,0 +1,139 @@ + +<!DOCTYPE html> + +<html> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> + + <title>app.tests.conftest — SaaS in a Flask 0.1.0 documentation</title> + <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css" /> + <link rel="stylesheet" type="text/css" href="../../../../_static/alabaster.css" /> + <link rel="stylesheet" type="text/css" href="../../../../_static/graphviz.css" /> + <script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> + <script src="../../../../_static/jquery.js"></script> + <script src="../../../../_static/underscore.js"></script> + <script src="../../../../_static/doctools.js"></script> + <link rel="index" title="Index" href="../../../../genindex.html" /> + <link rel="search" title="Search" href="../../../../search.html" /> + + <link rel="stylesheet" href="../../../../_static/custom.css" type="text/css" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> + + </head><body> + + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + + + <div class="body" role="main"> + + <section id="module-app.tests.conftest"> +<span id="app-tests-conftest"></span><h1><a class="reference internal" href="#module-app.tests.conftest" title="app.tests.conftest"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.tests.conftest</span></code></a><a class="headerlink" href="#module-app.tests.conftest" title="Permalink to this headline">¶</a></h1> +<p>Configuration with basic fixtures</p> +<section id="module-contents"> +<h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2> +<section id="functions"> +<h3>Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h3> +<table class="longtable docutils align-default"> +<colgroup> +<col style="width: 10%" /> +<col style="width: 90%" /> +</colgroup> +<tbody> +<tr class="row-odd"><td><p><a class="reference internal" href="#app.tests.conftest.app" title="app.tests.conftest.app"><code class="xref py py-obj docutils literal notranslate"><span class="pre">app</span></code></a>()</p></td> +<td><p>Special configurations for tests</p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#app.tests.conftest.client" title="app.tests.conftest.client"><code class="xref py py-obj docutils literal notranslate"><span class="pre">client</span></code></a>(app)</p></td> +<td><p></p></td> +</tr> +</tbody> +</table> +<dl class="py function"> +<dt class="sig sig-object py" id="app.tests.conftest.app"> +<span class="sig-prename descclassname"><span class="pre">app.tests.conftest.</span></span><span class="sig-name descname"><span class="pre">app</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#app.tests.conftest.app" title="Permalink to this definition">¶</a></dt> +<dd><p>Special configurations for tests</p> +<p>We use a dummy database and initialise it.</p> +</dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="app.tests.conftest.client"> +<span class="sig-prename descclassname"><span class="pre">app.tests.conftest.</span></span><span class="sig-name descname"><span class="pre">client</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">app</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.tests.conftest.client" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +</section> +</section> +</section> + + + </div> + + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> +<h1 class="logo"><a href="../../../../index.html">SaaS in a Flask</a></h1> + + + + + + + + +<h3>Navigation</h3> +<p class="caption"><span class="caption-text">Contents:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../index.html">API Reference</a></li> +</ul> + +<div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="../../../../index.html">Documentation overview</a><ul> + </ul></li> +</ul> +</div> +<div id="searchbox" style="display: none" role="search"> + <h3 id="searchlabel">Quick search</h3> + <div class="searchformwrapper"> + <form class="search" action="../../../../search.html" method="get"> + <input type="text" name="q" aria-labelledby="searchlabel" /> + <input type="submit" value="Go" /> + </form> + </div> +</div> +<script>$('#searchbox').show(0);</script> + + + + + + + + + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©2021, Navan Chauhan. + + | + Powered by <a href="http://sphinx-doc.org/">Sphinx 4.0.2</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + + | + <a href="../../../../_sources/autoapi/app/tests/conftest/index.rst.txt" + rel="nofollow">Page source</a> + </div> + + + + + </body> +</html>
\ No newline at end of file diff --git a/docs/_build/html/autoapi/app/tests/index.html b/docs/_build/html/autoapi/app/tests/index.html new file mode 100644 index 0000000..6a33e0d --- /dev/null +++ b/docs/_build/html/autoapi/app/tests/index.html @@ -0,0 +1,121 @@ + +<!DOCTYPE html> + +<html> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> + + <title>app.tests — SaaS in a Flask 0.1.0 documentation</title> + <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" /> + <link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css" /> + <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css" /> + <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> + <script src="../../../_static/jquery.js"></script> + <script src="../../../_static/underscore.js"></script> + <script src="../../../_static/doctools.js"></script> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + + <link rel="stylesheet" href="../../../_static/custom.css" type="text/css" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> + + </head><body> + + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + + + <div class="body" role="main"> + + <section id="module-app.tests"> +<span id="app-tests"></span><h1><a class="reference internal" href="#module-app.tests" title="app.tests"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.tests</span></code></a><a class="headerlink" href="#module-app.tests" title="Permalink to this headline">¶</a></h1> +<p>PyTest Modules for Unit Testing</p> +<section id="submodules"> +<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="conftest/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.tests.conftest</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="test_admin/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.tests.test_admin</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="test_cli/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.tests.test_cli</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="test_fastapi/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.tests.test_fastapi</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="test_forms/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.tests.test_forms</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="test_models/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.tests.test_models</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="test_views/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.tests.test_views</span></code></a></li> +</ul> +</div> +</section> +</section> + + + </div> + + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> +<h1 class="logo"><a href="../../../index.html">SaaS in a Flask</a></h1> + + + + + + + + +<h3>Navigation</h3> +<p class="caption"><span class="caption-text">Contents:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../index.html">API Reference</a></li> +</ul> + +<div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="../../../index.html">Documentation overview</a><ul> + </ul></li> +</ul> +</div> +<div id="searchbox" style="display: none" role="search"> + <h3 id="searchlabel">Quick search</h3> + <div class="searchformwrapper"> + <form class="search" action="../../../search.html" method="get"> + <input type="text" name="q" aria-labelledby="searchlabel" /> + <input type="submit" value="Go" /> + </form> + </div> +</div> +<script>$('#searchbox').show(0);</script> + + + + + + + + + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©2021, Navan Chauhan. + + | + Powered by <a href="http://sphinx-doc.org/">Sphinx 4.0.2</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + + | + <a href="../../../_sources/autoapi/app/tests/index.rst.txt" + rel="nofollow">Page source</a> + </div> + + + + + </body> +</html>
\ No newline at end of file diff --git a/docs/_build/html/autoapi/app/tests/test_admin/index.html b/docs/_build/html/autoapi/app/tests/test_admin/index.html new file mode 100644 index 0000000..d556f2b --- /dev/null +++ b/docs/_build/html/autoapi/app/tests/test_admin/index.html @@ -0,0 +1,132 @@ + +<!DOCTYPE html> + +<html> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> + + <title>app.tests.test_admin — SaaS in a Flask 0.1.0 documentation</title> + <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css" /> + <link rel="stylesheet" type="text/css" href="../../../../_static/alabaster.css" /> + <link rel="stylesheet" type="text/css" href="../../../../_static/graphviz.css" /> + <script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> + <script src="../../../../_static/jquery.js"></script> + <script src="../../../../_static/underscore.js"></script> + <script src="../../../../_static/doctools.js"></script> + <link rel="index" title="Index" href="../../../../genindex.html" /> + <link rel="search" title="Search" href="../../../../search.html" /> + + <link rel="stylesheet" href="../../../../_static/custom.css" type="text/css" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> + + </head><body> + + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + + + <div class="body" role="main"> + + <section id="module-app.tests.test_admin"> +<span id="app-tests-test-admin"></span><h1><a class="reference internal" href="#module-app.tests.test_admin" title="app.tests.test_admin"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.tests.test_admin</span></code></a><a class="headerlink" href="#module-app.tests.test_admin" title="Permalink to this headline">¶</a></h1> +<p>Test(s) for Admin Portal</p> +<section id="module-contents"> +<h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2> +<section id="functions"> +<h3>Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h3> +<table class="longtable docutils align-default"> +<colgroup> +<col style="width: 10%" /> +<col style="width: 90%" /> +</colgroup> +<tbody> +<tr class="row-odd"><td><p><a class="reference internal" href="#app.tests.test_admin.test_admin" title="app.tests.test_admin.test_admin"><code class="xref py py-obj docutils literal notranslate"><span class="pre">test_admin</span></code></a>(app, client)</p></td> +<td><p>Test Admin Portal</p></td> +</tr> +</tbody> +</table> +<dl class="py function"> +<dt class="sig sig-object py" id="app.tests.test_admin.test_admin"> +<span class="sig-prename descclassname"><span class="pre">app.tests.test_admin.</span></span><span class="sig-name descname"><span class="pre">test_admin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">app</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.tests.test_admin.test_admin" title="Permalink to this definition">¶</a></dt> +<dd><p>Test Admin Portal</p> +<p>We use the cli-runner to run the admin-create command. +Then we check if the admin portal is accessible to the newly created superuser.</p> +</dd></dl> + +</section> +</section> +</section> + + + </div> + + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> +<h1 class="logo"><a href="../../../../index.html">SaaS in a Flask</a></h1> + + + + + + + + +<h3>Navigation</h3> +<p class="caption"><span class="caption-text">Contents:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../index.html">API Reference</a></li> +</ul> + +<div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="../../../../index.html">Documentation overview</a><ul> + </ul></li> +</ul> +</div> +<div id="searchbox" style="display: none" role="search"> + <h3 id="searchlabel">Quick search</h3> + <div class="searchformwrapper"> + <form class="search" action="../../../../search.html" method="get"> + <input type="text" name="q" aria-labelledby="searchlabel" /> + <input type="submit" value="Go" /> + </form> + </div> +</div> +<script>$('#searchbox').show(0);</script> + + + + + + + + + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©2021, Navan Chauhan. + + | + Powered by <a href="http://sphinx-doc.org/">Sphinx 4.0.2</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + + | + <a href="../../../../_sources/autoapi/app/tests/test_admin/index.rst.txt" + rel="nofollow">Page source</a> + </div> + + + + + </body> +</html>
\ No newline at end of file diff --git a/docs/_build/html/autoapi/app/tests/test_cli/index.html b/docs/_build/html/autoapi/app/tests/test_cli/index.html new file mode 100644 index 0000000..dfb0d32 --- /dev/null +++ b/docs/_build/html/autoapi/app/tests/test_cli/index.html @@ -0,0 +1,131 @@ + +<!DOCTYPE html> + +<html> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> + + <title>app.tests.test_cli — SaaS in a Flask 0.1.0 documentation</title> + <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css" /> + <link rel="stylesheet" type="text/css" href="../../../../_static/alabaster.css" /> + <link rel="stylesheet" type="text/css" href="../../../../_static/graphviz.css" /> + <script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> + <script src="../../../../_static/jquery.js"></script> + <script src="../../../../_static/underscore.js"></script> + <script src="../../../../_static/doctools.js"></script> + <link rel="index" title="Index" href="../../../../genindex.html" /> + <link rel="search" title="Search" href="../../../../search.html" /> + + <link rel="stylesheet" href="../../../../_static/custom.css" type="text/css" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> + + </head><body> + + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + + + <div class="body" role="main"> + + <section id="module-app.tests.test_cli"> +<span id="app-tests-test-cli"></span><h1><a class="reference internal" href="#module-app.tests.test_cli" title="app.tests.test_cli"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.tests.test_cli</span></code></a><a class="headerlink" href="#module-app.tests.test_cli" title="Permalink to this headline">¶</a></h1> +<p>Test(s) for CLI Commands</p> +<section id="module-contents"> +<h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2> +<section id="functions"> +<h3>Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h3> +<table class="longtable docutils align-default"> +<colgroup> +<col style="width: 10%" /> +<col style="width: 90%" /> +</colgroup> +<tbody> +<tr class="row-odd"><td><p><a class="reference internal" href="#app.tests.test_cli.test_database_commands" title="app.tests.test_cli.test_database_commands"><code class="xref py py-obj docutils literal notranslate"><span class="pre">test_database_commands</span></code></a>(app, client)</p></td> +<td><p>Test for Database CLI Commands</p></td> +</tr> +</tbody> +</table> +<dl class="py function"> +<dt class="sig sig-object py" id="app.tests.test_cli.test_database_commands"> +<span class="sig-prename descclassname"><span class="pre">app.tests.test_cli.</span></span><span class="sig-name descname"><span class="pre">test_database_commands</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">app</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.tests.test_cli.test_database_commands" title="Permalink to this definition">¶</a></dt> +<dd><p>Test for Database CLI Commands</p> +<p>Test for initialisation, creation and admin user creation.</p> +</dd></dl> + +</section> +</section> +</section> + + + </div> + + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> +<h1 class="logo"><a href="../../../../index.html">SaaS in a Flask</a></h1> + + + + + + + + +<h3>Navigation</h3> +<p class="caption"><span class="caption-text">Contents:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../index.html">API Reference</a></li> +</ul> + +<div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="../../../../index.html">Documentation overview</a><ul> + </ul></li> +</ul> +</div> +<div id="searchbox" style="display: none" role="search"> + <h3 id="searchlabel">Quick search</h3> + <div class="searchformwrapper"> + <form class="search" action="../../../../search.html" method="get"> + <input type="text" name="q" aria-labelledby="searchlabel" /> + <input type="submit" value="Go" /> + </form> + </div> +</div> +<script>$('#searchbox').show(0);</script> + + + + + + + + + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©2021, Navan Chauhan. + + | + Powered by <a href="http://sphinx-doc.org/">Sphinx 4.0.2</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + + | + <a href="../../../../_sources/autoapi/app/tests/test_cli/index.rst.txt" + rel="nofollow">Page source</a> + </div> + + + + + </body> +</html>
\ No newline at end of file diff --git a/docs/_build/html/autoapi/app/tests/test_fastapi/index.html b/docs/_build/html/autoapi/app/tests/test_fastapi/index.html new file mode 100644 index 0000000..d572949 --- /dev/null +++ b/docs/_build/html/autoapi/app/tests/test_fastapi/index.html @@ -0,0 +1,160 @@ + +<!DOCTYPE html> + +<html> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> + + <title>app.tests.test_fastapi — SaaS in a Flask 0.1.0 documentation</title> + <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css" /> + <link rel="stylesheet" type="text/css" href="../../../../_static/alabaster.css" /> + <link rel="stylesheet" type="text/css" href="../../../../_static/graphviz.css" /> + <script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> + <script src="../../../../_static/jquery.js"></script> + <script src="../../../../_static/underscore.js"></script> + <script src="../../../../_static/doctools.js"></script> + <link rel="index" title="Index" href="../../../../genindex.html" /> + <link rel="search" title="Search" href="../../../../search.html" /> + + <link rel="stylesheet" href="../../../../_static/custom.css" type="text/css" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> + + </head><body> + + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + + + <div class="body" role="main"> + + <section id="module-app.tests.test_fastapi"> +<span id="app-tests-test-fastapi"></span><h1><a class="reference internal" href="#module-app.tests.test_fastapi" title="app.tests.test_fastapi"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.tests.test_fastapi</span></code></a><a class="headerlink" href="#module-app.tests.test_fastapi" title="Permalink to this headline">¶</a></h1> +<p>Test(s) for FastAPI Inegration</p> +<section id="module-contents"> +<h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2> +<section id="functions"> +<h3>Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h3> +<table class="longtable docutils align-default"> +<colgroup> +<col style="width: 10%" /> +<col style="width: 90%" /> +</colgroup> +<tbody> +<tr class="row-odd"><td><p><a class="reference internal" href="#app.tests.test_fastapi.test_fastapi" title="app.tests.test_fastapi.test_fastapi"><code class="xref py py-obj docutils literal notranslate"><span class="pre">test_fastapi</span></code></a>(app, client)</p></td> +<td><p>Basic Version Test</p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#app.tests.test_fastapi.test_fastapi_user_details" title="app.tests.test_fastapi.test_fastapi_user_details"><code class="xref py py-obj docutils literal notranslate"><span class="pre">test_fastapi_user_details</span></code></a>(app, client)</p></td> +<td><p>Basic User Test</p></td> +</tr> +</tbody> +</table> +</section> +<section id="attributes"> +<h3>Attributes<a class="headerlink" href="#attributes" title="Permalink to this headline">¶</a></h3> +<table class="longtable docutils align-default"> +<colgroup> +<col style="width: 10%" /> +<col style="width: 90%" /> +</colgroup> +<tbody> +<tr class="row-odd"><td><p><a class="reference internal" href="#app.tests.test_fastapi.fastapi_client" title="app.tests.test_fastapi.fastapi_client"><code class="xref py py-obj docutils literal notranslate"><span class="pre">fastapi_client</span></code></a></p></td> +<td><p></p></td> +</tr> +</tbody> +</table> +<dl class="py data"> +<dt class="sig sig-object py" id="app.tests.test_fastapi.fastapi_client"> +<span class="sig-prename descclassname"><span class="pre">app.tests.test_fastapi.</span></span><span class="sig-name descname"><span class="pre">fastapi_client</span></span><a class="headerlink" href="#app.tests.test_fastapi.fastapi_client" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="app.tests.test_fastapi.test_fastapi"> +<span class="sig-prename descclassname"><span class="pre">app.tests.test_fastapi.</span></span><span class="sig-name descname"><span class="pre">test_fastapi</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">app</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.tests.test_fastapi.test_fastapi" title="Permalink to this definition">¶</a></dt> +<dd><p>Basic Version Test</p> +<p>Check if endpoint is accessible</p> +</dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="app.tests.test_fastapi.test_fastapi_user_details"> +<span class="sig-prename descclassname"><span class="pre">app.tests.test_fastapi.</span></span><span class="sig-name descname"><span class="pre">test_fastapi_user_details</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">app</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.tests.test_fastapi.test_fastapi_user_details" title="Permalink to this definition">¶</a></dt> +<dd><p>Basic User Test</p> +<p>Check if DB is accessible to the FastAPI App</p> +</dd></dl> + +</section> +</section> +</section> + + + </div> + + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> +<h1 class="logo"><a href="../../../../index.html">SaaS in a Flask</a></h1> + + + + + + + + +<h3>Navigation</h3> +<p class="caption"><span class="caption-text">Contents:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../index.html">API Reference</a></li> +</ul> + +<div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="../../../../index.html">Documentation overview</a><ul> + </ul></li> +</ul> +</div> +<div id="searchbox" style="display: none" role="search"> + <h3 id="searchlabel">Quick search</h3> + <div class="searchformwrapper"> + <form class="search" action="../../../../search.html" method="get"> + <input type="text" name="q" aria-labelledby="searchlabel" /> + <input type="submit" value="Go" /> + </form> + </div> +</div> +<script>$('#searchbox').show(0);</script> + + + + + + + + + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©2021, Navan Chauhan. + + | + Powered by <a href="http://sphinx-doc.org/">Sphinx 4.0.2</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + + | + <a href="../../../../_sources/autoapi/app/tests/test_fastapi/index.rst.txt" + rel="nofollow">Page source</a> + </div> + + + + + </body> +</html>
\ No newline at end of file diff --git a/docs/_build/html/autoapi/app/tests/test_forms/index.html b/docs/_build/html/autoapi/app/tests/test_forms/index.html new file mode 100644 index 0000000..f1669c6 --- /dev/null +++ b/docs/_build/html/autoapi/app/tests/test_forms/index.html @@ -0,0 +1,140 @@ + +<!DOCTYPE html> + +<html> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> + + <title>app.tests.test_forms — SaaS in a Flask 0.1.0 documentation</title> + <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css" /> + <link rel="stylesheet" type="text/css" href="../../../../_static/alabaster.css" /> + <link rel="stylesheet" type="text/css" href="../../../../_static/graphviz.css" /> + <script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> + <script src="../../../../_static/jquery.js"></script> + <script src="../../../../_static/underscore.js"></script> + <script src="../../../../_static/doctools.js"></script> + <link rel="index" title="Index" href="../../../../genindex.html" /> + <link rel="search" title="Search" href="../../../../search.html" /> + + <link rel="stylesheet" href="../../../../_static/custom.css" type="text/css" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> + + </head><body> + + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + + + <div class="body" role="main"> + + <section id="module-app.tests.test_forms"> +<span id="app-tests-test-forms"></span><h1><a class="reference internal" href="#module-app.tests.test_forms" title="app.tests.test_forms"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.tests.test_forms</span></code></a><a class="headerlink" href="#module-app.tests.test_forms" title="Permalink to this headline">¶</a></h1> +<p>Test(s) for Forms</p> +<p>Tests the forms and their validations</p> +<section id="module-contents"> +<h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2> +<section id="functions"> +<h3>Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h3> +<table class="longtable docutils align-default"> +<colgroup> +<col style="width: 10%" /> +<col style="width: 90%" /> +</colgroup> +<tbody> +<tr class="row-odd"><td><p><a class="reference internal" href="#app.tests.test_forms.test_incorrect_forms" title="app.tests.test_forms.test_incorrect_forms"><code class="xref py py-obj docutils literal notranslate"><span class="pre">test_incorrect_forms</span></code></a>(app, client)</p></td> +<td><p>Simulate Invalid Forms</p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#app.tests.test_forms.test_contactus" title="app.tests.test_forms.test_contactus"><code class="xref py py-obj docutils literal notranslate"><span class="pre">test_contactus</span></code></a>(app, client)</p></td> +<td><p>Test Valid Form Submission</p></td> +</tr> +</tbody> +</table> +<dl class="py function"> +<dt class="sig sig-object py" id="app.tests.test_forms.test_incorrect_forms"> +<span class="sig-prename descclassname"><span class="pre">app.tests.test_forms.</span></span><span class="sig-name descname"><span class="pre">test_incorrect_forms</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">app</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.tests.test_forms.test_incorrect_forms" title="Permalink to this definition">¶</a></dt> +<dd><p>Simulate Invalid Forms</p> +</dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="app.tests.test_forms.test_contactus"> +<span class="sig-prename descclassname"><span class="pre">app.tests.test_forms.</span></span><span class="sig-name descname"><span class="pre">test_contactus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">app</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.tests.test_forms.test_contactus" title="Permalink to this definition">¶</a></dt> +<dd><p>Test Valid Form Submission</p> +</dd></dl> + +</section> +</section> +</section> + + + </div> + + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> +<h1 class="logo"><a href="../../../../index.html">SaaS in a Flask</a></h1> + + + + + + + + +<h3>Navigation</h3> +<p class="caption"><span class="caption-text">Contents:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../index.html">API Reference</a></li> +</ul> + +<div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="../../../../index.html">Documentation overview</a><ul> + </ul></li> +</ul> +</div> +<div id="searchbox" style="display: none" role="search"> + <h3 id="searchlabel">Quick search</h3> + <div class="searchformwrapper"> + <form class="search" action="../../../../search.html" method="get"> + <input type="text" name="q" aria-labelledby="searchlabel" /> + <input type="submit" value="Go" /> + </form> + </div> +</div> +<script>$('#searchbox').show(0);</script> + + + + + + + + + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©2021, Navan Chauhan. + + | + Powered by <a href="http://sphinx-doc.org/">Sphinx 4.0.2</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + + | + <a href="../../../../_sources/autoapi/app/tests/test_forms/index.rst.txt" + rel="nofollow">Page source</a> + </div> + + + + + </body> +</html>
\ No newline at end of file diff --git a/docs/_build/html/autoapi/app/tests/test_models/index.html b/docs/_build/html/autoapi/app/tests/test_models/index.html new file mode 100644 index 0000000..597f207 --- /dev/null +++ b/docs/_build/html/autoapi/app/tests/test_models/index.html @@ -0,0 +1,130 @@ + +<!DOCTYPE html> + +<html> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> + + <title>app.tests.test_models — SaaS in a Flask 0.1.0 documentation</title> + <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css" /> + <link rel="stylesheet" type="text/css" href="../../../../_static/alabaster.css" /> + <link rel="stylesheet" type="text/css" href="../../../../_static/graphviz.css" /> + <script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> + <script src="../../../../_static/jquery.js"></script> + <script src="../../../../_static/underscore.js"></script> + <script src="../../../../_static/doctools.js"></script> + <link rel="index" title="Index" href="../../../../genindex.html" /> + <link rel="search" title="Search" href="../../../../search.html" /> + + <link rel="stylesheet" href="../../../../_static/custom.css" type="text/css" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> + + </head><body> + + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + + + <div class="body" role="main"> + + <section id="module-app.tests.test_models"> +<span id="app-tests-test-models"></span><h1><a class="reference internal" href="#module-app.tests.test_models" title="app.tests.test_models"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.tests.test_models</span></code></a><a class="headerlink" href="#module-app.tests.test_models" title="Permalink to this headline">¶</a></h1> +<p>Test(s) for Database Models</p> +<section id="module-contents"> +<h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2> +<section id="functions"> +<h3>Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h3> +<table class="longtable docutils align-default"> +<colgroup> +<col style="width: 10%" /> +<col style="width: 90%" /> +</colgroup> +<tbody> +<tr class="row-odd"><td><p><a class="reference internal" href="#app.tests.test_models.test_usermodel" title="app.tests.test_models.test_usermodel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">test_usermodel</span></code></a>(app, client)</p></td> +<td><p>Test User Model</p></td> +</tr> +</tbody> +</table> +<dl class="py function"> +<dt class="sig sig-object py" id="app.tests.test_models.test_usermodel"> +<span class="sig-prename descclassname"><span class="pre">app.tests.test_models.</span></span><span class="sig-name descname"><span class="pre">test_usermodel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">app</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.tests.test_models.test_usermodel" title="Permalink to this definition">¶</a></dt> +<dd><p>Test User Model</p> +</dd></dl> + +</section> +</section> +</section> + + + </div> + + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> +<h1 class="logo"><a href="../../../../index.html">SaaS in a Flask</a></h1> + + + + + + + + +<h3>Navigation</h3> +<p class="caption"><span class="caption-text">Contents:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../index.html">API Reference</a></li> +</ul> + +<div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="../../../../index.html">Documentation overview</a><ul> + </ul></li> +</ul> +</div> +<div id="searchbox" style="display: none" role="search"> + <h3 id="searchlabel">Quick search</h3> + <div class="searchformwrapper"> + <form class="search" action="../../../../search.html" method="get"> + <input type="text" name="q" aria-labelledby="searchlabel" /> + <input type="submit" value="Go" /> + </form> + </div> +</div> +<script>$('#searchbox').show(0);</script> + + + + + + + + + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©2021, Navan Chauhan. + + | + Powered by <a href="http://sphinx-doc.org/">Sphinx 4.0.2</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + + | + <a href="../../../../_sources/autoapi/app/tests/test_models/index.rst.txt" + rel="nofollow">Page source</a> + </div> + + + + + </body> +</html>
\ No newline at end of file diff --git a/docs/_build/html/autoapi/app/tests/test_views/index.html b/docs/_build/html/autoapi/app/tests/test_views/index.html new file mode 100644 index 0000000..bd4f362 --- /dev/null +++ b/docs/_build/html/autoapi/app/tests/test_views/index.html @@ -0,0 +1,169 @@ + +<!DOCTYPE html> + +<html> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> + + <title>app.tests.test_views — SaaS in a Flask 0.1.0 documentation</title> + <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css" /> + <link rel="stylesheet" type="text/css" href="../../../../_static/alabaster.css" /> + <link rel="stylesheet" type="text/css" href="../../../../_static/graphviz.css" /> + <script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> + <script src="../../../../_static/jquery.js"></script> + <script src="../../../../_static/underscore.js"></script> + <script src="../../../../_static/doctools.js"></script> + <link rel="index" title="Index" href="../../../../genindex.html" /> + <link rel="search" title="Search" href="../../../../search.html" /> + + <link rel="stylesheet" href="../../../../_static/custom.css" type="text/css" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> + + </head><body> + + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + + + <div class="body" role="main"> + + <section id="module-app.tests.test_views"> +<span id="app-tests-test-views"></span><h1><a class="reference internal" href="#module-app.tests.test_views" title="app.tests.test_views"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.tests.test_views</span></code></a><a class="headerlink" href="#module-app.tests.test_views" title="Permalink to this headline">¶</a></h1> +<p>Test(s) for Flask Views</p> +<section id="module-contents"> +<h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2> +<section id="functions"> +<h3>Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h3> +<table class="longtable docutils align-default"> +<colgroup> +<col style="width: 10%" /> +<col style="width: 90%" /> +</colgroup> +<tbody> +<tr class="row-odd"><td><p><a class="reference internal" href="#app.tests.test_views.test_visitors" title="app.tests.test_views.test_visitors"><code class="xref py py-obj docutils literal notranslate"><span class="pre">test_visitors</span></code></a>(app, client)</p></td> +<td><p>Test if Vistors get expected endpoints and status codes</p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#app.tests.test_views.test_user_auth_flow" title="app.tests.test_views.test_user_auth_flow"><code class="xref py py-obj docutils literal notranslate"><span class="pre">test_user_auth_flow</span></code></a>(app, client)</p></td> +<td><p>Test User Authentication Flow</p></td> +</tr> +</tbody> +</table> +</section> +<section id="attributes"> +<h3>Attributes<a class="headerlink" href="#attributes" title="Permalink to this headline">¶</a></h3> +<table class="longtable docutils align-default"> +<colgroup> +<col style="width: 10%" /> +<col style="width: 90%" /> +</colgroup> +<tbody> +<tr class="row-odd"><td><p><a class="reference internal" href="#app.tests.test_views.ts" title="app.tests.test_views.ts"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ts</span></code></a></p></td> +<td><p>To create confirmation tokens</p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#app.tests.test_views.data2check_visitors" title="app.tests.test_views.data2check_visitors"><code class="xref py py-obj docutils literal notranslate"><span class="pre">data2check_visitors</span></code></a></p></td> +<td><p>Dictionary of Path, Expected Status Code and Data to Test for Visitors</p></td> +</tr> +</tbody> +</table> +<dl class="py data"> +<dt class="sig sig-object py" id="app.tests.test_views.ts"> +<span class="sig-prename descclassname"><span class="pre">app.tests.test_views.</span></span><span class="sig-name descname"><span class="pre">ts</span></span><a class="headerlink" href="#app.tests.test_views.ts" title="Permalink to this definition">¶</a></dt> +<dd><p>To create confirmation tokens</p> +</dd></dl> + +<dl class="py data"> +<dt class="sig sig-object py" id="app.tests.test_views.data2check_visitors"> +<span class="sig-prename descclassname"><span class="pre">app.tests.test_views.</span></span><span class="sig-name descname"><span class="pre">data2check_visitors</span></span><a class="headerlink" href="#app.tests.test_views.data2check_visitors" title="Permalink to this definition">¶</a></dt> +<dd><p>Dictionary of Path, Expected Status Code and Data to Test for Visitors</p> +</dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="app.tests.test_views.test_visitors"> +<span class="sig-prename descclassname"><span class="pre">app.tests.test_views.</span></span><span class="sig-name descname"><span class="pre">test_visitors</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">app</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.tests.test_views.test_visitors" title="Permalink to this definition">¶</a></dt> +<dd><p>Test if Vistors get expected endpoints and status codes</p> +</dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="app.tests.test_views.test_user_auth_flow"> +<span class="sig-prename descclassname"><span class="pre">app.tests.test_views.</span></span><span class="sig-name descname"><span class="pre">test_user_auth_flow</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">app</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.tests.test_views.test_user_auth_flow" title="Permalink to this definition">¶</a></dt> +<dd><p>Test User Authentication Flow</p> +<p>Tests Registeration, Email-Confirmation and Log-in along with appropriate redirects.</p> +</dd></dl> + +</section> +</section> +</section> + + + </div> + + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> +<h1 class="logo"><a href="../../../../index.html">SaaS in a Flask</a></h1> + + + + + + + + +<h3>Navigation</h3> +<p class="caption"><span class="caption-text">Contents:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../index.html">API Reference</a></li> +</ul> + +<div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="../../../../index.html">Documentation overview</a><ul> + </ul></li> +</ul> +</div> +<div id="searchbox" style="display: none" role="search"> + <h3 id="searchlabel">Quick search</h3> + <div class="searchformwrapper"> + <form class="search" action="../../../../search.html" method="get"> + <input type="text" name="q" aria-labelledby="searchlabel" /> + <input type="submit" value="Go" /> + </form> + </div> +</div> +<script>$('#searchbox').show(0);</script> + + + + + + + + + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©2021, Navan Chauhan. + + | + Powered by <a href="http://sphinx-doc.org/">Sphinx 4.0.2</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + + | + <a href="../../../../_sources/autoapi/app/tests/test_views/index.rst.txt" + rel="nofollow">Page source</a> + </div> + + + + + </body> +</html>
\ No newline at end of file |