Update note-c subtree (#97)

* remove note-c before re-add

* Squashed 'src/note-c/' content from commit 5c65c34

git-subtree-dir: src/note-c
git-subtree-split: 5c65c345f6eb2e3663800337d1b5c6370736ee1a

Author: zfields

src/note-c/.devcontainer/devcontainer.json

@@ -0,0 +1,39 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.205.2/containers/docker-existing-dockerfile
+{
+    "name": "Note-C Development Environment Dockerfile",
+
+    // Sets the run context to one level up instead of the .devcontainer folder.
+    "context": "..",
+
+    // Update the 'dockerFile' property if you aren't using the standard 'Dockerfile' filename.
+    //"dockerFile": "../.github/actions/compile-examples/Dockerfile",
+    "dockerFile": "../.github/actions/run_unit_tests/Dockerfile",
+
+    // Set *default* container specific settings.json values on container create.
+    "settings": {},
+
+    // Add the IDs of extensions you want installed when the container is created.
+    "extensions": [
+        "ms-vscode.cpptools",
+        "shardulm94.trailing-spaces",
+        "twxs.cmake"
+    ],
+
+    // Use 'forwardPorts' to make a list of ports inside the container available locally.
+    // "forwardPorts": [],
+
+    // Uncomment the next line to run commands after the container is created - for example installing curl.
+    // "postCreateCommand": "apt-get update && apt-get install -y curl",
+
+    // Uncomment when using a ptrace-based debugger like C++, Go, and Rust
+    // "runArgs": [
+    //     "--device=/dev/bus/usb/"
+    // ],
+
+    // Uncomment to use the Docker CLI from inside the container. See https://aka.ms/vscode-remote/samples/docker-from-docker.
+    // "mounts": [ "source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind" ],
+
+    // Uncomment to connect as a non-root user if you've added one. See https://aka.ms/vscode-remote/containers/non-root.
+    "remoteUser": "blues"
+}

src/note-c/.github/actions/run_unit_tests/Dockerfile

@@ -6,17 +6,53 @@
 # Launch development environment (mount source root as /note-c/)
 # $ docker run --rm --volume $(pwd)/../../../:/note-c/ --workdir /note-c/ note_c_run_unit_tests
 
+# Global Argument(s)
+ARG DEBIAN_FRONTEND="noninteractive"
+ARG UID=1000
+ARG USER="blues"
+
 # POSIX compatible (Linux/Unix) base image.
 FROM debian:stable-slim
 
+# Import Global Argument(s)
+ARG DEBIAN_FRONTEND
+ARG UID
+ARG USER
+
+# Local Argument(s)
+
+# Create Non-Root User
+RUN ["dash", "-c", "\
+    addgroup \
+     --gid ${UID} \
+     \"${USER}\" \
+ && adduser \
+     --disabled-password \
+     --gecos \"\" \
+     --ingroup \"${USER}\" \
+     --uid ${UID} \
+     \"${USER}\" \
+ && usermod \
+     --append \
+     --groups \"dialout,plugdev\" \
+     \"${USER}\" \
+"]
+
 # Install whatever dependencies we can via apt-get.
 RUN ["dash", "-c", "\
     apt-get update --quiet \
  && apt-get install --assume-yes --no-install-recommends --quiet \
-     build-essential \
+     astyle \
      ca-certificates \
      curl \
+     g++ \
+     gcc \
+     gdb \
+     git \
      lcov \
+     make \
+     nano \
+     valgrind \
  && apt-get clean \
  && apt-get purge \
  && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* \
@@ -40,4 +76,4 @@ RUN ["dash", "-c", "\
  && rm -rf Catch2-3.2.1  v3.2.1.tar.gz \
 "]
 
-ENTRYPOINT ["./scripts/run_unit_tests.sh", "--coverage"]
+ENTRYPOINT ["./scripts/run_unit_tests.sh", "--coverage", "--mem-check"]

src/note-c/.github/workflows/ci.yml

@@ -14,6 +14,15 @@ jobs:
         uses: actions/checkout@v3
       - name: Run unit tests
         uses: ./.github/actions/run_unit_tests
+      - name: Coveralls Action Bug Workaround
+        id: coveralls_bug_workaround
+        run: sudo sed -i 's/github\/workspace/home\/runner\/work\/note-c\/note-c/g' ./build/test/coverage/lcov.info
+      - name: Publish Test Coverage
+        id: publish_coverage
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          path-to-lcov: ./build/test/coverage/lcov.info
   run_astyle:
     runs-on: ubuntu-latest
     steps:

src/note-c/.vscode/tasks.json

@@ -0,0 +1,58 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Note-C: Compile and Run ALL Tests",
+            "type": "cppbuild",
+            "command": "./scripts/run_unit_tests.sh",
+            "args": [],
+            "options": {
+                "cwd": "${workspaceFolder}"
+            },
+            "problemMatcher": [
+                "$gcc"
+            ],
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            }
+        },
+        {
+            "label": "Note-C: Compile and Run ALL Tests (with coverage and memory check)",
+            "type": "cppbuild",
+            "command": "./scripts/run_unit_tests.sh",
+            "args": [
+                "--coverage",
+                "--mem-check"
+            ],
+            "options": {
+                "cwd": "${workspaceFolder}"
+            },
+            "problemMatcher": [
+                "$gcc"
+            ],
+            "group": {
+                "kind": "build",
+                "isDefault": false
+            }
+        },
+        {
+            "label": "Note-C: Run `astyle` Formatter",
+            "type": "shell",
+            "command": "./scripts/run_astyle.sh",
+            "args": [],
+            "options": {
+                "cwd": "${workspaceFolder}",
+                "env": {
+                    "LC_ALL":"C"
+                }
+            },
+            "problemMatcher": [
+                "$gcc"
+            ],
+            "group": {
+                "kind": "none"
+            }
+        }
+    ]
+}

