docs(development): Add test case documentation

!27 #15 nofusscomputing/infrastructure/website-template!16 nofusscomputing/projects/django_template#57 nofusscomputing/projects/gitlab-ci!83

docs/projects/django-template/development/api/index.md

@@ -0,0 +1,14 @@
+---
+title: API Documentation
+description: No Fuss Computings API Documentation for application development
+date: 2024-06-15
+template: project.html
+about: https://gitlab.com/nofusscomputing/infrastructure/configuration-management/django_app
+---
+
+This section contains the application API documentation to assist in application development. The target audience is anyone whom would be developing the application.
+
+
+## Testing
+
+- [Unit Testing](tests/index.md)

docs/projects/django-template/development/api/tests/index.md

@@ -0,0 +1,126 @@
+---
+title: Unit Tests
+description: No Fuss Computings django itsm unit tests
+date: 2024-06-15
+template: project.html
+about: https://gitlab.com/nofusscomputing/infrastructure/configuration-management/django_app
+---
+
+Unit tests are written to aid in application stability and to assist in preventing regression bugs. As part of development the developer working on a Merge/Pull request is to ensure that tests are written. Failing to do so will more likely than not ensure that your Merge/Pull request is not merged.
+
+
+## Writing Tests
+
+We use class based tests. Each class will require a `setUpTestData` method for test setup. To furhter assist in the writing of tests, we have written the test cases for common items as an abstract class. You are advised to review the [test cases](#test-cases) and if it's applicable to the item you have added, than add the test case class to be inherited by your test class.
+
+naming of test classes is in `CamelCase` in format `<Model Name><what's being tested>` for example the class name for device model history entry tests would be `DeviceHistory`.
+
+Test setup is written in a method called `setUpTestData` and is to contain the setup for all tests within the test class.
+
+Example of a model history test class.
+``` py
+
+import pytest
+import unittest
+import requests
+
+from django.test import TestCase, Client
+
+from core.models.history import History
+from core.tests.abstract.history_entry import HistoryEntry
+from core.tests.abstract.history_entry_parent_model import HistoryEntryParentItem
+
+
+
+class DeviceHistory(TestCase, HistoryEntry, HistoryEntryParentItem):
+
+
+    model = Device
+
+
+    @classmethod
+    def setUpTestData(self):
+        """ Setup Test """
+
+```
+
+Each module is to contain a tests directory of the model being tested with a single file for grouping of what is being tested. for items that depend upon a parent model, the test file is to be within the child-models test directory named with format `test_<model>_<parent app>_<parent model name>`
+
+_example file system structure for the device model that relies upon access app model organization, core app model history and model notes._
+
+``` text
+
+├── tests
+│   ├── <model name>
+│   │   ├── test_<model name>_access_organization.py
+│   │   ├── test_<model name>_api_permission.py
+│   │   ├── test_<model name>_core_history.py
+│   │   ├── test_<model name>_core_notes.py
+│   │   ├── test_<model name>_permission.py
+│   │   └── test_device.py
+
+
+```
+
+Items to test include, and are not limited to:
+
+- CRUD permissions admin site
+
+- CRUD permissions api site
+
+- CRUD permissions main site
+
+- can only access organization object
+
+- can access global object (still to require model CRUD permission)
+
+- model
+
+- history
+
+    - saves history with parent pk and parent class
+
+        add to model class the following
+        ``` py
+
+        @property
+        def parent_object(self):
+            """ Fetch the parent object """
+            
+            return self.<item that is the parent>
+
+        ```
+
+        history should now be auto saved as long as class `core.mixin.history_save.SaveHistory` is inherited by model.
+
+    - history is deleted when item deleted if `parent_pk=None` or if has `parent_pk` deletes history on parent pk being deleted.
+
+
+## Running Tests
+
+Test can be run by running the following:
+
+1. `pip install -r requirements_test.txt -r requirements.txt`
+
+1. `pytest --cov --cov-report html --cov=./`
+
+If your developing using VSCode/VSCodium the testing is available as is the ability to attach a debugger to the test.
+
+
+## Test Cases
+
+Models are tested using the following test cases:
+
+- [Add Permission](./model_permission_add.md)
+
+- [Change Permission](./model_permission_change.md)
+
+- [Delete Permission](./model_permission_delete.md)
+
+- [View Permission](./model_permission_view.md)
+
+- [History Entry](./model_history.md)
+
+- [History Entry (Child Item)](./model_history_child_item.md)
+
+- [History Entry (Parent Item)](./model_history_parent_item.md)

docs/projects/django-template/development/api/tests/model_history.md

@@ -0,0 +1,9 @@
+---
+title: History Entry Test Cases
+description: No Fuss Computings model history entry unit test cases
+date: 2024-06-15
+template: project.html
+about: https://gitlab.com/nofusscomputing/infrastructure/configuration-management/django_app
+---
+
+::: app.core.tests.abstract.history_entry.HistoryEntry

docs/projects/django-template/development/api/tests/model_history_child_item.md

@@ -0,0 +1,9 @@
+---
+title: Child Item History Entry Test Cases
+description: No Fuss Computings model child item history entry unit test cases
+date: 2024-06-15
+template: project.html
+about: https://gitlab.com/nofusscomputing/infrastructure/configuration-management/django_app
+---
+
+::: app.core.tests.abstract.history_entry_child_model.HistoryEntryChildItem

docs/projects/django-template/development/api/tests/model_history_parent_item.md

@@ -0,0 +1,9 @@
+---
+title: Parent Item History Entry Test Cases
+description: No Fuss Computings model parent item history entry unit test cases
+date: 2024-06-15
+template: project.html
+about: https://gitlab.com/nofusscomputing/infrastructure/configuration-management/django_app
+---
+
+::: app.core.tests.abstract.history_entry_parent_model.HistoryEntryParentItem

docs/projects/django-template/development/api/tests/model_permission_add.md

@@ -0,0 +1,9 @@
+---
+title: Model Permissions Add Test Cases
+description: No Fuss Computings model permissions add unit tests
+date: 2024-06-15
+template: project.html
+about: https://gitlab.com/nofusscomputing/infrastructure/configuration-management/django_app
+---
+
+::: app.app.tests.abstract.model_permissions.ModelPermissionsAdd

docs/projects/django-template/development/api/tests/model_permission_change.md

@@ -0,0 +1,9 @@
+---
+title: Model Permissions Change Test Cases
+description: No Fuss Computings model permissions change unit tests
+date: 2024-06-15
+template: project.html
+about: https://gitlab.com/nofusscomputing/infrastructure/configuration-management/django_app
+---
+
+::: app.app.tests.abstract.model_permissions.ModelPermissionsChange

docs/projects/django-template/development/api/tests/model_permission_delete.md

@@ -0,0 +1,9 @@
+---
+title: Model Permissions Delete Test Cases
+description: No Fuss Computings model permissions delete unit tests
+date: 2024-06-15
+template: project.html
+about: https://gitlab.com/nofusscomputing/infrastructure/configuration-management/django_app
+---
+
+::: app.app.tests.abstract.model_permissions.ModelPermissionsDelete

docs/projects/django-template/development/api/tests/model_permission_view.md

@@ -0,0 +1,9 @@
+---
+title: Model Permissions View Test Cases
+description: No Fuss Computings model permissions view unit tests
+date: 2024-06-15
+template: project.html
+about: https://gitlab.com/nofusscomputing/infrastructure/configuration-management/django_app
+---
+
+::: app.app.tests.abstract.model_permissions.ModelPermissionsView

docs/projects/django-template/development/index.md

@@ -1,6 +1,6 @@
 ---
 title: Django Template Devlopment
-description: No Fuss Computings NetBox Django Site Template Development
+description: No Fuss Computings Django Site Template Development
 date: 2024-05-17
 template: project.html
 about: https://gitlab.com/nofusscomputing/infrastructure/configuration-management/django_app