Skip to content

Commit 66cf829

Browse files
OlhaZahoruikoOlhaZahoruiko
committed
fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! ✨ [#500] Implement Referentielijsten integration for Klantcontact
1 parent 5d86994 commit 66cf829

File tree

3 files changed

+145
-102
lines changed

3 files changed

+145
-102
lines changed

‎src/openklant/config/tests/test_models.py‎

Lines changed: 51 additions & 102 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,26 @@
1-
import json
21
from pathlib import Path
3-
from unittest.mock import patch
42

53
from django.core.cache import cache
64
from django.core.exceptions import ValidationError
7-
from django.test import TestCase
85
from django.utils import timezone
96

10-
import vcr
11-
from requests.exceptions import RequestException
7+
from maykin_common.vcr import VCRTestCase
128
from zgw_consumers.test.factories import ServiceFactory
139

1410
from openklant.components.klantinteracties.api.validators import KanaalValidator
1511
from openklant.components.klantinteracties.models import Klantcontact
1612
from openklant.config.models import ReferentielijstenConfig
1713

18-
FIXTURE_PATH = (
19-
Path(__file__).resolve().parent.parent.parent.parent.parent
20-
/ "docker"
21-
/ "referentielijsten"
22-
/ "fixtures"
23-
/ "referentielijsten_fixtures.json"
24-
)
2514

26-
with open(FIXTURE_PATH) as f:
27-
FIXTURE_DATA = json.load(f)
28-
29-
FIXTURE_BY_TABEL = {}
30-
MAPPED_TABLE_PK = 1
31-
MAPPED_TABLE_CODE = "KANAAL"
32-
33-
for obj in FIXTURE_DATA:
34-
if obj["model"] == "api.item":
35-
tabel_pk = obj["fields"]["tabel"]
36-
if tabel_pk not in FIXTURE_BY_TABEL:
37-
FIXTURE_BY_TABEL[tabel_pk] = []
38-
item_fields = obj["fields"]
39-
FIXTURE_BY_TABEL[tabel_pk].append(
40-
{
41-
"code": item_fields["code"],
42-
"naam": item_fields["naam"],
43-
"begindatumGeldigheid": item_fields.get("begindatum_geldigheid"),
44-
"einddatumGeldigheid": item_fields.get("einddatum_geldigheid"),
45-
"tabel": {"code": MAPPED_TABLE_CODE},
46-
"aanvullendeGegevens": item_fields.get("aanvullende_gegevens"),
47-
}
48-
)
49-
50-
my_vcr = vcr.VCR(
51-
cassette_library_dir="tests/cassettes",
52-
record_mode="once",
53-
match_on=["method", "url", "query"],
54-
)
55-
56-
PATCH_TARGET = "openklant.components.klantinteracties.api.validators.ReferentielijstenClient.get_items_by_tabel_code"
57-
58-
59-
class KanaalValidatorAPITestCase(TestCase):
60-
def _get_items_from_fixture(self, tabel_code):
61-
tabel_pk_map = {"KANAAL": 1}
62-
tabel_pk = tabel_pk_map.get(tabel_code)
63-
if tabel_pk is None:
64-
return []
65-
return FIXTURE_BY_TABEL.get(tabel_pk, [])
15+
class KanaalValidatorAPITestCase(VCRTestCase):
16+
service_slug = "referentielijsten-api"
17+
VCR_TEST_FILES = Path("src/referentielijsten_client/tests")
6618

6719
@classmethod
6820
def setUpTestData(cls):
69-
cls.service = ServiceFactory(api_root="http://localhost:8004/")
21+
cls.service = ServiceFactory(
22+
slug=cls.service_slug, api_root="http://localhost:8004/api/v1"
23+
)
7024
ReferentielijstenConfig.objects.create(
7125
service=cls.service,
7226
enabled=True,
@@ -83,66 +37,61 @@ def setUpTestData(cls):
8337
plaatsgevonden_op=timezone.now(),
8438
)
8539

86-
def tearDown(self):
40+
def setUp(self):
41+
super().setUp()
8742
cache.clear()
8843

89-
@patch(PATCH_TARGET, autospec=True)
90-
def test_validation_succeeds_for_valid_kanaal(self, mock_get_items):
91-
mock_get_items.return_value = self._get_items_from_fixture("KANAAL")
92-
44+
def test_validation_succeeds_for_valid_kanaal(self):
9345
validator = KanaalValidator()
9446
try:
9547
validator("email")
9648
except ValidationError:
9749
self.fail("KanaalValidator raised ValidationError unexpectedly for 'email'")
9850

99-
@patch(PATCH_TARGET, autospec=True)
100-
def test_validation_fails_for_missing_kanaal_with_valid_list(self, mock_get_items):
101-
mock_get_items.return_value = self._get_items_from_fixture(MAPPED_TABLE_CODE)
102-
51+
def test_validation_fails_for_invalid_kanaal(self):
10352
validator = KanaalValidator()
10453

10554
with self.assertRaises(ValidationError) as cm:
10655
validator("fax")
10756

10857
self.assertIn("'fax' is not a valid kanaal", str(cm.exception))
109-
110-
self.assertIn("Allowed values: email, phone", str(cm.exception))
111-
112-
@patch(PATCH_TARGET, autospec=True)
113-
def test_validation_succeeds_when_config_is_disabled(self, mock_get_items):
114-
ReferentielijstenConfig.objects.all().update(enabled=False)
115-
116-
validator = KanaalValidator()
117-
118-
validator("not-a-real-channel")
119-
mock_get_items.assert_not_called()
120-
121-
@patch(PATCH_TARGET, autospec=True)
122-
def test_validation_fails_on_api_400(self, mock_get_items):
123-
from requests.exceptions import HTTPError
124-
from requests.models import Response
125-
126-
response = Response()
127-
response.status_code = 400
128-
mock_get_items.side_effect = HTTPError(response=response)
129-
130-
validator = KanaalValidator()
131-
with self.assertRaises(ValidationError) as cm:
132-
validator("email")
133-
134-
self.assertIn(
135-
"Failed to retrieve valid channels from the API", str(cm.exception)
136-
)
137-
138-
@patch(PATCH_TARGET, autospec=True)
139-
def test_validation_fails_on_api_request_exception(self, mock_get_items):
140-
mock_get_items.side_effect = RequestException("Timeout occurred")
141-
142-
validator = KanaalValidator()
143-
with self.assertRaises(ValidationError) as cm:
144-
validator("email")
145-
146-
self.assertIn(
147-
"Failed to retrieve valid channels from the API", str(cm.exception)
148-
)
58+
self.assertIn("email", str(cm.exception))
59+
self.assertIn("phone", str(cm.exception))
60+
61+
# @patch(PATCH_TARGET, autospec=True)
62+
# def test_validation_succeeds_when_config_is_disabled(self, mock_get_items):
63+
# ReferentielijstenConfig.objects.all().update(enabled=False)
64+
#
65+
# validator = KanaalValidator()
66+
#
67+
# validator("not-a-real-channel")
68+
# mock_get_items.assert_not_called()
69+
#
70+
# @patch(PATCH_TARGET, autospec=True)
71+
# def test_validation_fails_on_api_400(self, mock_get_items):
72+
# from requests.exceptions import HTTPError
73+
# from requests.models import Response
74+
#
75+
# response = Response()
76+
# response.status_code = 400
77+
# mock_get_items.side_effect = HTTPError(response=response)
78+
#
79+
# validator = KanaalValidator()
80+
# with self.assertRaises(ValidationError) as cm:
81+
# validator("email")
82+
#
83+
# self.assertIn(
84+
# "Failed to retrieve valid channels from the API", str(cm.exception)
85+
# )
86+
#
87+
# @patch(PATCH_TARGET, autospec=True)
88+
# def test_validation_fails_on_api_request_exception(self, mock_get_items):
89+
# mock_get_items.side_effect = RequestException("Timeout occurred")
90+
#
91+
# validator = KanaalValidator()
92+
# with self.assertRaises(ValidationError) as cm:
93+
# validator("email")
94+
#
95+
# self.assertIn(
96+
# "Failed to retrieve valid channels from the API", str(cm.exception)
97+
# )

‎src/referentielijsten_client/tests/vcr_cassettes/KanaalValidatorAPITestCase/test_validation_fails_for_invalid_kanaal.yaml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
interactions:
2+
- request:
3+
body: null
4+
headers:
5+
Accept:
6+
- '*/*'
7+
Accept-Encoding:
8+
- gzip, deflate
9+
Authorization:
10+
- Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiIiLCJpYXQiOjE3NjE4Mzk5ODQsImV4cCI6MTc2MTg4MzE4NCwiY2xpZW50X2lkIjoiIiwidXNlcl9pZCI6IiIsInVzZXJfcmVwcmVzZW50YXRpb24iOiIifQ.mB8P1geNzAuAYpSqbS3mYanHu5_PpZX6qqGTZzXo9YA
11+
Connection:
12+
- keep-alive
13+
User-Agent:
14+
- python-requests/2.32.4
15+
method: GET
16+
uri: http://localhost:8004/api/v1/items?tabel__code=KANAAL
17+
response:
18+
body:
19+
string: '{"count":2,"next":null,"previous":null,"results":[{"code":"phone","naam":"Telephone","begindatumGeldigheid":"2025-10-25T15:09:07Z","einddatumGeldigheid":"2029-10-25T15:09:08Z","aanvullendeGegevens":null},{"code":"email","naam":"E-mail
20+
Communication","begindatumGeldigheid":"2025-10-25T15:09:23Z","einddatumGeldigheid":null,"aanvullendeGegevens":null}]}'
21+
headers:
22+
Allow:
23+
- GET, HEAD, OPTIONS
24+
Content-Length:
25+
- '352'
26+
Content-Security-Policy:
27+
- 'worker-src ''self'' blob:; frame-src ''self''; default-src ''self''; img-src
28+
''self'' data: cdn.redoc.ly; base-uri ''self''; script-src ''self'' ''unsafe-inline'';
29+
font-src ''self'' fonts.gstatic.com; object-src ''none''; frame-ancestors
30+
''none''; style-src ''self'' ''unsafe-inline'' fonts.googleapis.com; form-action
31+
''self'''
32+
Content-Type:
33+
- application/json
34+
Cross-Origin-Opener-Policy:
35+
- same-origin
36+
Referrer-Policy:
37+
- same-origin
38+
Vary:
39+
- origin
40+
X-Content-Type-Options:
41+
- nosniff
42+
X-Frame-Options:
43+
- DENY
44+
status:
45+
code: 200
46+
message: OK
47+
version: 1

‎src/referentielijsten_client/tests/vcr_cassettes/KanaalValidatorAPITestCase/test_validation_succeeds_for_valid_kanaal.yaml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
interactions:
2+
- request:
3+
body: null
4+
headers:
5+
Accept:
6+
- '*/*'
7+
Accept-Encoding:
8+
- gzip, deflate
9+
Authorization:
10+
- Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiIiLCJpYXQiOjE3NjE4Mzk5ODQsImV4cCI6MTc2MTg4MzE4NCwiY2xpZW50X2lkIjoiIiwidXNlcl9pZCI6IiIsInVzZXJfcmVwcmVzZW50YXRpb24iOiIifQ.mB8P1geNzAuAYpSqbS3mYanHu5_PpZX6qqGTZzXo9YA
11+
Connection:
12+
- keep-alive
13+
User-Agent:
14+
- python-requests/2.32.4
15+
method: GET
16+
uri: http://localhost:8004/api/v1/items?tabel__code=KANAAL
17+
response:
18+
body:
19+
string: '{"count":2,"next":null,"previous":null,"results":[{"code":"phone","naam":"Telephone","begindatumGeldigheid":"2025-10-25T15:09:07Z","einddatumGeldigheid":"2029-10-25T15:09:08Z","aanvullendeGegevens":null},{"code":"email","naam":"E-mail
20+
Communication","begindatumGeldigheid":"2025-10-25T15:09:23Z","einddatumGeldigheid":null,"aanvullendeGegevens":null}]}'
21+
headers:
22+
Allow:
23+
- GET, HEAD, OPTIONS
24+
Content-Length:
25+
- '352'
26+
Content-Security-Policy:
27+
- 'worker-src ''self'' blob:; frame-src ''self''; default-src ''self''; img-src
28+
''self'' data: cdn.redoc.ly; base-uri ''self''; script-src ''self'' ''unsafe-inline'';
29+
font-src ''self'' fonts.gstatic.com; object-src ''none''; frame-ancestors
30+
''none''; style-src ''self'' ''unsafe-inline'' fonts.googleapis.com; form-action
31+
''self'''
32+
Content-Type:
33+
- application/json
34+
Cross-Origin-Opener-Policy:
35+
- same-origin
36+
Referrer-Policy:
37+
- same-origin
38+
Vary:
39+
- origin
40+
X-Content-Type-Options:
41+
- nosniff
42+
X-Frame-Options:
43+
- DENY
44+
status:
45+
code: 200
46+
message: OK
47+
version: 1

0 commit comments

Comments
 (0)