Merge branch 'dev' into hubspot-custom-properties-and+caching

Author: jirihofman

.github/workflows/nodejs.yml

@@ -12,15 +12,15 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Use Node.js 18.x
       uses: actions/setup-node@v4
       with:
         node-version: 18.x
+        cache: 'npm'
     - name: Install dependencies
       run: npm ci
     - name: Run lint
       run: npm run lint
-
-#    - name: Run unit tests
-#      run: npm run test-unit
+    - name: Run unit tests
+      run: npm run test-unit

.github/workflows/sonar.yml

@@ -15,13 +15,26 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          # our sonarqube server doesn't like node 20
+          node-version: '18'
+          cache: 'npm'
+      - name: Install dependencies
+        run: npm install
+      - name: Run unit tests and coverage
+        run: npm run test-unit-coverage
       - name: SonarQube Scan
         uses: SonarSource/[email protected]
         with:
           args: >
             -Dsonar.projectKey=clientIO_appmixer-connectors_AY7J_O6GZsPR2eThxIf0
             -Dsonar.sources=src
+            -Dsonar.tests=test
+            -Dsonar.javascript.lcov.reportPaths=coverage/lcov.info
             -Dsonar.exclusions=*/test/**
+            -Dsonar.coverage.exclusions=node_modules/**,test/**
         env:
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
           SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}

.gitignore

@@ -17,3 +17,5 @@ tags.lock
 .vscode
 *~*
 .env.local
+coverage/
+.nyc_output/

README.md

@@ -1,2 +1,20 @@
 # appmixer-connectors 
 Appmixer Connectors
+
+## Test
+In the `test` directory, you can find the test files for the connectors. They are not exhaustive as there is another set of tests that are not public.
+
+### Running the tests
+```sh
+npm run test-unit
+```
+
+### Appmixer stub
+In `test/utils.js` you can find a stub for the Appmixer API. It is supposed to emulate all the advanced features of the Appmixer engine like sending messages, doing HTTP requests, using cache, etc. It is not a complete implementation of the Appmixer API, but it is enough to test the connectors. You can use it to test your connectors without having to run the Appmixer engine.
+
+These tests run for each PR. They are also integrated into SonarQube analysis which is run on each commit to `dev` branch.
+
+### What to test
+Rule of thumb:
+- a `receive` function in a component should be tested if it has any logic in it (caching, timeouts, bulk processing). If it is just a pass-through, it does not need to be tested.
+- a `routes.js` file should be tested if used for more complex tasks. For example processing incoming webhooks.