xianhe/include/libwebsockets/abstract/transports/unit-test.h

 /*
 * libwebsockets - small server side websockets and web server implementation
 *
 * Copyright (C) 2010 - 2019 Andy Green <andy@warmcat.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 *
 * This is an abstract transport useful for unit testing abstract protocols.
 *
 * Instead of passing data anywhere, you give the transport a list of packets
 * to deliver and packets you expect back from the abstract protocol it's
 * bound to.
 */

enum {
	LWS_AUT_EXPECT_TEST_END					= (1 << 0),
	LWS_AUT_EXPECT_LOCAL_CLOSE				= (1 << 1),
	LWS_AUT_EXPECT_DO_REMOTE_CLOSE				= (1 << 2),
	LWS_AUT_EXPECT_TX /* expect this as tx from protocol */	= (1 << 3),
	LWS_AUT_EXPECT_RX /* present this as rx to protocol */	= (1 << 4),
	LWS_AUT_EXPECT_SHOULD_FAIL				= (1 << 5),
	LWS_AUT_EXPECT_SHOULD_TIMEOUT				= (1 << 6),
};

typedef enum {
	LPE_CONTINUE,
	LPE_SUCCEEDED,
	LPE_FAILED,
	LPE_FAILED_UNEXPECTED_TIMEOUT,
	LPE_FAILED_UNEXPECTED_PASS,
	LPE_FAILED_UNEXPECTED_CLOSE,
	LPE_SKIPPED,
	LPE_CLOSING
} lws_unit_test_packet_disposition;

typedef int (*lws_unit_test_packet_test_cb)(const void *cb_user, int disposition);
typedef int (*lws_unit_test_packet_cb)(lws_abs_t *instance);

/* each step in the unit test */

typedef struct lws_unit_test_packet {
	void				*buffer;
	lws_unit_test_packet_cb		pre;
	size_t				len;

	uint32_t			flags;
} lws_unit_test_packet_t;

/* each unit test */

typedef struct lws_unit_test {
	const char *		name; /* NULL indicates end of test array */
	lws_unit_test_packet_t *		expect_array;
	int			max_secs;
} lws_unit_test_t;

enum {
	LTMI_PEER_V_EXPECT_TEST = LTMI_TRANSPORT_BASE,	/* u.value */
	LTMI_PEER_V_EXPECT_RESULT_CB,			/* u.value */
	LTMI_PEER_V_EXPECT_RESULT_CB_ARG,		/* u.value */
};

LWS_VISIBLE LWS_EXTERN const char *
lws_unit_test_result_name(int in);