-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Expand file tree
/
Copy pathtest_basic.py
More file actions
3883 lines (3230 loc) · 126 KB
/
Copy pathtest_basic.py
File metadata and controls
3883 lines (3230 loc) · 126 KB
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 enum
import os
import re
import typing as t
import uuid
from datetime import date
from datetime import datetime
from datetime import time
import arrow
import pytest
from _pytest.mark.structures import ParameterSet
from flask import Flask
from sqlalchemy import Boolean
from sqlalchemy import cast
from sqlalchemy import Column
from sqlalchemy import Date
from sqlalchemy import DateTime
from sqlalchemy import Enum
from sqlalchemy import Float
from sqlalchemy import ForeignKey
from sqlalchemy import Integer
from sqlalchemy import String
from sqlalchemy import Table
from sqlalchemy import Text
from sqlalchemy import Time
from sqlalchemy.ext.hybrid import hybrid_property
from sqlalchemy.orm import backref
from sqlalchemy.orm import relationship
from sqlalchemy_utils import ArrowType
from sqlalchemy_utils import ChoiceType
from sqlalchemy_utils import ColorType
from sqlalchemy_utils import CurrencyType
from sqlalchemy_utils import EmailType
from sqlalchemy_utils import IPAddressType
from sqlalchemy_utils import URLType
from sqlalchemy_utils import UUIDType
from wtforms import fields
from wtforms import PasswordField
from wtforms import validators
from wtforms.form import Form
from flask_admin import Admin
from flask_admin import form
from flask_admin._compat import as_unicode
from flask_admin._compat import iteritems
from flask_admin.contrib.fileadmin import FileAdmin
from flask_admin.contrib.sqla import filters
from flask_admin.contrib.sqla import ModelView
from flask_admin.contrib.sqla import tools
from flask_admin.form.fields import DateTimeField
from flask_admin.form.fields import Select2Field
from flask_admin.tests import flask_babel_test_decorator
from flask_admin.tests.conftest import skip_or_return_session_or_db
from flask_admin.tests.conftest import T_ANY_SQLA_PROVIDER
from flask_admin.tests.conftest import T_LITERAL_SESSION_OR_DB
class CustomModelView(ModelView):
def __init__(
self,
model: type,
session: t.Any,
name: str | None = None,
category: str | None = None,
endpoint: str | None = None,
url: str | None = None,
static_folder: str | None = None,
menu_class_name: str | None = None,
menu_icon_type: str | None = None,
menu_icon_value: str | None = None,
**kwargs: t.Any,
) -> None:
for k, v in iteritems(kwargs):
setattr(self, k, v)
super().__init__(
model,
session,
name,
category,
endpoint,
url,
static_folder,
menu_class_name,
menu_icon_type,
menu_icon_value,
)
form_choices = {"choice_field": [("choice-1", "One"), ("choice-2", "Two")]}
def create_models(sqla_db_ext: T_ANY_SQLA_PROVIDER) -> tuple[type, type]:
class Model1(sqla_db_ext.Base): # type: ignore[misc, name-defined]
__tablename__ = "model1"
class EnumChoices(enum.Enum):
first = 1
second = 2
id = Column(Integer, primary_key=True)
test1 = Column(String(20))
test2 = Column(String(20))
test3 = Column(Text)
test4 = Column(Text)
bool_field = Column(Boolean, default=False)
date_field = Column(Date)
time_field = Column(Time)
datetime_field = Column(DateTime)
email_field = Column(EmailType)
enum_field = Column(Enum("model1_v1", "model1_v2"), nullable=True) # type: ignore[var-annotated]
enum_type_field = Column(Enum(EnumChoices), nullable=True) # type: ignore[var-annotated]
choice_field = Column(String, nullable=True)
sqla_utils_choice = Column(
ChoiceType([("choice-1", "First choice"), ("choice-2", "Second choice")])
)
sqla_utils_enum = Column(ChoiceType(EnumChoices, impl=Integer()))
sqla_utils_arrow = Column(ArrowType, default=arrow.utcnow())
sqla_utils_uuid = Column(UUIDType(binary=False), default=uuid.uuid4)
sqla_utils_url = Column(URLType)
sqla_utils_ip_address = Column(IPAddressType)
sqla_utils_currency = Column(CurrencyType)
sqla_utils_color = Column(ColorType)
def __str__(self) -> str:
return self.test1 # type: ignore[return-value]
class Model2(sqla_db_ext.Base): # type: ignore[misc, name-defined]
__tablename__ = "model2"
id = Column(Integer, primary_key=True)
string_field = Column(String)
string_field_default = Column(Text, nullable=False, default="")
string_field_empty_default = Column(Text, nullable=False, default="")
int_field = Column(Integer)
bool_field = Column(Boolean)
enum_field: t.Any = Column(Enum("model2_v1", "model2_v2"), nullable=True)
float_field = Column(Float)
# Relation
model1_id = Column(Integer, ForeignKey(Model1.id))
model1 = relationship(lambda: Model1, backref="model2")
sqla_db_ext.create_all()
return Model1, Model2
def fill_db(sqla_db_ext: T_ANY_SQLA_PROVIDER, Model1: type, Model2: type) -> None:
model1_obj1 = Model1(test1="test1_val_1", test2="test2_val_1", bool_field=True)
model1_obj2 = Model1(test1="test1_val_2", test2="test2_val_2", bool_field=False)
model1_obj3 = Model1(test1="test1_val_3", test2="test2_val_3")
model1_obj4 = Model1(
test1="test1_val_4",
test2="test2_val_4",
email_field="test@test.com",
choice_field="choice-1",
)
model2_obj1 = Model2(
string_field="test2_val_1", model1=model1_obj1, float_field=None
)
model2_obj2 = Model2(
string_field="test2_val_2", model1=model1_obj2, float_field=None
)
model2_obj3 = Model2(string_field="test2_val_3", int_field=5000, float_field=25.9)
model2_obj4 = Model2(string_field="test2_val_4", int_field=9000, float_field=75.5)
model2_obj5 = Model2(string_field="test2_val_5", int_field=6169453081680413441)
date_obj1 = Model1(test1="date_obj1", date_field=date(2014, 11, 17))
date_obj2 = Model1(test1="date_obj2", date_field=date(2013, 10, 16))
timeonly_obj1 = Model1(test1="timeonly_obj1", time_field=time(11, 10, 9))
timeonly_obj2 = Model1(test1="timeonly_obj2", time_field=time(10, 9, 8))
datetime_obj1 = Model1(
test1="datetime_obj1", datetime_field=datetime(2014, 4, 3, 1, 9, 0)
)
datetime_obj2 = Model1(
test1="datetime_obj2", datetime_field=datetime(2013, 3, 2, 0, 8, 0)
)
enum_obj1 = Model1(test1="enum_obj1", enum_field="model1_v1")
enum_obj2 = Model1(test1="enum_obj2", enum_field="model1_v2")
enum_type_obj1 = Model1(
test1="enum_type_obj1",
enum_type_field=Model1.EnumChoices.first, # type: ignore[attr-defined]
)
enum_type_obj2 = Model1(
test1="enum_type_obj2",
enum_type_field=Model1.EnumChoices.second, # type: ignore[attr-defined]
)
empty_obj = Model1(test2="empty_obj")
sqla_db_ext.db.session.add_all(
[
model1_obj1,
model1_obj2,
model1_obj3,
model1_obj4,
model2_obj1,
model2_obj2,
model2_obj3,
model2_obj4,
model2_obj5,
date_obj1,
timeonly_obj1,
datetime_obj1,
date_obj2,
timeonly_obj2,
datetime_obj2,
enum_obj1,
enum_obj2,
enum_type_obj1,
enum_type_obj2,
empty_obj,
]
)
sqla_db_ext.db.session.commit()
@pytest.mark.filterwarnings(
"ignore:'iter_groups' is expected to return 4 items tuple since wtforms 3.1, this "
"will be mandatory in wtforms 3.2:DeprecationWarning",
)
def test_model(
app: Flask,
sqla_db_ext: T_ANY_SQLA_PROVIDER,
admin: Admin,
session_or_db: T_LITERAL_SESSION_OR_DB,
) -> None:
with app.app_context():
Model1, Model2 = create_models(sqla_db_ext)
param = skip_or_return_session_or_db(sqla_db_ext, session_or_db)
view = CustomModelView(Model1, param)
admin.add_view(view)
assert view.model == Model1
assert view.name == "Model1"
assert view.endpoint == "model1"
assert view._primary_key == "id"
assert "test1" in view._sortable_columns
assert "test2" in view._sortable_columns
assert "test3" in view._sortable_columns
assert "test4" in view._sortable_columns
assert view._create_form_class is not None
assert view._edit_form_class is not None
assert not view._search_supported
assert view._filters is None
# Verify form
assert view._create_form_class.test1.field_class == fields.StringField # type: ignore[attr-defined]
assert view._create_form_class.test2.field_class == fields.StringField # type: ignore[attr-defined]
assert view._create_form_class.test3.field_class == fields.TextAreaField # type: ignore[attr-defined]
assert view._create_form_class.test4.field_class == fields.TextAreaField # type: ignore[attr-defined]
assert view._create_form_class.email_field.field_class == fields.StringField # type: ignore[attr-defined]
assert view._create_form_class.choice_field.field_class == Select2Field # type: ignore[attr-defined]
assert view._create_form_class.enum_field.field_class == Select2Field # type: ignore[attr-defined]
assert view._create_form_class.sqla_utils_choice.field_class == Select2Field # type: ignore[attr-defined]
assert view._create_form_class.sqla_utils_enum.field_class == Select2Field # type: ignore[attr-defined]
assert view._create_form_class.sqla_utils_arrow.field_class == DateTimeField # type: ignore[attr-defined]
assert view._create_form_class.sqla_utils_uuid.field_class == fields.StringField # type: ignore[attr-defined]
assert view._create_form_class.sqla_utils_url.field_class == fields.StringField # type: ignore[attr-defined]
assert (
view._create_form_class.sqla_utils_ip_address.field_class # type: ignore[attr-defined]
== fields.StringField
)
assert (
view._create_form_class.sqla_utils_currency.field_class # type: ignore[attr-defined]
== fields.StringField
)
assert (
view._create_form_class.sqla_utils_color.field_class == fields.StringField # type: ignore[attr-defined]
)
# Make some test clients
client = app.test_client()
# check that we can retrieve a list view
rv = client.get("/admin/model1/")
assert rv.status_code == 200
# check that we can retrieve a 'create' view
rv = client.get("/admin/model1/new/")
assert rv.status_code == 200
# create a new record
uuid_obj = uuid.uuid4()
rv = client.post(
"/admin/model1/new/",
data=dict(
test1="test1large",
test2="test2",
time_field=time(0, 0, 0),
email_field="Test@TEST.com",
choice_field="choice-1",
enum_field="model1_v1",
sqla_utils_choice="choice-1",
sqla_utils_enum=1,
sqla_utils_arrow="2018-10-27 14:17:00",
sqla_utils_uuid=str(uuid_obj),
sqla_utils_url="http://www.example.com",
sqla_utils_ip_address="127.0.0.1",
sqla_utils_currency="USD",
sqla_utils_color="#f0f0f0",
),
)
assert rv.status_code == 302
# check that the new record was persisted
model = sqla_db_ext.db.session.query(Model1).first()
assert model
assert model.test1 == "test1large"
assert model.test2 == "test2"
assert model.test3 is None
assert model.test4 is None
assert model.email_field == "test@test.com"
assert model.choice_field == "choice-1"
assert model.enum_field == "model1_v1"
assert model.sqla_utils_choice == "choice-1"
assert model.sqla_utils_enum.value == 1
assert model.sqla_utils_arrow == arrow.get("2018-10-27 14:17:00")
assert model.sqla_utils_uuid == uuid_obj
assert model.sqla_utils_url == "http://www.example.com"
assert str(model.sqla_utils_ip_address) == "127.0.0.1"
assert str(model.sqla_utils_currency) == "USD"
assert model.sqla_utils_color.hex == "#f0f0f0"
# check that the new record shows up on the list view
rv = client.get("/admin/model1/")
assert rv.status_code == 200
assert "test1large" in rv.data.decode("utf-8")
# check that we can retrieve an edit view
url = f"/admin/model1/edit/?id={model.id}"
rv = client.get(url)
assert rv.status_code == 200
# verify that midnight does not show as blank
assert "00:00:00" in rv.data.decode("utf-8")
# edit the record
new_uuid_obj = uuid.uuid4()
rv = client.post(
url,
data=dict(
test1="test1small",
test2="test2large",
email_field="Test2@TEST.com",
choice_field="__None",
enum_field="__None",
sqla_utils_choice="__None",
sqla_utils_enum="__None",
sqla_utils_arrow="",
sqla_utils_uuid=str(new_uuid_obj),
sqla_utils_url="",
sqla_utils_ip_address="",
sqla_utils_currency="",
sqla_utils_color="",
),
)
assert rv.status_code == 302
# check that the changes were persisted
model = sqla_db_ext.db.session.query(Model1).first()
assert model
assert model.test1 == "test1small"
assert model.test2 == "test2large"
assert model.test3 is None
assert model.test4 is None
assert model.email_field == "test2@test.com"
assert model.choice_field is None
assert model.enum_field is None
assert model.sqla_utils_choice is None
assert model.sqla_utils_enum is None
assert model.sqla_utils_arrow is None
assert model.sqla_utils_uuid == new_uuid_obj
assert model.sqla_utils_url is None
assert model.sqla_utils_ip_address is None
assert model.sqla_utils_currency is None
assert model.sqla_utils_color is None
# check that the model can be deleted
url = f"/admin/model1/delete/?id={model.id}"
rv = client.post(url)
assert rv.status_code == 302
assert sqla_db_ext.db.session.query(Model1).count() == 0
@pytest.mark.xfail(raises=Exception)
def test_no_pk(
app: Flask,
sqla_db_ext: T_ANY_SQLA_PROVIDER,
admin: Admin,
session_or_db: T_LITERAL_SESSION_OR_DB,
) -> None:
class Model(sqla_db_ext.Base): # type: ignore[misc, name-defined]
__tablename__ = "model"
test = Column(Integer)
param = skip_or_return_session_or_db(sqla_db_ext, session_or_db)
view = CustomModelView(Model, param)
admin.add_view(view)
def test_list_columns(
app: Flask,
sqla_db_ext: T_ANY_SQLA_PROVIDER,
admin: Admin,
session_or_db: T_LITERAL_SESSION_OR_DB,
) -> None:
with app.app_context():
Model1, Model2 = create_models(sqla_db_ext)
param = skip_or_return_session_or_db(sqla_db_ext, session_or_db)
# test column_list with a list of strings
view = CustomModelView(
Model1,
param,
column_list=["test1", "test3"],
column_labels=dict(test1="Column1"),
)
admin.add_view(view)
# test column_list with a list of SQLAlchemy columns
view2 = CustomModelView(
Model1,
param,
endpoint="model1_2",
column_list=[Model1.test1, Model1.test3], # type: ignore[attr-defined]
column_labels=dict(test1="Column1"),
)
admin.add_view(view2)
assert len(view._list_columns) == 2
assert view._list_columns == [("test1", "Column1"), ("test3", "Test3")]
client = app.test_client()
rv = client.get("/admin/model1/")
data = rv.data.decode("utf-8")
assert "Column1" in data
assert "Test2" not in data
assert len(view2._list_columns) == 2
assert view2._list_columns == [("test1", "Column1"), ("test3", "Test3")]
rv = client.get("/admin/model1_2/")
data = rv.data.decode("utf-8")
assert "Column1" in data
assert "Test2" not in data
def test_complex_list_columns(
app: Flask,
sqla_db_ext: T_ANY_SQLA_PROVIDER,
admin: Admin,
session_or_db: T_LITERAL_SESSION_OR_DB,
) -> None:
with app.app_context():
M1, M2 = create_models(sqla_db_ext)
m1 = M1(test1="model1_val1")
sqla_db_ext.db.session.add(m1)
sqla_db_ext.db.session.add(M2(string_field="model2_val1", model1=m1))
sqla_db_ext.db.session.commit()
# test column_list with a list of strings on a relation
param = skip_or_return_session_or_db(sqla_db_ext, session_or_db)
view = CustomModelView(M2, param, column_list=["model1.test1"])
admin.add_view(view)
client = app.test_client()
rv = client.get("/admin/model2/")
assert rv.status_code == 200
data = rv.data.decode("utf-8")
assert "model1_val1" in data
def test_exclude_columns(
app: Flask,
sqla_db_ext: T_ANY_SQLA_PROVIDER,
admin: Admin,
session_or_db: T_LITERAL_SESSION_OR_DB,
) -> None:
with app.app_context():
Model1, Model2 = create_models(sqla_db_ext)
param = skip_or_return_session_or_db(sqla_db_ext, session_or_db)
view = CustomModelView(
Model1,
param,
column_exclude_list=[
"test2",
"test4",
"enum_field",
"enum_type_field",
"date_field",
"datetime_field",
"time_field",
"sqla_utils_choice",
"sqla_utils_enum",
"sqla_utils_arrow",
"sqla_utils_uuid",
"sqla_utils_url",
"sqla_utils_ip_address",
"sqla_utils_currency",
"sqla_utils_color",
],
)
admin.add_view(view)
assert view._list_columns == [
("test1", "Test1"),
("test3", "Test3"),
("bool_field", "Bool Field"),
("email_field", "Email Field"),
("choice_field", "Choice Field"),
]
client = app.test_client()
rv = client.get("/admin/model1/")
data = rv.data.decode("utf-8")
assert "Test1" in data
assert "Test2" not in data
def test_column_searchable_list(
app: Flask,
sqla_db_ext: T_ANY_SQLA_PROVIDER,
admin: Admin,
session_or_db: T_LITERAL_SESSION_OR_DB,
) -> None:
with app.app_context():
Model1, Model2 = create_models(sqla_db_ext)
param = skip_or_return_session_or_db(sqla_db_ext, session_or_db)
view = CustomModelView(
Model2, param, column_searchable_list=["string_field", "int_field"]
)
admin.add_view(view)
assert view._search_supported
assert view._search_fields
assert len(view._search_fields) == 2
assert isinstance(view._search_fields[0][0], Column)
assert isinstance(view._search_fields[1][0], Column)
assert view._search_fields[0][0].name == "string_field"
assert view._search_fields[1][0].name == "int_field"
sqla_db_ext.db.session.add(Model2(string_field="model1-test", int_field=5000))
sqla_db_ext.db.session.add(Model2(string_field="model2-test", int_field=9000))
sqla_db_ext.db.session.commit()
client = app.test_client()
rv = client.get("/admin/model2/?search=model1")
data = rv.data.decode("utf-8")
assert "model1-test" in data
assert "model2-test" not in data
rv = client.get("/admin/model2/?search=9000")
data = rv.data.decode("utf-8")
assert "model1-test" not in data
assert "model2-test" in data
def test_extra_args_search(
app: Flask,
sqla_db_ext: T_ANY_SQLA_PROVIDER,
admin: Admin,
session_or_db: T_LITERAL_SESSION_OR_DB,
) -> None:
with app.app_context():
Model1, Model2 = create_models(sqla_db_ext)
param = skip_or_return_session_or_db(sqla_db_ext, session_or_db)
view1 = CustomModelView(
Model1,
param,
column_searchable_list=[
"test1",
],
)
admin.add_view(view1)
sqla_db_ext.db.session.add(
Model2(
string_field="model1-test",
)
)
sqla_db_ext.db.session.commit()
client = app.test_client()
# check that extra args in the url are propagated as hidden fields in the
# search form
rv = client.get("/admin/model1/?search=model1&foo=bar")
data = rv.data.decode("utf-8")
assert '<input type="hidden" name="foo" value="bar">' in data
def test_extra_args_filter(
app: Flask,
sqla_db_ext: T_ANY_SQLA_PROVIDER,
admin: Admin,
session_or_db: T_LITERAL_SESSION_OR_DB,
) -> None:
with app.app_context():
Model1, Model2 = create_models(sqla_db_ext)
param = skip_or_return_session_or_db(sqla_db_ext, session_or_db)
view2 = CustomModelView(
Model2,
param,
column_filters=[
"int_field",
],
)
admin.add_view(view2)
sqla_db_ext.db.session.add(Model2(string_field="model2-test", int_field=5000))
sqla_db_ext.db.session.commit()
client = app.test_client()
# check that extra args in the url are propagated as hidden fields in the form
rv = client.get("/admin/model2/?flt1_0=5000&foo=bar")
data = rv.data.decode("utf-8")
assert '<input type="hidden" name="foo" value="bar">' in data
def test_complex_searchable_list(
app: Flask,
sqla_db_ext: T_ANY_SQLA_PROVIDER,
admin: Admin,
session_or_db: T_LITERAL_SESSION_OR_DB,
) -> None:
with app.app_context():
Model1, Model2 = create_models(sqla_db_ext)
param = skip_or_return_session_or_db(sqla_db_ext, session_or_db)
view = CustomModelView(Model2, param, column_searchable_list=["model1.test1"])
admin.add_view(view)
view2 = CustomModelView(
Model1,
param,
column_searchable_list=[Model2.string_field], # type: ignore[attr-defined]
)
admin.add_view(view2)
m1 = Model1(test1="model1-test1-val")
m2 = Model1(test1="model1-test2-val")
sqla_db_ext.db.session.add(m1)
sqla_db_ext.db.session.add(m2)
sqla_db_ext.db.session.add(Model2(string_field="model2-test1-val", model1=m1))
sqla_db_ext.db.session.add(Model2(string_field="model2-test2-val", model1=m2))
sqla_db_ext.db.session.commit()
client = app.test_client()
# test relation string - 'model1.test1'
rv = client.get("/admin/model2/?search=model1-test1")
data = rv.data.decode("utf-8")
assert "model2-test1-val" in data
assert "model2-test2-val" not in data
# test relation object - Model2.string_field
rv = client.get("/admin/model1/?search=model2-test1")
data = rv.data.decode("utf-8")
assert "model1-test1-val" in data
assert "model1-test2-val" not in data
def test_complex_searchable_list_missing_children(
app: Flask,
sqla_db_ext: T_ANY_SQLA_PROVIDER,
admin: Admin,
session_or_db: T_LITERAL_SESSION_OR_DB,
) -> None:
with app.app_context():
Model1, Model2 = create_models(sqla_db_ext)
param = skip_or_return_session_or_db(sqla_db_ext, session_or_db)
view = CustomModelView(
Model1, param, column_searchable_list=["test1", "model2.string_field"]
)
admin.add_view(view)
sqla_db_ext.db.session.add(Model1(test1="magic string"))
sqla_db_ext.db.session.commit()
client = app.test_client()
rv = client.get("/admin/model1/?search=magic")
data = rv.data.decode("utf-8")
assert "magic string" in data
def test_column_editable_list(
app: Flask,
sqla_db_ext: T_ANY_SQLA_PROVIDER,
admin: Admin,
session_or_db: T_LITERAL_SESSION_OR_DB,
) -> None:
with app.app_context():
Model1, Model2 = create_models(sqla_db_ext)
param = skip_or_return_session_or_db(sqla_db_ext, session_or_db)
view = CustomModelView(
Model1, param, column_editable_list=["test1", "enum_field"]
)
admin.add_view(view)
# Test in-line editing for relations
view = CustomModelView(Model2, param, column_editable_list=["model1"])
admin.add_view(view)
fill_db(sqla_db_ext, Model1, Model2)
client = app.test_client()
# Test in-line edit field rendering
rv = client.get("/admin/model1/")
data = rv.data.decode("utf-8")
assert 'data-role="x-editable"' in data
# Form - Test basic in-line edit functionality
rv = client.post(
"/admin/model1/ajax/update/",
data={
"list_form_pk": "1",
"test1": "change-success-1",
},
)
data = rv.data.decode("utf-8")
assert "Record was successfully saved." == data
# ensure the value has changed
rv = client.get("/admin/model1/")
data = rv.data.decode("utf-8")
assert "change-success-1" in data
# Test validation error
rv = client.post(
"/admin/model1/ajax/update/",
data={
"list_form_pk": "1",
"enum_field": "problematic-input",
},
)
assert rv.status_code == 500
# Test invalid primary key
rv = client.post(
"/admin/model1/ajax/update/",
data={
"list_form_pk": "1000",
"test1": "problematic-input",
},
)
data = rv.data.decode("utf-8")
assert rv.status_code == 500
# Test editing column not in column_editable_list
rv = client.post(
"/admin/model1/ajax/update/",
data={
"list_form_pk": "1",
"test2": "problematic-input",
},
)
data = rv.data.decode("utf-8")
assert "problematic-input" not in data
rv = client.post(
"/admin/model2/ajax/update/",
data={
"list_form_pk": "1",
"model1": "3",
},
)
data = rv.data.decode("utf-8")
assert "Record was successfully saved." == data
# confirm the value has changed
rv = client.get("/admin/model2/")
data = rv.data.decode("utf-8")
assert "test1_val_3" in data
def test_details_view(
app: Flask,
sqla_db_ext: T_ANY_SQLA_PROVIDER,
admin: Admin,
session_or_db: T_LITERAL_SESSION_OR_DB,
) -> None:
with app.app_context():
Model1, Model2 = create_models(sqla_db_ext)
param = skip_or_return_session_or_db(sqla_db_ext, session_or_db)
view_no_details = CustomModelView(Model1, param)
admin.add_view(view_no_details)
# fields are scaffolded
view_w_details = CustomModelView(Model2, param, can_view_details=True)
admin.add_view(view_w_details)
# show only specific fields in details w/ column_details_list
string_field_view = CustomModelView(
Model2,
param,
can_view_details=True,
column_details_list=["string_field"],
endpoint="sf_view",
)
admin.add_view(string_field_view)
fill_db(sqla_db_ext, Model1, Model2)
client = app.test_client()
# ensure link to details is hidden when can_view_details is disabled
rv = client.get("/admin/model1/")
data = rv.data.decode("utf-8")
assert "/admin/model1/details/" not in data
# ensure link to details view appears
rv = client.get("/admin/model2/")
data = rv.data.decode("utf-8")
assert "/admin/model2/details/" in data
# test redirection when details are disabled
rv = client.get("/admin/model1/details/?url=%2Fadmin%2Fmodel1%2F&id=1")
assert rv.status_code == 302
# test if correct data appears in details view when enabled
rv = client.get("/admin/model2/details/?url=%2Fadmin%2Fmodel2%2F&id=1")
data = rv.data.decode("utf-8")
assert "String Field" in data
assert "test2_val_1" in data
assert "test1_val_1" in data
# test column_details_list
rv = client.get("/admin/sf_view/details/?url=%2Fadmin%2Fsf_view%2F&id=1")
data = rv.data.decode("utf-8")
assert "String Field" in data
assert "test2_val_1" in data
assert "test1_val_1" not in data
def test_editable_list_special_pks(
app: Flask,
sqla_db_ext: T_ANY_SQLA_PROVIDER,
admin: Admin,
session_or_db: T_LITERAL_SESSION_OR_DB,
) -> None:
"""Tests editable list view + a primary key with special characters"""
with app.app_context():
class Model1(sqla_db_ext.Base): # type: ignore[misc, name-defined]
__tablename__ = "model1"
def __init__(self, id: t.Any = None, val1: t.Any = None) -> None:
self.id = id
self.val1 = val1
id = Column(String(20), primary_key=True) # type: ignore[assignment]
val1 = Column(String(20))
sqla_db_ext.create_all()
param = skip_or_return_session_or_db(sqla_db_ext, session_or_db)
view = CustomModelView(Model1, param, column_editable_list=["val1"])
admin.add_view(view)
sqla_db_ext.db.session.add(Model1("1-1", "test1"))
sqla_db_ext.db.session.add(Model1("1-5", "test2"))
sqla_db_ext.db.session.commit()
client = app.test_client()
# Form - Test basic in-line edit functionality
rv = client.post(
"/admin/model1/ajax/update/",
data={
"list_form_pk": "1-1",
"val1": "change-success-1",
},
)
data = rv.data.decode("utf-8")
assert "Record was successfully saved." == data
# ensure the value has changed
rv = client.get("/admin/model1/")
data = rv.data.decode("utf-8")
assert "change-success-1" in data
def test_column_filters(
app: Flask,
sqla_db_ext: T_ANY_SQLA_PROVIDER,
admin: Admin,
session_or_db: T_LITERAL_SESSION_OR_DB,
) -> None:
with app.app_context():
Model1, Model2 = create_models(sqla_db_ext)
param = skip_or_return_session_or_db(sqla_db_ext, session_or_db)
view1 = CustomModelView(Model1, param, column_filters=["test1"])
admin.add_view(view1)
client = app.test_client()
assert view1._filters
assert len(view1._filters) == 7
# Generate views
view2 = CustomModelView(Model2, param, column_filters=["model1"])
view5 = CustomModelView(
Model1, param, column_filters=["test1"], endpoint="_strings"
)
admin.add_view(view5)
view6 = CustomModelView(Model2, param, column_filters=["int_field"])
admin.add_view(view6)
view7 = CustomModelView(
Model1, param, column_filters=["bool_field"], endpoint="_bools"
)
admin.add_view(view7)
view8 = CustomModelView(
Model2, param, column_filters=["float_field"], endpoint="_float"
)
admin.add_view(view8)
view9 = CustomModelView(
Model2,
param,
endpoint="_model2",
column_filters=["model1.bool_field"],
column_list=[
"string_field",
"model1.id",
"model1.bool_field",
],
)
admin.add_view(view9)
view10 = CustomModelView(
Model1,
param,
column_filters=["test1"],
endpoint="_model3",
named_filter_urls=True,
)
admin.add_view(view10)
view11 = CustomModelView(
Model1,
param,
column_filters=["date_field", "datetime_field", "time_field"],
endpoint="_datetime",
)
admin.add_view(view11)
view12 = CustomModelView(
Model1, param, column_filters=["enum_field"], endpoint="_enumfield"
)
admin.add_view(view12)
view13 = CustomModelView(
Model2,
param,
column_filters=[filters.FilterEqual(Model1.test1, "Test1")], # type: ignore[attr-defined]
endpoint="_relation_test",
)
admin.add_view(view13)
view14 = CustomModelView(
Model1,
param,
column_filters=["enum_type_field"],
endpoint="_enumtypefield",
)
admin.add_view(view14)
# Test views
assert view1._filter_groups
assert [