Merge pull request #534 from apache/feature/array_list_return_status_on_modification

pnoltes · web-flow · commit 19529d7af266 · 2023-05-03T20:37:08.000+02:00
Feature/array list return status on modification
diff --git a/libs/error_injector/CMakeLists.txt b/libs/error_injector/CMakeLists.txt
@@ -36,6 +36,7 @@ add_subdirectory(stat)
 add_subdirectory(fts)
 add_subdirectory(dlfcn)
 add_subdirectory(ifaddrs)
+add_subdirectory(celix_array_list)
 
 celix_subproject(ERROR_INJECTOR_MDNSRESPONDER "Option to enable building the mdnsresponder error injector" OFF)
 if (ERROR_INJECTOR_MDNSRESPONDER)
diff --git a/libs/error_injector/asprintf/CMakeLists.txt b/libs/error_injector/asprintf/CMakeLists.txt
@@ -20,5 +20,7 @@ add_library(asprintf_ei STATIC src/asprintf_ei.cc)
 target_include_directories(asprintf_ei PUBLIC ${CMAKE_CURRENT_LIST_DIR}/include)
 target_link_libraries(asprintf_ei PUBLIC Celix::error_injector)
 # It plays nicely with address sanitizer this way.
-target_link_options(asprintf_ei INTERFACE LINKER:--wrap,asprintf)
+target_link_options(asprintf_ei INTERFACE
+        LINKER:--wrap,vasprintf
+        LINKER:--wrap,asprintf)
 add_library(Celix::asprintf_ei ALIAS asprintf_ei)
diff --git a/libs/error_injector/asprintf/include/asprintf_ei.h b/libs/error_injector/asprintf/include/asprintf_ei.h
@@ -27,6 +27,8 @@ extern "C" {
 
 CELIX_EI_DECLARE(asprintf, int);
 
+CELIX_EI_DECLARE(vasprintf, int);
+
 #ifdef __cplusplus
 }
 #endif
