Topic/final changeset

.github/instructions/implementation.instructions.md

@@ -0,0 +1,32 @@
+## Implementation Guidelines
+
+- **Project Goal:** Migrate existing scripts to C code.
+- **Target Platforms:** Multiple embedded platforms with low memory and low CPU resources.
+- **Constraints:** Code must be efficient, lightweight, and platform-neutral to ensure portability across different embedded systems.
+
+## Implementation Strategy
+1. **Setup Development Environment**
+    - Use docker containers for consistent build environments.
+    - Container image that can be used for functional testing - https://github.com/rdkcentral/docker-device-mgt-service-test/pkgs/container/docker-device-mgt-service-test%2Fnative-platform
+
+2. **Code Development**
+    - Translate HLD components into modular C code.
+    - Adhere to coding standards and best practices for embedded systems.
+    - Implement error handling and logging mechanisms.
+    - Optimize for memory usage and performance.
+    - Do not use system calls to best possible extent.
+
+3. **Code Review and Integration**
+    - Conduct peer reviews to ensure code quality and adherence to design.
+    - Integrate modules incrementally and perform integration testing.
+
+4. **Documentation**
+    - Update code comments and API documentation.
+    - Document build and deployment procedures.
+    - Provide examples and usage guidelines.
+    - Maintain a changelog for implementation updates.
+
+5. **Testing**
+    - Develop unit tests for individual modules.
+    - Perform system testing on target hardware or simulators.
+    - Validate against original script functionality and performance criteria.

.github/instructions/migrationHLD.instructions.md

@@ -0,0 +1,52 @@
+## HLD Generation Guidelines
+
+- **Project Goal:** Migrate existing scripts to C code.
+- **Target Platforms:** Multiple embedded platforms with low memory and low CPU resources.
+- **Constraints:** Code must be efficient, lightweight, and platform-neutral to ensure portability across different embedded systems.
+
+## Migration Strategy
+1. **Requirements Gathering**
+    - For scripts selected in context, create a Markdown (`.md`) file documenting:
+        - Functional requirements
+        - Inputs/outputs
+        - Dependencies
+        - Constraints (timing, memory, etc.)
+        - Edge cases and error handling
+
+2. **High Level Design (HLD)**
+    - For each script, create a separate HLD `.md` file including:
+        - Architecture overview
+        - Module/component breakdown
+        - Data flow diagrams or descriptions
+        - Key algorithms and data structures
+        - Interfaces and integration points
+
+3. **Flowchart Creation**
+   - Develop flowcharts to visually represent the script's logic and workflow.
+   - Use `mermaid` syntax for creating flowcharts.
+   - For environments that may have issues with complex Mermaid diagrams, include a simplified text-based flowchart alternative.
+   - For scripts having related functionality, create combined or linked flowcharts to show interactions.
+   - Use standard flowchart symbols for processes, decisions, inputs/outputs, and connectors.
+   - Ensure flowcharts are clear, concise, and accurately reflect the script's functionality.
+   - Include annotations or notes for complex logic or important details.
+   - Store flowcharts in a dedicated directory within the project for easy reference.
+
+4. **Sequence Diagrams**
+   - Create sequence diagrams to illustrate interactions between components or modules.
+   - Use `mermaid` syntax for creating sequence diagrams.
+   - For environments that may have issues with complex Mermaid diagrams, include a simplified text-based sequence diagram alternative.
+   - Ensure diagrams clearly show the order of operations and interactions.
+   - Include annotations for clarity where necessary.
+
+5. **LLD Preparation**
+   - Prepare a Low-Level Design (LLD) document outlining:
+       - Detailed design specifications
+       - Data structures and algorithms
+       - Pseudocode or code snippets
+       - Interface definitions
+       - Error handling and edge cases
+
+5. **Fine tuning**
+   - Do not create implementation roadmap markdown files.
+   - Do not suggest timelines or planning details for execution.
+

cov_build.sh

@@ -43,7 +43,15 @@ fi
 if [ ! -d tr69hostif ]; then
     git clone https://github.com/rdkcentral/tr69hostif.git
 fi
+git clone https://github.com/rdkcentral/dcm-agent.git -b feature/logupload_copilot_lib
 
