Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions bots/rhodibot/src/canon/report.rs
Original file line number Diff line number Diff line change
Expand Up @@ -943,7 +943,7 @@ mod tests {

#[test]
fn the_deed_profile_declares_capabilities() {
let deed = "(repo-deed (rsr-profile :capabilities (governance-tier)))";
let deed = "(repo-deed (rsr-profile :capabilities (\"governance-tier\")))";
let report = report_for(&["widgets_chora.deed"], Some(deed), None);
assert_eq!(
report.declared_capabilities,
Expand All @@ -953,7 +953,7 @@ mod tests {

#[test]
fn a_misspelt_deed_capability_is_refused() {
let deed = "(repo-deed (rsr-profile :capabilities (governence-tier)))";
let deed = "(repo-deed (rsr-profile :capabilities (\"governence-tier\")))";
assert!(
CanonReport::build_with(
"acme/widgets",
Expand Down
100 changes: 81 additions & 19 deletions bots/rhodibot/src/deed.rs
Original file line number Diff line number Diff line change
Expand Up @@ -129,26 +129,14 @@ impl Deed {
let Some(clause) = self.clause("rsr-profile") else {
return Ok(None);
};
const KEYS: &[&str] = &[
":preset",
":capabilities",
":add",
":remove",
":role",
":spec",
":declares-against",
":policy",
":omitted-rationale",
":schema-version",
":version",
];
let keys = RSR_PROFILE_KEYS;
let members = clause.members();
for node in members {
if let Node::Atom(atom) = node
&& atom.starts_with(':')
{
ensure!(
KEYS.contains(&atom.as_str()),
keys.contains(&atom.as_str()),
"unknown key {atom} in (rsr-profile ...); a misspelt key would declare no \
capabilities and silently switch off every gated check"
);
Expand All @@ -159,10 +147,12 @@ impl Deed {
None => Ok(Vec::new()),
Some(Node::List(items)) => items
.iter()
.map(|item| {
item.text().map(str::to_string).ok_or_else(|| {
anyhow::anyhow!("(rsr-profile {key} ...) holds a nested list")
})
.map(|item| match item {
Node::Str(text) => Ok(text.clone()),
_ => bail!(
"(rsr-profile {key} ...) holds a non-string; capabilities, :add \
and :remove are lists of strings and symbols are refused"
),
})
.collect(),
Some(_) => bail!("(rsr-profile {key} ...) must be a list"),
Expand Down Expand Up @@ -195,6 +185,21 @@ impl Deed {
}
}

/// The top-level keys of `(rsr-profile ...)`, as the standards module defines
/// them (`bun 1-formats/deed/tools/deed_lint.js --rsr-profile-keys`, standards
/// #1605). `(notes ...)` is the one nested clause; it is not a key, and it holds
/// prose, so it is not scanned here. Any other key fails closed.
pub const RSR_PROFILE_KEYS: &[&str] = &[
":version",
":spec",
":declares-against",
":role",
":preset",
":capabilities",
":add",
":remove",
];

/// The `(rsr-profile ...)` clause, before it is checked against the gate table.
#[derive(Debug, Clone, PartialEq, Eq, Default)]
pub struct ProfileClause {
Expand Down Expand Up @@ -366,7 +371,7 @@ mod tests {
:repo-uuid #u8"gv-clade-index:github.com/o/r" ; trailing comment
(meta :version "0.1.0")
(anchor :id "x")
(rsr-profile :preset library :add (rust) :remove ())
(rsr-profile :preset library :add ("rust") :remove ())
(bot-directives
(bot :name panicbot :allow (assail))
(bot :name rhodibot (config :community-doc-format md))))
Expand Down Expand Up @@ -468,3 +473,60 @@ mod profile_shape_tests {
assert!(empty.rsr_profile().is_err());
}
}

#[cfg(test)]
mod module_alignment_tests {
use super::*;

/// The set standards' module reports (`deed_lint.js --rsr-profile-keys`).
#[test]
fn the_key_set_is_the_modules() {
assert_eq!(
RSR_PROFILE_KEYS,
[
":version",
":spec",
":declares-against",
":role",
":preset",
":capabilities",
":add",
":remove"
]
);
}

#[test]
fn keys_that_belong_to_other_clauses_are_refused() {
// :policy belongs to (anchor ...) and (egress ...); :omitted-rationale
// belongs inside (notes ...).
for key in [":policy", ":omitted-rationale", ":schema-version"] {
let deed = Deed::parse(&format!(
"(repo-deed (rsr-profile :capabilities (\"rust\") {key} \"x\"))"
))
.unwrap();
assert!(deed.rsr_profile().is_err(), "{key}");
}
}

#[test]
fn omitted_rationale_inside_notes_is_fine() {
let deed = Deed::parse(
"(repo-deed (rsr-profile :capabilities (\"rust\") (notes :omitted-rationale \"why\")))",
)
.unwrap();
assert!(deed.rsr_profile().unwrap().is_some());
}

#[test]
fn symbols_in_the_capability_lists_are_refused() {
for text in [
"(repo-deed (rsr-profile :capabilities (rust)))",
"(repo-deed (rsr-profile :preset \"p\" :add (rust)))",
"(repo-deed (rsr-profile :preset \"p\" :remove (rust)))",
] {
let deed = Deed::parse(text).unwrap();
assert!(deed.rsr_profile().is_err(), "{text}");
}
}
}
Loading