forked from WordPress/wordpress-develop
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathwpUpgrader.php
More file actions
1662 lines (1476 loc) · 43.3 KB
/
wpUpgrader.php
File metadata and controls
1662 lines (1476 loc) · 43.3 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
<?php
/**
* Tests the `WP_Upgrader` class.
*
* @group admin
* @group upgrade
*/
class Tests_Admin_WpUpgrader extends WP_UnitTestCase {
/**
* An instance of the WP_Upgrader class being tested.
*
* @var WP_Upgrader
*/
private static $instance;
/**
* @var WP_Upgrader_Skin&PHPUnit\Framework\MockObject\MockObject
*/
private static $upgrader_skin_mock;
/**
* Filesystem mock.
*
* @var WP_Filesystem_Base&PHPUnit\Framework\MockObject\MockObject
*/
private static $wp_filesystem_mock;
/**
* A backup of the existing 'wp_filesystem' global.
*
* @var mixed|null
*/
private static $wp_filesystem_backup = null;
/**
* Loads the class to be tested.
*/
public static function set_up_before_class() {
parent::set_up_before_class();
require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
require_once ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php';
}
/**
* Sets up the class instance and mocks needed for each test.
*/
public function set_up() {
parent::set_up();
self::$upgrader_skin_mock = $this->getMockBuilder( 'WP_Upgrader_Skin' )->getMock();
self::$instance = new WP_Upgrader( self::$upgrader_skin_mock );
self::$wp_filesystem_mock = $this->getMockBuilder( 'WP_Filesystem_Base' )->getMock();
if ( array_key_exists( 'wp_filesystem', $GLOBALS ) ) {
self::$wp_filesystem_backup = $GLOBALS['wp_filesystem'];
}
$GLOBALS['wp_filesystem'] = self::$wp_filesystem_mock;
}
/**
* Cleans up after each test.
*/
public function tear_down() {
if ( null !== self::$wp_filesystem_backup ) {
$GLOBALS['wp_filesystem'] = self::$wp_filesystem_backup;
} else {
unset( $GLOBALS['wp_filesystem'] );
}
parent::tear_down();
}
/**
* Tests that `WP_Upgrader::__construct()` creates a skin when one is not
* passed to the constructor.
*
* @ticket 54245
*
* @covers WP_Upgrader::__construct
*/
public function test_constructor_should_create_skin_when_one_is_not_provided() {
$instance = new WP_Upgrader();
$this->assertInstanceOf( WP_Upgrader_Skin::class, $instance->skin );
}
/**
* Tests that `WP_Upgrader::init()` calls `WP_Upgrader::set_upgrader()`.
*
* @ticket 54245
*
* @covers WP_Upgrader::init
*/
public function test_init_should_call_set_upgrader() {
self::$upgrader_skin_mock->expects( $this->once() )->method( 'set_upgrader' )->with( self::$instance );
self::$instance->init();
}
/**
* Tests that `WP_Upgrader::init()` initializes the `$strings` property.
*
* @ticket 54245
*
* @covers WP_Upgrader::init
* @covers WP_Upgrader::generic_strings
*
* @dataProvider data_init_should_initialize_strings
*
* @param string $key The key to check.
*/
public function test_init_should_initialize_strings( $key ) {
$this->assertEmpty( self::$instance->strings, '"$strings" has already been initialized' );
self::$instance->init();
$this->assertArrayHasKey( $key, self::$instance->strings, "The '$key' key was not created" );
}
/**
* Data provider.
*
* @return array[]
*/
public function data_init_should_initialize_strings() {
return self::text_array_to_dataprovider(
array(
'bad_request',
'fs_unavailable',
'fs_error',
'fs_no_root_dir',
'fs_no_content_dir',
'fs_no_plugins_dir',
'fs_no_themes_dir',
'fs_no_folder',
'no_package',
'download_failed',
'installing_package',
'no_files',
'folder_exists',
'mkdir_failed',
'incompatible_archive',
'files_not_writable',
'maintenance_start',
'maintenance_end',
'temp_backup_mkdir_failed',
'temp_backup_move_failed',
'temp_backup_restore_failed',
'temp_backup_delete_failed',
)
);
}
/**
* Tests that `WP_Upgrader::flatten_dirlist()` returns the expected file list.
*
* @ticket 54245
*
* @dataProvider data_should_flatten_dirlist
*
* @covers WP_Upgrader::flatten_dirlist
*
* @param array $expected The expected flattened dirlist.
* @param array $nested_files Array of files as returned by WP_Filesystem_Base::dirlist().
* @param string $path Optional. Relative path to prepend to child nodes. Default empty string.
*/
public function test_flatten_dirlist_should_flatten_the_provided_directory_list( $expected, $nested_files, $path = '' ) {
$flatten_dirlist = new ReflectionMethod( self::$instance, 'flatten_dirlist' );
$flatten_dirlist->setAccessible( true );
$actual = $flatten_dirlist->invoke( self::$instance, $nested_files, $path );
$flatten_dirlist->setAccessible( false );
$this->assertSameSetsWithIndex( $expected, $actual );
}
/**
* Data provider.
*
* @return array[]
*/
public function data_should_flatten_dirlist() {
return array(
'empty array, default path' => array(
'expected' => array(),
'nested_files' => array(),
),
'root only' => array(
'expected' => array(
'file1.php' => array( 'name' => 'file1.php' ),
'file2.php' => array( 'name' => 'file2.php' ),
),
'nested_files' => array(
'file1.php' => array( 'name' => 'file1.php' ),
'file2.php' => array( 'name' => 'file2.php' ),
),
),
'root only and custom path' => array(
'expected' => array(
'custom_path/file1.php' => array( 'name' => 'file1.php' ),
'custom_path/file2.php' => array( 'name' => 'file2.php' ),
),
'nested_files' => array(
'file1.php' => array( 'name' => 'file1.php' ),
'file2.php' => array( 'name' => 'file2.php' ),
),
'path' => 'custom_path/',
),
'one level deep' => array(
'expected' => array(
'subdir1' => array(
'files' => array(
'subfile1.php' => array( 'name' => 'subfile1.php' ),
'subfile2.php' => array( 'name' => 'subfile2.php' ),
),
),
'subdir2' => array(
'files' => array(
'subfile3.php' => array( 'name' => 'subfile3.php' ),
'subfile4.php' => array( 'name' => 'subfile4.php' ),
),
),
'subdir1/subfile1.php' => array( 'name' => 'subfile1.php' ),
'subdir1/subfile2.php' => array( 'name' => 'subfile2.php' ),
'subdir2/subfile3.php' => array( 'name' => 'subfile3.php' ),
'subdir2/subfile4.php' => array( 'name' => 'subfile4.php' ),
),
'nested_files' => array(
'subdir1' => array(
'files' => array(
'subfile1.php' => array( 'name' => 'subfile1.php' ),
'subfile2.php' => array( 'name' => 'subfile2.php' ),
),
),
'subdir2' => array(
'files' => array(
'subfile3.php' => array( 'name' => 'subfile3.php' ),
'subfile4.php' => array( 'name' => 'subfile4.php' ),
),
),
),
),
'one level deep and numeric keys' => array(
'expected' => array(
'subdir1' => array(
'files' => array(
0 => array( 'name' => '0' ),
1 => array( 'name' => '1' ),
),
),
'subdir2' => array(
'files' => array(
2 => array( 'name' => '2' ),
3 => array( 'name' => '3' ),
),
),
'subdir1/0' => array( 'name' => '0' ),
'subdir1/1' => array( 'name' => '1' ),
'subdir2/2' => array( 'name' => '2' ),
'subdir2/3' => array( 'name' => '3' ),
),
'nested_files' => array(
'subdir1' => array(
'files' => array(
'0' => array( 'name' => '0' ),
'1' => array( 'name' => '1' ),
),
),
'subdir2' => array(
'files' => array(
'2' => array( 'name' => '2' ),
'3' => array( 'name' => '3' ),
),
),
),
),
'one level deep and custom path' => array(
'expected' => array(
'custom_path/subdir1' => array(
'files' => array(
'subfile1.php' => array( 'name' => 'subfile1.php' ),
'subfile2.php' => array( 'name' => 'subfile2.php' ),
),
),
'custom_path/subdir2' => array(
'files' => array(
'subfile3.php' => array( 'name' => 'subfile3.php' ),
'subfile4.php' => array( 'name' => 'subfile4.php' ),
),
),
'custom_path/subdir1/subfile1.php' => array(
'name' => 'subfile1.php',
),
'custom_path/subdir1/subfile2.php' => array(
'name' => 'subfile2.php',
),
'custom_path/subdir2/subfile3.php' => array(
'name' => 'subfile3.php',
),
'custom_path/subdir2/subfile4.php' => array(
'name' => 'subfile4.php',
),
),
'nested_files' => array(
'subdir1' => array(
'files' => array(
'subfile1.php' => array( 'name' => 'subfile1.php' ),
'subfile2.php' => array( 'name' => 'subfile2.php' ),
),
),
'subdir2' => array(
'files' => array(
'subfile3.php' => array( 'name' => 'subfile3.php' ),
'subfile4.php' => array( 'name' => 'subfile4.php' ),
),
),
),
'path' => 'custom_path/',
),
'two levels deep' => array(
'expected' => array(
'subdir1' => array(
'files' => array(
'subfile1.php' => array(
'name' => 'subfile1.php',
),
'subfile2.php' => array(
'name' => 'subfile2.php',
),
'subsubdir1' => array(
'files' => array(
'subsubfile1.php' => array(
'name' => 'subsubfile1.php',
),
'subsubfile2.php' => array(
'name' => 'subsubfile2.php',
),
),
),
),
),
'subdir1/subfile1.php' => array(
'name' => 'subfile1.php',
),
'subdir1/subfile2.php' => array(
'name' => 'subfile2.php',
),
'subdir1/subsubdir1' => array(
'files' => array(
'subsubfile1.php' => array(
'name' => 'subsubfile1.php',
),
'subsubfile2.php' => array(
'name' => 'subsubfile2.php',
),
),
),
'subdir1/subsubdir1/subsubfile1.php' => array(
'name' => 'subsubfile1.php',
),
'subdir1/subsubdir1/subsubfile2.php' => array(
'name' => 'subsubfile2.php',
),
'subdir2' => array(
'files' => array(
'subfile3.php' => array( 'name' => 'subfile3.php' ),
'subfile4.php' => array( 'name' => 'subfile4.php' ),
'subsubdir2' => array(
'files' => array(
'subsubfile3.php' => array(
'name' => 'subsubfile3.php',
),
'subsubfile4.php' => array(
'name' => 'subsubfile4.php',
),
),
),
),
),
'subdir2/subfile3.php' => array(
'name' => 'subfile3.php',
),
'subdir2/subfile4.php' => array(
'name' => 'subfile4.php',
),
'subdir2/subsubdir2' => array(
'files' => array(
'subsubfile3.php' => array(
'name' => 'subsubfile3.php',
),
'subsubfile4.php' => array(
'name' => 'subsubfile4.php',
),
),
),
'subdir2/subsubdir2/subsubfile3.php' => array(
'name' => 'subsubfile3.php',
),
'subdir2/subsubdir2/subsubfile4.php' => array(
'name' => 'subsubfile4.php',
),
),
'nested_files' => array(
'subdir1' => array(
'files' => array(
'subfile1.php' => array( 'name' => 'subfile1.php' ),
'subfile2.php' => array( 'name' => 'subfile2.php' ),
'subsubdir1' => array(
'files' => array(
'subsubfile1.php' => array(
'name' => 'subsubfile1.php',
),
'subsubfile2.php' => array(
'name' => 'subsubfile2.php',
),
),
),
),
),
'subdir2' => array(
'files' => array(
'subfile3.php' => array( 'name' => 'subfile3.php' ),
'subfile4.php' => array( 'name' => 'subfile4.php' ),
'subsubdir2' => array(
'files' => array(
'subsubfile3.php' => array(
'name' => 'subsubfile3.php',
),
'subsubfile4.php' => array(
'name' => 'subsubfile4.php',
),
),
),
),
),
),
),
'two levels deep and custom path' => array(
'expected' => array(
'custom_path/subdir1' => array(
'files' => array(
'subfile1.php' => array(
'name' => 'subfile1.php',
),
'subfile2.php' => array(
'name' => 'subfile2.php',
),
'subsubdir1' => array(
'files' => array(
'subsubfile1.php' => array(
'name' => 'subsubfile1.php',
),
'subsubfile2.php' => array(
'name' => 'subsubfile2.php',
),
),
),
),
),
'custom_path/subdir1/subfile1.php' => array(
'name' => 'subfile1.php',
),
'custom_path/subdir1/subfile2.php' => array(
'name' => 'subfile2.php',
),
'custom_path/subdir1/subsubdir1' => array(
'files' => array(
'subsubfile1.php' => array(
'name' => 'subsubfile1.php',
),
'subsubfile2.php' => array(
'name' => 'subsubfile2.php',
),
),
),
'custom_path/subdir1/subsubdir1/subsubfile1.php' => array(
'name' => 'subsubfile1.php',
),
'custom_path/subdir1/subsubdir1/subsubfile2.php' => array(
'name' => 'subsubfile2.php',
),
'custom_path/subdir2' => array(
'files' => array(
'subfile3.php' => array( 'name' => 'subfile3.php' ),
'subfile4.php' => array( 'name' => 'subfile4.php' ),
'subsubdir2' => array(
'files' => array(
'subsubfile3.php' => array(
'name' => 'subsubfile3.php',
),
'subsubfile4.php' => array(
'name' => 'subsubfile4.php',
),
),
),
),
),
'custom_path/subdir2/subfile3.php' => array(
'name' => 'subfile3.php',
),
'custom_path/subdir2/subfile4.php' => array(
'name' => 'subfile4.php',
),
'custom_path/subdir2/subsubdir2' => array(
'files' => array(
'subsubfile3.php' => array(
'name' => 'subsubfile3.php',
),
'subsubfile4.php' => array(
'name' => 'subsubfile4.php',
),
),
),
'custom_path/subdir2/subsubdir2/subsubfile3.php' => array(
'name' => 'subsubfile3.php',
),
'custom_path/subdir2/subsubdir2/subsubfile4.php' => array(
'name' => 'subsubfile4.php',
),
),
'nested_files' => array(
'subdir1' => array(
'files' => array(
'subfile1.php' => array( 'name' => 'subfile1.php' ),
'subfile2.php' => array( 'name' => 'subfile2.php' ),
'subsubdir1' => array(
'files' => array(
'subsubfile1.php' => array(
'name' => 'subsubfile1.php',
),
'subsubfile2.php' => array(
'name' => 'subsubfile2.php',
),
),
),
),
),
'subdir2' => array(
'files' => array(
'subfile3.php' => array( 'name' => 'subfile3.php' ),
'subfile4.php' => array( 'name' => 'subfile4.php' ),
'subsubdir2' => array(
'files' => array(
'subsubfile3.php' => array(
'name' => 'subsubfile3.php',
),
'subsubfile4.php' => array(
'name' => 'subsubfile4.php',
),
),
),
),
),
),
'path' => 'custom_path/',
),
);
}
/**
* Tests that `WP_Upgrader::clear_destination()` returns early with `true`
* when the destination does not exist.
*
* @ticket 54245
*
* @covers WP_Upgrader::clear_destination
*/
public function test_clear_destination_should_return_early_when_the_destination_does_not_exist() {
self::$wp_filesystem_mock->expects( $this->never() )->method( 'is_writable' );
self::$wp_filesystem_mock->expects( $this->never() )->method( 'chmod' );
self::$wp_filesystem_mock->expects( $this->never() )->method( 'delete' );
$destination = DIR_TESTDATA . '/upgrade/';
self::$wp_filesystem_mock
->expects( $this->once() )
->method( 'dirlist' )
->with( $destination )
->willReturn( false );
$this->assertTrue( self::$instance->clear_destination( $destination ) );
}
/**
* Tests that `WP_Upgrader::clear_destination()` clears
* the destination directory.
*
* @ticket 54245
*
* @covers WP_Upgrader::clear_destination
*/
public function test_clear_destination_should_clear_the_destination_directory() {
$destination = DIR_TESTDATA . '/upgrade/';
self::$wp_filesystem_mock
->expects( $this->once() )
->method( 'dirlist' )
->with( $destination )
->willReturn( array() );
self::$wp_filesystem_mock
->expects( $this->once() )
->method( 'delete' )
->with( $destination )
->willReturn( true );
$this->assertTrue( self::$instance->clear_destination( $destination ) );
}
/**
* Tests that `WP_Upgrader::clear_destination()` returns a WP_Error object
* if files are not writable.
*
* This test runs in a separate process so that it can define
* constants without impacting other tests.
*
* This test does not preserve global state to prevent the exception
* "Serialization of 'Closure' is not allowed." when running in a
* separate process.
*
* @ticket 54245
*
* @covers WP_Upgrader::clear_destination
*
* @runInSeparateProcess
* @preserveGlobalState disabled
*/
public function test_clear_destination_should_return_wp_error_if_files_are_not_writable() {
define( 'FS_CHMOD_FILE', 0644 );
define( 'FS_CHMOD_DIR', 0755 );
self::$instance->generic_strings();
self::$wp_filesystem_mock->expects( $this->never() )->method( 'delete' );
$destination = DIR_TESTDATA . '/upgrade/';
$dirlist = array(
'file1.php' => array(
'name' => 'file1.php',
'type' => 'f',
),
'subdir' => array(
'name' => 'subdir',
'type' => 'd',
),
);
self::$wp_filesystem_mock
->expects( $this->once() )
->method( 'dirlist' )
->with( $destination )
->willReturn( $dirlist );
$unwritable_checks = array(
array( $destination . 'file1.php' ),
array( $destination . 'file1.php' ),
array( $destination . 'subdir' ),
array( $destination . 'subdir' ),
);
self::$wp_filesystem_mock
->expects( $this->exactly( 4 ) )
->method( 'is_writable' )
->withConsecutive( ...$unwritable_checks )
->willReturn( false );
$actual = self::$instance->clear_destination( $destination );
$this->assertWPError(
$actual,
'WP_Upgrader::clear_destination() did not return a WP_Error object'
);
$this->assertSame(
'files_not_writable',
$actual->get_error_code(),
'Unexpected WP_Error code'
);
$this->assertSameSets(
array( 'file1.php, subdir' ),
$actual->get_all_error_data(),
'Unexpected WP_Error data'
);
}
/**
* Tests that `WP_Upgrader::install_package()` returns a WP_Error object
* when an invalid source is passed.
*
* @ticket 54245
*
* @covers WP_Upgrader::install_package
*
* @dataProvider data_install_package_invalid_paths
*
* @param mixed $path The path to test.
*/
public function test_install_package_should_return_wp_error_with_invalid_source( $path ) {
self::$instance->generic_strings();
self::$upgrader_skin_mock->expects( $this->never() )->method( 'feedback' );
self::$wp_filesystem_mock->expects( $this->never() )->method( 'dirlist' );
self::$wp_filesystem_mock->expects( $this->never() )->method( 'find_folder' );
self::$wp_filesystem_mock->expects( $this->never() )->method( 'is_dir' );
self::$wp_filesystem_mock->expects( $this->never() )->method( 'exists' );
self::$wp_filesystem_mock->expects( $this->never() )->method( 'delete' );
self::$wp_filesystem_mock->expects( $this->never() )->method( 'mkdir' );
$args = array(
'source' => $path,
'destination' => '/',
);
$actual = self::$instance->install_package( $args );
$this->assertWPError(
$actual,
'WP_Upgrader::install_package() did not return a WP_Error object'
);
$this->assertSame(
'bad_request',
$actual->get_error_code(),
'Unexpected WP_Error code'
);
}
/**
* Tests that `WP_Upgrader::install_package()` returns a WP_Error object
* when an invalid destination is passed.
*
* @ticket 54245
*
* @covers WP_Upgrader::install_package
*
* @dataProvider data_install_package_invalid_paths
*
* @param mixed $path The path to test.
*/
public function test_install_package_should_return_wp_error_with_invalid_destination( $path ) {
self::$instance->generic_strings();
self::$upgrader_skin_mock->expects( $this->never() )->method( 'feedback' );
self::$wp_filesystem_mock->expects( $this->never() )->method( 'dirlist' );
self::$wp_filesystem_mock->expects( $this->never() )->method( 'find_folder' );
self::$wp_filesystem_mock->expects( $this->never() )->method( 'is_dir' );
self::$wp_filesystem_mock->expects( $this->never() )->method( 'exists' );
self::$wp_filesystem_mock->expects( $this->never() )->method( 'delete' );
self::$wp_filesystem_mock->expects( $this->never() )->method( 'mkdir' );
$args = array(
'source' => '/',
'destination' => $path,
);
$actual = self::$instance->install_package( $args );
$this->assertWPError(
$actual,
'WP_Upgrader::install_package() did not return a WP_Error object'
);
$this->assertSame(
'bad_request',
$actual->get_error_code(),
'Unexpected WP_Error code'
);
}
/**
* Data provider.
*
* @return array[]
*/
public function data_install_package_invalid_paths() {
return array(
'empty string' => array( 'path' => '' ),
// Type checks.
'empty array' => array( 'path' => array() ),
'populated array' => array( 'path' => array( '/' ) ),
'(int) 0' => array( 'path' => 0 ),
'(int) -0' => array( 'path' => -0 ),
'(int) -1' => array( 'path' => -1 ),
'(int) 1' => array( 'path' => 1 ),
'(float) 0.0' => array( 'path' => 0.0 ),
'(float) -0.0' => array( 'path' => -0.0 ),
'(float) 1.0' => array( 'path' => 1.0 ),
'(float) -1.0' => array( 'path' => -1.0 ),
'(bool) false' => array( 'path' => false ),
'(bool) true' => array( 'path' => true ),
'null' => array( 'path' => null ),
'empty object' => array( 'path' => new stdClass() ),
'populated object' => array( 'path' => (object) array( '/' ) ),
// Ensures that `trim()` is run triggering an empty array.
'a string with spaces' => array( 'path' => ' ' ),
'a string with tabs' => array( 'path' => "\t\t" ),
'a string with new lines' => array( 'path' => "\n\n" ),
'a string with carriage returns' => array( 'path' => "\r\r" ),
// Ensure that strings with leading/trailing whitespace are invalid.
'a path with a leading space' => array( 'path' => ' /path' ),
'a path with a trailing space' => array( 'path' => '/path ' ),
'a path with a leading tab' => array( 'path' => "\t/path" ),
'a path with a trailing tab' => array( 'path' => "/path\t" ),
);
}
/**
* Tests that `WP_Upgrader::install_package()` returns a WP_Error object
* when the 'upgrader_pre_install' filter returns a WP_Error object.
*
* @ticket 54245
*
* @covers WP_Upgrader::install_package
*/
public function test_install_package_should_return_wp_error_when_pre_install_filter_returns_wp_error() {
self::$instance->generic_strings();
self::$upgrader_skin_mock
->expects( $this->once() )
->method( 'feedback' )
->with( 'installing_package' );
add_filter(
'upgrader_pre_install',
static function () {
return new WP_Error( 'from_upgrader_pre_install' );
}
);
$args = array(
'source' => '/',
'destination' => '/',
);
$actual = self::$instance->install_package( $args );
$this->assertWPError(
$actual,
'WP_Upgrader::install_package() did not return a WP_Error object'
);
$this->assertSame(
'from_upgrader_pre_install',
$actual->get_error_code(),
'The WP_Error object was not returned from the filter'
);
}
/**
* Tests that `WP_Upgrader::install_package()` adds a trailing slash to
* the source directory and a single subdirectory.
*
* @ticket 54245
*
* @covers WP_Upgrader::install_package
*/
public function test_install_package_should_add_trailing_slash_to_source_and_subdirectory() {
self::$instance->generic_strings();
self::$upgrader_skin_mock
->expects( $this->once() )
->method( 'feedback' )
->with( 'installing_package' );
$dirlist = array(
'subdir' => array(
'name' => 'subdir',
'type' => 'd',
'files' => array( 'subfile.php' ),
),
);
self::$wp_filesystem_mock
->expects( $this->once() )
->method( 'dirlist' )
->with( '/source_dir' )
->willReturn( $dirlist );
self::$wp_filesystem_mock
->expects( $this->once() )
->method( 'is_dir' )
->with( '/source_dir/subdir/' )
->willReturn( true );
add_filter(
'upgrader_source_selection',
function ( $source ) {
$this->assertSame( '/source_dir/subdir/', $source );
// Return a WP_Error to exit before `move_dir()/copy_dir()`.
return new WP_Error();
}
);
$args = array(
'source' => '/source_dir',
'destination' => '/dest_dir',
);
self::$instance->install_package( $args );
}
/**
* Tests that `WP_Upgrader::install_package()` returns a WP_Error object
* when no source files exist.
*
* @ticket 54245
*
* @covers WP_Upgrader::install_package
*/
public function test_install_package_should_return_wp_error_when_no_source_files_exist() {
self::$instance->generic_strings();
self::$upgrader_skin_mock
->expects( $this->once() )
->method( 'feedback' )
->with( 'installing_package' );
self::$wp_filesystem_mock
->expects( $this->once() )
->method( 'dirlist' )
->with( '/' )
->willReturn( array() );
$args = array(
'source' => '/',
'destination' => '/',
);
$actual = self::$instance->install_package( $args );
$this->assertWPError(
$actual,
'WP_Upgrader::install_package() did not return a WP_Error object'
);
$this->assertSame(
'incompatible_archive_empty',
$actual->get_error_code(),
'Unexpected WP_Error code'
);
}
/**
* Tests that `WP_Upgrader::install_package()` adds a trailing slash to
* the source directory of a single file.
*
* @ticket 54245
*
* @covers WP_Upgrader::install_package
*/
public function test_install_package_should_add_trailing_slash_to_the_source_directory_of_single_file() {
self::$instance->generic_strings();
self::$upgrader_skin_mock
->expects( $this->once() )
->method( 'feedback' )
->with( 'installing_package' );
self::$wp_filesystem_mock
->expects( $this->once() )
->method( 'dirlist' )
->with( '/source_dir' )
->willReturn( array( 'file1.php' ) );
add_filter(
'upgrader_source_selection',
function ( $source ) {
$this->assertSame( '/source_dir/', $source );
// Return a WP_Error to exit before `move_dir()/copy_dir()`.
return new WP_Error();
}
);
$args = array(
'source' => '/source_dir',
'destination' => '/dest_dir',
);
self::$instance->install_package( $args );
}
/**
* Tests that `WP_Upgrader::install_package()` applies
* 'upgrader_clear_destination' filters with arguments.
*
* This test runs in a separate process so that it can define
* constants without impacting other tests.
*
* This test does not preserve global state to prevent the exception
* "Serialization of 'Closure' is not allowed." when running in a
* separate process.