-
Notifications
You must be signed in to change notification settings - Fork 421
/
Copy pathtest_idempotency.py
2138 lines (1722 loc) · 78.3 KB
/
test_idempotency.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import copy
import dataclasses
import datetime
import warnings
from typing import Any, Optional
from unittest.mock import MagicMock, Mock
import jmespath
import pytest
from botocore import stub
from botocore.config import Config
from pytest import FixtureRequest
from pytest_mock import MockerFixture
from aws_lambda_powertools.utilities.data_classes import (
APIGatewayProxyEventV2,
event_source,
)
from aws_lambda_powertools.utilities.idempotency import (
DynamoDBPersistenceLayer,
IdempotencyConfig,
idempotent,
idempotent_function,
)
from aws_lambda_powertools.utilities.idempotency.base import (
MAX_RETRIES,
IdempotencyHandler,
_prepare_data,
)
from aws_lambda_powertools.utilities.idempotency.exceptions import (
IdempotencyAlreadyInProgressError,
IdempotencyInconsistentStateError,
IdempotencyInvalidStatusError,
IdempotencyKeyError,
IdempotencyNoSerializationModelError,
IdempotencyPersistenceLayerError,
IdempotencyValidationError,
)
from aws_lambda_powertools.utilities.idempotency.persistence.base import (
BasePersistenceLayer,
DataRecord,
)
from aws_lambda_powertools.utilities.idempotency.serialization.custom_dict import (
CustomDictSerializer,
)
from aws_lambda_powertools.utilities.idempotency.serialization.dataclass import (
DataclassSerializer,
)
from aws_lambda_powertools.utilities.validation import envelopes, validator
from aws_lambda_powertools.warnings import PowertoolsUserWarning
from tests.functional.idempotency.utils import (
build_idempotency_put_item_response_stub,
build_idempotency_put_item_stub,
build_idempotency_update_item_stub,
hash_idempotency_key,
)
from tests.functional.utils import json_serialize, load_event
TABLE_NAME = "TEST_TABLE"
TESTS_MODULE_PREFIX = "test-func.tests.functional.idempotency._boto3.test_idempotency"
# Using parametrize to run test twice, with two separate instances of persistence store. One instance with caching
# enabled, and one without.
@pytest.mark.parametrize("idempotency_config", [{"use_local_cache": False}, {"use_local_cache": True}], indirect=True)
def test_idempotent_lambda_already_completed(
idempotency_config: IdempotencyConfig,
persistence_store: DynamoDBPersistenceLayer,
lambda_apigw_event,
timestamp_future,
hashed_idempotency_key,
serialized_lambda_response,
deserialized_lambda_response,
lambda_context,
):
"""
Test idempotent decorator where event with matching event key has already been successfully processed
"""
stubber = stub.Stubber(persistence_store.client)
ddb_response = {
"Item": {
"id": {"S": hashed_idempotency_key},
"expiration": {"N": timestamp_future},
"data": {"S": serialized_lambda_response},
"status": {"S": "COMPLETED"},
},
}
stubber.add_client_error("put_item", "ConditionalCheckFailedException", modeled_fields=ddb_response)
stubber.activate()
@idempotent(config=idempotency_config, persistence_store=persistence_store)
def lambda_handler(event, context):
raise Exception
lambda_resp = lambda_handler(lambda_apigw_event, lambda_context)
assert lambda_resp == deserialized_lambda_response
stubber.assert_no_pending_responses()
stubber.deactivate()
@pytest.mark.parametrize("idempotency_config", [{"use_local_cache": False}, {"use_local_cache": True}], indirect=True)
def test_idempotent_lambda_in_progress(
idempotency_config: IdempotencyConfig,
persistence_store: DynamoDBPersistenceLayer,
lambda_apigw_event,
lambda_response,
timestamp_future,
hashed_idempotency_key,
lambda_context,
):
"""
Test idempotent decorator where lambda_handler is already processing an event with matching event key
"""
stubber = stub.Stubber(persistence_store.client)
ddb_response = {
"Item": {
"id": {"S": hashed_idempotency_key},
"expiration": {"N": timestamp_future},
"status": {"S": "INPROGRESS"},
},
}
stubber.add_client_error("put_item", "ConditionalCheckFailedException", modeled_fields=ddb_response)
stubber.activate()
@idempotent(config=idempotency_config, persistence_store=persistence_store)
def lambda_handler(event, context):
return lambda_response
with pytest.raises(IdempotencyAlreadyInProgressError) as ex:
lambda_handler(lambda_apigw_event, lambda_context)
assert (
ex.value.args[0] == "Execution already in progress with idempotency key: "
"body=a3edd699125517bb49d562501179ecbd"
)
stubber.assert_no_pending_responses()
stubber.deactivate()
@pytest.mark.parametrize("idempotency_config", [{"use_local_cache": True}], indirect=True)
def test_idempotent_lambda_in_progress_with_cache(
idempotency_config: IdempotencyConfig,
persistence_store: DynamoDBPersistenceLayer,
lambda_apigw_event,
lambda_response,
timestamp_future,
hashed_idempotency_key,
mocker,
lambda_context,
):
"""
Test idempotent decorator where lambda_handler is already processing an event with matching event key, cache
enabled.
"""
save_to_cache_spy = mocker.spy(persistence_store, "_save_to_cache")
retrieve_from_cache_spy = mocker.spy(persistence_store, "_retrieve_from_cache")
stubber = stub.Stubber(persistence_store.client)
ddb_response = {
"Item": {
"id": {"S": hashed_idempotency_key},
"expiration": {"N": timestamp_future},
"status": {"S": "INPROGRESS"},
},
}
stubber.add_client_error("put_item", "ConditionalCheckFailedException", modeled_fields=ddb_response)
stubber.add_client_error("put_item", "ConditionalCheckFailedException", modeled_fields=copy.deepcopy(ddb_response))
stubber.add_client_error("put_item", "ConditionalCheckFailedException", modeled_fields=copy.deepcopy(ddb_response))
stubber.activate()
@idempotent(config=idempotency_config, persistence_store=persistence_store)
def lambda_handler(event, context):
return lambda_response
loops = 3
for _ in range(loops):
with pytest.raises(IdempotencyAlreadyInProgressError) as ex:
lambda_handler(lambda_apigw_event, lambda_context)
assert (
ex.value.args[0] == "Execution already in progress with idempotency key: "
"body=a3edd699125517bb49d562501179ecbd"
)
assert retrieve_from_cache_spy.call_count == loops
retrieve_from_cache_spy.assert_called_with(idempotency_key=hashed_idempotency_key)
save_to_cache_spy.assert_called()
assert persistence_store._cache.get(hashed_idempotency_key) is None
stubber.assert_no_pending_responses()
stubber.deactivate()
@pytest.mark.parametrize("idempotency_config", [{"use_local_cache": False}, {"use_local_cache": True}], indirect=True)
def test_idempotent_lambda_first_execution(
idempotency_config: IdempotencyConfig,
persistence_store: DynamoDBPersistenceLayer,
lambda_apigw_event,
expected_params_update_item,
expected_params_put_item,
lambda_response,
lambda_context,
):
"""
Test idempotent decorator when lambda is executed with an event with a previously unknown event key
"""
stubber = stub.Stubber(persistence_store.client)
ddb_response = {}
stubber.add_response("put_item", ddb_response, expected_params_put_item)
stubber.add_response("update_item", ddb_response, expected_params_update_item)
stubber.activate()
@idempotent(config=idempotency_config, persistence_store=persistence_store)
def lambda_handler(event, context):
return lambda_response
lambda_handler(lambda_apigw_event, lambda_context)
stubber.assert_no_pending_responses()
stubber.deactivate()
@pytest.mark.parametrize("idempotency_config", [{"use_local_cache": False}, {"use_local_cache": True}], indirect=True)
def test_idempotent_lambda_expired(
idempotency_config: IdempotencyConfig,
persistence_store: DynamoDBPersistenceLayer,
lambda_apigw_event,
lambda_response,
expected_params_update_item,
expected_params_put_item,
lambda_context,
):
"""
Test idempotent decorator when lambda is called with an event it successfully handled already, but outside of the
expiry window
"""
stubber = stub.Stubber(persistence_store.client)
ddb_response = {}
stubber.add_response("put_item", ddb_response, expected_params_put_item)
stubber.add_response("update_item", ddb_response, expected_params_update_item)
stubber.activate()
@idempotent(config=idempotency_config, persistence_store=persistence_store)
def lambda_handler(event, context):
return lambda_response
lambda_handler(lambda_apigw_event, lambda_context)
stubber.assert_no_pending_responses()
stubber.deactivate()
@pytest.mark.parametrize("idempotency_config", [{"use_local_cache": True}], indirect=True)
def test_idempotent_lambda_first_execution_cached(
idempotency_config: IdempotencyConfig,
persistence_store: DynamoDBPersistenceLayer,
lambda_apigw_event,
expected_params_update_item,
expected_params_put_item,
lambda_response,
hashed_idempotency_key,
mocker,
lambda_context,
):
"""
Test idempotent decorator when lambda is executed with an event with a previously unknown event key. Ensure
result is cached locally on the persistence store instance.
"""
save_to_cache_spy = mocker.spy(persistence_store, "_save_to_cache")
retrieve_from_cache_spy = mocker.spy(persistence_store, "_retrieve_from_cache")
stubber = stub.Stubber(persistence_store.client)
ddb_response = {}
stubber.add_response("put_item", ddb_response, expected_params_put_item)
stubber.add_response("update_item", ddb_response, expected_params_update_item)
stubber.activate()
@idempotent(config=idempotency_config, persistence_store=persistence_store)
def lambda_handler(event, context):
return lambda_response
lambda_handler(lambda_apigw_event, lambda_context)
retrieve_from_cache_spy.assert_called_once()
save_to_cache_spy.assert_called_once()
assert save_to_cache_spy.call_args[1]["data_record"].status == "COMPLETED"
assert persistence_store._cache.get(hashed_idempotency_key).status == "COMPLETED"
# This lambda call should not call AWS API
lambda_handler(lambda_apigw_event, lambda_context)
assert retrieve_from_cache_spy.call_count == 3
retrieve_from_cache_spy.assert_called_with(idempotency_key=hashed_idempotency_key)
# This assertion fails if an AWS API operation was called more than once
stubber.assert_no_pending_responses()
stubber.deactivate()
@pytest.mark.parametrize("idempotency_config", [{"use_local_cache": True, "event_key_jmespath": "body"}], indirect=True)
def test_idempotent_lambda_first_execution_event_mutation(
idempotency_config: IdempotencyConfig,
persistence_store: DynamoDBPersistenceLayer,
lambda_apigw_event,
lambda_response,
lambda_context,
):
"""
Test idempotent decorator where lambda_handler mutates the event.
Ensures we're passing data by value, not reference.
"""
event = copy.deepcopy(lambda_apigw_event)
stubber = stub.Stubber(persistence_store.client)
ddb_response = {}
stubber.add_response(
"put_item",
ddb_response,
build_idempotency_put_item_stub(data=event["body"]),
)
stubber.add_response(
"update_item",
ddb_response,
build_idempotency_update_item_stub(data=event["body"], handler_response=lambda_response),
)
stubber.activate()
@idempotent(config=idempotency_config, persistence_store=persistence_store)
def lambda_handler(event, context):
event.pop("body") # remove exact key we're using for idempotency
return lambda_response
lambda_handler(event, lambda_context)
stubber.assert_no_pending_responses()
stubber.deactivate()
@pytest.mark.parametrize("idempotency_config", [{"use_local_cache": False}, {"use_local_cache": True}], indirect=True)
def test_idempotent_lambda_exception(
idempotency_config: IdempotencyConfig,
persistence_store: DynamoDBPersistenceLayer,
lambda_apigw_event,
hashed_idempotency_key,
expected_params_put_item,
lambda_context,
):
"""
Test idempotent decorator when lambda is executed with an event with a previously unknown event key, but
lambda_handler raises an exception which is retryable.
"""
# Create a new provider
# Stub the boto3 client
stubber = stub.Stubber(persistence_store.client)
ddb_response = {}
expected_params_delete_item = {"TableName": TABLE_NAME, "Key": {"id": {"S": hashed_idempotency_key}}}
stubber.add_response("put_item", ddb_response, expected_params_put_item)
stubber.add_response("delete_item", ddb_response, expected_params_delete_item)
stubber.activate()
@idempotent(config=idempotency_config, persistence_store=persistence_store)
def lambda_handler(event, context):
raise Exception("Something went wrong!")
with pytest.raises(Exception, match="Something went wrong!"):
lambda_handler(lambda_apigw_event, lambda_context)
stubber.assert_no_pending_responses()
stubber.deactivate()
@pytest.mark.parametrize(
"idempotency_config",
[
{"use_local_cache": False, "payload_validation_jmespath": "requestContext"},
],
indirect=True,
)
def test_idempotent_lambda_already_completed_with_validation_bad_payload(
idempotency_config: IdempotencyConfig,
persistence_store: DynamoDBPersistenceLayer,
lambda_apigw_event,
timestamp_future,
lambda_response,
hashed_idempotency_key,
hashed_validation_key,
lambda_context,
):
"""
Test idempotent decorator where event with matching event key has already been successfully processed
"""
# GIVEN an idempotent record already exists for the same transaction
# and payload validation was enabled ('validation' key)
stubber = stub.Stubber(persistence_store.client)
ddb_response = {
"Item": {
"id": {"S": hashed_idempotency_key},
"expiration": {"N": timestamp_future},
"data": {"S": '{"message": "test", "statusCode": 200}'},
"status": {"S": "COMPLETED"},
"validation": {"S": hashed_validation_key},
},
}
stubber.add_client_error("put_item", "ConditionalCheckFailedException", modeled_fields=ddb_response)
stubber.activate()
@idempotent(config=idempotency_config, persistence_store=persistence_store)
def lambda_handler(event, context):
return lambda_response
# WHEN the subsequent request is the same but validated field is tampered
lambda_apigw_event["requestContext"]["accountId"] += "1" # Alter the request payload
# THEN we should raise
with pytest.raises(IdempotencyValidationError):
lambda_handler(lambda_apigw_event, lambda_context)
stubber.assert_no_pending_responses()
stubber.deactivate()
@pytest.mark.parametrize("idempotency_config", [{"use_local_cache": False}, {"use_local_cache": True}], indirect=True)
def test_idempotent_lambda_expired_during_request(
idempotency_config: IdempotencyConfig,
persistence_store: DynamoDBPersistenceLayer,
lambda_apigw_event,
timestamp_expired,
lambda_response,
hashed_idempotency_key,
mocker,
lambda_context,
):
"""
Test idempotent decorator when lambda is called with an event it successfully handled already. Persistence store
returns inconsistent/rapidly changing result between put_item and get_item calls.
"""
stubber = stub.Stubber(persistence_store.client)
ddb_response_get_item = {
"Item": {
"id": {"S": hashed_idempotency_key},
"expiration": {"N": timestamp_expired},
"data": {"S": '{"message": "test", "statusCode": 200}'},
"status": {"S": "INPROGRESS"},
},
}
ddb_response_get_item_missing = {}
expected_params_get_item = {
"TableName": TABLE_NAME,
"Key": {"id": {"S": hashed_idempotency_key}},
"ConsistentRead": True,
}
# Simulate record repeatedly changing state between put_item and get_item
stubber.add_client_error("put_item", "ConditionalCheckFailedException")
stubber.add_response("get_item", ddb_response_get_item, expected_params_get_item)
stubber.add_client_error("put_item", "ConditionalCheckFailedException")
stubber.add_response("get_item", ddb_response_get_item_missing)
stubber.add_client_error("put_item", "ConditionalCheckFailedException")
stubber.add_response("get_item", copy.deepcopy(ddb_response_get_item), copy.deepcopy(expected_params_get_item))
stubber.activate()
submethod_mocked = mocker.patch.object(persistence_store, "boto3_supports_condition_check_failure")
submethod_mocked.return_value = False
@idempotent(config=idempotency_config, persistence_store=persistence_store)
def lambda_handler(event, context):
return lambda_response
# max retries exceeded before get_item and put_item agree on item state, so exception gets raised
with pytest.raises(IdempotencyInconsistentStateError):
lambda_handler(lambda_apigw_event, lambda_context)
stubber.assert_no_pending_responses()
stubber.deactivate()
@pytest.mark.parametrize(
"idempotency_config",
[{"use_local_cache": True, "payload_validation_jmespath": "requestContext"}],
indirect=True,
)
def test_idempotent_lambda_already_completed_with_validation_bad_payload_from_local_cache(
idempotency_config: IdempotencyConfig,
persistence_store: DynamoDBPersistenceLayer,
lambda_apigw_event,
timestamp_future,
lambda_response,
hashed_idempotency_key,
hashed_validation_key,
lambda_context,
):
"""
Test idempotent decorator where event with matching event key has already been successfully processed
Fetching record from local cache
"""
stubber = stub.Stubber(persistence_store.client)
ddb_response = {
"Item": {
"id": {"S": hashed_idempotency_key},
"expiration": {"N": timestamp_future},
"data": {"S": '{"message": "test", "statusCode": 200}'},
"status": {"S": "COMPLETED"},
"validation": {"S": hashed_validation_key},
},
}
expected_params = {"TableName": TABLE_NAME, "Key": {"id": {"S": hashed_idempotency_key}}, "ConsistentRead": True}
stubber.add_client_error("put_item", "ConditionalCheckFailedException")
stubber.add_response("get_item", ddb_response, expected_params)
stubber.activate()
@idempotent(config=idempotency_config, persistence_store=persistence_store)
def lambda_handler(event, context):
return lambda_response
with pytest.raises(IdempotencyValidationError):
lambda_apigw_event["requestContext"]["accountId"] += "1" # Alter the request payload
lambda_handler(lambda_apigw_event, lambda_context)
stubber.assert_no_pending_responses()
stubber.deactivate()
@pytest.mark.parametrize("idempotency_config", [{"use_local_cache": False}, {"use_local_cache": True}], indirect=True)
def test_idempotent_persistence_exception_deleting(
idempotency_config: IdempotencyConfig,
persistence_store: DynamoDBPersistenceLayer,
lambda_apigw_event,
expected_params_put_item,
lambda_context,
):
"""
Test idempotent decorator when lambda is executed with an event with a previously unknown event key, but
lambda_handler raises an exception which is retryable.
"""
stubber = stub.Stubber(persistence_store.client)
ddb_response = {}
stubber.add_response("put_item", ddb_response, expected_params_put_item)
stubber.add_client_error("delete_item", "UnrecoverableError")
stubber.activate()
@idempotent(config=idempotency_config, persistence_store=persistence_store)
def lambda_handler(event, context):
raise Exception("Something went wrong!")
with pytest.raises(IdempotencyPersistenceLayerError) as exc:
lambda_handler(lambda_apigw_event, lambda_context)
assert exc.value.args[0] == "Failed to delete record from idempotency store"
stubber.assert_no_pending_responses()
stubber.deactivate()
@pytest.mark.parametrize("idempotency_config", [{"use_local_cache": False}, {"use_local_cache": True}], indirect=True)
def test_idempotent_persistence_exception_updating(
idempotency_config: IdempotencyConfig,
persistence_store: DynamoDBPersistenceLayer,
lambda_apigw_event,
expected_params_put_item,
lambda_context,
):
"""
Test idempotent decorator when lambda is executed with an event with a previously unknown event key, but
lambda_handler raises an exception which is retryable.
"""
stubber = stub.Stubber(persistence_store.client)
ddb_response = {}
stubber.add_response("put_item", ddb_response, expected_params_put_item)
stubber.add_client_error("update_item", "UnrecoverableError")
stubber.activate()
@idempotent(config=idempotency_config, persistence_store=persistence_store)
def lambda_handler(event, context):
return {"message": "success!"}
with pytest.raises(IdempotencyPersistenceLayerError) as exc:
lambda_handler(lambda_apigw_event, lambda_context)
assert exc.value.args[0] == "Failed to update record state to success in idempotency store"
stubber.assert_no_pending_responses()
stubber.deactivate()
@pytest.mark.parametrize("idempotency_config", [{"use_local_cache": False}, {"use_local_cache": True}], indirect=True)
def test_idempotent_persistence_exception_getting(
idempotency_config: IdempotencyConfig,
persistence_store: DynamoDBPersistenceLayer,
lambda_apigw_event,
lambda_context,
):
"""
Test idempotent decorator when lambda is executed with an event with a previously unknown event key, but
lambda_handler raises an exception which is retryable.
"""
stubber = stub.Stubber(persistence_store.client)
stubber.add_client_error("put_item", "ConditionalCheckFailedException")
stubber.add_client_error("get_item", "UnexpectedException")
stubber.activate()
@idempotent(config=idempotency_config, persistence_store=persistence_store)
def lambda_handler(event, context):
return {"message": "success!"}
with pytest.raises(IdempotencyPersistenceLayerError) as exc:
lambda_handler(lambda_apigw_event, lambda_context)
assert exc.value.args[0] == "Failed to get record from idempotency store"
stubber.assert_no_pending_responses()
stubber.deactivate()
@pytest.mark.parametrize(
"idempotency_config",
[
{"use_local_cache": False, "payload_validation_jmespath": "requestContext"},
{"use_local_cache": True, "payload_validation_jmespath": "requestContext"},
],
indirect=True,
)
def test_idempotent_lambda_first_execution_with_validation(
idempotency_config: IdempotencyConfig,
persistence_store: DynamoDBPersistenceLayer,
lambda_apigw_event,
expected_params_update_item_with_validation,
expected_params_put_item_with_validation,
lambda_response,
lambda_context,
):
"""
Test idempotent decorator when lambda is executed with an event with a previously unknown event key
"""
stubber = stub.Stubber(persistence_store.client)
ddb_response = {}
stubber.add_response("put_item", ddb_response, expected_params_put_item_with_validation)
stubber.add_response("update_item", ddb_response, expected_params_update_item_with_validation)
stubber.activate()
@idempotent(config=idempotency_config, persistence_store=persistence_store)
def lambda_handler(event, context):
return lambda_response
lambda_handler(lambda_apigw_event, lambda_context)
stubber.assert_no_pending_responses()
stubber.deactivate()
@pytest.mark.parametrize(
"config_without_jmespath",
[{"use_local_cache": False}, {"use_local_cache": True}],
indirect=True,
)
def test_idempotent_lambda_with_validator_util(
config_without_jmespath: IdempotencyConfig,
persistence_store: DynamoDBPersistenceLayer,
lambda_apigw_event,
timestamp_future,
serialized_lambda_response,
deserialized_lambda_response,
hashed_idempotency_key_with_envelope,
mock_function,
lambda_context,
):
"""
Test idempotent decorator where event with matching event key has already been succesfully processed, using the
validator utility to unwrap the event
"""
stubber = stub.Stubber(persistence_store.client)
ddb_response = {
"Item": {
"id": {"S": hashed_idempotency_key_with_envelope},
"expiration": {"N": timestamp_future},
"data": {"S": serialized_lambda_response},
"status": {"S": "COMPLETED"},
},
}
stubber.add_client_error("put_item", "ConditionalCheckFailedException", modeled_fields=ddb_response)
stubber.activate()
@validator(envelope=envelopes.API_GATEWAY_HTTP)
@idempotent(config=config_without_jmespath, persistence_store=persistence_store)
def lambda_handler(event, context):
mock_function()
return "shouldn't get here!"
mock_function.assert_not_called()
lambda_resp = lambda_handler(lambda_apigw_event, lambda_context)
assert lambda_resp == deserialized_lambda_response
stubber.assert_no_pending_responses()
stubber.deactivate()
@pytest.mark.parametrize("idempotency_config", [{"use_local_cache": False}, {"use_local_cache": True}], indirect=True)
def test_idempotent_lambda_expires_in_progress_before_expire(
idempotency_config: IdempotencyConfig,
persistence_store: DynamoDBPersistenceLayer,
lambda_apigw_event,
timestamp_future,
lambda_response,
hashed_idempotency_key,
lambda_context,
):
stubber = stub.Stubber(persistence_store.client)
stubber.add_client_error("put_item", "ConditionalCheckFailedException")
now = datetime.datetime.now()
period = datetime.timedelta(seconds=5)
timestamp_expires_in_progress = int((now + period).timestamp() * 1000)
expected_params_get_item = {
"TableName": TABLE_NAME,
"Key": {"id": {"S": hashed_idempotency_key}},
"ConsistentRead": True,
}
ddb_response_get_item = {
"Item": {
"id": {"S": hashed_idempotency_key},
"expiration": {"N": timestamp_future},
"in_progress_expiration": {"N": str(timestamp_expires_in_progress)},
"data": {"S": '{"message": "test", "statusCode": 200'},
"status": {"S": "INPROGRESS"},
},
}
stubber.add_response("get_item", ddb_response_get_item, expected_params_get_item)
stubber.activate()
@idempotent(config=idempotency_config, persistence_store=persistence_store)
def lambda_handler(event, context):
return lambda_response
with pytest.raises(IdempotencyAlreadyInProgressError):
lambda_handler(lambda_apigw_event, lambda_context)
stubber.assert_no_pending_responses()
stubber.deactivate()
@pytest.mark.parametrize("idempotency_config", [{"use_local_cache": False}, {"use_local_cache": True}], indirect=True)
def test_idempotent_lambda_expires_in_progress_before_expire_with_sort_key(
idempotency_config: IdempotencyConfig,
persistence_store_compound_static_pk_value: DynamoDBPersistenceLayer,
lambda_apigw_event,
timestamp_future,
lambda_response,
hashed_idempotency_key,
lambda_context,
):
stubber = stub.Stubber(persistence_store_compound_static_pk_value.client)
stubber.add_client_error("put_item", "ConditionalCheckFailedException")
now = datetime.datetime.now()
period = datetime.timedelta(seconds=5)
timestamp_expires_in_progress = int((now + period).timestamp() * 1000)
expected_params_get_item = {
"TableName": TABLE_NAME,
"Key": {"id": {"S": "static-value"}, "sk": {"S": hashed_idempotency_key}},
"ConsistentRead": True,
}
ddb_response_get_item = {
"Item": {
"id": {"S": "static-value"},
"expiration": {"N": timestamp_future},
"in_progress_expiration": {"N": str(timestamp_expires_in_progress)},
"data": {"S": '{"message": "test", "statusCode": 200'},
"status": {"S": "INPROGRESS"},
"sk": {"S": hashed_idempotency_key},
},
}
stubber.add_response("get_item", ddb_response_get_item, expected_params_get_item)
stubber.activate()
@idempotent(config=idempotency_config, persistence_store=persistence_store_compound_static_pk_value)
def lambda_handler(event, context):
return lambda_response
with pytest.raises(IdempotencyAlreadyInProgressError, match="and sort key"):
lambda_handler(lambda_apigw_event, lambda_context)
stubber.assert_no_pending_responses()
stubber.deactivate()
@pytest.mark.parametrize("idempotency_config", [{"use_local_cache": False}, {"use_local_cache": True}], indirect=True)
def test_idempotent_lambda_expires_in_progress_after_expire(
idempotency_config: IdempotencyConfig,
persistence_store: DynamoDBPersistenceLayer,
lambda_apigw_event,
timestamp_future,
lambda_response,
hashed_idempotency_key,
lambda_context,
):
stubber = stub.Stubber(persistence_store.client)
for _ in range(MAX_RETRIES + 1):
stubber.add_client_error("put_item", "ConditionalCheckFailedException")
one_second_ago = datetime.datetime.now() - datetime.timedelta(seconds=1)
expected_params_get_item = {
"TableName": TABLE_NAME,
"Key": {"id": {"S": hashed_idempotency_key}},
"ConsistentRead": True,
}
ddb_response_get_item = {
"Item": {
"id": {"S": hashed_idempotency_key},
"expiration": {"N": timestamp_future},
"in_progress_expiration": {"N": str(int(one_second_ago.timestamp() * 1000))},
"data": {"S": '{"message": "test", "statusCode": 200'},
"status": {"S": "INPROGRESS"},
},
}
stubber.add_response("get_item", ddb_response_get_item, expected_params_get_item)
stubber.activate()
@idempotent(config=idempotency_config, persistence_store=persistence_store)
def lambda_handler(event, context):
return lambda_response
with pytest.raises(IdempotencyInconsistentStateError):
lambda_handler(lambda_apigw_event, lambda_context)
stubber.assert_no_pending_responses()
stubber.deactivate()
def test_idempotent_lambda_expires_in_progress_unavailable_remaining_time():
mock_event = {"data": "value"}
idempotency_key = f"{TESTS_MODULE_PREFIX}.test_idempotent_lambda_expires_in_progress_unavailable_remaining_time.<locals>.function#{hash_idempotency_key(mock_event)}" # noqa E501
persistence_layer = MockPersistenceLayer(expected_idempotency_key=idempotency_key)
expected_result = {"message": "Foo"}
@idempotent_function(persistence_store=persistence_layer, data_keyword_argument="record")
def function(record):
return expected_result
with warnings.catch_warnings(record=True) as w:
warnings.simplefilter("default")
function(record=mock_event)
assert len(w) == 1
assert (
str(w[-1].message)
== "Couldn't determine the remaining time left. Did you call register_lambda_context on IdempotencyConfig?"
)
def test_data_record_invalid_status_value():
data_record = DataRecord("key", status="UNSUPPORTED_STATUS")
with pytest.raises(IdempotencyInvalidStatusError) as e:
_ = data_record.status
assert e.value.args[0] == "UNSUPPORTED_STATUS"
def test_data_record_json_to_dict_mapping():
# GIVEN a data record with status "INPROGRESS" and provided response data
data_record = DataRecord(
"key",
status="INPROGRESS",
response_data='{"body": "execution finished","statusCode": "200"}',
)
# WHEN translating response data to dictionary
response_data = data_record.response_json_as_dict()
# THEN return dictionary
assert isinstance(response_data, dict)
def test_data_record_json_to_dict_mapping_when_response_data_none():
# GIVEN a data record with status "INPROGRESS" and not set response data
data_record = DataRecord("key", status="INPROGRESS", response_data=None)
# WHEN translating response data to dictionary
response_data = data_record.response_json_as_dict()
# THEN return null value
assert response_data is None
@pytest.mark.parametrize("idempotency_config", [{"use_local_cache": True}], indirect=True)
def test_handler_for_status_expired_data_record(
idempotency_config: IdempotencyConfig,
persistence_store: DynamoDBPersistenceLayer,
):
idempotency_handler = IdempotencyHandler(
function=lambda a: a,
function_payload={},
config=idempotency_config,
persistence_store=persistence_store,
)
data_record = DataRecord("key", status="EXPIRED", response_data=None)
with pytest.raises(IdempotencyInconsistentStateError):
idempotency_handler._handle_for_status(data_record)
@pytest.mark.parametrize("idempotency_config", [{"use_local_cache": True}], indirect=True)
def test_handler_for_status_inprogress_data_record_inconsistent(
idempotency_config: IdempotencyConfig,
persistence_store: DynamoDBPersistenceLayer,
):
idempotency_handler = IdempotencyHandler(
function=lambda a: a,
function_payload={},
config=idempotency_config,
persistence_store=persistence_store,
)
now = datetime.datetime.now()
period = datetime.timedelta(milliseconds=100)
timestamp = int((now - period).timestamp() * 1000)
data_record = DataRecord("key", in_progress_expiry_timestamp=timestamp, status="INPROGRESS", response_data=None)
with pytest.raises(IdempotencyInconsistentStateError):
idempotency_handler._handle_for_status(data_record)
@pytest.mark.parametrize("idempotency_config", [{"use_local_cache": True}], indirect=True)
def test_handler_for_status_inprogress_data_record_consistent(
idempotency_config: IdempotencyConfig,
persistence_store: DynamoDBPersistenceLayer,
):
idempotency_handler = IdempotencyHandler(
function=lambda a: a,
function_payload={},
config=idempotency_config,
persistence_store=persistence_store,
)
now = datetime.datetime.now()
period = datetime.timedelta(milliseconds=100)
timestamp = int((now + period).timestamp() * 1000)
data_record = DataRecord("key", in_progress_expiry_timestamp=timestamp, status="INPROGRESS", response_data=None)
with pytest.raises(IdempotencyAlreadyInProgressError):
idempotency_handler._handle_for_status(data_record)
@pytest.mark.parametrize("idempotency_config", [{"use_local_cache": True}], indirect=True)
def test_in_progress_never_saved_to_cache(
idempotency_config: IdempotencyConfig,
persistence_store: DynamoDBPersistenceLayer,
):
# GIVEN a data record with status "INPROGRESS"
# and persistence_store has use_local_cache = True
persistence_store.configure(idempotency_config)
data_record = DataRecord("key", status="INPROGRESS")
# WHEN saving to local cache
persistence_store._save_to_cache(data_record)
# THEN don't save to local cache
assert persistence_store._cache.get("key") is None
@pytest.mark.parametrize("idempotency_config", [{"use_local_cache": False}], indirect=True)
def test_user_local_disabled(idempotency_config: IdempotencyConfig, persistence_store: DynamoDBPersistenceLayer):
# GIVEN a persistence_store with use_local_cache = False
persistence_store.configure(idempotency_config)
# WHEN calling any local cache options