+cd dcm-agent
+sh cov_build.sh
+autoreconf -i
+./configure
+make && make install
+cp uploadstblogs/include/*.h /usr/local/include 
+cd -
 cd rfc
 autoreconf -i
 ./configure --enable-rfctool=yes --enable-tr181set=yes

run_l2.sh

@@ -79,3 +79,4 @@ pytest --json-report --json-report-summary --json-report-file $RESULT_DIR/rrd_st
 pytest --json-report --json-report-summary --json-report-file $RESULT_DIR/rrd_background_cmd_static_profile_report.json test/functional-tests/tests/test_rrd_background_cmd_static_profile_report.py
 pytest --json-report --json-report-summary --json-report-file $RESULT_DIR/rrd_debug_report_upload.json test/functional-tests/tests/test_rrd_debug_report_upload.py
 pytest --json-report --json-report-summary --json-report-file $RESULT_DIR/rrd_deepsleep_static.json test/functional-tests/tests/test_rrd_deepsleep_static_report.py
+pytest --json-report --json-report-summary --json-report-file $RESULT_DIR/rrd_c_api_upload.json test/functional-tests/tests/test_rrd_c_api_upload.py

src/Makefile.am

@@ -1,14 +1,3 @@
-##########################################################################
-# If not stated otherwise in this file or this component's LICENSE
-# file the following copyright and licenses apply:
-#
-# Copyright 2018 RDK Management
-#
-# 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,
@@ -20,14 +9,17 @@
 bin_PROGRAMS = remotedebugger
 
 remotedebuggerincludedir = $(includedir)/rrd
-remotedebuggerinclude_HEADERS = rrdCommon.h rrdInterface.h
+remotedebuggerinclude_HEADERS = rrdCommon.h rrdInterface.h \
+        rrd_archive.h rrd_config.h rrd_logproc.h rrd_sysinfo.h rrd_upload.h
+
+remotedebugger_SOURCES = rrdMain.c rrdEventProcess.c rrdJsonParser.c rrdRunCmdThread.c rrdCommandSanity.c rrdDynamic.c rrdExecuteScript.c rrdMsgPackDecoder.c rrdInterface.c uploadRRDLogs.c rrd_config.c rrd_sysinfo.c rrd_logproc.c rrd_archive.c rrd_upload.c
 
-remotedebugger_SOURCES = rrdMain.c rrdEventProcess.c rrdJsonParser.c rrdRunCmdThread.c rrdCommandSanity.c rrdDynamic.c rrdExecuteScript.c rrdMsgPackDecoder.c rrdInterface.c
-remotedebugger_CFLAGS = -I$(top_srcdir)/include/rrd -I$(PKG_CONFIG_SYSROOT_DIR)${includedir}/trower-base64/ -I$(PKG_CONFIG_SYSROOT_DIR)${includedir}/rbus/ $(CJSON_CFLAGS)
-AM_LDFLAGS="-lpthread -lrdkloggers -lmsgpackc -ltrower-base64 -lwebconfig_framework -lrbus -lsecure_wrapper"
+remotedebugger_CFLAGS = -I$(top_srcdir)/include/rrd -I$(PKG_CONFIG_SYSROOT_DIR)${includedir}/trower-base64/ -I$(PKG_CONFIG_SYSROOT_DIR)${includedir}/rbus/  -I$(PKG_CONFIG_SYSROOT_DIR)${includedir} $(CJSON_CFLAGS)
+AM_LDFLAGS="-lpthread -lrdkloggers -lmsgpackc -ltrower-base64 -lwebconfig_framework -lrbus -lsecure_wrapper "
+remotedebugger_LDADD = -lfwutils -luploadstblogs -lz
 if IARMBUS_ENABLE
 remotedebugger_SOURCES += rrdIarmEvents.c
 remotedebugger_CFLAGS += -I$(PKG_CONFIG_SYSROOT_DIR)${includedir}/rdk/iarmbus/ -I$(PKG_CONFIG_SYSROOT_DIR)${includedir}/rdk/iarmmgrs/rdmmgr -I$(PKG_CONFIG_SYSROOT_DIR)${includedir}/rdk/iarmmgrs-hal -DIARMBUS_SUPPORT
 AM_LDFLAGS += "-lIARMBus -lrfcapi -ltr181api"
 endif
-remotedebugger_LDFLAGS = $(AM_LDFLAGS) $(CJSON_LDFLAGS) $(CJSON_LIBS) -fno-common
+remotedebugger_LDFLAGS = $(AM_LDFLAGS) $(CJSON_LDFLAGS) $(CJSON_LIBS) -luploadstblogs -fno-common

src/rrdExecuteScript.c

@@ -19,22 +19,17 @@
 
 #include "rrdExecuteScript.h"
 #if !defined(GTEST_ENABLE)
-#define RRD_SCRIPT "/lib/rdk/uploadRRDLogs.sh"
-#else
-#define RRD_SCRIPT "./mockSampleUploadScript.sh"
-#endif
-#if !defined(GTEST_ENABLE)
 #include "secure_wrapper.h"
 #endif
 
 static void normalizeIssueName(char *str);
 
 /*
  * @function uploadDebugoutput
- * @brief Executes a script to perform tar and upload operations for the collected issue logs.
+ * @brief Calls the upload API to perform tar and upload operations for the collected issue logs.
  * @param char *outdir - Output directory string.
  * @param char *issuename - Issue type from RFC.
- * @return int - Returns 0 for success and 1 for failure.
+ * @return int - Returns 0 for success and non-zero for failure.
  */
 int uploadDebugoutput(char *outdir, char *issuename)
 {
@@ -43,10 +38,16 @@ int uploadDebugoutput(char *outdir, char *issuename)
     if(outdir != NULL && issuename != NULL)
     {
         normalizeIssueName(issuename);
-        RDK_LOG(RDK_LOG_INFO,LOG_REMDEBUG,"[%s:%d]: Starting Upload Debug output Script: %s... \n",__FUNCTION__,__LINE__,RRD_SCRIPT);
-        if(v_secure_system("%s %s %s",RRD_SCRIPT,outdir,issuename) != 0)
+        RDK_LOG(RDK_LOG_INFO,LOG_REMDEBUG,"[%s:%d]: Starting Upload Debug output via API... \n",__FUNCTION__,__LINE__);
+
+        ret = rrd_upload_orchestrate(outdir, issuename);
+        if(ret != 0)
+        {
+            RDK_LOG(RDK_LOG_ERROR,LOG_REMDEBUG,"[%s:%d]: Upload orchestration failed with code: %d\n",__FUNCTION__,__LINE__, ret);
+        }
+        else
         {
-            ret = 1;
+            RDK_LOG(RDK_LOG_INFO,LOG_REMDEBUG,"[%s:%d]: Upload orchestration completed successfully\n",__FUNCTION__,__LINE__);
         }
     }
 

src/rrdExecuteScript.h

@@ -26,6 +26,7 @@ extern "C"
 #endif
 
 #include "rrdCommon.h"
+#include "rrd_upload.h"
 
 int uploadDebugoutput(char *outdir, char *issuename);