From 5f374d8209a34a0d2a786c5df9eb7a5c77fa9002 Mon Sep 17 00:00:00 2001 From: Kevin Day Date: Sun, 9 Mar 2025 22:22:43 -0500 Subject: [PATCH] Progress: Continue working on completing the remove program. I discovered that the `fl_directory_do()` could use some improvements while working on this. Those changes are now made in the FLL project. Make changes to this project based on the `fl_directory_do()` updates. I began writing some tests and I encountered several problems and concerns that side-tracked me. Rename the `kt_remove_operate_file_recurse()` to `kt_remove_operate_file_directory()`. This should make its design and purpose more clear. Make sure that the recurse status is processed in the proper order for the file operation directory. Fix the problem where the recursion is being performed even when the recurse flag is not set. Add checks to see if the directory is empty or not before deleting when recursion is not enabled. The flag (called code in this case) needs to accurately reflect the directory status of the file during recursion. Make sure the recurse error handler uses the top path or the recurse path as appropriate. Print debug messages before recursion begins. Add missing `f_status_t` return states to several print functions. I did not do an exhaustive look (I imagine the TacocaT program needs similar changes). Fix problems where the program output is being used for the print functions rather than the print output. The runtime unit tests do not work correctly because the standard outputs are being closed. Add additional ifdef checks to prevent the set down functions from being called. --- data/build/remove/settings | 4 +- data/build/remove/settings-mocks.remove | 3 +- data/build/remove/settings-objects | 4 +- data/build/remove/settings-tests.remove | 1 + documents/readme.txt | 4 +- .../program/kevux/tools/remove/main/common/print.c | 1 + .../program/kevux/tools/remove/main/common/print.h | 1 + .../c/program/kevux/tools/remove/main/operate.c | 73 +++++++++---- .../c/program/kevux/tools/remove/main/operate.h | 18 ++-- .../c/program/kevux/tools/remove/main/preprocess.c | 6 +- .../c/program/kevux/tools/remove/main/preprocess.h | 2 +- .../program/kevux/tools/remove/main/print/debug.c | 25 +++++ .../program/kevux/tools/remove/main/print/debug.h | 49 +++++++++ .../kevux/tools/remove/main/print/simulate.c | 116 ++++++++++++--------- .../kevux/tools/remove/main/print/simulate.h | 48 +++++++-- .../kevux/tools/remove/main/print/verbose.c | 16 +++ .../kevux/tools/remove/main/print/verbose.h | 26 +++++ sources/c/program/kevux/tools/remove/main/remove.h | 1 + sources/c/program/kevux/tools/remove/remove/main.c | 5 +- tests/unit/remove/c/mock-remove.c | 9 ++ tests/unit/remove/c/mock-remove.h | 2 + tests/unit/remove/c/test-remove-print_version.h | 2 +- tests/unit/remove/c/test-remove-regular_no_args.c | 34 ++++++ tests/unit/remove/c/test-remove-regular_no_args.h | 18 ++++ tests/unit/remove/c/test-remove.c | 2 + tests/unit/remove/c/test-remove.h | 1 + 26 files changed, 370 insertions(+), 101 deletions(-) create mode 100644 sources/c/program/kevux/tools/remove/main/print/debug.c create mode 100644 sources/c/program/kevux/tools/remove/main/print/debug.h create mode 100644 tests/unit/remove/c/test-remove-regular_no_args.c create mode 100644 tests/unit/remove/c/test-remove-regular_no_args.h diff --git a/data/build/remove/settings b/data/build/remove/settings index de961d4..2ab1792 100644 --- a/data/build/remove/settings +++ b/data/build/remove/settings @@ -44,9 +44,9 @@ build_libraries-individual_thread -lf_thread build_libraries-level -lfll_2 -lfll_1 -lfll_0 build_libraries-monolithic -lfll -build_sources_library common.c common/define.c common/enumeration.c common/print.c common/string.c common/type.c convert.c operate.c preprocess.c print/error.c print/message.c print/simulate.c print/verbose.c print/warning.c remove.c signal.c thread.c +build_sources_library common.c common/define.c common/enumeration.c common/print.c common/string.c common/type.c convert.c operate.c preprocess.c print/debug.c print/error.c print/message.c print/simulate.c print/verbose.c print/warning.c remove.c signal.c thread.c -build_sources_headers common.h common/define.h common/enumeration.h common/print.h common/string.h common/type.h convert.h operate.h preprocess.h print/error.h print/message.h print/simulate.h print/verbose.h print/warning.h remove.h signal.h thread.h +build_sources_headers common.h common/define.h common/enumeration.h common/print.h common/string.h common/type.h convert.h operate.h preprocess.h print/debug.h print/error.h print/message.h print/simulate.h print/verbose.h print/warning.h remove.h signal.h thread.h build_sources_documentation man diff --git a/data/build/remove/settings-mocks.remove b/data/build/remove/settings-mocks.remove index bb762a1..1b41928 100644 --- a/data/build/remove/settings-mocks.remove +++ b/data/build/remove/settings-mocks.remove @@ -39,7 +39,7 @@ build_sources_library ../../../../../../../tests/unit/remove/c/mock-remove.c build_sources_headers remove.h main.h string.h -build_objects_library common.o common/define.o common/enumeration.o common/print.o common/string.o common/type.o convert.o operate.o preprocess.o print/error.o print/message.o print/simulate.o print/verbose.o print/warning.o remove.o signal.o thread.o +build_objects_library common.o common/define.o common/enumeration.o common/print.o common/string.o common/type.o convert.o operate.o preprocess.o print/debug.o print/error.o print/message.o print/simulate.o print/verbose.o print/warning.o remove.o signal.o thread.o build_script no build_shared yes @@ -85,6 +85,7 @@ flags_library -fPIC flags_program-android -fPIE -Wl,-z,relro # Inject mocks. +flags -Wl,--wrap=f_directory_remove flags -Wl,--wrap=f_file_exists flags -Wl,--wrap=f_file_remove flags -Wl,--wrap=fll_program_print_version diff --git a/data/build/remove/settings-objects b/data/build/remove/settings-objects index d45c367..0a37af2 100644 --- a/data/build/remove/settings-objects +++ b/data/build/remove/settings-objects @@ -36,9 +36,9 @@ build_indexer ar build_indexer_arguments rcs build_language c -build_sources_object common.c common/define.c common/enumeration.c common/print.c common/string.c common/type.c convert.c operate.c preprocess.c print/error.c print/message.c print/simulate.c print/verbose.c print/warning.c remove.c signal.c thread.c +build_sources_object common.c common/define.c common/enumeration.c common/print.c common/string.c common/type.c convert.c operate.c preprocess.c print/debug.c print/error.c print/message.c print/simulate.c print/verbose.c print/warning.c remove.c signal.c thread.c -build_sources_headers common.h common/define.h common/enumeration.h common/print.h common/string.h common/type.h convert.h operate.h preprocess.h print/error.h print/message.h print/simulate.h print/verbose.h print/warning.h remove.h signal.h thread.h +build_sources_headers common.h common/define.h common/enumeration.h common/print.h common/string.h common/type.h convert.h operate.h preprocess.h print/debug.h print/error.h print/message.h print/simulate.h print/verbose.h print/warning.h remove.h signal.h thread.h build_sources_documentation man diff --git a/data/build/remove/settings-tests.remove b/data/build/remove/settings-tests.remove index 8f1881e..5df8f23 100644 --- a/data/build/remove/settings-tests.remove +++ b/data/build/remove/settings-tests.remove @@ -31,6 +31,7 @@ build_libraries-individual_thread -lf_thread build_sources_program test-remove.c build_sources_program test-remove-print_help.c test-remove-print_version.c +build_sources_program test-remove-regular_no_args.c build_script no build_shared yes diff --git a/documents/readme.txt b/documents/readme.txt index 4cd16a2..167affd 100644 --- a/documents/readme.txt +++ b/documents/readme.txt @@ -18,7 +18,7 @@ Readme Documentation: Programs such as the standard bold:"Linux" code:"install" (from bold:"GNU Coreutils") has some seriously simple problems such as being incapable of properly installing files when the file:"/proc" file system is mounted. The reason for the failure (be it a bug or otherwise) is unclear but the dependency on code:"/proc" being mounted is ridiculous. - - Better prepare for future planned functionality such as improved accessibility and interaction. + - Be better prepared for future planned functionality such as improved accessibility and interaction. This should help make the bold:"Turtle Kevux" distribution more ready in regards to the designers and developers future plans. - A need to improve maintainability of basic toolchain dependencies. @@ -28,7 +28,7 @@ Readme Documentation: - Provides more exposure to the FLL:"Featureless Linux Library". This results in more testing through real-word use. - - Makes the system more familiar. + - Makes the system more comfortable. The developer behind both the FLL:"Featureless Linux Library" and this project can work better in a more comfortable environment. See: file:"dependencies" for specific dependencies of this project. diff --git a/sources/c/program/kevux/tools/remove/main/common/print.c b/sources/c/program/kevux/tools/remove/main/common/print.c index 091e331..cfb8214 100644 --- a/sources/c/program/kevux/tools/remove/main/common/print.c +++ b/sources/c/program/kevux/tools/remove/main/common/print.c @@ -8,6 +8,7 @@ extern "C" { const f_string_t kt_remove_f_a[] = { "f_console_parameter_prioritize_right", "f_console_parameter_process", + "f_directory_remove", "f_file_mode_from_string", "f_file_mode_to_mode", "f_file_remove", diff --git a/sources/c/program/kevux/tools/remove/main/common/print.h b/sources/c/program/kevux/tools/remove/main/common/print.h index b9cff65..060027d 100644 --- a/sources/c/program/kevux/tools/remove/main/common/print.h +++ b/sources/c/program/kevux/tools/remove/main/common/print.h @@ -41,6 +41,7 @@ extern "C" { enum { kt_remove_f_f_console_parameter_prioritize_right_e, kt_remove_f_f_console_parameter_process_e, + kt_remove_f_f_directory_remove_e, kt_remove_f_f_file_mode_from_string_e, kt_remove_f_f_file_mode_to_mode_e, kt_remove_f_f_file_remove_e, diff --git a/sources/c/program/kevux/tools/remove/main/operate.c b/sources/c/program/kevux/tools/remove/main/operate.c index ddb9669..b02d2b6 100644 --- a/sources/c/program/kevux/tools/remove/main/operate.c +++ b/sources/c/program/kevux/tools/remove/main/operate.c @@ -21,7 +21,7 @@ extern "C" { if (F_status_is_error_not(main->setting.state.status) && !(main->setting.flag & kt_remove_main_flag_simulate_d) && !(flag_operate & kt_remove_flag_file_operate_processed_d)) { main->setting.state.status = flag_operate & kt_remove_flag_file_operate_directory_d - ? kt_remove_operate_file_recurse(main, path, flag_operate) + ? kt_remove_operate_file_directory(main, path, flag_operate) : kt_remove_operate_file_remove(main, path, flag_operate); } @@ -39,8 +39,8 @@ extern "C" { } #endif // _di_kt_remove_operate_file_ -#ifndef _di_kt_remove_operate_file_recurse_ - f_status_t kt_remove_operate_file_recurse(kt_remove_main_t * const main, const f_string_static_t path, const uint16_t flag_operate) { +#ifndef _di_kt_remove_operate_file_directory_ + f_status_t kt_remove_operate_file_directory(kt_remove_main_t * const main, const f_string_static_t path, const uint16_t flag_operate) { if (!kt_remove_operate_shall_remove(flag_operate)) return (flag_operate & kt_remove_flag_file_operate_remove_fail_d) ? F_status_set_error(F_no) : F_no; @@ -50,36 +50,42 @@ extern "C" { recurse.state.code = flag_operate; recurse.state.interrupt = &kt_remove_signal_check_recurse; - recurse.flag = f_directory_recurse_do_flag_list_e; - recurse.depth_max = kt_remove_depth_max_d; + recurse.flag = f_directory_recurse_do_flag_list_e | f_directory_recurse_do_flag_top_after_e; + recurse.depth_max = main->setting.flag & kt_remove_main_flag_recurse_d ? kt_remove_depth_max_d : 0; - recurse.action = &kt_remove_operate_file_recurse_action; + recurse.action = &kt_remove_operate_file_directory_action; recurse.handle = &kt_remove_operate_file_recurse_handle; fl_directory_do(path, &recurse); const f_status_t status = f_directory_recurse_do_delete(&recurse); + if (F_status_is_error(recurse.state.status)) return recurse.state.status; + if (F_status_is_error(status)) return status; - return F_status_is_error(recurse.state.status) - ? recurse.state.status - : F_status_is_error(status) - ? status - : F_yes; + return F_yes; } -#endif // _di_kt_remove_operate_file_recurse_ +#endif // _di_kt_remove_operate_file_directory_ -#ifndef _di_kt_remove_operate_file_recurse_action_ - void kt_remove_operate_file_recurse_action(f_directory_recurse_do_t * const recurse, const f_string_static_t name, const uint16_t flag) { +#ifndef _di_kt_remove_operate_file_directory_action_ + void kt_remove_operate_file_directory_action(f_directory_recurse_do_t * const recurse, const f_string_static_t name, const uint32_t flag) { if (!recurse || !recurse->state.custom || F_status_set_fine(recurse->state.status) == F_interrupt) return; if (!kt_remove_operate_shall_remove(recurse->state.code) || !(flag & f_directory_recurse_do_flag_action_e)) return; - recurse->state.status = kt_remove_operate_file_remove((kt_remove_main_t *) recurse->state.custom, recurse->path, recurse->state.code); + const f_string_static_t path = flag & f_directory_recurse_do_flag_top_after_e ? *recurse->path_top : recurse->path; + + recurse->state.status = kt_remove_operate_file_remove( + (kt_remove_main_t *) recurse->state.custom, + path, + f_directory_is(path) == F_true + ? recurse->state.code | f_directory_recurse_do_flag_directory_e + : recurse->state.code & ~f_directory_recurse_do_flag_directory_e + ); } -#endif // _di_kt_remove_operate_file_recurse_action_ +#endif // _di_kt_remove_operate_file_directory_action_ #ifndef _di_kt_remove_operate_file_recurse_handle_ - void kt_remove_operate_file_recurse_handle(f_directory_recurse_do_t * const recurse, const f_string_static_t name, const uint16_t flag) { + void kt_remove_operate_file_recurse_handle(f_directory_recurse_do_t * const recurse, const f_string_static_t name, const uint32_t flag) { if (!recurse || !recurse->state.custom || F_status_set_fine(recurse->state.status) == F_interrupt) return; @@ -92,16 +98,24 @@ extern "C" { return; } + if (flag & f_directory_recurse_do_flag_list_e && recurse->state.status == F_status_set_error(F_recurse)) { + recurse->state.status = F_status_set_error(F_directory_empty_not); + + kt_remove_print_error_file_status(&main->program.error, macro_kt_remove_f(fl_recurse_do), flag & f_directory_recurse_do_flag_top_after_e ? *recurse->path_top : recurse->path, f_file_operation_delete_s, fll_error_file_type_directory_e, recurse->state.status); + + return; + } + // The top-level path is an empty string or an error occurred while processing the top-level path. if (flag == (f_directory_recurse_do_flag_top_e | f_directory_recurse_do_flag_path_e) || flag == (f_directory_recurse_do_flag_top_e | f_directory_recurse_do_flag_path_e | f_directory_recurse_do_flag_before_e)) { - kt_remove_print_error_file_status(&main->program.error, macro_kt_remove_f(fl_recurse_do), name, f_file_operation_stat_s, fll_error_file_type_path_e, recurse->state.status); + kt_remove_print_error_file_status(&main->program.error, macro_kt_remove_f(fl_recurse_do), flag & f_directory_recurse_do_flag_top_after_e ? *recurse->path_top : recurse->path, f_file_operation_stat_s, fll_error_file_type_path_e, recurse->state.status); return; } // An error happened during directory list loading. if (flag == (f_directory_recurse_do_flag_list_e | f_directory_recurse_do_flag_path_e)) { - kt_remove_print_error_file_status(&main->program.error, macro_kt_remove_f(fl_recurse_do), name, f_file_operation_list_s, fll_error_file_type_directory_e, recurse->state.status); + kt_remove_print_error_file_status(&main->program.error, macro_kt_remove_f(fl_recurse_do), flag & f_directory_recurse_do_flag_top_after_e ? *recurse->path_top : recurse->path, f_file_operation_list_s, fll_error_file_type_directory_e, recurse->state.status); return; } @@ -114,6 +128,8 @@ extern "C" { if (!main) return F_status_set_error(F_parameter); if (!kt_remove_operate_shall_remove(flag_operate)) return (flag_operate & kt_remove_flag_file_operate_remove_fail_d) ? F_status_set_error(F_no) : F_no; + kt_remove_print_debug_operate_file_remove(&main->program.output, path, flag_operate); + f_status_t status = F_no; if (flag_operate & kt_remove_flag_file_operate_follow_d) { @@ -128,14 +144,29 @@ extern "C" { } } - status = (flag_operate & f_directory_recurse_do_flag_directory_e) + status = flag_operate & f_directory_recurse_do_flag_directory_e ? f_directory_remove((flag_operate & kt_remove_flag_file_operate_follow_d) ? main->cache.buffer : path, 0, F_false) : f_file_remove((flag_operate & kt_remove_flag_file_operate_follow_d) ? main->cache.buffer : path); if (F_status_is_error(status)) { - kt_remove_print_error_file(&main->program.error, macro_kt_remove_f(f_file_remove), (flag_operate & kt_remove_flag_file_operate_follow_d) ? main->cache.buffer : path, f_file_operation_delete_s, fll_error_file_type_file_e); + kt_remove_print_error_file_status( + &main->program.error, + flag_operate & f_directory_recurse_do_flag_directory_e + ? macro_kt_remove_f(f_directory_remove) + : macro_kt_remove_f(f_file_remove), + flag_operate & kt_remove_flag_file_operate_follow_d + ? main->cache.buffer + : path, + f_file_operation_delete_s, + flag_operate & f_directory_recurse_do_flag_directory_e + ? fll_error_file_type_directory_e + : fll_error_file_type_file_e, + status + ); } else { + kt_remove_print_verbose_operate_file_remove(&main->program.output, path, flag_operate); + status = F_yes; } diff --git a/sources/c/program/kevux/tools/remove/main/operate.h b/sources/c/program/kevux/tools/remove/main/operate.h index d752f26..3ed63b6 100644 --- a/sources/c/program/kevux/tools/remove/main/operate.h +++ b/sources/c/program/kevux/tools/remove/main/operate.h @@ -29,7 +29,7 @@ extern "C" { * * Errors (with error bit) from: f_string_dynamic_append(). * - * Errors (with error bit) from: kt_remove_operate_file_recurse(). + * Errors (with error bit) from: kt_remove_operate_file_directory(). * Errors (with error bit) from: kt_remove_operate_file_remove_delete(). * Errors (with error bit) from: kt_remove_operate_file_remove(). * Errors (with error bit) from: kt_remove_preprocess_file(). @@ -42,7 +42,7 @@ extern "C" { * * @see f_string_dynamic_append() * - * @see kt_remove_operate_file_recurse() + * @see kt_remove_operate_file_directory() * @see kt_remove_operate_file_remove_delete() * @see kt_remove_operate_file_remove() * @see kt_remove_preprocess_file() @@ -80,9 +80,9 @@ extern "C" { * @see f_file_remove() * @see fl_directory_do() */ -#ifndef _di_kt_remove_operate_file_recurse_ - extern f_status_t kt_remove_operate_file_recurse(kt_remove_main_t * const main, const f_string_static_t path, const uint16_t flag_operate); -#endif // _di_kt_remove_operate_file_recurse_ +#ifndef _di_kt_remove_operate_file_directory_ + extern f_status_t kt_remove_operate_file_directory(kt_remove_main_t * const main, const f_string_static_t path, const uint16_t flag_operate); +#endif // _di_kt_remove_operate_file_directory_ /** * Perform directory recurse for a single file operation action. @@ -101,9 +101,9 @@ extern "C" { * @see f_directory_remove() * @see fl_directory_do() */ -#ifndef _di_kt_remove_operate_file_recurse_action_ - extern void kt_remove_operate_file_recurse_action(f_directory_recurse_do_t * const recurse, const f_string_static_t name, const uint16_t flag); -#endif // _di_kt_remove_operate_file_recurse_action_ +#ifndef _di_kt_remove_operate_file_directory_action_ + extern void kt_remove_operate_file_directory_action(f_directory_recurse_do_t * const recurse, const f_string_static_t name, const uint32_t flag); +#endif // _di_kt_remove_operate_file_directory_action_ /** * Handle errors while performing directory recurse for a single file operation action. @@ -122,7 +122,7 @@ extern "C" { * @see fl_directory_do() */ #ifndef _di_kt_remove_operate_file_recurse_handle_ - extern void kt_remove_operate_file_recurse_handle(f_directory_recurse_do_t * const recurse, const f_string_static_t name, const uint16_t flag); + extern void kt_remove_operate_file_recurse_handle(f_directory_recurse_do_t * const recurse, const f_string_static_t name, const uint32_t flag); #endif // _di_kt_remove_operate_file_recurse_handle_ /** diff --git a/sources/c/program/kevux/tools/remove/main/preprocess.c b/sources/c/program/kevux/tools/remove/main/preprocess.c index 50bb0c4..1e1bc4b 100644 --- a/sources/c/program/kevux/tools/remove/main/preprocess.c +++ b/sources/c/program/kevux/tools/remove/main/preprocess.c @@ -349,8 +349,8 @@ extern "C" { recurse.state.code = flag_operate; recurse.state.interrupt = &kt_remove_signal_check_recurse; - recurse.flag = f_directory_recurse_do_flag_list_e; - recurse.depth_max = kt_remove_depth_max_d; + recurse.flag = f_directory_recurse_do_flag_list_e | f_directory_recurse_do_flag_top_after_e; + recurse.depth_max = main->setting.flag & kt_remove_main_flag_recurse_d ? kt_remove_depth_max_d : 0; recurse.action = &kt_remove_preprocess_file_recurse_action; recurse.handle = &kt_remove_operate_file_recurse_handle; @@ -368,7 +368,7 @@ extern "C" { #endif // _di_kt_remove_preprocess_file_recurse_ #ifndef _di_kt_remove_preprocess_file_recurse_action_ - void kt_remove_preprocess_file_recurse_action(f_directory_recurse_do_t * const recurse, const f_string_static_t name, const uint16_t flag) { + void kt_remove_preprocess_file_recurse_action(f_directory_recurse_do_t * const recurse, const f_string_static_t name, const uint32_t flag) { if (!recurse || !recurse->state.custom || F_status_set_fine(recurse->state.status) == F_interrupt) return; diff --git a/sources/c/program/kevux/tools/remove/main/preprocess.h b/sources/c/program/kevux/tools/remove/main/preprocess.h index acd81af..f704e70 100644 --- a/sources/c/program/kevux/tools/remove/main/preprocess.h +++ b/sources/c/program/kevux/tools/remove/main/preprocess.h @@ -92,7 +92,7 @@ extern "C" { * @see fl_directory_do() */ #ifndef _di_kt_remove_preprocess_file_recurse_action_ - extern void kt_remove_preprocess_file_recurse_action(f_directory_recurse_do_t * const recurse, const f_string_static_t name, const uint16_t flag); + extern void kt_remove_preprocess_file_recurse_action(f_directory_recurse_do_t * const recurse, const f_string_static_t name, const uint32_t flag); #endif // _di_kt_remove_preprocess_file_recurse_action_ #ifdef __cplusplus diff --git a/sources/c/program/kevux/tools/remove/main/print/debug.c b/sources/c/program/kevux/tools/remove/main/print/debug.c new file mode 100644 index 0000000..904e60d --- /dev/null +++ b/sources/c/program/kevux/tools/remove/main/print/debug.c @@ -0,0 +1,25 @@ +#include "../remove.h" + +#ifdef __cplusplus +extern "C" { +#endif + +#ifndef _di_kt_remove_print_debug_operate_file_remove_ + f_status_t kt_remove_print_debug_operate_file_remove(fl_print_t * const print, const f_string_static_t path, const uint16_t flag) { + + if (!print || !print->custom) return F_status_set_error(F_output_not); + + kt_remove_main_t * const main = (kt_remove_main_t *) print->custom; + + if (main->setting.flag & kt_remove_main_flag_simulate_d) return F_output_not; + if (print->verbosity < f_console_verbosity_debug_e && !(main->setting.flag & kt_remove_main_flag_force_d)) return F_output_not; + + fll_print_format("Removing '%Q'.%r", print->to, path, f_string_eol_s); + + return F_okay; + } +#endif // _di_kt_remove_print_debug_operate_file_remove_ + +#ifdef __cplusplus +} // extern "C" +#endif diff --git a/sources/c/program/kevux/tools/remove/main/print/debug.h b/sources/c/program/kevux/tools/remove/main/print/debug.h new file mode 100644 index 0000000..ff68a71 --- /dev/null +++ b/sources/c/program/kevux/tools/remove/main/print/debug.h @@ -0,0 +1,49 @@ +/** + * Kevux Tools - Remove + * + * Project: Kevux Tools + * API Version: 0.5 + * Licenses: lgpl-2.1-or-later + * + * Provides the print debug functionality. + * + * This is auto-included and should not need to be explicitly included. + */ +#ifndef _kt_remove_print_debug_h +#define _kt_remove_print_debug_h + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * Print file removal message when debug. + * + * @param print + * The output structure to print to. + * + * This locks, uses, and unlocks the file stream. + * + * Must not be NULL. + * + * This does not alter print.custom.setting.state.status. + * @param path + * The path to the file to operate on. + * @param flag + * The file operate flags associated with the file. + * + * @return + * F_okay on success. + * F_output_not on success, but no printing is performed. + * + * F_output_not (with error bit) if setting is NULL. + */ +#ifndef _di_kt_remove_print_debug_operate_file_remove_ + extern f_status_t kt_remove_print_debug_operate_file_remove(fl_print_t * const print, const f_string_static_t path, const uint16_t flag); +#endif // _di_kt_remove_print_debug_operate_file_remove_ + +#ifdef __cplusplus +} // extern "C" +#endif + +#endif // _kt_remove_print_debug_h diff --git a/sources/c/program/kevux/tools/remove/main/print/simulate.c b/sources/c/program/kevux/tools/remove/main/print/simulate.c index 9900a9f..92dbb2f 100644 --- a/sources/c/program/kevux/tools/remove/main/print/simulate.c +++ b/sources/c/program/kevux/tools/remove/main/print/simulate.c @@ -5,13 +5,13 @@ extern "C" { #endif #ifndef _di_kt_remove_print_simulate_operate_ - void kt_remove_print_simulate_operate(fl_print_t * const print) { + f_status_t kt_remove_print_simulate_operate(fl_print_t * const print) { - if (!print || !print->custom) return; + if (!print || !print->custom) return F_status_set_error(F_output_not); kt_remove_main_t * const main = (kt_remove_main_t *) print->custom; - if (!(main->setting.flag & kt_remove_main_flag_simulate_d)) return; + if (!(main->setting.flag & kt_remove_main_flag_simulate_d)) return F_output_not; main->setting.state.status = F_okay; @@ -25,59 +25,65 @@ extern "C" { f_print_dynamic(f_string_eol_s, print->to); - f_file_stream_unlock(main->program.output.to); + f_file_stream_unlock(print->to); + + return F_okay; } #endif // _di_kt_remove_print_simulate_operate_ #ifndef _di_kt_remove_print_simulate_operate_boolean_ - void kt_remove_print_simulate_operate_boolean(fl_print_t * const print, const f_string_static_t name, const bool yes) { + f_status_t kt_remove_print_simulate_operate_boolean(fl_print_t * const print, const f_string_static_t name, const bool yes) { - if (!print || !print->custom) return; + if (!print || !print->custom) return F_status_set_error(F_output_not); kt_remove_main_t * const main = (kt_remove_main_t *) print->custom; - if (!(main->setting.flag & kt_remove_main_flag_simulate_d)) return; + if (!(main->setting.flag & kt_remove_main_flag_simulate_d)) return F_output_not; + + fll_print_format(" %r %r%r", print->to, name, yes ? kt_remove_yes_s : kt_remove_no_s, f_string_eol_s); - fll_print_format(" %r %r%r", main->program.output.to, name, yes ? kt_remove_yes_s : kt_remove_no_s, f_string_eol_s); + return F_okay; } #endif // _di_kt_remove_print_simulate_operate_boolean_ #ifndef _di_kt_remove_print_simulate_operate_file_ - void kt_remove_print_simulate_operate_file(fl_print_t * const print, const f_string_static_t path, const uint16_t flag) { + f_status_t kt_remove_print_simulate_operate_file(fl_print_t * const print, const f_string_static_t path, const uint16_t flag) { - if (!print || !print->custom) return; + if (!print || !print->custom) return F_status_set_error(F_output_not); kt_remove_main_t * const main = (kt_remove_main_t *) print->custom; - if (!(main->setting.flag & kt_remove_main_flag_simulate_d)) return; + if (!(main->setting.flag & kt_remove_main_flag_simulate_d)) return F_output_not; fll_print_format( "%r%[Remove '%Q'%]:%r", - main->program.output.to, + print->to, flag & kt_remove_flag_file_operate_child_d ? f_string_eol_s : f_string_empty_s, - main->program.output.set->notable, + print->set->notable, path, - main->program.output.set->notable, + print->set->notable, f_string_eol_s ); + + return F_okay; } #endif // _di_kt_remove_print_simulate_operate_file_ #ifndef _di_kt_remove_print_simulate_operate_file_exists_ - void kt_remove_print_simulate_operate_file_exists(fl_print_t * const print, const f_string_static_t path, const uint16_t flag) { + f_status_t kt_remove_print_simulate_operate_file_exists(fl_print_t * const print, const f_string_static_t path, const uint16_t flag) { - if (!print || !print->custom) return; + if (!print || !print->custom) return F_status_set_error(F_output_not); kt_remove_main_t * const main = (kt_remove_main_t *) print->custom; - if (!(main->setting.flag & kt_remove_main_flag_simulate_d)) return; + if (!(main->setting.flag & kt_remove_main_flag_simulate_d)) return F_output_not; if (F_status_is_error(main->setting.state.status)) { - fl_print_format(" file_access_failure %ui%r", main->program.output.to, F_status_set_fine(main->setting.state.status), f_string_eol_s); + fl_print_format(" file_access_failure %ui%r", print->to, F_status_set_fine(main->setting.state.status), f_string_eol_s); - return; + return F_status_set_error(F_output_not); } if (flag & kt_remove_flag_file_operate_link_d) { @@ -86,58 +92,60 @@ extern "C" { const f_status_t status = f_file_link_read(path, F_false, &main->cache.buffer); if (F_status_is_error(status)) { - fl_print_format(" link_read_failure %ui%r", main->program.output.to, F_status_set_fine(status), f_string_eol_s); + fl_print_format(" link_read_failure %ui%r", print->to, F_status_set_fine(status), f_string_eol_s); - return; + return F_status_set_error(F_output_not); } - f_file_stream_lock(main->program.output.to); + f_file_stream_lock(print->to); - fl_print_format(" follow %r%r", main->program.output.to, (main->setting.flag & kt_remove_main_flag_follow_d) ? kt_remove_yes_s : kt_remove_no_s, f_string_eol_s); - fl_print_format(" to '%Q'%r", main->program.output.to, main->cache.buffer, f_string_eol_s); + fl_print_format(" follow %r%r", print->to, (main->setting.flag & kt_remove_main_flag_follow_d) ? kt_remove_yes_s : kt_remove_no_s, f_string_eol_s); + fl_print_format(" to '%Q'%r", print->to, main->cache.buffer, f_string_eol_s); - f_file_stream_unlock(main->program.output.to); + f_file_stream_unlock(print->to); } - fll_print_format(" exists %r%r", main->program.output.to, main->setting.state.status == F_true ? kt_remove_yes_s : kt_remove_no_s, f_string_eol_s); + fll_print_format(" exists %r%r", print->to, main->setting.state.status == F_true ? kt_remove_yes_s : kt_remove_no_s, f_string_eol_s); + + return F_okay; } #endif // _di_kt_remove_print_simulate_operate_file_exists_ #ifndef _di_kt_remove_print_simulate_operate_file_stat_ - void kt_remove_print_simulate_operate_file_stat(fl_print_t * const print, struct stat statistics) { + f_status_t kt_remove_print_simulate_operate_file_stat(fl_print_t * const print, struct stat statistics) { - if (!print || !print->custom) return; + if (!print || !print->custom) return F_status_set_error(F_output_not); kt_remove_main_t * const main = (kt_remove_main_t *) print->custom; - if (!(main->setting.flag & kt_remove_main_flag_simulate_d)) return; + if (!(main->setting.flag & kt_remove_main_flag_simulate_d)) return F_output_not; if (main->setting.flag & kt_remove_main_flag_block_d) { - fll_print_format(" block %r%r", main->program.output.to, (macro_f_file_type_get(statistics.st_mode) == F_file_type_block_d) ? kt_remove_yes_s : kt_remove_no_s, f_string_eol_s); + fll_print_format(" block %r%r", print->to, (macro_f_file_type_get(statistics.st_mode) == F_file_type_block_d) ? kt_remove_yes_s : kt_remove_no_s, f_string_eol_s); } if (main->setting.flag & kt_remove_main_flag_character_d) { - fll_print_format(" character %r%r", main->program.output.to, (macro_f_file_type_get(statistics.st_mode) == F_file_type_character_d) ? kt_remove_yes_s : kt_remove_no_s, f_string_eol_s); + fll_print_format(" character %r%r", print->to, (macro_f_file_type_get(statistics.st_mode) == F_file_type_character_d) ? kt_remove_yes_s : kt_remove_no_s, f_string_eol_s); } if (main->setting.flag & kt_remove_main_flag_directory_d) { - fll_print_format(" directory %r%r", main->program.output.to, (macro_f_file_type_get(statistics.st_mode) == F_file_type_directory_d) ? kt_remove_yes_s : kt_remove_no_s, f_string_eol_s); + fll_print_format(" directory %r%r", print->to, (macro_f_file_type_get(statistics.st_mode) == F_file_type_directory_d) ? kt_remove_yes_s : kt_remove_no_s, f_string_eol_s); } if (main->setting.flag & kt_remove_main_flag_fifo_d) { - fll_print_format(" fifo %r%r", main->program.output.to, (macro_f_file_type_get(statistics.st_mode) == F_file_type_fifo_d) ? kt_remove_yes_s : kt_remove_no_s, f_string_eol_s); + fll_print_format(" fifo %r%r", print->to, (macro_f_file_type_get(statistics.st_mode) == F_file_type_fifo_d) ? kt_remove_yes_s : kt_remove_no_s, f_string_eol_s); } if (main->setting.flag & kt_remove_main_flag_link_d) { - fll_print_format(" link %r%r", main->program.output.to, (macro_f_file_type_get(statistics.st_mode) == F_file_type_link_d) ? kt_remove_yes_s : kt_remove_no_s, f_string_eol_s); + fll_print_format(" link %r%r", print->to, (macro_f_file_type_get(statistics.st_mode) == F_file_type_link_d) ? kt_remove_yes_s : kt_remove_no_s, f_string_eol_s); } if (main->setting.flag & kt_remove_main_flag_regular_d) { - fll_print_format(" regular %r%r", main->program.output.to, (macro_f_file_type_get(statistics.st_mode) == F_file_type_regular_d) ? kt_remove_yes_s : kt_remove_no_s, f_string_eol_s); + fll_print_format(" regular %r%r", print->to, (macro_f_file_type_get(statistics.st_mode) == F_file_type_regular_d) ? kt_remove_yes_s : kt_remove_no_s, f_string_eol_s); } if (main->setting.flag & kt_remove_main_flag_socket_d) { - fll_print_format(" socket %r%r", main->program.output.to, (macro_f_file_type_get(statistics.st_mode) == F_file_type_socket_d) ? kt_remove_yes_s : kt_remove_no_s, f_string_eol_s); + fll_print_format(" socket %r%r", print->to, (macro_f_file_type_get(statistics.st_mode) == F_file_type_socket_d) ? kt_remove_yes_s : kt_remove_no_s, f_string_eol_s); } f_number_unsigned_t i = 0; @@ -149,19 +157,19 @@ extern "C" { } // for if (i == main->setting.users.used) { - fll_print_format(" user%r", main->program.output.to, f_string_eol_s); + fll_print_format(" user%r", print->to, f_string_eol_s); } else { - fll_print_format(" user %un%r", main->program.output.to, (f_number_unsigned_t) statistics.st_uid, f_string_eol_s); + fll_print_format(" user %un%r", print->to, (f_number_unsigned_t) statistics.st_uid, f_string_eol_s); } } if (main->setting.flag & kt_remove_main_flag_same_d) { - fll_print_format(" same %r%r", main->program.output.to, (statistics.st_uid == geteuid()) ? kt_remove_yes_s : kt_remove_no_s, f_string_eol_s); + fll_print_format(" same %r%r", print->to, (statistics.st_uid == geteuid()) ? kt_remove_yes_s : kt_remove_no_s, f_string_eol_s); } if (main->setting.flag & kt_remove_main_flag_different_d) { - fll_print_format(" different %r%r", main->program.output.to, (statistics.st_uid == geteuid()) ? kt_remove_no_s : kt_remove_yes_s, f_string_eol_s); + fll_print_format(" different %r%r", print->to, (statistics.st_uid == geteuid()) ? kt_remove_no_s : kt_remove_yes_s, f_string_eol_s); } if (main->setting.flag & kt_remove_main_flag_group_d) { @@ -170,17 +178,17 @@ extern "C" { } // for if (i == main->setting.groups.used) { - fll_print_format(" group%r", main->program.output.to, f_string_eol_s); + fll_print_format(" group%r", print->to, f_string_eol_s); } else { - fll_print_format(" group %un%r", main->program.output.to, (f_number_unsigned_t) statistics.st_gid, f_string_eol_s); + fll_print_format(" group %un%r", print->to, (f_number_unsigned_t) statistics.st_gid, f_string_eol_s); } } if (main->setting.flag & kt_remove_main_flag_mode_d) { const mode_t mode = statistics.st_mode & F_file_mode_all_d; - fll_print_format(" mode %@03un%r", main->program.output.to, (f_number_unsigned_t) mode, f_string_eol_s); + fll_print_format(" mode %@03un%r", print->to, (f_number_unsigned_t) mode, f_string_eol_s); for (i = 0; i < main->setting.modes.used; ++i) { @@ -216,7 +224,7 @@ extern "C" { for (j = 0; j < 4; ++j) { if (main->setting.modes.array[i].type == types[j]) { - fll_print_format(" mode_matched %Q %@03un%r", main->program.output.to, strings[j], (f_number_unsigned_t) main->setting.modes.array[i].mode, f_string_eol_s); + fll_print_format(" mode_matched %Q %@03un%r", print->to, strings[j], (f_number_unsigned_t) main->setting.modes.array[i].mode, f_string_eol_s); break; } @@ -256,7 +264,7 @@ extern "C" { for (i = 0; i < dates[j]->used; ++i) { - if (kt_remove_signal_check(main)) return; + if (kt_remove_signal_check(main)) return F_status_set_error(F_interrupt); match_year = kt_remove_time_year_unix_epoch_d + (times[j].tv_sec / kt_remove_time_seconds_in_year_d); match_second = times[j].tv_sec % kt_remove_time_seconds_in_year_d; @@ -448,28 +456,32 @@ extern "C" { } if (name_type.used) { - fll_print_format(" %Q %Q ", main->program.output.to, *names[j], result ? kt_remove_yes_s : kt_remove_no_s); - fll_print_format("%u::%un 0:%un %Q ", main->program.output.to, match_year, (f_number_unsigned_t) times[j].tv_sec, (f_number_unsigned_t) times[j].tv_nsec, name_type); - fll_print_format("%u::%un 0:%un%r", main->program.output.to, dates[j]->array[i].start_year, dates[j]->array[i].start_second, dates[j]->array[i].start_nanosecond, f_string_eol_s); + fll_print_format(" %Q %Q ", print->to, *names[j], result ? kt_remove_yes_s : kt_remove_no_s); + fll_print_format("%u::%un 0:%un %Q ", print->to, match_year, (f_number_unsigned_t) times[j].tv_sec, (f_number_unsigned_t) times[j].tv_nsec, name_type); + fll_print_format("%u::%un 0:%un%r", print->to, dates[j]->array[i].start_year, dates[j]->array[i].start_second, dates[j]->array[i].start_nanosecond, f_string_eol_s); break; } } // for } // for } + + return F_okay; } #endif // _di_kt_remove_print_simulate_operate_file_stat_ #ifndef _di_kt_remove_print_simulate_operate_prompt_once_ - void kt_remove_print_simulate_operate_prompt_once(fl_print_t * const print, const bool yes) { + f_status_t kt_remove_print_simulate_operate_prompt_once(fl_print_t * const print, const bool yes) { - if (!print || !print->custom) return; + if (!print || !print->custom) return F_status_set_error(F_output_not); kt_remove_main_t * const main = (kt_remove_main_t *) print->custom; - if (!(main->setting.flag & kt_remove_main_flag_simulate_d)) return; + if (!(main->setting.flag & kt_remove_main_flag_simulate_d)) return F_output_not; + + fll_print_format(" %r %r%r", print->to, kt_remove_prompt_s, yes ? kt_remove_once_s : kt_remove_no_s, f_string_eol_s); - fll_print_format(" %r %r%r", main->program.output.to, kt_remove_prompt_s, yes ? kt_remove_once_s : kt_remove_no_s, f_string_eol_s); + return F_okay; } #endif // _di_kt_remove_print_simulate_operate_prompt_once_ diff --git a/sources/c/program/kevux/tools/remove/main/print/simulate.h b/sources/c/program/kevux/tools/remove/main/print/simulate.h index 99dfa4a..16e3e7f 100644 --- a/sources/c/program/kevux/tools/remove/main/print/simulate.h +++ b/sources/c/program/kevux/tools/remove/main/print/simulate.h @@ -29,9 +29,15 @@ extern "C" { * Must not be NULL. * * This does not alter print.custom.setting.state.status. + * + * @return + * F_okay on success. + * F_output_not on success, but no printing is performed. + * + * F_output_not (with error bit) if setting is NULL. */ #ifndef _di_kt_remove_print_simulate_operate_ - extern void kt_remove_print_simulate_operate(fl_print_t * const print); + extern f_status_t kt_remove_print_simulate_operate(fl_print_t * const print); #endif // _di_kt_remove_print_simulate_operate_ /** @@ -52,9 +58,15 @@ extern "C" { * @param yes * If TRUE, then print "yes". * If FALSE, then print "no". + * + * @return + * F_okay on success. + * F_output_not on success, but no printing is performed. + * + * F_output_not (with error bit) if setting is NULL. */ #ifndef _di_kt_remove_print_simulate_operate_boolean_ - extern void kt_remove_print_simulate_operate_boolean(fl_print_t * const print, const f_string_static_t name, const bool yes); + extern f_status_t kt_remove_print_simulate_operate_boolean(fl_print_t * const print, const f_string_static_t name, const bool yes); #endif // _di_kt_remove_print_simulate_operate_boolean_ /** @@ -75,9 +87,15 @@ extern "C" { * @param flag * The file operate flags associated with the file. * The kt_remove_flag_file_operate_link_d is of specific interest here. + * + * @return + * F_okay on success. + * F_output_not on success, but no printing is performed. + * + * F_output_not (with error bit) if setting is NULL. */ #ifndef _di_kt_remove_print_simulate_operate_file_ - extern void kt_remove_print_simulate_operate_file(fl_print_t * const print, const f_string_static_t path, const uint16_t flag); + extern f_status_t kt_remove_print_simulate_operate_file(fl_print_t * const print, const f_string_static_t path, const uint16_t flag); #endif // _di_kt_remove_print_simulate_operate_file_ /** @@ -98,9 +116,15 @@ extern "C" { * @param flag * The file operate flags associated with the file. * The kt_remove_flag_file_operate_link_d is of specific interest here. + * + * @return + * F_okay on success. + * F_output_not on success, but no printing is performed. + * + * F_output_not (with error bit) if setting is NULL. */ #ifndef _di_kt_remove_print_simulate_operate_file_exists_ - extern void kt_remove_print_simulate_operate_file_exists(fl_print_t * const print, const f_string_static_t path, const uint16_t flag); + extern f_status_t kt_remove_print_simulate_operate_file_exists(fl_print_t * const print, const f_string_static_t path, const uint16_t flag); #endif // _di_kt_remove_print_simulate_operate_file_exists_ /** @@ -118,9 +142,15 @@ extern "C" { * This does not alter print.custom.setting.state.status. * @param statistics * The file statistics. + * + * @return + * F_okay on success. + * F_output_not on success, but no printing is performed. + * + * F_output_not (with error bit) if setting is NULL. */ #ifndef _di_kt_remove_print_simulate_operate_file_stat_ - extern void kt_remove_print_simulate_operate_file_stat(fl_print_t * const print, struct stat statistics); + extern f_status_t kt_remove_print_simulate_operate_file_stat(fl_print_t * const print, struct stat statistics); #endif // _di_kt_remove_print_simulate_operate_file_stat_ /** @@ -139,9 +169,15 @@ extern "C" { * @param yes * If TRUE, then print "once". * If FALSE, then print "no". + * + * @return + * F_okay on success. + * F_output_not on success, but no printing is performed. + * + * F_output_not (with error bit) if setting is NULL. */ #ifndef _di_kt_remove_print_simulate_operate_prompt_once_ - extern void kt_remove_print_simulate_operate_prompt_once(fl_print_t * const print, const bool yes); + extern f_status_t kt_remove_print_simulate_operate_prompt_once(fl_print_t * const print, const bool yes); #endif // _di_kt_remove_print_simulate_operate_prompt_once_ #ifdef __cplusplus diff --git a/sources/c/program/kevux/tools/remove/main/print/verbose.c b/sources/c/program/kevux/tools/remove/main/print/verbose.c index 7a21078..0c605a1 100644 --- a/sources/c/program/kevux/tools/remove/main/print/verbose.c +++ b/sources/c/program/kevux/tools/remove/main/print/verbose.c @@ -4,6 +4,22 @@ extern "C" { #endif +#ifndef _di_kt_remove_print_verbose_operate_file_remove_ + f_status_t kt_remove_print_verbose_operate_file_remove(fl_print_t * const print, const f_string_static_t path, const uint16_t flag) { + + if (!print || !print->custom) return F_status_set_error(F_output_not); + + kt_remove_main_t * const main = (kt_remove_main_t *) print->custom; + + if (main->setting.flag & kt_remove_main_flag_simulate_d) return F_output_not; + if (print->verbosity < f_console_verbosity_verbose_e && !(main->setting.flag & kt_remove_main_flag_force_d)) return F_output_not; + + fll_print_format("Removed '%Q'.%r", print->to, path, f_string_eol_s); + + return F_okay; + } +#endif // _di_kt_remove_print_verbose_operate_file_remove_ + #ifdef __cplusplus } // extern "C" #endif diff --git a/sources/c/program/kevux/tools/remove/main/print/verbose.h b/sources/c/program/kevux/tools/remove/main/print/verbose.h index 8fb3661..d8051c5 100644 --- a/sources/c/program/kevux/tools/remove/main/print/verbose.h +++ b/sources/c/program/kevux/tools/remove/main/print/verbose.h @@ -16,6 +16,32 @@ extern "C" { #endif +/** + * Print file removal message when verbose. + * + * @param print + * The output structure to print to. + * + * This locks, uses, and unlocks the file stream. + * + * Must not be NULL. + * + * This does not alter print.custom.setting.state.status. + * @param path + * The path to the file to operate on. + * @param flag + * The file operate flags associated with the file. + * + * @return + * F_okay on success. + * F_output_not on success, but no printing is performed. + * + * F_output_not (with error bit) if setting is NULL. + */ +#ifndef _di_kt_remove_print_verbose_operate_file_remove_ + extern f_status_t kt_remove_print_verbose_operate_file_remove(fl_print_t * const print, const f_string_static_t path, const uint16_t flag); +#endif // _di_kt_remove_print_verbose_operate_file_remove_ + #ifdef __cplusplus } // extern "C" #endif diff --git a/sources/c/program/kevux/tools/remove/main/remove.h b/sources/c/program/kevux/tools/remove/main/remove.h index fd8f6ba..0eed1fc 100644 --- a/sources/c/program/kevux/tools/remove/main/remove.h +++ b/sources/c/program/kevux/tools/remove/main/remove.h @@ -59,6 +59,7 @@ #include #include #include +#include #include #include #include diff --git a/sources/c/program/kevux/tools/remove/remove/main.c b/sources/c/program/kevux/tools/remove/remove/main.c index c68cf2d..7c635ec 100644 --- a/sources/c/program/kevux/tools/remove/remove/main.c +++ b/sources/c/program/kevux/tools/remove/remove/main.c @@ -87,7 +87,10 @@ int kt_remove_main_delete(&data); - fll_program_standard_set_down(&data.program); + // Must not close the standard I/O during testing. + #ifndef _kt_MOCK_MAIN_NAME + fll_program_standard_set_down(&data.program); + #endif // _kt_MOCK_MAIN_NAME return (F_status_is_error(data.setting.state.status) || data.setting.state.status == F_false) ? 1 : 0; } diff --git a/tests/unit/remove/c/mock-remove.c b/tests/unit/remove/c/mock-remove.c index 217056f..3153283 100644 --- a/tests/unit/remove/c/mock-remove.c +++ b/tests/unit/remove/c/mock-remove.c @@ -7,6 +7,15 @@ extern "C" { int mock_unwrap = 0; f_status_t mock_status = 0; +f_status_t __wrap_f_directory_remove(const f_string_static_t path, const int depth_max, const bool preserve) { + + const bool failure = mock_type(bool); + + if (failure) return mock_type(f_status_t); + + return mock_type(f_status_t); +} + f_status_t __wrap_f_file_exists(const f_string_static_t path, const bool dereference) { const bool failure = mock_type(bool); diff --git a/tests/unit/remove/c/mock-remove.h b/tests/unit/remove/c/mock-remove.h index 25065b4..7693110 100644 --- a/tests/unit/remove/c/mock-remove.h +++ b/tests/unit/remove/c/mock-remove.h @@ -32,6 +32,8 @@ const static int mock_errno_generic = 32767; extern int mock_unwrap; extern f_status_t mock_status; +extern f_status_t __wrap_f_directory_remove(const f_string_static_t path, const int depth_max, const bool preserve); + extern f_status_t __wrap_f_file_exists(const f_string_static_t path, const bool dereference); extern f_status_t __wrap_f_file_remove(const f_string_static_t path); diff --git a/tests/unit/remove/c/test-remove-print_version.h b/tests/unit/remove/c/test-remove-print_version.h index 18c6328..48d24b5 100644 --- a/tests/unit/remove/c/test-remove-print_version.h +++ b/tests/unit/remove/c/test-remove-print_version.h @@ -5,7 +5,7 @@ * API Version: 0.5 * Licenses: lgpl-2.1-or-later * - * Test the --help parameter. + * Test the --version parameter. */ #ifndef _TEST__KT_remove__print_version #define _TEST__KT_remove__print_version diff --git a/tests/unit/remove/c/test-remove-regular_no_args.c b/tests/unit/remove/c/test-remove-regular_no_args.c new file mode 100644 index 0000000..bceed4f --- /dev/null +++ b/tests/unit/remove/c/test-remove-regular_no_args.c @@ -0,0 +1,34 @@ +#include "test-remove.h" +#include "test-remove-regular_no_args.h" + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +void test__kt_remove__regular_no_args__works(void **state) { + + mock_unwrap = 0; + + { + const f_string_t argv[] = { "mocked_main", "to_remove", 0 }; + + mock_status = F_okay; + + will_return(__wrap_f_file_exists, F_false); + will_return(__wrap_f_file_exists, F_false); + + // @todo this is incomplete. + //will_return(__wrap_f_file_remove, F_test); + + const int result = kt_main_test__remove(2, argv, 0); + + assert_int_equal(result, 0); + assert_int_equal(mock_status, F_okay); + } +} + +#ifdef __cplusplus +} // extern "C" +#endif diff --git a/tests/unit/remove/c/test-remove-regular_no_args.h b/tests/unit/remove/c/test-remove-regular_no_args.h new file mode 100644 index 0000000..4f39503 --- /dev/null +++ b/tests/unit/remove/c/test-remove-regular_no_args.h @@ -0,0 +1,18 @@ +/** + * Kevux Tools - Remove + * + * Project: Kevux Tools + * API Version: 0.5 + * Licenses: lgpl-2.1-or-later + * + * Test the remove. + */ +#ifndef _TEST__KT_remove__regular_no_args +#define _TEST__KT_remove__regular_no_args + +/** + * Test that the remove works, for regular files without other arguments. + */ +extern void test__kt_remove__regular_no_args__works(void **state); + +#endif // _TEST__KT_remove__regular_no_args diff --git a/tests/unit/remove/c/test-remove.c b/tests/unit/remove/c/test-remove.c index 57422ee..f948bdd 100644 --- a/tests/unit/remove/c/test-remove.c +++ b/tests/unit/remove/c/test-remove.c @@ -21,6 +21,8 @@ int main(void) { const struct CMUnitTest tests[] = { cmocka_unit_test(test__kt_remove__print_help__works), cmocka_unit_test(test__kt_remove__print_version__works), + + cmocka_unit_test(test__kt_remove__regular_no_args__works), }; return cmocka_run_group_tests(tests, setup, setdown); diff --git a/tests/unit/remove/c/test-remove.h b/tests/unit/remove/c/test-remove.h index 727ca44..6bfd56e 100644 --- a/tests/unit/remove/c/test-remove.h +++ b/tests/unit/remove/c/test-remove.h @@ -32,6 +32,7 @@ // Test includes. #include "test-remove-print_help.h" #include "test-remove-print_version.h" +#include "test-remove-regular_no_args.h" #ifdef __cplusplus extern "C" { -- 1.8.3.1