mbed-os/features/cellular/TESTS/socket/udp/main.cpp

/*
 * Copyright (c) 2018, Arm Limited and affiliates.
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#if !defined(MBED_CONF_NSAPI_PRESENT)
#error [NOT_SUPPORTED] A json configuration file is needed. Skipping this build.
#endif

#include "CellularUtil.h" // for CELLULAR_ helper macros
#include "CellularTargets.h"

#ifndef CELLULAR_DEVICE
#error [NOT_SUPPORTED] CELLULAR_DEVICE must be defined
#endif

#ifndef MBED_CONF_APP_CELLULAR_SIM_PIN
#error [NOT_SUPPORTED] SIM pin code is needed. Skipping this build.
#endif

#if defined(TARGET_ADV_WISE_1570) || defined(TARGET_MTB_ADV_WISE_1570)
#error [NOT_SUPPORTED] target MTB_ADV_WISE_1570 is too unstable for network tests, IoT network is unstable
#endif

#include "greentea-client/test_env.h"
#include "unity.h"
#include "utest.h"

#include "mbed.h"

#include "CellularContext.h"

#if MBED_CONF_CELLULAR_USE_APN_LOOKUP || MBED_CONF_PPP_CELL_IFACE_APN_LOOKUP
#include "APN_db.h"
#endif //MBED_CONF_CELLULAR_USE_APN_LOOKUP || MBED_CONF_PPP_CELL_IFACE_APN_LOOKUP

#include "../../cellular_tests_common.h"

#define NETWORK_TIMEOUT (180*1000)
#define SOCKET_TIMEOUT (30*1000)

#define ECHO_SERVER_NAME "echo.mbedcloudtesting.com"
#define ECHO_SERVER_UDP_PORT  8877

static CellularContext *ctx;
static SocketAddress echo_server_addr;
static rtos::EventFlags eventFlags;

class EchoSocket : public UDPSocket {
public:
    EchoSocket(int size) : UDPSocket(), _data(0), _size(size), _async_flag(0), _tx_pending(false), _rx_pending(false)
    {
    }
    virtual ~EchoSocket()
    {
        delete _data;
    }
    void set_async(int async)
    {
        _async_flag = async;
        if (_async_flag) {
            set_blocking(false);
            sigio(callback(this, &EchoSocket::async_callback));
        }
    }

    void test_sendto(const char *const hostname = NULL)
    {
        if (!_data) {
            _data = new uint8_t[_size];
            for (int i = 0; i < _size; i++) {
                _data[i] = (uint8_t)rand();
            }
        }
        nsapi_size_or_error_t ret;
        if (hostname) {
            ret = sendto(hostname, ECHO_SERVER_UDP_PORT, _data, _size);
        } else {
            ret = sendto(echo_server_addr, _data, _size);
        }
        if (ret == _size) { // send successful
            _tx_pending = false;
        } else {
            TEST_ASSERT(_async_flag && ret == NSAPI_ERROR_WOULD_BLOCK);
            _tx_pending = true;
        }
    }

    void test_recvfrom()
    {
        uint8_t *buf = new uint8_t[_size];
        memset(buf, 0, _size);
        SocketAddress recv_address;
        nsapi_size_or_error_t ret = recvfrom(&recv_address, buf, _size);
        if (ret == _size) { // recv successful
            _rx_pending = false;
            TEST_ASSERT(recv_address == echo_server_addr);
            TEST_ASSERT(memcmp(_data, buf, _size) == 0);
            delete _data;
            _data = NULL;
            _rx_pending = false;
        } else {
            TEST_ASSERT(_async_flag && ret == NSAPI_ERROR_WOULD_BLOCK);
            _rx_pending = true;
        }
        delete buf;
    }

    bool async_process()
    {
        if (_tx_pending) {
            test_sendto();
        }
        if (_rx_pending) {
            test_recvfrom();
        }
        return _tx_pending | _rx_pending;
    }

private:
    void async_callback()
    {
        eventFlags.set(_async_flag);
    }
    uint8_t *_data;
    int _size;
    uint32_t _async_flag; // 0 for blocking socket, signal bit for async
    bool _tx_pending;
    bool _rx_pending;
};

static void udp_network_stack()
{
    ctx = CellularContext::get_default_instance();
    TEST_ASSERT(ctx != NULL);
    ctx->set_sim_pin(MBED_CONF_APP_CELLULAR_SIM_PIN);
#ifdef MBED_CONF_APP_APN
    ctx->set_credentials(MBED_CONF_APP_APN, MBED_CONF_APP_USERNAME, MBED_CONF_APP_PASSWORD);
#endif
    TEST_ASSERT(ctx->connect() == NSAPI_ERROR_OK);
}

static void udp_gethostbyname()
{
    TEST_ASSERT(ctx->gethostbyname(ECHO_SERVER_NAME, &echo_server_addr) == 0);
    tr_info("Echo server IP: %s", echo_server_addr.get_ip_address());
    echo_server_addr.set_port(7);
}

static void udp_socket_send_receive()
{
    EchoSocket echo_socket(4);
    TEST_ASSERT(echo_socket.open(ctx) == NSAPI_ERROR_OK);
    echo_socket.set_blocking(true);
    echo_socket.set_timeout(SOCKET_TIMEOUT);
    echo_socket.test_sendto();
    echo_socket.test_recvfrom();
    TEST_ASSERT(echo_socket.close() == NSAPI_ERROR_OK);
}

static void udp_socket_send_receive_async()
{
    int async_flag = 1;
    TEST_ASSERT(!(eventFlags.clear(async_flag) & osFlagsError));

    EchoSocket echo_socket(4);
    TEST_ASSERT(echo_socket.open(ctx) == NSAPI_ERROR_OK);
    echo_socket.set_async(async_flag);
    echo_socket.test_sendto();
    echo_socket.test_recvfrom();

    while (true) {
        TEST_ASSERT((eventFlags.wait_any(async_flag, SOCKET_TIMEOUT) & (osFlagsError)) != osFlagsError);
        if (!echo_socket.async_process()) {
            break;
        }
    }
    TEST_ASSERT(echo_socket.close() == NSAPI_ERROR_OK);
}

using namespace utest::v1;

static utest::v1::status_t greentea_failure_handler(const Case *const source, const failure_t reason)
{
#if MBED_CONF_MBED_TRACE_ENABLE
    trace_close();
#endif
    greentea_case_failure_abort_handler(source, reason);
    return STATUS_ABORT;
}

static Case cases[] = {
    Case("UDP network stack", udp_network_stack, greentea_failure_handler),
    Case("UDP gethostbyname", udp_gethostbyname, greentea_failure_handler),
    Case("UDP socket send/receive", udp_socket_send_receive, greentea_failure_handler),
    Case("UDP socket send/receive async", udp_socket_send_receive_async, greentea_failure_handler),
};

static utest::v1::status_t test_setup(const size_t number_of_cases)
{
    GREENTEA_SETUP(10 * 60, "default_auto"); // network registration may take up to 180 seconds, DNS query a couple of minutes, etc.
    return verbose_test_setup_handler(number_of_cases);
}

static Specification specification(test_setup, cases);

int main()
{
#if MBED_CONF_MBED_TRACE_ENABLE
    trace_open();
#endif
    int ret = Harness::run(specification);
#if MBED_CONF_MBED_TRACE_ENABLE
    trace_close();
#endif
    return ret;
}