add log framework, stub decode tests

Author: ryankurte

Cargo.lock

@@ -32,10 +32,12 @@ pkg-fmt = "zip"
 [dependencies]
 cargo_metadata = "0.15"
 cargo_toml = "0.11"
-clap = { version = "3.2", features = ["derive"] }
+clap = { version = "3.2", features = ["derive", "env"] }
 espflash = { version = "=1.6.1-dev", path = "../espflash" }
+log = "0.4.17"
 miette = { version = "5.2", features = ["fancy"] }
 serde = { version = "1.0", features = ["derive"] }
 strum = "0.24"
 thiserror = "1.0"
+tracing-subscriber = { version = "0.3.11", features = [ "env-filter" ] }
 toml = "0.5"

cargo-espflash/Cargo.toml

@@ -15,8 +15,10 @@ use espflash::{
     },
     Chip, Config, ImageFormatId,
 };
+use log::debug;
 use miette::{IntoDiagnostic, Result, WrapErr};
 use strum::VariantNames;
+use tracing_subscriber::{filter::LevelFilter, EnvFilter};
 
 use crate::{
     cargo_config::{parse_cargo_config, CargoConfig},
@@ -28,19 +30,23 @@ mod cargo_config;
 mod error;
 mod package_metadata;
 
-#[derive(Parser)]
+#[derive(Debug, Clone, Parser)]
 #[clap(bin_name = "cargo", version, propagate_version = true)]
 struct Opts {
     #[clap(subcommand)]
     subcommand: CargoSubCommand,
+
+    /// Log level
+    #[clap(long, default_value = "info", env)]
+    log_level: LevelFilter,
 }
 
-#[derive(Parser)]
+#[derive(Debug, Clone, Parser)]
 enum CargoSubCommand {
     Espflash(EspFlashOpts),
 }
 
-#[derive(Parser)]
+#[derive(Debug, Clone, Parser)]
 struct EspFlashOpts {
     #[clap(flatten)]
     flash_opts: FlashOpts,
@@ -52,7 +58,7 @@ struct EspFlashOpts {
     subcommand: Option<SubCommand>,
 }
 
-#[derive(Parser)]
+#[derive(Debug, Clone, Parser)]
 pub enum SubCommand {
     /// Display information about the connected board and exit without flashing
     BoardInfo(ConnectOpts),
@@ -64,7 +70,7 @@ pub enum SubCommand {
     PartitionTable(PartitionTableOpts),
 }
 
-#[derive(Parser)]
+#[derive(Debug, Clone, Parser)]
 pub struct BuildOpts {
     /// Build the application using the release profile
     #[clap(long)]
@@ -100,7 +106,7 @@ pub struct BuildOpts {
     pub flash_config_opts: FlashConfigOpts,
 }
 
-#[derive(Parser)]
+#[derive(Debug, Clone, Parser)]
 pub struct SaveImageOpts {
     #[clap(flatten)]
     pub build_opts: BuildOpts,
@@ -125,8 +131,20 @@ fn main() -> Result<()> {
 
     check_for_updates(env!("CARGO_PKG_NAME"), env!("CARGO_PKG_VERSION"));
 
-    let CargoSubCommand::Espflash(opts) = Opts::parse().subcommand;
+    // Parse options
+    let opts = Opts::parse();
+
+    // Setup logging
+    let _ = tracing_subscriber::fmt()
+        .with_env_filter(EnvFilter::from_default_env().add_directive(opts.log_level.into()))
+        .init();
+
+    // Extract subcommand
+    let CargoSubCommand::Espflash(opts) = opts.subcommand;
+
+    debug!("subcommand options: {:?}", opts);
 
+    // Load configuration and metadata
     let config = Config::load()?;
     let metadata = CargoEspFlashMeta::load("Cargo.toml")?;
     let cargo_config = parse_cargo_config(".")?;

cargo-espflash/src/main.rs

@@ -32,7 +32,7 @@ pkg-fmt = "zip"
 base64 = "0.13.0"
 binread = "2.2"
 bytemuck = { version = "1.11", features = ["derive"] }
-clap = { version = "3.2", features = ["derive"] }
+clap = { version = "3.2", features = ["derive", "env"] }
 comfy-table = "6.0"
 crossterm = "0.24"
 csv = "1.1"
@@ -41,6 +41,7 @@ directories-next = "2.0"
 espmonitor = "0.10"
 flate2 = "1.0"
 indicatif = "0.17"
+log = "0.4.17"
 maplit = "1.0"
 md5 = "0.7"
 miette = { version = "5.2", features = ["fancy"] }
@@ -51,6 +52,7 @@ serde-hex = "0.1"
 serde_json = "1.0.83"
 serde_plain = "1.0"
 serialport = "4.2"
+tracing-subscriber = { version = "0.3.11", features = [ "env-filter" ] }
 sha2 = "0.10"
 slip-codec = "0.3"
 strum = "0.24"

espflash/Cargo.toml

@@ -1,7 +1,7 @@
 use std::{collections::HashMap, ops::Range, str::FromStr};
 
 use maplit::hashmap;
-use strum_macros::{Display, EnumVariantNames};
+use strum_macros::{Display, EnumIter, EnumVariantNames};
 
 pub use self::{
     esp32::{Esp32, Esp32Params, Esp32c2, Esp32c3, Esp32s2, Esp32s3},
@@ -143,7 +143,7 @@ impl SpiRegisters {
     }
 }
 
-#[derive(Debug, Copy, Clone, Eq, PartialEq, Display, EnumVariantNames)]
+#[derive(Debug, Copy, Clone, Eq, PartialEq, Display, EnumVariantNames, EnumIter)]
 pub enum Chip {
     #[strum(serialize = "ESP32")]
     Esp32,

espflash/src/chip/mod.rs

@@ -31,7 +31,7 @@ pub mod monitor;
 
 mod serial;
 
-#[derive(Parser, Debug)]
+#[derive(Clone, Debug, Parser)]
 pub struct ConnectOpts {
     /// Serial port connected to target device
     pub serial: Option<String>,
@@ -45,7 +45,7 @@ pub struct ConnectOpts {
     pub use_stub: bool,
 }
 
-#[derive(Parser, Debug)]
+#[derive(Clone, Debug, Parser)]
 pub struct FlashOpts {
     /// Load the application to RAM instead of Flash
     #[clap(long)]
@@ -61,7 +61,7 @@ pub struct FlashOpts {
     pub monitor: bool,
 }
 
-#[derive(Parser, Debug)]
+#[derive(Debug, Clone, Parser)]
 pub struct FlashConfigOpts {
     /// Flash mode to use
     #[clap(short = 'm', long, possible_values = FlashMode::VARIANTS, value_name = "MODE")]
@@ -74,7 +74,7 @@ pub struct FlashConfigOpts {
     pub flash_freq: Option<FlashFrequency>,
 }
 
-#[derive(Parser, Debug)]
+#[derive(Clone, Debug, Parser)]
 pub struct PartitionTableOpts {
     /// Convert CSV parition table to binary representation
     #[clap(long, required_unless_present_any = ["info", "to-csv"])]
@@ -92,7 +92,7 @@ pub struct PartitionTableOpts {
     output: Option<PathBuf>,
 }
 
-#[derive(Parser, Debug)]
+#[derive(Clone, Debug, Parser)]
 pub struct WriteBinToFlashOpts {
     /// Address at which to write the binary file
     #[clap(value_parser = parse_u32)]
@@ -138,7 +138,12 @@ pub fn connect(opts: &ConnectOpts, config: &Config) -> Result<Flasher> {
         _ => unreachable!(),
     };
 
-    Ok(Flasher::connect(serial, port_info, opts.speed, opts.use_stub)?)
+    Ok(Flasher::connect(
+        serial,
+        port_info,
+        opts.speed,
+        opts.use_stub,
+    )?)
 }
 
 pub fn board_info(opts: ConnectOpts, config: Config) -> Result<()> {