src/note-c/CMakeLists.txt

@@ -14,16 +14,10 @@ if(NOT EXISTS ${PROJECT_BINARY_DIR}/.gitignore)
     file(WRITE ${PROJECT_BINARY_DIR}/.gitignore "*")
 endif()
 
-option(BUILD_TESTS "Build tests." ON)
-option(BUILD_SHARED_LIBS "Build note-c as a shared library." ON)
+option(BUILD_TESTS "Build tests." OFF)
+option(BUILD_SHARED_LIBS "Build note-c as a shared library." OFF)
 option(COVERAGE "Compile for test coverage reporting." OFF)
-
-add_compile_options(
-    -Wall
-    -Wextra
-    -Wpedantic
-    -Werror
-)
+option(MEM_CHECK "Run tests with Valgrind." OFF)
 
 set(NOTE_C_SRC_DIR ${CMAKE_CURRENT_SOURCE_DIR})
 add_library(
@@ -44,16 +38,37 @@ add_library(
     ${NOTE_C_SRC_DIR}/n_request.c
     ${NOTE_C_SRC_DIR}/n_str.c
 )
+target_compile_options(
+    note_c
+    PRIVATE
+        -Wall
+        -Wextra
+        -Wpedantic
+        -Werror
+)
+target_include_directories(
+    note_c
+    PUBLIC ${NOTE_C_SRC_DIR}
+)
 
 if(BUILD_TESTS)
-    add_compile_definitions(
-        TEST
-    )
-
-    # Including this here rather than in test/CMakeLists.txt allows us to run
+    # Including CTest here rather than in test/CMakeLists.txt allows us to run
     # ctest from the root build directory (e.g. build/ instead of build/test/).
+    # We also need to set MEMORYCHECK_COMMAND_OPTIONS before including this.
+    # See: https://stackoverflow.com/a/60741757
+    if(MEM_CHECK)
+        # Go ahead and make sure we can find valgrind while we're here.
+        find_program(VALGRIND valgrind REQUIRED)
+        message(STATUS "Found valgrind: ${VALGRIND}")
+        set(MEMORYCHECK_COMMAND_OPTIONS "--leak-check=full --error-exitcode=1")
+    endif(MEM_CHECK)
     include(CTest)
 
+    target_compile_definitions(
+        note_c
+        PUBLIC TEST
+    )
+
     # If we don't weaken the functions we're mocking in the tests, the linker
     # will complain about multiple function definitions: the mocked one and the
     # "real" one from note-c. Weakening the real function causes the mock
@@ -82,7 +97,21 @@ if(BUILD_TESTS)
          NoteDebug;
          NotePrint;
          NoteNewCommand;
-         NoteRequest"
+         NoteRequest;
+         JCreateObject;
+         NoteTransactionStart;
+         NoteUserAgent;
+         serialNoteReset;
+         serialNoteTransaction;
+         i2cNoteReset;
+         i2cNoteTransaction;
+         JCreateStringValue;
+         NoteSetEnvDefault;
+         NoteSleep;
+         NotePayloadRetrieveAfterSleep;
+         NoteTimeValidST;
+         NoteTimeST;
+         NoteRegion"
     )
     foreach(MOCKED_FN ${MOCKED_FNS})
         string(APPEND OBJCOPY_WEAKEN "-W ${MOCKED_FN} ")

