From: Kevin Day Date: Sat, 8 Mar 2025 05:37:15 +0000 (-0600) Subject: Progress: Continue working on completing the remove program. X-Git-Url: https://git.kevux.org/?a=commitdiff_plain;h=cf7ad88181c8213d401d9af6208062e82d741e28;p=kevux-tools Progress: Continue working on completing the remove program. This adds the beginnings of the runtime, unit test like, testing. This approach for a runtime test is being done to make mocking functions easier. The goal here is to not have actual files created and especially to have no files actually deleted. If the delete doesn't work properly, then there should be no consequences due to not actually running any real deletes. The current state of this simply tests the help and version parameters. I chose this as a way to hash out the process that I am going to use. This fixes a mistake in the individual library link name for `-lfl_directory`. Remove unused `kt_remove_main_t *main ` declaration. Fix documentation comments for several header files. --- diff --git a/data/build/remove/defines b/data/build/remove/defines index f0c01ed..9be7691 100644 --- a/data/build/remove/defines +++ b/data/build/remove/defines @@ -7,3 +7,5 @@ _en_kt_process_path_ Enable support for processing that process path, such as /p _en_kt_default_to_utc_ Default to UTC mode rather than local time. _use_timegm_ Enable use of timegm() rather than trying to perform the calculations manually. + +_kt_MOCK_MAIN_NAME Used for runtime testing to rename the "main" program to link it as a library without conflicting with "main" in the test program. diff --git a/data/build/remove/dependencies-tests b/data/build/remove/dependencies-tests new file mode 100644 index 0000000..dea3179 --- /dev/null +++ b/data/build/remove/dependencies-tests @@ -0,0 +1,3 @@ +# fss-0001 + +cmocka 1.* diff --git a/data/build/remove/settings b/data/build/remove/settings index 67ce870..de961d4 100644 --- a/data/build/remove/settings +++ b/data/build/remove/settings @@ -38,7 +38,7 @@ build_language c build_libraries -lc build_libraries-individual -lfll_error -lfll_print -lfll_program -build_libraries-individual -lfl_conversion -fl_directory -lfl_path -lfl_print +build_libraries-individual -lfl_conversion -lfl_directory -lfl_path -lfl_print build_libraries-individual -lf_account -lf_color -lf_compare -lf_console -lf_conversion -lf_directory -lf_file -lf_memory -lf_path -lf_pipe -lf_print -lf_rip -lf_signal -lf_string -lf_time -lf_type_array -lf_utf build_libraries-individual_thread -lf_thread build_libraries-level -lfll_2 -lfll_1 -lfll_0 diff --git a/data/build/remove/settings-mocks.remove b/data/build/remove/settings-mocks.remove new file mode 100644 index 0000000..bb762a1 --- /dev/null +++ b/data/build/remove/settings-mocks.remove @@ -0,0 +1,91 @@ +# fss-0001 +# +# Build the project with appropriate mocks linked in via the dynamic linker's "--wrap" functionality. +# +# The -Wl,--wrap does not work across shared files. +# Therefore, this file is a work-around to inject the mocks into the library for testing purposes. +# This should exactly match the "settings" file, except for the additional "-Wl,--wrap" parts and the additional mock source file. +# +# The flags -o0 must be passed to prevent the compiler from optimizing away any functions being mocked (which results in the mock not happening and a real function being called). +# Alternatively, figure out which optimization that is disabled by -o0 and have that specific optimization disabled. +# + +build_name remove +stage mocks-remove + +version_major 0 +version_minor 5 +version_micro 0 +version_file micro +version_target minor + +modes android clang coverage fanalyzer gcc gcc_13 individual individual_thread test thread threadless +modes_default individual individual_thread test thread gcc + +build_compiler gcc +build_compiler-clang clang +build_indexer ar +build_indexer_arguments rcs +build_language c + +build_libraries -lc +build_libraries-individual -lfll_error -lfll_print -lfll_program +build_libraries-individual -lfl_conversion -lfl_directory -lfl_print +build_libraries-individual -lf_account -lf_color -lf_compare -lf_console -lf_conversion -lf_directory -lf_file -lf_memory -lf_path -lf_pipe -lf_print -lf_rip -lf_signal -lf_string -lf_time -lf_type_array -lf_utf +build_libraries-individual_thread -lf_thread + +build_sources_library remove.c main.c string.c +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_script no +build_shared yes +build_static no + +path_headers program/kevux/tools/remove/remove +path_sources sources/c/program/kevux/tools/remove/remove + +has_path_standard no +preserve_path_headers yes + +search_exclusive yes +search_shared yes +search_static yes + +environment PATH LD_LIBRARY_PATH +environment LANG LC_ALL LC_COLLATE LC_CTYPE LC_FASTMSG LC_MESSAGES LC_MONETARY LC_NUMERIC LC_TIME LOCPATH NLSPATH + +#defines -D_di_libcap_ +defines -D_libcap_legacy_only_ +defines-android -D_di_f_thread_attribute_affinity_get_ -D_di_f_thread_attribute_affinity_set_ -D_di_f_thread_attribute_concurrency_get_ -D_di_f_thread_attribute_concurrency_set_ -D_di_f_thread_attribute_default_get_ -D_di_f_thread_attribute_default_set_ -D_di_f_thread_cancel_ -D_di_f_thread_cancel_state_set_ -D_di_f_thread_cancel_test_ -D_di_f_thread_join_try_ -D_di_f_thread_join_timed_ -D_pthread_mutex_prioceiling_unsupported_ -D_di_f_thread_semaphore_file_close_ -D_di_f_thread_semaphore_file_open_ -D_di_f_thread_semaphore_file_delete_ -D_di_f_thread_cancel_type_set_ +defines-threadless -D_di_thread_support_ +defines-thread -D_pthread_attr_unsupported_ -D_pthread_sigqueue_unsupported_ + +# This is needed for glibc and strptime() usage. +defines -D_GNU_SOURCE=1 + +# Designate renaming the main() for tests. +defines-test -D_kt_MOCK_MAIN_NAME + +flags -O0 -g -fdiagnostics-color=always -Wno-logical-not-parentheses -Wno-parentheses -Wno-missing-braces +flags -fstack-clash-protection -fno-delete-null-pointer-checks +flags -Wl,-z,nodlopen -Wl,-z,noexecstack -Wl,-z,relro -Wl,-z,now +flags-android -Wno-implicit-function-declaration -Wl,-z,norelro +flags-clang -Wno-logical-op-parentheses +flags-coverage -O0 --coverage -fprofile-abs-path -fprofile-dir=build/coverage/ +flags-fanalyzer -fanalyzer +flags-gcc_13 -fstrict-flex-arrays=3 +flags-test -O0 -fstack-protector-strong -Wall +flags-thread -pthread + +flags_library -fPIC +flags_program-android -fPIE -Wl,-z,relro + +# Inject mocks. +flags -Wl,--wrap=f_file_exists +flags -Wl,--wrap=f_file_remove +flags -Wl,--wrap=fll_program_print_version +flags -Wl,--wrap=kt_remove_print_message_help diff --git a/data/build/remove/settings-objects b/data/build/remove/settings-objects new file mode 100644 index 0000000..d45c367 --- /dev/null +++ b/data/build/remove/settings-objects @@ -0,0 +1,85 @@ +# fss-0001 +# +# Builds the remove library of the project as objects for use in tests. +# +# Modes: +# - android: Compile on an android system (using Termux; may need modification depending on the android system). +# - clang: Use CLang rather than the default, which is generally GCC. +# - coverage: Compile for building coverage. +# - fanalyzer: Compile using GCC's -fanalyzer compile time option. +# - gcc: Use GCC specific settings. +# - gcc_13: Use gcc version 13 or greater specific settings. +# - individual: Compile using per project (individual) libraries, does not handle thread or threadless cases. +# - individual_thread: This is required when compiling in individual mode with "thread" mode. +# - level: Compile using per level libraries. +# - monolithic: Compile using per monolithic libraries. +# - test: Compile for a test, such as unit testing. +# - thread: Compile with thread support. +# - threadless: Compile without thread support. +# + +build_name remove +stage remove + +version_major 0 +version_minor 5 +version_micro 0 +version_file micro +version_target minor + +modes android clang coverage fanalyzer gcc gcc_13 individual individual_thread level monolithic test thread threadless +modes_default individual individual_thread test thread gcc + +build_compiler gcc +build_compiler-clang clang +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_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_documentation man + +build_script yes +build_shared yes +build_static no + +path_headers program/kevux/tools/remove/main +path_sources sources/c/program/kevux/tools/remove/main + +has_path_standard no +preserve_path_headers yes + +search_exclusive yes +search_shared yes +search_static yes + +environment PATH LD_LIBRARY_PATH +environment LANG LC_ALL LC_COLLATE LC_CTYPE LC_FASTMSG LC_MESSAGES LC_MONETARY LC_NUMERIC LC_TIME LOCPATH NLSPATH + +#defines -D_di_libcap_ +defines -D_libcap_legacy_only_ +defines -D_use_timegm_ +defines-android -D_di_f_thread_attribute_affinity_get_ -D_di_f_thread_attribute_affinity_set_ -D_di_f_thread_attribute_concurrency_get_ -D_di_f_thread_attribute_concurrency_set_ -D_di_f_thread_attribute_default_get_ -D_di_f_thread_attribute_default_set_ -D_di_f_thread_cancel_ -D_di_f_thread_cancel_state_set_ -D_di_f_thread_cancel_test_ -D_di_f_thread_join_try_ -D_di_f_thread_join_timed_ -D_pthread_mutex_prioceiling_unsupported_ -D_di_f_thread_semaphore_file_close_ -D_di_f_thread_semaphore_file_open_ -D_di_f_thread_semaphore_file_delete_ -D_di_f_thread_cancel_type_set_ +defines-threadless -D_di_thread_support_ +defines-thread -D_pthread_attr_unsupported_ -D_pthread_sigqueue_unsupported_ + +# This is needed for glibc and strptime() usage. +defines -D_GNU_SOURCE=1 + +flags -O0 -g -fdiagnostics-color=always -Wno-logical-not-parentheses -Wno-parentheses -Wno-missing-braces +flags -fstack-clash-protection -fno-delete-null-pointer-checks +flags -Wl,-z,nodlopen -Wl,-z,noexecstack -Wl,-z,relro -Wl,-z,now +flags-android -Wno-implicit-function-declaration -Wl,-z,norelro +flags-clang -Wno-logical-op-parentheses +flags-coverage -O0 --coverage -fprofile-abs-path -fprofile-dir=build/coverage/ +flags-fanalyzer -fanalyzer +flags-gcc_13 -fstrict-flex-arrays=3 +flags-test -O0 -fstack-protector-strong -Wall +flags-thread -pthread + +flags_library -fPIC +flags_object -fPIC +flags_program-android -fPIE -Wl,-z,relro diff --git a/data/build/remove/settings-tests.remove b/data/build/remove/settings-tests.remove new file mode 100644 index 0000000..8f1881e --- /dev/null +++ b/data/build/remove/settings-tests.remove @@ -0,0 +1,81 @@ +# fss-0001 +# +# Builds a program that is links to the generated library and is executed to perform tests. +# +# Memory leaks in the test program can be checked for by running valgrind with this executable. +# + +build_name test-remove +stage test-remove + +version_major 0 +version_minor 5 +version_micro 0 +version_file micro +version_target minor + +modes android clang coverage fanalyzer gcc gcc_13 individual individual_thread test thread threadless +modes_default individual individual_thread test thread gcc + +build_compiler gcc +build_compiler-clang clang +build_indexer ar +build_indexer_arguments rcs +build_language c + +build_libraries -lc -lcmocka -lremove +build_libraries-individual -lfll_error -lfll_print -lfll_program +build_libraries-individual -lfl_conversion -lfl_directory -lfl_path -lfl_print +build_libraries-individual -lf_account -lf_color -lf_compare -lf_console -lf_conversion -lf_directory -lf_file -lf_memory -lf_path -lf_pipe -lf_print -lf_rip -lf_signal -lf_string -lf_time -lf_type_array -lf_utf +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_script no +build_shared yes +build_static no + +path_headers tests/unit/remove/c +path_sources tests/unit/remove/c + +has_path_standard no +preserve_path_headers yes + +search_exclusive yes +search_shared yes +search_static yes + +environment PATH LD_LIBRARY_PATH +environment LANG LC_ALL LC_COLLATE LC_CTYPE LC_FASTMSG LC_MESSAGES LC_MONETARY LC_NUMERIC LC_TIME LOCPATH NLSPATH + +defines -Ibuild/includes +defines_static -Lbuild/libraries/static +defines_shared -Lbuild/libraries/shared + +#defines -D_di_libcap_ +defines -D_libcap_legacy_only_ +defines -D_use_timegm_ +defines-android -D_di_f_thread_attribute_affinity_get_ -D_di_f_thread_attribute_affinity_set_ -D_di_f_thread_attribute_concurrency_get_ -D_di_f_thread_attribute_concurrency_set_ -D_di_f_thread_attribute_default_get_ -D_di_f_thread_attribute_default_set_ -D_di_f_thread_cancel_ -D_di_f_thread_cancel_state_set_ -D_di_f_thread_cancel_test_ -D_di_f_thread_join_try_ -D_di_f_thread_join_timed_ -D_pthread_mutex_prioceiling_unsupported_ -D_di_f_thread_semaphore_file_close_ -D_di_f_thread_semaphore_file_open_ -D_di_f_thread_semaphore_file_delete_ -D_di_f_thread_cancel_type_set_ +defines-threadless -D_di_thread_support_ +defines-thread -D_pthread_attr_unsupported_ -D_pthread_sigqueue_unsupported_ + +# This is needed for glibc and strptime() usage. +defines -D_GNU_SOURCE=1 + +# Designate renaming the main() for tests. +defines-test -D_kt_MOCK_MAIN_NAME + +flags -O2 -g -fdiagnostics-color=always -Wno-logical-not-parentheses -Wno-parentheses -Wno-missing-braces +flags -fstack-clash-protection -fno-delete-null-pointer-checks +flags -Wl,-z,nodlopen -Wl,-z,noexecstack -Wl,-z,relro -Wl,-z,now +flags-android -Wno-implicit-function-declaration -Wl,-z,norelro +flags-clang -Wno-logical-op-parentheses +flags-coverage -O0 --coverage -fprofile-abs-path -fprofile-dir=build/coverage/ +flags-fanalyzer -fanalyzer +flags-gcc_13 -fstrict-flex-arrays=3 +flags-test -O0 -fstack-protector-strong -Wall +flags-thread -pthread + +flags_program -fPIE +flags_program-android -fPIE -Wl,-z,relro diff --git a/data/build/remove/settings.remove b/data/build/remove/settings.remove index 4f4e975..6144799 100644 --- a/data/build/remove/settings.remove +++ b/data/build/remove/settings.remove @@ -38,7 +38,7 @@ build_language c build_libraries -lc -lremove build_libraries-individual -lfll_error -lfll_print -lfll_program -build_libraries-individual -lfl_conversion -fl_directory -lfl_print +build_libraries-individual -lfl_conversion -lfl_directory -lfl_print build_libraries-individual -lf_account -lf_color -lf_compare -lf_console -lf_conversion -lf_directory -lf_file -lf_memory -lf_path -lf_pipe -lf_print -lf_rip -lf_signal -lf_string -lf_time -lf_type_array -lf_utf build_libraries-individual_thread -lf_thread build_libraries-level -lfll_2 -lfll_1 -lfll_0 diff --git a/data/build/remove/testfile b/data/build/remove/testfile new file mode 100644 index 0000000..9397d82 --- /dev/null +++ b/data/build/remove/testfile @@ -0,0 +1,79 @@ +# fss-0005 iki-0002 +# +# Performs runtime testing, which includes building the program. +# +# To keep things simple, this only runs tests against fss_read. +# + +settings: + load_build yes + fail exit + + environment PATH LD_LIBRARY_PATH + environment LANG LC_ALL LC_COLLATE LC_CTYPE LC_FASTMSG LC_MESSAGES LC_MONETARY LC_NUMERIC LC_TIME LOCPATH NLSPATH + environment CMOCKA_XML_FILE CMOCKA_MESSAGE_OUTPUT CMOCKA_TEST_ABORT + + # Cmocka is not fully thread-safe, set this to "1" to have cmocka call abort() on a test failure. + #define CMOCKA_TEST_ABORT 1 + + # One of: STDOUT, SUBUNIT, TAP, or XML. + #define CMOCKA_MESSAGE_OUTPUT STDOUT + + # When in "XML" output mode, output to this file rather than stdout. + #define CMOCKA_XML_FILE ./out.xml + +main: + build settings-objects + build settings-mocks.remove + build settings-tests.remove + + operate build_path + operate ld_library_path + + if exist parameter:"build_path"programs/shared/test-remove + shell parameter:"build_path"programs/shared/test-remove + + if exist parameter:"build_path"programs/static/test-remove + shell parameter:"build_path"programs/static/test-remove + + if not exist parameter:"build_path"programs/shared/test-remove + and not exist parameter:"build_path"programs/static/test-remove + operate not_created + +not_created: + print + print 'context:"error"Failed to test due to being unable to find either a shared or static test binary to perform tests.[context]:"reset"' + + exit failure + +build_path: + parameter build_path build/ + + if parameter build:value + parameter build_path parameter:"build:value" + +ld_library_path: + if define LD_LIBRARY_PATH + and parameter work:value + define LD_LIBRARY_PATH 'parameter:"build_path"libraries/shared:parameter:"work:value"libraries/shared:define:"LD_LIBRARY_PATH"' + + else + if define LD_LIBRARY_PATH + define LD_LIBRARY_PATH 'parameter:"build_path"libraries/shared:define:"LD_LIBRARY_PATH"' + + else + if parameter work:value + define LD_LIBRARY_PATH 'parameter:"build_path"libraries/shared:parameter:"work:value"libraries/shared' + + else + define LD_LIBRARY_PATH 'parameter:"build_path"libraries/shared' + +help: + print + print context:'title'Fakefile Options for Kevux Tools Remove Software Testing.context:'reset' + print + + print + print The following operations are available\: + print " - context:'notable'help:context:'reset' Perform the help operation, printing this message." + print " - context:'notable'main:context:'reset' Build the and run the tests." diff --git a/sources/c/program/kevux/tools/remove/main/print/error.c b/sources/c/program/kevux/tools/remove/main/print/error.c index d61395f..9f90db8 100644 --- a/sources/c/program/kevux/tools/remove/main/print/error.c +++ b/sources/c/program/kevux/tools/remove/main/print/error.c @@ -120,8 +120,6 @@ extern "C" { if (!print) return F_status_set_error(F_output_not); if (print->verbosity < f_console_verbosity_error_e) return F_output_not; - kt_remove_main_t *main = (kt_remove_main_t *) print->custom; - f_file_stream_lock(print->to); fl_print_format("%[%QMax recursion of", print->to, print->set->error, print->prefix, print->set->error, f_string_eol_s); diff --git a/sources/c/program/kevux/tools/remove/remove/main.c b/sources/c/program/kevux/tools/remove/remove/main.c index 751df4e..c68cf2d 100644 --- a/sources/c/program/kevux/tools/remove/remove/main.c +++ b/sources/c/program/kevux/tools/remove/remove/main.c @@ -5,7 +5,13 @@ extern "C" { #endif -int main(const int argc, const f_string_t *argv, const f_string_t *envp) { +int + #ifndef _kt_MOCK_MAIN_NAME + main + #else + kt_main_test__remove + #endif +(const int argc, const f_string_t *argv, const f_string_t *envp) { kt_remove_main_t data = kt_remove_main_t_initialize; diff --git a/sources/c/program/kevux/tools/remove/remove/main.h b/sources/c/program/kevux/tools/remove/remove/main.h index 3cd9474..eea85e4 100644 --- a/sources/c/program/kevux/tools/remove/remove/main.h +++ b/sources/c/program/kevux/tools/remove/remove/main.h @@ -29,7 +29,13 @@ extern "C" { * 0 on success. * 1 on error. */ -extern int main(const int argc, const f_string_t *argv, const f_string_t *envp); +extern int + #ifndef _kt_MOCK_MAIN_NAME + main + #else + kt_main_test__remove + #endif +(const int argc, const f_string_t *argv, const f_string_t *envp); #ifdef __cplusplus } // extern "C" diff --git a/sources/c/program/kevux/tools/remove/remove/remove.h b/sources/c/program/kevux/tools/remove/remove/remove.h index 1ff2e3b..0afbc8d 100644 --- a/sources/c/program/kevux/tools/remove/remove/remove.h +++ b/sources/c/program/kevux/tools/remove/remove/remove.h @@ -1,8 +1,8 @@ /** - * FLL - Level 3 + * Kevux Tools - Remove * * Project: Kevux Tools - * API Version: 0.7 + * API Version: 0.5 * Licenses: lgpl-2.1-or-later * * This program provides the base include for the remove program. diff --git a/sources/c/program/kevux/tools/remove/remove/string.h b/sources/c/program/kevux/tools/remove/remove/string.h index 1bacfb7..4675d46 100644 --- a/sources/c/program/kevux/tools/remove/remove/string.h +++ b/sources/c/program/kevux/tools/remove/remove/string.h @@ -1,8 +1,8 @@ /** - * FLL - Level 3 + * Kevux Tools - Remove * * Project: Kevux Tools - * API Version: 0.7 + * API Version: 0.5 * Licenses: lgpl-2.1-or-later * * Provides the common string structures for the remove program. diff --git a/sources/c/program/kevux/tools/tacocat/tacocat/main.h b/sources/c/program/kevux/tools/tacocat/tacocat/main.h index 6ce45d0..142f26e 100644 --- a/sources/c/program/kevux/tools/tacocat/tacocat/main.h +++ b/sources/c/program/kevux/tools/tacocat/tacocat/main.h @@ -1,5 +1,5 @@ /** - * Kevux Tools - Remove + * Kevux Tools - TacoCat * * Project: Kevux Tools * API Version: 0.5 diff --git a/sources/c/program/kevux/tools/tacocat/tacocat/string.h b/sources/c/program/kevux/tools/tacocat/tacocat/string.h index 4a22795..ee85ffa 100644 --- a/sources/c/program/kevux/tools/tacocat/tacocat/string.h +++ b/sources/c/program/kevux/tools/tacocat/tacocat/string.h @@ -1,8 +1,8 @@ /** - * FLL - Level 3 + * Kevux Tools - TacoCat * * Project: Kevux Tools - * API Version: 0.7 + * API Version: 0.5 * Licenses: lgpl-2.1-or-later * * Provides the common string structures for the tacocat program. diff --git a/sources/c/program/kevux/tools/tacocat/tacocat/tacocat.h b/sources/c/program/kevux/tools/tacocat/tacocat/tacocat.h index 35d528c..29f486e 100644 --- a/sources/c/program/kevux/tools/tacocat/tacocat/tacocat.h +++ b/sources/c/program/kevux/tools/tacocat/tacocat/tacocat.h @@ -1,8 +1,8 @@ /** - * FLL - Level 3 + * Kevux Tools - TacoCat * * Project: Kevux Tools - * API Version: 0.7 + * API Version: 0.5 * Licenses: lgpl-2.1-or-later * * This program provides the base include for the tacocat program. diff --git a/tests/unit/remove/c/main-test-remove.c b/tests/unit/remove/c/main-test-remove.c new file mode 100644 index 0000000..66bcd74 --- /dev/null +++ b/tests/unit/remove/c/main-test-remove.c @@ -0,0 +1,90 @@ +#include "main-test-remove.h" + +#ifdef __cplusplus +extern "C" { +#endif + +int main_test__remove(const int argc, const f_string_t *argv, const f_string_t *envp) { + + kt_remove_main_t data = kt_remove_main_t_initialize; + + data.program.debug.flag |= kt_remove_print_flag_debug_d | kt_remove_print_flag_out_d; + data.program.error.flag |= kt_remove_print_flag_error_d | kt_remove_print_flag_out_d; + data.program.message.flag |= kt_remove_print_flag_message_d | kt_remove_print_flag_out_d; + data.program.output.flag |= kt_remove_print_flag_out_d; + data.program.warning.flag |= kt_remove_print_flag_warning_d | kt_remove_print_flag_out_d; + data.program.message.custom = (void *) &data; + data.program.output.custom = (void *) &data; + data.program.error.custom = (void *) &data; + data.program.warning.custom = (void *) &data; + data.program.debug.custom = (void *) &data; + + data.setting.state.data = (void *) &data; + data.setting.program_name = &kt_remove_program_name_s; + data.setting.program_name_long = &kt_remove_program_name_long_s; + + data.call.print_help = &kt_remove_print_message_help; + data.call.process_normal = &kt_remove_process_normal_operate; + + #ifdef _en_kt_default_to_utc_ + data.setting.flag |= kt_remove_flag_utc_d; + #endif // _en_kt_default_to_utc_ + + f_console_parameter_t parameters[] = kt_remove_console_parameter_t_initialize; + + data.program.parameters.array = parameters; + data.program.parameters.used = kt_remove_total_parameters_d; + data.program.environment = envp; + + if (f_pipe_input_exists()) { + data.program.pipe = fll_program_data_pipe_input_e; + } + + fll_program_standard_set_up(&data.program); + + #ifdef _di_thread_support_ + { + const f_console_arguments_t arguments = macro_f_console_arguments_t_initialize_1(argc, argv, envp); + + kt_remove_setting_load(arguments, &data); + } + + kt_remove_main(&data); + #else + { + f_thread_id_t id_signal; + + memset(&id_signal, 0, sizeof(f_thread_id_t)); + + data.setting.state.status = f_thread_create(0, &id_signal, &kt_remove_thread_signal, (void *) &data); + + if (F_status_is_error(data.setting.state.status)) { + kt_remove_print_error(&data.program.error, macro_kt_remove_f(f_thread_create)); + } + else { + { + const f_console_arguments_t arguments = macro_f_console_arguments_t_initialize_1(argc, argv, envp); + + kt_remove_setting_load(arguments, &data); + } + + if (!kt_remove_signal_check(&data)) { + kt_remove_main(&data); + } + + f_thread_cancel(id_signal); + f_thread_join(id_signal, 0); + } + } + #endif // _di_thread_support_ + + kt_remove_main_delete(&data); + + fll_program_standard_set_down(&data.program); + + return (F_status_is_error(data.setting.state.status) || data.setting.state.status == F_false) ? 1 : 0; +} + +#ifdef __cplusplus +} // extern "C" +#endif diff --git a/tests/unit/remove/c/main-test-remove.h b/tests/unit/remove/c/main-test-remove.h new file mode 100644 index 0000000..018c6b6 --- /dev/null +++ b/tests/unit/remove/c/main-test-remove.h @@ -0,0 +1,41 @@ +/** + * Kevux Tools - Remove + * + * Project: Kevux Tools + * API Version: 0.5 + * Licenses: lgpl-2.1-or-later + * + * Provide a main function wrapper. + */ +#ifndef _MAIN_TEST__remove_h +#define _MAIN_TEST__remove_h + +// Remove includes. +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * Wrapped program entry point. + * + * @param argc + * The number of arguments. + * @param argv + * The array of arguments. + * @param envp + * The array of all environment variables on program start. + * + * @return + * 0 on success. + * 1 on error. + */ +extern int main_test__remove(const int argc, const f_string_t *argv, const f_string_t *envp); + +#ifdef __cplusplus +} // extern "C" +#endif + +#endif // _MAIN_TEST__remove_h diff --git a/tests/unit/remove/c/mock-remove.c b/tests/unit/remove/c/mock-remove.c new file mode 100644 index 0000000..217056f --- /dev/null +++ b/tests/unit/remove/c/mock-remove.c @@ -0,0 +1,44 @@ +#include "mock-remove.h" + +#ifdef __cplusplus +extern "C" { +#endif + +int mock_unwrap = 0; +f_status_t mock_status = 0; + +f_status_t __wrap_f_file_exists(const f_string_static_t path, const bool dereference) { + + 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_remove(const f_string_static_t path) { + + const bool failure = mock_type(bool); + + if (failure) return mock_type(f_status_t); + + return mock_type(f_status_t); +} + +f_status_t __wrap_fll_program_print_version(fl_print_t * const print, const f_string_static_t version) { + + mock_status = mock_type(f_status_t); + + return mock_status; +} + +f_status_t __wrap_kt_remove_print_message_help(fl_print_t * const print, const f_color_context_t context) { + + mock_status = mock_type(f_status_t); + + return mock_status; +} + +#ifdef __cplusplus +} // extern "C" +#endif diff --git a/tests/unit/remove/c/mock-remove.h b/tests/unit/remove/c/mock-remove.h new file mode 100644 index 0000000..25065b4 --- /dev/null +++ b/tests/unit/remove/c/mock-remove.h @@ -0,0 +1,46 @@ +/** + * Kevux Tools - Remove + * + * Project: Kevux Tools + * API Version: 0.5 + * Licenses: lgpl-2.1-or-later + * + * Test the remove project. + */ +#ifndef _MOCK__remove_h +#define _MOCK__remove_h + +// Libc includes. +#include +#include +#include +#include + +// cmocka includes. +#include + +// Remove includes. +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +const static int mock_errno_generic = 32767; + +extern int mock_unwrap; +extern f_status_t mock_status; + +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); + +extern f_status_t __wrap_fll_program_print_version(fl_print_t * const print, const f_string_static_t version); + +extern f_status_t __wrap_kt_remove_print_message_help(fl_print_t * const print, const f_color_context_t context); + +#ifdef __cplusplus +} // extern "C" +#endif + +#endif // _MOCK__remove_h diff --git a/tests/unit/remove/c/test-remove-print_help.c b/tests/unit/remove/c/test-remove-print_help.c new file mode 100644 index 0000000..19bc06a --- /dev/null +++ b/tests/unit/remove/c/test-remove-print_help.c @@ -0,0 +1,43 @@ +#include "test-remove.h" +#include "test-remove-print_help.h" + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +void test__kt_remove__print_help__works(void **state) { + + mock_unwrap = 0; + + { + const f_string_t argv[] = { "mocked_main", "--help", 0 }; + + mock_status = F_okay; + + will_return(__wrap_kt_remove_print_message_help, F_test); + + const int result = kt_main_test__remove(2, argv, 0); + + assert_int_equal(result, 0); + assert_int_equal(mock_status, F_test); + } + + { + const f_string_t argv[] = { "mocked_main", "-h", 0 }; + + mock_status = F_okay; + + will_return(__wrap_kt_remove_print_message_help, F_test); + + const int result = kt_main_test__remove(2, argv, 0); + + assert_int_equal(result, 0); + assert_int_equal(mock_status, F_test); + } +} + +#ifdef __cplusplus +} // extern "C" +#endif diff --git a/tests/unit/remove/c/test-remove-print_help.h b/tests/unit/remove/c/test-remove-print_help.h new file mode 100644 index 0000000..5ca4eed --- /dev/null +++ b/tests/unit/remove/c/test-remove-print_help.h @@ -0,0 +1,18 @@ +/** + * Kevux Tools - Remove + * + * Project: Kevux Tools + * API Version: 0.5 + * Licenses: lgpl-2.1-or-later + * + * Test the --help parameter. + */ +#ifndef _TEST__KT_remove__print_help +#define _TEST__KT_remove__print_help + +/** + * Test that the --help parameter works. + */ +extern void test__kt_remove__print_help__works(void **state); + +#endif // _TEST__KT_remove__print_help diff --git a/tests/unit/remove/c/test-remove-print_version.c b/tests/unit/remove/c/test-remove-print_version.c new file mode 100644 index 0000000..7008407 --- /dev/null +++ b/tests/unit/remove/c/test-remove-print_version.c @@ -0,0 +1,43 @@ +#include "test-remove.h" +#include "test-remove-print_version.h" + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +void test__kt_remove__print_version__works(void **state) { + + mock_unwrap = 0; + + { + const f_string_t argv[] = { "mocked_main", "++version", 0 }; + + mock_status = F_okay; + + will_return(__wrap_fll_program_print_version, F_test); + + const int result = kt_main_test__remove(2, argv, 0); + + assert_int_equal(result, 0); + assert_int_equal(mock_status, F_test); + } + + { + const f_string_t argv[] = { "mocked_main", "+v", 0 }; + + mock_status = F_okay; + + will_return(__wrap_fll_program_print_version, F_test); + + const int result = kt_main_test__remove(2, argv, 0); + + assert_int_equal(result, 0); + assert_int_equal(mock_status, F_test); + } +} + +#ifdef __cplusplus +} // extern "C" +#endif diff --git a/tests/unit/remove/c/test-remove-print_version.h b/tests/unit/remove/c/test-remove-print_version.h new file mode 100644 index 0000000..18c6328 --- /dev/null +++ b/tests/unit/remove/c/test-remove-print_version.h @@ -0,0 +1,18 @@ +/** + * Kevux Tools - Remove + * + * Project: Kevux Tools + * API Version: 0.5 + * Licenses: lgpl-2.1-or-later + * + * Test the --help parameter. + */ +#ifndef _TEST__KT_remove__print_version +#define _TEST__KT_remove__print_version + +/** + * Test that the ++version parameter works. + */ +extern void test__kt_remove__print_version__works(void **state); + +#endif // _TEST__KT_remove__print_version diff --git a/tests/unit/remove/c/test-remove.c b/tests/unit/remove/c/test-remove.c new file mode 100644 index 0000000..57422ee --- /dev/null +++ b/tests/unit/remove/c/test-remove.c @@ -0,0 +1,31 @@ +#include "test-remove.h" + +#ifdef __cplusplus +extern "C" { +#endif + +int setup(void **state) { + + return 0; +} + +int setdown(void **state) { + + errno = 0; + + return 0; +} + +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), + }; + + return cmocka_run_group_tests(tests, setup, setdown); +} + +#ifdef __cplusplus +} // extern "C" +#endif diff --git a/tests/unit/remove/c/test-remove.h b/tests/unit/remove/c/test-remove.h new file mode 100644 index 0000000..727ca44 --- /dev/null +++ b/tests/unit/remove/c/test-remove.h @@ -0,0 +1,77 @@ +/** + * Kevux Tools - Remove + * + * Project: Kevux Tools + * API Version: 0.5 + * Licenses: lgpl-2.1-or-later + * + * Test the remove project. + */ +#ifndef _TEST__F_remove_h +#define _TEST__F_remove_h + +// Libc includes. +#include +#include +#include +#include + +// cmocka includes. +#include + +// Remove includes. +#include +#include + +// Mock includes. +#include "mock-remove.h" + +// Main includes. +#include "main-test-remove.h" + +// Test includes. +#include "test-remove-print_help.h" +#include "test-remove-print_version.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * Perform any setup operations. + * + * @param state + * The test state. + * + * @return + * The status of this function, where 0 means success. + */ +extern int setup(void **state); + +/** + * Peform any setdown operations. + * + * @param state + * The test state. + * + * @return + * The status of this function, where 0 means success. + */ +extern int setdown(void **state); + +/** + * Run all tests. + * + * @return + * The final result of the tests. + * + * @see cmocka_run_group_tests() + * @see cmocka_unit_test() + */ +extern int main(void); + +#ifdef __cplusplus +} // extern "C" +#endif + +#endif // _TEST__F_remove_h