nofusscomputing/centurion_erp
1
0
Fork 0
Code Issues Wiki Activity

revert(core): Relocate history model class

Browse Source 
reverted commit was 5cc08e3e94

ref: #765 #766
This commit is contained in:
Jon Lockwood
2025-05-20 05:52:38 +09:30
parent 9d7a3e2e79
commit 2c33fa6f62
5 changed files with 204 additions and 385 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
app/core/migrations/0024_alter_modelhistory_options_and_more.py
View File

@ -1,57 +0,0 @@
# Generated by Django 5.1.9 on 2025-05-16 18:48
import core.models.centurion
import django.db.models.deletion
from django.conf import settings
from django.db import migrations, models
class Migration(migrations.Migration):
dependencies = [
('access', '0010_company_alter_entity_entity_type_alter_person_dob_and_more'),
('contenttypes', '0002_remove_content_type_name'),
('core', '0023_ticketcommentaction_alter_manufacturer_organization_and_more'),
migrations.swappable_dependency(settings.AUTH_USER_MODEL),
]
operations = [
migrations.AlterModelOptions(
name='modelhistory',
options={'ordering': ['-created'], 'verbose_name': 'Model History', 'verbose_name_plural': 'Model Histories'},
),
migrations.RemoveField(
model_name='modelhistory',
name='is_global',
),
migrations.AlterField(
model_name='modelhistory',
name='action',
field=models.IntegerField(choices=[(1, 'Create'), (2, 'Update'), (3, 'Delete')], default=None, help_text='History action performed', null=True, validators=[core.models.centurion.CenturionModel.validate_field_not_none], verbose_name='Action'),
),
migrations.AlterField(
model_name='modelhistory',
name='after',
field=models.JSONField(blank=True, default=None, help_text='Value Change to', null=True, validators=[core.models.centurion.CenturionModel.validate_field_not_none], verbose_name='After'),
),
migrations.AlterField(
model_name='modelhistory',
name='before',
field=models.JSONField(blank=True, default=None, help_text='Value before Change', null=True, validators=[core.models.centurion.CenturionModel.validate_field_not_none], verbose_name='Before'),
),
migrations.AlterField(
model_name='modelhistory',
name='content_type',
field=models.ForeignKey(blank=True, help_text='Model this history is for', on_delete=django.db.models.deletion.CASCADE, to='contenttypes.contenttype', validators=[core.models.centurion.CenturionModel.validate_field_not_none], verbose_name='Content Model'),
),
migrations.AlterField(
model_name='modelhistory',
name='organization',
field=models.ForeignKey(help_text='Tenancy this belongs to', null=True, on_delete=django.db.models.deletion.CASCADE, related_name='+', to='access.tenant', validators=[core.models.centurion.CenturionModel.validate_field_not_none], verbose_name='Tenant'),
),
migrations.AlterField(
model_name='modelhistory',
name='user',
field=models.ForeignKey(help_text='User whom performed the action', null=True, on_delete=django.db.models.deletion.DO_NOTHING, to=settings.AUTH_USER_MODEL, verbose_name='User'),
),
]

268
app/core/models/audit.py
View File

