/***************************************************************************/
/* 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                                            */
/***************************************************************************/

/* MQTT connect test.  This test case validates MQTT client keepalive feature. */

#include   "tx_api.h"
#include   "nx_api.h"
#include   "nxd_mqtt_client.h"
extern void    test_control_return(UINT status);
#define     DEMO_STACK_SIZE    2048

#define CLIENT_ID "1234"
#define TOPIC1    "topic1"
#define MESSAGE1  "message1"

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

static TX_THREAD               ntest_0;
static TX_THREAD               ntest_1;

static NX_PACKET_POOL          pool_0;
static NX_IP                   ip_0;
static NX_IP                   ip_1;
static NX_TCP_SOCKET           server_socket;


#define NUM_PACKETS                 24
#define PACKET_SIZE                 1536
#define PACKET_POOL_SIZE            (NUM_PACKETS * (PACKET_SIZE + sizeof(NX_PACKET)))

#ifdef NX_SECURE_ENABLE

#include "../web_test/test_device_cert.c"
#include "../web_test/test_ca_cert.c"

/* Declare external cryptosuites. */
extern const NX_SECURE_TLS_CRYPTO nx_crypto_tls_ciphers;

static NX_SECURE_TLS_SESSION tls_server_session;
static NX_SECURE_X509_CERT server_local_certificate;

/* Define crypto metadata buffer. */
static UCHAR client_metadata[5*4096];
static UCHAR server_metadata[5*4096];

/* For remote certificate. */
static NX_SECURE_X509_CERT remote_certificate, remote_issuer, ca_certificate;
static UCHAR remote_cert_buffer[2000];
static UCHAR remote_issuer_buffer[2000];
static UCHAR tls_packet_buffer[2][4096];

#define TEST_LOOP 2
#else
#define TEST_LOOP 1
#endif

static TX_SEMAPHORE semaphore_server_start;
static TX_SEMAPHORE semaphore_client_stop;

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

static ULONG                   error_counter;

/* Define thread prototypes.  */

static void    ntest_0_entry(ULONG thread_input);
static void    ntest_1_entry(ULONG thread_input);
extern void    _nx_ram_network_driver(struct NX_IP_DRIVER_STRUCT *driver_req);

extern void SET_ERROR_COUNTER(ULONG *error_counter, CHAR *filename, int line_number);

static int client_disconnected = 0;

/* Define what the initial system looks like.  */
static NXD_MQTT_CLIENT *client_ptr;
static UCHAR *client_memory;
static CHAR *stack_ptr;
#define CLIENT_MEMORY_SIZE 1024
#ifdef CTEST
VOID test_application_define(void *first_unused_memory)
#else
void       netx_mqtt_client_keepalive_timeout_application_define(void *first_unused_memory)
#endif
{
CHAR       *pointer;
UINT       status;

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

    error_counter = 0;

    /* 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_DONT_START);

    pointer = pointer + DEMO_STACK_SIZE;

    /* Create the main thread.  */
    tx_thread_create(&ntest_1, "thread 1", ntest_1_entry, 0,
                     pointer, DEMO_STACK_SIZE, 
                     3, 3, TX_NO_TIME_SLICE, TX_AUTO_START);

    pointer = pointer + DEMO_STACK_SIZE;

    tx_semaphore_create(&semaphore_server_start, "semaphore server start", 0);
    tx_semaphore_create(&semaphore_client_stop, "semaphore client stop", 0);

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

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

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

    /* Create an IP instance.  */
    status = nx_ip_create(&ip_0, "NetX IP Instance 0", IP_ADDRESS(1, 2, 3, 4), 0xFFFFFF00UL, &pool_0, _nx_ram_network_driver,
                          pointer, 2048, 1);
    pointer = pointer + 2048;

    /* Create another IP instance.  */
    status += nx_ip_create(&ip_1, "NetX IP Instance 1", IP_ADDRESS(1, 2, 3, 5), 0xFFFFFF00UL, &pool_0, _nx_ram_network_driver,
                           pointer, 2048, 1);
    pointer = pointer + 2048;

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

    /* Enable ARP and supply ARP cache memory for IP Instance 0.  */
    status = nx_arp_enable(&ip_0, (void *) pointer, 1024);
    pointer = pointer + 1024;

    /* Enable ARP and supply ARP cache memory for IP Instance 1.  */
    status += nx_arp_enable(&ip_1, (void *) pointer, 1024);
    pointer = pointer + 1024;

    /* Check ARP enable status.  */
    if(status)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

    /* Enable TCP processing for both IP instances.  */
    status = nx_tcp_enable(&ip_0);
    status += nx_tcp_enable(&ip_1);

    /* Check TCP enable status.  */
    if(status)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);
    stack_ptr = pointer;
    pointer += DEMO_STACK_SIZE;

    client_memory = pointer;
    pointer += CLIENT_MEMORY_SIZE;

    client_ptr = (NXD_MQTT_CLIENT*)pointer;
}

