feat(esp_linenoise): Update esp_linenoise_create_instance

Author: SoucheSouche

.gitignore

@@ -13,3 +13,5 @@ warnings.txt
 doxygen_output/
 **/docs/book/
 docs_build_output/
+pytest-args.txt
+build_info*.json

esp_linenoise/.build-test-rules.yml

@@ -3,5 +3,5 @@ esp_linenoise/test_apps:
     - if: IDF_TARGET == "linux"
       reason: "Sufficient to test on Linux target"
   disable:
-    - if: IDF_VERSION_MAJOR == 5 and IDF_VERSION_MINOR <= 4
+    - if: IDF_VERSION_MAJOR <= 5 and IDF_VERSION_MINOR <= 4
       reason: "those versions of esp-idf do not support eventfd for linux target"

esp_linenoise/README.md

@@ -14,7 +14,8 @@
 ```c
 esp_linenoise_config_t config;
 esp_linenoise_get_instance_config_default(&config);
-esp_linenoise_handle_t handle = esp_linenoise_create_instance(&config);
+esp_linenoise_handle_t handle;
+const esp_err_t ret = esp_linenoise_create_instance(&config, &handle);
 const size_t buffer_size = 128;
 char buffer[128];
 const char *line = esp_linenoise_get_line(&handle, buffer, buffer_size);

esp_linenoise/include/esp_linenoise.h

@@ -137,9 +137,10 @@ void esp_linenoise_get_instance_config_default(esp_linenoise_config_t *config);
  * @brief Creates a new linenoise instance.
  *
  * @param config Pointer to the configuration parameters for the instance.
- * @return Handle to the created instance, or NULL on failure.
+ * @param[out] out_handle Handle to the created instance, or NULL on failure.
+ * @return ESP_OK if instance created successfully,
  */
-esp_linenoise_handle_t esp_linenoise_create_instance(const esp_linenoise_config_t *config);
+esp_err_t esp_linenoise_create_instance(const esp_linenoise_config_t *config, esp_linenoise_handle_t *out_handle);
 
 /**
  * @brief Destroys a linenoise instance and frees associated memory.

esp_linenoise/src/esp_linenoise.c

@@ -1116,21 +1116,20 @@ void esp_linenoise_get_instance_config_default(esp_linenoise_config_t *config)
     };
 }
 
-esp_linenoise_handle_t esp_linenoise_create_instance(const esp_linenoise_config_t *config)
+esp_err_t esp_linenoise_create_instance(const esp_linenoise_config_t *config, esp_linenoise_handle_t *out_handle)
 {
-    if (!config) {
-        return NULL;
-    }
-
-    esp_linenoise_instance_t *instance = malloc(sizeof(esp_linenoise_instance_t));
-    if (!instance) {
-        return NULL;
+    if (!config || !out_handle) {
+        return ESP_ERR_INVALID_ARG;
     }
 
     /* make sure the history is NULL since the linenoise library will allocate it */
     if (config->history != NULL) {
-        free(instance);
-        return NULL;
+        return ESP_ERR_INVALID_ARG;
+    }
+
+    esp_linenoise_instance_t *instance = malloc(sizeof(esp_linenoise_instance_t));
+    if (!instance) {
+        return ESP_ERR_NO_MEM;
     }
 
     instance->config = *config;
@@ -1170,7 +1169,7 @@ esp_linenoise_handle_t esp_linenoise_create_instance(const esp_linenoise_config_
             const esp_err_t ret_val = esp_linenoise_set_event_fd(instance);
             if (ret_val != ESP_OK) {
                 free(instance);
-                return NULL;
+                return ret_val;
             }
         } else {
             /* make sure the state->mux is set to NULL */
@@ -1196,9 +1195,11 @@ esp_linenoise_handle_t esp_linenoise_create_instance(const esp_linenoise_config_
         instance->config.write_bytes_cb(instance->config.out_fd, buf, len);
     }
 
-    /* set the self value to the handle of instance */
+    /* set the self value to the handle of instance and assign the instance to out_handle */
     instance->self = instance;
-    return (esp_linenoise_handle_t)instance;
+    *out_handle =  (esp_linenoise_handle_t)instance;
+
+    return ESP_OK;
 }
 
 esp_err_t esp_linenoise_delete_instance(esp_linenoise_handle_t handle)

esp_linenoise/test_apps/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.16)
+cmake_minimum_required(VERSION 3.22)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 set(COMPONENTS main)

esp_linenoise/test_apps/main/test_esp_linenoise_behavioral.c

@@ -153,7 +153,7 @@ static void get_line_task(void *args)
 {
     get_line_args_t *task_args = (get_line_args_t *)args;
 
-    s_linenoise_hdl = esp_linenoise_create_instance(task_args->config);
+    TEST_ASSERT_EQUAL(ESP_OK, esp_linenoise_create_instance(task_args->config, &s_linenoise_hdl));
     TEST_ASSERT_NOT_NULL(s_linenoise_hdl);
 
     // wait for the instance to properly initialize before unlocking
@@ -613,7 +613,7 @@ TEST_CASE("CTRL-L clears the screen", "[esp_linenoise]")
     // we can check that the proper command was sent from
     // linenoise to the terminal
     // Verify prompt string is found in output
-    wait_ms(50);
+    wait_ms(100);
     char full_cmd_line[32] = {0};
     const char *expect_string = "screen cleared";
     const ssize_t nread = read(s_socket_fd_a[1], full_cmd_line, 32);
@@ -712,7 +712,7 @@ TEST_CASE("check esp_linenoise_get_line return values", "[esp_linenoise]")
 
     test_instance_setup(s_socket_fd_a, &lock, &config);
 
-    s_linenoise_hdl = esp_linenoise_create_instance(&config);
+    TEST_ASSERT_EQUAL(ESP_OK, esp_linenoise_create_instance(&config, &s_linenoise_hdl));
     TEST_ASSERT_NOT_NULL(s_linenoise_hdl);
 
     const size_t buffer_size = 10;
@@ -762,7 +762,7 @@ TEST_CASE("check cmd line is bigger than the buffer", "[esp_linenoise]")
 
     test_instance_setup(s_socket_fd_a, &lock, &config);
 
-    s_linenoise_hdl = esp_linenoise_create_instance(&config);
+    TEST_ASSERT_EQUAL(ESP_OK, esp_linenoise_create_instance(&config, &s_linenoise_hdl));
     TEST_ASSERT_NOT_NULL(s_linenoise_hdl);
 
     const size_t buffer_size = 10;
@@ -979,7 +979,8 @@ TEST_CASE("Create and use 2 esp_linenoise instances", "[esp_linenoise]")
     pthread_mutex_t lock_a = PTHREAD_MUTEX_INITIALIZER;
 
     test_instance_setup(s_socket_fd_a, &lock_a, &config_a);
-    esp_linenoise_handle_t linenoise_handle_a = esp_linenoise_create_instance(&config_a);
+    esp_linenoise_handle_t linenoise_handle_a;
+    TEST_ASSERT_EQUAL(ESP_OK, esp_linenoise_create_instance(&config_a, &linenoise_handle_a));
     TEST_ASSERT_NOT_NULL(linenoise_handle_a);
 
     const size_t buffer_a_size = 32;
@@ -1001,7 +1002,8 @@ TEST_CASE("Create and use 2 esp_linenoise instances", "[esp_linenoise]")
     pthread_mutex_t lock_b = PTHREAD_MUTEX_INITIALIZER;
 
     test_instance_setup(s_socket_fd_b, &lock_b, &config_b);
-    esp_linenoise_handle_t linenoise_handle_b = esp_linenoise_create_instance(&config_b);
+    esp_linenoise_handle_t linenoise_handle_b;
+    TEST_ASSERT_EQUAL(ESP_OK, esp_linenoise_create_instance(&config_b, &linenoise_handle_b));
     TEST_ASSERT_NOT_NULL(linenoise_handle_b);
 
     const size_t buffer_b_size = 32;
@@ -1053,7 +1055,8 @@ TEST_CASE("tests that esp_linenoise_abort actually forces esp_linenoise_get_line
     config_a.read_bytes_cb = NULL;
     config_b.read_bytes_cb = NULL;
 
-    esp_linenoise_handle_t linenoise_handle_a = esp_linenoise_create_instance(&config_a);
+    esp_linenoise_handle_t linenoise_handle_a;
+    TEST_ASSERT_EQUAL(ESP_OK, esp_linenoise_create_instance(&config_a, &linenoise_handle_a));
     TEST_ASSERT_NOT_NULL(linenoise_handle_a);
 
     const size_t buffer_a_size = 32;
@@ -1071,7 +1074,8 @@ TEST_CASE("tests that esp_linenoise_abort actually forces esp_linenoise_get_line
     xTaskCreate(get_line_task_w_args, "freertos_task", 2048, &args_a, 5, NULL);
     pthread_mutex_lock(&lock_a);
 
-    esp_linenoise_handle_t linenoise_handle_b = esp_linenoise_create_instance(&config_b);
+    esp_linenoise_handle_t linenoise_handle_b;
+    TEST_ASSERT_EQUAL(ESP_OK, esp_linenoise_create_instance(&config_b, &linenoise_handle_b));
     TEST_ASSERT_NOT_NULL(linenoise_handle_b);
 
     const size_t buffer_b_size = 32;

esp_linenoise/test_apps/main/test_esp_linenoise_get_set.c

@@ -14,7 +14,8 @@ static esp_linenoise_handle_t get_linenoise_instance_default_config(void)
 {
     esp_linenoise_config_t config;
     esp_linenoise_get_instance_config_default(&config);
-    esp_linenoise_handle_t h = esp_linenoise_create_instance(&config);
+    esp_linenoise_handle_t h;
+    TEST_ASSERT_EQUAL(ESP_OK, esp_linenoise_create_instance(&config, &h));
     TEST_ASSERT_NOT_NULL(h);
     return h;
 }

esp_linenoise/test_apps/pytest_linenoise.py

@@ -1,8 +1,16 @@
 import pytest
+from pytest_embedded import Dut
+from pytest_embedded_idf.utils import idf_parametrize
+import glob
+from pathlib import Path
 
-@pytest.mark.generic
-@pytest.mark.parametrize(
-    'target', ['linux'], indirect=['target'])
-@pytest.mark.skip_if_soc("IDF_VERSION_MAJOR < 5 and IDF_VERSION_MINOR <= 4")
-def test_esp_linenoise(dut) -> None:
+
+
+@pytest.mark.host_test
+@pytest.mark.skipif(
+    not bool(glob.glob(f'{Path(__file__).parent.absolute()}/build*/')),
+    reason="Skip the idf version that did not build"
+)
+@idf_parametrize('target', ['linux'], indirect=['target'])
+def test_esp_linenoise(dut: Dut) -> None:
     dut.run_all_single_board_cases()