Add a python script to help pick up the latest cjson and libcbor (#1211)

Author: TingDaoK

THIRD-PARTY-LICENSES.txt

@@ -34,7 +34,7 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 ------
 
-** cJSON; version 1.7.16 -- https://github.com/DaveGamble/cJSON
+** cJSON; version 1.7.18 -- https://github.com/DaveGamble/cJSON
 Copyright (c) 2009-2017 Dave Gamble and cJSON contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -57,7 +57,7 @@ THE SOFTWARE.
 
 ------
 
-** libcbor; version 0.11.0 -- https://github.com/PJK/libcbor
+** libcbor; version 0.12.0 -- https://github.com/PJK/libcbor
 Copyright (c) 2014-2017 Pavel Kalvoda
 
 MIT License

scripts/import_libcbor.py

@@ -1,3 +1,4 @@
+#!/usr/bin/env python3
 import os
 import tempfile
 import shutil
@@ -93,10 +94,13 @@ def parse_version(version_string):
     subprocess.run(clone_command, shell=True, check=True)
     subprocess.run(["git", "checkout", "tags/" + args.version],
                    cwd=temp_repo_dir, check=True)
+    version_number = args.version[1:]  # Remove 'v' prefix
 
     # Create a separate folder for the copied files
+    base_dir = os.path.join(os.path.dirname(
+        __file__), "..")
     output_dir = os.path.join(
-        os.path.dirname(__file__), "..", "source", "external", "libcbor")
+        base_dir, "source", "external", "libcbor")
     shutil.rmtree(output_dir, ignore_errors=True)
     os.makedirs(output_dir, exist_ok=True)
 
@@ -121,6 +125,21 @@ def parse_version(version_string):
         file.write(GENERATED_NOTES)
         file.write(CONFIGURATION_H)
 
+    # Update the version number in THIRD-PARTY-LICENSES.txt
+    license_path = os.path.join(base_dir, "THIRD-PARTY-LICENSES.txt")
+    with open(license_path, 'r') as f:
+        content = f.read()
+
+    # Update the version number using regex for more accurate replacement
+    pattern = r'\*\* libcbor; version \d+\.\d+\.\d+ --'
+    replacement = f'** libcbor; version {version_number} --'
+    content = re.sub(pattern, replacement, content)
+
+    with open(license_path, 'w') as f:
+        f.write(content)
+
+    print(f"Updated libcbor to version {version_number}")
+
 except Exception as e:
     print(f"An error occurred: {e}")
 

scripts/update_cjson.py