#ifdef NX_SECURE_ENABLE

/* Define the callback function for tls connection. */
static UINT client_tls_setup(NXD_MQTT_CLIENT* client_ptr, NX_SECURE_TLS_SESSION* tls_session,
                             NX_SECURE_X509_CERT* certificate, NX_SECURE_X509_CERT* trusted_certificate)
{
UINT status;

    /* Create a tls session. */
    status = nx_secure_tls_session_create(tls_session,
                                          &nx_crypto_tls_ciphers,
                                          client_metadata,
                                          sizeof(client_metadata));

    if (status)
    {
        return status;
    }
    
    nx_secure_tls_session_packet_buffer_set(tls_session, tls_packet_buffer[0], sizeof(tls_packet_buffer[0]));
    nx_secure_tls_remote_certificate_allocate(tls_session, &remote_certificate, remote_cert_buffer, sizeof(remote_cert_buffer));
    nx_secure_tls_remote_certificate_allocate(tls_session, &remote_issuer, remote_issuer_buffer, sizeof(remote_issuer_buffer));

    nx_secure_x509_certificate_initialize(&ca_certificate, test_ca_cert_der, test_ca_cert_der_len,
                                          NX_NULL, 0, NX_NULL, 0, NX_SECURE_X509_KEY_TYPE_NONE);
    nx_secure_tls_trusted_certificate_add(tls_session, &ca_certificate);

    return(NX_SUCCESS);
}

static UINT server_tls_setup(NX_SECURE_TLS_SESSION *tls_session)
{
UINT status;

    status = nx_secure_tls_session_create(tls_session,
                                          &nx_crypto_tls_ciphers,
                                          server_metadata,
                                          sizeof(server_metadata));
    if (status)
    {
        return status;
    }

    memset(&server_local_certificate, 0, sizeof(server_local_certificate));
    nx_secure_x509_certificate_initialize(&server_local_certificate,
                                          test_device_cert_der, test_device_cert_der_len,
                                          NX_NULL, 0, test_device_cert_key_der,
                                          test_device_cert_key_der_len, NX_SECURE_X509_KEY_TYPE_RSA_PKCS1_DER);

    nx_secure_tls_local_certificate_add(tls_session, &server_local_certificate);

    nx_secure_tls_session_packet_buffer_set(tls_session, tls_packet_buffer[1], sizeof(tls_packet_buffer[1]));

    return(NX_SUCCESS);
}
#endif

