Merge pull request #783 from JonathanBrouwer/parse_note

Parse `note=` for notes on priorities and rollup

Author: Kobzol

src/bors/command/parser.rs

@@ -521,7 +521,7 @@ fn parser_priority(command: &CommandPart<'_>, parts: &[CommandPart<'_>]) -> Pars
         Ok(p) => p,
         Err(e) => return Some(Err(e)),
     };
-    let note = join_parts(parts);
+    let note = parse_note(parts);
     Some(Ok(BorsCommand::SetPriority { priority, note }))
 }
 
@@ -550,7 +550,7 @@ fn parser_rollup(command: &CommandPart<'_>, parts: &[CommandPart<'_>]) -> ParseR
         Ok(r) => r,
         Err(e) => return Some(Err(e)),
     };
-    let note = join_parts(parts);
+    let note = parse_note(parts);
     Some(Ok(BorsCommand::SetRollupMode { rollup_mode, note }))
 }
 
@@ -594,6 +594,13 @@ fn parser_tree_ops(command: &CommandPart<'_>, parts: &[CommandPart<'_>]) -> Pars
     }
 }
 
+fn parse_note(parts: &[CommandPart<'_>]) -> Option<String> {
+    match parts {
+        &[CommandPart::KeyValue { key: "note", value }] => Some(value.to_string()),
+        parts => join_parts(parts),
+    }
+}
+
 /// Join all the command parts into a single string.
 /// If there are no other parts, returns `None`.
 fn join_parts(parts: &[CommandPart<'_>]) -> Option<String> {
@@ -1012,6 +1019,23 @@ mod tests {
         );
     }
 
+    #[test]
+    fn parse_priority_explicit_note() {
+        let cmds = parse_commands("@bors p=1 note=a");
+        insta::assert_debug_snapshot!(cmds, @r#"
+        [
+            Ok(
+                SetPriority {
+                    priority: 1,
+                    note: Some(
+                        "a",
+                    ),
+                },
+            ),
+        ]
+        "#);
+    }
+
     #[test]
     fn parse_priority_unknown_arg() {
         let cmds = parse_commands("@bors p=1 a");
@@ -1244,6 +1268,23 @@ mod tests {
         "#);
     }
 
+    #[test]
+    fn parse_rollup_explicit_note() {
+        let cmds = parse_commands("@bors rollup note=a");
+        insta::assert_debug_snapshot!(cmds, @r#"
+        [
+            Ok(
+                SetRollupMode {
+                    rollup_mode: Always,
+                    note: Some(
+                        "a",
+                    ),
+                },
+            ),
+        ]
+        "#);
+    }
+
     #[test]
     fn parse_rollup_unknown_arg() {
         let cmds = parse_commands("@bors rollup a");

src/bors/handlers/help.rs

@@ -38,9 +38,9 @@ mod tests {
                 - You can pass a comma-separated list of GitHub usernames.
                 - Optionally, you can attach a `<note>` to the PR that will be displayed on the queue page.
             - `r-`: Unapprove this PR
-            - `p=<priority> [note]` | `priority=<priority> [<note>]`: Set the priority of this PR
+            - `p=<priority> [note=[<note>]]` | `priority=<priority> [note=[<note>]]`: Set the priority of this PR
                 - Optionally, you can attach a `<note>` to the PR that will be displayed on the queue page.
-            - `rollup=<never|iffy|maybe|always> [<note>]`: Set the rollup status of the PR
+            - `rollup=<never|iffy|maybe|always> [note=[<note>]]`: Set the rollup status of the PR
                 - Optionally, you can attach a `<note>` to the PR that will be displayed on the queue page.
             - `rollup`: Short for `rollup=always`
             - `rollup-`: Short for `rollup=maybe`

src/bors/mod.rs

@@ -104,9 +104,9 @@ You can use the following commands:
     - You can pass a comma-separated list of GitHub usernames.
     - Optionally, you can attach a `<note>` to the PR that will be displayed on the queue page.
 - `r-`: Unapprove this PR
-- `p=<priority> [note]` | `priority=<priority> [<note>]`: Set the priority of this PR
+- `p=<priority> [note=[<note>]]` | `priority=<priority> [note=[<note>]]`: Set the priority of this PR
     - Optionally, you can attach a `<note>` to the PR that will be displayed on the queue page.
-- `rollup=<never|iffy|maybe|always> [<note>]`: Set the rollup status of the PR
+- `rollup=<never|iffy|maybe|always> [note=[<note>]]`: Set the rollup status of the PR
     - Optionally, you can attach a `<note>` to the PR that will be displayed on the queue page.
 - `rollup`: Short for `rollup=always`
 - `rollup-`: Short for `rollup=maybe`