@ -1,268 +0,0 @@
from django.conf import settings
from django.contrib.auth.models import ContentType
from django.db import models
from rest_framework.reverse import reverse
from access.fields import AutoCreatedField
from access.models.tenant import Tenant
from access.models.tenancy import TenancyObject
from core.models.centurion import (
CenturionModel,
)
from core.lib.feature_not_used import FeatureNotUsed
class ModelHistoryOld:
""" Old Model History
This class exists until the other models that rely upon these attributes
and functions are refactored to not rely upon these functions.
"""
save_model_history: bool = False
model_notes = None
is_global = None
child_history_models = [
'configgrouphostshistory',
'configgroupsoftwarehistory',
'deviceoperatingsystemhistory',
'devicesoftwarehistory',
'projectmilestonehistory',
]
"""Child History Models
This list is currently used for excluding child models from the the history
select_related query.
Returns:
list: Child history models.
"""
page_layout: list = []
table_fields: list = [
'created',
'action',
'content',
'user',
'nbsp',
[
'before',
'after'
]
]
def get_related_field_name(self, model) -> str:
meta = getattr(model, '_meta')
for related_object in getattr(meta, 'related_objects', []):
if getattr(model, related_object.name, None):
return related_object.name
# return related_field_name
return ''
def get_serialized_model_field(self, context):
model = None
model = getattr(self, self.get_related_field_name( self ))
model = model.get_serialized_model(context).data
return model
def get_serialized_child_model_field(self, context):
model = {}
parent_model = getattr(self, self.get_related_field_name( self ))
child_model = getattr(parent_model, self.get_related_field_name( parent_model ), None)
if child_model is not None:
model = child_model.get_serialized_child_model(context).data
return model
def get_url_kwargs(self) -> dict:
parent_model = getattr(self, self.get_related_field_name( self ))
return {
'app_label': parent_model.model._meta.app_label,
'model_name': parent_model.model._meta.model_name,
'model_id': parent_model.model.pk,
'pk': parent_model.pk
}
def get_url_kwargs_notes(self):
return FeatureNotUsed
def get_url( self, request = None ) -> str:
if request:
return reverse(f"v2:_api_v2_model_history-detail", request=request, kwargs = self.get_url_kwargs() )
return reverse(f"v2:_api_v2_model_history-detail", kwargs = self.get_url_kwargs() )
# class CenturionAudit(
class ModelHistory(
ModelHistoryOld,
TenancyObject,
):
"""Centurion Audit History
This model is responsible for recording change to a model. The saving of
model history is via the `delete` and `save` signals
Args:
ModelHistoryOld (_type_): Old Model attributes and functions due for removal.
CenturionModel (_type_): Centurion Model attributes, functions and method
TenancyObject (_type_): Centurion Tenancy Abstract model.
"""
_audit_enabled: bool = False
"""Don't Save audit history for audit history model"""
class Meta:
# db_table = 'centurion_audit'
db_table = 'core_model_history'
ordering = [
'-created'
]
verbose_name = 'Model History'
verbose_name_plural = 'Model Histories'
id = models.AutoField(
blank=False,
help_text = 'ID of the item',
primary_key=True,
unique=True,
verbose_name = 'ID'
)
organization = models.ForeignKey(
Tenant,
blank = False,
help_text = 'Tenancy this belongs to',
null = True,
on_delete = models.CASCADE,
related_name = '+',
# validators = [
# CenturionModel.validate_field_not_none,
# ],
verbose_name = 'Tenant'
)
content_type = models.ForeignKey(
ContentType,
blank= True,
help_text = 'Model this history is for',
null = False,
on_delete = models.CASCADE,
# validators = [
# CenturionModel.validate_field_not_none,
# ],
verbose_name = 'Content Model'
)
before = models.JSONField(
blank = True,
default = None,
help_text = 'Value before Change',
null = True,
# validators = [
# CenturionModel.validate_field_not_none,
# ],
verbose_name = 'Before'
)
after = models.JSONField(
blank = True,
default = None,
help_text = 'Value Change to',
null = True,
# validators = [
# CenturionModel.validate_field_not_none,
# ],
verbose_name = 'After'
)
class Actions(models.IntegerChoices):
ADD = 1, 'Create'
UPDATE = 2, 'Update'
DELETE = 3, 'Delete'
action = models.IntegerField(
blank = False,
choices = Actions,
default = None,
help_text = 'History action performed',
null = True,
# validators = [
# CenturionModel.validate_field_not_none,
# ],
verbose_name = 'Action'
)
user = models.ForeignKey(
settings.AUTH_USER_MODEL,
blank = False,
help_text = 'User whom performed the action',
null = True,
on_delete = models.DO_NOTHING,
# validators = [
# CenturionModel.validate_field_not_none,
# ],
verbose_name = 'User'
)
created = AutoCreatedField(
editable = True
)
page_layout: list = []
table_fields: list = [
'created',
'action',
'content',
'user',
'nbsp',
[
'before',
'after'
]
]

55
app/core/models/centurion.py
View File

@ -1,55 +0,0 @@
from django.db import models
from django.core.exceptions import (
ValidationError
)
class CenturionModel(
models.Model
):
_audit_enabled: bool = True
"""Should this model have audit history kept"""
_is_submodel: bool = False
"""This model a sub-model"""
class Meta:
abstract = True
@staticmethod
def validate_field_not_none(value):
if value is None:
raise ValidationError(code = 'field_value_not_none', message = 'Value can not be none.')
def get_history_model_name(self) -> str:
"""Get the name for the History Model
Returns:
str: Name of the history model (`<model class name>AuditHistory`)
"""
return f'{self._meta.object_name}AuditHistory'
class CenturionSubModel(
CenturionModel
):
_is_submodel: bool = True
"""This model a sub-model"""
class Meta:
abstract = True

