-
Benachrichtigungen
You must be signed in to change notification settings - Fork 225
/
robots_test.cc
1016 lines (931 loc) · 37 KB
/
robots_test.cc
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
// Copyright 2019 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// This file tests the robots.txt parsing and matching code found in robots.cc
// against the current Robots Exclusion Protocol (REP) RFC.
// https://www.rfc-editor.org/rfc/rfc9309.html
#include "robots.h"
#include <string>
#include "gtest/gtest.h"
#include "absl/strings/str_cat.h"
#include "absl/strings/string_view.h"
namespace {
using ::googlebot::RobotsMatcher;
bool IsUserAgentAllowed(const absl::string_view robotstxt,
const std::string& useragent, const std::string& url) {
RobotsMatcher matcher;
return matcher.OneAgentAllowedByRobots(robotstxt, useragent, url);
}
// Google-specific: system test.
TEST(RobotsUnittest, GoogleOnly_SystemTest) {
const absl::string_view robotstxt =
"user-agent: FooBot\n"
"disallow: /\n";
// Empty robots.txt: everything allowed.
EXPECT_TRUE(IsUserAgentAllowed("", "FooBot", ""));
// Empty user-agent to be matched: everything allowed.
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "", ""));
// Empty url: implicitly disallowed, see method comment for GetPathParamsQuery
// in robots.cc.
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "FooBot", ""));
// All params empty: same as robots.txt empty, everything allowed.
EXPECT_TRUE(IsUserAgentAllowed("", "", ""));
}
// Rules are colon separated name-value pairs. The following names are
// provisioned:
// user-agent: <value>
// allow: <value>
// disallow: <value>
// See REP RFC section "Protocol Definition".
// https://www.rfc-editor.org/rfc/rfc9309.html#section-2.1
//
// Google specific: webmasters sometimes miss the colon separator, but it's
// obvious what they mean by "disallow /", so we assume the colon if it's
// missing.
TEST(RobotsUnittest, ID_LineSyntax_Line) {
const absl::string_view robotstxt_correct =
"user-agent: FooBot\n"
"disallow: /\n";
const absl::string_view robotstxt_incorrect =
"foo: FooBot\n"
"bar: /\n";
const absl::string_view robotstxt_incorrect_accepted =
"user-agent FooBot\n"
"disallow /\n";
const std::string url = "http://foo.bar/x/y";
EXPECT_FALSE(IsUserAgentAllowed(robotstxt_correct, "FooBot", url));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt_incorrect, "FooBot", url));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt_incorrect_accepted, "FooBot", url));
}
// A group is one or more user-agent line followed by rules, and terminated
// by a another user-agent line. Rules for same user-agents are combined
// opaquely into one group. Rules outside groups are ignored.
// See REP RFC section "Protocol Definition".
// https://www.rfc-editor.org/rfc/rfc9309.html#section-2.1
TEST(RobotsUnittest, ID_LineSyntax_Groups) {
const absl::string_view robotstxt =
"allow: /foo/bar/\n"
"\n"
"user-agent: FooBot\n"
"disallow: /\n"
"allow: /x/\n"
"user-agent: BarBot\n"
"disallow: /\n"
"allow: /y/\n"
"\n"
"\n"
"allow: /w/\n"
"user-agent: BazBot\n"
"\n"
"user-agent: FooBot\n"
"allow: /z/\n"
"disallow: /\n";
const std::string url_w = "http://foo.bar/w/a";
const std::string url_x = "http://foo.bar/x/b";
const std::string url_y = "http://foo.bar/y/c";
const std::string url_z = "http://foo.bar/z/d";
const std::string url_foo = "http://foo.bar/foo/bar/";
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot", url_x));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot", url_z));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "FooBot", url_y));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "BarBot", url_y));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "BarBot", url_w));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "BarBot", url_z));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "BazBot", url_z));
// Lines with rules outside groups are ignored.
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "FooBot", url_foo));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "BarBot", url_foo));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "BazBot", url_foo));
}
// Group must not be closed by rules not explicitly defined in the REP RFC.
// See REP RFC section "Protocol Definition".
// https://www.rfc-editor.org/rfc/rfc9309.html#section-2.1
TEST(RobotsUnittest, ID_LineSyntax_Groups_OtherRules) {
{
const absl::string_view robotstxt =
"User-agent: BarBot\n"
"Sitemap: https://foo.bar/sitemap\n"
"User-agent: *\n"
"Disallow: /\n";
std::string url = "http://foo.bar/";
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "FooBot", url));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "BarBot", url));
}
{
const absl::string_view robotstxt =
"User-agent: FooBot\n"
"Invalid-Unknown-Line: unknown\n"
"User-agent: *\n"
"Disallow: /\n";
std::string url = "http://foo.bar/";
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "FooBot", url));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "BarBot", url));
}
}
// REP lines are case insensitive. See REP RFC section "Protocol Definition".
// https://www.rfc-editor.org/rfc/rfc9309.html#section-2.1
TEST(RobotsUnittest, ID_REPLineNamesCaseInsensitive) {
const absl::string_view robotstxt_upper =
"USER-AGENT: FooBot\n"
"ALLOW: /x/\n"
"DISALLOW: /\n";
const absl::string_view robotstxt_lower =
"user-agent: FooBot\n"
"allow: /x/\n"
"disallow: /\n";
const absl::string_view robotstxt_camel =
"uSeR-aGeNt: FooBot\n"
"AlLoW: /x/\n"
"dIsAlLoW: /\n";
const std::string url_allowed = "http://foo.bar/x/y";
const std::string url_disallowed = "http://foo.bar/a/b";
EXPECT_TRUE(IsUserAgentAllowed(robotstxt_upper, "FooBot", url_allowed));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt_lower, "FooBot", url_allowed));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt_camel, "FooBot", url_allowed));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt_upper, "FooBot", url_disallowed));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt_lower, "FooBot", url_disallowed));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt_camel, "FooBot", url_disallowed));
}
// A user-agent line is expected to contain only [a-zA-Z_-] characters and must
// not be empty. See REP RFC section "The user-agent line".
// https://www.rfc-editor.org/rfc/rfc9309.html#section-2.2.1
TEST(RobotsUnittest, ID_VerifyValidUserAgentsToObey) {
EXPECT_TRUE(RobotsMatcher::IsValidUserAgentToObey("Foobot"));
EXPECT_TRUE(RobotsMatcher::IsValidUserAgentToObey("Foobot-Bar"));
EXPECT_TRUE(RobotsMatcher::IsValidUserAgentToObey("Foo_Bar"));
EXPECT_FALSE(RobotsMatcher::IsValidUserAgentToObey(absl::string_view()));
EXPECT_FALSE(RobotsMatcher::IsValidUserAgentToObey(""));
EXPECT_FALSE(RobotsMatcher::IsValidUserAgentToObey("ツ"));
EXPECT_FALSE(RobotsMatcher::IsValidUserAgentToObey("Foobot*"));
EXPECT_FALSE(RobotsMatcher::IsValidUserAgentToObey(" Foobot "));
EXPECT_FALSE(RobotsMatcher::IsValidUserAgentToObey("Foobot/2.1"));
EXPECT_FALSE(RobotsMatcher::IsValidUserAgentToObey("Foobot Bar"));
}
// User-agent line values are case insensitive. See REP RFC section "The
// user-agent line".
// https://www.rfc-editor.org/rfc/rfc9309.html#section-2.2.1
TEST(RobotsUnittest, ID_UserAgentValueCaseInsensitive) {
const absl::string_view robotstxt_upper =
"User-Agent: FOO BAR\n"
"Allow: /x/\n"
"Disallow: /\n";
const absl::string_view robotstxt_lower =
"User-Agent: foo bar\n"
"Allow: /x/\n"
"Disallow: /\n";
const absl::string_view robotstxt_camel =
"User-Agent: FoO bAr\n"
"Allow: /x/\n"
"Disallow: /\n";
const std::string url_allowed = "http://foo.bar/x/y";
const std::string url_disallowed = "http://foo.bar/a/b";
EXPECT_TRUE(IsUserAgentAllowed(robotstxt_upper, "Foo", url_allowed));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt_lower, "Foo", url_allowed));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt_camel, "Foo", url_allowed));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt_upper, "Foo", url_disallowed));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt_lower, "Foo", url_disallowed));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt_camel, "Foo", url_disallowed));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt_upper, "foo", url_allowed));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt_lower, "foo", url_allowed));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt_camel, "foo", url_allowed));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt_upper, "foo", url_disallowed));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt_lower, "foo", url_disallowed));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt_camel, "foo", url_disallowed));
}
// Google specific: accept user-agent value up to the first space. Space is not
// allowed in user-agent values, but that doesn't stop webmasters from using
// them. This is more restrictive than the RFC, since in case of the bad value
// "Googlebot Images" we'd still obey the rules with "Googlebot".
// Extends REP RFC section "The user-agent line"
// https://www.rfc-editor.org/rfc/rfc9309.html#section-2.2.1
TEST(RobotsUnittest, GoogleOnly_AcceptUserAgentUpToFirstSpace) {
EXPECT_FALSE(RobotsMatcher::IsValidUserAgentToObey("Foobot Bar"));
const absl::string_view robotstxt =
"User-Agent: *\n"
"Disallow: /\n"
"User-Agent: Foo Bar\n"
"Allow: /x/\n"
"Disallow: /\n";
const std::string url = "http://foo.bar/x/y";
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "Foo", url));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "Foo Bar", url));
}
// If no group matches the user-agent, crawlers must obey the first group with a
// user-agent line with a "*" value, if present. If no group satisfies either
// condition, or no groups are present at all, no rules apply.
// See REP RFC section "The user-agent line".
// https://www.rfc-editor.org/rfc/rfc9309.html#section-2.2.1
TEST(RobotsUnittest, ID_GlobalGroups_Secondary) {
const absl::string_view robotstxt_empty = "";
const absl::string_view robotstxt_global =
"user-agent: *\n"
"allow: /\n"
"user-agent: FooBot\n"
"disallow: /\n";
const absl::string_view robotstxt_only_specific =
"user-agent: FooBot\n"
"allow: /\n"
"user-agent: BarBot\n"
"disallow: /\n"
"user-agent: BazBot\n"
"disallow: /\n";
const std::string url = "http://foo.bar/x/y";
EXPECT_TRUE(IsUserAgentAllowed(robotstxt_empty, "FooBot", url));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt_global, "FooBot", url));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt_global, "BarBot", url));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt_only_specific, "QuxBot", url));
}
// Matching rules against URIs is case sensitive.
// See REP RFC section "The Allow and Disallow lines".
// https://www.rfc-editor.org/rfc/rfc9309.html#section-2.2.2
TEST(RobotsUnittest, ID_AllowDisallow_Value_CaseSensitive) {
const absl::string_view robotstxt_lowercase_url =
"user-agent: FooBot\n"
"disallow: /x/\n";
const absl::string_view robotstxt_uppercase_url =
"user-agent: FooBot\n"
"disallow: /X/\n";
const std::string url = "http://foo.bar/x/y";
EXPECT_FALSE(IsUserAgentAllowed(robotstxt_lowercase_url, "FooBot", url));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt_uppercase_url, "FooBot", url));
}
// The most specific match found MUST be used. The most specific match is the
// match that has the most octets. In case of multiple rules with the same
// length, the least strict rule must be used.
// See REP RFC section "The Allow and Disallow lines".
// https://www.rfc-editor.org/rfc/rfc9309.html#section-2.2.2
TEST(RobotsUnittest, ID_LongestMatch) {
const std::string url = "http://foo.bar/x/page.html";
{
const absl::string_view robotstxt =
"user-agent: FooBot\n"
"disallow: /x/page.html\n"
"allow: /x/\n";
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "FooBot", url));
}
{
const absl::string_view robotstxt =
"user-agent: FooBot\n"
"allow: /x/page.html\n"
"disallow: /x/\n";
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot", url));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/x/"));
}
{
const absl::string_view robotstxt =
"user-agent: FooBot\n"
"disallow: \n"
"allow: \n";
// In case of equivalent disallow and allow patterns for the same
// user-agent, allow is used.
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot", url));
}
{
const absl::string_view robotstxt =
"user-agent: FooBot\n"
"disallow: /\n"
"allow: /\n";
// In case of equivalent disallow and allow patterns for the same
// user-agent, allow is used.
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot", url));
}
{
std::string url_a = "http://foo.bar/x";
std::string url_b = "http://foo.bar/x/";
const absl::string_view robotstxt =
"user-agent: FooBot\n"
"disallow: /x\n"
"allow: /x/\n";
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "FooBot", url_a));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot", url_b));
}
{
const absl::string_view robotstxt =
"user-agent: FooBot\n"
"disallow: /x/page.html\n"
"allow: /x/page.html\n";
// In case of equivalent disallow and allow patterns for the same
// user-agent, allow is used.
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot", url));
}
{
const absl::string_view robotstxt =
"user-agent: FooBot\n"
"allow: /page\n"
"disallow: /*.html\n";
// Longest match wins.
EXPECT_FALSE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/page.html"));
EXPECT_TRUE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/page"));
}
{
const absl::string_view robotstxt =
"user-agent: FooBot\n"
"allow: /x/page.\n"
"disallow: /*.html\n";
// Longest match wins.
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot", url));
EXPECT_FALSE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/x/y.html"));
}
{
const absl::string_view robotstxt =
"User-agent: *\n"
"Disallow: /x/\n"
"User-agent: FooBot\n"
"Disallow: /y/\n";
// Most specific group for FooBot allows implicitly /x/page.
EXPECT_TRUE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/x/page"));
EXPECT_FALSE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/y/page"));
}
}
// Octets in the URI and robots.txt paths outside the range of the US-ASCII
// coded character set, and those in the reserved range defined by RFC3986,
// MUST be percent-encoded as defined by RFC3986 prior to comparison.
// See REP RFC section "The Allow and Disallow lines".
// https://www.rfc-editor.org/rfc/rfc9309.html#section-2.2.2
//
// NOTE: It's up to the caller to percent encode a URL before passing it to the
// parser. Percent encoding URIs in the rules is unnecessary.
TEST(RobotsUnittest, ID_Encoding) {
// /foo/bar?baz=http://foo.bar stays unencoded.
{
const absl::string_view robotstxt =
"User-agent: FooBot\n"
"Disallow: /\n"
"Allow: /foo/bar?qux=taz&baz=http://foo.bar?tar&par\n";
EXPECT_TRUE(IsUserAgentAllowed(
robotstxt, "FooBot",
"http://foo.bar/foo/bar?qux=taz&baz=http://foo.bar?tar&par"));
}
// 3 byte character: /foo/bar/ツ -> /foo/bar/%E3%83%84
{
const absl::string_view robotstxt =
"User-agent: FooBot\n"
"Disallow: /\n"
"Allow: /foo/bar/ツ\n";
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot",
"http://foo.bar/foo/bar/%E3%83%84"));
// The parser encodes the 3-byte character, but the URL is not %-encoded.
EXPECT_FALSE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/foo/bar/ツ"));
}
// Percent encoded 3 byte character: /foo/bar/%E3%83%84 -> /foo/bar/%E3%83%84
{
const absl::string_view robotstxt =
"User-agent: FooBot\n"
"Disallow: /\n"
"Allow: /foo/bar/%E3%83%84\n";
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot",
"http://foo.bar/foo/bar/%E3%83%84"));
EXPECT_FALSE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/foo/bar/ツ"));
}
// Percent encoded unreserved US-ASCII: /foo/bar/%62%61%7A -> NULL
// This is illegal according to RFC3986 and while it may work here due to
// simple string matching, it should not be relied on.
{
const absl::string_view robotstxt =
"User-agent: FooBot\n"
"Disallow: /\n"
"Allow: /foo/bar/%62%61%7A\n";
EXPECT_FALSE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/foo/bar/baz"));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot",
"http://foo.bar/foo/bar/%62%61%7A"));
}
}
// The REP RFC defines the following characters that have special meaning in
// robots.txt:
// # - inline comment.
// $ - end of pattern.
// * - any number of characters.
// See REP RFC section "Special Characters".
// https://www.rfc-editor.org/rfc/rfc9309.html#section-2.2.3
TEST(RobotsUnittest, ID_SpecialCharacters) {
{
const absl::string_view robotstxt =
"User-agent: FooBot\n"
"Disallow: /foo/bar/quz\n"
"Allow: /foo/*/qux\n";
EXPECT_FALSE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/foo/bar/quz"));
EXPECT_TRUE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/foo/quz"));
EXPECT_TRUE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/foo//quz"));
EXPECT_TRUE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/foo/bax/quz"));
}
{
const absl::string_view robotstxt =
"User-agent: FooBot\n"
"Disallow: /foo/bar$\n"
"Allow: /foo/bar/qux\n";
EXPECT_FALSE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/foo/bar"));
EXPECT_TRUE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/foo/bar/qux"));
EXPECT_TRUE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/foo/bar/"));
EXPECT_TRUE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/foo/bar/baz"));
}
{
const absl::string_view robotstxt =
"User-agent: FooBot\n"
"# Disallow: /\n"
"Disallow: /foo/quz#qux\n"
"Allow: /\n";
EXPECT_TRUE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/foo/bar"));
EXPECT_FALSE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/foo/quz"));
}
}
// Google-specific: "index.html" (and only that) at the end of a pattern is
// equivalent to "/".
TEST(RobotsUnittest, GoogleOnly_IndexHTMLisDirectory) {
const absl::string_view robotstxt =
"User-Agent: *\n"
"Allow: /allowed-slash/index.html\n"
"Disallow: /\n";
// If index.html is allowed, we interpret this as / being allowed too.
EXPECT_TRUE(
IsUserAgentAllowed(robotstxt, "foobot", "http://foo.com/allowed-slash/"));
// Does not exatly match.
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "foobot",
"http://foo.com/allowed-slash/index.htm"));
// Exact match.
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "foobot",
"http://foo.com/allowed-slash/index.html"));
EXPECT_FALSE(
IsUserAgentAllowed(robotstxt, "foobot", "http://foo.com/anyother-url"));
}
// Google-specific: long lines are ignored after 8 * 2083 bytes. See comment in
// RobotsTxtParser::Parse().
TEST(RobotsUnittest, GoogleOnly_LineTooLong) {
size_t kEOLLen = std::string("\n").length();
int kMaxLineLen = 2083 * 8;
std::string allow = "allow: ";
std::string disallow = "disallow: ";
// Disallow rule pattern matches the URL after being cut off at kMaxLineLen.
{
std::string robotstxt = "user-agent: FooBot\n";
std::string longline = "/x/";
size_t max_length =
kMaxLineLen - longline.length() - disallow.length() + kEOLLen;
while (longline.size() < max_length) {
absl::StrAppend(&longline, "a");
}
absl::StrAppend(&robotstxt, disallow, longline, "/qux\n");
// Matches nothing, so URL is allowed.
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/fux"));
// Matches cut off disallow rule.
EXPECT_FALSE(IsUserAgentAllowed(
robotstxt, "FooBot", absl::StrCat("http://foo.bar", longline, "/fux")));
}
{
std::string robotstxt =
"user-agent: FooBot\n"
"disallow: /\n";
std::string longline_a = "/x/";
std::string longline_b = "/x/";
size_t max_length =
kMaxLineLen - longline_a.length() - allow.length() + kEOLLen;
while (longline_a.size() < max_length) {
absl::StrAppend(&longline_a, "a");
absl::StrAppend(&longline_b, "b");
}
absl::StrAppend(&robotstxt, allow, longline_a, "/qux\n");
absl::StrAppend(&robotstxt, allow, longline_b, "/qux\n");
// URL matches the disallow rule.
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/"));
// Matches the allow rule exactly.
EXPECT_TRUE(
IsUserAgentAllowed(robotstxt, "FooBot",
absl::StrCat("http://foo.bar", longline_a, "/qux")));
// Matches cut off allow rule.
EXPECT_TRUE(
IsUserAgentAllowed(robotstxt, "FooBot",
absl::StrCat("http://foo.bar", longline_b, "/fux")));
}
}
TEST(RobotsUnittest, GoogleOnly_DocumentationChecks) {
// Test documentation from
// https://developers.google.com/search/reference/robots_txt
// Section "URL matching based on path values".
{
std::string robotstxt =
"user-agent: FooBot\n"
"disallow: /\n"
"allow: /fish\n";
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/bar"));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/fish"));
EXPECT_TRUE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/fish.html"));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot",
"http://foo.bar/fish/salmon.html"));
EXPECT_TRUE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/fishheads"));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot",
"http://foo.bar/fishheads/yummy.html"));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot",
"http://foo.bar/fish.html?id=anything"));
EXPECT_FALSE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/Fish.asp"));
EXPECT_FALSE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/catfish"));
EXPECT_FALSE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/?id=fish"));
}
// "/fish*" equals "/fish"
{
std::string robotstxt =
"user-agent: FooBot\n"
"disallow: /\n"
"allow: /fish*\n";
EXPECT_FALSE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/bar"));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/fish"));
EXPECT_TRUE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/fish.html"));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot",
"http://foo.bar/fish/salmon.html"));
EXPECT_TRUE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/fishheads"));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot",
"http://foo.bar/fishheads/yummy.html"));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot",
"http://foo.bar/fish.html?id=anything"));
EXPECT_FALSE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/Fish.bar"));
EXPECT_FALSE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/catfish"));
EXPECT_FALSE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/?id=fish"));
}
// "/fish/" does not equal "/fish"
{
std::string robotstxt =
"user-agent: FooBot\n"
"disallow: /\n"
"allow: /fish/\n";
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/bar"));
EXPECT_TRUE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/fish/"));
EXPECT_TRUE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/fish/salmon"));
EXPECT_TRUE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/fish/?salmon"));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot",
"http://foo.bar/fish/salmon.html"));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot",
"http://foo.bar/fish/?id=anything"));
EXPECT_FALSE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/fish"));
EXPECT_FALSE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/fish.html"));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "FooBot",
"http://foo.bar/Fish/Salmon.html"));
}
// "/*.php"
{
std::string robotstxt =
"user-agent: FooBot\n"
"disallow: /\n"
"allow: /*.php\n";
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/bar"));
EXPECT_TRUE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/filename.php"));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot",
"http://foo.bar/folder/filename.php"));
EXPECT_TRUE(IsUserAgentAllowed(
robotstxt, "FooBot", "http://foo.bar/folder/filename.php?parameters"));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot",
"http://foo.bar//folder/any.php.file.html"));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot",
"http://foo.bar/filename.php/"));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot",
"http://foo.bar/index?f=filename.php/"));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "FooBot",
"http://foo.bar/php/"));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "FooBot",
"http://foo.bar/index?php"));
EXPECT_FALSE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/windows.PHP"));
}
// "/*.php$"
{
std::string robotstxt =
"user-agent: FooBot\n"
"disallow: /\n"
"allow: /*.php$\n";
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/bar"));
EXPECT_TRUE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/filename.php"));
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot",
"http://foo.bar/folder/filename.php"));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "FooBot",
"http://foo.bar/filename.php?parameters"));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "FooBot",
"http://foo.bar/filename.php/"));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "FooBot",
"http://foo.bar/filename.php5"));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "FooBot",
"http://foo.bar/php/"));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "FooBot",
"http://foo.bar/filename?php"));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "FooBot",
"http://foo.bar/aaaphpaaa"));
EXPECT_FALSE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar//windows.PHP"));
}
// "/fish*.php"
{
std::string robotstxt =
"user-agent: FooBot\n"
"disallow: /\n"
"allow: /fish*.php\n";
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/bar"));
EXPECT_TRUE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/fish.php"));
EXPECT_TRUE(
IsUserAgentAllowed(robotstxt, "FooBot",
"http://foo.bar/fishheads/catfish.php?parameters"));
EXPECT_FALSE(
IsUserAgentAllowed(robotstxt, "FooBot", "http://foo.bar/Fish.PHP"));
}
// Section "Order of precedence for group-member records".
{
std::string robotstxt =
"user-agent: FooBot\n"
"allow: /p\n"
"disallow: /\n";
std::string url = "http://example.com/page";
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot", url));
}
{
std::string robotstxt =
"user-agent: FooBot\n"
"allow: /folder\n"
"disallow: /folder\n";
std::string url = "http://example.com/folder/page";
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot", url));
}
{
std::string robotstxt =
"user-agent: FooBot\n"
"allow: /page\n"
"disallow: /*.htm\n";
std::string url = "http://example.com/page.htm";
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "FooBot", url));
}
{
std::string robotstxt =
"user-agent: FooBot\n"
"allow: /$\n"
"disallow: /\n";
std::string url = "http://example.com/";
std::string url_page = "http://example.com/page.html";
EXPECT_TRUE(IsUserAgentAllowed(robotstxt, "FooBot", url));
EXPECT_FALSE(IsUserAgentAllowed(robotstxt, "FooBot", url_page));
}
}
class RobotsStatsReporter : public googlebot::RobotsParseHandler {
public:
void HandleRobotsStart() override {
last_line_seen_ = 0;
valid_directives_ = 0;
unknown_directives_ = 0;
sitemap_.clear();
}
void HandleRobotsEnd() override {}
void HandleUserAgent(int line_num, absl::string_view value) override {
Digest(line_num);
}
void HandleAllow(int line_num, absl::string_view value) override {
Digest(line_num);
}
void HandleDisallow(int line_num, absl::string_view value) override {
Digest(line_num);
}
void HandleSitemap(int line_num, absl::string_view value) override {
Digest(line_num);
sitemap_.append(value.data(), value.length());
}
// Any other unrecognized name/v pairs.
void HandleUnknownAction(int line_num, absl::string_view action,
absl::string_view value) override {
last_line_seen_ = line_num;
unknown_directives_++;
}
int last_line_seen() const { return last_line_seen_; }
// All directives found, including unknown.
int valid_directives() const { return valid_directives_; }
// Number of unknown directives.
int unknown_directives() const { return unknown_directives_; }
// Parsed sitemap line.
std::string sitemap() const { return sitemap_; }
private:
void Digest(int line_num) {
ASSERT_GE(line_num, last_line_seen_);
last_line_seen_ = line_num;
valid_directives_++;
}
int last_line_seen_ = 0;
int valid_directives_ = 0;
int unknown_directives_ = 0;
std::string sitemap_;
};
// Different kinds of line endings are all supported: %x0D / %x0A / %x0D.0A
TEST(RobotsUnittest, ID_LinesNumbersAreCountedCorrectly) {
RobotsStatsReporter report;
static const char kUnixFile[] =
"User-Agent: foo\n"
"Allow: /some/path\n"
"User-Agent: bar\n"
"\n"
"\n"
"Disallow: /\n";
googlebot::ParseRobotsTxt(kUnixFile, &report);
EXPECT_EQ(4, report.valid_directives());
EXPECT_EQ(6, report.last_line_seen());
static const char kDosFile[] =
"User-Agent: foo\r\n"
"Allow: /some/path\r\n"
"User-Agent: bar\r\n"
"\r\n"
"\r\n"
"Disallow: /\r\n";
googlebot::ParseRobotsTxt(kDosFile, &report);
EXPECT_EQ(4, report.valid_directives());
EXPECT_EQ(6, report.last_line_seen());
static const char kMacFile[] =
"User-Agent: foo\r"
"Allow: /some/path\r"
"User-Agent: bar\r"
"\r"
"\r"
"Disallow: /\r";
googlebot::ParseRobotsTxt(kMacFile, &report);
EXPECT_EQ(4, report.valid_directives());
EXPECT_EQ(6, report.last_line_seen());
static const char kNoFinalNewline[] =
"User-Agent: foo\n"
"Allow: /some/path\n"
"User-Agent: bar\n"
"\n"
"\n"
"Disallow: /";
googlebot::ParseRobotsTxt(kNoFinalNewline, &report);
EXPECT_EQ(4, report.valid_directives());
EXPECT_EQ(6, report.last_line_seen());
static const char kMixedFile[] =
"User-Agent: foo\n"
"Allow: /some/path\r\n"
"User-Agent: bar\n"
"\r\n"
"\n"
"Disallow: /";
googlebot::ParseRobotsTxt(kMixedFile, &report);
EXPECT_EQ(4, report.valid_directives());
EXPECT_EQ(6, report.last_line_seen());
}
// BOM characters are unparseable and thus skipped. The rules following the line
// are used.
TEST(RobotsUnittest, ID_UTF8ByteOrderMarkIsSkipped) {
RobotsStatsReporter report;
static const char kUtf8FileFullBOM[] =
"\xEF\xBB\xBF"
"User-Agent: foo\n"
"Allow: /AnyValue\n";
googlebot::ParseRobotsTxt(kUtf8FileFullBOM, &report);
EXPECT_EQ(2, report.valid_directives());
EXPECT_EQ(0, report.unknown_directives());
// We allow as well partial ByteOrderMarks.
static const char kUtf8FilePartial2BOM[] =
"\xEF\xBB"
"User-Agent: foo\n"
"Allow: /AnyValue\n";
googlebot::ParseRobotsTxt(kUtf8FilePartial2BOM, &report);
EXPECT_EQ(2, report.valid_directives());
EXPECT_EQ(0, report.unknown_directives());
static const char kUtf8FilePartial1BOM[] =
"\xEF"
"User-Agent: foo\n"
"Allow: /AnyValue\n";
googlebot::ParseRobotsTxt(kUtf8FilePartial1BOM, &report);
EXPECT_EQ(2, report.valid_directives());
EXPECT_EQ(0, report.unknown_directives());
// If the BOM is not the right sequence, the first line looks like garbage
// that is skipped (we essentially see "\x11\xBFUser-Agent").
static const char kUtf8FileBrokenBOM[] =
"\xEF\x11\xBF"
"User-Agent: foo\n"
"Allow: /AnyValue\n";
googlebot::ParseRobotsTxt(kUtf8FileBrokenBOM, &report);
EXPECT_EQ(1, report.valid_directives());
EXPECT_EQ(1, report.unknown_directives()); // We get one broken line.
// Some other messed up file: BOMs only valid in the beginning of the file.
static const char kUtf8BOMSomewhereInMiddleOfFile[] =
"User-Agent: foo\n"
"\xEF\xBB\xBF"
"Allow: /AnyValue\n";
googlebot::ParseRobotsTxt(kUtf8BOMSomewhereInMiddleOfFile, &report);
EXPECT_EQ(1, report.valid_directives());
EXPECT_EQ(1, report.unknown_directives());
}
// Google specific: the RFC allows any line that crawlers might need, such as
// sitemaps, which Google supports.
// See REP RFC section "Other records".
// https://www.rfc-editor.org/rfc/rfc9309.html#section-2.2.4
TEST(RobotsUnittest, ID_NonStandardLineExample_Sitemap) {
RobotsStatsReporter report;
{
std::string sitemap_loc = "http://foo.bar/sitemap.xml";
std::string robotstxt =
"User-Agent: foo\n"
"Allow: /some/path\n"
"User-Agent: bar\n"
"\n"
"\n";
absl::StrAppend(&robotstxt, "Sitemap: ", sitemap_loc, "\n");
googlebot::ParseRobotsTxt(robotstxt, &report);
EXPECT_EQ(sitemap_loc, report.sitemap());
}
// A sitemap line may appear anywhere in the file.
{
std::string robotstxt;
std::string sitemap_loc = "http://foo.bar/sitemap.xml";
std::string robotstxt_temp =
"User-Agent: foo\n"
"Allow: /some/path\n"
"User-Agent: bar\n"
"\n"
"\n";
absl::StrAppend(&robotstxt, "Sitemap: ", sitemap_loc, "\n", robotstxt_temp);
googlebot::ParseRobotsTxt(robotstxt, &report);
EXPECT_EQ(sitemap_loc, report.sitemap());
}
}
} // namespace
// Integrity tests. These functions are available to the linker, but not in the
// header, because they should only be used for testing.
namespace googlebot {
std::string GetPathParamsQuery(const std::string& url);
bool MaybeEscapePattern(const char* src, char** dst);
} // namespace googlebot
void TestPath(const std::string& url, const std::string& expected_path) {
EXPECT_EQ(expected_path, googlebot::GetPathParamsQuery(url));
}
void TestEscape(const std::string& url, const std::string& expected) {
char* escaped_value = nullptr;
const bool is_escaped =
googlebot::MaybeEscapePattern(url.c_str(), &escaped_value);
const std::string escaped = escaped_value;
if (is_escaped) delete[] escaped_value;
EXPECT_EQ(expected, escaped);
}
TEST(RobotsUnittest, TestGetPathParamsQuery) {
// Only testing URLs that are already correctly escaped here.
TestPath("", "/");
TestPath("http://www.example.com", "/");
TestPath("http://www.example.com/", "/");
TestPath("http://www.example.com/a", "/a");
TestPath("http://www.example.com/a/", "/a/");
TestPath("http://www.example.com/a/b?c=http://d.e/", "/a/b?c=http://d.e/");
TestPath("http://www.example.com/a/b?c=d&e=f#fragment", "/a/b?c=d&e=f");
TestPath("example.com", "/");
TestPath("example.com/", "/");
TestPath("example.com/a", "/a");
TestPath("example.com/a/", "/a/");