Repository navigation
Expand file tree
/
Copy pathtest_newprinter.py
More file actions
3876 lines (3233 loc) · 150 KB
/
Copy pathtest_newprinter.py
File metadata and controls
3876 lines (3233 loc) · 150 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
#!/usr/bin/python3
## Copyright (C) 2015 Red Hat, Inc.
## Authors:
## Alexander Pevzner <pzz@apevzner.com>
## Ayush Singh <ayushsinghceee@gmail.com>
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 2 of the License, or
## (at your option) any later version.
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
## You should have received a copy of the GNU General Public License
## along with this program; if not, write to the Free Software
## Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
import gi
import tempfile
import threading
import time
import pytest
import newprinter
gi.require_version('Gtk', '3.0')
from gi.repository import Gtk, GLib
from unittest.mock import MagicMock
import cupshelpers
import cups
import authconn
class MockPrinter:
def __init__(self, uri):
self.device_uri = uri
class MockExistingPrinter:
def __init__(self, name):
self.discovered = False
self.name = name
class MockDevice:
def __init__(self, uri):
self.uri = uri
def test_configured_uri_exact_match():
dev = MockDevice("ipp://printer/ipp/print")
printers = {"Printer1": MockPrinter("ipp://printer/ipp/print")}
filtered = newprinter._filter_configured_devices([dev], printers)
assert len(filtered) == 0
def test_configured_uri_no_match():
dev = MockDevice("ipp://other-printer/ipp/print")
printers = {"Printer1": MockPrinter("ipp://printer/ipp/print")}
filtered = newprinter._filter_configured_devices([dev], printers)
assert len(filtered) == 1
assert filtered[0].uri == "ipp://other-printer/ipp/print"
def test_configured_uri_missing():
dev = MockDevice("ipp://printer/ipp/print")
printers = {
"Printer1": MockPrinter(None),
"Printer2": MockPrinter("")
}
filtered = newprinter._filter_configured_devices([dev], printers)
assert len(filtered) == 1
def test_multiple_configured_printers():
dev1 = MockDevice("usb://dev1")
dev2 = MockDevice("usb://dev2")
dev3 = MockDevice("usb://dev3") # not configured
printers = {
"P1": MockPrinter("usb://dev1"),
"P2": MockPrinter("usb://dev2")
}
filtered = newprinter._filter_configured_devices([dev1, dev2, dev3], printers)
assert len(filtered) == 1
assert filtered[0].uri == "usb://dev3"
def test_default_ports_normalization():
tests = [
("socket://192.168.1.5", "socket://192.168.1.5:9100"),
("http://192.168.1.5", "http://192.168.1.5:80"),
("https://192.168.1.5", "https://192.168.1.5:443"),
("ipp://192.168.1.5", "ipp://192.168.1.5:631"),
("ipps://192.168.1.5", "ipps://192.168.1.5:631"),
("lpd://192.168.1.5", "lpd://192.168.1.5:515"),
("IPP://192.168.1.5:631", "ipp://192.168.1.5"),
]
for disc_uri, conf_uri in tests:
dev = MockDevice(disc_uri)
printers = {"Printer1": MockPrinter(conf_uri)}
filtered = newprinter._filter_configured_devices([dev], printers)
assert len(filtered) == 0, f"Expected match between {disc_uri} and {conf_uri}"
def test_different_port_no_match():
dev = MockDevice("socket://192.168.1.5:1234")
printers = {"Printer1": MockPrinter("socket://192.168.1.5:9100")}
filtered = newprinter._filter_configured_devices([dev], printers)
assert len(filtered) == 1, "Different ports should not match"
def test_hp_no_device_found_does_not_match_real_printer():
dev = MockDevice("hp:/no_device_found")
printers = {"Printer1": MockPrinter("hp:/net/printer?ip=1.2.3.4")}
filtered = newprinter._filter_configured_devices([dev], printers)
assert len(filtered) == 1, "hp:/no_device_found should not match a real HP printer"
class MockPPDAttr:
def __init__(self, value):
self.value = value
class MockCupsPPD:
def __init__(self, attrs):
self.attrs = attrs
def findAttr(self, name):
if name in self.attrs:
return MockPPDAttr(self.attrs[name])
return None
class MockPPDsCache:
def __init__(self, data):
self.data = data
def getInfoFromPPDName(self, name):
if name in self.data:
return self.data[name]
raise KeyError(name)
def test_driver_name_from_cups_ppd(monkeypatch):
import cups
monkeypatch.setattr(cups, "PPD", MockCupsPPD)
ppd = MockCupsPPD({"NickName": "HP LaserJet 1200", "modelName": "HP LaserJet"})
assert newprinter._get_driver_name_from_ppd(ppd, None) == "HP LaserJet 1200"
ppd2 = MockCupsPPD({"modelName": "HP LaserJet"})
assert newprinter._get_driver_name_from_ppd(ppd2, None) == "HP LaserJet"
def test_driver_name_from_string():
cache = MockPPDsCache({
"foomatic:HP-LaserJet_1200-pxlmono.ppd": {"ppd-make-and-model": "HP LaserJet 1200 Foomatic/pxlmono"},
"some-other-driver.ppd": {"ppd-make-and-model": ["HP LaserJet", "Something else"]}
})
assert newprinter._get_driver_name_from_ppd("raw", cache) == "Raw Queue"
assert newprinter._get_driver_name_from_ppd(None, cache) == ""
assert newprinter._get_driver_name_from_ppd("", cache) == ""
assert newprinter._get_driver_name_from_ppd("foomatic:HP-LaserJet_1200-pxlmono.ppd", cache) == "HP LaserJet 1200 Foomatic/pxlmono"
assert newprinter._get_driver_name_from_ppd("some-other-driver.ppd", cache) == "HP LaserJet"
assert newprinter._get_driver_name_from_ppd("unknown.ppd", cache) == "unknown.ppd"
def test_driver_name_from_cups_ppd_missing_attrs(monkeypatch):
import cups
monkeypatch.setattr(cups, "PPD", MockCupsPPD)
ppd = MockCupsPPD({"OtherAttr": "Value"})
assert newprinter._get_driver_name_from_ppd(ppd, None) == ""
class DummyGUI(newprinter.NewPrinterGUI):
def __init__(self):
self.ppds = None
self.dialog_mode = "printer"
self.device = cupshelpers.Device("ipp://localhost:60000/ipp/print", **{"device-info": "driverless"})
if "driverless" in self.device.info:
self.device.driverless = True
self.device.type = "ipp"
self.remotecupsqueue = False
self.id_matched_ppdnames = []
self.exactdrivermatch = False
self.nextnptab_rerun = False
self.devid = None
self.searchedfordriverpackages = True
self.fetchDevices_conn = None
self.printer_finder = None
self.founddownloadabledrivers = False
self.rbtnNPDownloadableDriverSearch = MagicMock()
self.rbtnNPDownloadableDriverSearch.get_active.return_value = False
self.rbtnNPFoomatic = MagicMock()
self.rbtnNPFoomatic.get_active.return_value = True
self.rbtnNPPPD = MagicMock()
self.rbtnNPPPD.get_active.return_value = False
self.auto_make = ""
self.auto_model = ""
self.auto_driver = None
self.ppdsloader = None
self.installed_driver_files = []
def get_dummy_gui():
np = DummyGUI()
np._loadPPDsForDevice = MagicMock()
np._installPrinterFromDeviceID = MagicMock(return_value="install_done")
np.getNetworkPrinterMakeModel = MagicMock()
np.getDeviceURI = MagicMock(return_value="ipp://localhost:60000/ipp/print")
np.dec_spinner_task = MagicMock()
np.cups = MagicMock()
np.cups.getServerPPD = MagicMock(return_value='/tmp/mock.ppd')
return np
def test_driverless_skip_snmp():
np = get_dummy_gui()
np._selectDeviceForInstallation("ipp://localhost:60000/ipp/print")
np.getNetworkPrinterMakeModel.assert_not_called()
def test_driverless_loads_ppds_on_forward():
np = get_dummy_gui()
np._selectDeviceForInstallation = MagicMock()
np._installHPScannerFilesIfNeeded = MagicMock()
res = np._handlePrinterInstallationStage(newprinter.NewPrinterGUI.PAGE_SELECT_DEVICE, 1)
np._loadPPDsForDevice.assert_called_once()
assert res == newprinter.NewPrinterGUI.INSTALL_RESULT_OPS_PENDING
def test_driverless_install_device_id():
np = get_dummy_gui()
real_install = newprinter.NewPrinterGUI._installPrinterFromDeviceID.__get__(np)
np._installPrinterOrSearchForDriver = MagicMock(return_value=newprinter.NewPrinterGUI.INSTALL_RESULT_DONE)
np._validateDriverlessPPD = MagicMock(return_value="mock_ppd_object")
real_install(None, 1, 1)
expected_ppd = "driverless:ipp://localhost:60000/ipp/print"
np._installPrinterOrSearchForDriver.assert_called_with(None, expected_ppd, "exact", 1, 1)
# E. Working driverless:
# - validation succeeds
# - no _driverless_failed state
# - existing driverless behavior remains unchanged
assert not getattr(np.device, '_driverless_failed', False)
def test_driverless_search_driver():
np = get_dummy_gui()
real_search = newprinter.NewPrinterGUI._installPrinterOrSearchForDriver.__get__(np)
np.ppds = None # Ensure ppds is None as it would be from skipping load
np.fillDriverList = MagicMock()
np.fillMakeList = MagicMock()
ppdname = "driverless:ipp://localhost:60000/ipp/print"
real_search(None, ppdname, "exact", 0, 0)
assert np.exactdrivermatch
assert np.auto_make == "Generic"
assert np.auto_model == "Driverless IPP"
assert np.auto_driver == ppdname
np.fillDriverList.assert_not_called()
np.fillMakeList.assert_not_called()
def test_driverless_get_np_ppd(monkeypatch):
monkeypatch.setattr(cups, "PPD", MockCupsPPD)
np = get_dummy_gui()
np.auto_driver = "driverless:ipp://localhost:60000/ipp/print"
np.cups._begin_operation = MagicMock()
with tempfile.NamedTemporaryFile(delete=False) as tf:
mock_ppd_path = tf.name
np.cups.getServerPPD = MagicMock(return_value=mock_ppd_path)
real_get = newprinter.NewPrinterGUI.getNPPPD.__get__(np)
result = real_get()
np.cups._begin_operation.assert_called_with("fetching PPD")
np.cups.getServerPPD.assert_called_with("driverless:ipp://localhost:60000/ipp/print")
assert isinstance(result, MockCupsPPD)
def test_driverless_installable_options_reached(monkeypatch):
monkeypatch.setattr(cups, "PPD", MockCupsPPD)
np = get_dummy_gui()
np.getNPPPD = MagicMock(return_value=MockCupsPPD({}))
np.exactdrivermatch = True
np.dialog_mode = 'printer'
np.remotecupsqueue = False
np.founddownloadabledrivers = False
np.rbtnNPDownloadableDriverSearch = MagicMock()
np.rbtnNPDownloadableDriverSearch.get_active.return_value = False
np.fillNPInstallableOptions = MagicMock()
np._selectDeviceForInstallation = MagicMock()
np.makeNameUnique = MagicMock(return_value="printer")
np.entNPName = MagicMock()
np.entNPDescription = MagicMock()
np.entNPLocation = MagicMock()
np.entNPDriver = MagicMock()
np.btnNPApply = MagicMock()
np.btnNPForward = MagicMock()
np.btnNPBack = MagicMock()
real_stage = newprinter.NewPrinterGUI.nextNPTab.__get__(np)
np.ntbkNewPrinter = MagicMock()
np.ntbkNewPrinter.get_current_page.return_value = 1
np._handlePrinterInstallationMode = MagicMock(return_value=1)
real_stage(1)
np.getNPPPD.assert_called_once()
np.fillNPInstallableOptions.assert_called_once()
np._loadPPDsForDevice.assert_not_called()
def test_searching_spinner_visible_during_driverless_validation():
"""Verify that the searching spinner remains visible while nextNPTab executes."""
np = get_dummy_gui()
loader = MagicMock()
loader._jockey_has_answered = False
loader.get_error.return_value = None
loader.get_ppds.return_value = {"driverless:foo": {}}
loader.get_ppdsmatch_result.return_value = {}
# We want to intercept nextNPTab and check if the spinner has been hidden yet.
spinner_states = []
def mock_hide():
spinner_states.append("hidden")
np._hide_searching_spinner = mock_hide
def mock_nextNPTab(step=1):
if "hidden" not in spinner_states:
spinner_states.append("visible")
else:
spinner_states.append("already_hidden")
np.nextNPTab = mock_nextNPTab
np.ntbkNewPrinter = MagicMock()
np.ntbkNewPrinter.get_current_page.return_value = np.PAGE_DESCRIBE_PRINTER
np._set_driver_ppd_loading = MagicMock()
np.on_ppdsloader_finished_next(loader)
assert "visible" in spinner_states, "Spinner was hidden before nextNPTab finished"
assert "hidden" in spinner_states, "Spinner was not hidden eventually"
assert spinner_states == ["visible", "hidden"], "Unexpected sequence of events"
def test_broken_driverless_getnpppd_returns_none_on_runtime_error(monkeypatch):
"""When cups.PPD() raises RuntimeError for a driverless PPD,
getNPPPD() must return None (not the stale string)."""
monkeypatch.setattr(cups, "PPD",
MagicMock(side_effect=RuntimeError("ppdOpenFile failed")))
np = get_dummy_gui()
np.auto_driver = "driverless:ipp://localhost:60000/ipp/print"
np.cups._begin_operation = MagicMock()
np.cups._end_operation = MagicMock()
with tempfile.NamedTemporaryFile(delete=False) as tf:
mock_ppd_path = tf.name
np.cups.getServerPPD = MagicMock(return_value=mock_ppd_path)
real_get = newprinter.NewPrinterGUI.getNPPPD.__get__(np)
result = real_get()
assert result is None
np.cups.getServerPPD.assert_called_with("driverless:ipp://localhost:60000/ipp/print")
def test_broken_driverless_getnpppd_returns_none_on_ipp_error(monkeypatch):
"""When getServerPPD raises cups.IPPError for a driverless PPD,
getNPPPD() must return None."""
monkeypatch.setattr(cups, "PPD", MockCupsPPD)
np = get_dummy_gui()
np.auto_driver = "driverless:ipp://localhost:60000/ipp/print"
np.cups._begin_operation = MagicMock()
np.cups._end_operation = MagicMock()
np.cups.getServerPPD = MagicMock(side_effect=cups.IPPError(0, ""))
real_get = newprinter.NewPrinterGUI.getNPPPD.__get__(np)
result = real_get()
assert result is None
def test_broken_driverless_triggers_legacy_fallback():
"""When driverless PPD fetch fails in nextNPTab, device.driverless
should be set to False and _handlePrinterInstallationMode should
be called to trigger the legacy PPD catalog load."""
np = get_dummy_gui()
np.getNPPPD = MagicMock(return_value=None)
np.exactdrivermatch = True
np.dialog_mode = 'printer'
np.remotecupsqueue = False
np.founddownloadabledrivers = False
np.rbtnNPDownloadableDriverSearch = MagicMock()
np.rbtnNPDownloadableDriverSearch.get_active.return_value = False
np.fillNPInstallableOptions = MagicMock()
np._selectDeviceForInstallation = MagicMock()
np.makeNameUnique = MagicMock(return_value="printer")
np.entNPName = MagicMock()
np.entNPDescription = MagicMock()
np.entNPLocation = MagicMock()
np.entNPDriver = MagicMock()
np.btnNPApply = MagicMock()
np.btnNPForward = MagicMock()
np.btnNPBack = MagicMock()
real_stage = newprinter.NewPrinterGUI.nextNPTab.__get__(np)
np.ntbkNewPrinter = MagicMock()
np.ntbkNewPrinter.get_current_page.return_value = 1
original_mode = MagicMock(
return_value=newprinter.NewPrinterGUI.INSTALL_RESULT_DONE)
np._handlePrinterInstallationMode = MagicMock(
side_effect=[newprinter.NewPrinterGUI.INSTALL_RESULT_DONE,
newprinter.NewPrinterGUI.INSTALL_RESULT_OPS_PENDING])
assert np.device.driverless is True
real_stage(1)
assert np.device.driverless is False
assert np._handlePrinterInstallationMode.call_count == 2
np.btnNPForward.set_sensitive.assert_called_with(False)
np.fillNPInstallableOptions.assert_not_called()
def test_non_driverless_ppd_failure_preserves_string(monkeypatch):
"""For non-driverless PPD strings, RuntimeError in cups.PPD()
should NOT set ppd to None — the existing server-side fallback
must be preserved."""
monkeypatch.setattr(cups, "PPD",
MagicMock(side_effect=RuntimeError("ppdOpenFile failed")))
np = get_dummy_gui()
np.device.driverless = False
np.ppds = MagicMock()
np.rbtnNPFoomatic = MagicMock()
np.rbtnNPFoomatic.get_active.return_value = True
np.founddownloadableppd = False
np.installed_driver_files = []
np.tvNPDrivers = MagicMock()
selection_mock = MagicMock()
iter_mock = MagicMock()
model_mock = MagicMock()
model_mock.get_path.return_value = [0]
selection_mock.get_selected.return_value = (model_mock, iter_mock)
np.tvNPDrivers.get_selection.return_value = selection_mock
np.NPDrivers = ["foomatic:HP-LaserJet-pxlmono.ppd"]
np.cups._begin_operation = MagicMock()
np.cups._end_operation = MagicMock()
with tempfile.NamedTemporaryFile(delete=False) as tf:
mock_ppd_path = tf.name
np.cups.getServerPPD = MagicMock(return_value=mock_ppd_path)
real_get = newprinter.NewPrinterGUI.getNPPPD.__get__(np)
result = real_get()
assert result == "foomatic:HP-LaserJet-pxlmono.ppd"
def test_search_uri_masking_broken_driverless():
"""Verify that a broken driverless fallback masks its URI as None."""
np = get_dummy_gui()
np.device.driverless = False
np.device._driverless_failed = True
np.device.id = "MFG:A;MDL:B;"
np.device.id_dict = {"MFG": "A", "MDL": "B", "DES": "", "CMD": []}
np.device.uri = "ipp://localhost:60000/ipp/print"
np.device.make_and_model = "A B"
np.dialog_mode = 'printer'
np.remotecupsqueue = False
np.ppds = MagicMock()
np.ppds.getPPDNamesFromDeviceID.return_value = {"mock_ppd": "exact"}
np.ppds.orderPPDNamesByPreference.return_value = ["mock_ppd"]
np._installPrinterOrSearchForDriver = MagicMock(return_value=newprinter.NewPrinterGUI.INSTALL_RESULT_DONE)
real_install = newprinter.NewPrinterGUI._installPrinterFromDeviceID.__get__(np)
real_install(None, 0, 0)
np.ppds.getPPDNamesFromDeviceID.assert_called_with("A", "B", "", [], None, "A B")
def test_search_uri_normal_non_driverless():
"""Verify that a normal non-driverless IPP device passes its true URI."""
np = get_dummy_gui()
np.device.driverless = False
np.device._driverless_failed = False
np.device.id = "MFG:A;MDL:B;"
np.device.id_dict = {"MFG": "A", "MDL": "B", "DES": "", "CMD": []}
np.device.uri = "ipp://localhost:60000/ipp/print"
np.device.make_and_model = "A B"
np.dialog_mode = 'printer'
np.remotecupsqueue = False
np.ppds = MagicMock()
np.ppds.getPPDNamesFromDeviceID.return_value = {"mock_ppd": "exact"}
np.ppds.orderPPDNamesByPreference.return_value = ["mock_ppd"]
np._installPrinterOrSearchForDriver = MagicMock(return_value=newprinter.NewPrinterGUI.INSTALL_RESULT_DONE)
real_install = newprinter.NewPrinterGUI._installPrinterFromDeviceID.__get__(np)
real_install(None, 0, 0)
np.ppds.getPPDNamesFromDeviceID.assert_called_with("A", "B", "", [], "ipp://localhost:60000/ipp/print", "A B")
def test_search_uri_working_driverless():
"""Verify that a working driverless device bypasses legacy matching entirely."""
np = get_dummy_gui()
np.device.driverless = True
np.device._driverless_failed = False
np.device.uri = "ipp://localhost:60000/ipp/print"
np.dialog_mode = 'printer'
np.ppds = MagicMock()
np._installPrinterOrSearchForDriver = MagicMock(return_value=newprinter.NewPrinterGUI.INSTALL_RESULT_DONE)
real_install = newprinter.NewPrinterGUI._installPrinterFromDeviceID.__get__(np)
real_install(None, 0, 0)
np.ppds.getPPDNamesFromDeviceID.assert_not_called()
def test_network_broken_driverless_rejected():
"""Network broken driverless candidate is rejected and falls back."""
np = get_dummy_gui()
np.device.driverless = False
np.device.uri = "dnssd://printer._ipp._tcp.local/"
np.device.make_and_model = "A B"
np.device.id_dict = {"MFG": "A", "MDL": "B", "DES": "", "CMD": []}
np.device.id = "MFG:A;MDL:B;"
np.installed_driver_files = []
np.dialog_mode = 'printer'
np.remotecupsqueue = False
np.ppds = MagicMock()
np.ppds.getPPDNamesFromDeviceID.return_value = {"driverless:dnssd://...": "exact", "other_ppd": "close"}
np.ppds.orderPPDNamesByPreference.return_value = ["driverless:dnssd://...", "other_ppd"]
np._validateDriverlessPPD = MagicMock(return_value=None)
np._installPrinterOrSearchForDriver = MagicMock(return_value=newprinter.NewPrinterGUI.INSTALL_RESULT_DONE)
np.searchedfordriverpackages = False
np.exactdrivermatch = True # Pre-set to verify it gets explicitly forced to False
real_install = newprinter.NewPrinterGUI._installPrinterFromDeviceID.__get__(np)
result = real_install(None, 0, 0)
np._validateDriverlessPPD.assert_called_with("driverless:dnssd://...")
np._installPrinterOrSearchForDriver.assert_called_with(None, None, None, 0, 0)
assert result == newprinter.NewPrinterGUI.INSTALL_RESULT_DONE
assert np.device.driverless is False
assert np.device._driverless_failed is True
assert np.exactdrivermatch is False
assert np.id_matched_ppdnames == []
assert np.searchedfordriverpackages is True
assert not hasattr(np, '_broken_driverless_ppds')
def test_network_broken_driverless_no_alternative():
"""Network broken driverless with no alternative behaves as no matching PPD."""
np = get_dummy_gui()
np.searchedfordriverpackages = False
np.device.driverless = False
np.device.uri = "dnssd://printer._ipp._tcp.local/"
np.device.make_and_model = "A B"
np.device.id_dict = {"MFG": "A", "MDL": "B", "DES": "", "CMD": []}
np.device.id = "MFG:A;MDL:B;"
np.installed_driver_files = []
np.dialog_mode = 'printer'
np.remotecupsqueue = False
np.ppds = MagicMock()
np.ppds.getPPDNamesFromDeviceID.return_value = {"driverless:dnssd://...": "exact"}
np.ppds.orderPPDNamesByPreference.return_value = ["driverless:dnssd://..."]
np._validateDriverlessPPD = MagicMock(return_value=None)
np._installPrinterOrSearchForDriver = MagicMock(return_value=newprinter.NewPrinterGUI.INSTALL_RESULT_DONE)
real_install = newprinter.NewPrinterGUI._installPrinterFromDeviceID.__get__(np)
result = real_install(None, 0, 0)
# B. If all candidates are removed, ppdname=None, status=None
# exactdrivermatch remains False, and it continues to manual fallback
np._installPrinterOrSearchForDriver.assert_called_with(None, None, None, 0, 0)
assert result == newprinter.NewPrinterGUI.INSTALL_RESULT_DONE
assert np.device.driverless is False
assert np.device._driverless_failed is True
assert np.searchedfordriverpackages is True
assert not hasattr(np, '_broken_driverless_ppds')
def test_usb_broken_driverless_fallback():
"""USB/ipp-usb broken driverless enters manual fallback without re-loading PPDs."""
np = get_dummy_gui()
np.device.driverless = True
np.device.uri = "ipp://localhost:60000/ipp/print"
np._validateDriverlessPPD = MagicMock(return_value=None)
np._loadPPDsForDevice = MagicMock()
np._installPrinterOrSearchForDriver = MagicMock(return_value=newprinter.NewPrinterGUI.INSTALL_RESULT_DONE)
real_install = newprinter.NewPrinterGUI._installPrinterFromDeviceID.__get__(np)
result = real_install(None, 0, 0)
assert result == newprinter.NewPrinterGUI.INSTALL_RESULT_DONE
assert np.device.driverless is False
assert np.device._driverless_failed is True
assert np.searchedfordriverpackages is True
assert np.exactdrivermatch is False
np._loadPPDsForDevice.assert_not_called()
def test_working_driverless_cached():
"""Working driverless PPD is cached and not fetched twice."""
np = get_dummy_gui()
np.device.driverless = True
np.device.uri = "ipp://localhost:60000/ipp/print"
np.ppds = None
np.auto_driver = "driverless:ipp://localhost:60000/ipp/print"
mock_ppd = MagicMock()
np._cached_driverless_ppd = mock_ppd
np.cups = MagicMock()
real_get = newprinter.NewPrinterGUI.getNPPPD.__get__(np)
result = real_get()
assert result == mock_ppd
np.cups.getServerPPD.assert_not_called()
assert getattr(np, '_cached_driverless_ppd', None) is None
def test_fillDriverList_excludes_broken_driverless_ppds(monkeypatch):
"""Verify fillDriverList excludes driverless PPDs when _driverless_failed is True."""
np = get_dummy_gui()
np.device.make_and_model = "A B"
np.device.id_dict = {"MFG": "A", "MDL": "B"}
np.installed_driver_files = []
np.auto_driver = None
np.recommended_model_selected = False
np.device._driverless_failed = True
np.ppds = MagicMock()
np.ppds.getInfoFromModel.return_value = {
"driverless:dnssd://...": {"ppd-make-and-model": "Broken Xerox, Fax, driverless"},
"other_ppd": {"ppd-make-and-model": "Other Driver"}
}
np.ppds.orderPPDNamesByPreference.return_value = ["driverless:dnssd://...", "other_ppd"]
def get_info(name):
return np.ppds.getInfoFromModel.return_value[name]
np.ppds.getInfoFromPPDName.side_effect = get_info
np.tvNPDrivers = MagicMock()
mock_model = MagicMock()
np.tvNPDrivers.get_model.return_value = mock_model
real_fill = newprinter.NewPrinterGUI.fillDriverList.__get__(np)
real_fill("A", "B")
assert "driverless:dnssd://..." not in np.NPDrivers
assert "other_ppd" in np.NPDrivers
assert np.NPDrivers == ["other_ppd"]
appended_strings = [args[0][0] for args, kwargs in mock_model.append.call_args_list]
assert not any("Broken Xerox" in s for s in appended_strings)
assert any("Other Driver" in s for s in appended_strings)
def test_ipp_connection_labels():
"""Verify that IPP connection labels distinguish IPP and IPP over USB using dnssdresolve,
and preserve DNS-SD LPD and AppSocket labels."""
np = get_dummy_gui()
np.device_selected = 0
np.tvNPDeviceURIs = MagicMock()
np.expNPDeviceURIs = MagicMock()
np.lblNPDeviceDescription = MagicMock()
np.ntbkNPType = MagicMock()
np.new_printer_device_tabs = {}
np.PAGE_SELECT_DEVICE = 1
np.PAGE_DESCRIBE_PRINTER = 2
mock_widget = MagicMock()
mock_widget.get_cursor.return_value = ("0", 0)
mock_model = MagicMock()
mock_widget.get_model.return_value = mock_model
mock_model.get_iter.return_value = "iter"
mock_physicaldevice = MagicMock()
mock_model.get_value.return_value = mock_physicaldevice
# 1. Normal network DNS-SD IPP printer
dev_dnssd_net = cupshelpers.Device("dnssd://printer._ipp._tcp.local/", **{'device-info': 'Network Printer'})
dev_dnssd_net.address = '192.168.1.20'
# 2. IPP-over-USB printer resolved to 127.0.0.1
dev_usb_v4 = cupshelpers.Device("ipp://printer%20(USB)._ipp._tcp.local/", **{'device-info': 'ipp-usb (driverless)'})
dev_usb_v4.address = '127.0.0.1'
# 3. IPP-over-USB printer resolved to ::1
dev_usb_v6 = cupshelpers.Device("ipp://printer%20(USB)._ipp._tcp.local/", **{'device-info': 'ipp-usb (driverless)'})
dev_usb_v6.address = '::1'
# 4. DNS-SD LPD printer
dev_dnssd_lpd = cupshelpers.Device("dnssd://printer._printer._tcp.local/", **{'device-info': 'Network LPD Printer'})
dev_dnssd_lpd.address = '192.168.1.30'
# 5. DNS-SD AppSocket/JetDirect printer
dev_dnssd_socket = cupshelpers.Device("dnssd://printer._pdl-datastream._tcp.local/", **{'device-info': 'Network Socket Printer'})
dev_dnssd_socket.address = '192.168.1.40'
# 6. Legacy / ipp scheme network printer (non-driverless and driverless)
dev_net = cupshelpers.Device("ipp://printer.example.com/", **{'device-info': 'Network Printer'})
dev_net.address = '192.168.1.50'
dev_net_driverless = cupshelpers.Device("ipp://printer._ipp._tcp.local/", **{'device-info': 'Network Printer (driverless)'})
dev_net_driverless.address = '192.168.1.10'
# 7. IPPS network printer (e.g. from simulator publishing _ipps._tcp)
dev_ipps = cupshelpers.Device("ipps://Broken%20Xerox%20B235%20MFP._ipps._tcp.local", **{'device-info': 'Broken Xerox B235 MFP (driverless)'})
mock_physicaldevice.get_devices.return_value = [
dev_dnssd_net, dev_usb_v4, dev_usb_v6, dev_dnssd_lpd, dev_dnssd_socket, dev_net, dev_net_driverless, dev_ipps
]
np.on_tvNPDevices_cursor_changed(mock_widget)
# 1. normal network DNS-SD IPP -> "IPP"
assert dev_dnssd_net.menuentry == "IPP"
# 2. IPP-over-USB -> "IPP over USB"
assert dev_usb_v4.menuentry == "IPP over USB"
assert getattr(dev_usb_v4, 'driverless', False) is True
assert dev_usb_v6.menuentry == "IPP over USB"
assert getattr(dev_usb_v6, 'driverless', False) is True
# 3. DNS-SD LPD -> existing LPD label
assert dev_dnssd_lpd.menuentry == "LPD network printer via DNS-SD"
# 4. DNS-SD AppSocket -> existing AppSocket/JetDirect label
assert dev_dnssd_socket.menuentry == "AppSocket/JetDirect network printer via DNS-SD"
# 5. ipp:// network printers -> "IPP"
assert dev_net.menuentry == "IPP"
assert not getattr(dev_net, 'driverless', False)
assert dev_net_driverless.menuentry == "IPP"
assert getattr(dev_net_driverless, 'driverless', False) is True
# 6. ipps:// network printer -> "IPP"
assert dev_ipps.menuentry == "IPP"
assert getattr(dev_ipps, 'driverless', False) is True
def test_ipps_network_device_connection_label():
"""Verify that an ipps://..._ipps._tcp.local device displays 'IPP' and keeps Connection section visible."""
np = get_dummy_gui()
np.device_selected = 0
np.tvNPDeviceURIs = MagicMock()
np.expNPDeviceURIs = MagicMock()
np.lblNPDeviceDescription = MagicMock()
np.ntbkNPType = MagicMock()
np.new_printer_device_tabs = {}
np.PAGE_SELECT_DEVICE = 1
np.PAGE_DESCRIBE_PRINTER = 2
mock_widget = MagicMock()
mock_widget.get_cursor.return_value = ("0", 0)
mock_model = MagicMock()
mock_widget.get_model.return_value = mock_model
mock_model.get_iter.return_value = "iter"
mock_physicaldevice = MagicMock()
mock_model.get_value.return_value = mock_physicaldevice
dev_ipps = cupshelpers.Device(
"ipps://Broken%20Xerox%20B235%20MFP._ipps._tcp.local",
**{'device-info': 'Broken Xerox B235 MFP (driverless)'}
)
mock_physicaldevice.get_devices.return_value = [dev_ipps]
np.on_tvNPDevices_cursor_changed(mock_widget)
# 1. Connection section remains visible
np.expNPDeviceURIs.show_all.assert_called_once()
np.expNPDeviceURIs.hide.assert_not_called()
# 2. menuentry is "IPP"
assert dev_ipps.menuentry == "IPP"
assert getattr(dev_ipps, 'driverless', False) is True
def test_broken_driverless_skips_openprinting(monkeypatch):
"""Broken driverless fallback skips remote OpenPrinting query."""
np = get_dummy_gui()
np.searchedfordriverpackages = False
np.installed_driver_files = []
np.device.driverless = False
np.device._driverless_failed = True
np.device.id = "MFG:Xerox;MDL:B235;"
np.device.uri = "dnssd://Xerox%20B235._ipp._tcp.local/"
np.ppds = MagicMock()
np.ppds.getPPDNamesFromDeviceID.return_value = {}
np.ppds.orderPPDNamesByPreference.return_value = []
np.fillMakeList = MagicMock()
mock_opreq_cls = MagicMock()
monkeypatch.setattr(newprinter, "OpenPrintingRequest", mock_opreq_cls)
real_install = newprinter.NewPrinterGUI._installPrinterFromDeviceID.__get__(np)
result = real_install(np.device.id, 0, 0)
assert np.searchedfordriverpackages is True
mock_opreq_cls.assert_not_called()
assert getattr(np, 'opreq', None) is None
np.fillMakeList.assert_called_once()
assert result == newprinter.NewPrinterGUI.INSTALL_RESULT_DONE
def test_normal_printer_searches_openprinting_when_no_match(monkeypatch):
"""Normal printer without driver match still queries OpenPrinting."""
np = get_dummy_gui()
np.searchedfordriverpackages = False
np.installed_driver_files = []
np.device.driverless = False
np.device._driverless_failed = False
np.device.id = "MFG:TestMFG;MDL:TestMDL;"
np.device.uri = "usb://TestMFG/TestMDL"
np.ppds = MagicMock()
np.ppds.getPPDNamesFromDeviceID.return_value = {}
np.ppds.orderPPDNamesByPreference.return_value = []
np.fillMakeList = MagicMock()
np._show_searching_spinner = MagicMock()
mock_opreq_instance = MagicMock()
mock_opreq_cls = MagicMock(return_value=mock_opreq_instance)
monkeypatch.setattr(newprinter, "OpenPrintingRequest", mock_opreq_cls)
real_install = newprinter.NewPrinterGUI._installPrinterFromDeviceID.__get__(np)
result = real_install(np.device.id, 0, 0)
assert np.searchedfordriverpackages is True
mock_opreq_cls.assert_called_once()
mock_opreq_instance.searchPrinters.assert_called_once_with(np.device.id)
np.fillMakeList.assert_not_called()
assert result == newprinter.NewPrinterGUI.INSTALL_RESULT_OPS_PENDING
def test_network_broken_driverless_probe_failure_sets_flags_and_skips_packagekit():
"""When driverless PPD validation fails, flags are set immediately and driverless mode is abandoned."""
np = get_dummy_gui()
np.device.driverless = True
np.device.uri = "dnssd://Xerox%20B235._ipp._tcp.local/"
np.device.id = "MFG:Xerox;MDL:B235;"
np.searchedfordriverpackages = False
np._validateDriverlessPPD = MagicMock(return_value=None)
np._loadPPDsForDevice = MagicMock()
np._installPrinterOrSearchForDriver = MagicMock(return_value=newprinter.NewPrinterGUI.INSTALL_RESULT_DONE)
real_install = newprinter.NewPrinterGUI._installPrinterFromDeviceID.__get__(np)
result = real_install(np.device.id, 0, 0)
assert result == newprinter.NewPrinterGUI.INSTALL_RESULT_DONE
assert np.device.driverless is False
assert np.device._driverless_failed is True
assert np.searchedfordriverpackages is True
assert np.exactdrivermatch is False
np._loadPPDsForDevice.assert_not_called()
def test_broken_driverless_guard_prevents_openprinting_even_if_reset(monkeypatch):
"""Even if searchedfordriverpackages is reset to False, _driverless_failed=True prevents OpenPrinting."""
np = get_dummy_gui()
np.searchedfordriverpackages = False
np.device.driverless = False
np.device._driverless_failed = True
np.dialog_mode = "printer"
np.ppds = MagicMock()
np.fillMakeList = MagicMock()
mock_opreq_cls = MagicMock()
monkeypatch.setattr(newprinter, "OpenPrintingRequest", mock_opreq_cls)
real_search = newprinter.NewPrinterGUI._installPrinterOrSearchForDriver.__get__(np)
result = real_search("MFG:Xerox;MDL:B235;", None, None, 0, 0)
mock_opreq_cls.assert_not_called()
assert getattr(np, 'opreq', None) is None
np.fillMakeList.assert_called_once()
assert result == newprinter.NewPrinterGUI.INSTALL_RESULT_DONE
def test_ppdsloader_with_none_device_id_skips_packagekit_and_queries_cups():
"""Passing device_id=None to PPDsLoader skips PackageKit and directly queries CUPS."""
import ppdsloader
loader = ppdsloader.PPDsLoader(device_id=None, device_uri="dnssd://Xerox%20B235._ipp._tcp.local/")
loader._query_packagekit = MagicMock()
loader._query_cups = MagicMock()
loader.run()
loader._query_packagekit.assert_not_called()
loader._query_cups.assert_called_once()
def test_choose_driver_button_visible_for_driverless():
np = get_dummy_gui()
np.ntbkNewPrinter = MagicMock()
np.ntbkNewPrinter.get_current_page.return_value = newprinter.NewPrinterGUI.PAGE_DESCRIBE_PRINTER
np.dialog_mode = "printer"
np.btnNPBack = MagicMock()
np.btnNPForward = MagicMock()
np.btnNPApply = MagicMock()
np.btnNPChooseDriver = MagicMock()
np.entNPName = MagicMock()
np.entNPName.get_text.return_value = "TestPrinter"
np.printers = {}
np.ppd = "driverless:ipp://localhost:60000/ipp/print"
np.device.driverless = True
newprinter.NewPrinterGUI.setNPButtons(np)
np.btnNPChooseDriver.show.assert_called_once()
np.btnNPChooseDriver.hide.assert_not_called()
def test_choose_driver_button_visible_for_non_driverless():
np = get_dummy_gui()
np.ntbkNewPrinter = MagicMock()
np.ntbkNewPrinter.get_current_page.return_value = newprinter.NewPrinterGUI.PAGE_DESCRIBE_PRINTER
np.dialog_mode = "printer"
np.btnNPBack = MagicMock()
np.btnNPForward = MagicMock()
np.btnNPApply = MagicMock()
np.btnNPChooseDriver = MagicMock()
np.entNPName = MagicMock()
np.entNPName.get_text.return_value = "TestPrinter"
np.printers = {}
np.ppd = "foomatic:HP-LaserJet_4_Plus-hpijs.ppd"
np.device.driverless = False
newprinter.NewPrinterGUI.setNPButtons(np)
np.btnNPChooseDriver.show.assert_called_once()
np.btnNPChooseDriver.hide.assert_not_called()
def test_clicking_choose_driver_button_enters_manual_workflow():
np = get_dummy_gui()
np.dialog_mode = "duplicate"
np.device.driverless = True
np.exactdrivermatch = True
np.ppds = MagicMock()
np.ntbkNewPrinter = MagicMock()
np.rbtnNPFoomatic = MagicMock()
np.on_rbtnNPFoomatic_toggled = MagicMock()
np.nextNPTab = MagicMock()
np._loadPPDsForDevice = MagicMock()
np._ensure_driver_selection_spinner = MagicMock(return_value=True)
np._driver_selection_stack = MagicMock()
np._driver_selection_spinner = MagicMock()
np.ntbkPPDSource = MagicMock()
newprinter.NewPrinterGUI.on_btnNPChooseDriver_clicked(np, None)
assert np.device.driverless is True
assert np.duplicate_driver_selection is True
assert np._getPagesOrderForDialogMode() == [
np.PAGE_SELECT_INSTALL_METHOD,
np.PAGE_CHOOSE_DRIVER_FROM_DB,
np.PAGE_INSTALLABLE_OPTIONS,
np.PAGE_DESCRIBE_PRINTER,
]
assert np.exactdrivermatch is False
assert np.searchedfordriverpackages is True
np._driver_selection_stack.set_visible_child_name.assert_any_call("loading")
np._driver_selection_stack.set_visible_child_name.assert_any_call("content")
np._driver_selection_spinner.start.assert_called_once()
np._driver_selection_spinner.stop.assert_called_once()
np._loadPPDsForDevice.assert_not_called()
np.ntbkNewPrinter.set_current_page.assert_called_with(newprinter.NewPrinterGUI.PAGE_SELECT_INSTALL_METHOD)
np.rbtnNPFoomatic.set_active.assert_called_with(True)
np.on_rbtnNPFoomatic_toggled.assert_called_with(np.rbtnNPFoomatic)
np.nextNPTab.assert_called_with(step=0)
def test_choose_driver_triggers_ppd_load_when_ppds_none():
np = get_dummy_gui()
np.ppds = None
np.device.driverless = False
np.dialog_mode = "printer"
np._selectDeviceForInstallation = MagicMock()
np._installHPScannerFilesIfNeeded = MagicMock()
np._loadPPDsForDevice = MagicMock()
result = newprinter.NewPrinterGUI._handlePrinterInstallationStage(
np, newprinter.NewPrinterGUI.PAGE_SELECT_INSTALL_METHOD, 0
)
np._loadPPDsForDevice.assert_called_once()
assert result == newprinter.NewPrinterGUI.INSTALL_RESULT_OPS_PENDING
def test_driverless_printer_subsequently_selects_non_driverless_driver(monkeypatch):
"""When on PAGE_SELECT_INSTALL_METHOD, driverless PPD is excluded from ppdnamelist,
exactdrivermatch is False, and selecting a manual driver shows that driver and hides the button."""
monkeypatch.setattr(cups, "PPD", MockCupsPPD)
np = get_dummy_gui()
np.ppds = MagicMock()
fit = {
"driverless:ipp://localhost:60000/ipp/print": "exact",
"foomatic:HP-LaserJet": "exact",
}
np.ppds.getPPDNamesFromDeviceID.return_value = fit
np.ppds.orderPPDNamesByPreference.return_value = [
"driverless:ipp://localhost:60000/ipp/print",
"foomatic:HP-LaserJet",
]
np.ppds.getInfoFromPPDName.return_value = {
"ppd-make-and-model": "HP LaserJet"
}
np.installed_driver_files = []
np.fillDriverList = MagicMock()
np.fillMakeList = MagicMock()