#define MQTT_CLIENT_THREAD_PRIORITY  2
static UINT keepalive_value;
static UINT cleansession_value;
static UINT connection_flag_value;
static UINT QoS;
static UINT retain;
/* Define the test threads.  */
/* This thread sets up MQTT client and makes a connect request without username/password. */
static void    ntest_0_entry(ULONG thread_input)
{
UINT       status;
NXD_ADDRESS server_address;
UINT        i;

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

    /* Check for earlier error.  */
    if(error_counter)
    {
        printf("ERROR!\n");
        test_control_return(1);
    }

    status = nxd_mqtt_client_create(client_ptr, "my client", CLIENT_ID, strlen(CLIENT_ID), &ip_0, &pool_0,
        stack_ptr, DEMO_STACK_SIZE, MQTT_CLIENT_THREAD_PRIORITY, client_memory, CLIENT_MEMORY_SIZE);
    if (status)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);
    tx_thread_sleep(1);

    for (i = 0; i < TEST_LOOP; i++)
    {

        server_address.nxd_ip_version = 4;
        server_address.nxd_ip_address.v4 = IP_ADDRESS(1, 2, 3, 5);
        keepalive_value = 1;
        cleansession_value = 0;
        client_disconnected = 0;

        tx_semaphore_get(&semaphore_server_start, NX_WAIT_FOREVER);

        if (i == 0)
        {
            status = nxd_mqtt_client_connect(client_ptr, &server_address, NXD_MQTT_PORT,
                                             keepalive_value, cleansession_value, NX_IP_PERIODIC_RATE);
#ifdef NXD_MQTT_REQUIRE_TLS
            if (status != NXD_MQTT_CONNECT_FAILURE)
                SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

            tx_semaphore_put(&semaphore_client_stop);
            continue;
#endif
        }
#ifdef NX_SECURE_ENABLE
        else
        {
            status = nxd_mqtt_client_secure_connect(client_ptr, &server_address, NXD_MQTT_PORT,
                                                    client_tls_setup,
                                                    keepalive_value, cleansession_value, NX_IP_PERIODIC_RATE);
        }
#endif
        if (status)
            SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

        QoS = 1;
        retain = 0;

        if (i == 0)
        {
            /* Sleep for 60 ticks */
            tx_thread_sleep(60);
        }

        /* Issue a subscribe command. */
        status = nxd_mqtt_client_publish(client_ptr, TOPIC1, strlen(TOPIC1), MESSAGE1, strlen(MESSAGE1), retain, QoS, 1);
        if (status)
            SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

        /* Sleep for 150 ticks, expect MQTT PINGREQ */
        tx_thread_sleep(150);

        if (client_disconnected == 0)
            SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

        nxd_mqtt_client_disconnect(client_ptr);

        tx_semaphore_put(&semaphore_client_stop);
    }

    nxd_mqtt_client_delete(client_ptr);

    /* Determine if the test was successful.  */
    if(error_counter)
    {
        printf("ERROR!\n");
        test_control_return(1);
    }
    else
    {
        printf("SUCCESS!\n");
        test_control_return(0);
    }
}


static UCHAR content[100];


static void ntest_1_disconnect_callback(NX_TCP_SOCKET *server_socket_ptr)
{

    client_disconnected = 1;


}
/* This thread acts as MQTT server, accepting the connection. */
static void    ntest_1_entry(ULONG thread_input)
{
UINT       status;
ULONG      actual_status;
NX_PACKET  *packet_ptr;
UCHAR      *byte;
USHORT      packet_id;
UINT        publish_time;
UINT        ping_time;
UINT        i;

    /* Ensure the IP instance has been initialized.  */
    status = nx_ip_status_check(&ip_1, NX_IP_INITIALIZE_DONE, &actual_status, NX_IP_PERIODIC_RATE);

    /* Check for error.  */
    if(status)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

    /* Create a socket.  */
    status = nx_tcp_socket_create(&ip_1, &server_socket, "Server Socket", 
                                  NX_IP_NORMAL, NX_FRAGMENT_OKAY, NX_IP_TIME_TO_LIVE, 1000,
                                  NX_NULL, ntest_1_disconnect_callback);

    /* Check for error.  */
    if(status)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

    /* Setup this thread to listen.  */
    status = nx_tcp_server_socket_listen(&ip_1, NXD_MQTT_PORT, &server_socket, 5, NX_NULL);

    /* Check for error.  */
    if(status)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

#ifdef NX_SECURE_ENABLE
    /* Session setup.  */
    server_tls_setup(&tls_server_session);
#endif

    tx_thread_resume(&ntest_0);

    for (i = 0; i < TEST_LOOP; i++)
    {

        tx_semaphore_put(&semaphore_server_start);

        /* Accept a connection from client socket.  */
        status = nx_tcp_server_socket_accept(&server_socket, NX_IP_PERIODIC_RATE);

        /* Check for error.  */
        if (status)
        {
#ifdef NXD_MQTT_REQUIRE_TLS
            if (i == 1)
#endif
                SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);
        }

#ifdef NX_SECURE_ENABLE
        if (i == 1)
        {
            status = nx_secure_tls_session_start(&tls_server_session, &server_socket, NX_WAIT_FOREVER);
            if (status)
                SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);
        }
