-
Notifications
You must be signed in to change notification settings - Fork 97
Expand file tree
/
Copy pathplugin-check.feature
More file actions
921 lines (824 loc) · 28 KB
/
plugin-check.feature
File metadata and controls
921 lines (824 loc) · 28 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
Feature: Test that the WP-CLI command works.
Scenario: Check a non-existent plugin
Given a WP install with the Plugin Check plugin
When I try the WP-CLI command `plugin check foo-bar`
Then STDERR should contain:
"""
Plugin with slug foo-bar is not installed.
"""
Scenario: Check custom single file plugin
Given a WP install with the Plugin Check plugin
And a wp-content/plugins/foo-single.php file:
"""
<?php
/**
* Plugin Name: Foo Single
* Plugin URI: https://foo-single.com
* Description: Custom plugin.
* Version: 0.1.0
* Author: WordPress Performance Team
* Author URI: https://make.wordpress.org/performance/
* License: GPL-2.0+
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt
*/
add_action(
'init',
function () {
$number = mt_rand( 10, 100 );
echo $number;
}
);
"""
When I run the WP-CLI command `plugin check foo-single.php`
Then STDOUT should contain:
"""
mt_rand() is discouraged.
"""
And STDOUT should not contain:
"""
no_plugin_readme
"""
And STDOUT should not contain:
"""
trademarked_term
"""
And STDOUT should contain:
"""
All output should be run through an escaping function
"""
When I run the WP-CLI command `plugin check foo-single.php --format=csv`
Then STDOUT should contain:
"""
line,column,type,code,message,docs
1,0,ERROR,missing_direct_file_access_protection,"PHP file should prevent direct access. Add a check like: if ( ! defined( 'ABSPATH' ) ) exit;",https://developer.wordpress.org/plugins/wordpress-org/common-issues/#direct-file-access
16,15,ERROR,WordPress.WP.AlternativeFunctions.rand_mt_rand,"mt_rand() is discouraged. Use the far less predictable wp_rand() instead.",
17,10,ERROR,WordPress.Security.EscapeOutput.OutputNotEscaped,"All output should be run through an escaping function (see the Security sections in the WordPress Developer Handbooks), found '$number'.",https://developer.wordpress.org/apis/security/escaping/#escaping-functions
"""
When I run the WP-CLI command `plugin check foo-single.php --format=csv --fields=line,column,code`
Then STDOUT should contain:
"""
line,column,code
1,0,missing_direct_file_access_protection
16,15,WordPress.WP.AlternativeFunctions.rand_mt_rand
17,10,WordPress.Security.EscapeOutput.OutputNotEscaped
"""
When I run the WP-CLI command `plugin check foo-single.php --format=json`
Then STDOUT should contain:
"""
{"line":16,"column":15,"type":"ERROR","code":"WordPress.WP.AlternativeFunctions.rand_mt_rand","message":"mt_rand() is discouraged. Use the far less predictable wp_rand() instead.","docs":""}
"""
When I run the WP-CLI command `plugin check foo-single.php --ignore-errors`
Then STDOUT should contain:
"""
Success: Checks complete. No errors found.
"""
When I run the WP-CLI command `plugin check foo-single.php --ignore-warnings`
Then STDOUT should not be empty
When I run the WP-CLI command `plugin check foo-single.php --checks=plugin_review_phpcs`
Then STDOUT should contain:
"""
WordPress.WP.AlternativeFunctions.rand_mt_rand
"""
And STDOUT should not contain:
"""
WordPress.Security.EscapeOutput.OutputNotEscaped
"""
When I run the WP-CLI command `plugin check foo-single.php --exclude-checks=late_escaping`
Then STDOUT should not contain:
"""
WordPress.Security.EscapeOutput.OutputNotEscaped
"""
And STDOUT should contain:
"""
WordPress.WP.AlternativeFunctions.rand_mt_rand
"""
When I run the WP-CLI command `plugin check foo-single.php --categories=security`
Then STDOUT should contain:
"""
WordPress.Security.EscapeOutput.OutputNotEscaped
"""
And STDOUT should not contain:
"""
WordPress.WP.AlternativeFunctions.rand_mt_rand
"""
When I run the WP-CLI command `plugin check foo-single.php --checks=plugin_review_phpcs,late_escaping --exclude-checks=late_escaping`
Then STDOUT should contain:
"""
WordPress.WP.AlternativeFunctions.rand_mt_rand
"""
And STDOUT should not contain:
"""
WordPress.Security.EscapeOutput.OutputNotEscaped
"""
When I run the WP-CLI command `plugin check foo-single.php --ignore-codes=WordPress.WP.AlternativeFunctions.rand_mt_rand`
Then STDOUT should not contain:
"""
WordPress.WP.AlternativeFunctions.rand_mt_rand
"""
And STDOUT should contain:
"""
WordPress.Security.EscapeOutput.OutputNotEscaped
"""
When I run the WP-CLI command `plugin check foo-single.php --ignore-codes=WordPress.Security.EscapeOutput.OutputNotEscaped`
Then STDOUT should not contain:
"""
WordPress.Security.EscapeOutput.OutputNotEscaped
"""
And STDOUT should contain:
"""
WordPress.WP.AlternativeFunctions.rand_mt_rand
"""
When I run the WP-CLI command `plugin check foo-single.php --ignore-codes="WordPress.WP.AlternativeFunctions.rand_mt_rand,WordPress.Security.EscapeOutput.OutputNotEscaped"`
Then STDOUT should not contain:
"""
WordPress.Security.EscapeOutput.OutputNotEscaped
"""
And STDOUT should not contain:
"""
WordPress.WP.AlternativeFunctions.rand_mt_rand
"""
When I run the WP-CLI command `plugin check foo-single.php --format=json --fields=line,column,type,code`
Then STDOUT should contain:
"""
FILE:
"""
When I run the WP-CLI command `plugin check foo-single.php --format=strict-json --fields=line,column,type,code`
Then STDOUT should be valid JSON
And STDOUT should not contain:
"""
FILE:
"""
Scenario: Check plugin with special chars in plugin name
Given a WP install with the Plugin Check plugin
And a wp-content/plugins/johns-post-counter/johns-post-counter.php file:
"""
<?php
/**
* Plugin Name: John's — Post & Counter
*/
"""
And a wp-content/plugins/johns-post-counter/readme.txt file:
"""
=== John's — Post & Counter ===
"""
When I run the WP-CLI command `plugin check johns-post-counter --format=csv --fields=code,type`
Then STDOUT should not contain:
"""
mismatched_plugin_name,WARNING
"""
Scenario: Exclude directories in plugin check
Given a WP install with the Plugin Check plugin
And an empty wp-content/plugins/foo-plugin directory
And an empty wp-content/plugins/foo-plugin/subdirectory directory
And a wp-content/plugins/foo-plugin/foo-plugin.php file:
"""
<?php
/**
* Plugin Name: Foo Plugin
* Plugin URI: https://foo-plugin.com
* Description:
* Version: 0.1.0
* Author:
* Author URI:
* License: GPL-2.0+
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt
* Text Domain: foo-plugin
* Domain Path: /languages
*/
"""
And a wp-content/plugins/foo-plugin/subdirectory/bar.php file:
"""
<?php
$value = 1;
echo $value;
"""
When I run the WP-CLI command `plugin check foo-plugin`
Then STDOUT should contain:
"""
FILE: subdirectory/bar.php
"""
When I run the WP-CLI command `plugin check foo-plugin --exclude-directories=subdirectory`
Then STDOUT should not contain:
"""
FILE: subdirectory/bar.php
"""
Scenario: Exclude files in plugin check
Given a WP install with the Plugin Check plugin
And an empty wp-content/plugins/foo-plugin directory
And an empty wp-content/plugins/foo-plugin/subdirectory directory
And a wp-content/plugins/foo-plugin/foo-plugin.php file:
"""
<?php
/**
* Plugin Name: Foo Plugin
* Plugin URI: https://foo-plugin.com
* Description:
* Version: 0.1.0
* Author:
* Author URI:
* License: GPL-2.0+
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt
* Text Domain: foo-plugin
* Domain Path: /languages
*/
"""
And a wp-content/plugins/foo-plugin/bar.php file:
"""
<?php
$value = 1;
echo $value;
"""
And a wp-content/plugins/foo-plugin/foobar.php file:
"""
<?php
$value = 1;
echo $value;
"""
And a wp-content/plugins/foo-plugin/subdirectory/error.php file:
"""
<?php
$value = 1;
echo $value;
"""
When I run the WP-CLI command `plugin check foo-plugin`
Then STDOUT should contain:
"""
FILE: bar.php
"""
And STDOUT should contain:
"""
FILE: foobar.php
"""
When I run the WP-CLI command `plugin check foo-plugin --exclude-files=bar.php`
Then STDOUT should contain:
"""
FILE: foobar.php
"""
And STDOUT should not contain:
"""
FILE: bar.php
"""
When I run the WP-CLI command `plugin check foo-plugin --exclude-files=subdirectory/error.php`
Then STDOUT should not contain:
"""
FILE: subdirectory/error.php
"""
Scenario: Perform runtime check
Given a WP install with the Plugin Check plugin
And a wp-content/plugins/foo-single.php file:
"""
<?php
/**
* Plugin Name: Foo Single
* Plugin URI: https://foo-single.com
* Description: Custom plugin.
* Version: 0.1.0
* Author: WordPress Performance Team
* Author URI: https://make.wordpress.org/performance/
* License: GPL-2.0+
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt
*/
add_action(
'init',
function () {
$number = mt_rand( 10, 100 );
echo $number;
}
);
"""
When I run the WP-CLI command `plugin check foo-single.php --require=./wp-content/plugins/plugin-check/cli.php`
Then STDOUT should contain:
"""
mt_rand() is discouraged.
"""
Scenario: Perform runtime check for multi-file plugin
Given a WP install with the Plugin Check plugin
And a wp-content/plugins/foo-sample/foo-sample.php file:
"""
<?php
/**
* Plugin Name: Foo Sample
* Plugin URI: https://foo-sample.com
* Description: Custom plugin.
* Version: 0.1.0
* Author: WordPress Performance Team
* Author URI: https://make.wordpress.org/performance/
* License: GPL-2.0+
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt
*/
add_action(
'init',
function () {
$number = mt_rand( 10, 100 );
echo absint( $number );
}
);
add_action(
'wp_enqueue_scripts',
function() {
wp_enqueue_style(
'style',
plugin_dir_url( __FILE__ ) . 'style.css',
array(),
'1.0'
);
}
);
"""
And a wp-content/plugins/foo-sample/style.css file:
"""
a {
text-decoration: underline;
}
"""
When I run the WP-CLI command `plugin activate foo-sample`
And I run the WP-CLI command `plugin check foo-sample --fields=code,type --format=csv --require=./wp-content/plugins/plugin-check/cli.php`
Then STDOUT should contain:
"""
WordPress.WP.AlternativeFunctions.rand_mt_rand,ERROR
"""
And STDOUT should contain:
"""
EnqueuedStylesScope,WARNING
"""
And STDOUT should contain:
"""
no_plugin_readme,ERROR
"""
Scenario: Check a plugin from external location
Given a WP install with the Plugin Check plugin
And an empty external-folder/foo-plugin directory
And a external-folder/foo-plugin/foo-plugin.php file:
"""
<?php
/**
* Plugin Name: Foo Plugin
* Plugin URI: https://foo-plugin.com
* Description:
* Version: 0.1.0
* Author:
* Author URI:
* License: GPL-2.0+
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt
* Text Domain: foo-plugin
* Domain Path: /languages
*/
"""
When I run the WP-CLI command `plugin check {RUN_DIR}/external-folder/foo-plugin`
Then STDERR should be empty
And STDOUT should contain:
"""
trademarked_term
"""
And STDOUT should contain:
"""
no_plugin_readme
"""
Scenario: Check a plugin from external location with custom plugin slug
Given a WP install with the Plugin Check plugin
And an empty external-folder/pxzvccv345nhg directory
And a external-folder/pxzvccv345nhg/foo-sample.php file:
"""
<?php
/**
* Plugin Name: Foo Sample
* Plugin URI: https://foo-sample.com
* Description:
* Version: 0.1.0
* Author:
* Author URI:
* License: GPL-2.0+
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt
* Text Domain: foo-sample
*/
"""
When I run the WP-CLI command `plugin check {RUN_DIR}/external-folder/pxzvccv345nhg/ --format=csv --fields=code,type`
Then STDERR should be empty
And STDOUT should contain:
"""
textdomain_mismatch,WARNING
"""
And STDOUT should contain:
"""
no_plugin_readme,ERROR
"""
When I run the WP-CLI command `plugin check {RUN_DIR}/external-folder/pxzvccv345nhg/ --format=csv --fields=code,type --slug=foo-sample`
Then STDERR should be empty
And STDOUT should not contain:
"""
textdomain_mismatch,WARNING
"""
And STDOUT should contain:
"""
no_plugin_readme,ERROR
"""
Scenario: Check a plugin from external location but with invalid plugin
Given a WP install with the Plugin Check plugin
And an empty external-folder/foo-plugin directory
And a external-folder/foo-plugin/foo-plugin.php file:
"""
<?php
// Not a valid plugin.
"""
When I try the WP-CLI command `plugin check {RUN_DIR}/non-existent-external-folder/foo-plugin`
Then STDOUT should be empty
And STDERR should not contain:
"""
no_plugin_readme
"""
And STDERR should contain:
"""
Invalid plugin slug
"""
When I try the WP-CLI command `plugin check {RUN_DIR}/external-folder/foo-plugin`
Then STDOUT should be empty
And STDERR should not contain:
"""
no_plugin_readme
"""
And STDERR should contain:
"""
Invalid plugin slug
"""
Scenario: Check a plugin with static checks from an add-on
Given a WP install with the Plugin Check plugin
And a Plugin Check add-on being installed
And a wp-content/plugins/foo-sample/foo-sample.php file:
"""
<?php
/**
* Plugin Name: Foo Sample
* Plugin URI: https://example.com
* Description: Sample plugin.
* Version: 0.1.0
* Author: WordPress Performance Team
* Author URI: https://make.wordpress.org/performance/
* License: GPL-2.0+
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt
*/
$text = 'I am bad'; // This should trigger the error.
$string = 'This is experimental string.';
"""
And I run the WP-CLI command `plugin activate foo-sample`
# The two stable checks from pcp-addon should be available.
When I run the WP-CLI command `plugin list-checks --fields=slug,category,stability --format=csv`
Then STDOUT should contain:
"""
example_static,new_category,stable
"""
And STDOUT should contain:
"""
example_runtime,new_category,stable
"""
And STDOUT should not contain:
"""
example_experimental,new_category,experimental
"""
# Experimental checks from pcp-addon should be available.
When I run the WP-CLI command `plugin list-checks --fields=slug,category,stability --format=csv --include-experimental`
Then STDOUT should contain:
"""
example_experimental,new_category,experimental
"""
# The new check category should therefore also be available.
When I run the WP-CLI command `plugin list-check-categories --fields=slug,name --format=csv`
Then STDOUT should contain:
"""
new_category,"New Category"
"""
# Running static checks, including the one from pcp-addon
When I run the WP-CLI command `plugin check foo-sample --fields=code,type --format=csv`
Then STDOUT should contain:
"""
prohibited_text_detected,ERROR
"""
# Same again, but after filtering only to the new categories from pcp-addon
When I run the WP-CLI command `plugin check foo-sample --fields=code,type --format=csv --categories=new_category`
Then STDOUT should contain:
"""
prohibited_text_detected,ERROR
"""
# Running experimental checks, including the one from pcp-addon
When I run the WP-CLI command `plugin check foo-sample --fields=code,type --format=csv --include-experimental`
Then STDOUT should contain:
"""
experimental_text_detected,ERROR
"""
# Running only the check from pcp-addon
When I run the WP-CLI command `plugin check foo-sample --checks=example_static --fields=code,type --format=csv`
Then STDOUT should contain:
"""
prohibited_text_detected,ERROR
"""
Scenario: Check a plugin with runtime checks from an add-on
Given a WP install with the Plugin Check plugin
And a Plugin Check add-on being installed
And a wp-content/plugins/foo-dependency/foo-dependency.php file:
"""
<?php
/**
* Plugin Name: Foo Dependency
* Plugin URI: https://example.com
* Description: Sample plugin.
* Version: 0.1.0
* Author: WordPress Performance Team
* Author URI: https://make.wordpress.org/performance/
* License: GPL-2.0+
* License URI: https://www.gnu.org/licenses/gpl-2.0.txt
*/
"""
And a wp-content/plugins/foo-sample/foo-sample.php file:
"""
<?php
/**
* Plugin Name: Foo Sample
* Plugin URI: https://example.com
* Description: Sample plugin.
* Version: 0.1.0
* Author: WordPress Performance Team
* Author URI: https://make.wordpress.org/performance/
* License: GPL-2.0+
* License URI: https://www.gnu.org/licenses/gpl-2.0.txt
* Requires Plugins: foo-dependency
*/
// This should trigger the error.
add_action(
'wp_enqueue_scripts',
function() {
wp_enqueue_script( 'test', plugin_dir_url( __FILE__ ) . 'test.js', array(), '1.0' );
}
);
"""
And I run the WP-CLI command `plugin activate foo-dependency foo-sample`
# Running runtime checks, including the one from pcp-addon
When I run the WP-CLI command `plugin check foo-sample --fields=code,type --format=csv --require=./wp-content/plugins/plugin-check/cli.php`
Then STDOUT should contain:
"""
WordPress.WP.EnqueuedResourceParameters.NotInFooter,WARNING
"""
And STDOUT should contain:
"""
ExampleRuntimeCheck.ForbiddenScript,WARNING
"""
# Same again but without requiring the cli.php file, to verify object-cache.php was properly cleared again
When I run the WP-CLI command `plugin check foo-sample --fields=code,type --format=csv`
Then STDOUT should contain:
"""
WordPress.WP.EnqueuedResourceParameters.NotInFooter,WARNING
"""
And STDOUT should not contain:
"""
ExampleRuntimeCheck.ForbiddenScript,WARNING
"""
# Run one runtime check from PCP and one from pcp-addon.
When I run the WP-CLI command `plugin check foo-sample --checks=non_blocking_scripts,example_runtime --fields=code,type --format=csv --require=./wp-content/plugins/plugin-check/cli.php`
Then STDOUT should contain:
"""
ExampleRuntimeCheck.ForbiddenScript,WARNING
"""
# Run only the runtime check from pcp-addon, no others
When I run the WP-CLI command `plugin check foo-sample --checks=example_runtime --fields=code,type --format=csv --require=./wp-content/plugins/plugin-check/cli.php`
Then STDOUT should contain:
"""
ExampleRuntimeCheck.ForbiddenScript,WARNING
"""
Scenario: Check custom single file plugin that has no errors or warnings
Given a WP install with the Plugin Check plugin
And a wp-content/plugins/foo-single.php file:
"""
<?php
/**
* Plugin Name: Foo Single
* Plugin URI: https://foo-single.com
* Description: Custom plugin.
* Version: 0.1.0
* Author: WordPress Performance Team
* Author URI: https://make.wordpress.org/performance/
* License: GPL-2.0+
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
add_action(
'init',
function () {
echo esc_html( 'this is a test.' );
}
);
"""
When I run the WP-CLI command `plugin check foo-single.php`
Then STDOUT should contain:
"""
Success: Checks complete. No errors found.
"""
Scenario: Check for mismatched plugin name in non-English language setup
Given a WP install with the Plugin Check plugin
And a wp-content/plugins/foo-sample/foo-sample.php file:
"""
<?php
/**
* Plugin Name: Foo Sample
* Plugin URI: https://foo-sample.com
* Description: Custom plugin.
* Version: 0.1.0
* Author: WordPress Performance Team
* Author URI: https://make.wordpress.org/performance/
* License: GPL-2.0+
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt
*/
"""
And a wp-content/plugins/foo-sample/readme.txt file:
"""
=== Foo Sample ===
Contributors: johndoe
Tags: foo, sample
Tested up to: 6.5
Stable tag: 0.1.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Short description will be here.
== Description ==
Long description will be here.
"""
And a wp-content/plugins/foo-sample/foo-sample-ne_NP.po file:
"""
# Copyright (C) 2024 WordPress Performance Team
# This file is distributed under the GPLv2 or later.
msgid ""
msgstr ""
"Project-Id-Version: Foo Sample 0.1.0\n"
"Report-Msgid-Bugs-To: \n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"POT-Creation-Date: \n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"X-Generator: WP-CLI 2.11.0\n"
"Language: ne_NP\n"
"X-Domain: foo-sample\n"
#. Plugin Name of the plugin
#: foo-sample.php
msgid "Foo Sample"
msgstr "फू स्याम्पल"
"""
And I run the WP-CLI command `language core install ne_NP`
And I run the WP-CLI command `i18n make-mo wp-content/plugins/foo-sample/foo-sample-ne_NP.po`
And I run the WP-CLI command `site switch-language ne_NP`
When I run the WP-CLI command `plugin check foo-sample`
Then STDOUT should not contain:
"""
mismatched_plugin_name
"""
Scenario: Check Contributors value in readme in markdown format
Given a WP install with the Plugin Check plugin
And a wp-content/plugins/foo-sample/foo-sample.php file:
"""
<?php
/**
* Plugin Name: Foo Sample
* Plugin URI: https://foo-sample.com
* Description: Custom plugin.
* Version: 0.1.0
* Author: WordPress Performance Team
* Author URI: https://make.wordpress.org/performance/
* License: GPL-2.0+
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt
*/
"""
And a wp-content/plugins/foo-sample/README.md file:
"""
# Foo Sample #
**Contributors:** johndoe
**Requires at least:** 6.0
**Tested up to:** 6.6
**Requires PHP:** 7.2
**Stable tag:** 0.1.0
**License:** GPL-2.0+
**License URI:** http://www.gnu.org/licenses/gpl-2.0.txt
This is a short description of the plugin.
"""
When I run the WP-CLI command `plugin check foo-sample`
Then STDOUT should not contain:
"""
readme_invalid_contributors
"""
Scenario: Check duplicated error messages for hidden files and application files
Given a WP install with the Plugin Check plugin
And a wp-content/plugins/foo-sample/foo-sample.php file:
"""
<?php
/**
* Plugin Name: Foo Sample
* Plugin URI: https://foo-sample.com
* Description: Custom plugin.
* Version: 0.1.0
* Author: WordPress Performance Team
* Author URI: https://make.wordpress.org/performance/
* License: GPL-2.0+
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt
*/
"""
And a wp-content/plugins/foo-sample/.DS_Store file:
"""
"""
When I run the WP-CLI command `plugin check foo-sample --checks=file_type`
Then STDOUT should contain:
"""
hidden_files
"""
And STDOUT should not contain:
"""
application_detected
"""
Scenario: Check for i18n severity
Given a WP install with the Plugin Check plugin
And a wp-content/plugins/foo-sample/foo-sample.php file:
"""
<?php
/**
* Plugin Name: Foo Sample
* Plugin URI: https://foo-sample.com
* Description: Custom plugin.
* Version: 0.1.0
* Author: WordPress Performance Team
* Author URI: https://make.wordpress.org/performance/
* License: GPL-2.0+
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt
*/
esc_html_e( 'Hello world', "${var}" );
esc_html_e( domain: 'foo-sample' );
esc_html_e( '%s', 'foo-sample' );
echo esc_html_x( 'Hello world', $var, 'foo-sample' );
esc_html_e( 'Hello world', $var );
esc_html_e( 'Hello world', 'foo-sample', 'too-many-args' );
"""
When I run the WP-CLI command `plugin check foo-sample --checks=i18n_usage --fields=line,type,code,severity --format=csv`
Then STDOUT should contain:
"""
13,ERROR,WordPress.WP.I18n.InterpolatedVariableDomain,7
"""
And STDOUT should contain:
"""
14,ERROR,WordPress.WP.I18n.MissingArgText,7
"""
And STDOUT should contain:
"""
15,ERROR,WordPress.WP.I18n.NoEmptyStrings,7
"""
And STDOUT should contain:
"""
16,ERROR,WordPress.WP.I18n.NonSingularStringLiteralContext,7
"""
And STDOUT should contain:
"""
17,ERROR,WordPress.WP.I18n.NonSingularStringLiteralDomain,7
"""
And STDOUT should contain:
"""
18,ERROR,WordPress.WP.I18n.TooManyFunctionArgs,7
"""
Scenario: Check unsupported plugin name in plugin header field
Given a WP install with the Plugin Check plugin
And a wp-content/plugins/foo-sample/foo-sample.php file:
"""
<?php
/**
* Plugin Name: अद्भुत प्लगिन
* Plugin URI: https://foo-sample.com
* Description: Custom plugin.
* Version: 0.1.0
* Author: WordPress Performance Team
* Author URI: https://make.wordpress.org/performance/
* License: GPL-2.0+
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt
*/
"""
When I run the WP-CLI command `plugin check foo-sample`
Then STDOUT should contain:
"""
plugin_header_unsupported_plugin_name
"""
Scenario: Check plugin with missing Text Domain plugin header field
Given a WP install with the Plugin Check plugin
And a wp-content/plugins/foo-sample/foo-sample.php file:
"""
<?php
/**
* Plugin Name: Foo Sample
* Plugin URI: https://foo-sample.com
* Description: Custom plugin.
* Version: 0.1.0
* Author: WordPress Performance Team
* Author URI: https://make.wordpress.org/performance/
* License: GPL-2.0+
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt
*/
"""
When I run the WP-CLI command `plugin check foo-sample --slug=custom-slug`
Then STDOUT should not contain:
"""
textdomain_mismatch
"""