summaryrefslogtreecommitdiff
path: root/test/regression/mqtt_test/netx_mqtt_api_test.c
blob: bb037ebb874fe4b11f266f24fb2a8d9fdde24cf8 (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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
/***************************************************************************/
/* Copyright (c) 2024 Microsoft Corporation                                */
/* Copyright (c) 2026 Eclipse ThreadX contributors                         */
/*                                                                         */
/* This program and the accompanying materials are made available under    */
/* the terms of the MIT License which is available at                      */
/* https://opensource.org/licenses/MIT.                                    */
/*                                                                         */
/* SPDX-License-Identifier: MIT                                            */
/***************************************************************************/

/* This NetX test concentrates on the basic IP operation.  */

#include   "nxd_mqtt_client.h"
#include   "tx_api.h"
#include   "nx_api.h"
#include   "nx_ip.h"
#define     DEMO_STACK_SIZE         2048


/* Define the ThreadX and NetX object control blocks...  */

static TX_THREAD               ntest_0;

static NX_PACKET_POOL          pool_0;
static NX_IP                   ip_0;


/* Define the counters used in the test application...  */

static ULONG                   error_counter;
static CHAR                   *ip_0_memory_ptr;


/* Define thread prototypes.  */

static void    ntest_0_entry(ULONG thread_input);
extern void    test_control_return(UINT status);
extern void    _nx_ram_network_driver_256(struct NX_IP_DRIVER_STRUCT *driver_req);
extern ULONG   simulated_address_msw;
extern ULONG   simulated_address_lsw;
extern void SET_ERROR_COUNTER(ULONG *error_counter, CHAR *filename, int line_number);

/* Define what the initial system looks like.  */

#ifdef CTEST
VOID test_application_define(void *first_unused_memory)
#else
void    netx_mqtt_api_test_application_define(void *first_unused_memory)
#endif
{

CHAR    *pointer;
UINT    status;

    
    /* Setup the working pointer.  */
    pointer =  (CHAR *) first_unused_memory;

    /* Create the main thread.  */
    tx_thread_create(&ntest_0, "thread 0", ntest_0_entry, 0,  
            pointer, DEMO_STACK_SIZE, 
            4, 4, TX_NO_TIME_SLICE, TX_AUTO_START);
    pointer =  pointer + DEMO_STACK_SIZE;

    /* Initialize the NetX system.  */
    nx_system_initialize();

    /* Create a packet pool.  */
    status =  nx_packet_pool_create(&pool_0, "NetX Main Packet Pool", 256, pointer, 8192);
    pointer = pointer + 8192;

    if (status)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

    /* Create IP instances.  */
    ip_0_memory_ptr =  pointer;
    status = nx_ip_create(&ip_0, "NetX IP Instance 0", IP_ADDRESS(1, 2, 3, 9), 0xFFFFFF00UL, &pool_0, _nx_ram_network_driver_256,
                    pointer, 2048, 1);
    pointer =  pointer + 2048;

    if (status)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);                                    
}



