Import/Reimport Stats: Change name of left untouched (#12193)

* Import/Reimport Stats: Change name of left untouched

* Update migrations

* Failed spell check

* Update migration again

* Migrate from `left_untouched` to `untouched`

Author: Maffooch

docs/content/en/open_source/upgrading/2.46.md

@@ -2,6 +2,41 @@
 title: 'Upgrading to DefectDojo Version 2.46.x'
 toc_hide: true
 weight: -20250407
-description: No special instructions.
+description: Import Payload Changes
 ---
-There are no special instructions for upgrading to 2.46.x. Check the [Release Notes](https://github.com/DefectDojo/django-DefectDojo/releases/tag/2.46.0) for the contents of the release.
+
+### Import / Reimport Statistics Delta
+
+Following a successful import or reimport, a JSON blob for `statistics` is generated to provide the differential of finding activity.
+There was a section in the `delta` JSON blob that referred to a key labeled `left untouched`. This value does not comply with REST
+norms, and has been renamed to `untouched`. Here is a before and after to make it clear:
+
+Before:
+
+    "statistics": {
+        "before": {},
+        "delta": {
+        "created": {},
+        "closed": {},
+        "reactivated": {},
+        "left untouched": {}
+        },
+        "after": {}
+    }
+
+After:
+
+    "statistics": {
+        "before": {},
+        "delta": {
+        "created": {},
+        "closed": {},
+        "reactivated": {},
+        "untouched": {}
+        },
+        "after": {}
+    }
+
+---
+
+Check the [Release Notes](https://github.com/DefectDojo/django-DefectDojo/releases/tag/2.46.0) for the contents of the release.

dojo/db_migrations/0226_import_history_left_untouched_rename.py

@@ -0,0 +1,42 @@
+# Generated by Django 5.0.8 on 2024-09-12 18:22
+
+from django.db import migrations, models
+
+
+original_untouched_value = "left untouched"
+updated_untouched_value = "untouched"
+
+
+def convert_space_to_underscore(apps, schema_editor):
+    test_import_finding_action = apps.get_model("dojo", "Test_Import_Finding_Action")
+    for test_import_action in test_import_finding_action.objects.filter(
+        action=original_untouched_value
+    ):
+        test_import_action.action = updated_untouched_value
+        test_import_action.save()
+
+
+def convert_underscore_to_space(apps, schema_editor):
+    test_import_finding_action = apps.get_model("dojo", "Test_Import_Finding_Action")
+    for test_import_action in test_import_finding_action.objects.filter(
+        action=updated_untouched_value
+    ):
+        test_import_action.action = original_untouched_value
+        test_import_action.save()
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("dojo", "0225_alter_product_revenue"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='test_import_finding_action',
+            name='action',
+            field=models.CharField(blank=True, choices=[('N', 'created'), ('C', 'closed'), ('R', 'reactivated'), ('U', 'untouched')], max_length=100, null=True),
+        ),
+        migrations.RunPython(
+            convert_space_to_underscore, reverse_code=convert_underscore_to_space
+        ),
+    ]

dojo/models.py

@@ -67,7 +67,7 @@
     (IMPORT_CREATED_FINDING, "created"),
     (IMPORT_CLOSED_FINDING, "closed"),
     (IMPORT_REACTIVATED_FINDING, "reactivated"),
-    (IMPORT_UNTOUCHED_FINDING, "left untouched"),
+    (IMPORT_UNTOUCHED_FINDING, "untouched"),
 ]
 
 

unittests/test_import_reimport.py

@@ -1554,7 +1554,7 @@ def test_import_0_reimport_1_active_verified_reimport_0_active_verified_statisti
                     "low": {"active": 1, "duplicate": 0, "false_p": 0, "is_mitigated": 0, "out_of_scope": 0, "risk_accepted": 0, "total": 1, "verified": 0},
                     "medium": {"active": 0, "duplicate": 0, "false_p": 0, "is_mitigated": 0, "out_of_scope": 0, "risk_accepted": 0, "total": 0, "verified": 0},
                     "total": {"active": 1, "duplicate": 0, "false_p": 0, "is_mitigated": 0, "out_of_scope": 0, "risk_accepted": 0, "total": 1, "verified": 0}},
-                "left untouched": {
+                "untouched": {
                     "critical": {"active": 0, "duplicate": 0, "false_p": 0, "is_mitigated": 0, "out_of_scope": 0, "risk_accepted": 0, "total": 0, "verified": 0},
                     "high": {"active": 0, "duplicate": 0, "false_p": 0, "is_mitigated": 0, "out_of_scope": 0, "risk_accepted": 0, "total": 0, "verified": 0},
                     "info": {"active": 0, "duplicate": 0, "false_p": 0, "is_mitigated": 0, "out_of_scope": 0, "risk_accepted": 0, "total": 0, "verified": 0},
@@ -1604,7 +1604,7 @@ def test_import_0_reimport_1_active_verified_reimport_0_active_verified_statisti
                     "low": {"active": 0, "duplicate": 0, "false_p": 0, "is_mitigated": 0, "out_of_scope": 0, "risk_accepted": 0, "total": 0, "verified": 0},
                     "medium": {"active": 0, "duplicate": 0, "false_p": 0, "is_mitigated": 0, "out_of_scope": 0, "risk_accepted": 0, "total": 0, "verified": 0},
                     "total": {"active": 0, "duplicate": 0, "false_p": 0, "is_mitigated": 0, "out_of_scope": 0, "risk_accepted": 0, "total": 0, "verified": 0}},
-                "left untouched": {
+                "untouched": {
                     "critical": {"active": 0, "duplicate": 0, "false_p": 0, "is_mitigated": 0, "out_of_scope": 0, "risk_accepted": 0, "total": 0, "verified": 0},
                     "high": {"active": 0, "duplicate": 0, "false_p": 0, "is_mitigated": 0, "out_of_scope": 0, "risk_accepted": 0, "total": 0, "verified": 0},
                     "info": {"active": 0, "duplicate": 0, "false_p": 0, "is_mitigated": 0, "out_of_scope": 0, "risk_accepted": 0, "total": 0, "verified": 0},