diff --git a/libs/error_injector/asprintf/src/asprintf_ei.cc b/libs/error_injector/asprintf/src/asprintf_ei.cc
@@ -24,6 +24,15 @@
 
 extern "C" {
 
+int __real_vasprintf(char** buf, const char* format, va_list args);
+CELIX_EI_DEFINE(vasprintf, int)
+int __wrap_vasprintf(char** buf, const char* format, va_list args) {
+    errno = ENOMEM;
+    CELIX_EI_IMPL(vasprintf);
+    errno = 0;
+    return __real_vasprintf(buf, format, args);
+}
+
 int __real_asprintf(char** buf, const char* format, ...);
 CELIX_EI_DEFINE(asprintf, int)
 int __wrap_asprintf(char** buf, const char* format, ...) {
@@ -32,7 +41,7 @@ int __wrap_asprintf(char** buf, const char* format, ...) {
     errno = 0;
     va_list args;
     va_start(args, format);
-    int rc = vasprintf(buf, format, args);
+    int rc = __real_vasprintf(buf, format, args);
     va_end(args);
     return rc;
 }
diff --git a/libs/error_injector/celix_array_list/CMakeLists.txt b/libs/error_injector/celix_array_list/CMakeLists.txt
@@ -0,0 +1,35 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+
+add_library(array_list_ei STATIC src/celix_array_list_ei.cc)
+
+target_include_directories(array_list_ei PUBLIC ${CMAKE_CURRENT_LIST_DIR}/include)
+target_link_libraries(array_list_ei PUBLIC Celix::error_injector Celix::utils)
+target_link_options(array_list_ei INTERFACE
+        LINKER:--wrap,celix_arrayList_create
+        LINKER:--wrap,celix_arrayList_createWithOptions
+        LINKER:--wrap,celix_arrayList_add
+        LINKER:--wrap,celix_arrayList_addInt
+        LINKER:--wrap,celix_arrayList_addLong
+        LINKER:--wrap,celix_arrayList_addUInt
+        LINKER:--wrap,celix_arrayList_addULong
+        LINKER:--wrap,celix_arrayList_addFloat
+        LINKER:--wrap,celix_arrayList_addDouble
+        LINKER:--wrap,celix_arrayList_addBool
+        LINKER:--wrap,celix_arrayList_addSize
+)
+add_library(Celix::array_list_ei ALIAS array_list_ei)
diff --git a/libs/error_injector/celix_array_list/include/celix_array_list_ei.h b/libs/error_injector/celix_array_list/include/celix_array_list_ei.h
@@ -0,0 +1,54 @@
+/*
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements.  See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership.  The ASF licenses this file
+ to you 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.
+ */
+
+#ifndef CELIX_CELIX_ARRAY_LIST_EI_H
+#define CELIX_CELIX_ARRAY_LIST_EI_H
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include "celix_array_list.h"
+#include "celix_error_injector.h"
+
+CELIX_EI_DECLARE(celix_arrayList_create, celix_array_list_t*);
+
+CELIX_EI_DECLARE(celix_arrayList_createWithOptions, celix_array_list_t*);
+
+CELIX_EI_DECLARE(celix_arrayList_add, celix_status_t);
+
+CELIX_EI_DECLARE(celix_arrayList_addInt, celix_status_t);
+
+CELIX_EI_DECLARE(celix_arrayList_addLong, celix_status_t);
+
+CELIX_EI_DECLARE(celix_arrayList_addUInt, celix_status_t);
+
+CELIX_EI_DECLARE(celix_arrayList_addULong, celix_status_t);
+
+CELIX_EI_DECLARE(celix_arrayList_addFloat, celix_status_t);
+
+CELIX_EI_DECLARE(celix_arrayList_addDouble, celix_status_t);
+
+CELIX_EI_DECLARE(celix_arrayList_addBool, celix_status_t);
+
+CELIX_EI_DECLARE(celix_arrayList_addSize, celix_status_t);
+
+#ifdef __cplusplus
+}
+#endif
+#endif //CELIX_CELIX_ARRAY_LIST_EI_H
diff --git a/libs/error_injector/celix_array_list/src/celix_array_list_ei.cc b/libs/error_injector/celix_array_list/src/celix_array_list_ei.cc
@@ -0,0 +1,101 @@
+/*
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements.  See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership.  The ASF licenses this file
+ to you 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.
+ */
+
+#include "celix_array_list_ei.h"
+
+extern "C" {
+
+void *__real_celix_arrayList_create(void);
+CELIX_EI_DEFINE(celix_arrayList_create, celix_array_list_t*)
+void *__wrap_celix_arrayList_create(void) {
+    CELIX_EI_IMPL(celix_arrayList_create);
+    return __real_celix_arrayList_create();
+}
+
+void *__real_celix_arrayList_createWithOptions(const celix_array_list_create_options_t* opts);
+CELIX_EI_DEFINE(celix_arrayList_createWithOptions, celix_array_list_t*)
+void *__wrap_celix_arrayList_createWithOptions(const celix_array_list_create_options_t* opts) {
+    CELIX_EI_IMPL(celix_arrayList_createWithOptions);
+    return __real_celix_arrayList_createWithOptions(opts);
+}
+
+celix_status_t __real_celix_arrayList_add(celix_array_list_t* list, void* value);
+CELIX_EI_DEFINE(celix_arrayList_add, celix_status_t)
+celix_status_t __wrap_celix_arrayList_add(celix_array_list_t* list, void* value) {
+    CELIX_EI_IMPL(celix_arrayList_add);
+    return __real_celix_arrayList_add(list, value);
+}
+
+celix_status_t __real_celix_arrayList_addInt(celix_array_list_t* list, int value);
+CELIX_EI_DEFINE(celix_arrayList_addInt, celix_status_t)
+celix_status_t __wrap_celix_arrayList_addInt(celix_array_list_t* list, int value) {
+    CELIX_EI_IMPL(celix_arrayList_addInt);
+    return __real_celix_arrayList_addInt(list, value);
+}
+
+celix_status_t __real_celix_arrayList_addLong(celix_array_list_t* list, long value);
+CELIX_EI_DEFINE(celix_arrayList_addLong, celix_status_t)
+celix_status_t __wrap_celix_arrayList_addLong(celix_array_list_t* list, long value) {
+    CELIX_EI_IMPL(celix_arrayList_addLong);
+    return __real_celix_arrayList_addLong(list, value);
+}
+
+celix_status_t __real_celix_arrayList_addUInt(celix_array_list_t* list, unsigned int value);
+CELIX_EI_DEFINE(celix_arrayList_addUInt, celix_status_t)
+celix_status_t __wrap_celix_arrayList_addUInt(celix_array_list_t* list, unsigned int value) {
+    CELIX_EI_IMPL(celix_arrayList_addUInt);
+    return __real_celix_arrayList_addUInt(list, value);
+}
+
+celix_status_t __real_celix_arrayList_addULong(celix_array_list_t* list, unsigned long value);
+CELIX_EI_DEFINE(celix_arrayList_addULong, celix_status_t)
+celix_status_t __wrap_celix_arrayList_addULong(celix_array_list_t* list, unsigned long value) {
+    CELIX_EI_IMPL(celix_arrayList_addULong);
+    return __real_celix_arrayList_addULong(list, value);
+}
+
+celix_status_t __real_celix_arrayList_addFloat(celix_array_list_t* list, float value);
+CELIX_EI_DEFINE(celix_arrayList_addFloat, celix_status_t)
+celix_status_t __wrap_celix_arrayList_addFloat(celix_array_list_t* list, float value) {
+    CELIX_EI_IMPL(celix_arrayList_addFloat);
+    return __real_celix_arrayList_addFloat(list, value);
+}
+
+celix_status_t __real_celix_arrayList_addDouble(celix_array_list_t* list, double value);
+CELIX_EI_DEFINE(celix_arrayList_addDouble, celix_status_t)
+celix_status_t __wrap_celix_arrayList_addDouble(celix_array_list_t* list, double value) {
+    CELIX_EI_IMPL(celix_arrayList_addDouble);
+    return __real_celix_arrayList_addDouble(list, value);
+}
+
+celix_status_t __real_celix_arrayList_addBool(celix_array_list_t* list, bool value);
+CELIX_EI_DEFINE(celix_arrayList_addBool, celix_status_t)
+celix_status_t __wrap_celix_arrayList_addBool(celix_array_list_t* list, bool value) {
+    CELIX_EI_IMPL(celix_arrayList_addBool);
+    return __real_celix_arrayList_addBool(list, value);
+}
+
+celix_status_t __real_celix_arrayList_addSize(celix_array_list_t* list, size_t value);
+CELIX_EI_DEFINE(celix_arrayList_addSize, celix_status_t)
+celix_status_t __wrap_celix_arrayList_addSize(celix_array_list_t* list, size_t value) {
+    CELIX_EI_IMPL(celix_arrayList_addSize);
+    return __real_celix_arrayList_addSize(list, value);
+}
+
+}
diff --git a/libs/utils/gtest/CMakeLists.txt b/libs/utils/gtest/CMakeLists.txt
@@ -82,8 +82,9 @@ if (LINKER_WRAP_SUPPORTED)
             src/FileUtilsErrorInjectionTestSuite.cc
             src/ConvertUtilsErrorInjectionTestSuite.cc
             src/IpUtilsErrorInjectionTestSuite.cc
-            )
-    target_link_libraries(test_utils_with_ei PRIVATE Celix::zip_ei Celix::stdio_ei Celix::stat_ei Celix::fts_ei Celix::utils_obj Celix::utils_ei Celix::ifaddrs_ei GTest::gtest GTest::gtest_main)
+            src/ArrayListErrorInjectionTestSuite.cc
+    )
+    target_link_libraries(test_utils_with_ei PRIVATE Celix::zip_ei Celix::stdio_ei Celix::stat_ei Celix::fts_ei Celix::utils_obj Celix::utils_ei Celix::ifaddrs_ei Celix::malloc_ei GTest::gtest GTest::gtest_main)
     target_include_directories(test_utils_with_ei PRIVATE ../src) #for version_private (needs refactoring of test)
     celix_deprecated_utils_headers(test_utils_with_ei)
     add_dependencies(test_utils_with_ei test_utils_resources)
