From 70bccf002ca53a83cbe6a1e741c709d8eec84d26 Mon Sep 17 00:00:00 2001 From: fdai7514 Date: Thu, 9 Feb 2023 00:50:02 +0100 Subject: [PATCH 1/4] implement function calculatorDivide() --- project.yml | 101 ++++++++++++++++++++++++++++++++++ src/calculatorDivide.c | 2 + src/calculatorDivide.h | 8 +++ src/main.c | 19 ++++++- tests/support/.gitkeep | 0 tests/test_calculatorDivide.c | 20 +++++++ 6 files changed, 147 insertions(+), 3 deletions(-) create mode 100644 project.yml create mode 100644 src/calculatorDivide.c create mode 100644 src/calculatorDivide.h create mode 100644 tests/support/.gitkeep create mode 100644 tests/test_calculatorDivide.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/calculatorDivide.c b/src/calculatorDivide.c new file mode 100644 index 0000000..c6abdcf --- /dev/null +++ b/src/calculatorDivide.c @@ -0,0 +1,2 @@ +#include "calculatorDivide.h" +float calculatorDivide(float x, float y){return x/y;} diff --git a/src/calculatorDivide.h b/src/calculatorDivide.h new file mode 100644 index 0000000..e33d7ef --- /dev/null +++ b/src/calculatorDivide.h @@ -0,0 +1,8 @@ +#ifndef CALCULATORDIVIDE_H +#define CALCULATORDIVIDE_H +#include +#include +float calculatorDivide(float x, float y); + + +#endif // CALCULATORDIVIDE_H diff --git a/src/main.c b/src/main.c index a3a8e04..72023c8 100644 --- a/src/main.c +++ b/src/main.c @@ -1,4 +1,17 @@ -#include -int main(){ -return 0; +#include "calculatorDivide.c" +int main() +{ + float num1, num2, quotient; + + printf("number1: "); + scanf("%f", &num1); + + printf("number2: "); + scanf("%f", &num2); + + quotient = calculatorDivide(num1, num2); + + printf("answer: %f", quotient); + return 0; } + diff --git a/tests/support/.gitkeep b/tests/support/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/tests/test_calculatorDivide.c b/tests/test_calculatorDivide.c new file mode 100644 index 0000000..d18118f --- /dev/null +++ b/tests/test_calculatorDivide.c @@ -0,0 +1,20 @@ +#ifdef TEST + +#include "unity.h" + +#include "calculatorDivide.h" + +void setUp(void) +{ +} + +void tearDown(void) +{ +} + +void test_calculatorDivide_NeedToImplement(void) +{ + TEST_IGNORE_MESSAGE("Need to Implement calculatorDivide"); +} + +#endif // TEST From b0acd83da21a082c4ca8fdab32f497dec77deac7 Mon Sep 17 00:00:00 2001 From: fdai7514 Date: Thu, 9 Feb 2023 00:51:50 +0100 Subject: [PATCH 2/4] implement unittest for calculatorDivide.c --- build-project.sh | 1 + tests/test_calculatorDivide.c | 100 +++++++++++++++++++++++++++++++++- 2 files changed, 99 insertions(+), 2 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_calculatorDivide.c b/tests/test_calculatorDivide.c index d18118f..1894d0b 100644 --- a/tests/test_calculatorDivide.c +++ b/tests/test_calculatorDivide.c @@ -12,9 +12,105 @@ void tearDown(void) { } -void test_calculatorDivide_NeedToImplement(void) +void test1_calculatorDivide(void) { - TEST_IGNORE_MESSAGE("Need to Implement calculatorDivide"); + float p, q, a, e; + p = 26.24; + q = 23.22; + a = calculatorDivide(p, q); + e = p/q; + TEST_ASSERT_EQUAL_FLOAT(e, a); } +void test2_calculatorDivide(void) +{ + float p, q, a, e; + p = 2236.24; + q = 2123.22; + a = calculatorDivide(p, q); + e = p/q; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + +void test3_calculatorDivide(void) +{ + float p, q, a, e; + p = 623.2; + q = 23.22; + a = calculatorDivide(p, q); + e = p/q; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + +void test4_calculatorDivide(void) +{ + float p, q, a, e; + p = 234.7; + q = 124.2; + a = calculatorDivide(p, q); + e = p/q; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + +void test5_calculatorDivide(void) +{ + float p, q, a, e; + p = 26207.2; + q = 278.23; + a = calculatorDivide(p, q); + e = p/q; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + +void test6_calculatorDivide(void) +{ + float p, q, a, e; + p = 111; + q = 21; + a = calculatorDivide(p, q); + e = p/q; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + +void test7_calculatorDivide(void) +{ + float p, q, a, e; + p = 167; + q = 23.22; + a = calculatorDivide(p, q); + e = p/q; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + +void test8_calculatorDivide(void) +{ + float p, q, a, e; + p = 26124; + q = 23022; + a = calculatorDivide(p, q); + e = p/q; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + +void test9_calculatorDivide(void) +{ + float p, q, a, e; + p = 1234; + q = 4321; + a = calculatorDivide(p, q); + e = p/q; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + +void test10_calculatorDivide(void) +{ + float p, q, a, e; + p = 2345; + q = 123.7; + a = calculatorDivide(p, q); + e = p/q; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + + #endif // TEST From a9cda3ff44d238c88e7705b561407e590855b304 Mon Sep 17 00:00:00 2001 From: fdai7514 Date: Mon, 6 Feb 2023 20:15:10 +0100 Subject: [PATCH 3/4] refactoring: change variable names and format code in calculatorDivide.c --- src/calculatorDivide.c | 11 ++++++++++- src/calculatorDivide.h | 2 +- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/src/calculatorDivide.c b/src/calculatorDivide.c index c6abdcf..86e0a5c 100644 --- a/src/calculatorDivide.c +++ b/src/calculatorDivide.c @@ -1,2 +1,11 @@ #include "calculatorDivide.h" -float calculatorDivide(float x, float y){return x/y;} +// 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 */ + + +float calculatorDivide(float num1, float num2) +{ + return num1 / num2; +} + diff --git a/src/calculatorDivide.h b/src/calculatorDivide.h index e33d7ef..18c242e 100644 --- a/src/calculatorDivide.h +++ b/src/calculatorDivide.h @@ -2,7 +2,7 @@ #define CALCULATORDIVIDE_H #include #include -float calculatorDivide(float x, float y); +float calculatorDivide(float num1, float num2); #endif // CALCULATORDIVIDE_H From a975931afbf773dfa4bf66fdf9bb9dbf8e16f992 Mon Sep 17 00:00:00 2001 From: fdai7514 Date: Mon, 6 Feb 2023 20:22:00 +0100 Subject: [PATCH 4/4] refactoring: change variable names in test_calculatorDivide.c --- tests/test_calculatorDivide.c | 126 ++++++++++++++++++---------------- 1 file changed, 66 insertions(+), 60 deletions(-) diff --git a/tests/test_calculatorDivide.c b/tests/test_calculatorDivide.c index 1894d0b..dca5c49 100644 --- a/tests/test_calculatorDivide.c +++ b/tests/test_calculatorDivide.c @@ -4,6 +4,11 @@ #include "calculatorDivide.h" +// 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,103 +19,104 @@ void tearDown(void) void test1_calculatorDivide(void) { - float p, q, a, e; - p = 26.24; - q = 23.22; - a = calculatorDivide(p, q); - e = p/q; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual, expected; //Arrange + num1 = 26.24; + num2 = 23.22; + expected = num1 / num2; + actual = calculatorDivide(num1, num2); //Act + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test2_calculatorDivide(void) { - float p, q, a, e; - p = 2236.24; - q = 2123.22; - a = calculatorDivide(p, q); - e = p/q; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual, expected; //Arrange + num1 = 2236.24; + num2 = 2123.22; + expected = num1 / num2; + actual = calculatorDivide(num1, num2); //Act + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test3_calculatorDivide(void) { - float p, q, a, e; - p = 623.2; - q = 23.22; - a = calculatorDivide(p, q); - e = p/q; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual, expected; //Arrange + num1 = 623.2; + num2 = 23.22; + expected = num1 / num2; + actual = calculatorDivide(num1, num2); //Act + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test4_calculatorDivide(void) { - float p, q, a, e; - p = 234.7; - q = 124.2; - a = calculatorDivide(p, q); - e = p/q; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual, expected; //Arrange + num1 = 234.7; + num2 = 124.2; + expected = num1 / num2; + actual = calculatorDivide(num1, num2); //Act + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test5_calculatorDivide(void) { - float p, q, a, e; - p = 26207.2; - q = 278.23; - a = calculatorDivide(p, q); - e = p/q; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual, expected; //Arrange + num1 = 26207.2; + num2 = 278.23; + expected = num1 / num2; + actual = calculatorDivide(num1, num2); //Act + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test6_calculatorDivide(void) { - float p, q, a, e; - p = 111; - q = 21; - a = calculatorDivide(p, q); - e = p/q; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual, expected; //Arrange + num1 = 111; + num2 = 21; + expected = num1 / num2; + actual = calculatorDivide(num1, num2); //Act + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test7_calculatorDivide(void) { - float p, q, a, e; - p = 167; - q = 23.22; - a = calculatorDivide(p, q); - e = p/q; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual, expected; //Arrange + num1 = 167; + num2 = 23.22; + expected = num1 / num2; + actual = calculatorDivide(num1, num2); //Act + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test8_calculatorDivide(void) { - float p, q, a, e; - p = 26124; - q = 23022; - a = calculatorDivide(p, q); - e = p/q; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual, expected; //Arrange + num1 = 26124; + num2 = 23022; + expected = num1 / num2; + actual = calculatorDivide(num1, num2); //Act + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test9_calculatorDivide(void) { - float p, q, a, e; - p = 1234; - q = 4321; - a = calculatorDivide(p, q); - e = p/q; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual, expected; //Arrange + num1 = 1234; + num2 = 4321; + expected = num1 / num2; + actual = calculatorDivide(num1, num2); //Act + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test10_calculatorDivide(void) { - float p, q, a, e; - p = 2345; - q = 123.7; - a = calculatorDivide(p, q); - e = p/q; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual, expected; //Arrange + num1 = 2345; + num2 = 123.7; + expected = num1 / num2; + actual = calculatorDivide(num1, num2); //Act + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } + #endif // TEST