src/note-c/README.md

@@ -1,3 +1,5 @@
+[![Coverage Status](https://coveralls.io/repos/github/blues/note-c/badge.svg?branch=master)](https://coveralls.io/github/blues/note-c?branch=master)
+
 # note-c
 
 The note-c C library for communicating with the

src/note-c/n_cjson_helpers.c

@@ -386,7 +386,7 @@ bool JGetBinaryFromObject(J *rsp, const char *fieldName, uint8_t **retBinaryData
 /*!
     @brief  Get the object name.
     @param   item The JSON object.
-    @returns The number, or and empty string, if NULL.
+    @returns The name, or the empty string, if NULL.
 */
 /**************************************************************************/
 const char *JGetItemName(const J * item)
@@ -399,10 +399,10 @@ const char *JGetItemName(const J * item)
 
 //**************************************************************************/
 /*!
-    @brief  Convert an integer to text
-    @param   an integer
-    @returns The number converted to text, null-terminated.
-    @note The buffer midt be large enough because no bounds checking is done.
+    @brief  Convert an integer to text.
+    @param   n The integer to convert.
+    @param   s The buffer to hold the text.
+    @note The buffer must be large enough because no bounds checking is done.
 */
 /**************************************************************************/
 void JItoA(long int n, char *s)
@@ -430,7 +430,7 @@ void JItoA(long int n, char *s)
 //**************************************************************************/
 /*!
     @brief  Convert text to an integer
-    @param   a null-terminated text buffer
+    @param   string A null-terminated text buffer
     @returns An integer, or 0 if invalid
 */
 /**************************************************************************/
@@ -467,15 +467,18 @@ long int JAtoI(const char *string)
 //**************************************************************************/
 /*!
     @brief  Convert a buffer/len to a null-terminated c-string
-    @param   a buffer containing text with a counted length
-    @returns A c-string (NULL if invalid) that must be freed with JFree()
+    @param   buffer A buffer containing the bytes to convert.
+    @param   len The length of buffer in bytes.
+    @returns If buffer is NULL or length 0, the empty string. If allocation
+             fails, NULL. On success, the converted c-string. The returned
+             string must be freed with NoteFree.
 */
 /**************************************************************************/
 char *JAllocString(uint8_t *buffer, uint32_t len)
 {
     char *buf = _Malloc(len+1);
     if (buf == NULL) {
-        return false;
+        return NULL;
     }
     if (len > 0) {
         memcpy(buf, buffer, len);
@@ -517,10 +520,11 @@ const char *JType(J *item)
 
 //**************************************************************************/
 /*!
-    @brief  Return the type of an item, as an int usable in a switch statement
-    @param   json object
-    @param   field within the json object
-    @returns The type
+    @brief  Get the type of a field, as an int usable in a switch statement.
+    @param   rsp The JSON object containing the field.
+    @param   field The field's name.
+    @returns The type of the field on success. JTYPE_NOT_PRESENT on error or if
+             the field doesn't exist.
 */
 /**************************************************************************/
 int JGetType(J *rsp, const char *field)