Documentation for readthedocs

.readthedocs.yaml

@@ -0,0 +1,24 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Build documentation with MkDocs
+#mkdocs:
+#  configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF
+formats:
+  - pdf
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.7
+  install:
+    - requirements: requirements.txt

README.md

@@ -1 +1,3 @@
-# PerformanceTesting
+# PerformanceTesting
+
+Check Documentation at: [performancetesting.readthedocs.io](https://performancetesting.readthedocs.io/)

docs/Makefile

@@ -0,0 +1,22 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+export DJANGO_SETTINGS_MODULE = "gitApp.settings"
+export GITHUBAPPID = -1
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/Overview.rst

@@ -0,0 +1,12 @@
+Overview
+========
+
+.. image:: _static/Overview.png
+    :width: 600
+
+
+Detail: Check Flow
+------------------
+
+.. image:: _static/drawIO/CheckFlow.png
+    :width: 400

docs/Setup.rst

@@ -0,0 +1,2 @@
+Setup
+=====

docs/_static/drawIO/CheckFlow.drawio

@@ -0,0 +1 @@
+<mxfile host="Electron" modified="2020-07-30T18:57:03.868Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/13.4.5 Chrome/83.0.4103.122 Electron/9.1.0 Safari/537.36" etag="1Bc-gen5dyIHM75j8t2y" version="13.4.5" type="device"><diagram id="11zgLUxlglwPnSVA6IN0" name="Page-1">7Vxbc5s4FP41fkyGO/gxzqXZ2fSyTTtp+rIjg2yzAeQFkTj761cCcZPAJjYYO3E705qDkOCc71x1YKRe+qtPIVguPiMHeiNFclYj9WqkKLKq6+Q/SnlNKZbCCPPQddiggnDv/gcZUWLU2HVgVBmIEfKwu6wSbRQE0MYVGghD9FIdNkNeddUlmEOBcG8DT6Q+uA5eZE9hFvRb6M4X2cqyMU7P+CAbzJ4kWgAHvZRI6vVIvQwRwukvf3UJPcq8jC/pdTcNZ/MbC2GA21zwJYj/WJnG74t4MZs8/754/qF9PzPUdJpn4MXsidnd4teMBSGKAwfSWaSROnlZuBjeL4FNz74QoRPaAvseOZLJz3kIHJfc0SXyUJhcr14b9C85x5aCIYarxoeQc9YQTEHkQxy+kiHZBRrjJoOTYjJ2vxTC0Uw2ZlESjGVkoGCAmOdzFzwjPxjb3sJC5bhZKKtSOxbKutQXC+XjZqHekoNWbwzUaxhoeGTZiUt+zHHy3ClhhshDlllr/Buj7MRZlFjgCzJANpar4mRiYjNmFkTVSP6USelqD3CaLUieKF2zeh+EXLo3TtpENrgq0giH6AlmAg1QAOktu57HkYDnzgNyaBNZQkKfUEm7xKBfsBO+6zh0mVoMVVHWBVQMTtukGqzUQEXpCypmna4NCpVbhJ7INd+Qc0JMDWLqrIu1V8RYh4aYr8HZFfRBQAAjPaDwiUjthJwa5IxF5OROfC/QsZqNTWukyFWkpEL8HgfUZMBwhkICBMJWNu00zIbcEGAkZsVN8FAPj8YgQ94cZIBphLwYw4vQZnlLQi2OtBxKWeqgcDgiGHcAtGa2ADqKftuC0xnjyD27SbkDnKhc+KLV+KTcT5VxovWFkwyAQ+DkM4io8irS7fXF1QkoZaDkhuFggKLKgiigQxJ2dohCvEBzFADvuqByhrYYc4fQkgnjH4jxKxMHiDGqChCuXPyr9PuRTnWus6OrFZs5OXgtHRDcueS5qWtIaQHhwa/iYnr4WD5XTJUcZXNVsaHVS5ryYb2cCdtQHNpwHX/TcRiEc4jXjZPqgRNCD2D3uXoj3aNATLm/oFpg3IEp9DhtbO20Q0jMC5gm81ExLKkrSZ5Fn4z0K0EM6sSjy02A/TRPMMeFC40ayYpXbKlRrnZlCa5Rh0b9PZPOLVVXKjp8xtZsLSk2O/Oj+dTaeVbpyifmJkGzWURAxAs7v80dItKxIP9HGA1pGQpr8Fg6M4RlWA/Boe2GrG8CrEr+VKNYaTfA9g9HsYb6GRI+ENLXPwVQin6+nHgswJKO81dzWk4/n3noxV6AEJ870HYjFwUN0QZviPjYQYeWU0QZpTOWMiVpVjf5R56WMskZZstwISd27ilk65itwv78vtZSfxvUdz9uXxP07Nv3ETUPN+Tf1NML0f0DnC6S+lI3ahgRDuG/m2L+DVo4m0HDro3gHXM8lTqqAgha2FIJjd50UD0aHTz4+Fxv62eVIRU1qzEdfpZ2gJIbNLMS95E+0ZhJukS+75LcR7Cv6em6WlsxRqR8XeKkasPT70CUrUZCnQ9adOHst9zWgPcXRYkbAH/FMKYB7jWxg25N6rVtlIvs2Cd8Uhrkm5b7iFYr+mZ3C2US9pp1shsbpgo6Cnrzmlgmrprtmlpx9babLovF1CuxgrmthAAGUxDBbSOgmdIQARlTQ+9IJDpXtpQtUSTGPiOg3EmcIqCd/aistHSkyq6ONLn0IgzBa2kAqwE21sVUtYo91eS6srjxirl2PPmR3kGnBQtLee94XF8FE9E6BECtBit2WABVxwMANONhyYXdgTiwF6Niw/8UHFJpKC2jjd525LRBc7192JLkaLjSnNw2c1THO9qT3aJOMXX8AZNsLimGO2KyV9mVP2nziB4Orc3y+KTN/Wqz0VabB1VmQ1Dmbvpxso2xvOmGxBpINA2TEKTOPq07nbpy1hf4h7YaWYvB4VuN/Sl6Fpht3lIbJA3g805N35AGqGvH95MGaNrx4qrkn8w3OajeWjTaAlLbdZO3HkEal0gSE8XZo/TO2GUFtt4K7caFmrCtqfraC/oBdyYPMWD+GZz5p5i5qd7ONS+P5aG9n/ZOelIrRqoIqgev+KrjtiHzoFunmliz+phNqdrGplTaGpZOtq1PyXtOOaXur8lPM48lFtnQX6oc6MZOazXvJj7ZtW6+MapQrSGiCk3cq29qjX7vZsjcbIbGHTXD6+c63wyv78swZXpTkvh9bNswmsX02uQNKE76H6gH2arZ+99394xxNJ7j+HZbtba7I9awrcvi7sjPpYeAQzUURrGHRRv9MfI5VfhAQs33SGo1Vu2tnCm+0JHVoSVarZbSPP196/SmwK+dQ++mdVZuqePptsU6ly+8XZShb7/Bo269rdrKja+Gjvt81UkX36c5+krGVjuC5LKN+m7H4XNuv4fQB70hBN5TL7kYmF77S0xvgLUPf7ykJNWftRZKM42qQ9zGQAkWRSZ6YFbmPZO16iQ9Wg3xMyCXC2g/NSKhvwTlBviuRzlwC71nSGGUoYLFSUod4ppTlqYkp+9NX61tXjPuLUoyBaH+gKHvBgDXfGWjoWtvS0FjthBl+1Z96JYN6/vQp5ZOtza76UPnXg3Qxno7mfXWiG69+1fxap35gPmp1dpXD9MNzO2VHmQbgDVs6f0tYWmXIeiQqG1bVRmoeYX/hKks6Wthy1+gK/oeYCvWfC6RT8WRuAAiN8UAPvVWwTRajurek0w/ScXecM9essTngjp81FJR3QfuOioVkcPi28wpJIovXKvX/wM=</diagram></mxfile>

docs/conf.py

@@ -0,0 +1,62 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('../'))
+sys.path.insert(0, os.path.abspath('../gitApp'))
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'gitApp.settings')
+os.environ.setdefault('GITHUBAPPID', '-1')
+
+# -- Project information -----------------------------------------------------
+
+project = 'Autopas Performance Testing'
+copyright = '2020, kruegener'
+author = 'kruegener'
+
+# The full version, including alpha/beta/rc tags
+release = 'alpha'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['recommonmark', 'sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx_rtd_theme', 'sphinx.ext.coverage']
+autodoc_default_options = {"members": True, "undoc-members": True, "private-members": True}
+# autodoc_mock_imports = ["mongoengine"]
+autodoc_inherit_docstrings = True
+autodoc_member_order = 'alphabetical'  # 'bysource'
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+# html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']