/* Define the test threads.  */
#define MQTT_CLIENT_THREAD_PRIORITY  2
static NXD_MQTT_CLIENT my_client;
static ULONG mqtt_stack_space[DEMO_STACK_SIZE / sizeof(ULONG)];
static ULONG client_memory;
static void    ntest_0_entry(ULONG thread_input)
{
NXD_ADDRESS server_ip;

UINT        status;
UCHAR       message[4];    

    /* Print out test information banner.  */
    printf("NetX Test:   MQTT API Test ............................................");


    /* Check for earlier error.  */
    if (error_counter)
    {

        printf("ERROR!\n");
        test_control_return(1);
    }

    /* Test MQTT_CLIENT control block being NULL */
    status = nxd_mqtt_client_create(NX_NULL, NX_NULL, NX_NULL, 0, &ip_0, &pool_0, mqtt_stack_space, sizeof(mqtt_stack_space), MQTT_CLIENT_THREAD_PRIORITY, NX_NULL, 0);
    if(status != NX_PTR_ERROR)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

    /* Test IP control block being NULL */
    status = nxd_mqtt_client_create(&my_client, NX_NULL, NX_NULL, 0, /* &ip_0*/NX_NULL, &pool_0, mqtt_stack_space, sizeof(mqtt_stack_space), MQTT_CLIENT_THREAD_PRIORITY, NX_NULL, 0);
    if(status != NX_PTR_ERROR)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

    /* Test packet_pool control block being NULL */
    status = nxd_mqtt_client_create(&my_client, NX_NULL, NX_NULL, 0, &ip_0, NX_NULL/*&pool_0*/, mqtt_stack_space, sizeof(mqtt_stack_space), MQTT_CLIENT_THREAD_PRIORITY, NX_NULL, 0);
    if(status != NX_PTR_ERROR)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

    /* Test stack space being NULL */
    status = nxd_mqtt_client_create(&my_client, NX_NULL, NX_NULL, 0, &ip_0, &pool_0, NX_NULL/*mqtt_stack_space*/, sizeof(mqtt_stack_space), MQTT_CLIENT_THREAD_PRIORITY, NX_NULL, 0);
    if(status != NX_PTR_ERROR)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);
    
    /* Test stack size being 0 */
    status = nxd_mqtt_client_create(&my_client, NX_NULL, NX_NULL, 0, &ip_0, &pool_0, mqtt_stack_space, 0, MQTT_CLIENT_THREAD_PRIORITY, NX_NULL, 0);
    if(status != NX_PTR_ERROR)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);
    
    /* Test ip_id != NX_IP_ID */
    ip_0.nx_ip_id = 0;
    status = nxd_mqtt_client_create(&my_client, NX_NULL, NX_NULL, 0, &ip_0, &pool_0, mqtt_stack_space, sizeof(mqtt_stack_space), MQTT_CLIENT_THREAD_PRIORITY, NX_NULL, 0);
    if(status != NX_PTR_ERROR)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);
    ip_0.nx_ip_id = NX_IP_ID;

    /* Test client connect API. */
    server_ip.nxd_ip_version = 4;
    /* Test MQTT_CLIENT control block being NULL */
    status = nxd_mqtt_client_connect(NX_NULL, &server_ip, NXD_MQTT_PORT,  0, 0, 0);
    if(status != NX_PTR_ERROR)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

    /* Test server_ip being NULL */
    status = nxd_mqtt_client_connect(&my_client, NX_NULL, NXD_MQTT_PORT, 0, 0, 0);
    if(status != NX_PTR_ERROR)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

    /* Test invalid port number */
    status = nxd_mqtt_client_connect(&my_client, &server_ip,  0, 0, 0, 0);
    if(status != NX_INVALID_PORT)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);
    
    /* Test invalid IP version number */
    server_ip.nxd_ip_version = 3;
    status = nxd_mqtt_client_connect(&my_client, &server_ip,  NXD_MQTT_PORT, 0, 0, 0);    
    if(status != NXD_MQTT_INVALID_PARAMETER)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

    /* Restore the IP version number */
    server_ip.nxd_ip_version = 6;
    
    /* Test invalid username/password combination. */
    status = nxd_mqtt_client_login_set(&my_client, NX_NULL, 8, NX_NULL, 0);
    if(status != NXD_MQTT_INVALID_PARAMETER)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);
    
    /* Test invalid username/password combination. */
    status = nxd_mqtt_client_login_set(&my_client, NX_NULL, 0, NX_NULL, 8);
    if(status != NXD_MQTT_INVALID_PARAMETER)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

    /* Test invalid client_ptr. */
    status = nxd_mqtt_client_login_set(NX_NULL, NX_NULL, 0, NX_NULL, 8);
    if(status != NXD_MQTT_INVALID_PARAMETER)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

    /* MQTT 5.10sp4:  The following test was removed because MQTT shall
       allow user name being set and password not being set. */
#if 0
    status = nxd_mqtt_client_login_set(&my_client, "username", 8, NX_NULL, 0);
    if (status != NXD_MQTT_INVALID_PARAMETER)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);
