fanasina/y_project
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
fanasina
2023-10-09 10:57:59 +02:00
committed by GitHub
parent ed376999a3
commit 35ef5d9a94
1 changed files with 24 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+20 -7
View File
@@ -29,7 +29,7 @@ chmod +x compile.sh
We can combine these options, for example: `./compile "-D DEBUG=1 -D HK -g"` We can combine these options, for example: `./compile "-D DEBUG=1 -D HK -g"`
## launch options if using run_all_tests_args(argc, argv); ## launch options if using run_all_tests_args(argc, argv);
By default `./launch_is_good_{c,m}` is on 1 thread but we can add some options to run tests in parallel, or chanche colors, to disable progress bar, ..., to print help By default `./launch_is_good_{c,m}` is on 1 thread but we can add some options to run tests in parallel, or change colors, to disable progress bar, ..., to print help
### help ### help
`./launch_is_good_c -h` `./launch_is_good_c -h`
@@ -127,7 +127,11 @@ int main(){
# FMOCK # FMOCK
## How to create fmock ## How to create fmock
outside all function:
```
#include "fmock/fmock.h"
```
outside all functions:
``` ```
MOCK_FUNC(returnType, name_function_mock,(prototype of the function with paranthesis),(args when call the funct with parathesis)) MOCK_FUNC(returnType, name_function_mock,(prototype of the function with paranthesis),(args when call the funct with parathesis))
/* use (returnType) in parathesis if the returType has more than 1 words for example (long int) or (struct someStruct) */ /* use (returnType) in parathesis if the returType has more than 1 words for example (long int) or (struct someStruct) */
@@ -140,6 +144,13 @@ we use
``` ```
MOCK_FUNC(int, f_mock,(int a,int b),(a,b)) MOCK_FUNC(int, f_mock,(int a,int b),(a,b))
``` ```
args:
```
returnType: int,
name_function_mock: f_mock,
args prototype with paranthesis: (int a,int b),
args variable names with parathesis (same variable names as prototype): (a,b)
```
## print variables ## print variables
We may define a function to print variables of the mock function, it is usefull in logs, the macro has almost the same args as MOCK_FUNC, without returnType wich is alway `char*`. We may define a function to print variables of the mock function, it is usefull in logs, the macro has almost the same args as MOCK_FUNC, without returnType wich is alway `char*`.
For example with `f_mock` we define: For example with `f_mock` we define:
@@ -161,13 +172,13 @@ args:
returnType: int, returnType: int,
name_function_mock: f_mock, name_function_mock: f_mock,
arg prototype of the function with paranthesis: (int a,int b), arg prototype of the function with paranthesis: (int a,int b),
arg when we call the function (same variable names as prototype): (a<b) conditions to check on args before calling the function:(bool expression): (a<b)
number of repetition response (number of call times): 3 number of repetition response (number of call times): 3
``` ```
## define will call ## define will call
``` ```
WILL_MOCK_CALL(int, f_mock, (int a,int b), (a<b), 3){ WILL_MOCK_CALL(int, f_mock, (int a,int b), (a==b), 1){
return a+b; return a*b;
} }
``` ```
same args as EXPECT_MOCK_CALL, the difference is, the EXPECT_MOCK_CALL have to be call by the test earlier, but not WILL_MOCK_CALL. same args as EXPECT_MOCK_CALL, the difference is, the EXPECT_MOCK_CALL have to be call by the test earlier, but not WILL_MOCK_CALL.
@@ -175,7 +186,8 @@ same args as EXPECT_MOCK_CALL, the difference is, the EXPECT_MOCK_CALL have to b
## init call and call ## init call and call
in TEST environement, we may use macro `INIT_CALLER_MOCK(f_mock);` before calling `f_mock` to have explicit logs again! in TEST environement, we may use macro `INIT_CALLER_MOCK(f_mock);` before calling `f_mock` to have explicit logs again!
Call function mock is the same as other normal function! Call function mock is the same as other normal functions.
Example: Example:
``` ```
TEST(f_mock_test){ TEST(f_mock_test){
@@ -186,7 +198,8 @@ TEST(f_mock_test){
``` ```
# PRINTF # PRINTF
We may use standard printf function, but I provide a macro PRINTF to allow us record logs in files and also ordered logs when we use parallel tests. We may use standard printf function, but I provide a macro PRINTF to allow us record logs in files and also ordered logs when we use parallel tests.
args is the same as printf.
args are the same as `printf` stdio.h function.
example: example:
``` ```
PRINTF("hello\n"); PRINTF("hello\n");