summaryrefslogtreecommitdiff
path: root/FreeRTOS-Plus/Test/CMock/test/system/test_interactions/return_thru_ptr_ignore_arg.yml
blob: 8b07be99746ba29a6c24d7ffce67b37b802b1ac1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
---
:cmock:
    :mock_path: test/mocks
    :mock_prefix: mock_
    :treat_as:
        abs_struct: PTR
        intptr: INT*
    :when_ptr: :smart
    :plugins:
        - :array
        - :expect_any_args
        - :return_thru_ptr

:systest:
  :types: |
    typedef int *intptr;

    struct a_struct
    {
        int i1;
        int i2;
        int i3;
    };

    struct _abs_struct
    {
        int abs_i1;
        int abs_i2;
    };

    typedef struct _abs_struct abs_struct;

  :mockable: |
      void ptr_ret_int(int *r);
      void ptr_ret_ints(int *r, int *s);
      void ptr_ret_array(char r[], int len);
      void ptr_ret_typedef(intptr r);
      void ptr_ret_struct(struct a_struct *r);
      void ptr_ret_abstract(abs_struct *r);
      void ptr_ret_abstract_array(abs_struct *r, int len);
      void ptr_ret_const_int(int *r, const int *s);
      void ptr_ret_string(char *s);

  :source:
    :header: |
      #include <string.h>
      #define lengthof(x) (sizeof(x)/sizeof((x)[0]))

    :code: |

  :tests:
    :common: |
      void setUp(void) {}
      void tearDown(void) {}

    :units:
    - :pass: TRUE
      :should: "handle a single int* argument"
      :code: |
        test()
        {
          int r = 1;
          int res = 4;

          ptr_ret_int_Expect(&r);
          ptr_ret_int_ReturnThruPtr_r(&res);
          ptr_ret_int(&r);
          TEST_ASSERT_EQUAL(4, r);
        }

    - :pass: TRUE
      :should: "handle multiple calls"
      :code: |
        test()
        {
          int r = 1;
          int res1 = 4;
          int res2 = 8;
          int res3 = 16;

          ptr_ret_int_Expect(&r);
          ptr_ret_int_ReturnThruPtr_r(&res1);
          ptr_ret_int_Expect(&r);
          ptr_ret_int_ReturnThruPtr_r(&res2);
          ptr_ret_int_Expect(&r);
          ptr_ret_int_ReturnThruPtr_r(&res3);

          ptr_ret_int(&r);
          TEST_ASSERT_EQUAL(4, r);
          ptr_ret_int(&r);
          TEST_ASSERT_EQUAL(8, r);
          ptr_ret_int(&r);
          TEST_ASSERT_EQUAL(16, r);

        }

    - :pass: TRUE
      :should: "ignore an argument"
      :code: |
        test()
        {
          int s = 2;
          int res = 4;

          ptr_ret_int_ExpectAnyArgs();
          ptr_ret_int_ReturnThruPtr_r(&res);
          ptr_ret_int(&s);
          TEST_ASSERT_EQUAL(4, s);
        }

    - :pass: TRUE
      :should: "ignore a null pointer argument"
      :code: |
        test()
        {
          int r = 1;
          int res = 4;

          ptr_ret_int_ExpectAnyArgs();
          ptr_ret_int_ReturnThruPtr_r(&res);
          ptr_ret_int(&r);
          TEST_ASSERT_EQUAL(4, r);
        }

    - :pass: TRUE
      :should: "handle multiple int* arguments"
      :code: |
        test()
        {
          int r, s = 0x0880AA55;
          int r_res = 4;
          int s_res = 6;

          ptr_ret_ints_Expect(&r, &s);
          ptr_ret_ints_ReturnThruPtr_r(&r_res);
          ptr_ret_ints_ReturnThruPtr_s(&s_res);
          ptr_ret_ints(&r, &s);
          TEST_ASSERT_EQUAL(4, r);
          TEST_ASSERT_EQUAL(6, s);
        }

    - :pass: TRUE
      :should: "only return through pointer when asked to"
      :code: |
        test()
        {
          int r = 0x0880AA55;
          int s = 0xAA55;
          int r_res = 4;

          ptr_ret_ints_Expect(&r, &s);
          ptr_ret_ints_ReturnThruPtr_r(&r_res);
          ptr_ret_ints(&r, &s);
          TEST_ASSERT_EQUAL(4, r);
          TEST_ASSERT_EQUAL(0xAA55, s);
        }

    - :pass: TRUE
      :should: "return an array through a pointer correctly"
      :code: |
        test()
        {
          char r_a[] = "booboorooboo";
          char r_a_ret[] = "FEEFI";

          ptr_ret_array_Expect(r_a, lengthof(r_a));
          ptr_ret_array_ReturnArrayThruPtr_r(r_a_ret, (int)strlen(r_a_ret));
          ptr_ret_array(r_a, lengthof(r_a));
          TEST_ASSERT_EQUAL_STRING("FEEFIorooboo", r_a);
        }

    - :pass: TRUE
      :should: "handle structs"
      :code: |
        test()
        {
          struct a_struct r_s = { .i1 = 2, .i2 = 3, .i3 = 4, };
          struct a_struct r_s_ret = { .i1 = 8, .i2 = 16, .i3 = 32, };

          ptr_ret_struct_Expect(&r_s);
          ptr_ret_struct_ReturnThruPtr_r(&r_s_ret);
          ptr_ret_struct(&r_s);
          TEST_ASSERT_EQUAL_MEMORY(&r_s_ret, &r_s, sizeof(struct a_struct));
        }

    - :pass: TRUE
      :should: "handle typedefs"
      :code: |
        test()
        {
          abs_struct r_as = {.abs_i1 = 0x1234, .abs_i2 = 0x4567};
          abs_struct r_as_ret = {.abs_i1 = 0xFFAA55, .abs_i2 = 0xAAFFAA};
          ptr_ret_abstract_Expect(&r_as);
          ptr_ret_abstract_ReturnMemThruPtr_r(&r_as_ret, sizeof(abs_struct));
          ptr_ret_abstract(&r_as);
          TEST_ASSERT_EQUAL_MEMORY(&r_as_ret, &r_as, sizeof(abs_struct));
        }

    - :pass: TRUE
      :should: "only generate ReturnThruPtr definitions for non-const arguments"
      :code: |
        test()
        {
        #if !defined(ptr_ret_const_int_ReturnThruPtr_r)
            TEST_FAIL_MESSAGE("ReturnThruPtr not defined for a pointer argument.");
        #endif

        #if defined(ptr_ret_const_int_ReturnThruPtr_s)
            TEST_FAIL_MESSAGE("ReturnThruPtr defined for a const pointer argument.");
        #endif
        }

    - :pass: TRUE
      :should: "generate ReturnThruPtr definitions for string arguments"
      :code: |
        test()
        {
        #if !defined(ptr_ret_string_ReturnThruPtr_s)
            TEST_FAIL_MESSAGE("ReturnThruPtr not defined for a string argument.");
        #endif
        }

    - :pass: TRUE
      :should: "generate ExpectAnyArgs definitions"
      :code: |
        test()
        {
        #if !defined(ptr_ret_array_ExpectAnyArgs)
            TEST_FAIL_MESSAGE("ExpectAnyArgs not defined for an argument.");
        #endif
        }