Testing

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.

User Interface (UI) test are written if applicable to test the user interface to ensure that it functions as it should. Changes to the UI will need to be tested.

In most cases functional tests will not need to be written, however you should confirm this with a maintainer.

Integration tests will be required if the development introduces code that interacts with an independent third-party application.

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 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.

Test cases themselves are written within the test class within an appropriately and uniquely named method. Each test case is to test one and only one item.

Example of a model history test class.

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 showing the layout of the tests directory for a module.

.
├── tests
│   ├── functional
│   │   ├── __init__.py
│   │   └── <model name>
│   │       └── test_<model name>_a_tast_name.py
│   ├── __init__.py
│   ├── integration
│   │   ├── __init__.py
│   │   └── <model name>
│   │       └── test_<model name>_a_tast_name.py
│   ├── ui
│   │   ├── __init__.py
│   │   └── <model name>
│   │       └── test_<model name>_a_tast_name.py
│   └── unit
│       ├── __init__.py
│       └── <model name>
│           ├── test_<model name>_api.py
│           ├── test_<model name>_permission_api.py
│           ├── test_<model name>_permission.py
│           ├── test_<model name>_core_history.py
│           ├── test_<model name>_history_permission.py
│           ├── test_<model name>.py
│           └── test_<model name>_views.py

Tests are broken up into the type the test is (sub-directory to test), and they are unit, functional, UI and integration. These sub-directories each contain a sub-directory for each model they are testing.

Items to test include, and are not limited to:

CRUD permissions admin site
CRUD permissions api site - ModelPermissions (API)
CRUD permissions main site - ModelPermissions
can only access organization object - ModelPermissions, ModelPermissions (API)
can access global object (still to require model CRUD permission)
history - History Entries, History Permissions
- saves history with parent pk and parent class
  
  add to model class the following
```
@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.
model - any customizations
notes - Notes Permissions

applicable if notes are able to be added to an item.
API Fields

Field exists, Type is checked

Running Tests

Test can be run by running the following:

pip install -r requirements_test.txt -r requirements.txt
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.

About:

This page forms part of our Project Centurion ERP.

Page Metadata

Version: ToDo: place files short git commit here
Date Created: 2024-06-17
Date Edited: 2024-08-31

Contribution:

Would You like to contribute to our Centurion ERP project? You can assist in the following ways:

Edit This Page If there is a mistake or a way you can improve it.
Add a Page to the Manual if you would like to add an item to our manual
Raise an Issue if there is something about this page you would like to improve, and git is unfamiliar to you.

ToDo: Add the page list of contributors