Merge pull request #605 from nofusscomputing/refactor-model-history

CONTRIBUTING.md

@@ -95,6 +95,34 @@ clear; \
 ```
 
 
+
+
+
+## Tips / Handy info
+
+- To obtain a list of models _(in in the same order as the file system)_ using the db shell `python3 manage.py dbshell` run the following sql command:
+
+    ``` sql
+
+    SELECT model FROM django_content_type ORDER BY app_label ASC, model ASC;
+
+    ```
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 # Old working docs
 
 

Release-Notes.md

@@ -1,3 +1,71 @@
+
+## Version 1.11.0
+
+**Note:** Migrations should be performed offline. **Failing to perform** an online migration, the option provided below will not be available if the migration crashes. Running the below commands to reset the database for the migrations to re-run will cause data loss if users are making changes to Centurion.
+
+- History views removed from original Centurion interface.
+
+- History views removed from API v1.
+
+- A migration exists that will move the history from the old tables to the new ones.
+
+    if for some reason the migration crashes enter the following commands in the dbshell `python manage.py dbshell` and restart the migrations
+
+    ``` sql
+
+    delete from access_organization_history;
+    delete from access_team_history;
+
+    delete from assistance_knowledge_base_history;
+    delete from assistance_knowledge_base_category_history;
+
+    delete from config_management_configgroups_history;
+    delete from config_management_configgroupsoftware_history;
+    delete from config_management_configgrouphosts_history;
+
+    delete from core_manufacturer_history;
+    delete from core_ticketcategory_history;
+    delete from core_ticketcommentcategory_history;
+
+    delete from itam_device_history;
+    delete from itam_devicemodel_history;
+    delete from itam_devicetype_history;
+    delete from itam_deviceoperatingsystem_history;
+    delete from itam_devicesoftware_history;
+    delete from itam_operatingsystem_history;
+    delete from itam_operatingsystemversion_history;
+    delete from itam_software_history;
+    delete from itam_softwareversion_history;
+    delete from itam_softwarecategory_history;
+
+    delete from itim_cluster_history;
+    delete from itim_clustertype_history;
+    delete from itim_port_history;
+    delete from itim_service_history;
+
+    delete from project_management_project_history;
+    delete from project_management_projectmilestone_history;
+    delete from project_management_projectstate_history;
+    delete from project_management_projecttype_history;
+    delete from settings_externallink_history;
+
+    delete from core_model_history;
+
+    ```
+
+    The above commands truncate the data from the new history tables so the migration can run again.
+
+
+## Version 1.10.0
+
+- Nothing significant to report
+
+
+## Version 1.9.0
+
+- Nothing significant to report
+
+
 ## Version 1.8.0
 
 - Prometheus exporter added. To enable metrics for the database you will have to update the database backend. see the [docs](https://nofusscomputing.com/projects/centurion_erp/administration/monitoring/#django-exporter-setup) for further information.

app/access/admin.py

@@ -2,7 +2,10 @@
 from django.contrib.auth.models import Group, User
 from django.contrib.auth.admin import UserAdmin
 
-from .models import *
+
+from access.models.organization import Organization
+from access.models.team import Team
+from access.models.team_user import TeamUsers
 
 admin.site.unregister(Group)
 

app/access/forms/organization.py

@@ -3,7 +3,7 @@
 
 from app import settings
 
-from access.models import Organization
+from access.models.organization import Organization
 
 from core.forms.common import CommonModelForm
 

app/access/forms/team.py

@@ -4,7 +4,7 @@
 
 from .team_users import TeamUsersForm, TeamUsers
 
-from access.models import Team
+from access.models.team import Team
 from access.functions import permissions
 
 from app import settings

app/access/forms/team_users.py

@@ -2,7 +2,7 @@
 
 from app import settings
 
-from access.models import TeamUsers
+from access.models.team_user import TeamUsers
 
 from core.forms.common import CommonModelForm
 

app/access/middleware/request.py

@@ -6,7 +6,10 @@
 from django.contrib.auth.models import User, Group
 from django.utils.deprecation import MiddlewareMixin
 
-from access.models import Organization, Team
+
+from access.models.organization import Organization
+from access.models.team import Team
+
 
 from settings.models.app_settings import AppSettings
 

app/access/migrations/0001_initial.py

@@ -44,7 +44,7 @@ class Migration(migrations.Migration):
                 ('team_name', models.CharField(default='', max_length=50, verbose_name='Name')),
                 ('created', access.fields.AutoCreatedField(default=django.utils.timezone.now, editable=False)),
                 ('modified', access.fields.AutoLastModifiedField(default=django.utils.timezone.now, editable=False)),
-                ('organization', models.ForeignKey(null=True, on_delete=django.db.models.deletion.CASCADE, to='access.organization', validators=[access.models.TenancyObject.validatate_organization_exists])),
+                ('organization', models.ForeignKey(null=True, on_delete=django.db.models.deletion.CASCADE, to='access.organization', validators=[access.models.tenancy.TenancyObject.validatate_organization_exists])),
             ],
             options={
                 'verbose_name_plural': 'Teams',

app/access/migrations/0002_alter_organization_options_alter_team_options_and_more.py

@@ -59,7 +59,7 @@ class Migration(migrations.Migration):
         migrations.AlterField(
             model_name='team',
             name='organization',
-            field=models.ForeignKey(help_text='Organization this belongs to', on_delete=django.db.models.deletion.CASCADE, to='access.organization', validators=[access.models.TenancyObject.validatate_organization_exists], verbose_name='Organization'),
+            field=models.ForeignKey(help_text='Organization this belongs to', on_delete=django.db.models.deletion.CASCADE, to='access.organization', validators=[access.models.tenancy.TenancyObject.validatate_organization_exists], verbose_name='Organization'),
         ),
         migrations.AlterField(
             model_name='team',

app/access/migrations/0003_alter_team_organization_organizationnotes_teamnotes.py

@@ -16,7 +16,7 @@ class Migration(migrations.Migration):
         migrations.AlterField(
             model_name='team',
             name='organization',
-            field=models.ForeignKey(help_text='Organization this belongs to', on_delete=django.db.models.deletion.CASCADE, to='access.organization', validators=[access.models.Team.validatate_organization_exists], verbose_name='Organization'),
+            field=models.ForeignKey(help_text='Organization this belongs to', on_delete=django.db.models.deletion.CASCADE, to='access.organization', validators=[access.models.team.Team.validatate_organization_exists], verbose_name='Organization'),
         ),
         migrations.CreateModel(
             name='OrganizationNotes',

app/access/migrations/0004_organizationhistory_teamhistory.py

@@ -0,0 +1,43 @@
+# Generated by Django 5.1.5 on 2025-02-19 13:32
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('access', '0003_alter_team_organization_organizationnotes_teamnotes'),
+        ('core', '0018_ticketcommentcategoryhistory'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='OrganizationHistory',
+            fields=[
+                ('modelhistory_ptr', models.OneToOneField(auto_created=True, on_delete=django.db.models.deletion.CASCADE, parent_link=True, primary_key=True, serialize=False, to='core.modelhistory')),
+                ('model', models.ForeignKey(help_text='Model this note belongs to', on_delete=django.db.models.deletion.CASCADE, related_name='history', to='access.organization', verbose_name='Model')),
+            ],
+            options={
+                'verbose_name': 'Organization History',
+                'verbose_name_plural': 'Organization History',
+                'db_table': 'access_organization_history',
+                'ordering': ['-created'],
+            },
+            bases=('core.modelhistory',),
+        ),
+        migrations.CreateModel(
+            name='TeamHistory',
+            fields=[
+                ('modelhistory_ptr', models.OneToOneField(auto_created=True, on_delete=django.db.models.deletion.CASCADE, parent_link=True, primary_key=True, serialize=False, to='core.modelhistory')),
+                ('model', models.ForeignKey(help_text='Model this note belongs to', on_delete=django.db.models.deletion.CASCADE, related_name='history', to='access.team', verbose_name='Model')),
+            ],
+            options={
+                'verbose_name': 'Team History',
+                'verbose_name_plural': 'Team History',
+                'db_table': 'access_team_history',
+                'ordering': ['-created'],
+            },
+            bases=('core.modelhistory',),
+        ),
+    ]

app/access/mixin.py

@@ -4,7 +4,9 @@
 from django.core.exceptions import PermissionDenied
 from django.utils.functional import cached_property
 
-from .models import Organization, Team
+from access.models.organization import Organization
+from access.models.team import Team
+
 
 
 class OrganizationMixin():

app/access/mixins/organization.py

@@ -1,7 +1,9 @@
 from django.contrib.auth.models import User, Group
 from django.db import models
 
-from access.models import Organization, Team
+from access.models.organization import Organization
+from access.models.team import Team
+
 
 
 class OrganizationMixin:

app/access/mixins/permissions.py

@@ -5,7 +5,7 @@
 from rest_framework import exceptions
 from rest_framework.permissions import DjangoObjectPermissions
 
-from access.models import TenancyObject
+from access.models.tenancy import TenancyObject
 
 from core import exceptions as centurion_exceptions