Entity justification

.pylintrc

@@ -1,3 +1,5 @@
 [MASTER]
 ignore=manage.py
 ignore-paths=vran/migrations
+load-plugins=pylint_django
+django-settings-module=tests.settings

django_project/settings/settings_test.py

@@ -9,6 +9,7 @@
 For the full list of settings and their values, see
 https://docs.djangoproject.com/en/4.1/ref/settings/
 """
+
 # pylint: disable=duplicate-code
 
 from os import environ
@@ -85,7 +86,7 @@ def get_file_secret(secret_name):
     "django.contrib.sessions",
     "django.contrib.messages",
     "django.contrib.staticfiles",
-    # "django.contrib.postgres",
+    "django.contrib.postgres",
     "corsheaders",
     "django_rq",
     "vran",

pyproject.toml

@@ -31,6 +31,7 @@ requests = "^2.28.1"
 python-dotenv = "^0.21.0"
 pytest-redis = "^3.0.2"
 pip = "^24.0"
+pylint-django = "^2.5.5"
 
 [build-system]
 requires = ["poetry-core"]

tests/conftest.py

@@ -11,7 +11,7 @@
 from tests.tag import common as ct
 from tests.user import common as cu
 from tests.user.api.integration.requests import post_login, post_register
-from vran.entity.models_django import Entity
+from vran.entity.models_django import Entity, EntityJustification
 from vran.management.display_txt.util import DISPLAY_TXT_ORDER_CONFIG_KEY
 from vran.management.models_django import ConfigValue
 from vran.tag.models_django import TagDefinition, TagDefinitionHistory
@@ -66,6 +66,28 @@ def entity2(user1):
     return entity
 
 
+@pytest.fixture()
+def justification0(user):
+    EntityJustification.add(
+        ce.id_justification_0,
+        ce.id_persistent_test_0,
+        ce.justification_0,
+        ce.time_justification_0,
+        user,
+    )
+
+
+@pytest.fixture()
+def justification1(user1):
+    EntityJustification.add(
+        ce.id_justification_1,
+        ce.id_persistent_test_1,
+        ce.justification_1,
+        ce.time_justification_1,
+        user1,
+    )
+
+
 @pytest.fixture()
 def tag_def(user):
     return TagDefinitionHistory.objects.create(  # pylint: disable=no-member

tests/contribution/api/integration/common.py

@@ -1,5 +1,5 @@
 # pylint: disable=missing-module-docstring, missing-function-docstring,redefined-outer-name,invalid-name,disable=unused-argument
-from datetime import datetime
+from datetime import datetime, timezone
 
 import tests.contribution.common as c
 import tests.user.common as cu
@@ -25,6 +25,7 @@
     "error_msg": None,
     "error_details": None,
     "empty_values": "null,nan,na",
+    "justification_txt": None,
 }
 
 contribution_test_upload1 = {
@@ -36,6 +37,7 @@
     "error_msg": None,
     "error_details": None,
     "empty_values": "null,nan,na",
+    "justification_txt": None,
 }
 
 tag_def_test0 = {
@@ -55,4 +57,4 @@
 }
 
 id_tag_merge_request_persistent = "ab6a456e-4560-458b-9f8d-864bdcccc904"
-time_edit_tag_merge_request = datetime(2020, 2, 3)
+time_edit_tag_merge_request = datetime(2020, 2, 3, tzinfo=timezone.utc)

tests/contribution/api/integration/get_contribution_test.py

@@ -109,4 +109,5 @@ def test_get_with_error(auth_server, contribution_error):
         "error_details": contribution_error.error_trace,
         "match_tag_definition_list": [],
         "empty_values": "null,nan,na",
+        "justification_txt": None,
     }

tests/contribution/conftest.py

@@ -88,6 +88,17 @@ def contribution_tag_def_assigned(contribution_user, tag_def):
     )
 
 
+@pytest.fixture
+def contribution_tag_def_assigned_justification(contribution_user, tag_def):
+    return TagDefinitionContribution.objects.create(  # pylint:disable=no-member
+        name=c.name_definition_test0,
+        id_persistent=c.id_persistent_tag_def_test0,
+        contribution_candidate=contribution_user,
+        index_in_file=9000,
+        id_existing_persistent="justification",
+    )
+
+
 @pytest.fixture
 def contribution_tag_def_assigned_display_txt(contribution_user, tag_def):
     return TagDefinitionContribution.objects.create(  # pylint:disable=no-member

tests/contribution/entity/api/integration/get_chunks_test.py

@@ -43,6 +43,7 @@ def test_get_chunk(auth_server, contribution_candidate, entities):
                     "display_txt": c.display_txt_test_entity_duplicate,
                     "display_txt_details": "Display Text",
                     "disabled": False,
+                    "justification_txt": None,
                 }
             ]
         },

tests/contribution/entity/api/integration/put_duplicate_test.py

@@ -5,20 +5,24 @@
 import tests.contribution.entity.common as c
 import tests.entity.common as ce
 from vran.contribution.entity.models_django import EntityDuplicate
+from vran.contribution.models_django import ContributionCandidate
+from vran.entity.models_django import EntityJustification
+
+justification = "justification for entity"
 
 
 def test_no_cookies(auth_server):
     live_server, _ = auth_server
     rsp = r.put_duplicate(
-        live_server.url, "contribution_id", "id_origin", "id_destination", []
+        live_server.url, "contribution_id", "id_origin", "id_destination", cookies=None
     )
     assert rsp.status_code == 401
 
 
 def test_no_candidate(auth_server):
     live_server, cookies = auth_server
     rsp = r.put_duplicate(
-        live_server.url, str(uuid4()), "id_origin", "id_destination", cookies
+        live_server.url, str(uuid4()), "id_origin", "id_destination", cookies=cookies
     )
     assert rsp.status_code == 404
 
@@ -30,7 +34,7 @@ def test_unknown_entities(auth_server, contribution_candidate):
         contribution_candidate.id_persistent,
         "id_origin",
         "id_destination",
-        cookies,
+        cookies=cookies,
     )
     assert rsp.status_code == 404
     assert rsp.json() == {"msg": "One of the entities does not exist."}
@@ -43,30 +47,127 @@ def test_put_duplicate(auth_server, contribution_candidate, entities):
         contribution_candidate.id_persistent,
         c.id_persistent_entity_duplicate_test,
         ce.id_persistent_test_0,
-        cookies,
+        cookies=cookies,
     )
     assert rsp.status_code == 200
     duplicate = EntityDuplicate.objects.all().get()  # pylint: disable=no-member
     assert duplicate.id_origin_persistent == c.id_persistent_entity_duplicate_test
     assert duplicate.id_destination_persistent == ce.id_persistent_test_0
 
 
+def test_put_none_no_justification(auth_server, contribution_candidate, entities):
+    live_server, cookies = auth_server
+    rsp = r.put_duplicate(
+        live_server.url,
+        contribution_candidate.id_persistent,
+        c.id_persistent_entity_duplicate_test,
+        None,
+        cookies=cookies,
+    )
+    assert rsp.status_code == 400
+    assert len(EntityDuplicate.objects.all()) == 0  # pylint: disable=no-member
+
+
+def test_put_none_with_justification(auth_server, contribution_candidate, entities):
+    live_server, cookies = auth_server
+    rsp = r.put_duplicate(
+        live_server.url,
+        contribution_candidate.id_persistent,
+        c.id_persistent_entity_duplicate_test,
+        None,
+        justification=justification,
+        cookies=cookies,
+    )
+    assert rsp.status_code == 200
+    assert len(EntityDuplicate.objects.all()) == 0  # pylint: disable=no-member
+    justification_db = EntityJustification.for_id_entity_persistent_unordered(
+        c.id_persistent_entity_duplicate_test
+    ).get()
+    assert justification_db.text == justification
+
+
+def test_keep_justification(auth_server, contribution_candidate, entities):
+    live_server, cookies = auth_server
+    rsp = r.put_duplicate(
+        live_server.url,
+        contribution_candidate.id_persistent,
+        c.id_persistent_entity_duplicate_test,
+        None,
+        justification=justification,
+        keep_justification_for_all=True,
+        cookies=cookies,
+    )
+    assert rsp.status_code == 200
+    assert len(EntityDuplicate.objects.all()) == 0  # pylint: disable=no-member
+    justification_db = EntityJustification.for_id_entity_persistent_unordered(
+        c.id_persistent_entity_duplicate_test
+    ).get()
+    assert justification_db.text == justification
+    contribution = ContributionCandidate.by_id_persistent(
+        contribution_candidate.id_persistent, contribution_candidate.created_by
+    ).get()
+    assert contribution.justification == justification
+
+
+def test_uses_contribution_justification(auth_server, contribution_candidate, entities):
+    contribution_candidate.justification = justification
+    contribution_candidate.save()
+    live_server, cookies = auth_server
+    rsp = r.put_duplicate(
+        live_server.url,
+        contribution_candidate.id_persistent,
+        c.id_persistent_entity_duplicate_test,
+        None,
+        cookies=cookies,
+    )
+    assert rsp.status_code == 200
+    assert len(EntityDuplicate.objects.all()) == 0  # pylint: disable=no-member
+    justification_db = EntityJustification.for_id_entity_persistent_unordered(
+        c.id_persistent_entity_duplicate_test
+    ).get()
+    assert justification_db.text == justification
+
+
+def test_uses_entity_justification(auth_server, contribution_candidate, entities):
+    EntityJustification.add(
+        "72ae157a-75f8-46a6-a143-6548ea4ea91b",
+        c.id_persistent_entity_duplicate_test,
+        justification,
+        c.time_edit_deduplication,
+        contribution_candidate.created_by,
+    )
+    live_server, cookies = auth_server
+    rsp = r.put_duplicate(
+        live_server.url,
+        contribution_candidate.id_persistent,
+        c.id_persistent_entity_duplicate_test,
+        None,
+        cookies=cookies,
+    )
+    assert rsp.status_code == 200
+    assert len(EntityDuplicate.objects.all()) == 0  # pylint: disable=no-member
+    justification_db = EntityJustification.for_id_entity_persistent_unordered(
+        c.id_persistent_entity_duplicate_test
+    ).get()
+    assert justification_db.text == justification
+
+
 def test_put_duplicate_removes_old(auth_server, contribution_candidate, entities):
     live_server, cookies = auth_server
     rsp = r.put_duplicate(
         live_server.url,
         contribution_candidate.id_persistent,
         c.id_persistent_entity_duplicate_test,
         ce.id_persistent_test_0,
-        cookies,
+        cookies=cookies,
     )
     assert rsp.status_code == 200
     rsp = r.put_duplicate(
         live_server.url,
         contribution_candidate.id_persistent,
         c.id_persistent_entity_duplicate_test,
         ce.id_persistent_test_1,
-        cookies,
+        cookies=cookies,
     )
     assert rsp.status_code == 200
     duplicate = EntityDuplicate.objects.all().get()  # pylint: disable=no-member

tests/contribution/entity/api/requests.py

@@ -1,4 +1,4 @@
-# pylint: disable=missing-module-docstring, missing-function-docstring,redefined-outer-name,invalid-name
+# pylint: disable=missing-module-docstring, missing-function-docstring,redefined-outer-name,invalid-name,too-many-arguments
 import requests
 
 
@@ -36,6 +36,8 @@ def put_duplicate(
     id_contribution_candidate_persistent,
     id_entity_origin_persistent,
     id_entity_destination_persistent,
+    justification=None,
+    keep_justification_for_all=None,
     cookies=None,
 ):
     return requests.put(
@@ -44,7 +46,11 @@ def put_duplicate(
             f"/vran/api/contributions/{id_contribution_candidate_persistent}"
             f"/entities/{id_entity_origin_persistent}/duplicate"
         ),
-        json={"id_entity_destination_persistent": id_entity_destination_persistent},
+        json={
+            "id_entity_destination_persistent": id_entity_destination_persistent,
+            "justification_txt": justification,
+            "keep_justification_for_all": keep_justification_for_all,
+        },
         cookies=cookies,
-        timeout=9,
+        timeout=90,
     )

tests/contribution/entity/common.py

@@ -21,6 +21,6 @@
 id_tag_instance_match_destination = "2ce8231e-5a58-4f43-8ef4-89efca0a6b97"
 id_tag_instance_match_origin = "db0079c1-4cbf-43e8-ad19-e5dee0ae7405"
 id_tag_merge_request_persistent = "af01c5cb-33b9-4b05-ade5-6d821a2d3075"
-time_edit_tag_instance_match_origin = datetime(2022, 1, 1)
-time_edit_tag_instance_match_destination = datetime(2021, 12, 3)
-time_edit_tag_merge_request = datetime(2022, 1, 2)
+time_edit_tag_instance_match_origin = datetime(2022, 1, 1, tzinfo=timezone.utc)
+time_edit_tag_instance_match_destination = datetime(2021, 12, 3, tzinfo=timezone.utc)
+time_edit_tag_merge_request = datetime(2022, 1, 2, tzinfo=timezone.utc)