Merge branch 'feature/esp_mqtt_as_managed_component' into 'master'

[MQTT] - Moves compile definition out of idf

See merge request espressif/esp-idf!20651

.gitlab/ci/host-test.yml

@@ -350,7 +350,7 @@ test_nvs_page:
 test_mqtt_on_host:
   extends: .host_test_template
   script:
-    - cd ${IDF_PATH}/components/mqtt/host_test
+    - cd ${IDF_PATH}/components/mqtt/esp-mqtt/host_test
     - idf.py build
     - LSAN_OPTIONS=verbosity=1:log_threads=1 build/host_mqtt_client_test.elf
 

components/mqtt/CMakeLists.txt

@@ -1,13 +1 @@
-set(srcs esp-mqtt/mqtt_client.c esp-mqtt/lib/mqtt_msg.c esp-mqtt/lib/mqtt_outbox.c esp-mqtt/lib/platform_esp32_idf.c)
-
-if(CONFIG_MQTT_PROTOCOL_5)
-    list(APPEND srcs esp-mqtt/lib/mqtt5_msg.c esp-mqtt/mqtt5_client.c)
-endif()
-
-idf_component_register(SRCS "${srcs}"
-                    INCLUDE_DIRS esp-mqtt/include
-                    PRIV_INCLUDE_DIRS "esp-mqtt/lib/include"
-                    REQUIRES esp_event tcp_transport
-                    PRIV_REQUIRES esp_timer http_parser esp_hw_support heap
-                    )
-target_compile_options(${COMPONENT_LIB} PRIVATE "-Wno-format")
+include(${CMAKE_CURRENT_LIST_DIR}/esp-mqtt/CMakeLists.txt)

components/mqtt/Kconfig

