Merge pull request #92 from Skptak/CI-CD_Updates

CI-CD Updates

Author: AniruddhaKanhere

Diff for: .github/.cSpellWords.txt

@@ -0,0 +1,63 @@
+# Contributing Guidelines
+
+Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
+documentation, we greatly value feedback and contributions from our community.
+
+Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
+information to effectively respond to your bug report or contribution.
+
+
+## Reporting Bugs/Feature Requests
+
+We welcome you to use the GitHub issue tracker to report bugs or suggest features.
+
+When filing an issue, please check [existing open](https://github.com/FreeRTOS/coreMQTT/issues), or [recently closed](https://github.com/FreeRTOS/coreMQTT/issues?q=is%3Aissue+is%3Aclosed), issues to make sure somebody else hasn't already
+reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
+
+* A reproducible test case or series of steps
+* The version of our code being used
+* Any modifications you've made relevant to the bug
+* Anything unusual about your environment or deployment
+
+
+## Contributing via Pull Requests
+Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
+
+1. You are working against the latest source on the *main* branch.
+1. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
+1. You open an issue to discuss any significant work - we would hate for your time to be wasted.
+
+To send us a pull request, please:
+
+1. Fork the repository.
+1. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
+1. Ensure that your contributions conform to the [style guide](https://www.freertos.org/FreeRTOS-Coding-Standard-and-Style-Guide.html).
+1. Format your code with uncrustify, using the config available in [FreeRTOS/CI-CD-Github-Actions](https://github.com/FreeRTOS/CI-CD-Github-Actions/blob/main/formatting/uncrustify.cfg).
+1. Ensure local tests pass.
+1. Commit to your fork using clear commit messages.
+1. Send us a pull request, answering any default questions in the pull request interface.
+1. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
+
+GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
+[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
+
+
+## Finding contributions to work on
+Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels ((enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/FreeRTOS/coreMQTT/labels?q=help+wanted) issues is a great place to start.
+
+
+## Code of Conduct
+This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
+For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
+[email protected] with any additional questions or comments.
+
+
+## Security issue notifications
+If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](https://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
+
+
+## Licensing
+
+See the [LICENSE](../LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
+
+We may ask you to sign a [Contributor License Agreement (CLA)](https://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.

Diff for: .github/CONTRIBUTING.md

@@ -16,43 +16,51 @@ on:
   workflow_dispatch:
 
 jobs:
+  formatting:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v3
+      - name: Check Formatting of Files
+        uses: FreeRTOS/CI-CD-Github-Actions/formatting@main
+        with:
+          exclude-dirs: Drivers
+
   spell-check:
+      runs-on: ubuntu-latest
+      steps:
+        - name: Clone This Repo
+          uses: actions/checkout@v3
+        - name: Run spellings check
+          uses: FreeRTOS/CI-CD-Github-Actions/spellings@main
+
+  link-verifier:
     runs-on: ubuntu-latest
     steps:
       - name: Clone This Repo
-        uses: actions/checkout@v2
-      - name: Run spellings check
-        uses: FreeRTOS/CI-CD-Github-Actions/spellings@main
-        with:
-          path: ./
+        uses: actions/checkout@v3
+      - name: Link Verification
+        uses: FreeRTOS/CI-CD-Github-Actions/link-verifier@main
 
-  formatting:
+  verify-manifest:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Install Uncrustify
-        run: sudo apt-get install uncrustify
-      - name: Run Uncrustify
-        run: |
-          uncrustify --version
-          find Projects Common -iname "*.[hc]" -exec uncrustify --check -c tools/uncrustify.cfg {} +
-      - name: Check For Trailing Whitespace
-        run: |
-          set +e
-          grep --exclude="README.md" -rnI -e "[[:blank:]]$" .
-          if [ "$?" = "0" ]; then
-            echo "Files have trailing whitespace."
-            exit 1
-          else
-            exit 0
-          fi
+      - uses: actions/checkout@v3
+        with:
+          submodules: true
+          fetch-depth: 0
+
+      - name: Run manifest verifier
+        uses: FreeRTOS/CI-CD-GitHub-Actions/manifest-verifier@main
+        with:
+          path: ./
+          fail-on-incorrect-version: true
 
   git-secrets:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Checkout awslabs/git-secrets
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           repository: awslabs/git-secrets
           ref: master
@@ -67,7 +75,7 @@ jobs:
   pre-commit-hooks:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Fetch HEAD revision
         run: git fetch origin
       - name: Install python pip

Diff for: .github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: Format Pull Request Files
+
+on:
+  issue_comment:
+    types: [created]
+
+env:
+  bashPass: \033[32;1mPASSED -
+  bashInfo: \033[33;1mINFO -
+  bashFail: \033[31;1mFAILED -
+  bashEnd:  \033[0m
+
+jobs:
+  Formatting:
+    name: Run Formatting Check
+    if: ${{ github.event.issue.pull_request &&
+        ( ( github.event.comment.body == '/bot run uncrustify' ) ||
+          ( github.event.comment.body == '/bot run formatting' ) ) }}
+    runs-on: ubuntu-20.04
+    steps:
+    - name: Apply Formatting Fix
+      uses: FreeRTOS/CI-CD-Github-Actions/formatting-bot@main
+      id: check-formatting

Diff for: .github/workflows/formatting.yml

@@ -353,19 +353,19 @@ static void prvUnsubscribeFromDefenderTopics( DefenderAgentCtx_t * pxCtx )
 static void prvPrintHex( const uint8_t * pcPayload,
                          size_t xPayloadLen )
 {
-#if ( LOG_LEVEL >= LOG_DEBUG )
-    for( uint32_t i = 0; i < xPayloadLen; i += 16 )
-    {
-        LogDebug( "\t%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X",
-                  pcPayload[ i + 0 ], pcPayload[ i + 1 ], pcPayload[ i + 2 ], pcPayload[ i + 3 ],
-                  pcPayload[ i + 4 ], pcPayload[ i + 5 ], pcPayload[ i + 6 ], pcPayload[ i + 7 ],
-                  pcPayload[ i + 8 ], pcPayload[ i + 9 ], pcPayload[ i + 10 ], pcPayload[ i + 11 ],
-                  pcPayload[ i + 12 ], pcPayload[ i + 13 ], pcPayload[ i + 14 ], pcPayload[ i + 15 ] );
-    }
-#else /* LOG_LEVEL >= LOG_DEBUG */
-    ( void ) pcPayload;
-    ( void ) xPayloadLen;
-#endif /* LOG_LEVEL < LOG_DEBUG */
+    #if ( LOG_LEVEL >= LOG_DEBUG )
+        for( uint32_t i = 0; i < xPayloadLen; i += 16 )
+        {
+            LogDebug( "\t%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X",
+                      pcPayload[ i + 0 ], pcPayload[ i + 1 ], pcPayload[ i + 2 ], pcPayload[ i + 3 ],
+                      pcPayload[ i + 4 ], pcPayload[ i + 5 ], pcPayload[ i + 6 ], pcPayload[ i + 7 ],
+                      pcPayload[ i + 8 ], pcPayload[ i + 9 ], pcPayload[ i + 10 ], pcPayload[ i + 11 ],
+                      pcPayload[ i + 12 ], pcPayload[ i + 13 ], pcPayload[ i + 14 ], pcPayload[ i + 15 ] );
+        }
+    #else /* LOG_LEVEL >= LOG_DEBUG */
+        ( void ) pcPayload;
+        ( void ) xPayloadLen;
+    #endif /* LOG_LEVEL < LOG_DEBUG */
 }
 
 /*-----------------------------------------------------------*/

Diff for: Common/app/defender/defender_task.c

@@ -46,15 +46,15 @@
 #include "lwipopts.h"
 
 #if !defined( LWIP_TCPIP_CORE_LOCKING ) || ( LWIP_TCPIP_CORE_LOCKING == 0 )
-#error "Network metrics are only supported in core locking mode. Please define LWIP_TCPIP_CORE_LOCKING to 1 in lwipopts.h."
+    #error "Network metrics are only supported in core locking mode. Please define LWIP_TCPIP_CORE_LOCKING to 1 in lwipopts.h."
 #endif
 
 #if MIB2_STATS == 0
-#error "MIB2_STATS must be enabled."
+    #error "MIB2_STATS must be enabled."
 #endif
 
 #if LWIP_BYTES_IN_OUT_UNSUPPORTED != 0
-#error "LWIP_BYTES_IN_OUT_UNSUPPORTED must be set to 0."
+    #error "LWIP_BYTES_IN_OUT_UNSUPPORTED must be set to 0."
 #endif
 
 #define UINT16_STR_LEN         5
@@ -122,11 +122,11 @@ CborError xGetNetworkStats( CborEncoder * pxEncoder )
 
         LOCK_TCPIP_CORE();
 
-#if LWIP_SINGLE_NETIF
-        pxNetif = netif_default;
-#else
-        NETIF_FOREACH( pxNetif )
-#endif /* LWIP_SINGLE_NETIF */
+        #if LWIP_SINGLE_NETIF
+            pxNetif = netif_default;
+        #else
+            NETIF_FOREACH( pxNetif )
+        #endif /* LWIP_SINGLE_NETIF */
         {
             xBytesIn += pxNetif->mib2_counters.ifinoctets;
             xBytesOut += pxNetif->mib2_counters.ifoutoctets;

Diff for: Common/app/defender/metrics_collector_lwip.c

@@ -86,7 +86,7 @@
 #define RETRY_MAX_BACKOFF_DELAY     ( 5U * 60U )
 
 /**
- * @brief Multiplier to apply to the bacoff delay to convert arbitrary units to milliseconds.
+ * @brief Multiplier to apply to the backoff delay to convert arbitrary units to milliseconds.
  */
 #define RETRY_BACKOFF_MULTIPLIER    ( 100U )
 

Diff for: Common/app/mqtt/mqtt_agent_task.c

@@ -39,14 +39,14 @@
  * @brief Maximum number of concurrent subscriptions.
  */
 #ifndef MQTT_AGENT_MAX_SUBSCRIPTIONS
-#define MQTT_AGENT_MAX_SUBSCRIPTIONS    10U
+    #define MQTT_AGENT_MAX_SUBSCRIPTIONS    10U
 #endif /* MQTT_AGENT_MAX_SUBSCRIPTIONS */
 
 /**
  * @brief Maximum number of callbacks that may be registered.
  */
 #ifndef MQTT_AGENT_MAX_CALLBACKS
-#define MQTT_AGENT_MAX_CALLBACKS    10U
+    #define MQTT_AGENT_MAX_CALLBACKS    10U
 #endif /* MQTT_AGENT_MAX_CALLBACKS */
 
 /**