From 3a708b304319afe84ebf3d40ecebabe6acc339f3 Mon Sep 17 00:00:00 2001 From: Navan Chauhan Date: Mon, 7 Jun 2021 13:59:08 +0530 Subject: started work on automatic documentation --- .../html/autoapi/app/tests/conftest/index.html | 139 +++++++++++++++++ docs/_build/html/autoapi/app/tests/index.html | 121 +++++++++++++++ .../html/autoapi/app/tests/test_admin/index.html | 132 ++++++++++++++++ .../html/autoapi/app/tests/test_cli/index.html | 131 ++++++++++++++++ .../html/autoapi/app/tests/test_fastapi/index.html | 160 +++++++++++++++++++ .../html/autoapi/app/tests/test_forms/index.html | 140 +++++++++++++++++ .../html/autoapi/app/tests/test_models/index.html | 130 ++++++++++++++++ .../html/autoapi/app/tests/test_views/index.html | 169 +++++++++++++++++++++ 8 files changed, 1122 insertions(+) create mode 100644 docs/_build/html/autoapi/app/tests/conftest/index.html create mode 100644 docs/_build/html/autoapi/app/tests/index.html create mode 100644 docs/_build/html/autoapi/app/tests/test_admin/index.html create mode 100644 docs/_build/html/autoapi/app/tests/test_cli/index.html create mode 100644 docs/_build/html/autoapi/app/tests/test_fastapi/index.html create mode 100644 docs/_build/html/autoapi/app/tests/test_forms/index.html create mode 100644 docs/_build/html/autoapi/app/tests/test_models/index.html create mode 100644 docs/_build/html/autoapi/app/tests/test_views/index.html (limited to 'docs/_build/html/autoapi/app/tests') 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 @@ + + + + + + + + + app.tests.conftest — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.tests.conftest

+

Configuration with basic fixtures

+
+

Module Contents

+
+

Functions

+ ++++ + + + + + + + + +

app()

Special configurations for tests

client(app)

+
+
+app.tests.conftest.app()
+

Special configurations for tests

+

We use a dummy database and initialise it.

+
+ +
+
+app.tests.conftest.client(app)
+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ 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 @@ + + + + + + + + + app.tests — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.tests

+

PyTest Modules for Unit Testing

+
+

Submodules

+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ 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 @@ + + + + + + + + + app.tests.test_admin — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.tests.test_admin

+

Test(s) for Admin Portal

+
+

Module Contents

+
+

Functions

+ ++++ + + + + + +

test_admin(app, client)

Test Admin Portal

+
+
+app.tests.test_admin.test_admin(app, client)
+

Test Admin Portal

+

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.

+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ 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 @@ + + + + + + + + + app.tests.test_cli — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.tests.test_cli

+

Test(s) for CLI Commands

+
+

Module Contents

+
+

Functions

+ ++++ + + + + + +

test_database_commands(app, client)

Test for Database CLI Commands

+
+
+app.tests.test_cli.test_database_commands(app, client)
+

Test for Database CLI Commands

+

Test for initialisation, creation and admin user creation.

+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ 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 @@ + + + + + + + + + app.tests.test_fastapi — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.tests.test_fastapi

+

Test(s) for FastAPI Inegration

+
+

Module Contents

+
+

Functions

+ ++++ + + + + + + + + +

test_fastapi(app, client)

Basic Version Test

test_fastapi_user_details(app, client)

Basic User Test

+
+
+

Attributes

+ ++++ + + + + + +

fastapi_client

+
+
+app.tests.test_fastapi.fastapi_client
+
+ +
+
+app.tests.test_fastapi.test_fastapi(app, client)
+

Basic Version Test

+

Check if endpoint is accessible

+
+ +
+
+app.tests.test_fastapi.test_fastapi_user_details(app, client)
+

Basic User Test

+

Check if DB is accessible to the FastAPI App

+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ 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 @@ + + + + + + + + + app.tests.test_forms — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.tests.test_forms

+

Test(s) for Forms

+

Tests the forms and their validations

+
+

Module Contents

+
+

Functions

+ ++++ + + + + + + + + +

test_incorrect_forms(app, client)

Simulate Invalid Forms

test_contactus(app, client)

Test Valid Form Submission

+
+
+app.tests.test_forms.test_incorrect_forms(app, client)
+

Simulate Invalid Forms

+
+ +
+
+app.tests.test_forms.test_contactus(app, client)
+

Test Valid Form Submission

+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ 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 @@ + + + + + + + + + app.tests.test_models — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.tests.test_models

+

Test(s) for Database Models

+
+

Module Contents

+
+

Functions

+ ++++ + + + + + +

test_usermodel(app, client)

Test User Model

+
+
+app.tests.test_models.test_usermodel(app, client)
+

Test User Model

+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ 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 @@ + + + + + + + + + app.tests.test_views — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.tests.test_views

+

Test(s) for Flask Views

+
+

Module Contents

+
+

Functions

+ ++++ + + + + + + + + +

test_visitors(app, client)

Test if Vistors get expected endpoints and status codes

test_user_auth_flow(app, client)

Test User Authentication Flow

+
+
+

Attributes

+ ++++ + + + + + + + + +

ts

To create confirmation tokens

data2check_visitors

Dictionary of Path, Expected Status Code and Data to Test for Visitors

+
+
+app.tests.test_views.ts
+

To create confirmation tokens

+
+ +
+
+app.tests.test_views.data2check_visitors
+

Dictionary of Path, Expected Status Code and Data to Test for Visitors

+
+ +
+
+app.tests.test_views.test_visitors(app, client)
+

Test if Vistors get expected endpoints and status codes

+
+ +
+
+app.tests.test_views.test_user_auth_flow(app, client)
+

Test User Authentication Flow

+

Tests Registeration, Email-Confirmation and Log-in along with appropriate redirects.

+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file -- cgit v1.2.3