docs/index.rst

@@ -0,0 +1,38 @@
+.. Autopas Performance Testing documentation master file, created by
+   sphinx-quickstart on Thu Jul 23 16:18:36 2020.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Autopas Performance Testing's documentation!
+=======================================================
+
+.. toctree::
+   :maxdepth: 4
+   :caption: Contents:
+
+   Overview
+   Setup
+
+   modules/modules
+
+
+=====
+TODOs
+=====
+
+- API Flow Charts
+- Auth schemes used (Git / Imgur / Openshift / Mongo)
+- Openshift Setup
+- Database Setup
+- TBC ...
+
+
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/modules/gitApp.checks.rst

@@ -0,0 +1,64 @@
+=====================
+Checks Package
+=====================
+.. py:currentmodule:: checks
+
+.. toctree::
+   :maxdepth: 2
+
+Authenticator
+----------------------------------
+
+.. autoclass:: Authenticator
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+CheckFlow
+------------------------------
+
+.. autoclass:: CheckFlow
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Commit
+---------------------------
+
+.. autoclass:: Commit
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ImgurUploader
+----------------------------------
+
+.. autoclass:: ImgurUploader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Repository
+-------------------------------
+
+.. autoclass:: Repository
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Worker
+---------------------------
+
+.. autoclass:: Worker
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+YamlSetups - uploadSetups
+--------------------------------------------
+
+.. autoclass:: yamlSetups.uploadSetups
+   :members:
+   :undoc-members:
+   :show-inheritance:
+

