Tests/add file tree tests (#7)

* Add documentation to file tree funcs

* Add tests for file tree create

* add tests for tree add child

* Add tests for file_tree_build_recursive

* Add tests for file_tree_build

* Add tests for file_tree_free'

* Add unit tests for file_tree_select

* Add unit tests file_tree_count_selected

* Add unit tests delete_selected_recursive

* Add tests file_tree_delete_selected

* Add tests for file_tree_get_list_recurive

* Add ability to suppress src printf

Author: MatthewMuller

include/cisco_cli.h

@@ -121,7 +121,9 @@ void file_tree_build(serial_conn_t *conn, dir_node_t **root);
 void file_tree_free(dir_node_t *node);
 void file_tree_select(dir_node_t *node, int selected);
 int file_tree_count_selected(dir_node_t *node);
+void file_tree_delete_selected_recursive(serial_conn_t *conn, dir_node_t *node, int *success_count, int *fail_count);
 void file_tree_delete_selected(serial_conn_t *conn, dir_node_t *node);
+int file_tree_get_flat_list_recursive(dir_node_t *node, dir_node_t **list, int max_count, int *current_count);
 int file_tree_get_flat_list(dir_node_t *node, dir_node_t **list, int max_count);
 
 // UI functions

src/cisco_commands.c

@@ -132,6 +132,11 @@ int cisco_init_flash(serial_conn_t *conn, int timeout) {
  *          will occur if the returned list is not properly freed.
  */
 int cisco_get_directory_listing(serial_conn_t *conn, const char *path, file_entry_t **files, int timeout) {
+    // Validate input parameters
+    if (!conn || !path || !files) {
+        return -1;
+    }
+    
     char command[MAX_LINE_LEN];
     char buffer[MAX_LINE_LEN * 10]; // Large buffer for directory listing
     char *line, *saveptr;

src/file_tree.c

@@ -1,13 +1,23 @@
 #include "cisco_cli.h"
 
+// Creates a new directory tree node with the given name, path, and type
 dir_node_t *file_tree_create(const char *name, const char *path, file_type_t type) {
     dir_node_t *node = malloc(sizeof(dir_node_t));
     if (!node) return NULL;
 
-    strncpy(node->name, name, MAX_PATH_LEN - 1);
+    // Handle NULL parameters safely
+    if (name) {
+        strncpy(node->name, name, MAX_PATH_LEN - 1);
+    } else {
+        node->name[0] = '\0';
+    }
     node->name[MAX_PATH_LEN - 1] = '\0';
 
-    strncpy(node->path, path, MAX_PATH_LEN - 1);
+    if (path) {
+        strncpy(node->path, path, MAX_PATH_LEN - 1);
+    } else {
+        node->path[0] = '\0';
+    }
     node->path[MAX_PATH_LEN - 1] = '\0';
 
     node->type = type;
@@ -19,8 +29,9 @@ dir_node_t *file_tree_create(const char *name, const char *path, file_type_t typ
     node->next = NULL;
 
     return node;
-}
+} 
 
+// Adds a child node to a parent node in the tree
 void file_tree_add_child(dir_node_t *parent, dir_node_t *child) {
     if (!parent || !child) return;
 
@@ -38,7 +49,13 @@ void file_tree_add_child(dir_node_t *parent, dir_node_t *child) {
     }
 }
 
+// Recursively builds the file tree by fetching directory listings from the device
 void file_tree_build_recursive(serial_conn_t *conn, dir_node_t *parent, const char *path) {
+    // Validate input parameters
+    if (!conn || !parent || !path) {
+        return;
+    }
+    
     file_entry_t *files = NULL;
     int file_count = cisco_get_directory_listing(conn, path, &files, 3);
 
@@ -61,7 +78,11 @@ void file_tree_build_recursive(serial_conn_t *conn, dir_node_t *parent, const ch
     }
 }
 
+// Initializes and builds the root file tree structure
 void file_tree_build(serial_conn_t *conn, dir_node_t **root) {
+    // Validate input parameters
+    if (!root) return;
+    
     // Create root node
     *root = file_tree_create("flash:/", "flash:/", FILE_TYPE_DIRECTORY);
     if (!*root) return;
@@ -70,6 +91,7 @@ void file_tree_build(serial_conn_t *conn, dir_node_t **root) {
     file_tree_build_recursive(conn, *root, "flash:/");
 }
 
+// Recursively frees all memory allocated for the file tree
 void file_tree_free(dir_node_t *node) {
     if (!node) return;
 
@@ -85,6 +107,7 @@ void file_tree_free(dir_node_t *node) {
     free(node);
 }
 
+// Sets the selection state of a node and all its children
 void file_tree_select(dir_node_t *node, int selected) {
     if (!node) return;
 
@@ -100,6 +123,7 @@ void file_tree_select(dir_node_t *node, int selected) {
     }
 }
 
+// Counts the total number of selected nodes in the tree
 int file_tree_count_selected(dir_node_t *node) {
     if (!node) return 0;
 
@@ -115,6 +139,7 @@ int file_tree_count_selected(dir_node_t *node) {
     return count;
 }
 
+// Recursively deletes selected files and directories from the device
 void file_tree_delete_selected_recursive(serial_conn_t *conn, dir_node_t *node, int *success_count, int *fail_count) {
     if (!node) return;
 
@@ -138,14 +163,15 @@ void file_tree_delete_selected_recursive(serial_conn_t *conn, dir_node_t *node,
             result = cisco_delete_file(conn, node->path, 3);
         }
 
-        if (result == 0) {
+        if (result == 0 && success_count != NULL) {
             (*success_count)++;
-        } else {
+        } else if (result != 0 && fail_count != NULL) {
             (*fail_count)++;
         }
     }
 }
 
+// Deletes all selected files and directories and reports results
 void file_tree_delete_selected(serial_conn_t *conn, dir_node_t *node) {
     int success_count = 0, fail_count = 0;
 
@@ -155,13 +181,15 @@ void file_tree_delete_selected(serial_conn_t *conn, dir_node_t *node) {
     printf("Deletion complete: %d successful, %d failed\n", success_count, fail_count);
 }
 
-// Utility function to get all nodes in a flat list for UI display
+// Recursively builds a flat list of visible nodes for UI display
 int file_tree_get_flat_list_recursive(dir_node_t *node, dir_node_t **list, int max_count, int *current_count) {
-    if (!node || *current_count >= max_count) return *current_count;
+    if (!node || !list || !current_count || *current_count >= max_count) return 0;
 
+    // Always include the current node in the list
     list[*current_count] = node;
     (*current_count)++;
 
+    // Only include children if the current node is expanded
     if (node->expanded) {
         dir_node_t *child = node->children;
         while (child != NULL && *current_count < max_count) {
@@ -173,6 +201,7 @@ int file_tree_get_flat_list_recursive(dir_node_t *node, dir_node_t **list, int m
     return *current_count;
 }
 
+// Creates a flat list of all visible nodes in the tree for UI rendering
 int file_tree_get_flat_list(dir_node_t *node, dir_node_t **list, int max_count) {
     int count = 0;
     return file_tree_get_flat_list_recursive(node, list, max_count, &count);

tests/Makefile

@@ -4,52 +4,68 @@ LDFLAGS = -lpthread -Wl,--gc-sections
 
 # Source files for the streamlined framework
 TEST_FRAMEWORK_SRC = framework/test_framework.c
-TEST_SRC = unit/test_cisco_commands.c
-SOURCE_SRC = ../src/cisco_commands.c
+TEST_SRC = unit/test_cisco_commands.c unit/test_file_tree.c
+SOURCE_SRC = ../src/cisco_commands.c ../src/file_tree.c
 
 # Object files
 TEST_FRAMEWORK_OBJ = $(TEST_FRAMEWORK_SRC:.c=.o)
 TEST_OBJ = $(TEST_SRC:.c=.o)
 SOURCE_OBJ = $(SOURCE_SRC:.c=.o)
 
-# Test executable
+# Test executables
 TEST_EXEC = test_cisco_commands
+FILE_TREE_TEST_EXEC = test_file_tree
 
 # Default target
-all: $(TEST_EXEC)
+all: $(TEST_EXEC) $(FILE_TREE_TEST_EXEC)
 
-# Build test executable
-$(TEST_EXEC): $(TEST_FRAMEWORK_OBJ) $(TEST_OBJ) $(SOURCE_OBJ)
+# Build test executables
+$(TEST_EXEC): $(TEST_FRAMEWORK_OBJ) unit/test_cisco_commands.o ../src/cisco_commands.o
+	$(CC) $(CFLAGS) -o $@ $^ $(LDFLAGS)
+
+$(FILE_TREE_TEST_EXEC): $(TEST_FRAMEWORK_OBJ) unit/test_file_tree.o ../src/file_tree.o ../src/cisco_commands.o
 	$(CC) $(CFLAGS) -o $@ $^ $(LDFLAGS)
 
 # Compile test framework
 $(TEST_FRAMEWORK_OBJ): $(TEST_FRAMEWORK_SRC) framework/test_framework.h
 	$(CC) $(CFLAGS) -c $< -o $@
 
-# Compile test file
-$(TEST_OBJ): $(TEST_SRC) framework/test_framework.h ../include/cisco_cli.h
+# Compile test files
+unit/test_cisco_commands.o: unit/test_cisco_commands.c framework/test_framework.h ../include/cisco_cli.h
+	$(CC) $(CFLAGS) -c $< -o $@
+
+unit/test_file_tree.o: unit/test_file_tree.c framework/test_framework.h ../include/cisco_cli.h
+	$(CC) $(CFLAGS) -c $< -o $@
+
+# Compile source files
+../src/cisco_commands.o: ../src/cisco_commands.c ../include/cisco_cli.h
 	$(CC) $(CFLAGS) -c $< -o $@
 
-# Compile source file (only the one we need for testing)
-$(SOURCE_OBJ): $(SOURCE_SRC) ../include/cisco_cli.h
+../src/file_tree.o: ../src/file_tree.c ../include/cisco_cli.h
 	$(CC) $(CFLAGS) -c $< -o $@
 
 # Run tests
-test: $(TEST_EXEC)
+test: $(TEST_EXEC) $(FILE_TREE_TEST_EXEC)
+	@echo "Running cisco_commands tests..."
 	./$(TEST_EXEC)
+	@echo "Running file_tree tests..."
+	./$(FILE_TREE_TEST_EXEC)
 
 # Run tests with verbose output
-test-verbose: $(TEST_EXEC)
+test-verbose: $(TEST_EXEC) $(FILE_TREE_TEST_EXEC)
+	@echo "Running cisco_commands tests with verbose output..."
 	./$(TEST_EXEC) --verbose
+	@echo "Running file_tree tests with verbose output..."
+	./$(FILE_TREE_TEST_EXEC) --verbose
 
 # Clean
 clean:
-	rm -f $(TEST_FRAMEWORK_OBJ) $(TEST_OBJ) $(SOURCE_OBJ) $(TEST_EXEC)
+	rm -f $(TEST_FRAMEWORK_OBJ) unit/*.o ../src/*.o $(TEST_EXEC) $(FILE_TREE_TEST_EXEC)
 
 # Help
 help:
 	@echo "Available targets:"
-	@echo "  all         - Build test executable"
+	@echo "  all         - Build all test executables"
 	@echo "  test        - Run all tests"
 	@echo "  test-verbose- Run all tests with verbose output"
 	@echo "  clean       - Clean test files"

tests/framework/test_framework.c

@@ -14,6 +14,9 @@
 
 #include "test_framework.h"
 #include "../include/cisco_cli.h"
+#include <unistd.h>
+#include <fcntl.h>
+#include <stdio.h>
 
 // ============================================================================
 // Mock Framework Implementation
@@ -150,8 +153,14 @@ static int run_single_test(const char *test_name, test_func_t test_func) {
     printf("  Running: %s", test_name);
     fflush(stdout);
 
+    // Suppress stdout during test execution to avoid printf output from functions under test
+    suppress_stdout();
+    
     int result = test_func();
 
+    // Restore stdout after test execution
+    restore_stdout();
+    
     if (result) {
         printf(" ✓ PASS\n");
         test_stats.passed_tests++;
@@ -220,6 +229,47 @@ int run_test_suite(const char *suite_name) {
     return run_all_tests();
 }
 
+// ============================================================================
+// Output Suppression Functions
+// ============================================================================
+
+// Global variables to store original stdout
+static int original_stdout_fd = -1;
+static int stdout_suppressed = 0;
+
+/**
+ * @brief Suppress stdout output during test execution
+ */
+void suppress_stdout(void) {
+    if (!stdout_suppressed) {
+        // Store the original stdout file descriptor
+        original_stdout_fd = dup(STDOUT_FILENO);
+        
+        // Redirect stdout to /dev/null to suppress output
+        freopen("/dev/null", "w", stdout);
+        stdout_suppressed = 1;
+    }
+}
+
+/**
+ * @brief Restore stdout output after test execution
+ */
+void restore_stdout(void) {
+    if (stdout_suppressed && original_stdout_fd != -1) {
+        // Close the current stdout (which points to /dev/null)
+        fclose(stdout);
+        
+        // Restore the original stdout file descriptor
+        dup2(original_stdout_fd, STDOUT_FILENO);
+        close(original_stdout_fd);
+        original_stdout_fd = -1;
+        
+        // Reopen stdout as a FILE* for the restored file descriptor
+        stdout = fopen("/dev/stdout", "w");
+        stdout_suppressed = 0;
+    }
+}
+
 // ============================================================================
 // Utility Functions
 // ============================================================================

tests/framework/test_framework.h

@@ -281,4 +281,18 @@ TEST_SETUP(serial);
  */
 TEST_TEARDOWN(serial);
 
+// ============================================================================
+// Output Suppression Functions
+// ============================================================================
+
+/**
+ * @brief Suppress stdout output during test execution
+ */
+void suppress_stdout(void);
+
+/**
+ * @brief Restore stdout output after test execution
+ */
+void restore_stdout(void);
+
 #endif // TEST_FRAMEWORK_V2_H

tests/unit/test_cisco_commands.c

@@ -1221,7 +1221,7 @@ TEST(delete_directory_special_characters_in_path) {
 // ============================================================================
 
 int main(void) {
-    printf("Running cisco_commands unit tests (v2)...\n");
+    printf("Running cisco_commands unit tests...\n");
 
     int result = run_all_tests();