#endif

    /* Validate nxd_mqtt_client_publish  */
    status = nxd_mqtt_client_publish(NX_NULL, "topic", 5, "message", 7, 0, 0, 0);
    if(status != NX_PTR_ERROR)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

    /* Validate topic name */
    status = nxd_mqtt_client_publish(&my_client, NX_NULL, 5, "message", 7, 0, 0, 0);
    if(status != NXD_MQTT_INVALID_PARAMETER)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);
    status = nxd_mqtt_client_publish(&my_client, "topic", 0, "message", 7, 0, 0, 0);
    if(status != NXD_MQTT_INVALID_PARAMETER)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

    /* Validate message length. */
    status = nxd_mqtt_client_publish(&my_client, "topic", 5, "message", 0, 0, 0, 0);
    if(status != NXD_MQTT_INVALID_PARAMETER)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

    /* Validate message empty and non-zero length. */
    status = nxd_mqtt_client_publish(&my_client, "topic", 5, NX_NULL, 2, 0, 0, 0);
    if(status != NXD_MQTT_NOT_CONNECTED)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

    /* Validate message empty and zero length. */
    status = nxd_mqtt_client_publish(&my_client, "topic", 5, NX_NULL, 0, 0, 0, 0);
    if(status != NXD_MQTT_NOT_CONNECTED)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

    /* Validate QoS value. */
    status = nxd_mqtt_client_publish(&my_client, "topic", 5, "message", 7, 0, 4, 0);
    if(status != NXD_MQTT_INVALID_PARAMETER)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

    

    /* Validate nxd_mqtt_client_subscribe. */
    status = nxd_mqtt_client_subscribe(NX_NULL, "topic", 5, 0);
    if(status != NX_PTR_ERROR)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);


    status = nxd_mqtt_client_subscribe(&my_client, NX_NULL, 5, 0);
    if(status != NXD_MQTT_INVALID_PARAMETER)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

    status = nxd_mqtt_client_subscribe(&my_client, "topic", 0, 0);
    if(status != NXD_MQTT_INVALID_PARAMETER)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

    status = nxd_mqtt_client_subscribe(&my_client, "topic", 5, 3);
    if(status != NXD_MQTT_INVALID_PARAMETER)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);


    /* validate nxd_mqtt_client_unsubscribe. */
    status = nxd_mqtt_client_unsubscribe(NX_NULL, "topic", 5);
    if(status != NX_PTR_ERROR)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);


    status = nxd_mqtt_client_unsubscribe(&my_client, NX_NULL, 5);
    if(status != NXD_MQTT_INVALID_PARAMETER)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

    status = nxd_mqtt_client_unsubscribe(&my_client, "topic", 0);
    if(status != NXD_MQTT_INVALID_PARAMETER)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);



    /* Validate nxd_mqtt_client_receive_notify_set. */
    status = nxd_mqtt_client_receive_notify_set(NX_NULL, NX_NULL);
    if(status != NX_PTR_ERROR)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

    /* Validate nxd_mqtt_client_receive_notify_set. */
    status = nxd_mqtt_client_receive_notify_set(&my_client, NX_NULL);
    if(status != NX_PTR_ERROR)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

    /* Validate nxd_mqtt_client_disconnect_notify_set NULL client_ptr behavior. */
    status = nxd_mqtt_client_disconnect_notify_set(NX_NULL, NX_NULL);
    if(status != NX_PTR_ERROR)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

    /* Validate nxd_mqtt_client_disconnect */
    status = nxd_mqtt_client_disconnect(NX_NULL);
    if(status != NX_PTR_ERROR)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);    

    /* Validate nxd_mqtt_client_delete */
    status = nxd_mqtt_client_delete(NX_NULL);
    if(status != NX_PTR_ERROR)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);    

    /* Validate nxd_mqtt_client_message_get. */
    status = nxd_mqtt_client_message_get(NX_NULL, NX_NULL, 0, NX_NULL, message, sizeof(message), NX_NULL);
    if(status != NX_PTR_ERROR)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);        

    status = nxd_mqtt_client_message_get(&my_client, NX_NULL, 0, NX_NULL, NX_NULL, 0, NX_NULL);
    if(status != NXD_MQTT_INVALID_PARAMETER)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);        
    status = nxd_mqtt_client_message_get(&my_client, NX_NULL, 0, NX_NULL, message, sizeof(message), NX_NULL);
    if(status != NXD_MQTT_INVALID_PARAMETER)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);        

    status = nxd_mqtt_client_will_message_set(NX_NULL, NX_NULL, 0, NX_NULL, 0, 0, 0);
    if(status != NXD_MQTT_INVALID_PARAMETER)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);
    status = nxd_mqtt_client_will_message_set(&my_client, NX_NULL, 2, NX_NULL, 0, 0, 0);
    if(status != NXD_MQTT_INVALID_PARAMETER)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);    
    status = nxd_mqtt_client_will_message_set(&my_client, "ab", 0, NX_NULL, 0, 0, 0);
    if(status != NXD_MQTT_INVALID_PARAMETER)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);    
    status = nxd_mqtt_client_will_message_set(&my_client, "Ab", 2, NX_NULL, 0, 0, 4);
    if(status != NXD_MQTT_INVALID_PARAMETER)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);    

    status = nxd_mqtt_client_will_message_set(&my_client, "Ab", 2, NX_NULL, 0, 2, 0);
    if(status != NXD_MQTT_INVALID_PARAMETER)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);    

    if(error_counter)
    {

        printf("ERROR!\n");
        test_control_return(1);
    }
    else
    {

        printf("SUCCESS!\n");
        test_control_return(0);
    }
}