From 5416031d06c2fc272be6fbbcc3f7184f456052d2 Mon Sep 17 00:00:00 2001 From: fdai7514 Date: Thu, 9 Feb 2023 00:27:13 +0100 Subject: [PATCH 1/4] implement function calculatorMultiply() --- project.yml | 101 ++++++++++++++++++++++++++++++++ src/calculatorMultiply.c | 2 + src/calculatorMultiply.h | 9 +++ src/main.c | 21 ++++++- tests/support/.gitkeep | 0 tests/test_calculatorMultiply.c | 20 +++++++ 6 files changed, 150 insertions(+), 3 deletions(-) create mode 100644 project.yml create mode 100644 src/calculatorMultiply.c create mode 100644 src/calculatorMultiply.h create mode 100644 tests/support/.gitkeep create mode 100644 tests/test_calculatorMultiply.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/calculatorMultiply.c b/src/calculatorMultiply.c new file mode 100644 index 0000000..df3f401 --- /dev/null +++ b/src/calculatorMultiply.c @@ -0,0 +1,2 @@ +#include "calculatorMultiply.h" +float calculatorMultiply(float x, float y){return x*y;} diff --git a/src/calculatorMultiply.h b/src/calculatorMultiply.h new file mode 100644 index 0000000..8641b05 --- /dev/null +++ b/src/calculatorMultiply.h @@ -0,0 +1,9 @@ +#ifndef CALCULATORMULTIPLY_H +#define CALCULATORMULTIPLY_H +#include +#include +float calculatorMultiply(float x, float y); + + + +#endif // CALCULATORMULTIPLY_H diff --git a/src/main.c b/src/main.c index a3a8e04..01a278f 100644 --- a/src/main.c +++ b/src/main.c @@ -1,4 +1,19 @@ -#include -int main(){ -return 0; +#include "calculatorMultiply.c" + + +int main() +{ + float num1, num2, produkt; + + printf("number1: "); + scanf("%f", &num1); + + printf("number2: "); + scanf("%f", &num2); + + produkt = calculatorMultiply(num1, num2); + + printf("answer: %f", produkt); + return 0; } + diff --git a/tests/support/.gitkeep b/tests/support/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/tests/test_calculatorMultiply.c b/tests/test_calculatorMultiply.c new file mode 100644 index 0000000..5768561 --- /dev/null +++ b/tests/test_calculatorMultiply.c @@ -0,0 +1,20 @@ +#ifdef TEST + +#include "unity.h" + +#include "calculatorMultiply.h" + +void setUp(void) +{ +} + +void tearDown(void) +{ +} + +void test_calculatorMultiply_NeedToImplement(void) +{ + TEST_IGNORE_MESSAGE("Need to Implement calculatorMultiply"); +} + +#endif // TEST From da0dd52871db84df0b44b429affcaa39308a8b07 Mon Sep 17 00:00:00 2001 From: fdai7514 Date: Thu, 9 Feb 2023 00:29:25 +0100 Subject: [PATCH 2/4] implement unittest for calculatorMultiply.c --- build-project.sh | 1 + tests/test_calculatorMultiply.c | 99 ++++++++++++++++++++++++++++++++- 2 files changed, 98 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_calculatorMultiply.c b/tests/test_calculatorMultiply.c index 5768561..359fe6b 100644 --- a/tests/test_calculatorMultiply.c +++ b/tests/test_calculatorMultiply.c @@ -12,9 +12,104 @@ void tearDown(void) { } -void test_calculatorMultiply_NeedToImplement(void) +void test1_calculatorMultiply(void) { - TEST_IGNORE_MESSAGE("Need to Implement calculatorMultiply"); + float p, q, a, e; + p = 26.24; + q = 23.22; + a = calculatorMultiply(p, q); + e = p * q; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + +void test2_calculatorMultiply(void) +{ + float p, q, a, e; + p = 56.24; + q = 233.22; + a = calculatorMultiply(p, q); + e = p * q; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + +void test3_calculatorMultiply(void) +{ + float p, q, a, e; + p = 1226.24; + q = 323.22; + a = calculatorMultiply(p, q); + e = p * q; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + +void test4_calculatorMultiply(void) +{ + float p, q, a, e; + p = 2623.24; + q = 2323.22; + a = calculatorMultiply(p, q); + e = p * q; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + +void test5_calculatorMultiply(void) +{ + float p, q, a, e; + p = 2435.24; + q = 23423.22; + a = calculatorMultiply(p, q); + e = p * q; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + +void test6_calculatorMultiply(void) +{ + float p, q, a, e; + p = 4534.24; + q = 2221.22; + a = calculatorMultiply(p, q); + e = p * q; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + +void test7_calculatorMultiply(void) +{ + float p, q, a, e; + p = 26322.24; + q = 2332.222; + a = calculatorMultiply(p, q); + e = p * q; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + +void test8_calculatorMultiply(void) +{ + float p, q, a, e; + p = 26132.24; + q = 2331122.222; + a = calculatorMultiply(p, q); + e = p * q; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + +void test9_calculatorMultiply(void) +{ + float p, q, a, e; + p = 6322.24; + q = 21232.2322; + a = calculatorMultiply(p, q); + e = p * q; + TEST_ASSERT_EQUAL_FLOAT(e, a); +} + +void test10_calculatorMultiply(void) +{ + float p, q, a, e; + p = 1234.456; + q = 654.4321; + a = calculatorMultiply(p, q); + e = p * q; + TEST_ASSERT_EQUAL_FLOAT(e, a); } #endif // TEST From c14d061ac40d5ba6e059062bd428c56e9250ae5a Mon Sep 17 00:00:00 2001 From: fdai7514 Date: Mon, 6 Feb 2023 19:51:32 +0100 Subject: [PATCH 3/4] refactoring: change variable names and format code in calculatorMultiply.c --- src/calculatorMultiply.c | 10 +++++++++- src/calculatorMultiply.h | 2 +- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/src/calculatorMultiply.c b/src/calculatorMultiply.c index df3f401..42e1763 100644 --- a/src/calculatorMultiply.c +++ b/src/calculatorMultiply.c @@ -1,2 +1,10 @@ #include "calculatorMultiply.h" -float calculatorMultiply(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 calculatorMultiply(float num1, float num2) +{ + return num1 * num2; +} + diff --git a/src/calculatorMultiply.h b/src/calculatorMultiply.h index 8641b05..569b389 100644 --- a/src/calculatorMultiply.h +++ b/src/calculatorMultiply.h @@ -2,7 +2,7 @@ #define CALCULATORMULTIPLY_H #include #include -float calculatorMultiply(float x, float y); +float calculatorMultiply(float num1, float num2); From 8192d8e234f90984b8ab7ce48a664cd12adc5e4b Mon Sep 17 00:00:00 2001 From: fdai7514 Date: Mon, 6 Feb 2023 19:57:42 +0100 Subject: [PATCH 4/4] refactoring: change variable names in test_calculatorMultiply.c --- tests/test_calculatorMultiply.c | 125 +++++++++++++++++--------------- 1 file changed, 65 insertions(+), 60 deletions(-) diff --git a/tests/test_calculatorMultiply.c b/tests/test_calculatorMultiply.c index 359fe6b..64f1b78 100644 --- a/tests/test_calculatorMultiply.c +++ b/tests/test_calculatorMultiply.c @@ -4,6 +4,11 @@ #include "calculatorMultiply.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,102 +19,102 @@ void tearDown(void) void test1_calculatorMultiply(void) { - float p, q, a, e; - p = 26.24; - q = 23.22; - a = calculatorMultiply(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 = calculatorMultiply(num1, num2); //Act + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test2_calculatorMultiply(void) { - float p, q, a, e; - p = 56.24; - q = 233.22; - a = calculatorMultiply(p, q); - e = p * q; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual ,expected; //Arrange + num1 = 56.24; + num2 = 233.22; + expected = num1 * num2; + actual = calculatorMultiply(num1, num2); //Act + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test3_calculatorMultiply(void) { - float p, q, a, e; - p = 1226.24; - q = 323.22; - a = calculatorMultiply(p, q); - e = p * q; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual ,expected; //Arrange + num1 = 1226.24; + num2 = 323.22; + expected = num1 * num2; + actual = calculatorMultiply(num1, num2); //Act + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test4_calculatorMultiply(void) { - float p, q, a, e; - p = 2623.24; - q = 2323.22; - a = calculatorMultiply(p, q); - e = p * q; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual ,expected; //Arrange + num1 = 2623.24; + num2 = 2323.22; + expected = num1 * num2; + actual = calculatorMultiply(num1, num2); //Act + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test5_calculatorMultiply(void) { - float p, q, a, e; - p = 2435.24; - q = 23423.22; - a = calculatorMultiply(p, q); - e = p * q; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual ,expected; //Arrange + num1 = 2435.24; + num2 = 23423.22; + expected = num1 * num2; + actual = calculatorMultiply(num1, num2); //Act + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test6_calculatorMultiply(void) { - float p, q, a, e; - p = 4534.24; - q = 2221.22; - a = calculatorMultiply(p, q); - e = p * q; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual ,expected; //Arrange + num1 = 4534.24; + num2 = 2221.22; + expected = num1 * num2; + actual = calculatorMultiply(num1, num2); //Act + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test7_calculatorMultiply(void) { - float p, q, a, e; - p = 26322.24; - q = 2332.222; - a = calculatorMultiply(p, q); - e = p * q; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual ,expected; //Arrange + num1 = 26322.24; + num2 = 2332.222; + expected = num1 * num2; + actual = calculatorMultiply(num1, num2); //Act + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test8_calculatorMultiply(void) { - float p, q, a, e; - p = 26132.24; - q = 2331122.222; - a = calculatorMultiply(p, q); - e = p * q; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual ,expected; //Arrange + num1 = 26132.24; + num2 = 2331122.222; + expected = num1 * num2; + actual = calculatorMultiply(num1, num2); //Act + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test9_calculatorMultiply(void) { - float p, q, a, e; - p = 6322.24; - q = 21232.2322; - a = calculatorMultiply(p, q); - e = p * q; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual ,expected; //Arrange + num1 = 6322.24; + num2 = 21232.2322; + expected = num1 * num2; + actual = calculatorMultiply(num1, num2); //Act + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } void test10_calculatorMultiply(void) { - float p, q, a, e; - p = 1234.456; - q = 654.4321; - a = calculatorMultiply(p, q); - e = p * q; - TEST_ASSERT_EQUAL_FLOAT(e, a); + float num1, num2, actual ,expected; //Arrange + num1 = 1234.456; + num2 = 654.4321; + expected = num1 * num2; + actual = calculatorMultiply(num1, num2); //Act + TEST_ASSERT_EQUAL_FLOAT(expected, actual); //Assert } #endif // TEST