205
app/core/models/model_history.py
View File

@ -1,3 +1,202 @@
from core.models.audit import ( # pylint: disable=W0611:unused-import
ModelHistory
)
import django
from django.conf import settings
from django.contrib.auth.models import ContentType
from django.db import models
from rest_framework.reverse import reverse
from access.fields import AutoCreatedField
from access.models.tenant import Tenant
from access.models.tenancy import TenancyObject
from core.lib.feature_not_used import FeatureNotUsed
User = django.contrib.auth.get_user_model()
class ModelHistory(
TenancyObject
):
save_model_history: bool = False
class Meta:
db_table = 'core_model_history'
ordering = [
'-created'
]
verbose_name = 'History'
verbose_name_plural = 'History'
class Actions(models.IntegerChoices):
ADD = 1, 'Create'
UPDATE = 2, 'Update'
DELETE = 3, 'Delete'
model_notes = None # model notes not required for this model
before = models.JSONField(
blank = True,
default = None,
help_text = 'JSON Object before Change',
null = True,
verbose_name = 'Before'
)
after = models.JSONField(
blank = True,
default = None,
help_text = 'JSON Object After Change',
null = True,
verbose_name = 'After'
)
action = models.IntegerField(
blank = False,
choices=Actions,
default=None,
help_text = 'History action performed',
null=True,
verbose_name = 'Action'
)
organization = models.ForeignKey(
Tenant,
blank = False,
help_text = 'Tenant this belongs to',
null = True,
on_delete = models.CASCADE,
related_name = '+',
verbose_name = 'Tenant'
)
user = models.ForeignKey(
settings.AUTH_USER_MODEL,
blank= False,
help_text = 'User whom performed the action this history relates to',
null = True,
on_delete=models.DO_NOTHING,
verbose_name = 'User'
)
content_type = models.ForeignKey(
ContentType,
blank= True,
help_text = 'Model this note is for',
null = False,
on_delete=models.CASCADE,
verbose_name = 'Content Model'
)
created = AutoCreatedField(
editable = True
)
child_history_models = [
'configgrouphostshistory',
'configgroupsoftwarehistory',
'deviceoperatingsystemhistory',
'devicesoftwarehistory',
'projectmilestonehistory',
]
"""Child History Models
This list is currently used for excluding child models from the the history
select_related query.
Returns:
list: Child history models.
"""
page_layout: list = []
table_fields: list = [
'created',
'action',
'content',
'user',
'nbsp',
[
'before',
'after'
]
]
def get_related_field_name(self, model) -> str:
meta = getattr(model, '_meta')
for related_object in getattr(meta, 'related_objects', []):
if getattr(model, related_object.name, None):
return related_object.name
# return related_field_name
return ''
def get_serialized_model_field(self, context):
model = None
model = getattr(self, self.get_related_field_name( self ))
model = model.get_serialized_model(context).data
return model
def get_serialized_child_model_field(self, context):
model = {}
parent_model = getattr(self, self.get_related_field_name( self ))
child_model = getattr(parent_model, self.get_related_field_name( parent_model ), None)
if child_model is not None:
model = child_model.get_serialized_child_model(context).data
return model
def get_url_kwargs(self) -> dict:
parent_model = getattr(self, self.get_related_field_name( self ))
return {
'app_label': parent_model.model._meta.app_label,
'model_name': parent_model.model._meta.model_name,
'model_id': parent_model.model.pk,
'pk': parent_model.pk
}
def get_url_kwargs_notes(self):
return FeatureNotUsed
def get_url( self, request = None ) -> str:
if request:
return reverse(f"v2:_api_v2_model_history-detail", request=request, kwargs = self.get_url_kwargs() )
return reverse(f"v2:_api_v2_model_history-detail", kwargs = self.get_url_kwargs() )

4
app/core/tests/unit/centurion_audit/conftest.py
View File

@ -1,13 +1,13 @@
import pytest
from core.models.audit import ModelHistory
from core.models.audit import CenturionAudit
@pytest.fixture( scope = 'class')
def model(request):
request.cls.model = ModelHistory
request.cls.model = CenturionAudit
yield request.cls.model