@@ -1,166 +0,0 @@
-menu "ESP-MQTT Configurations"
-
-    config MQTT_PROTOCOL_311
-        bool "Enable MQTT protocol 3.1.1"
-        default y
-        help
-            If not, this library will use MQTT protocol 3.1
-
-    config MQTT_PROTOCOL_5
-        bool "Enable MQTT protocol 5.0"
-        default n
-        help
-            If not, this library will not support MQTT 5.0
-
-    config MQTT_TRANSPORT_SSL
-        bool "Enable MQTT over SSL"
-        default y
-        help
-            Enable MQTT transport over SSL with mbedtls
-
-    config MQTT_TRANSPORT_WEBSOCKET
-        bool "Enable MQTT over Websocket"
-        default y
-        depends on WS_TRANSPORT
-        help
-            Enable MQTT transport over Websocket.
-
-    config MQTT_TRANSPORT_WEBSOCKET_SECURE
-        bool "Enable MQTT over Websocket Secure"
-        default y
-        depends on MQTT_TRANSPORT_WEBSOCKET
-        depends on MQTT_TRANSPORT_SSL
-        help
-            Enable MQTT transport over Websocket Secure.
-
-    config MQTT_MSG_ID_INCREMENTAL
-        bool "Use Incremental Message Id"
-        default n
-        help
-            Set this to true for the message id (2.3.1 Packet Identifier) to be generated
-            as an incremental number rather then a random value (used by default)
-
-    config MQTT_SKIP_PUBLISH_IF_DISCONNECTED
-        bool "Skip publish if disconnected"
-        default n
-        help
-            Set this to true to avoid publishing (enqueueing messages) if the client is disconnected.
-            The MQTT client tries to publish all messages by default, even in the disconnected state
-            (where the qos1 and qos2 packets are stored in the internal outbox to be published later)
-            The MQTT_SKIP_PUBLISH_IF_DISCONNECTED option allows applications to override this behaviour
-            and not enqueue publish packets in the disconnected state.
-
-    config MQTT_REPORT_DELETED_MESSAGES
-        bool "Report deleted messages"
-        default n
-        help
-            Set this to true to post events for all messages which were deleted from the outbox
-            before being correctly sent and confirmed.
-
-    config MQTT_USE_CUSTOM_CONFIG
-        bool "MQTT Using custom configurations"
-        default n
-        help
-            Custom MQTT configurations.
-
-    config MQTT_TCP_DEFAULT_PORT
-        int "Default MQTT over TCP port"
-        default 1883
-        depends on MQTT_USE_CUSTOM_CONFIG
-        help
-            Default MQTT over TCP port
-
-    config MQTT_SSL_DEFAULT_PORT
-        int "Default MQTT over SSL port"
-        default 8883
-        depends on MQTT_USE_CUSTOM_CONFIG
-        depends on MQTT_TRANSPORT_SSL
-        help
-            Default MQTT over SSL port
-
-    config MQTT_WS_DEFAULT_PORT
-        int "Default MQTT over Websocket port"
-        default 80
-        depends on MQTT_USE_CUSTOM_CONFIG
-        depends on MQTT_TRANSPORT_WEBSOCKET
-        help
-            Default MQTT over Websocket port
-
-    config MQTT_WSS_DEFAULT_PORT
-        int "Default MQTT over Websocket Secure port"
-        default 443
-        depends on MQTT_USE_CUSTOM_CONFIG
-        depends on MQTT_TRANSPORT_WEBSOCKET
-        depends on MQTT_TRANSPORT_WEBSOCKET_SECURE
-        help
-            Default MQTT over Websocket Secure port
-
-    config MQTT_BUFFER_SIZE
-        int "Default MQTT Buffer Size"
-        default 1024
-        depends on MQTT_USE_CUSTOM_CONFIG
-        help
-            This buffer size using for both transmit and receive
-
-    config MQTT_TASK_STACK_SIZE
-        int "MQTT task stack size"
-        default 6144
-        depends on MQTT_USE_CUSTOM_CONFIG
-        help
-            MQTT task stack size
-
-    config MQTT_DISABLE_API_LOCKS
-        bool "Disable API locks"
-        default n
-        depends on MQTT_USE_CUSTOM_CONFIG
-        help
-            Default config employs API locks to protect internal structures. It is possible to disable
-            these locks if the user code doesn't access MQTT API from multiple concurrent tasks
-
-    config MQTT_TASK_PRIORITY
-        int "MQTT task priority"
-        default 5
-        depends on MQTT_USE_CUSTOM_CONFIG
-        help
-            MQTT task priority. Higher number denotes higher priority.
-
-    config MQTT_EVENT_QUEUE_SIZE
-        int "Number of queued events."
-        default 1
-        depends on MQTT_USE_CUSTOM_CONFIG
-        help
-            A value higher than 1 enables multiple queued events.
-
-    config MQTT_TASK_CORE_SELECTION_ENABLED
-        bool "Enable MQTT task core selection"
-        help
-            This will enable core selection
-
-    choice MQTT_TASK_CORE_SELECTION
-        depends on MQTT_TASK_CORE_SELECTION_ENABLED
-        prompt "Core to use ?"
-        config MQTT_USE_CORE_0
-            bool "Core 0"
-        config MQTT_USE_CORE_1
-            bool "Core 1"
-    endchoice
-
-    config MQTT_CUSTOM_OUTBOX
-        bool "Enable custom outbox implementation"
-        default n
-        help
-            Set to true if a specific implementation of message outbox is needed (e.g. persistent outbox in NVM or
-            similar).
-            Note: Implementation of the custom outbox must be added to the mqtt component. These CMake commands
-            could be used to append the custom implementation to lib-mqtt sources:
-            idf_component_get_property(mqtt mqtt COMPONENT_LIB)
-            set_property(TARGET ${mqtt} PROPERTY SOURCES ${PROJECT_DIR}/custom_outbox.c APPEND)
-
-    config MQTT_OUTBOX_EXPIRED_TIMEOUT_MS
-        int "Outbox message expired timeout[ms]"
-        default 30000
-        depends on MQTT_USE_CUSTOM_CONFIG
-        help
-            Messages which stays in the outbox longer than this value before being published will be discarded.
-
-endmenu

components/mqtt/esp-mqtt

@@ -1 +1 @@
-Subproject commit fde00340f19b9f5ae81fff02ccfa9926f0e33687
+Subproject commit dffabb067fb3c39f486033d2e47eb4b1416f0c82

components/mqtt/host_test/CMakeLists.txt

