-
Notifications
You must be signed in to change notification settings - Fork 299
/
Copy pathvalidate.rs
1103 lines (1028 loc) · 37.5 KB
/
validate.rs
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
use crate::api::github::GitHubApi;
use crate::api::zulip::ZulipApi;
use crate::data::Data;
use crate::schema::{
Bot, Email, MergeBot, Permissions, RepoPermission, Team, TeamKind, TeamPeople, ZulipMember,
};
use anyhow::{bail, Error};
use log::{error, warn};
use regex::Regex;
use std::collections::hash_map::{Entry, HashMap};
use std::collections::HashSet;
macro_rules! checks {
($($f:ident,)*) => {
&[$(
Check {
f: $f,
name: stringify!($f)
}
),*]
}
}
#[allow(clippy::type_complexity)]
static CHECKS: &[Check<fn(&Data, &mut Vec<String>)>] = checks![
validate_name_prefixes,
validate_subteam_of,
validate_team_leads,
validate_team_members,
validate_alumni,
validate_archived_teams,
validate_inactive_members,
validate_list_email_addresses,
validate_list_extra_people,
validate_list_extra_teams,
validate_list_addresses,
validate_people_addresses,
validate_duplicate_permissions,
validate_permissions,
validate_rfcbot_labels,
validate_rfcbot_exclude_members,
validate_team_names,
validate_github_teams,
validate_zulip_stream_name,
validate_subteam_of_required,
validate_discord_team_members_have_discord_ids,
validate_unique_zulip_groups,
validate_zulip_group_ids,
validate_zulip_group_extra_people,
validate_unique_zulip_streams,
validate_zulip_stream_ids,
validate_zulip_stream_extra_people,
validate_repos,
validate_archived_repos,
validate_branch_protections,
validate_member_roles,
validate_admin_access,
validate_website,
];
#[allow(clippy::type_complexity)]
static GITHUB_CHECKS: &[Check<fn(&Data, &GitHubApi, &mut Vec<String>)>] =
checks![validate_github_usernames,];
#[allow(clippy::type_complexity)]
static ZULIP_CHECKS: &[Check<fn(&Data, &ZulipApi, &mut Vec<String>)>] =
checks![validate_zulip_users,];
struct Check<F> {
f: F,
name: &'static str,
}
pub(crate) fn validate(data: &Data, strict: bool, skip: &[&str]) -> Result<(), Error> {
let mut errors = Vec::new();
for check in CHECKS {
if skip.contains(&check.name) {
warn!("skipped check: {}", check.name);
continue;
}
(check.f)(data, &mut errors);
}
let github = GitHubApi::new();
if let Err(err) = github.require_auth() {
if strict {
return Err(err);
} else {
warn!("couldn't perform checks relying on the GitHub API, some errors will not be detected");
warn!("cause: {}", err);
}
} else {
for check in GITHUB_CHECKS {
if skip.contains(&check.name) {
warn!("skipped check: {}", check.name);
continue;
}
(check.f)(data, &github, &mut errors);
}
}
let zulip = ZulipApi::new();
if let Err(err) = zulip.require_auth() {
warn!("couldn't perform checks relying on the Zulip API, some errors will not be detected");
warn!("cause: {}", err);
} else {
for check in ZULIP_CHECKS {
if skip.contains(&check.name) {
warn!("skipped check: {}", check.name);
continue;
}
(check.f)(data, &zulip, &mut errors);
}
}
if !errors.is_empty() {
errors.sort();
errors.dedup_by(|a, b| a == b);
for err in &errors {
error!("validation error: {}", err);
}
bail!("{} validation errors found", errors.len());
}
Ok(())
}
/// Ensure working group names start with `wg-`
fn validate_name_prefixes(data: &Data, errors: &mut Vec<String>) {
fn ensure_prefix(
team: &Team,
kind: TeamKind,
prefix: &str,
exceptions: &[&str],
) -> Result<(), Error> {
if exceptions.contains(&team.name()) {
return Ok(());
}
if team.kind() == kind && !team.name().starts_with(prefix) {
bail!(
"{} `{}`'s name doesn't start with `{}`",
kind,
team.name(),
prefix,
);
} else if team.kind() != kind && team.name().starts_with(prefix) {
bail!(
"{} `{}` seems like a {} (since it has the `{}` prefix)",
team.kind(),
team.name(),
kind,
prefix,
);
}
Ok(())
}
wrapper(data.teams(), errors, |team, _| {
ensure_prefix(team, TeamKind::WorkingGroup, "wg-", &["wg-leads"])?;
ensure_prefix(
team,
TeamKind::ProjectGroup,
"project-",
&["project-group-leads"],
)?;
Ok(())
});
}
/// Ensure `subteam-of` points to an existing team
fn validate_subteam_of(data: &Data, errors: &mut Vec<String>) {
wrapper(data.teams(), errors, |mut team, _| {
let mut visited = Vec::new();
while let Some(parent) = team.subteam_of() {
visited.push(team.name());
if visited.contains(&parent) {
bail!(
"team `{parent}` is a subteam of itself: {} => {parent}",
visited.join(" => "),
);
}
let Some(parent) = data.team(parent) else {
bail!(
"the parent of team `{}` doesn't exist: `{}`",
team.name(),
parent,
);
};
team = parent;
}
Ok(())
});
}
/// Ensure team leaders are part of the teams they lead
fn validate_team_leads(data: &Data, errors: &mut Vec<String>) {
wrapper(data.teams(), errors, |team, errors| {
let members = team.members(data)?;
wrapper(team.leads().iter(), errors, |lead, _| {
if !members.contains(lead) {
bail!(
"`{}` leads team `{}`, but is not a member of it",
lead,
team.name()
);
}
Ok(())
});
Ok(())
});
}
/// Ensure team members are people
fn validate_team_members(data: &Data, errors: &mut Vec<String>) {
wrapper(data.teams(), errors, |team, errors| {
wrapper(team.members(data)?.iter(), errors, |member, _| {
if data.person(member).is_none() {
bail!(
"person `{}` is member of team `{}` but doesn't exist",
member,
team.name()
);
}
Ok(())
});
Ok(())
});
}
/// Alumni team must consist only of automatically populated alumni from the other teams
fn validate_alumni(data: &Data, errors: &mut Vec<String>) {
let Some(alumni_team) = data.team("alumni") else {
errors.push("cannot find an 'alumni' team".to_owned());
return;
};
if !alumni_team.explicit_members().is_empty() {
errors.push("'alumni' team must not have explicit members; move them to the appropriate team's alumni entry".to_owned());
}
// Teams must contain an `alumni = […]` field (even if empty) so that there
// is an obvious place to move contributors within the same file when
// removing from `members`.
//
// Marker teams are exempt from this, as well as teams which comprise only
// members of other teams via `include-team-leads` or similar; they do not
// need `alumni = […]`. For these teams, the correct place to put alumni is
// in the same team they're being included from.
wrapper(data.teams(), errors, |team, _| {
// Exhaustive destructuring to ensure this code is touched if a new
// "include" settings is introduced.
let TeamPeople {
leads: _,
members,
alumni,
included_teams,
include_team_leads,
include_wg_leads,
include_project_group_leads,
include_all_team_members,
include_all_alumni,
} = team.raw_people();
if alumni.is_none() {
let exempt_team_kind = match team.kind() {
TeamKind::MarkerTeam => true,
TeamKind::Team | TeamKind::WorkingGroup | TeamKind::ProjectGroup => false,
};
let exempt_composition = members.is_empty() // intentionally not team.members(data).is_empty()
&& (*include_team_leads
|| *include_wg_leads
|| *include_project_group_leads
|| *include_all_team_members
|| *include_all_alumni
|| !included_teams.is_empty());
let exempt = exempt_team_kind || exempt_composition;
if !exempt {
let team_name = team.name();
bail!("team '{team_name}' needs an `alumni = []` entry");
}
}
Ok(())
});
}
fn validate_archived_teams(data: &Data, errors: &mut Vec<String>) {
wrapper(data.archived_teams(), errors, |team, _| {
if !team.members(data)?.is_empty() {
bail!("archived team '{}' must not have current members; please move members to that team's alumni", team.name());
}
Ok(())
})
}
/// Ensure every person is part of at least one team (active or archived)
fn validate_inactive_members(data: &Data, errors: &mut Vec<String>) {
let mut referenced_members = HashSet::new();
wrapper(
data.teams().chain(data.archived_teams()),
errors,
|team, _| {
let members = team.members(data)?;
for member in members {
referenced_members.insert(member);
}
for person in team.explicit_alumni() {
referenced_members.insert(person.github.as_str());
}
for list in team.raw_lists() {
for person in &list.extra_people {
referenced_members.insert(person);
}
}
Ok(())
},
);
let all_members = data.people().map(|p| p.github()).collect::<HashSet<_>>();
// All the individual contributors to any Rust controlled repos
let all_ics = data
.all_repos()
.flat_map(|r| r.access.individuals.keys())
.map(|n| n.as_str())
.collect::<HashSet<_>>();
let zulip_groups = match data.zulip_groups() {
Ok(z) => z,
Err(e) => {
errors.push(format!("could not get all the Zulip groups: {e}"));
return;
}
};
// All people in that are included in a Zulip group which can contain people not in all_members
let all_extra_zulip_people = zulip_groups
.values()
.flat_map(|z| z.members())
.filter_map(|m| match m {
ZulipMember::MemberWithId { github, .. } | ZulipMember::MemberWithoutId { github } => {
Some(github.as_str())
}
ZulipMember::JustId(_) => None,
})
.collect::<HashSet<_>>();
wrapper(
all_members.difference(&referenced_members),
errors,
|person, _| {
if !data.person(person).unwrap().permissions().has_any()
&& !all_ics.contains(person)
&& !all_extra_zulip_people.contains(person)
{
bail!(
"person `{person}` is not a member of any team (active or archived), \
has no permissions, is not an individual contributor to any repo, and \
is not included as a extra person in a Zulip group",
);
}
Ok(())
},
);
}
/// Ensure every member of a team with a mailing list has an email address
fn validate_list_email_addresses(data: &Data, errors: &mut Vec<String>) {
wrapper(data.teams(), errors, |team, errors| {
let lists = team.lists(data)?;
if lists.is_empty() {
return Ok(());
}
wrapper(team.members(data)?.iter(), errors, |member, _| {
if let Some(member) = data.person(member) {
if let Email::Missing = member.email() {
bail!(
"person `{}` is a member of at least one mailing list ({}) but has no email address",
member.github(),
lists.iter().map(|l| l.address()).collect::<Vec<_>>().join(", "),
);
}
}
Ok(())
});
Ok(())
});
}
/// Ensure members of extra-people in a list are real people
fn validate_list_extra_people(data: &Data, errors: &mut Vec<String>) {
wrapper(data.teams(), errors, |team, errors| {
wrapper(team.raw_lists().iter(), errors, |list, _| {
for person in &list.extra_people {
if data.person(person).is_none() {
bail!(
"person `{}` does not exist (in list `{}`)",
person,
list.address
);
}
}
Ok(())
});
Ok(())
});
}
/// Ensure members of extra-people in a list are real people
fn validate_list_extra_teams(data: &Data, errors: &mut Vec<String>) {
wrapper(data.teams(), errors, |team, errors| {
wrapper(team.raw_lists().iter(), errors, |list, _| {
for list_team in &list.extra_teams {
if data.team(list_team).is_none() {
bail!(
"team `{}` does not exist (in list `{}`)",
list_team,
list.address
);
}
}
Ok(())
});
Ok(())
});
}
/// Ensure the list addresses are correct
fn validate_list_addresses(data: &Data, errors: &mut Vec<String>) {
let email_re = Regex::new(r"^[a-zA-Z0-9_\.-]+@([a-zA-Z0-9_\.-]+)$").unwrap();
let config = data.config().allowed_mailing_lists_domains();
wrapper(data.teams(), errors, |team, errors| {
wrapper(team.raw_lists().iter(), errors, |list, _| {
if let Some(captures) = email_re.captures(&list.address) {
if !config.contains(&captures[1]) {
bail!("list address on a domain we don't own: `{}`", list.address);
}
} else {
bail!("invalid list address: `{}`", list.address);
}
Ok(())
});
Ok(())
});
}
/// Ensure people email addresses are correct
fn validate_people_addresses(data: &Data, errors: &mut Vec<String>) {
wrapper(data.people(), errors, |person, _| {
if let Email::Present(email) = person.email() {
if !email.contains('@') {
bail!("invalid email address of `{}`: {}", person.github(), email);
}
}
Ok(())
});
}
/// Ensure members of teams with permissions don't explicitly have those permissions
fn validate_duplicate_permissions(data: &Data, errors: &mut Vec<String>) {
wrapper(data.teams(), errors, |team, errors| {
wrapper(team.members(data)?.iter(), errors, |member, _| {
if let Some(person) = data.person(member) {
for permission in &Permissions::available(data.config()) {
if team.permissions().has(permission)
&& person.permissions().has_directly(permission)
{
bail!(
"user `{}` has the permission `{}` both explicitly and through \
the `{}` team",
member,
permission,
team.name()
);
}
}
}
Ok(())
});
Ok(())
});
}
/// Ensure the permissions are valid
fn validate_permissions(data: &Data, errors: &mut Vec<String>) {
wrapper(data.teams(), errors, |team, _| {
team.permissions()
.validate(format!("team `{}`", team.name()), data.config())?;
team.leads_permissions()
.validate(format!("team `{}`", team.name()), data.config())?;
Ok(())
});
wrapper(data.people(), errors, |person, _| {
person
.permissions()
.validate(format!("user `{}`", person.github()), data.config())?;
Ok(())
});
}
/// Ensure there are no duplicate rfcbot labels
fn validate_rfcbot_labels(data: &Data, errors: &mut Vec<String>) {
let mut labels = HashSet::new();
wrapper(data.teams(), errors, move |team, errors| {
if let Some(rfcbot) = team.rfcbot_data() {
if !labels.insert(rfcbot.label.clone()) {
errors.push(format!("duplicate rfcbot label: {}", rfcbot.label));
}
}
Ok(())
});
}
/// Ensure rfcbot's exclude-members only contains not duplicated team members
fn validate_rfcbot_exclude_members(data: &Data, errors: &mut Vec<String>) {
wrapper(data.teams(), errors, move |team, errors| {
if let Some(rfcbot) = team.rfcbot_data() {
let mut exclude = HashSet::new();
let members = team.members(data)?;
wrapper(rfcbot.exclude_members.iter(), errors, move |member, _| {
if !exclude.insert(member) {
bail!(
"duplicate member in `{}` rfcbot.exclude-members: {}",
team.name(),
member
);
}
if !members.contains(member.as_str()) {
bail!(
"person `{}` is not a member of team `{}` (in rfcbot.exclude-members)",
member,
team.name()
);
}
Ok(())
});
}
Ok(())
});
}
/// Ensure team names are alphanumeric + `-`
fn validate_team_names(data: &Data, errors: &mut Vec<String>) {
wrapper(data.teams(), errors, |team, _| {
if !ascii_kebab_case(team.name()) {
bail!(
"team name `{}` can only be alphanumeric with hyphens",
team.name()
);
}
Ok(())
});
}
/// Ensure GitHub teams are unique and in the allowed orgs
fn validate_github_teams(data: &Data, errors: &mut Vec<String>) {
let mut found = HashMap::new();
let allowed = data.config().allowed_github_orgs();
wrapper(data.teams(), errors, |team, errors| {
wrapper(
team.github_teams(data)?.into_iter(),
errors,
|gh_team, _| {
if !allowed.contains(gh_team.org) {
bail!(
"GitHub organization `{}` isn't allowed (in team `{}`)",
gh_team.org,
team.name()
);
}
if let Some(other) = found.insert((gh_team.org, gh_team.name), team.name()) {
bail!(
"GitHub team `{}/{}` is defined for both the `{}` and `{}` teams",
gh_team.org,
gh_team.name,
team.name(),
other
);
}
Ok(())
},
);
Ok(())
});
}
/// Ensure there are no misspelled GitHub account names
fn validate_github_usernames(data: &Data, github: &GitHubApi, errors: &mut Vec<String>) {
let people = data
.people()
.map(|p| (p.github_id(), p))
.collect::<HashMap<_, _>>();
match github.usernames(&people.keys().cloned().collect::<Vec<_>>()) {
Ok(res) => wrapper(res.iter(), errors, |(id, name), _| {
let original = people[id].github();
if original != name {
bail!("GitHub user `{}` changed username to `{}`", original, name);
}
Ok(())
}),
Err(err) => errors.push(format!("couldn't verify GitHub usernames: {}", err)),
}
}
/// Ensure the user doens't put an URL as the Zulip stream name.
fn validate_zulip_stream_name(data: &Data, errors: &mut Vec<String>) {
wrapper(data.teams(), errors, |team, _| {
if let Some(stream) = team.website_data().and_then(|ws| ws.zulip_stream()) {
if stream.starts_with("https://") {
bail!(
"the zulip stream name of the team `{}` is a link: only the name is required",
team.name()
);
}
}
Ok(())
})
}
/// Ensure teams have a parent team.
fn validate_subteam_of_required(data: &Data, errors: &mut Vec<String>) {
wrapper(data.teams(), errors, |team, _| {
let top_level = team.top_level().unwrap_or(false);
if top_level && team.subteam_of().is_some() {
bail!(
"team `{}` specifies both top-level=true and subteam-of, \
it should only specify one or the other",
team.name()
);
}
if top_level && team.kind() != TeamKind::Team {
bail!(
"team `{}` is top-level, but is a `{}` team kind, \
it must be a normal team (don't specify \"kind\")",
team.name(),
team.kind()
);
}
if team.kind() != TeamKind::MarkerTeam
&& team.subteam_of().is_none()
&& !matches!(team.name(), "leadership-council" | "core")
&& !top_level
{
bail!(
"team `{}` must specify `subteam-of` or top-level=true",
team.name()
);
}
Ok(())
})
}
fn validate_discord_team_members_have_discord_ids(data: &Data, errors: &mut Vec<String>) {
wrapper(data.teams(), errors, |team, _| {
if team.discord_roles().is_some() && team.name() != "all" {
let team_members = team.members(data)?;
if team_members.len() != team.discord_ids(data)?.len() {
let missing_discord_id = team_members
.into_iter()
.filter(|name| data.person(name).map(|p| p.discord_id()) == Some(None))
.collect::<Vec<_>>();
bail!(
"the following members of the \"{}\" team do not have discord_ids: {}",
team.name(),
missing_discord_id.join(", "),
);
}
}
Ok(())
});
}
/// Ensure every member of a team that has a Zulip group has a Zulip id
fn validate_zulip_users(data: &Data, zulip: &ZulipApi, errors: &mut Vec<String>) {
let by_id = match zulip.get_users() {
Ok(u) => u.iter().map(|u| u.user_id).collect::<HashSet<_>>(),
Err(err) => {
errors.push(format!("couldn't verify Zulip users: {}", err));
return;
}
};
let zulip_groups = match data.zulip_groups() {
Ok(zgs) => zgs,
Err(err) => {
errors.push(format!("couldn't get all the Zulip groups: {}", err));
return;
}
};
wrapper(zulip_groups.iter(), errors, |(group_name, group), _| {
let missing_members = group
.members()
.iter()
.filter_map(|m| match m {
ZulipMember::MemberWithId { github, zulip_id } if !by_id.contains(zulip_id) => {
Some(github.clone())
}
ZulipMember::JustId(zulip_id) if !by_id.contains(zulip_id) => {
Some(format!("ID: {zulip_id}"))
}
ZulipMember::MemberWithoutId { github } => Some(github.clone()),
_ => None,
})
.collect::<HashSet<_>>();
if !missing_members.is_empty() {
bail!(
"the \"{}\" Zulip group includes members who don't appear on Zulip: {}",
group_name,
missing_members.into_iter().collect::<Vec<_>>().join(", ")
);
}
Ok(())
})
}
/// Ensure team members in Zulip groups have a Zulip id
fn validate_zulip_group_ids(data: &Data, errors: &mut Vec<String>) {
wrapper(data.teams(), errors, |team, errors| {
let groups = team.zulip_groups(data)?;
// Returns if group is empty or all the groups don't include the team members
if groups.is_empty() || groups.iter().all(|g| !g.includes_team_members()) {
return Ok(());
}
wrapper(team.members(data)?.iter(), errors, |member, _| {
if let Some(member) = data.person(member) {
if member.zulip_id().is_none() {
bail!(
"person `{}` in '{}' is a member of a Zulip user group but has no Zulip id",
member.github(),
team.name()
);
}
}
Ok(())
});
Ok(())
});
}
/// Ensure team members in Zulip streams have a Zulip id
fn validate_zulip_stream_ids(data: &Data, errors: &mut Vec<String>) {
wrapper(data.teams(), errors, |team, errors| {
let streams = team.zulip_streams(data)?;
// Returns if stream is empty or all the streams don't include the team members
if streams.is_empty() || streams.iter().all(|s| !s.includes_team_members()) {
return Ok(());
}
wrapper(team.members(data)?.iter(), errors, |member, _| {
if let Some(member) = data.person(member) {
if member.zulip_id().is_none() {
bail!(
"person `{}` in '{}' is a member of a Zulip stream but has no Zulip id",
member.github(),
team.name()
);
}
}
Ok(())
});
Ok(())
});
}
/// Ensure there is at most one definition for any given Zulip group
fn validate_unique_zulip_groups(data: &Data, errors: &mut Vec<String>) {
let mut groups = HashMap::new();
wrapper(data.teams(), errors, |team, errors| {
wrapper(
team.zulip_groups(data).iter().flatten(),
errors,
|group, _| {
if let Some(other_team) = groups.insert(group.name().to_owned(), team.name()) {
bail!(
"the Zulip group `{}` is defined in both `{}` and `{}` team definitions",
group.name(),
team.name(),
other_team
);
}
Ok(())
},
);
Ok(())
});
}
/// Ensure there is at most one definition for any given Zulip group
fn validate_unique_zulip_streams(data: &Data, errors: &mut Vec<String>) {
let mut streams = HashMap::new();
wrapper(data.teams(), errors, |team, errors| {
wrapper(
team.zulip_streams(data).iter().flatten(),
errors,
|stream, _| {
if let Some(other_team) = streams.insert(stream.name().to_owned(), team.name()) {
bail!(
"the Zulip stream `{}` is defined in both `{}` and `{}` team definitions",
stream.name(),
team.name(),
other_team
);
}
Ok(())
},
);
Ok(())
});
}
/// Ensure members of extra-people in a Zulip user group are real people
fn validate_zulip_group_extra_people(data: &Data, errors: &mut Vec<String>) {
wrapper(data.teams(), errors, |team, errors| {
wrapper(team.raw_zulip_groups().iter(), errors, |group, _| {
for person in &group.common.extra_people {
if data.person(person).is_none() {
bail!(
"person `{}` does not exist (in Zulip group `{}`)",
person,
group.common.name
);
}
}
Ok(())
});
Ok(())
});
}
/// Ensure members of extra-people in a Zulip user group are real people
fn validate_zulip_stream_extra_people(data: &Data, errors: &mut Vec<String>) {
wrapper(data.teams(), errors, |team, errors| {
wrapper(team.raw_zulip_streams().iter(), errors, |stream, _| {
for person in &stream.common.extra_people {
if data.person(person).is_none() {
bail!(
"person `{}` does not exist (in Zulip stream `{}`)",
person,
stream.common.name
);
}
}
Ok(())
});
Ok(())
});
}
/// Ensure repos reference valid teams and that they are unique
fn validate_repos(data: &Data, errors: &mut Vec<String>) {
let allowed_orgs = data.config().allowed_github_orgs();
let github_teams = data.github_teams();
let mut repo_map = HashSet::new();
wrapper(data.all_repos(), errors, |repo, _| {
if !repo_map.insert(format!("{}/{}", repo.org, repo.name)) {
bail!("The repo {}/{} is duplicated", repo.org, repo.name);
}
if !allowed_orgs.contains(&repo.org) {
bail!(
"The repo '{}' is in an invalid org '{}'",
repo.name,
repo.org
);
}
for team_name in repo.access.teams.keys() {
if !github_teams.contains(&(repo.org.clone(), team_name.clone())) {
bail!(
"access for {}/{} is invalid: '{}' is not configured as a GitHub team for the '{}' org",
repo.org,
repo.name,
team_name,
repo.org
)
}
}
for name in repo.access.individuals.keys() {
if data.person(name).is_none() {
bail!(
"access for {}/{} is invalid: '{}' is not the name of a person in the team repo",
repo.org,
repo.name,
name
);
}
}
Ok(())
});
}
fn validate_archived_repos(data: &Data, errors: &mut Vec<String>) {
wrapper(data.archived_repos(), errors, |repo, _| {
if !repo.access.teams.is_empty() {
bail!("archived repo '{}' should not have any teams", repo.name);
}
Ok(())
});
}
/// Validate that branch protections make sense in combination with used bots.
fn validate_branch_protections(data: &Data, errors: &mut Vec<String>) {
let github_teams = data.github_teams();
wrapper(data.repos(), errors, |repo, _| {
let homu_configured = repo.bots.iter().any(|b| matches!(b, Bot::Bors));
for protection in &repo.branch_protections {
for team in &protection.allowed_merge_teams {
let key = (repo.org.clone(), team.clone());
if !github_teams.contains(&key) {
bail!(
r#"repo '{}' uses a branch protection for {} that mentions the '{}' github team;
but that team does not seem to exist"#,
repo.name,
protection.pattern,
team
);
}
if !repo.access.teams.contains_key(team) {
bail!(
r#"repo '{}' uses a branch protection for {} that has an allowed merge team '{}',
but that team is not mentioned in [access.teams]"#,
repo.name,
protection.pattern,
team
);
}
}
if !protection.pr_required {
// It does not make sense to use CI checks when a PR is not required, because with a
// CI check, it would not be possible to push into the branch without a PR anyway.
if !protection.ci_checks.is_empty() {
bail!(
r#"repo '{}' uses a branch protection for {} that does not require a PR, but has non-empty `ci-checks`"#,
repo.name,
protection.pattern,
);
}
if protection.required_approvals.is_some() {
bail!(
r#"repo '{}' uses a branch protection for {} that does not require a PR, but sets the `required-approvals` attribute"#,
repo.name,
protection.pattern,
);
}
}
let managed_by_homu = protection.merge_bots.contains(&MergeBot::Homu);
if managed_by_homu {
if !homu_configured {
bail!(
r#"repo '{}' uses homu to manage a branch protection for '{}', but homu is not enabled. Add "bors" to the `bots` array"#,
repo.name,
protection.pattern,
);
}
if protection.required_approvals.is_some()
|| protection.dismiss_stale_review
|| !protection.pr_required
|| !protection.allowed_merge_teams.is_empty()
{
bail!(
r#"repo '{}' uses the homu merge bot, but its branch protection for {} uses invalid
attributes (`required-approvals`, `dismiss-stale-review`, `pr-required` or `allowed-merge-teams`).
Please remove the attributes when using bors"#,
repo.name,
protection.pattern,
);
}
}
}
Ok(())
})
}
/// Enforce that roles are only assigned to a valid team member, and that the
/// same role id always has a consistent description across teams (because the
/// role id becomes the Fluent id used for translation).
fn validate_member_roles(data: &Data, errors: &mut Vec<String>) {
let mut role_descriptions = HashMap::new();
wrapper(
data.teams().chain(data.archived_teams()),
errors,
|team, errors| {
let team_name = team.name();
let mut role_ids = HashSet::new();
for role in team.roles() {
let role_id = &role.id;
if !ascii_kebab_case(role_id) {
errors.push(format!(
"role id {role_id:?} must be alphanumeric with hyphens",
));
}