@@ -0,0 +1,105 @@
+#!/usr/bin/env python3
+import os
+import shutil
+import tempfile
+import subprocess
+import re
+
+
+def run_command(cmd, cwd=None, check=True):
+    """Run a command and return its output."""
+    print(f"Running: {cmd}")
+    result = subprocess.run(cmd, shell=True, check=check, text=True,
+                            stdout=subprocess.PIPE, stderr=subprocess.PIPE, cwd=cwd)
+    return result.stdout.strip(), result.returncode
+
+
+def main():
+    # Create a temporary directory
+    temp_dir = tempfile.mkdtemp()
+    print(f"Created temporary directory: {temp_dir}")
+
+    try:
+        # 1. Clone the cJSON repository
+        _, _ = run_command(
+            f"git clone https://github.com/DaveGamble/cJSON.git {temp_dir}")
+
+        # 2. Get the latest release tag
+        tags_output, _ = run_command("git tag -l", cwd=temp_dir)
+        tags = tags_output.split('\n')
+        # Filter for version tags (e.g., v1.7.15)
+        version_tags = [tag for tag in tags if re.match(
+            r'^v\d+\.\d+\.\d+$', tag)]
+        # Sort by version number
+        version_tags.sort(key=lambda v: [int(x) for x in v[1:].split('.')])
+        latest_tag = version_tags[-1]
+        latest_version = latest_tag[1:]  # Remove 'v' prefix
+
+        print(f"Latest cJSON version: {latest_version}")
+
+        # Checkout the latest tag
+        _, _ = run_command(f"git checkout {latest_tag}", cwd=temp_dir)
+
+        # 3. Copy cJSON.h and cJSON.c to ./source/external/
+        base_dir = os.path.join(os.path.dirname(
+            __file__), "..")
+        source_dir = os.path.join(base_dir, "source", "external")
+        shutil.copy(os.path.join(temp_dir, "cJSON.h"),
+                    os.path.join(source_dir, "cJSON.h"))
+        shutil.copy(os.path.join(temp_dir, "cJSON.c"),
+                    os.path.join(source_dir, "cJSON.c"))
+
+        print(f"Copied cJSON.h and cJSON.c to {source_dir}")
+
+        # 4. Update the version number in THIRD-PARTY-LICENSES.txt
+        license_path = os.path.join(base_dir, "THIRD-PARTY-LICENSES.txt")
+        with open(license_path, 'r') as f:
+            content = f.read()
+
+        # Update the version number using regex for more accurate replacement
+        pattern = r'\*\* cJSON; version \d+\.\d+\.\d+ --'
+        replacement = f'** cJSON; version {latest_version} --'
+        content = re.sub(pattern, replacement, content)
+
+        with open(license_path, 'w') as f:
+            f.write(content)
+
+        print(f"Updated cJSON to version {latest_version}")
+
+        # 5. Apply the changes from commit f005fdc06c34fdd663031661eff5c5575843e998
+        # https://github.com/awslabs/aws-c-common/pull/1211/commits/f005fdc06c34fdd663031661eff5c5575843e998
+        # it applies the amazon edit to cJSON.h and cJSON.c
+        _, returncode = run_command(
+            f"git add *", cwd=source_dir, check=False)
+        if returncode == 0:
+            _, returncode = run_command(
+                f"git commit -m \"update cjson to {latest_version}\"", cwd=base_dir, check=False)
+            if returncode == 0:
+                _, returncode = run_command(
+                    f"git cherry-pick f005fdc06c34fdd663031661eff5c5575843e998", cwd=base_dir, check=False)
+                if returncode == 0:
+                    print(
+                        "Successfully applied Amazon modifications from commit f005fdc06c34fdd663031661eff5c5575843e998")
+                else:
+                    print(
+                        "\nWARNING: Failed to apply changes from commit f005fdc06c34fdd663031661eff5c5575843e998")
+                    print(
+                        "You will need to manually apply these changes. Please run the following command:")
+                    print(f"  git cherry-pick f005fdc06c34fdd663031661eff5c5575843e998")
+                    print("If there are conflicts, resolve them and then run:")
+                    print("  git cherry-pick --continue")
+            else:
+                print("\nWARNING: Failed to commit the updated cJSON files")
+                print("You will need to manually commit and then apply the changes from commit f005fdc06c34fdd663031661eff5c5575843e998")
+        else:
+            print("\nWARNING: Failed to add the updated cJSON files to git")
+            print("You will need to manually add, commit, and then apply the changes from commit f005fdc06c34fdd663031661eff5c5575843e998")
+
+    finally:
+        # Clean up the temporary directory
+        shutil.rmtree(temp_dir)
+        print(f"Removed temporary directory: {temp_dir}")
+
+
+if __name__ == "__main__":
+    main()

source/external/cJSON.h

@@ -264,7 +264,7 @@ CJSON_PUBLIC(cJSON *) cJSON_Duplicate(const cJSON *item, cJSON_bool recurse);
 CJSON_PUBLIC(cJSON_bool) cJSON_Compare(const cJSON * const a, const cJSON * const b, const cJSON_bool case_sensitive);
 
 /* Minify a strings, remove blank characters(such as ' ', '\t', '\r', '\n') from strings.
- * The input pointer json cannot point to a read-only address area, such as a string constant,
+ * The input pointer json cannot point to a read-only address area, such as a string constant, 
  * but should point to a readable and writable address area. */
 CJSON_PUBLIC(void) cJSON_Minify(char *json);
 

source/external/libcbor/cbor.c

@@ -9,9 +9,8 @@
 #include "cbor/internal/builder_callbacks.h"
 #include "cbor/internal/loaders.h"
 