#endif

        tx_thread_sleep(1);
        if (i == 0)
        {
            status = nx_tcp_socket_receive(&server_socket, &packet_ptr, 5 * NX_IP_PERIODIC_RATE);
        }
#ifdef NX_SECURE_ENABLE
        else
        {
            status = nx_secure_tls_session_receive(&tls_server_session, &packet_ptr, NX_WAIT_FOREVER);
        }
#endif

        if (status)
        {
#ifdef NXD_MQTT_REQUIRE_TLS
            if (i == 1)
#endif
                SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);
        }
        else
        {

#ifdef NX_SECURE_ENABLE
            if (i == 1)
            {
                nx_packet_release(packet_ptr);
                status = nx_secure_tls_packet_allocate(&tls_server_session, &pool_0, &packet_ptr, NX_NO_WAIT);
                if (status)
                    SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);
            }
#endif

            /* Response with Connect SUCCESS */
            byte = packet_ptr->nx_packet_prepend_ptr;
            byte[0] = 0x20;
            byte[1] = 0x02;
            byte[2] = 0;
            byte[3] = 0;

            packet_ptr->nx_packet_append_ptr = packet_ptr->nx_packet_prepend_ptr + 4;
            packet_ptr->nx_packet_length = 4;

            if (i == 0)
            {
                status = nx_tcp_socket_send(&server_socket, packet_ptr, 1);
                if (status)
                    SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

                status = nx_tcp_socket_receive(&server_socket, &packet_ptr, 100);
            }
#ifdef NX_SECURE_ENABLE
            else
            {
                status = nx_secure_tls_session_send(&tls_server_session, packet_ptr, NX_WAIT_FOREVER);
                if (status)
                    SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

                status = nx_secure_tls_session_receive(&tls_server_session, &packet_ptr, NX_WAIT_FOREVER);

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

            publish_time = tx_time_get();

            /* construct the publish message. */
            byte = content;
            *byte++ = 0x30 | ((*(packet_ptr->nx_packet_prepend_ptr) & 0x0F)); /* Publish */
            byte++; /* Skip the length field. */
            *byte++ = (strlen(TOPIC1) >> 8) & 0xFF;
            *byte++ = strlen(TOPIC1) & 0xFF;
            /* Fill in the topic string. */
            memcpy(byte, TOPIC1, strlen(TOPIC1));
            byte += strlen(TOPIC1);
            if (((content[0] & 6) >> 1) != 0)
            {
                packet_id = packet_ptr->nx_packet_prepend_ptr[byte - content];/* Fill in packet ID MSB. */
                packet_id = (packet_id << 8) | packet_ptr->nx_packet_prepend_ptr[byte - content + 1];/* Fill in packet ID MSB. */
                *byte++ = ((packet_id >> 8) & 0xFF);
                *byte++ = (packet_id & 0xFF);
            }
            /* Fill in the message being pulished. */

            memcpy(byte, MESSAGE1, strlen(MESSAGE1));
            byte += strlen(MESSAGE1);

            /* Fill in the QoS and Retain information. */
            content[0] = content[0] & 0xF8;
            content[0] = content[0] | (QoS << 1);
            if (retain)
                content[0] = content[0] | 1;


            /* Now validate message length */
            if (packet_ptr->nx_packet_length != (byte - content))
                SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

            /* Fill in the remaining length field. */
            content[1] = (packet_ptr->nx_packet_length - 2) & 0xFF;

            /* Validate the MQTT pubish request. */
            if (memcmp(packet_ptr->nx_packet_prepend_ptr, content, packet_ptr->nx_packet_length))
                SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

#ifdef NX_SECURE_ENABLE
            if (i == 1)
            {
                nx_packet_release(packet_ptr);
                status = nx_secure_tls_packet_allocate(&tls_server_session, &pool_0, &packet_ptr, NX_NO_WAIT);
                if (status)
                    SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);
            }
