Merge pull request #12 from ByteOtter/add-application-settings

Add parsing of settings parameters

.github/workflows/lint.yml

@@ -47,7 +47,8 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install pyright
+          pip install importlib-resources
+          pip install .[lint_requires,tests_require]
       - name: Analysing the code with pyright
         run: |
           pyright $(git ls-files '*.py')

.github/workflows/testing.yml

@@ -0,0 +1,38 @@
+name: Execute tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.x
+
+    - name: Install dependencies
+      run: pip install .[tests_require]
+
+    - name: Run tests
+      run: pytest -v --cov=src/ tests/
+    - name: Generate coverage report
+      run: coverage xml
+
+    # https://github.com/codacy/codacy-coverage-reporter-action
+    - name: Run codacy-coverage-reporter
+      uses: codacy/codacy-coverage-reporter-action@v1
+      continue-on-error: true
+      with:
+        project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
+        coverage-reports: coverage.xml

.gitignore

@@ -6,6 +6,14 @@ __pycache__/
 # C extensions
 *.so
 
+# IDEs
+.idea/
+.vscode/
+
+# Documentation
+changelog/*
+!changelog/.gitkeep
+
 # Distribution / packaging
 .Python
 build/

.prospector.yml

@@ -11,8 +11,22 @@ dodgy:
 mccabe:
   run: true
 
+pycodestyle:
+  run: true
+  disable:
+    # https://github.com/psf/black/issues/354#issuecomment-397685631
+    - E203
+    - W503
+
 pydocstyle:
   run: true
+  disable:
+    # https://github.com/PyCQA/pydocstyle/issues/627
+    - D202
+    # https://github.com/PyCQA/pydocstyle/issues/141
+    - D203
+    # https://github.com/PyCQA/pydocstyle/issues/475
+    - D212
 
 pyflakes:
   run: true

changelog.d/7.added

@@ -0,0 +1 @@
+Add parsing of application settings

docs/_static/extend_width.css

@@ -0,0 +1,3 @@
+.wy-nav-content {
+    max-width: 90% !important;
+}

docs/code-autodoc/cobbler_tftp.exceptions.rst

@@ -0,0 +1,21 @@
+cobbler\_tftp.exceptions package
+================================
+
+Submodules
+----------
+
+cobbler\_tftp.exceptions.settings\_exceptions module
+----------------------------------------------------
+
+.. automodule:: cobbler_tftp.exceptions.settings_exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: cobbler_tftp.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/code-autodoc/cobbler_tftp.rst

@@ -1,16 +1,15 @@
 cobbler\_tftp package
 =====================
 
-Submodules
-----------
+Subpackages
+-----------
 
-cobbler\_tftp.authentication module
------------------------------------
+.. toctree::
+   :maxdepth: 4
 
-.. automodule:: cobbler_tftp.authentication
-   :members:
-   :undoc-members:
-   :show-inheritance:
+   cobbler_tftp.exceptions
+   cobbler_tftp.settings
+   cobbler_tftp.types
 
 Module contents
 ---------------

docs/code-autodoc/cobbler_tftp.settings.data.rst

@@ -0,0 +1,10 @@
+cobbler\_tftp.settings.data package
+===================================
+
+Module contents
+---------------
+
+.. automodule:: cobbler_tftp.settings.data
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/code-autodoc/cobbler_tftp.settings.migrations.rst

@@ -0,0 +1,21 @@
+cobbler\_tftp.settings.migrations package
+=========================================
+
+Submodules
+----------
+
+cobbler\_tftp.settings.migrations.v1\_0 module
+----------------------------------------------
+
+.. automodule:: cobbler_tftp.settings.migrations.v1_0
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: cobbler_tftp.settings.migrations
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/code-autodoc/cobbler_tftp.settings.rst

@@ -0,0 +1,19 @@
+cobbler\_tftp.settings package
+==============================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   cobbler_tftp.settings.data
+   cobbler_tftp.settings.migrations
+
+Module contents
+---------------
+
+.. automodule:: cobbler_tftp.settings
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/code-autodoc/cobbler_tftp.types.rst

@@ -0,0 +1,10 @@
+cobbler\_tftp.types package
+===========================
+
+Module contents
+---------------
+
+.. automodule:: cobbler_tftp.types
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/code-autodoc/modules.rst

@@ -1,9 +1,7 @@
-src
-===
+cobbler_tftp
+============
 
 .. toctree::
    :maxdepth: 4
 
    cobbler_tftp
-   main
-   service

docs/conf.py

@@ -24,3 +24,4 @@
 
 html_theme = "sphinx_rtd_theme"
 html_static_path = ["_static"]
+html_css_files = ["extend_width.css"]

docs/index.rst

@@ -10,6 +10,8 @@ Welcome to Cobbler-TFTP's documentation!
    :maxdepth: 2
    :caption: Contents:
 
+   Code Documentation<code-autodoc/modules.rst>
+
 
 
 Indices and tables

setup.cfg

@@ -20,18 +20,26 @@ package_dir=
 packages = find:
 include_package_data = True
 setup_requires =
-  setuptools>=44.11.0
-  setuptools-scm~=7.1.0
-  wheel>=0.37.1
+  setuptools
+  setuptools-scm
+  wheel
 install_requires =
   fbtftp>=0.5
-  python-daemon>=3.0.1
+  python-daemon>=3.0.1; python_version>"3.6"
+  python-daemon==2.3.2; python_version=="3.6"
   pyyaml>=6.0
+  click>=8.0.4; python_version>"3.6"
+  click==8.0.4; python_version=="3.6"
+  importlib-resources==5.4.0; python_version=="3.6"
+  schema>=0.6.7; python_version>"3.6"
+  schema==0.6.7; python_version=="3.6"
 
 [options.extras_require]
 tests_require =
   pytest>=7.0.1
   pytest-mock>=3.6.1
+  pytest-cov>=4.1.0; python_version>"3.6"
+  pytest-cov==3.0.0; python_version=="3.6"
 lint_requires =
   pre-commit>=2.0.1
   black>=22.1.0

setup.py

@@ -1,6 +1,4 @@
-"""
-This file only serves to allow compatibility with legacy build tools
-"""
+"""File only serves to allow compatibility with legacy build tools."""
 
 from setuptools import setup
 

src/cobbler_tftp/__init__.py

@@ -1,4 +1 @@
-"""
-Cobbler-TFTP provides a stateless TFTP-Server to provide an alternative method of operations
-for cobbler-sync.
-"""
+"""Cobbler-TFTP provides a stateless TFTP-Server as an alternative method of operations for ``cobbler sync``."""

src/cobbler_tftp/exceptions/__init__.py

@@ -0,0 +1,9 @@
+"""Custom exceptions for cobbler-tftp."""
+
+
+class CobblerTftpException(Exception):
+    """Generic cobbler-tftp exception."""
+
+    def __init__(self, message: str = "CobblerTFTPException"):
+        """Create custom generic CobblerTFTPException."""
+        super().__init__(message)

src/cobbler_tftp/exceptions/settings_exceptions.py

@@ -0,0 +1,25 @@
+"""Custom exceptions for cobbler-tftp's settings module."""
+
+
+class CobblerTftpSettingsException(Exception):
+    """Generic cobbler-tftp exception."""
+
+    def __init__(self, message: str = "An Error occured!"):
+        """Create custom generic settings exception."""
+        super().__init__(message)
+
+
+class CobblerTftpMissingConfigParameterException(KeyError):
+    """Exception to handle a missing but required config parameter."""
+
+    def __init__(
+        self,
+        message="MissingConfigParameterException: Application settings missing required parameter!",
+        parameter: str = "NONE",
+    ):
+        """Create custom exception to raise when a specific config parameter is missing for the application settings."""
+        if parameter is None or parameter == "NONE":
+            raise ValueError("Parameter cannot be 'NONE'")
+        self.parameter = parameter
+        self.message = str.join(message, parameter)
+        super().__init__(message, parameter)