-#pragma clang diagnostic push
-cbor_item_t *cbor_load(cbor_data source, size_t source_size,
-                       struct cbor_load_result *result) {
+cbor_item_t* cbor_load(cbor_data source, size_t source_size,
+                       struct cbor_load_result* result) {
   /* Context stack */
   static struct cbor_callbacks callbacks = {
       .uint8 = &cbor_builder_uint8_callback,
@@ -115,8 +114,8 @@ cbor_item_t *cbor_load(cbor_data source, size_t source_size,
   return NULL;
 }
 
-static cbor_item_t *_cbor_copy_int(cbor_item_t *item, bool negative) {
-  cbor_item_t *res;
+static cbor_item_t* _cbor_copy_int(cbor_item_t* item, bool negative) {
+  cbor_item_t* res = NULL;
   switch (cbor_int_get_width(item)) {
     case CBOR_INT_8:
       res = cbor_build_uint8(cbor_get_uint8(item));
@@ -137,8 +136,7 @@ static cbor_item_t *_cbor_copy_int(cbor_item_t *item, bool negative) {
   return res;
 }
 
-static cbor_item_t *_cbor_copy_float_ctrl(cbor_item_t *item) {
-  // cppcheck-suppress missingReturn
+static cbor_item_t* _cbor_copy_float_ctrl(cbor_item_t* item) {
   switch (cbor_float_get_width(item)) {
     case CBOR_FLOAT_0:
       return cbor_build_ctrl(cbor_ctrl_value(item));
@@ -148,11 +146,13 @@ static cbor_item_t *_cbor_copy_float_ctrl(cbor_item_t *item) {
       return cbor_build_float4(cbor_float_get_float4(item));
     case CBOR_FLOAT_64:
       return cbor_build_float8(cbor_float_get_float8(item));
+    default:
+      _CBOR_UNREACHABLE;
+      return NULL;
   }
 }
 
-cbor_item_t *cbor_copy(cbor_item_t *item) {
-  // cppcheck-suppress missingReturn
+cbor_item_t* cbor_copy(cbor_item_t* item) {
   switch (cbor_typeof(item)) {
     case CBOR_TYPE_UINT:
       return _cbor_copy_int(item, false);
@@ -163,13 +163,13 @@ cbor_item_t *cbor_copy(cbor_item_t *item) {
         return cbor_build_bytestring(cbor_bytestring_handle(item),
                                      cbor_bytestring_length(item));
       } else {
-        cbor_item_t *res = cbor_new_indefinite_bytestring();
+        cbor_item_t* res = cbor_new_indefinite_bytestring();
         if (res == NULL) {
           return NULL;
         }
 
         for (size_t i = 0; i < cbor_bytestring_chunk_count(item); i++) {
-          cbor_item_t *chunk_copy =
+          cbor_item_t* chunk_copy =
               cbor_copy(cbor_bytestring_chunks_handle(item)[i]);
           if (chunk_copy == NULL) {
             cbor_decref(&res);
@@ -186,16 +186,16 @@ cbor_item_t *cbor_copy(cbor_item_t *item) {
       }
     case CBOR_TYPE_STRING:
       if (cbor_string_is_definite(item)) {
-        return cbor_build_stringn((const char *)cbor_string_handle(item),
+        return cbor_build_stringn((const char*)cbor_string_handle(item),
                                   cbor_string_length(item));
       } else {
-        cbor_item_t *res = cbor_new_indefinite_string();
+        cbor_item_t* res = cbor_new_indefinite_string();
         if (res == NULL) {
           return NULL;
         }
 
         for (size_t i = 0; i < cbor_string_chunk_count(item); i++) {
-          cbor_item_t *chunk_copy =
+          cbor_item_t* chunk_copy =
               cbor_copy(cbor_string_chunks_handle(item)[i]);
           if (chunk_copy == NULL) {
             cbor_decref(&res);
@@ -211,7 +211,7 @@ cbor_item_t *cbor_copy(cbor_item_t *item) {
         return res;
       }
     case CBOR_TYPE_ARRAY: {
-      cbor_item_t *res;
+      cbor_item_t* res;
       if (cbor_array_is_definite(item)) {
         res = cbor_new_definite_array(cbor_array_size(item));
       } else {
@@ -222,7 +222,7 @@ cbor_item_t *cbor_copy(cbor_item_t *item) {
       }
 
       for (size_t i = 0; i < cbor_array_size(item); i++) {
-        cbor_item_t *entry_copy = cbor_copy(cbor_move(cbor_array_get(item, i)));
+        cbor_item_t* entry_copy = cbor_copy(cbor_move(cbor_array_get(item, i)));
         if (entry_copy == NULL) {
           cbor_decref(&res);
           return NULL;
@@ -237,7 +237,7 @@ cbor_item_t *cbor_copy(cbor_item_t *item) {
       return res;
     }
     case CBOR_TYPE_MAP: {
-      cbor_item_t *res;
+      cbor_item_t* res;
       if (cbor_map_is_definite(item)) {
         res = cbor_new_definite_map(cbor_map_size(item));
       } else {
@@ -247,14 +247,14 @@ cbor_item_t *cbor_copy(cbor_item_t *item) {
         return NULL;
       }
 
-      struct cbor_pair *it = cbor_map_handle(item);
+      struct cbor_pair* it = cbor_map_handle(item);
       for (size_t i = 0; i < cbor_map_size(item); i++) {
-        cbor_item_t *key_copy = cbor_copy(it[i].key);
+        cbor_item_t* key_copy = cbor_copy(it[i].key);
         if (key_copy == NULL) {
           cbor_decref(&res);
           return NULL;
         }
-        cbor_item_t *value_copy = cbor_copy(it[i].value);
+        cbor_item_t* value_copy = cbor_copy(it[i].value);
         if (value_copy == NULL) {
           cbor_decref(&res);
           cbor_decref(&key_copy);
@@ -273,16 +273,19 @@ cbor_item_t *cbor_copy(cbor_item_t *item) {
       return res;
     }
     case CBOR_TYPE_TAG: {
-      cbor_item_t *item_copy = cbor_copy(cbor_move(cbor_tag_item(item)));
+      cbor_item_t* item_copy = cbor_copy(cbor_move(cbor_tag_item(item)));
       if (item_copy == NULL) {
         return NULL;
       }
-      cbor_item_t *tag = cbor_build_tag(cbor_tag_value(item), item_copy);
+      cbor_item_t* tag = cbor_build_tag(cbor_tag_value(item), item_copy);
       cbor_decref(&item_copy);
       return tag;
     }
     case CBOR_TYPE_FLOAT_CTRL:
       return _cbor_copy_float_ctrl(item);
+    default:
+      _CBOR_UNREACHABLE;
+      return NULL;
   }
 }
 
@@ -301,11 +304,11 @@ static int _pow(int b, int ex) {
   return res;
 }
 
-static void _cbor_type_marquee(FILE *out, char *label, int indent) {
+static void _cbor_type_marquee(FILE* out, char* label, int indent) {
   fprintf(out, "%*.*s[%s] ", indent, indent, " ", label);
 }
 
-static void _cbor_nested_describe(cbor_item_t *item, FILE *out, int indent) {
+static void _cbor_nested_describe(cbor_item_t* item, FILE* out, int indent) {
   const int indent_offset = 4;
   switch (cbor_typeof(item)) {
     case CBOR_TYPE_UINT: {
@@ -329,7 +332,7 @@ static void _cbor_nested_describe(cbor_item_t *item, FILE *out, int indent) {
           _cbor_nested_describe(cbor_bytestring_chunks_handle(item)[i], out,
                                 indent + indent_offset);
       } else {
-        const unsigned char *data = cbor_bytestring_handle(item);
+        const unsigned char* data = cbor_bytestring_handle(item);
         fprintf(out, "Definite, Length: %zuB, Data:\n",
                 cbor_bytestring_length(item));
         fprintf(out, "%*s", indent + indent_offset, " ");
@@ -418,7 +421,7 @@ static void _cbor_nested_describe(cbor_item_t *item, FILE *out, int indent) {
   }
 }
 
-void cbor_describe(cbor_item_t *item, FILE *out) {
+void cbor_describe(cbor_item_t* item, FILE* out) {
   _cbor_nested_describe(item, out, 0);
 }