diff --git a/libs/utils/gtest/src/ArrayListErrorInjectionTestSuite.cc b/libs/utils/gtest/src/ArrayListErrorInjectionTestSuite.cc
@@ -0,0 +1,51 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.
+ */
+
+#include <gtest/gtest.h>
+
+#include "celix_array_list.h"
+#include "malloc_ei.h"
+
+class ArrayListErrorInjectionTestSuite : public ::testing::Test {
+public:
+    ArrayListErrorInjectionTestSuite() = default;
+    ~ArrayListErrorInjectionTestSuite() noexcept override {
+        celix_ei_expect_realloc(nullptr, 0, nullptr);
+    }
+};
+
+TEST_F(ArrayListErrorInjectionTestSuite, TestAddFunctions) {
+    //Given an array list with a capacity of 10 (whitebox knowledge)
+    auto* list = celix_arrayList_create();
+
+    //When adding 10 elements, no error is expected
+    for (int i = 0; i < 10; ++i) {
+        EXPECT_EQ(CELIX_SUCCESS, celix_arrayList_addInt(list, i));
+    }
+    EXPECT_EQ(10, celix_arrayList_size(list));
+
+    //And realloc is primed to fail
+    celix_ei_expect_realloc(CELIX_EI_UNKNOWN_CALLER, 1, nullptr);
+
+    //Then adding an element should fail
+    EXPECT_EQ(CELIX_ENOMEM, celix_arrayList_addInt(list, 10));
+    EXPECT_EQ(10, celix_arrayList_size(list));
+
+    celix_arrayList_destroy(list);
+}
diff --git a/libs/utils/gtest/src/ArrayListTestSuite.cc b/libs/utils/gtest/src/ArrayListTestSuite.cc
@@ -230,3 +230,30 @@ TEST_F(ArrayListTestSuite, TestSortForArrayList) {
 
     celix_arrayList_destroy(list);
 }