@@ -1,17 +0,0 @@
-cmake_minimum_required(VERSION 3.16)
-
-include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-set(COMPONENTS main)
-list(APPEND EXTRA_COMPONENT_DIRS
-                                 "mocks/heap/"
-                                 "$ENV{IDF_PATH}/tools/mocks/esp_hw_support/"
-                                 "$ENV{IDF_PATH}/tools/mocks/freertos/"
-                                 "$ENV{IDF_PATH}/tools/mocks/esp_timer/"
-                                 "$ENV{IDF_PATH}/tools/mocks/esp_event/"
-                                 "$ENV{IDF_PATH}/tools/mocks/lwip/"
-                                 "$ENV{IDF_PATH}/tools/mocks/esp-tls/"
-                                 "$ENV{IDF_PATH}/tools/mocks/http_parser/"
-                                 "$ENV{IDF_PATH}/tools/mocks/tcp_transport/"
-                                 )
-
-project(host_mqtt_client_test)

components/mqtt/host_test/README.md

@@ -1,30 +0,0 @@
-| Supported Targets | Linux |
-| ----------------- | ----- |
-
-# Description
-
-This directory contains test code for the mqtt client that runs on host.
-
-Tests are written using [Catch2](https://github.com/catchorg/Catch2) test framework 
-
-# Build
-
-Tests build regularly like an idf project. 
-
-```
-idf.py build
-```
-
-# Run
-
-The build produces an executable in the build folder. 
-
-Just run:
-
-```
-./build/host_mqtt_client_test.elf
-```
-
-The test executable have some options provided by the test framework. 
-
-

components/mqtt/host_test/main/CMakeLists.txt

@@ -1,3 +0,0 @@
-idf_component_register(SRCS  "test_mqtt_client.cpp"
-                       INCLUDE_DIRS "$ENV{IDF_PATH}/tools/catch"
-                       REQUIRES cmock mqtt esp_timer esp_hw_support http_parser log)

components/mqtt/host_test/main/test_mqtt_client.cpp

@@ -1,121 +0,0 @@
-#define CATCH_CONFIG_MAIN  // This tells the catch header to generate a main
-#include "catch.hpp"
-
-extern "C" {
-#include "Mockesp_event.h"
-#include "Mockesp_mac.h"
-#include "Mockesp_transport.h"
-#include "Mockesp_transport_ssl.h"
-#include "Mockesp_transport_tcp.h"
-#include "Mockesp_transport_ws.h"
-#include "Mockevent_groups.h"
-#include "Mockhttp_parser.h"
-#include "Mockqueue.h"
-#include "Mocktask.h"
-#include "Mockesp_timer.h"
-
-    /*
-     * The following functions are not directly called but the generation of them
-     * from cmock is broken, so we need to define them here.
-     */
-    esp_err_t esp_tls_get_and_clear_last_error(esp_tls_error_handle_t h, int *esp_tls_code, int *esp_tls_flags)
-    {
-        return ESP_OK;
-    }
-}
-
-#include "mqtt_client.h"
-
-struct ClientInitializedFixture {
-    esp_mqtt_client_handle_t client;
-    ClientInitializedFixture()
-    {
-        [[maybe_unused]] auto protect = TEST_PROTECT();
-        int mtx;
-        int transport_list;
-        int transport;
-        int event_group;
-        uint8_t mac[] = {0xAA, 0x55, 0xAA, 0x55, 0xAA, 0x55};
-        esp_timer_get_time_IgnoreAndReturn(0);
-        xQueueTakeMutexRecursive_IgnoreAndReturn(true);
-        xQueueGiveMutexRecursive_IgnoreAndReturn(true);
-        xQueueCreateMutex_ExpectAnyArgsAndReturn(
-            reinterpret_cast<QueueHandle_t>(&mtx));
-        xEventGroupCreate_IgnoreAndReturn(reinterpret_cast<EventGroupHandle_t>(&event_group));
-        esp_transport_list_init_IgnoreAndReturn(reinterpret_cast<esp_transport_list_handle_t>(&transport_list));
-        esp_transport_tcp_init_IgnoreAndReturn(reinterpret_cast<esp_transport_handle_t>(&transport));
-        esp_transport_ssl_init_IgnoreAndReturn(reinterpret_cast<esp_transport_handle_t>(&transport));
-        esp_transport_ws_init_IgnoreAndReturn(reinterpret_cast<esp_transport_handle_t>(&transport));
-        esp_transport_ws_set_subprotocol_IgnoreAndReturn(ESP_OK);
-        esp_transport_list_add_IgnoreAndReturn(ESP_OK);
-        esp_transport_set_default_port_IgnoreAndReturn(ESP_OK);
-        http_parser_parse_url_IgnoreAndReturn(0);
-        http_parser_url_init_ExpectAnyArgs();
-        esp_event_loop_create_IgnoreAndReturn(ESP_OK);
-        esp_read_mac_IgnoreAndReturn(ESP_OK);
-        esp_read_mac_ReturnThruPtr_mac(mac);
-        esp_transport_list_destroy_IgnoreAndReturn(ESP_OK);
-        vEventGroupDelete_Ignore();
-        vQueueDelete_Ignore();
-
-        esp_mqtt_client_config_t config{};
-        client = esp_mqtt_client_init(&config);
-    }
-    ~ClientInitializedFixture()
-    {
-        esp_mqtt_client_destroy(client);
-    }
-};
-TEST_CASE_METHOD(ClientInitializedFixture, "Client set uri")
-{
-        struct http_parser_url ret_uri = {
-            .field_set = 1,
-            .port = 0,
-            .field_data = { { 0, 1} }
-        };
-    SECTION("User set a correct URI") {
-        http_parser_parse_url_StopIgnore();
-        http_parser_parse_url_ExpectAnyArgsAndReturn(0);
-        http_parser_parse_url_ReturnThruPtr_u(&ret_uri);
-        auto res = esp_mqtt_client_set_uri(client, " ");
-        REQUIRE(res == ESP_OK);
-    }
-    SECTION("Incorrect URI from user") {
-        http_parser_parse_url_StopIgnore();
-        http_parser_parse_url_ExpectAnyArgsAndReturn(1);
-        http_parser_parse_url_ReturnThruPtr_u(&ret_uri);
-        auto res = esp_mqtt_client_set_uri(client, " ");
-        REQUIRE(res == ESP_FAIL);
-    }
-}
-TEST_CASE_METHOD(ClientInitializedFixture, "Client Start")
-{
-    SECTION("Successful start") {
-        esp_mqtt_client_config_t config{};
-        config.broker.address.uri = "mqtt://1.1.1.1";
-        struct http_parser_url ret_uri = {
-            .field_set = 1 | (1<<1),
-            .port = 0,
-            .field_data = { { 0, 4 } /*mqtt*/, { 7, 1 } } // at least *scheme* and *host*
-        };
-        http_parser_parse_url_StopIgnore();
-        http_parser_parse_url_ExpectAnyArgsAndReturn(0);
-        http_parser_parse_url_ReturnThruPtr_u(&ret_uri);
-        xTaskCreatePinnedToCore_ExpectAnyArgsAndReturn(pdTRUE);
-        auto res = esp_mqtt_set_config(client, &config);
-        REQUIRE(res == ESP_OK);
-        res = esp_mqtt_client_start(client);
-        REQUIRE(res == ESP_OK);
-    }
-    SECTION("Failed on initialization") {
-        xTaskCreatePinnedToCore_ExpectAnyArgsAndReturn(pdFALSE);
-        auto res = esp_mqtt_client_start(nullptr);
-        REQUIRE(res == ESP_ERR_INVALID_ARG);
-    }
-    SECTION("Client already started") {}
-    SECTION("Failed to start task") {
-        xTaskCreatePinnedToCore_ExpectAnyArgsAndReturn(pdFALSE);
-        auto res = esp_mqtt_client_start(client);
-        REQUIRE(res == ESP_FAIL);
-    }
-}

components/mqtt/host_test/mocks/config.yaml

@@ -1,25 +0,0 @@
-        :cmock:
-          :plugins:
-            - expect
-            - expect_any_args
-            - return_thru_ptr
-            - ignore
-            - array
-            - callback
-          :includes_h_pre_orig_header:
-            - local_FreeRTOS_config.h
-            - esp_attr.h
-            - FreeRTOS.h
-            - net/if.h
-          :strippables:
-            - '(?:__attribute__\s*\(+.*?\)+)'
-            - '(?:vQueueAddToRegistry\s*\(+.*?\)+)'
-            - '(?:vQueueUnregisterQueue\s*\(+.*?\)+)'
-            - '(?:pcQueueGetName\s*\(+.*?\)+)'
-            - '(?:xQueueTakeMutexRecursive\s*\(+.*?\)+)'
-            - '(?:xQueueGiveMutexRecursive\s*\(+.*?\)+)'
-            - '(?:vTaskSetThreadLocalStoragePointerAndDelCallback\s*\(+.*?\)+)'
-            - '(?:esp_log_writev\s*\(+.*?\)+)'
-            - '(?:esp_restart\s*\(+.*?\)+)'
-            - '(?:esp_system_abort\s*\(+.*?\)+)'
-            - PRIVILEGED_FUNCTION

components/mqtt/host_test/mocks/include/freertos/FreeRTOSConfig.h

@@ -1,133 +0,0 @@
-/*
-    FreeRTOS V8.2.0 - Copyright (C) 2015 Real Time Engineers Ltd.
-    All rights reserved
-
-    VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
-
-    This file is part of the FreeRTOS distribution.
-
-    FreeRTOS is free software; you can redistribute it and/or modify it under
-    the terms of the GNU General Public License (version 2) as published by the
-    Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.
-
-        ***************************************************************************
-    >>!   NOTE: The modification to the GPL is included to allow you to     !<<
-    >>!   distribute a combined work that includes FreeRTOS without being   !<<
-    >>!   obliged to provide the source code for proprietary components     !<<
-    >>!   outside of the FreeRTOS kernel.                                   !<<
-        ***************************************************************************
-
-    FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
-    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-    FOR A PARTICULAR PURPOSE.  Full license text is available on the following
-    link: http://www.freertos.org/a00114.html
-
-    ***************************************************************************
-     *                                                                       *
-     *    FreeRTOS provides completely free yet professionally developed,    *
-     *    robust, strictly quality controlled, supported, and cross          *
-     *    platform software that is more than just the market leader, it     *
-     *    is the industry's de facto standard.                               *
-     *                                                                       *
-     *    Help yourself get started quickly while simultaneously helping     *
-     *    to support the FreeRTOS project by purchasing a FreeRTOS           *
-     *    tutorial book, reference manual, or both:                          *
-     *    http://www.FreeRTOS.org/Documentation                              *
-     *                                                                       *
-    ***************************************************************************
-
-    http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading
-        the FAQ page "My application does not run, what could be wrong?".  Have you
-        defined configASSERT()?
-
-        http://www.FreeRTOS.org/support - In return for receiving this top quality
-        embedded software for free we request you assist our global community by
-        participating in the support forum.
-
-        http://www.FreeRTOS.org/training - Investing in training allows your team to
-        be as productive as possible as early as possible.  Now you can receive
-        FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers
-        Ltd, and the world's leading authority on the world's leading RTOS.
-
-    http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
-    including FreeRTOS+Trace - an indispensable productivity tool, a DOS
-    compatible FAT file system, and our tiny thread aware UDP/IP stack.
-
-    http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
-    Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.
-
-    http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High
-    Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS
-    licenses offer ticketed support, indemnification and commercial middleware.
-
-    http://www.SafeRTOS.com - High Integrity Systems also provide a safety
-    engineered and independently SIL3 certified version for use in safety and
-    mission critical applications that require provable dependability.
-
-    1 tab == 4 spaces!
-*/
-
-#ifndef FREERTOS_CONFIG_H
-#define FREERTOS_CONFIG_H
-
-#include "esp_attr.h"
-
-/*-----------------------------------------------------------
- * Application specific definitions.
- *
- * These definitions should be adjusted for your particular hardware and
- * application requirements.
- *
- * THESE PARAMETERS ARE DESCRIBED WITHIN THE 'CONFIGURATION' SECTION OF THE
- * FreeRTOS API DOCUMENTATION AVAILABLE ON THE FreeRTOS.org WEB SITE.
- *
- * See http://www.freertos.org/a00110.html.
- *----------------------------------------------------------*/
-
-#define configUSE_PREEMPTION 1
-#define configUSE_IDLE_HOOK 1
-#define configUSE_TICK_HOOK 1
-#define configTICK_RATE_HZ ((TickType_t)1000)
-#define configMINIMAL_STACK_SIZE ((unsigned short)256) /* This can be made smaller if required. */
-#define configTOTAL_HEAP_SIZE ((size_t)(32 * 1024))
-#define configMAX_TASK_NAME_LEN (16)
-#define configUSE_TRACE_FACILITY 1
-#define configUSE_16_BIT_TICKS 1
-#define configIDLE_SHOULD_YIELD 1
-#define configUSE_CO_ROUTINES 1
-#define configUSE_MUTEXES 1
-#define configUSE_COUNTING_SEMAPHORES 1
-#define configUSE_ALTERNATIVE_API 0
-#define configUSE_RECURSIVE_MUTEXES 1
-#define configCHECK_FOR_STACK_OVERFLOW 0 /* Do not use this option on the PC port. */
-#define configUSE_APPLICATION_TASK_TAG 1
-#define configQUEUE_REGISTRY_SIZE 0
-
-#define configMAX_PRIORITIES (10)
-#define configMAX_CO_ROUTINE_PRIORITIES (2)
-
-/* Set the following definitions to 1 to include the API function, or zero
-to exclude the API function. */
-
-#define INCLUDE_vTaskPrioritySet 1
-#define INCLUDE_uxTaskPriorityGet 1
-#define INCLUDE_vTaskDelete 1
-#define INCLUDE_vTaskCleanUpResources 1
-#define INCLUDE_vTaskSuspend 1
-#define INCLUDE_vTaskDelayUntil 1
-#define INCLUDE_vTaskDelay 1
-#define INCLUDE_uxTaskGetStackHighWaterMark 0 /* Do not use this option on the PC port. */
-
-/* This demo makes use of one or more example stats formatting functions.  These
-format the raw data provided by the uxTaskGetSystemState() function in to human
-readable ASCII form.  See the notes in the implementation of vTaskList() within
-FreeRTOS/Source/tasks.c for limitations. */
-#define configUSE_STATS_FORMATTING_FUNCTIONS 1
-
-/* An example "task switched in" hook macro definition. */
-#define traceTASK_SWITCHED_IN() xTaskCallApplicationTaskHook(NULL, (void*)0xabcd)
-
-extern void vMainQueueSendPassed(void);
-#define traceQUEUE_SEND(pxQueue) vMainQueueSendPassed()
-
-#endif /* FREERTOS_CONFIG_H */

components/mqtt/host_test/mocks/include/freertos/portmacro.h

@@ -1,177 +0,0 @@
-/*
- * FreeRTOS Kernel V10.4.3
- * Copyright (C) 2019 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
- *
- * 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.
- *
- * http://www.FreeRTOS.org
- * http://aws.amazon.com/freertos
- *
- * 1 tab == 4 spaces!
- */
-#ifndef PORTMACRO_H
-#define PORTMACRO_H
-
-#include <stdint.h>
-#include <stdlib.h>
-#include <stdbool.h>
-#include <stdio.h>
-#include <limits.h>
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-#ifndef __ASSEMBLER__
-
-/*-----------------------------------------------------------
- * Port specific definitions.
- *
- * The settings in this file configure FreeRTOS correctly for the
- * given hardware and compiler.
- *
- * These settings should not be altered.
- *-----------------------------------------------------------
- */
-
-/* Type definitions. */
-#define portCHAR uint8_t
-#define portFLOAT float
-#define portDOUBLE double
-#define portLONG int32_t
-#define portSHORT int16_t
-#define portSTACK_TYPE uint8_t
-#define portBASE_TYPE int
-// interrupt module will mask interrupt with priority less than threshold
-#define RVHAL_EXCM_LEVEL 4
-
-typedef portSTACK_TYPE StackType_t;
-typedef portBASE_TYPE BaseType_t;
-typedef unsigned portBASE_TYPE UBaseType_t;
-
-#if (configUSE_16_BIT_TICKS == 1)
-typedef uint16_t TickType_t;
-#define portMAX_DELAY (TickType_t)0xffff
-#else
-typedef uint32_t TickType_t;
-#define portMAX_DELAY (TickType_t)0xffffffffUL
-#endif
-/*------------------------------------------------------*/
-
-/* Architecture specifics. */
-#define portSTACK_GROWTH (-1)
-#define portTICK_PERIOD_MS ((TickType_t)(1000 / configTICK_RATE_HZ))
-#define portBYTE_ALIGNMENT 16
-/*-----------------------------------------------------------*/
-
-#define portCRITICAL_NESTING_IN_TCB 0
-
-/*
- * Send an interrupt to another core in order to make the task running
- * on it yield for a higher-priority task.
- */
-void vPortYieldOtherCore(BaseType_t coreid);
-
-/*
- Callback to set a watchpoint on the end of the stack. Called every context switch to change the stack
- watchpoint around.
- */
-void vPortSetStackWatchpoint(void *pxStackStart);
-
-/*
- * Returns true if the current core is in ISR context; low prio ISR, med prio ISR or timer tick ISR. High prio ISRs
- * aren't detected here, but they normally cannot call C code, so that should not be an issue anyway.
- */
-BaseType_t xPortInIsrContext(void);
-
-/*
- * This function will be called in High prio ISRs. Returns true if the current core was in ISR context
- * before calling into high prio ISR context.
- */
-BaseType_t xPortInterruptedFromISRContext(void);
-
-/* "mux" data structure (spinlock) */
-typedef struct {
-    /* owner field values:
-     * 0                - Uninitialized (invalid)
-     * portMUX_FREE_VAL - Mux is free, can be locked by either CPU
-     * CORE_ID_REGVAL_PRO / CORE_ID_REGVAL_APP - Mux is locked to the particular core
-     *
-     *
-     * Any value other than portMUX_FREE_VAL, CORE_ID_REGVAL_PRO, CORE_ID_REGVAL_APP indicates corruption
-     */
-    uint32_t owner;
-    /* count field:
-     * If mux is unlocked, count should be zero.
-     * If mux is locked, count is non-zero & represents the number of recursive locks on the mux.
-     */
-    uint32_t count;
-} portMUX_TYPE;
-
-#define portMUX_FREE_VAL SPINLOCK_FREE
-
-/* Special constants for vPortCPUAcquireMutexTimeout() */
-#define portMUX_NO_TIMEOUT SPINLOCK_WAIT_FOREVER /* When passed for 'timeout_cycles', spin forever if necessary */
-#define portMUX_TRY_LOCK SPINLOCK_NO_WAIT        /* Try to acquire the spinlock a single time only */
-
-// Keep this in sync with the portMUX_TYPE struct definition please.
-#define portMUX_INITIALIZER_UNLOCKED                                                                                   \
-    { .owner = portMUX_FREE_VAL, .count = 0, }
-
-/* Scheduler utilities. */
-extern void vPortYield(void);
-extern void vPortYieldFromISR(void);
-
-#define portYIELD() vPortYield()
-#define portYIELD_FROM_ISR() vPortYieldFromISR()
-
-/* Yielding within an API call (when interrupts are off), means the yield should be delayed
-   until interrupts are re-enabled.
-   To do this, we use the "cross-core" interrupt as a trigger to yield on this core when interrupts are re-enabled.This
-   is the same interrupt & code path which is used to trigger a yield between CPUs, although in this case the yield is
-   happening on the same CPU.
-*/
-#define portYIELD_WITHIN_API() portYIELD()
-/*-----------------------------------------------------------*/
-
-/* Critical section management. */
-extern int vPortSetInterruptMask(void);
-extern void vPortClearInterruptMask(int);
-
-extern void vPortEnterCritical(void);
-extern void vPortExitCritical(void);
-
-/* Task function macros as described on the FreeRTOS.org WEB site. */
-#define portTASK_FUNCTION_PROTO(vFunction, pvParameters) void vFunction(void* pvParameters)
-#define portTASK_FUNCTION(vFunction, pvParameters) void vFunction(void* pvParameters)
-
-void vApplicationSleep(TickType_t xExpectedIdleTime);
-#define portSUPPRESS_TICKS_AND_SLEEP(idleTime) vApplicationSleep(idleTime)
-
-#define portNOP() //__asm volatile  ( " nop " )
-
-#define portVALID_TCB_MEM(ptr)   // esp_ptr_byte_accessible(ptr)
-#define portVALID_STACK_MEM(ptr) // esp_ptr_byte_accessible(ptr)
-
-#endif //__ASSEMBLER__
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif /* PORTMACRO_H */

components/mqtt/host_test/mocks/include/machine/endian.h

@@ -1,2 +0,0 @@
-#pragma once
-#include_next <endian.h>

components/mqtt/host_test/mocks/include/sys/queue.h

@@ -1,66 +0,0 @@
-#pragma once
-
-/* Implementation from BSD headers*/
-#define	QMD_SAVELINK(name, link)	void **name = (void *)&(link)
-#define	TRASHIT(x)	do {(x) = (void *)-1;} while (0)
-#define	STAILQ_NEXT(elm, field)	((elm)->field.stqe_next)
-
-#define	STAILQ_FIRST(head)	((head)->stqh_first)
-
-#define	STAILQ_HEAD(name, type)						\
-struct name {								\
-	struct type *stqh_first;/* first element */			\
-	struct type **stqh_last;/* addr of last next element */		\
-}
-
-#define	STAILQ_ENTRY(type)						\
-struct {								\
-	struct type *stqe_next;	/* next element */			\
-}
-
-#define	STAILQ_INSERT_TAIL(head, elm, field) do {			\
-	STAILQ_NEXT((elm), field) = NULL;				\
-	*(head)->stqh_last = (elm);					\
-	(head)->stqh_last = &STAILQ_NEXT((elm), field);			\
-} while (0)
-
-#define	STAILQ_INIT(head) do {						\
-	STAILQ_FIRST((head)) = NULL;					\
-	(head)->stqh_last = &STAILQ_FIRST((head));			\
-} while (0)
-
-#define	STAILQ_FOREACH(var, head, field)				\
-	for((var) = STAILQ_FIRST((head));				\
-	   (var);							\
-	   (var) = STAILQ_NEXT((var), field))
-
-#define	STAILQ_FOREACH_SAFE(var, head, field, tvar)			\
-	for ((var) = STAILQ_FIRST((head));				\
-	    (var) && ((tvar) = STAILQ_NEXT((var), field), 1);		\
-	    (var) = (tvar))
-
-#define STAILQ_REMOVE_AFTER(head, elm, field) do {			\
-	if ((STAILQ_NEXT(elm, field) =					\
-	     STAILQ_NEXT(STAILQ_NEXT(elm, field), field)) == NULL)	\
-		(head)->stqh_last = &STAILQ_NEXT((elm), field);		\
-} while (0)
-
-#define	STAILQ_REMOVE_HEAD(head, field) do {				\
-	if ((STAILQ_FIRST((head)) =					\
-	     STAILQ_NEXT(STAILQ_FIRST((head)), field)) == NULL)		\
-		(head)->stqh_last = &STAILQ_FIRST((head));		\
-} while (0)
-
-#define	STAILQ_REMOVE(head, elm, type, field) do {			\
-	QMD_SAVELINK(oldnext, (elm)->field.stqe_next);			\
-	if (STAILQ_FIRST((head)) == (elm)) {				\
-		STAILQ_REMOVE_HEAD((head), field);			\
-	}								\
-	else {								\
-		struct type *curelm = STAILQ_FIRST((head));		\
-		while (STAILQ_NEXT(curelm, field) != (elm))		\
-			curelm = STAILQ_NEXT(curelm, field);		\
-		STAILQ_REMOVE_AFTER(head, curelm, field);		\
-	}								\
-	TRASHIT(*oldnext);						\
-} while (0)

components/mqtt/host_test/sdkconfig.defaults

@@ -1,6 +0,0 @@
-CONFIG_IDF_TARGET="linux"
-CONFIG_COMPILER_CXX_EXCEPTIONS=y
-CONFIG_COMPILER_CXX_RTTI=y
-CONFIG_COMPILER_CXX_EXCEPTIONS_EMG_POOL_SIZE=0
-CONFIG_COMPILER_STACK_CHECK_NONE=y
-CONFIG_UNITY_ENABLE_IDF_TEST_RUNNER=n

docs/en/api-guides/unit-tests.rst

@@ -349,7 +349,7 @@ Examples of component mocks can be found under :idf:`tools/mocks` in the IDF dir
 
 - :component_file:`unit test for the NVS Page class <nvs_flash/host_test/nvs_page_test/README.md>`.
 - :component_file:`unit test for esp_event <esp_event/host_test/esp_event_unit_test/main/esp_event_test.cpp>`.
-- :component_file:`unit test for mqtt <mqtt/host_test/README.md>`.
+- :component_file:`unit test for mqtt <mqtt/esp-mqtt/host_test/README.md>`.
 
 .. _adjustments_for_mocks: