forked from MicroPythonOS/MicroPythonOS
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_shared_preferences.py
More file actions
688 lines (555 loc) · 28.4 KB
/
test_shared_preferences.py
File metadata and controls
688 lines (555 loc) · 28.4 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
import unittest
import os
from mpos import SharedPreferences
from mpos.config import Editor
class TestSharedPreferences(unittest.TestCase):
"""Test suite for SharedPreferences configuration storage."""
def setUp(self):
"""Set up test fixtures before each test method."""
self.test_app_name = "com.test.unittest"
self.test_dir = f"data/{self.test_app_name}"
self.test_file = f"{self.test_dir}/config.json"
# Clean up any existing test data
self._cleanup()
def tearDown(self):
"""Clean up test fixtures after each test method."""
self._cleanup()
def _cleanup(self):
"""Remove test data directory if it exists."""
try:
# Use os.stat() instead of os.path.exists() for MicroPython compatibility
try:
os.stat(self.test_file)
os.remove(self.test_file)
except OSError:
pass # File doesn't exist, that's fine
try:
os.stat(self.test_dir)
os.rmdir(self.test_dir)
except OSError:
pass # Directory doesn't exist, that's fine
try:
os.stat("data")
# Try to remove data directory, but it might have other contents
try:
os.rmdir("data")
except OSError:
# Directory not empty, that's okay
pass
except OSError:
pass # Directory doesn't exist, that's fine
except Exception as e:
# Cleanup failure is not critical for tests
print(f"Cleanup warning: {e}")
# ============================================================
# Basic String Operations
# ============================================================
def test_put_get_string(self):
"""Test storing and retrieving a string value."""
prefs = SharedPreferences(self.test_app_name)
editor = prefs.edit()
editor.put_string("username", "testuser")
editor.commit()
# Reload to verify persistence
prefs2 = SharedPreferences(self.test_app_name)
self.assertEqual(prefs2.get_string("username"), "testuser")
def test_get_string_default(self):
"""Test getting a string with default value when key doesn't exist."""
prefs = SharedPreferences(self.test_app_name)
self.assertEqual(prefs.get_string("nonexistent", "default"), "default")
self.assertIsNone(prefs.get_string("nonexistent"))
def test_put_string_overwrites(self):
"""Test that putting a string overwrites existing value."""
prefs = SharedPreferences(self.test_app_name)
prefs.edit().put_string("key", "value1").commit()
prefs.edit().put_string("key", "value2").commit()
prefs2 = SharedPreferences(self.test_app_name)
self.assertEqual(prefs2.get_string("key"), "value2")
# ============================================================
# Integer Operations
# ============================================================
def test_put_get_int(self):
"""Test storing and retrieving an integer value."""
prefs = SharedPreferences(self.test_app_name)
editor = prefs.edit()
editor.put_int("count", 42)
editor.commit()
prefs2 = SharedPreferences(self.test_app_name)
self.assertEqual(prefs2.get_int("count"), 42)
def test_get_int_default(self):
"""Test getting an integer with default value when key doesn't exist."""
prefs = SharedPreferences(self.test_app_name)
self.assertEqual(prefs.get_int("nonexistent", 100), 100)
self.assertEqual(prefs.get_int("nonexistent"), 0)
def test_get_int_invalid_type(self):
"""Test getting an integer when stored value is invalid."""
prefs = SharedPreferences(self.test_app_name)
prefs.edit().put_string("invalid", "not_a_number").commit()
prefs2 = SharedPreferences(self.test_app_name)
self.assertEqual(prefs2.get_int("invalid", 99), 99)
# ============================================================
# Boolean Operations
# ============================================================
def test_put_get_bool(self):
"""Test storing and retrieving boolean values."""
prefs = SharedPreferences(self.test_app_name)
prefs.edit().put_bool("enabled", True).commit()
prefs.edit().put_bool("disabled", False).commit()
prefs2 = SharedPreferences(self.test_app_name)
self.assertTrue(prefs2.get_bool("enabled"))
self.assertFalse(prefs2.get_bool("disabled"))
def test_get_bool_default(self):
"""Test getting a boolean with default value when key doesn't exist."""
prefs = SharedPreferences(self.test_app_name)
self.assertTrue(prefs.get_bool("nonexistent", True))
self.assertFalse(prefs.get_bool("nonexistent", False))
self.assertFalse(prefs.get_bool("nonexistent"))
# ============================================================
# List Operations
# ============================================================
def test_put_get_list(self):
"""Test storing and retrieving a list."""
prefs = SharedPreferences(self.test_app_name)
test_list = [1, 2, 3, "four"]
prefs.edit().put_list("mylist", test_list).commit()
prefs2 = SharedPreferences(self.test_app_name)
self.assertEqual(prefs2.get_list("mylist"), test_list)
def test_get_list_default(self):
"""Test getting a list with default value when key doesn't exist."""
prefs = SharedPreferences(self.test_app_name)
self.assertEqual(prefs.get_list("nonexistent"), [])
self.assertEqual(prefs.get_list("nonexistent", ["a", "b"]), ["a", "b"])
def test_append_to_list(self):
"""Test appending items to a list."""
prefs = SharedPreferences(self.test_app_name)
editor = prefs.edit()
editor.append_to_list("items", {"id": 1, "name": "first"})
editor.append_to_list("items", {"id": 2, "name": "second"})
editor.commit()
prefs2 = SharedPreferences(self.test_app_name)
items = prefs2.get_list("items")
self.assertEqual(len(items), 2)
self.assertEqual(items[0]["id"], 1)
self.assertEqual(items[1]["name"], "second")
def test_update_list_item(self):
"""Test updating an item in a list."""
prefs = SharedPreferences(self.test_app_name)
prefs.edit().put_list("items", [{"a": 1}, {"b": 2}]).commit()
prefs.edit().update_list_item("items", 1, {"b": 99}).commit()
prefs2 = SharedPreferences(self.test_app_name)
items = prefs2.get_list("items")
self.assertEqual(items[1]["b"], 99)
def test_remove_from_list(self):
"""Test removing an item from a list."""
prefs = SharedPreferences(self.test_app_name)
prefs.edit().put_list("items", [{"a": 1}, {"b": 2}, {"c": 3}]).commit()
prefs.edit().remove_from_list("items", 1).commit()
prefs2 = SharedPreferences(self.test_app_name)
items = prefs2.get_list("items")
self.assertEqual(len(items), 2)
self.assertEqual(items[0]["a"], 1)
self.assertEqual(items[1]["c"], 3)
def test_get_list_item(self):
"""Test getting a specific field from a list item."""
prefs = SharedPreferences(self.test_app_name)
prefs.edit().put_list("users", [
{"name": "Alice", "age": 30},
{"name": "Bob", "age": 25}
]).commit()
self.assertEqual(prefs.get_list_item("users", 0, "name"), "Alice")
self.assertEqual(prefs.get_list_item("users", 1, "age"), 25)
self.assertIsNone(prefs.get_list_item("users", 99, "name"))
self.assertEqual(prefs.get_list_item("users", 99, "name", "default"), "default")
def test_get_list_item_dict(self):
"""Test getting an entire dictionary from a list."""
prefs = SharedPreferences(self.test_app_name)
prefs.edit().put_list("configs", [{"key": "value"}]).commit()
item = prefs.get_list_item_dict("configs", 0)
self.assertEqual(item["key"], "value")
self.assertEqual(prefs.get_list_item_dict("configs", 99), {})
# ============================================================
# Dictionary Operations
# ============================================================
def test_put_get_dict(self):
"""Test storing and retrieving a dictionary."""
prefs = SharedPreferences(self.test_app_name)
test_dict = {"key1": "value1", "key2": 42}
prefs.edit().put_dict("mydict", test_dict).commit()
prefs2 = SharedPreferences(self.test_app_name)
self.assertEqual(prefs2.get_dict("mydict"), test_dict)
def test_get_dict_default(self):
"""Test getting a dict with default value when key doesn't exist."""
prefs = SharedPreferences(self.test_app_name)
self.assertEqual(prefs.get_dict("nonexistent"), {})
self.assertEqual(prefs.get_dict("nonexistent", {"default": True}), {"default": True})
def test_put_dict_item(self):
"""Test adding items to a dictionary."""
prefs = SharedPreferences(self.test_app_name)
editor = prefs.edit()
editor.put_dict_item("wifi_aps", "HomeNetwork", {"password": "secret123", "priority": 1})
editor.put_dict_item("wifi_aps", "WorkNetwork", {"password": "work456", "priority": 2})
editor.commit()
prefs2 = SharedPreferences(self.test_app_name)
self.assertEqual(prefs2.get_dict_item("wifi_aps", "HomeNetwork")["password"], "secret123")
self.assertEqual(prefs2.get_dict_item("wifi_aps", "WorkNetwork")["priority"], 2)
def test_remove_dict_item(self):
"""Test removing an item from a dictionary."""
prefs = SharedPreferences(self.test_app_name)
prefs.edit().put_dict("items", {"a": 1, "b": 2, "c": 3}).commit()
prefs.edit().remove_dict_item("items", "b").commit()
prefs2 = SharedPreferences(self.test_app_name)
items = prefs2.get_dict("items")
self.assertEqual(len(items), 2)
self.assertIn("a", items)
self.assertIn("c", items)
self.assertFalse("b" in items) # Use 'in' operator instead of assertNotIn
def test_get_dict_item(self):
"""Test getting a specific item from a dictionary."""
prefs = SharedPreferences(self.test_app_name)
prefs.edit().put_dict("settings", {
"theme": {"color": "blue", "size": 14},
"audio": {"volume": 80}
}).commit()
theme = prefs.get_dict_item("settings", "theme")
self.assertEqual(theme["color"], "blue")
self.assertEqual(prefs.get_dict_item("settings", "nonexistent"), {})
def test_get_dict_item_field(self):
"""Test getting a specific field from a dict item."""
prefs = SharedPreferences(self.test_app_name)
prefs.edit().put_dict("networks", {
"ssid1": {"password": "pass1", "signal": 100},
"ssid2": {"password": "pass2", "signal": 50}
}).commit()
self.assertEqual(prefs.get_dict_item_field("networks", "ssid1", "password"), "pass1")
self.assertEqual(prefs.get_dict_item_field("networks", "ssid2", "signal"), 50)
self.assertIsNone(prefs.get_dict_item_field("networks", "ssid99", "password"))
self.assertEqual(prefs.get_dict_item_field("networks", "ssid1", "missing", "def"), "def")
def test_get_dict_keys(self):
"""Test getting all keys from a dictionary."""
prefs = SharedPreferences(self.test_app_name)
prefs.edit().put_dict("items", {"a": 1, "b": 2, "c": 3}).commit()
keys = prefs.get_dict_keys("items")
self.assertEqual(len(keys), 3)
self.assertIn("a", keys)
self.assertIn("b", keys)
self.assertIn("c", keys)
def test_get_dict_keys_nonexistent(self):
"""Test getting keys from a nonexistent dictionary."""
prefs = SharedPreferences(self.test_app_name)
self.assertEqual(prefs.get_dict_keys("nonexistent"), [])
# ============================================================
# Editor Operations
# ============================================================
def test_editor_chaining(self):
"""Test that editor methods can be chained."""
prefs = SharedPreferences(self.test_app_name)
prefs.edit()\
.put_string("name", "test")\
.put_int("count", 5)\
.put_bool("enabled", True)\
.commit()
prefs2 = SharedPreferences(self.test_app_name)
self.assertEqual(prefs2.get_string("name"), "test")
self.assertEqual(prefs2.get_int("count"), 5)
self.assertTrue(prefs2.get_bool("enabled"))
def test_editor_apply_vs_commit(self):
"""Test that both apply and commit save data."""
prefs = SharedPreferences(self.test_app_name)
# Test apply
prefs.edit().put_string("key1", "apply_test").apply()
prefs2 = SharedPreferences(self.test_app_name)
self.assertEqual(prefs2.get_string("key1"), "apply_test")
# Test commit
prefs.edit().put_string("key2", "commit_test").commit()
prefs3 = SharedPreferences(self.test_app_name)
self.assertEqual(prefs3.get_string("key2"), "commit_test")
def test_editor_without_commit_doesnt_save(self):
"""Test that changes without commit/apply are not persisted."""
prefs = SharedPreferences(self.test_app_name)
editor = prefs.edit()
editor.put_string("unsaved", "value")
# Don't call commit() or apply()
# Reload and verify data wasn't saved
prefs2 = SharedPreferences(self.test_app_name)
self.assertIsNone(prefs2.get_string("unsaved"))
def test_multiple_edits(self):
"""Test multiple sequential edit operations."""
prefs = SharedPreferences(self.test_app_name)
prefs.edit().put_string("step", "1").commit()
prefs.edit().put_string("step", "2").commit()
prefs.edit().put_string("step", "3").commit()
prefs2 = SharedPreferences(self.test_app_name)
self.assertEqual(prefs2.get_string("step"), "3")
# ============================================================
# File Persistence
# ============================================================
def test_directory_creation(self):
"""Test that directory structure is created automatically."""
prefs = SharedPreferences(self.test_app_name)
prefs.edit().put_string("test", "value").commit()
# Use os.stat() instead of os.path.exists() for MicroPython
try:
os.stat("data")
data_exists = True
except OSError:
data_exists = False
self.assertTrue(data_exists)
try:
os.stat(self.test_dir)
dir_exists = True
except OSError:
dir_exists = False
self.assertTrue(dir_exists)
try:
os.stat(self.test_file)
file_exists = True
except OSError:
file_exists = False
self.assertTrue(file_exists)
def test_custom_filename(self):
"""Test using a custom filename for preferences."""
prefs = SharedPreferences(self.test_app_name, "custom.json")
prefs.edit().put_string("custom", "data").commit()
custom_file = f"{self.test_dir}/custom.json"
# Use os.stat() instead of os.path.exists() for MicroPython
try:
os.stat(custom_file)
file_exists = True
except OSError:
file_exists = False
self.assertTrue(file_exists)
prefs2 = SharedPreferences(self.test_app_name, "custom.json")
self.assertEqual(prefs2.get_string("custom"), "data")
def test_load_existing_file(self):
"""Test loading from an existing preferences file."""
# Create initial prefs
prefs1 = SharedPreferences(self.test_app_name)
prefs1.edit().put_string("existing", "data").commit()
# Load in a new instance
prefs2 = SharedPreferences(self.test_app_name)
self.assertEqual(prefs2.get_string("existing"), "data")
# ============================================================
# Edge Cases and Error Handling
# ============================================================
def test_empty_string_values(self):
"""Test storing and retrieving empty strings."""
prefs = SharedPreferences(self.test_app_name)
prefs.edit().put_string("empty", "").commit()
prefs2 = SharedPreferences(self.test_app_name)
self.assertEqual(prefs2.get_string("empty"), "")
def test_zero_values(self):
"""Test storing and retrieving zero values."""
prefs = SharedPreferences(self.test_app_name)
prefs.edit().put_int("zero", 0).put_bool("false", False).commit()
prefs2 = SharedPreferences(self.test_app_name)
self.assertEqual(prefs2.get_int("zero"), 0)
self.assertFalse(prefs2.get_bool("false"))
def test_none_values(self):
"""Test handling None values gracefully."""
prefs = SharedPreferences(self.test_app_name)
# Getting a nonexistent key should return None or default
self.assertIsNone(prefs.get_string("nonexistent"))
def test_special_characters_in_keys(self):
"""Test keys with special characters."""
prefs = SharedPreferences(self.test_app_name)
prefs.edit()\
.put_string("key.with.dots", "value1")\
.put_string("key_with_underscores", "value2")\
.put_string("key-with-dashes", "value3")\
.commit()
prefs2 = SharedPreferences(self.test_app_name)
self.assertEqual(prefs2.get_string("key.with.dots"), "value1")
self.assertEqual(prefs2.get_string("key_with_underscores"), "value2")
self.assertEqual(prefs2.get_string("key-with-dashes"), "value3")
def test_unicode_values(self):
"""Test storing and retrieving Unicode strings."""
prefs = SharedPreferences(self.test_app_name)
prefs.edit().put_string("unicode", "Hello 世界 🌍").commit()
prefs2 = SharedPreferences(self.test_app_name)
self.assertEqual(prefs2.get_string("unicode"), "Hello 世界 🌍")
def test_large_nested_structure(self):
"""Test storing a complex nested data structure."""
prefs = SharedPreferences(self.test_app_name)
complex_data = {
"users": {
"alice": {"age": 30, "roles": ["admin", "user"]},
"bob": {"age": 25, "roles": ["user"]}
},
"settings": {
"theme": "dark",
"notifications": True,
"limits": [10, 20, 30]
}
}
prefs.edit().put_dict("app_data", complex_data).commit()
prefs2 = SharedPreferences(self.test_app_name)
loaded = prefs2.get_dict("app_data")
self.assertEqual(loaded["users"]["alice"]["age"], 30)
self.assertEqual(loaded["settings"]["theme"], "dark")
self.assertEqual(loaded["settings"]["limits"][2], 30)
# Tests for default values feature
def test_constructor_defaults_basic(self):
"""Test that constructor defaults are returned when key is missing."""
defaults = {"brightness": -1, "enabled": True, "name": "default"}
prefs = SharedPreferences(self.test_app_name, defaults=defaults)
# No values stored yet, should return constructor defaults
self.assertEqual(prefs.get_int("brightness"), -1)
self.assertEqual(prefs.get_bool("enabled"), True)
self.assertEqual(prefs.get_string("name"), "default")
def test_method_default_precedence(self):
"""Test that method defaults override constructor defaults."""
defaults = {"brightness": -1, "enabled": False, "name": "default"}
prefs = SharedPreferences(self.test_app_name, defaults=defaults)
# Method defaults should take precedence when different from hardcoded defaults
self.assertEqual(prefs.get_int("brightness", 50), 50)
# For booleans, we can only test when method default differs from hardcoded False
self.assertEqual(prefs.get_bool("enabled", True), True)
self.assertEqual(prefs.get_string("name", "override"), "override")
def test_stored_value_precedence(self):
"""Test that stored values override all defaults."""
defaults = {"brightness": -1, "enabled": True, "name": "default"}
prefs = SharedPreferences(self.test_app_name, defaults=defaults)
# Store some values
prefs.edit().put_int("brightness", 75).put_bool("enabled", False).put_string("name", "stored").commit()
# Reload and verify stored values override defaults
prefs2 = SharedPreferences(self.test_app_name, defaults=defaults)
self.assertEqual(prefs2.get_int("brightness"), 75)
self.assertEqual(prefs2.get_bool("enabled"), False)
self.assertEqual(prefs2.get_string("name"), "stored")
# Method defaults should not override stored values
self.assertEqual(prefs2.get_int("brightness", 100), 75)
self.assertEqual(prefs2.get_bool("enabled", True), False)
self.assertEqual(prefs2.get_string("name", "method"), "stored")
def test_default_values_not_saved(self):
"""Test that values matching defaults are not written to disk."""
defaults = {"brightness": -1, "enabled": True, "name": "default"}
prefs = SharedPreferences(self.test_app_name, defaults=defaults)
# Set values matching defaults
prefs.edit().put_int("brightness", -1).put_bool("enabled", True).put_string("name", "default").commit()
# Reload and verify values are returned correctly
prefs2 = SharedPreferences(self.test_app_name, defaults=defaults)
self.assertEqual(prefs2.get_int("brightness"), -1)
self.assertEqual(prefs2.get_bool("enabled"), True)
self.assertEqual(prefs2.get_string("name"), "default")
# Verify raw data doesn't contain the keys (they weren't saved)
self.assertFalse("brightness" in prefs2.data)
self.assertFalse("enabled" in prefs2.data)
self.assertFalse("name" in prefs2.data)
def test_cleanup_removes_defaults(self):
"""Test that setting a value to its default removes it from storage."""
defaults = {"brightness": -1}
prefs = SharedPreferences(self.test_app_name, defaults=defaults)
# Store a non-default value
prefs.edit().put_int("brightness", 75).commit()
prefs2 = SharedPreferences(self.test_app_name, defaults=defaults)
self.assertIn("brightness", prefs2.data)
self.assertEqual(prefs2.get_int("brightness"), 75)
# Change it back to default
prefs2.edit().put_int("brightness", -1).commit()
# Reload and verify it's been removed from storage
prefs3 = SharedPreferences(self.test_app_name, defaults=defaults)
self.assertFalse("brightness" in prefs3.data)
self.assertEqual(prefs3.get_int("brightness"), -1)
def test_none_as_valid_default(self):
"""Test that None can be used as a constructor default value."""
defaults = {"optional_string": None, "optional_list": None}
prefs = SharedPreferences(self.test_app_name, defaults=defaults)
# Should return None for these keys
self.assertIsNone(prefs.get_string("optional_string"))
self.assertIsNone(prefs.get_list("optional_list"))
# Store some values
prefs.edit().put_string("optional_string", "value").put_list("optional_list", [1, 2]).commit()
# Reload
prefs2 = SharedPreferences(self.test_app_name, defaults=defaults)
self.assertEqual(prefs2.get_string("optional_string"), "value")
self.assertEqual(prefs2.get_list("optional_list"), [1, 2])
def test_empty_collection_defaults(self):
"""Test empty lists and dicts as constructor defaults."""
defaults = {"items": [], "settings": {}}
prefs = SharedPreferences(self.test_app_name, defaults=defaults)
# Should return empty collections
self.assertEqual(prefs.get_list("items"), [])
self.assertEqual(prefs.get_dict("settings"), {})
# These should not be saved to disk
prefs.edit().put_list("items", []).put_dict("settings", {}).commit()
prefs2 = SharedPreferences(self.test_app_name, defaults=defaults)
self.assertFalse("items" in prefs2.data)
self.assertFalse("settings" in prefs2.data)
def test_defaults_with_nested_structures(self):
"""Test that defaults work with complex nested structures."""
defaults = {
"config": {"theme": "dark", "size": 12},
"items": [1, 2, 3]
}
prefs = SharedPreferences(self.test_app_name, defaults=defaults)
# Constructor defaults should work
self.assertEqual(prefs.get_dict("config"), {"theme": "dark", "size": 12})
self.assertEqual(prefs.get_list("items"), [1, 2, 3])
# Exact match should not be saved
prefs.edit().put_dict("config", {"theme": "dark", "size": 12}).commit()
prefs2 = SharedPreferences(self.test_app_name, defaults=defaults)
self.assertFalse("config" in prefs2.data)
# Modified value should be saved
prefs2.edit().put_dict("config", {"theme": "light", "size": 12}).commit()
prefs3 = SharedPreferences(self.test_app_name, defaults=defaults)
self.assertIn("config", prefs3.data)
self.assertEqual(prefs3.get_dict("config")["theme"], "light")
def test_backward_compatibility(self):
"""Test that existing code without defaults parameter still works."""
# Old style initialization (no defaults parameter)
prefs = SharedPreferences(self.test_app_name)
# Should work exactly as before
prefs.edit().put_string("key", "value").put_int("count", 42).commit()
prefs2 = SharedPreferences(self.test_app_name)
self.assertEqual(prefs2.get_string("key"), "value")
self.assertEqual(prefs2.get_int("count"), 42)
def test_type_conversion_with_defaults(self):
"""Test type conversion works correctly with constructor defaults."""
defaults = {"number": -1, "flag": True}
prefs = SharedPreferences(self.test_app_name, defaults=defaults)
# Store string representations
prefs.edit().put_string("number", "123").put_string("flag", "false").commit()
# get_int and get_bool should handle conversion
prefs2 = SharedPreferences(self.test_app_name, defaults=defaults)
# Note: the stored values are strings, not ints/bools, so they're different from defaults
self.assertIn("number", prefs2.data)
self.assertIn("flag", prefs2.data)
def test_multiple_editors_with_defaults(self):
"""Test that multiple edit sessions work correctly with defaults."""
defaults = {"brightness": -1, "volume": 50}
prefs = SharedPreferences(self.test_app_name, defaults=defaults)
# First editor session
editor1 = prefs.edit()
editor1.put_int("brightness", 75)
editor1.commit()
# Second editor session
editor2 = prefs.edit()
editor2.put_int("volume", 80)
editor2.commit()
# Verify both values
prefs2 = SharedPreferences(self.test_app_name, defaults=defaults)
self.assertEqual(prefs2.get_int("brightness"), 75)
self.assertEqual(prefs2.get_int("volume"), 80)
self.assertIn("brightness", prefs2.data)
self.assertIn("volume", prefs2.data)
# Set one back to default
prefs2.edit().put_int("brightness", -1).commit()
prefs3 = SharedPreferences(self.test_app_name, defaults=defaults)
self.assertFalse("brightness" in prefs3.data)
self.assertEqual(prefs3.get_int("brightness"), -1)
def test_partial_defaults(self):
"""Test that some keys can have defaults while others don't."""
defaults = {"brightness": -1} # Only brightness has a default
prefs = SharedPreferences(self.test_app_name, defaults=defaults)
# Save multiple values
prefs.edit().put_int("brightness", -1).put_int("volume", 50).put_string("name", "test").commit()
# Reload
prefs2 = SharedPreferences(self.test_app_name, defaults=defaults)
# brightness matches default, should not be in data
self.assertFalse("brightness" in prefs2.data)
self.assertEqual(prefs2.get_int("brightness"), -1)
# volume and name have no defaults, should be in data
self.assertIn("volume", prefs2.data)
self.assertIn("name", prefs2.data)
self.assertEqual(prefs2.get_int("volume"), 50)
self.assertEqual(prefs2.get_string("name"), "test")