From acdfb400b329b06c740f3fc599f8054c1852bf38 Mon Sep 17 00:00:00 2001 From: fdai7514 Date: Thu, 9 Feb 2023 02:10:47 +0100 Subject: [PATCH 1/4] implement function calculatorGetUserInputFactorial() --- project.yml | 101 +++++++++++++++++++ src/calculatorGetUserInputFactorial.c | 16 +++ src/calculatorGetUserInputFactorial.h | 10 ++ src/main.c | 10 +- tests/support/.gitkeep | 0 tests/test_calculatorGetUserInputFactorial.c | 20 ++++ 6 files changed, 154 insertions(+), 3 deletions(-) create mode 100644 project.yml create mode 100644 src/calculatorGetUserInputFactorial.c create mode 100644 src/calculatorGetUserInputFactorial.h create mode 100644 tests/support/.gitkeep create mode 100644 tests/test_calculatorGetUserInputFactorial.c diff --git a/project.yml b/project.yml new file mode 100644 index 0000000..640cb8f --- /dev/null +++ b/project.yml @@ -0,0 +1,101 @@ +--- + +# Notes: +# Sample project C code is not presently written to produce a release artifact. +# As such, release build options are disabled. +# This sample, therefore, only demonstrates running a collection of unit tests. + +:project: + :use_exceptions: FALSE + :use_test_preprocessor: TRUE + :use_auxiliary_dependencies: TRUE + :build_root: build +# :release_build: TRUE + :test_file_prefix: test_ + :which_ceedling: gem + :ceedling_version: 0.31.1 + :default_tasks: + - test:all + +#:test_build: +# :use_assembly: TRUE + +#:release_build: +# :output: MyApp.out +# :use_assembly: FALSE + +:environment: + +:extension: + :executable: .out + +:paths: + :test: + - +:tests/** + - -:tests/support + :source: + - src/** + :support: + - tests/support + :libraries: [] + +:defines: + # in order to add common defines: + # 1) remove the trailing [] from the :common: section + # 2) add entries to the :common: section (e.g. :test: has TEST defined) + :common: &common_defines [] + :test: + - *common_defines + - TEST + :test_preprocess: + - *common_defines + - TEST + +:cmock: + :mock_prefix: mock_ + :when_no_prototypes: :warn + :enforce_strict_ordering: TRUE + :plugins: + - :ignore + - :callback + :treat_as: + uint8: HEX8 + uint16: HEX16 + uint32: UINT32 + int8: INT8 + bool: UINT8 + +# Add -gcov to the plugins list to make sure of the gcov plugin +# You will need to have gcov and gcovr both installed to make it work. +# For more information on these options, see docs in plugins/gcov +:gcov: + :reports: + - HtmlDetailed + :gcovr: + :html_medium_threshold: 75 + :html_high_threshold: 90 + +#:tools: +# Ceedling defaults to using gcc for compiling, linking, etc. +# As [:tools] is blank, gcc will be used (so long as it's in your system path) +# See documentation to configure a given toolchain for use + +# LIBRARIES +# These libraries are automatically injected into the build process. Those specified as +# common will be used in all types of builds. Otherwise, libraries can be injected in just +# tests or releases. These options are MERGED with the options in supplemental yaml files. +:libraries: + :placement: :end + :flag: "-l${1}" + :path_flag: "-L ${1}" + :system: [] # for example, you might list 'm' to grab the math library + :test: [] + :release: [] + +:plugins: + :load_paths: + - "#{Ceedling.load_path}" + :enabled: + - stdout_pretty_tests_report + - module_generator +... diff --git a/src/calculatorGetUserInputFactorial.c b/src/calculatorGetUserInputFactorial.c new file mode 100644 index 0000000..661e1ec --- /dev/null +++ b/src/calculatorGetUserInputFactorial.c @@ -0,0 +1,16 @@ +#include "calculatorGetUserInputFactorial.h" +int allowWhen() +{ + if(q == 1) + return 1; +} + +void calculatorGetUserInputFactorial(int *z) +{ + if(allowWhen() == 1) + { + printf("num: "); + scanf("%d", z); + } +} + diff --git a/src/calculatorGetUserInputFactorial.h b/src/calculatorGetUserInputFactorial.h new file mode 100644 index 0000000..272bb52 --- /dev/null +++ b/src/calculatorGetUserInputFactorial.h @@ -0,0 +1,10 @@ +#ifndef CALCULATORGETUSERINPUTFACTORIAL_H +#define CALCULATORGETUSERINPUTFACTORIAL_H +#include +#include +int allowWhen(); +const int q = 1; +void calculatorGetUserInputFactorial(int *z); + + +#endif // CALCULATORGETUSERINPUTFACTORIAL_H diff --git a/src/main.c b/src/main.c index a3a8e04..2180373 100644 --- a/src/main.c +++ b/src/main.c @@ -1,4 +1,8 @@ -#include -int main(){ -return 0; +#include "calculatorGetUserInputFactorial.c" +int main() +{ + int userInput; + calculatorGetUserInputFactorial(&userInput); + printf("Your Input is %d", userInput); + return 0; } diff --git a/tests/support/.gitkeep b/tests/support/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/tests/test_calculatorGetUserInputFactorial.c b/tests/test_calculatorGetUserInputFactorial.c new file mode 100644 index 0000000..2e0ff2c --- /dev/null +++ b/tests/test_calculatorGetUserInputFactorial.c @@ -0,0 +1,20 @@ +#ifdef TEST + +#include "unity.h" + +#include "calculatorGetUserInputFactorial.h" + +void setUp(void) +{ +} + +void tearDown(void) +{ +} + +void test_calculatorGetUserInputFactorial_NeedToImplement(void) +{ + TEST_IGNORE_MESSAGE("Need to Implement calculatorGetUserInputFactorial"); +} + +#endif // TEST From 0e355995fcdad00462b1c8940c627b192adb7958 Mon Sep 17 00:00:00 2001 From: fdai7514 Date: Thu, 9 Feb 2023 02:12:43 +0100 Subject: [PATCH 2/4] implement unittest for calculatorGetUserInputFactorial.c --- build-project.sh | 1 + tests/test_calculatorGetUserInputFactorial.c | 9 ++++++--- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/build-project.sh b/build-project.sh index 43a0588..51cf723 100755 --- a/build-project.sh +++ b/build-project.sh @@ -1,4 +1,5 @@ clear +ceedling test:all cd src/ gcc main.c -o main ./main diff --git a/tests/test_calculatorGetUserInputFactorial.c b/tests/test_calculatorGetUserInputFactorial.c index 2e0ff2c..5a42adb 100644 --- a/tests/test_calculatorGetUserInputFactorial.c +++ b/tests/test_calculatorGetUserInputFactorial.c @@ -2,7 +2,7 @@ #include "unity.h" -#include "calculatorGetUserInputFactorial.h" +#include "calculatorGetUserInputFactorial.c" void setUp(void) { @@ -12,9 +12,12 @@ void tearDown(void) { } -void test_calculatorGetUserInputFactorial_NeedToImplement(void) +void test_calculatorGetUserInputFactorial(void) { - TEST_IGNORE_MESSAGE("Need to Implement calculatorGetUserInputFactorial"); + int a, e; + e = 1; + a = allowWhen(); + TEST_ASSERT_EQUAL_INT(e, a); } #endif // TEST From b796599129a05667e4436601ecd4e23a017e39f1 Mon Sep 17 00:00:00 2001 From: fdai7514 Date: Tue, 7 Feb 2023 16:47:02 +0100 Subject: [PATCH 3/4] refactoring: change variable names and attach descriptive comments in calculatorGetUserInputFactorial.c --- src/calculatorGetUserInputFactorial.c | 14 +++++++++----- src/calculatorGetUserInputFactorial.h | 4 ++-- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/src/calculatorGetUserInputFactorial.c b/src/calculatorGetUserInputFactorial.c index 661e1ec..0f556e8 100644 --- a/src/calculatorGetUserInputFactorial.c +++ b/src/calculatorGetUserInputFactorial.c @@ -1,16 +1,20 @@ #include "calculatorGetUserInputFactorial.h" -int allowWhen() +// Note: +/* This Function may or may not be implemented in actual program, even if it is merged to the main branch. + If it is temporarily not included in the main Program, then this has a role in future Development of the Project */ + +int allowWhen()// int allowWhen() is helpful for indirectly unittesting void calculatorGetUserInputFactorial() { - if(q == 1) + if(utc == 1) return 1; } -void calculatorGetUserInputFactorial(int *z) +void calculatorGetUserInputFactorial(int *num) { - if(allowWhen() == 1) + if(allowWhen() == 1)//Only when int allowWhen() returns 1, void calculatorGetUserInputFactorial() will display desired Output { printf("num: "); - scanf("%d", z); + scanf("%d", num); } } diff --git a/src/calculatorGetUserInputFactorial.h b/src/calculatorGetUserInputFactorial.h index 272bb52..d8da77c 100644 --- a/src/calculatorGetUserInputFactorial.h +++ b/src/calculatorGetUserInputFactorial.h @@ -3,8 +3,8 @@ #include #include int allowWhen(); -const int q = 1; -void calculatorGetUserInputFactorial(int *z); +const int utc = 1; //ufc is unitTestConstant, which has a role in unittesting void calculatorGetUserInputFactorial() +void calculatorGetUserInputFactorial(int *num); #endif // CALCULATORGETUSERINPUTFACTORIAL_H From 7fd2d0e3aa950e130732752611d02b9994d04b19 Mon Sep 17 00:00:00 2001 From: fdai7514 Date: Tue, 7 Feb 2023 16:50:14 +0100 Subject: [PATCH 4/4] refactoring: change variable names in test_calculatorGetUserInputFactorial.c --- tests/test_calculatorGetUserInputFactorial.c | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/tests/test_calculatorGetUserInputFactorial.c b/tests/test_calculatorGetUserInputFactorial.c index 5a42adb..b9a2e91 100644 --- a/tests/test_calculatorGetUserInputFactorial.c +++ b/tests/test_calculatorGetUserInputFactorial.c @@ -4,6 +4,10 @@ #include "calculatorGetUserInputFactorial.c" +// Note: +/* This Function may or may not be implemented in actual program, even if it is merged to the main branch. + If it is temporarily not included in the main Program, then this has a role in future Development of the Project */ + void setUp(void) { } @@ -14,10 +18,10 @@ void tearDown(void) void test_calculatorGetUserInputFactorial(void) { - int a, e; - e = 1; - a = allowWhen(); - TEST_ASSERT_EQUAL_INT(e, a); + int actual, expected; //Arrange + expected = 1; + actual = allowWhen(); //Act + TEST_ASSERT_EQUAL_INT(expected, actual); //Assert } #endif // TEST