#endif

            if (((content[0] & 0x6) >> 1) == 1)
            {
                /* QoS 1: Respond with PUBACK */
                byte = packet_ptr->nx_packet_prepend_ptr;
                byte[0] = 0x40;
                byte[1] = 0x02;
                byte[2] = (packet_id >> 8) & 0xFF;
                byte[3] = packet_id & 0xFF;
                packet_ptr->nx_packet_append_ptr = packet_ptr->nx_packet_prepend_ptr + 4;
                packet_ptr->nx_packet_length = 4;
            }
            if (((content[0] & 0x6) >> 1) == 2)
            {
                byte = packet_ptr->nx_packet_prepend_ptr;
                byte[0] = 0x50;
                byte[1] = 0x02;
                byte[2] = (packet_id >> 8) & 0xFF;
                byte[3] = packet_id & 0xFF;
                packet_ptr->nx_packet_append_ptr = packet_ptr->nx_packet_prepend_ptr + 4;
                packet_ptr->nx_packet_length = 4;
            }
            if (((content[0] & 0x6) >> 1) != 0)
            {
                if (i == 0)
                {
                    status = nx_tcp_socket_send(&server_socket, packet_ptr, 1);
                }
#ifdef NX_SECURE_ENABLE
                else
                {
                    status = nx_secure_tls_session_send(&tls_server_session, packet_ptr, NX_WAIT_FOREVER);
                }
#endif
                if (status)
                {
                    SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);
                    nx_packet_release(packet_ptr);
                }
            }

            if (i == 0)
            {
                status = nx_tcp_socket_receive(&server_socket, &packet_ptr, 100);
            }
#ifdef NX_SECURE_ENABLE
            else
            {
                status = nx_secure_tls_session_receive(&tls_server_session, &packet_ptr, NX_WAIT_FOREVER);
            }
#endif
            if (status)
                SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

            ping_time = tx_time_get();
            if ((packet_ptr->nx_packet_prepend_ptr[0] == 0xc0) && (packet_ptr->nx_packet_prepend_ptr[1] == 0))
            {
                /* This is the ping message. */
                if ((ping_time - publish_time) > (keepalive_value * TX_TIMER_TICKS_PER_SECOND))
                    SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

                /* Validate that ping was sent. */
                if (client_ptr->nxd_mqtt_ping_not_responded != NX_TRUE)
                    SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

                /* In this test the server does not send a pingresp.  This should force the client to
                   timeout and closes the connection. */


                if (client_ptr->nxd_mqtt_ping_not_responded == NX_FALSE)
                    SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);
            }
            else
                SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

            tx_thread_sleep(50);

#ifdef NX_SECURE_ENABLE
            if (i == 1)
            {
                /* End session.  */
                nx_secure_tls_session_end(&tls_server_session, NX_NO_WAIT);
            }
#endif

            /* Disconnect.  */
            status = nx_tcp_socket_disconnect(&server_socket, NX_IP_PERIODIC_RATE);

            /* Check for error.  */
            if (status)
                SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);
        }

        tx_semaphore_get(&semaphore_client_stop, NX_WAIT_FOREVER);

        /* Unaccept the server socket.  */
        status = nx_tcp_server_socket_unaccept(&server_socket);

        /* Check for error.  */
        if (status)
            SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

        /* Prepare to accept another connection. */
        status = nx_tcp_server_socket_relisten(&ip_1, NXD_MQTT_PORT, &server_socket);

        /* Check for error.  */
        if (status)
            SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);
    }

#ifdef NX_SECURE_ENABLE
    /* Delete the session.  */
    nx_secure_tls_session_delete(&tls_server_session);
#endif

    /* Unlisten on the server port.  */
    status =  nx_tcp_server_socket_unlisten(&ip_1, NXD_MQTT_PORT);

    /* Check for error.  */
    if (status)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);

    /* Delete the socket.  */
    status = nx_tcp_socket_delete(&server_socket);

    /* Check for error.  */
    if(status)
        SET_ERROR_COUNTER(&error_counter, __FILE__, __LINE__);
}