From bce3b53bb80e58ff37563f36929fc84e0af840a7 Mon Sep 17 00:00:00 2001 From: fdai7514 Date: Wed, 8 Feb 2023 23:46:24 +0100 Subject: [PATCH 1/4] implement function calculatorAdd() --- project.yml | 101 +++++++++++++++++++++++++++++++++++++ src/calculatorAdd.c | 5 ++ src/calculatorAdd.h | 6 +++ src/main.c | 20 ++++++-- tests/support/.gitkeep | 0 tests/test_calculatorAdd.c | 20 ++++++++ 6 files changed, 149 insertions(+), 3 deletions(-) create mode 100644 project.yml create mode 100644 src/calculatorAdd.c create mode 100644 src/calculatorAdd.h create mode 100644 tests/support/.gitkeep create mode 100644 tests/test_calculatorAdd.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/calculatorAdd.c b/src/calculatorAdd.c new file mode 100644 index 0000000..781e507 --- /dev/null +++ b/src/calculatorAdd.c @@ -0,0 +1,5 @@ +#include "calculatorAdd.h" + +float calculatorAdd(float x,float y) +{return x+y;} + diff --git a/src/calculatorAdd.h b/src/calculatorAdd.h new file mode 100644 index 0000000..443a906 --- /dev/null +++ b/src/calculatorAdd.h @@ -0,0 +1,6 @@ +#ifndef CALCULATORADD_H +#define CALCULATORADD_H +#include +#include +float calculatorAdd(float x,float y); +#endif // CALCULATORADD_H diff --git a/src/main.c b/src/main.c index a3a8e04..cec361d 100644 --- a/src/main.c +++ b/src/main.c @@ -1,4 +1,18 @@ -#include -int main(){ -return 0; +#include "calculatorAdd.c" + + +int main() +{ + float num1, num2, sum; + + printf("number1: "); + scanf("%f", &num1); + + printf("number2: "); + scanf("%f", &num2); + + sum = calculatorAdd(num1, num2); + + printf("answer: %f", sum); + return 0; } diff --git a/tests/support/.gitkeep b/tests/support/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/tests/test_calculatorAdd.c b/tests/test_calculatorAdd.c new file mode 100644 index 0000000..5dd554b --- /dev/null +++ b/tests/test_calculatorAdd.c @@ -0,0 +1,20 @@ +#ifdef TEST + +#include "unity.h" + +#include "calculatorAdd.h" + +void setUp(void) +{ +} + +void tearDown(void) +{ +} + +void test_calculatorAdd_NeedToImplement(void) +{ + TEST_IGNORE_MESSAGE("Need to Implement calculatorAdd"); +} + +#endif // TEST From 22c4f866369fba6741cab8c08affbb177a626e7c Mon Sep 17 00:00:00 2001 From: fdai7514 Date: Wed, 8 Feb 2023 23:49:26 +0100 Subject: [PATCH 2/4] implement unittest for calculatorAdd.c --- build-project.sh | 1 + tests/test_calculatorAdd.c | 101 +++++++++++++++++++++++++++++++++++-- 2 files changed, 99 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_calculatorAdd.c b/tests/test_calculatorAdd.c index 5dd554b..0c55e52 100644 --- a/tests/test_calculatorAdd.c +++ b/tests/test_calculatorAdd.c @@ -2,7 +2,7 @@ #include "unity.h" -#include "calculatorAdd.h" +#include "calculatorAdd.c" void setUp(void) { @@ -12,9 +12,104 @@ void tearDown(void) { } -void test_calculatorAdd_NeedToImplement(void) +void test1_calculatorAdd(void) { - TEST_IGNORE_MESSAGE("Need to Implement calculatorAdd"); + float x, y, a ,e; + x = 26.24; + y = 23.22; + a = calculatorAdd(x, y); + e = x + y; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + +void test2_calculatorAdd(void) +{ + float x, y, a ,e; + x = 56.24; + y = 233.22; + a = calculatorAdd(x, y); + e = x + y; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + +void test3_calculatorAdd(void) +{ + float x, y, a ,e; + x = 1226.24; + y = 323.22; + a = calculatorAdd(x, y); + e = x + y; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + +void test4_calculatorAdd(void) +{ + float x, y, a ,e; + x = 2623.24; + y = 2323.22; + a = calculatorAdd(x, y); + e = x + y; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + +void test5_calculatorAdd(void) +{ + float x, y, a ,e; + x = 2435.24; + y = 23423.22; + a = calculatorAdd(x, y); + e = x + y; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + +void test6_calculatorAdd(void) +{ + float x, y, a ,e; + x = 4534.24; + y = 2221.22; + a = calculatorAdd(x, y); + e = x + y; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + +void test7_calculatorAdd(void) +{ + float x, y, a ,e; + x = 26322.24; + y = 2332.222; + a = calculatorAdd(x, y); + e = x + y; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + +void test8_calculatorAdd(void) +{ + float x, y, a ,e; + x = 26132.24; + y = 2331122.222; + a = calculatorAdd(x, y); + e = x + y; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + +void test9_calculatorAdd(void) +{ + float x, y, a ,e; + x = 6322.24; + y = 21232.2322; + a = calculatorAdd(x, y); + e = x + y; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + +void test10_calculatorAdd(void) +{ + float x, y, a ,e; + x = 1234.456; + y = 654.4321; + a = calculatorAdd(x, y); + e = x + y; + TEST_ASSERT_EQUAL_FLOAT(e, a); } #endif // TEST From 9a8bfb585e4b7f3d0fae180f1ffc4eff1a23e140 Mon Sep 17 00:00:00 2001 From: fdai7514 Date: Sun, 5 Feb 2023 00:01:00 +0100 Subject: [PATCH 3/4] refactoring: change variable names calculatorAdd.c and calculatorAdd.h --- src/calculatorAdd.c | 11 +++++++++-- src/calculatorAdd.h | 4 +++- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/src/calculatorAdd.c b/src/calculatorAdd.c index 781e507..99c892a 100644 --- a/src/calculatorAdd.c +++ b/src/calculatorAdd.c @@ -1,5 +1,12 @@ #include "calculatorAdd.h" -float calculatorAdd(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 calculatorAdd(float num1,float num2) +{ + return num1+num2; +} diff --git a/src/calculatorAdd.h b/src/calculatorAdd.h index 443a906..412a599 100644 --- a/src/calculatorAdd.h +++ b/src/calculatorAdd.h @@ -1,6 +1,8 @@ #ifndef CALCULATORADD_H #define CALCULATORADD_H + #include #include -float calculatorAdd(float x,float y); +float calculatorAdd(float num1,float num2); + #endif // CALCULATORADD_H From ef307cac167198a4efcf5272df7b8df056807015 Mon Sep 17 00:00:00 2001 From: fdai7514 Date: Sun, 5 Feb 2023 00:13:48 +0100 Subject: [PATCH 4/4] refactoring: change variable names in test_calculatorAdd.c --- tests/test_calculatorAdd.c | 127 +++++++++++++++++++------------------ 1 file changed, 67 insertions(+), 60 deletions(-) diff --git a/tests/test_calculatorAdd.c b/tests/test_calculatorAdd.c index 0c55e52..3e22349 100644 --- a/tests/test_calculatorAdd.c +++ b/tests/test_calculatorAdd.c @@ -4,6 +4,13 @@ #include "calculatorAdd.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,102 +21,102 @@ void tearDown(void) void test1_calculatorAdd(void) { - float x, y, a ,e; - x = 26.24; - y = 23.22; - a = calculatorAdd(x, y); - e = x + y; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual ,expected; //Arrange + num1 = 26.24; + num2 = 23.22; + actual = calculatorAdd(num1, num2); //Act + expected = num1 + num2; + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test2_calculatorAdd(void) { - float x, y, a ,e; - x = 56.24; - y = 233.22; - a = calculatorAdd(x, y); - e = x + y; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual ,expected; //Arrange + num1 = 56.24; + num2 = 233.22; + actual = calculatorAdd(num1, num2); //Act + expected = num1 + num2; + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test3_calculatorAdd(void) { - float x, y, a ,e; - x = 1226.24; - y = 323.22; - a = calculatorAdd(x, y); - e = x + y; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual ,expected; //Arrange + num1 = 1226.24; + num2 = 323.22; + actual = calculatorAdd(num1, num2); //Act + expected = num1 + num2; + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test4_calculatorAdd(void) { - float x, y, a ,e; - x = 2623.24; - y = 2323.22; - a = calculatorAdd(x, y); - e = x + y; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual ,expected; //Arrange + num1 = 2623.24; + num2 = 2323.22; + actual = calculatorAdd(num1, num2); //Act + expected = num1 + num2; + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test5_calculatorAdd(void) { - float x, y, a ,e; - x = 2435.24; - y = 23423.22; - a = calculatorAdd(x, y); - e = x + y; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual ,expected; //Arrange + num1 = 2435.24; + num2 = 23423.22; + actual = calculatorAdd(num1, num2); //Act + expected = num1 + num2; + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test6_calculatorAdd(void) { - float x, y, a ,e; - x = 4534.24; - y = 2221.22; - a = calculatorAdd(x, y); - e = x + y; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual ,expected; //Arrange + num1 = 4534.24; + num2 = 2221.22; + actual = calculatorAdd(num1, num2); //Act + expected = num1 + num2; + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test7_calculatorAdd(void) { - float x, y, a ,e; - x = 26322.24; - y = 2332.222; - a = calculatorAdd(x, y); - e = x + y; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual ,expected; //Arrange + num1 = 26322.24; + num2 = 2332.222; + actual = calculatorAdd(num1, num2); //Act + expected = num1 + num2; + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test8_calculatorAdd(void) { - float x, y, a ,e; - x = 26132.24; - y = 2331122.222; - a = calculatorAdd(x, y); - e = x + y; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual ,expected; //Arrange + num1 = 26132.24; + num2 = 2331122.222; + actual = calculatorAdd(num1, num2); //Act + expected = num1 + num2; + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test9_calculatorAdd(void) { - float x, y, a ,e; - x = 6322.24; - y = 21232.2322; - a = calculatorAdd(x, y); - e = x + y; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual ,expected; //Arrange + num1 = 6322.24; + num2 = 21232.2322; + actual = calculatorAdd(num1, num2); //Act + expected = num1 + num2; + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test10_calculatorAdd(void) { - float x, y, a ,e; - x = 1234.456; - y = 654.4321; - a = calculatorAdd(x, y); - e = x + y; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual ,expected; //Arrange + num1 = 1234.456; + num2 = 654.4321; + actual = calculatorAdd(num1, num2); //Act + expected = num1 + num2; + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } #endif // TEST