docs/modules/gitApp.gitApp.rst

@@ -0,0 +1,11 @@
+=====================
+Django Server gitApp
+=====================
+
+settings
+-----------------------------
+
+.. automodule:: gitApp.settings
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/modules/gitApp.hook.rst

@@ -0,0 +1,33 @@
+===================
+Django App hook
+===================
+
+
+.. toctree::
+   :maxdepth: 4
+
+
+hook.apps
+-----------------------
+
+.. automodule:: hook.apps
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+hook.helper
+-------------------------
+
+.. automodule:: hook.helper
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+hook.views
+------------------------
+
+.. automodule:: hook.views
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/modules/gitApp.mongoDocuments.rst

@@ -0,0 +1,39 @@
+MongoDocuments Package
+=============================
+
+.. py:currentmodule:: mongoDocuments
+
+.. toctree::
+   :maxdepth: 2
+
+Config
+-----------------------------------
+
+.. autoclass:: Config
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+QueueObject
+----------------------------------------
+
+.. autoclass:: QueueObject
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Result
+-----------------------------------
+
+.. autoclass:: Result
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Setup
+----------------------------------
+
+.. autoclass:: Setup
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/modules/modules.rst

@@ -0,0 +1,11 @@
+=======
+GitApp
+=======
+
+.. toctree::
+   :maxdepth: 4
+
+   gitApp.checks
+   gitApp.mongoDocuments
+   gitApp.hook
+   gitApp.gitApp

gitApp/checks/CheckFlow.py

@@ -14,12 +14,12 @@
     BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
     BASE_DIR = os.path.join('../gitApp', BASE_DIR)
 from hook.helper import pretty_request, initialStatus, codeStatus, spawnWorker, get_dyn_keys, generate_label_table
-from checks.Authenticator import Authenticator
-from checks.Repository import Repository
-from mongoDocuments.Config import Config
-from mongoDocuments.QueueObject import QueueObject
-from mongoDocuments.Result import Result
-from checks.ImgurUploader import ImgurUploader
+from checks import Authenticator
+from checks import ImgurUploader
+from checks import Repository
+from mongoDocuments import Config
+from mongoDocuments import QueueObject
+from mongoDocuments import Result
 
 """
 Codes: