wip

Author: ckrenslehner

stm32cubeprogrammer-cli/src/main.rs

@@ -1,3 +1,37 @@
+// TODO: Add doctest for commands from readme
+// const CLI_COMMAND: &str = "unprotect ble-update --file stack.bin --address 0x123 flash-bin --file app.bin --address 0x456 protect reset";
+
+// // Include the command in the docstring dynamically
+// #[doc = concat!(
+//     "Example usage of the CLI.\n\n",
+//     "```sh\n",
+//     "my_cli_tool ", CLI_COMMAND, "\n",
+//     "```\n\n",
+//     "(The following test is hidden from the documentation.)"
+// )]
+// ///
+// /// ```
+// /// # use my_crate::{options, TargetCommand, BleStackInfo, BinFileInfo, HexAddress, ResetMode};
+// /// # use std::path::PathBuf;
+// /// # std::env::set_var("STM32_CUBE_PROGRAMMER_DIR", "some/dir");
+// ///
+// /// // Use the same command string in the test
+// /// let command = CLI_COMMAND;
+// ///
+// /// // Run the CLI parsing logic
+// /// let value = options()
+// ///     .run_inner(command.split(' ').collect::<Vec<_>>().as_slice())
+// ///     .unwrap();
+// /// ```
+// #[derive(Default)]
+// /// Track the connection state of the programmer
+// enum ConnectionState<'a> {
+//     #[default]
+//     Disconnected,
+//     Connected(Option<stm32cubeprogrammer::ConnectedProgrammer<'a>>),
+//     ConnectedFus(Option<stm32cubeprogrammer::ConnectedFusProgrammer<'a>>),
+// }
+
 //! This CLI aims to provide a simple interface for setting up stm32 targets.
 //! # Supported commands
 //! - Flashing bin and hex files
@@ -57,14 +91,8 @@ use log::{error, info};
 use std::sync::Mutex;
 use stm32cubeprogrammer::probe;
 
-#[derive(Default)]
-/// Track the connection state of the programmer
-enum ConnectionState<'a> {
-    #[default]
-    Disconnected,
-    Connected(Option<stm32cubeprogrammer::ConnectedProgrammer<'a>>),
-    ConnectedFus(Option<stm32cubeprogrammer::ConnectedFusProgrammer<'a>>),
-}
+
+
 
 /// Helper struct to manage the programmer connection
 struct ProgrammerConnection<'a> {
@@ -264,7 +292,7 @@ fn main_inner() -> Result<crate::output::Output, anyhow::Error> {
     if options
         .target_commands
         .iter()
-        .any(|command| matches!(command, parse::TargetCommand::UpdateBleStack(_)))
+        .any(|command| matches!(command, parse::TargetCommand::BleUpdate(_)))
         && !programmer_connection
             .connection()?
             .general_information()
@@ -310,7 +338,7 @@ fn main_inner() -> Result<crate::output::Output, anyhow::Error> {
 
                 output::CommandOutput::FlashHex { file }
             }
-            parse::TargetCommand::UpdateBleStack(ble_stack_info) => {
+            parse::TargetCommand::BleUpdate(ble_stack_info) => {
                 log::info!("Update BLE stack: {}", ble_stack_info);
 
                 display_handler
@@ -363,7 +391,7 @@ fn main_inner() -> Result<crate::output::Output, anyhow::Error> {
                         .unwrap_or(output::BleStackUpdated::NotUpdated),
                 }
             }
-            parse::TargetCommand::BleStackInfo { compare } => {
+            parse::TargetCommand::BleInfo { compare } => {
                 display_handler
                     .lock()
                     .unwrap()

stm32cubeprogrammer-cli/src/parse.rs

@@ -2,7 +2,7 @@ use bpaf::*;
 use stm32cubeprogrammer::utility::HexAddress;
 
 #[derive(Debug, Clone, Bpaf)]
-#[bpaf(options)]
+#[bpaf(options, version)]
 /// Overall arguments for CLI
 /// Note: Be careful with duplicate short or long flag names in the subcommands and the parent struct
 pub struct Options {
@@ -58,11 +58,11 @@ pub enum TargetCommand {
 
     #[bpaf(command, adjacent)]
     /// Update the BLE stack on the target
-    UpdateBleStack(#[bpaf(external(ble_stack_info))] BleStackInfo),
+    BleUpdate(#[bpaf(external(ble_stack_info))] BleStackInfo),
 
     /// Read BLE stack information
     #[bpaf(command, adjacent)]
-    BleStackInfo {
+    BleInfo {
         #[bpaf(long, fallback(None))]
         /// The flash address in format 0x123 or 0X123 where file should be written
         compare: Option<stm32cubeprogrammer::fus::Version>,
@@ -261,7 +261,41 @@ mod test {
             value.target_commands,
             vec![
                 TargetCommand::Unprotect,
-                TargetCommand::UpdateBleStack(BleStackInfo {
+                TargetCommand::BleUpdate(BleStackInfo {
+                    file: std::path::PathBuf::from("stack.bin"),
+                    address: HexAddress(0x123),
+                    version: None,
+                    force: false,
+                }),
+                TargetCommand::FlashBin(BinFileInfo {
+                    file: std::path::PathBuf::from("app.bin"),
+                    address: HexAddress(0x456),
+                }),
+                TargetCommand::Protect,
+                TargetCommand::Reset(ResetMode::Hardware),
+            ]
+        )
+    }
+
+    #[test]
+    fn parse_multi_two() {
+
+        std::env::set_var("STM32_CUBE_PROGRAMMER_DIR", "some/dir");
+
+        let command = 
+            "unprotect ble-update --file stack.bin --address 0x123 flash-bin --file app.bin --address 0x456 protect reset";
+
+        let value = options()
+            .run_inner(command.split(' ').collect::<Vec<_>>().as_slice())
+            .unwrap();
+
+        println!("{:?}", value);
+
+        assert_eq!(
+            value.target_commands,
+            vec![ 
+                TargetCommand::Unprotect,
+                TargetCommand::BleUpdate(BleStackInfo {
                     file: std::path::PathBuf::from("stack.bin"),
                     address: HexAddress(0x123),
                     version: None,