+
+TEST_F(ArrayListTestSuite, TestReturnStatusAddFunctions) {
+    auto* list = celix_arrayList_create();
+    ASSERT_TRUE(list != nullptr);
+    EXPECT_EQ(0, celix_arrayList_size(list));
+
+    //no error, return status is CELIX_SUCCESS
+    EXPECT_EQ(CELIX_SUCCESS, celix_arrayList_addInt(list, 1));
+    EXPECT_EQ(1, celix_arrayList_size(list));
+
+    EXPECT_EQ(CELIX_SUCCESS, celix_arrayList_addLong(list, 2L));
+    EXPECT_EQ(2, celix_arrayList_size(list));
+
+    EXPECT_EQ(CELIX_SUCCESS, celix_arrayList_addFloat(list, 3.0f));
+    EXPECT_EQ(3, celix_arrayList_size(list));
+
+    EXPECT_EQ(CELIX_SUCCESS, celix_arrayList_addDouble(list, 4.0));
+    EXPECT_EQ(4, celix_arrayList_size(list));
+
+    EXPECT_EQ(CELIX_SUCCESS, celix_arrayList_addBool(list, true));
+    EXPECT_EQ(5, celix_arrayList_size(list));
+
+    EXPECT_EQ(CELIX_SUCCESS, celix_arrayList_add(list, (void*)0x42));
+    EXPECT_EQ(6, celix_arrayList_size(list));
+
+    celix_arrayList_destroy(list);
+}
diff --git a/libs/utils/include/celix_array_list.h b/libs/utils/include/celix_array_list.h
diff --git a/libs/utils/include/celix_errno.h b/libs/utils/include/celix_errno.h
diff --git a/libs/utils/include_deprecated/array_list.h b/libs/utils/include_deprecated/array_list.h
diff --git a/libs/utils/src/array_list.c b/libs/utils/src/array_list.c

Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,8 @@ extern "C" {`
`27`	`27`
`28`	`28`	`CELIX_EI_DECLARE(asprintf, int);`
`29`	`29`
	`30`	`+CELIX_EI_DECLARE(vasprintf, int);`
	`31`	`+`
`30`	`32`	`#ifdef __cplusplus`
`31`	`33`	`}`
`32`	`34`	`#endif`