xref: /aosp_15_r20/external/libwebsockets/minimal-examples/api-tests/api-test-lws_struct-json/test2.c (revision 1c60b9aca93fdbc9b5f19b2d2194c91294b22281)
1*1c60b9acSAndroid Build Coastguard Worker /*
2*1c60b9acSAndroid Build Coastguard Worker  * lws-api-test-lws_struct-json
3*1c60b9acSAndroid Build Coastguard Worker  *
4*1c60b9acSAndroid Build Coastguard Worker  * Written in 2010-2020 by Andy Green <[email protected]>
5*1c60b9acSAndroid Build Coastguard Worker  *
6*1c60b9acSAndroid Build Coastguard Worker  * This file is made available under the Creative Commons CC0 1.0
7*1c60b9acSAndroid Build Coastguard Worker  * Universal Public Domain Dedication.
8*1c60b9acSAndroid Build Coastguard Worker  *
9*1c60b9acSAndroid Build Coastguard Worker  * lws_struct apis are used to serialize and deserialize your C structs and
10*1c60b9acSAndroid Build Coastguard Worker  * linked-lists in a standardized way that's very modest on memory but
11*1c60b9acSAndroid Build Coastguard Worker  * convenient and easy to maintain.
12*1c60b9acSAndroid Build Coastguard Worker  *
13*1c60b9acSAndroid Build Coastguard Worker  * This second test file shows a worked example for how to express a schema
14*1c60b9acSAndroid Build Coastguard Worker  * and both consume JSON -> struct and struct -> JSON for it.
15*1c60b9acSAndroid Build Coastguard Worker  */
16*1c60b9acSAndroid Build Coastguard Worker 
17*1c60b9acSAndroid Build Coastguard Worker #include <libwebsockets.h>
18*1c60b9acSAndroid Build Coastguard Worker 
19*1c60b9acSAndroid Build Coastguard Worker static const char * const test2_json =
20*1c60b9acSAndroid Build Coastguard Worker "{"
21*1c60b9acSAndroid Build Coastguard Worker 	"\"config\":["
22*1c60b9acSAndroid Build Coastguard Worker 		"{"
23*1c60b9acSAndroid Build Coastguard Worker 			"\"id1\":"		"null,"
24*1c60b9acSAndroid Build Coastguard Worker 			"\"creds\":{"
25*1c60b9acSAndroid Build Coastguard Worker 				"\"key1\":"	"\"\\\"xxxxxxxxx\\\"\","
26*1c60b9acSAndroid Build Coastguard Worker 				"\"key2\":"	"null"
27*1c60b9acSAndroid Build Coastguard Worker 			"},"
28*1c60b9acSAndroid Build Coastguard Worker 			"\"frequency\":"	"0,"
29*1c60b9acSAndroid Build Coastguard Worker 			"\"arg1\":"		"\"val1\","
30*1c60b9acSAndroid Build Coastguard Worker 			"\"arg2\":"		"0,"
31*1c60b9acSAndroid Build Coastguard Worker 			"\"priority\":"		"1,"
32*1c60b9acSAndroid Build Coastguard Worker 			"\"ssid\":"		"\"\\\"nw2\\\"\""
33*1c60b9acSAndroid Build Coastguard Worker 		"}, {"
34*1c60b9acSAndroid Build Coastguard Worker 			"\"id2\":"		"null,"
35*1c60b9acSAndroid Build Coastguard Worker 			"\"creds\": {"
36*1c60b9acSAndroid Build Coastguard Worker 				"\"key1\":"	"\"\\\"xxxxxxxxxxxxx\\\"\","
37*1c60b9acSAndroid Build Coastguard Worker 				"\"key2\":"	"null"
38*1c60b9acSAndroid Build Coastguard Worker 			"},"
39*1c60b9acSAndroid Build Coastguard Worker 			"\"frequency\":"	"11,"
40*1c60b9acSAndroid Build Coastguard Worker 			"\"arg1\":"		"\"val2\","
41*1c60b9acSAndroid Build Coastguard Worker 			"\"arg2\":"		"1420887242594,"
42*1c60b9acSAndroid Build Coastguard Worker 			"\"priority\":"		"3,"
43*1c60b9acSAndroid Build Coastguard Worker 			"\"ssid\":"		"\"\\\"nw1\\\"\""
44*1c60b9acSAndroid Build Coastguard Worker 		"}"
45*1c60b9acSAndroid Build Coastguard Worker 	"]"
46*1c60b9acSAndroid Build Coastguard Worker "}";
47*1c60b9acSAndroid Build Coastguard Worker 
48*1c60b9acSAndroid Build Coastguard Worker static const char * const test2_json_expected =
49*1c60b9acSAndroid Build Coastguard Worker 	"{\"config\":[{\"creds\":{\"key1\":\"\\u0022xxxxxxxxx\\u0022\"},"
50*1c60b9acSAndroid Build Coastguard Worker 	 "\"arg1\":\"val1\",\"ssid\":\"\\u0022nw2\\u0022\","
51*1c60b9acSAndroid Build Coastguard Worker 	 "\"frequency\":0,\"arg2\":0,\"priority\":1},"
52*1c60b9acSAndroid Build Coastguard Worker 	 "{\"creds\":{\"key1\":\"\\u0022xxxxxxxxxxxxx\\u0022\"},"
53*1c60b9acSAndroid Build Coastguard Worker 	 "\"arg1\":\"val2\",\"ssid\":\"\\u0022nw1\\u0022\","
54*1c60b9acSAndroid Build Coastguard Worker 	 "\"frequency\":11,\"arg2\":1420887242594,\"priority\":3}]}"
55*1c60b9acSAndroid Build Coastguard Worker ;
56*1c60b9acSAndroid Build Coastguard Worker 
57*1c60b9acSAndroid Build Coastguard Worker /*
58*1c60b9acSAndroid Build Coastguard Worker  * level 3: Credentials object
59*1c60b9acSAndroid Build Coastguard Worker  */
60*1c60b9acSAndroid Build Coastguard Worker 
61*1c60b9acSAndroid Build Coastguard Worker typedef struct t2_cred {
62*1c60b9acSAndroid Build Coastguard Worker 	const char				*key1;
63*1c60b9acSAndroid Build Coastguard Worker 	const char				*key2;
64*1c60b9acSAndroid Build Coastguard Worker } t2_cred_t;
65*1c60b9acSAndroid Build Coastguard Worker 
66*1c60b9acSAndroid Build Coastguard Worker static const lws_struct_map_t lsm_t2_cred[] = {
67*1c60b9acSAndroid Build Coastguard Worker 	LSM_STRING_PTR	(t2_cred_t, key1, "key1"),
68*1c60b9acSAndroid Build Coastguard Worker 	LSM_STRING_PTR	(t2_cred_t, key2, "key2"),
69*1c60b9acSAndroid Build Coastguard Worker };
70*1c60b9acSAndroid Build Coastguard Worker 
71*1c60b9acSAndroid Build Coastguard Worker /*
72*1c60b9acSAndroid Build Coastguard Worker  * level 2: Configuration object, containing a child credentials object
73*1c60b9acSAndroid Build Coastguard Worker  */
74*1c60b9acSAndroid Build Coastguard Worker 
75*1c60b9acSAndroid Build Coastguard Worker typedef struct t2_config {
76*1c60b9acSAndroid Build Coastguard Worker 	lws_dll2_t				list;
77*1c60b9acSAndroid Build Coastguard Worker 	t2_cred_t 				*creds;
78*1c60b9acSAndroid Build Coastguard Worker 	const char				*id1;
79*1c60b9acSAndroid Build Coastguard Worker 	const char				*arg1;
80*1c60b9acSAndroid Build Coastguard Worker 	const char				*ssid;
81*1c60b9acSAndroid Build Coastguard Worker 	unsigned int				frequency;
82*1c60b9acSAndroid Build Coastguard Worker 	unsigned long long			arg2;
83*1c60b9acSAndroid Build Coastguard Worker 	unsigned int				priority;
84*1c60b9acSAndroid Build Coastguard Worker } t2_config_t;
85*1c60b9acSAndroid Build Coastguard Worker 
86*1c60b9acSAndroid Build Coastguard Worker static const lws_struct_map_t lsm_t2_config[] = {
87*1c60b9acSAndroid Build Coastguard Worker 	LSM_CHILD_PTR	(t2_config_t,
88*1c60b9acSAndroid Build Coastguard Worker 			 creds,			/* the child pointer member */
89*1c60b9acSAndroid Build Coastguard Worker 			 t2_cred_t,		/* the child type */
90*1c60b9acSAndroid Build Coastguard Worker 			 NULL, lsm_t2_cred,	/* map object for item type */
91*1c60b9acSAndroid Build Coastguard Worker 			 "creds"),		/* outer json object name */
92*1c60b9acSAndroid Build Coastguard Worker 	LSM_STRING_PTR	(t2_config_t, id1, 	 "id1"),
93*1c60b9acSAndroid Build Coastguard Worker 	LSM_STRING_PTR	(t2_config_t, arg1,	 "arg1"),
94*1c60b9acSAndroid Build Coastguard Worker 	LSM_STRING_PTR	(t2_config_t, ssid,	 "ssid"),
95*1c60b9acSAndroid Build Coastguard Worker 
96*1c60b9acSAndroid Build Coastguard Worker 	LSM_UNSIGNED	(t2_config_t, frequency, "frequency"),
97*1c60b9acSAndroid Build Coastguard Worker 	LSM_UNSIGNED	(t2_config_t, arg2,	 "arg2"),
98*1c60b9acSAndroid Build Coastguard Worker 	LSM_UNSIGNED	(t2_config_t, priority,	 "priority"),
99*1c60b9acSAndroid Build Coastguard Worker };
100*1c60b9acSAndroid Build Coastguard Worker 
101*1c60b9acSAndroid Build Coastguard Worker /*
102*1c60b9acSAndroid Build Coastguard Worker  * level 1: list-of-configurations object
103*1c60b9acSAndroid Build Coastguard Worker  */
104*1c60b9acSAndroid Build Coastguard Worker 
105*1c60b9acSAndroid Build Coastguard Worker typedef struct t2_configs {
106*1c60b9acSAndroid Build Coastguard Worker 	lws_dll2_owner_t 			configs;
107*1c60b9acSAndroid Build Coastguard Worker } t2_configs_t;
108*1c60b9acSAndroid Build Coastguard Worker 
109*1c60b9acSAndroid Build Coastguard Worker static const lws_struct_map_t lsm_t2_configs[] = {
110*1c60b9acSAndroid Build Coastguard Worker 	LSM_LIST	(t2_configs_t, configs, /* the list owner type/member */
111*1c60b9acSAndroid Build Coastguard Worker 			 t2_config_t,  list,	/* the list item type/member */
112*1c60b9acSAndroid Build Coastguard Worker 			 NULL, lsm_t2_config,	/* map object for item type */
113*1c60b9acSAndroid Build Coastguard Worker 			 "config"),		/* outer json object name */
114*1c60b9acSAndroid Build Coastguard Worker };
115*1c60b9acSAndroid Build Coastguard Worker 
116*1c60b9acSAndroid Build Coastguard Worker /*
117*1c60b9acSAndroid Build Coastguard Worker  * For parsing, this lists the kind of object we expect to parse so the struct
118*1c60b9acSAndroid Build Coastguard Worker  * can be allocated polymorphically.
119*1c60b9acSAndroid Build Coastguard Worker  *
120*1c60b9acSAndroid Build Coastguard Worker  * Lws uses an explicit "schema" member so the type is known unambiguously.  If
121*1c60b9acSAndroid Build Coastguard Worker  * in the incoming JSON the first member is not "schema", it will scan the
122*1c60b9acSAndroid Build Coastguard Worker  * maps listed here and instantiate the first object that has a member of that
123*1c60b9acSAndroid Build Coastguard Worker  * name.
124*1c60b9acSAndroid Build Coastguard Worker  */
125*1c60b9acSAndroid Build Coastguard Worker 
126*1c60b9acSAndroid Build Coastguard Worker static const lws_struct_map_t lsm_schema[] = {
127*1c60b9acSAndroid Build Coastguard Worker 	LSM_SCHEMA	(t2_configs_t, NULL, lsm_t2_configs, "t2"),
128*1c60b9acSAndroid Build Coastguard Worker 	/* other schemata that might need parsing... */
129*1c60b9acSAndroid Build Coastguard Worker };
130*1c60b9acSAndroid Build Coastguard Worker 
131*1c60b9acSAndroid Build Coastguard Worker 
132*1c60b9acSAndroid Build Coastguard Worker 
133*1c60b9acSAndroid Build Coastguard Worker static int
t2_config_dump(struct lws_dll2 * d,void * user)134*1c60b9acSAndroid Build Coastguard Worker t2_config_dump(struct lws_dll2 *d, void *user)
135*1c60b9acSAndroid Build Coastguard Worker {
136*1c60b9acSAndroid Build Coastguard Worker #if !defined(LWS_WITH_NO_LOGS)
137*1c60b9acSAndroid Build Coastguard Worker 	t2_config_t *c = lws_container_of(d, t2_config_t, list);
138*1c60b9acSAndroid Build Coastguard Worker 
139*1c60b9acSAndroid Build Coastguard Worker 	lwsl_notice("%s:   id1 '%s'\n", __func__, c->id1);
140*1c60b9acSAndroid Build Coastguard Worker 	lwsl_notice("%s:   arg1 '%s'\n", __func__, c->arg1);
141*1c60b9acSAndroid Build Coastguard Worker 	lwsl_notice("%s:   ssid '%s'\n", __func__, c->ssid);
142*1c60b9acSAndroid Build Coastguard Worker 
143*1c60b9acSAndroid Build Coastguard Worker 	lwsl_notice("%s:   freq %d\n", __func__, c->frequency);
144*1c60b9acSAndroid Build Coastguard Worker 	lwsl_notice("%s:   arg2 %llu\n", __func__, c->arg2);
145*1c60b9acSAndroid Build Coastguard Worker 	lwsl_notice("%s:   priority %d\n", __func__, c->priority);
146*1c60b9acSAndroid Build Coastguard Worker 
147*1c60b9acSAndroid Build Coastguard Worker 	lwsl_notice("%s:      key1: %s, key2: %s\n", __func__,
148*1c60b9acSAndroid Build Coastguard Worker 			     c->creds->key1, c->creds->key2);
149*1c60b9acSAndroid Build Coastguard Worker #endif
150*1c60b9acSAndroid Build Coastguard Worker 
151*1c60b9acSAndroid Build Coastguard Worker 	return 0;
152*1c60b9acSAndroid Build Coastguard Worker }
153*1c60b9acSAndroid Build Coastguard Worker 
154*1c60b9acSAndroid Build Coastguard Worker static int
t2_configs_dump(t2_configs_t * t2cs)155*1c60b9acSAndroid Build Coastguard Worker t2_configs_dump(t2_configs_t *t2cs)
156*1c60b9acSAndroid Build Coastguard Worker {
157*1c60b9acSAndroid Build Coastguard Worker 	lwsl_notice("%s: number of configs: %d\n", __func__,
158*1c60b9acSAndroid Build Coastguard Worker 		    t2cs->configs.count);
159*1c60b9acSAndroid Build Coastguard Worker 
160*1c60b9acSAndroid Build Coastguard Worker 	lws_dll2_foreach_safe(&t2cs->configs, NULL, t2_config_dump);
161*1c60b9acSAndroid Build Coastguard Worker 
162*1c60b9acSAndroid Build Coastguard Worker 	return 0;
163*1c60b9acSAndroid Build Coastguard Worker }
164*1c60b9acSAndroid Build Coastguard Worker 
165*1c60b9acSAndroid Build Coastguard Worker 
166*1c60b9acSAndroid Build Coastguard Worker int
test2(void)167*1c60b9acSAndroid Build Coastguard Worker test2(void)
168*1c60b9acSAndroid Build Coastguard Worker {
169*1c60b9acSAndroid Build Coastguard Worker 	lws_struct_serialize_t *ser;
170*1c60b9acSAndroid Build Coastguard Worker 	struct lejp_ctx ctx;
171*1c60b9acSAndroid Build Coastguard Worker 	lws_struct_args_t a;
172*1c60b9acSAndroid Build Coastguard Worker 	t2_configs_t *top;
173*1c60b9acSAndroid Build Coastguard Worker 	uint8_t buf[4096];
174*1c60b9acSAndroid Build Coastguard Worker 	size_t written;
175*1c60b9acSAndroid Build Coastguard Worker 	int n, bad = 1;
176*1c60b9acSAndroid Build Coastguard Worker 
177*1c60b9acSAndroid Build Coastguard Worker 	lwsl_notice("%s: start \n", __func__);
178*1c60b9acSAndroid Build Coastguard Worker 
179*1c60b9acSAndroid Build Coastguard Worker 	memset(&a, 0, sizeof(a));
180*1c60b9acSAndroid Build Coastguard Worker 	a.map_st[0] = lsm_schema;
181*1c60b9acSAndroid Build Coastguard Worker 	a.map_entries_st[0] = LWS_ARRAY_SIZE(lsm_schema);
182*1c60b9acSAndroid Build Coastguard Worker 	a.ac_block_size = 512;
183*1c60b9acSAndroid Build Coastguard Worker 	lws_struct_json_init_parse(&ctx, NULL, &a);
184*1c60b9acSAndroid Build Coastguard Worker 
185*1c60b9acSAndroid Build Coastguard Worker 	n = lejp_parse(&ctx, (uint8_t *)test2_json, (int)strlen(test2_json));
186*1c60b9acSAndroid Build Coastguard Worker 	lwsl_notice("%s: lejp_parse %d\n", __func__, n);
187*1c60b9acSAndroid Build Coastguard Worker 	if (n < 0) {
188*1c60b9acSAndroid Build Coastguard Worker 		lwsl_err("%s: test2 JSON decode failed '%s'\n",
189*1c60b9acSAndroid Build Coastguard Worker 				__func__, lejp_error_to_string(n));
190*1c60b9acSAndroid Build Coastguard Worker 		goto bail;
191*1c60b9acSAndroid Build Coastguard Worker 	}
192*1c60b9acSAndroid Build Coastguard Worker 	lwsac_info(a.ac);
193*1c60b9acSAndroid Build Coastguard Worker 
194*1c60b9acSAndroid Build Coastguard Worker 	top = (t2_configs_t *)a.dest; /* the top level object */
195*1c60b9acSAndroid Build Coastguard Worker 
196*1c60b9acSAndroid Build Coastguard Worker 	if (!top) {
197*1c60b9acSAndroid Build Coastguard Worker 		lwsl_err("%s: no top level object\n", __func__);
198*1c60b9acSAndroid Build Coastguard Worker 		goto bail;
199*1c60b9acSAndroid Build Coastguard Worker 	}
200*1c60b9acSAndroid Build Coastguard Worker 	t2_configs_dump(top);
201*1c60b9acSAndroid Build Coastguard Worker 
202*1c60b9acSAndroid Build Coastguard Worker 	/* 2. Let's reserialize the top level object and see what comes out */
203*1c60b9acSAndroid Build Coastguard Worker 
204*1c60b9acSAndroid Build Coastguard Worker 	ser = lws_struct_json_serialize_create(&lsm_schema[0], 1,
205*1c60b9acSAndroid Build Coastguard Worker 					       LSSERJ_FLAG_OMIT_SCHEMA, top);
206*1c60b9acSAndroid Build Coastguard Worker 	if (!ser) {
207*1c60b9acSAndroid Build Coastguard Worker 		lwsl_err("%s: unable to init serialization\n", __func__);
208*1c60b9acSAndroid Build Coastguard Worker 		goto bail;
209*1c60b9acSAndroid Build Coastguard Worker 	}
210*1c60b9acSAndroid Build Coastguard Worker 
211*1c60b9acSAndroid Build Coastguard Worker 	do {
212*1c60b9acSAndroid Build Coastguard Worker 		n = (int)lws_struct_json_serialize(ser, buf, sizeof(buf), &written);
213*1c60b9acSAndroid Build Coastguard Worker 		switch (n) {
214*1c60b9acSAndroid Build Coastguard Worker 		case LSJS_RESULT_FINISH:
215*1c60b9acSAndroid Build Coastguard Worker 			puts((const char *)buf);
216*1c60b9acSAndroid Build Coastguard Worker 			break;
217*1c60b9acSAndroid Build Coastguard Worker 		case LSJS_RESULT_CONTINUE:
218*1c60b9acSAndroid Build Coastguard Worker 		case LSJS_RESULT_ERROR:
219*1c60b9acSAndroid Build Coastguard Worker 			goto bail;
220*1c60b9acSAndroid Build Coastguard Worker 		}
221*1c60b9acSAndroid Build Coastguard Worker 	} while (n == LSJS_RESULT_CONTINUE);
222*1c60b9acSAndroid Build Coastguard Worker 
223*1c60b9acSAndroid Build Coastguard Worker 	if (strcmp(test2_json_expected, (char *)buf)) {
224*1c60b9acSAndroid Build Coastguard Worker 		lwsl_err("%s: expected %s\n", __func__, test2_json_expected);
225*1c60b9acSAndroid Build Coastguard Worker 		goto bail;
226*1c60b9acSAndroid Build Coastguard Worker 	}
227*1c60b9acSAndroid Build Coastguard Worker 
228*1c60b9acSAndroid Build Coastguard Worker 	lws_struct_json_serialize_destroy(&ser);
229*1c60b9acSAndroid Build Coastguard Worker 
230*1c60b9acSAndroid Build Coastguard Worker 	bad = 0;
231*1c60b9acSAndroid Build Coastguard Worker 
232*1c60b9acSAndroid Build Coastguard Worker bail:
233*1c60b9acSAndroid Build Coastguard Worker 	lwsac_free(&a.ac);
234*1c60b9acSAndroid Build Coastguard Worker 
235*1c60b9acSAndroid Build Coastguard Worker 	return bad;
236*1c60b9acSAndroid Build Coastguard Worker }
237