2023-01-05: Bug fixes

Fixed
- Updated Dockerfile to use Ubuntu Kinetic which includes the required
versions of libmosquitto and libwebsockets
- If 'obuspa -c get' truncates the printing of a parameter value, this
is now indicated
- Added note that start transaction vendor hook must never return a
failure, as it is not possible for OBUSPA to handle the failure in all
cases

Author: Richard Holme

Dockerfile

@@ -1,13 +1,9 @@
-FROM ubuntu:focal
+ # Ubuntu 22.10 (Kinetic Kudu) includes libmosquitto 2.0.11 and libwebsockets 4.1.6
+FROM ubuntu:kinetic
 
 ENV MAKE_JOBS=8
 ENV OBUSPA_ARGS="-v4"
 
-# Add mosquitto latest ppa
-RUN apt-get update && \
-    apt-get install -y software-properties-common && \
-    add-apt-repository ppa:mosquitto-dev/mosquitto-ppa
-
 # Install dependencies
 RUN apt-get update &&\
     apt-get -y install \

src/core/cli_server.c

@@ -761,7 +761,7 @@ int ExecuteCli_Set(char *arg1, char *arg2, char *usage)
 {
     int i;
     int err;
-    char path[USP_ERR_MAXLEN];
+    char path[MAX_DM_PATH];
     dm_trans_vector_t trans;
     str_vector_t objects;
     char param_name[MAX_DM_PATH];
@@ -847,7 +847,7 @@ int ExecuteCli_Add(char *arg1, char *arg2, char *usage)
 {
     int i;
     int err;
-    char path[USP_ERR_MAXLEN];
+    char path[MAX_DM_PATH];
     dm_trans_vector_t trans;
     str_vector_t objects;
     char *instance_str;
@@ -1790,7 +1790,9 @@ int SplitSetExpression(char *expr, char *search_path, int search_path_len, char
 **
 ** SendCliResponse
 **
-** Sends the printf-style formatted message back to the CLI client
+** Sends the printf-style formatted message back to the CLI client. In the
+** event that the buffer is too small, truncate the response, and make it
+** clear that it has been truncated
 **
 ** \param   fmt - printf style format
 **
@@ -1799,15 +1801,24 @@ int SplitSetExpression(char *expr, char *search_path, int search_path_len, char
 **************************************************************************/
 void SendCliResponse(char *fmt, ...)
 {
+    #define MAX_CLI_RSP_LEN 4096
     va_list ap;
-    char buf[USP_ERR_MAXLEN];
+    char buf[MAX_CLI_RSP_LEN];
+    int chars_written;
 
-    // Write the USP error message into the local store
+    // Write the message into the local store
     va_start(ap, fmt);
-    vsnprintf(buf, sizeof(buf), fmt, ap);
+    chars_written = vsnprintf(buf, sizeof(buf), fmt, ap);
     buf[sizeof(buf)-1] = '\0';
     va_end(ap);
 
+    // Ensure that if the message has been truncated, that it is reported
+    if (chars_written >= sizeof(buf)-1)
+    {
+        #define TRUNCATED_STR "...[truncated]...\n"
+        memcpy(&buf[sizeof(buf)-sizeof(TRUNCATED_STR)], TRUNCATED_STR, sizeof(TRUNCATED_STR));
+    }
+
     CLI_SERVER_SendResponse(buf);
 }
 

src/include/usp_api.h

@@ -263,6 +263,10 @@ typedef int (*dm_vendor_reboot_cb_t)(void);
 typedef int (*dm_vendor_factory_reset_cb_t)(void);
 
 // Vendor hooks associated with vendor database transactions
+// NOTE: The start transaction vendor hook must only return when the start transaction has completed successfully.
+//       It must never return an error. This is necessary because there are some cases where the agent cannot sensibly
+//       handle success followed by failure as it would lead to data model inconsistencies.
+//       e.g. when the result of one USP Set request cascades to other parts of the data model
 typedef int (*dm_vendor_start_trans_cb_t)(void);
 typedef int (*dm_vendor_commit_trans_cb_t)(void);
 typedef int (*dm_vendor_abort_trans_cb_t)(void);