[#98] Add command to display paths searched for command binaries

Author: orecham

iceoryx2-cli/iox2/src/cli.rs

@@ -15,6 +15,13 @@ pub struct Cli {
     #[arg(short, long, help = "List all installed commands")]
     pub list: bool,
 
+    #[arg(
+        short,
+        long,
+        help = "Display paths that will be checked for installed commands"
+    )]
+    pub paths: bool,
+
     #[arg(
         short,
         long,

iceoryx2-cli/iox2/src/commands.rs

@@ -1,6 +1,7 @@
 use colored::*;
 use std::env;
 use std::fs;
+use std::io;
 use std::path::PathBuf;
 use std::process::{Command, Stdio};
 use thiserror::Error;
@@ -43,35 +44,52 @@ pub fn list() {
         .for_each(|formatted_command| println!("{}", formatted_command));
 }
 
+fn get_development_binaries_dir() -> Result<std::path::PathBuf, io::Error> {
+    let current_exe = env::current_exe()?;
+
+    let build_type = if cfg!(debug_assertions) {
+        "debug"
+    } else {
+        "release"
+    };
+
+    let build_path = current_exe
+        .parent()
+        .and_then(|p| p.parent())
+        .map(|p| p.join(build_type))
+        .ok_or_else(|| {
+            io::Error::new(
+                io::ErrorKind::Other,
+                "Failed to construct path of development dir",
+            )
+        })?;
+
+    Ok(build_path)
+}
+
+fn get_installed_binaries_dirs() -> impl Iterator<Item = std::path::PathBuf> {
+    env::var("PATH")
+        .ok()
+        .into_iter()
+        .flat_map(|path_var| env::split_paths(&path_var).collect::<Vec<_>>())
+}
+
 fn find() -> Vec<CommandInfo> {
-    let development_commands = find_command_binaries_in_development_dirs();
-    let installed_commands = find_command_binaries_in_system_path();
+    let development_commands = find_development_command_binaries();
+    let installed_commands = find_installed_command_binaries();
 
     let mut all_commands = development_commands;
     all_commands.extend(installed_commands.iter().cloned());
     all_commands
 }
 
-fn find_command_binaries_in_development_dirs() -> Vec<CommandInfo> {
-    let current_exe = match env::current_exe() {
-        Ok(exe) => exe,
+fn find_development_command_binaries() -> Vec<CommandInfo> {
+    let development_binaries_dir = match get_development_binaries_dir() {
+        Ok(location) => location,
         Err(_) => return Vec::new(),
     };
-    let build_type = if cfg!(debug_assertions) {
-        "debug"
-    } else {
-        "release"
-    };
 
-    // Get the location of the binary directory for the build
-    let binary_dir = current_exe
-        .parent()
-        .unwrap()
-        .parent()
-        .unwrap()
-        .join(build_type);
-
-    fs::read_dir(binary_dir)
+    fs::read_dir(development_binaries_dir)
         .ok()
         .into_iter()
         .flat_map(|entries| entries.filter_map(Result::ok))
@@ -92,11 +110,9 @@ fn find_command_binaries_in_development_dirs() -> Vec<CommandInfo> {
         .collect()
 }
 
-fn find_command_binaries_in_system_path() -> Vec<CommandInfo> {
-    env::var("PATH")
-        .ok()
+fn find_installed_command_binaries() -> Vec<CommandInfo> {
+    get_installed_binaries_dirs()
         .into_iter()
-        .flat_map(|path_var| env::split_paths(&path_var).collect::<Vec<_>>())
         .flat_map(|path: PathBuf| {
             fs::read_dir(path)
                 .into_iter()
@@ -130,6 +146,26 @@ fn is_valid_command_binary(path: &PathBuf) -> bool {
         && path.extension().is_none() // Exclude files with extensions (e.g. '.d')
 }
 
+pub fn paths() {
+    let mut development_binaries_dirs = Vec::new();
+    development_binaries_dirs.extend(get_development_binaries_dir().ok());
+
+    let mut installed_binaries_dirs = Vec::new();
+    installed_binaries_dirs.extend(get_installed_binaries_dirs());
+
+    println!("{}", "Development Binary Paths:".bright_green().bold());
+    for dir in &development_binaries_dirs {
+        println!("  {}", dir.display().to_string().bold());
+    }
+
+    println!();
+
+    println!("{}", "Installed Binary Paths:".bright_green().bold());
+    for dir in &installed_binaries_dirs {
+        println!("  {}", dir.display().to_string().bold());
+    }
+}
+
 pub fn execute_external_command(
     command_name: &str,
     args: &[String],

iceoryx2-cli/iox2/src/main.rs

@@ -27,6 +27,8 @@ fn main() {
 
     if cli.list {
         commands::list();
+    } else if cli.paths {
+        commands::paths();
     } else if !cli.external_command.is_empty() {
         let command_name = &cli.external_command[0];
         let command_args = &cli.external_command[1..];