Adding unit tests for the upgrade process

JIRA: ZAPP-1362
project-chip · Sep 24, 2024 · 99ed89b · 99ed89b
1 parent feba85c
commit 99ed89b
Show file tree

Hide file tree

Showing 8 changed files with 5,960 additions and 1 deletion.
diff --git a/src-electron/importexport/import-json.js b/src-electron/importexport/import-json.js
@@ -1989,7 +1989,8 @@ async function jsonDataLoader(
   await Promise.all(promisesStage2)
   await querySession.setSessionClean(db, sessionId)
 
-  if ('package' in state) {
+  // No need to go through this when upgrading packages.
+  if ('package' in state && !upgradeZclPackages && !upgradeTemplatePackages) {
     await Promise.all(
       state.package.map(async (pkg) => {
         let pkgFilePath = getPkgPath(pkg, state.filePath)

diff --git a/src-electron/main-process/startup.js b/src-electron/main-process/startup.js
@@ -1105,3 +1105,4 @@ exports.startUpSecondaryInstance = startUpSecondaryInstance
 exports.shutdown = shutdown
 exports.quit = quit
 exports.generateSingleFile = generateSingleFile
+exports.upgradeZapFile = upgradeZapFile
diff --git a/test/gen-template/matter/gen-templates-matter.json b/test/gen-template/matter/gen-templates-matter.json
@@ -0,0 +1,79 @@
+{
+  "name": "Matter test template",
+  "version": "test-matter",
+  "category": "matter",
+  "options": {
+    "testOption": {
+      "code1": "label1",
+      "code2": "label2",
+      "code3": "label3",
+      "code4": "label4",
+      "code5": "label5"
+    },
+    "externalOption": "externalOptions.json",
+    "cli": "cli.json",
+    "generator": {
+      "disableUcComponentOnZclClusterUpdate": "true"
+    }
+  },
+  "zcl": {
+    "event": {
+      "testEventExtension1": {
+        "type": "text",
+        "configurability": "hidden",
+        "globalDefault": "defGlob",
+        "label": "Test event extensions",
+        "defaults": [
+          {
+            "clusterCode": "0x9999",
+            "eventCode": "0x0001",
+            "value": "defHello"
+          }
+        ]
+      }
+    }
+  },
+  "helpers": ["helper-chip.js", "external-addon-helper.js"],
+  "templates": [
+    {
+      "path": "simple-test.zapt",
+      "name": "Simple test template",
+      "output": "simple-test.h"
+    },
+    {
+      "path": "sdk-ext.zapt",
+      "name": "SDK extension test",
+      "output": "sdk-ext.txt"
+    },
+    {
+      "path": "feature-map.zapt",
+      "name": "Feature map test template",
+      "output": "feature-map.h"
+    },
+    {
+      "path": "device-types.zapt",
+      "name": "Device types",
+      "output": "device-types.txt"
+    },
+    {
+      "path": "endpoint-config.zapt",
+      "name": "Endpoint Configuration",
+      "output": "endpoint-config.c"
+    },
+    {
+      "path": "events.zapt",
+      "name": "Events",
+      "output": "events.out"
+    },
+    {
+      "path": "endpoints.zapt",
+      "name": "Endpoints",
+      "output": "endpoints.out"
+    },
+    {
+      "path": "chip-tool-helpers.zapt",
+      "name": "Helpers in chip-tool",
+      "output": "chip-tool-helpers.txt"
+    }
+  ]
+}
diff --git a/test/gen-template/zigbee/gen-templates-zigbee.json b/test/gen-template/zigbee/gen-templates-zigbee.json
@@ -0,0 +1,287 @@
+{
+  "name": "Test templates",
+  "version": "test-v1",
+  "category": "zigbee",
+  "requiredFeatureLevel": 2,
+  "options": {
+    "testOption": {
+      "code1": "label1",
+      "code2": "label2",
+      "code3": "label3",
+      "code4": "label4",
+      "code5": "label5"
+    },
+    "externalOption": "externalOptions.json",
+    "cli": "cli.json",
+    "types": {
+      "bacnet_oid": "bacnet_type_t"
+    },
+    "generator": {
+      "shareClusterStatesAcrossEndpoints": "true"
+    }
+  },
+  "zcl": {
+    "cluster": {
+      "testClusterExtension": {
+        "type": "text",
+        "configurability": "hidden",
+        "globalDefault": null,
+        "label": "Test cluster extension",
+        "defaults": [
+          {
+            "clusterCode": "0x0000",
+            "value": "Extension to basic cluster"
+          },
+          {
+            "clusterCode": "0x0001",
+            "role": "server",
+            "value": "Extension to power cluster"
+          },
+          {
+            "clusterCode": "0x0002",
+            "value": "Extension to temperature config cluster"
+          }
+        ]
+      },
+      "testClusterExtension1": {
+        "type": "text",
+        "configurability": "hidden",
+        "globalDefault": null,
+        "label": "Test cluster extension with external defaults values",
+        "defaults": "externalDefaults.json"
+      }
+    },
+    "command": {
+      "implementedCommands": {
+        "type": "boolean",
+        "configurability": "hidden",
+        "globalDefault": false,
+        "label": "List of commands that are implemented by the SDK",
+        "defaults": "implementedCommands.json"
+      },
+      "testCommandExtension": {
+        "type": "boolean",
+        "configurability": "hidden",
+        "globalDefault": false,
+        "label": "Test command extension",
+        "defaults": [
+          {
+            "clusterCode": "0x0000",
+            "commandCode": "0x00",
+            "value": true
+          }
+        ]
+      }
+    },
+    "attribute": {
+      "testAttributeExtension1": {
+        "type": "integer",
+        "configurability": "hidden",
+        "globalDefault": 0,
+        "label": "Test attribute extension 1",
+        "defaults": [
+          {
+            "clusterCode": "0x0000",
+            "attributeCode": "0x0000",
+            "value": 42
+          },
+          {
+            "clusterCode": "0x0000",
+            "attributeCode": "0x0001",
+            "value": 77
+          }
+        ]
+      },
+      "testAttributeExtension2": {
+        "type": "integer",
+        "configurability": "hidden",
+        "globalDefault": 1,
+        "label": "Test attribute extension 2",
+        "defaults": [
+          {
+            "clusterCode": "0x0000",
+            "attributeCode": "0x0000",
+            "value": 99
+          }
+        ]
+      }
+    },
+    "attributeType": {
+      "simpleTypeExtension": {
+        "type": "integer",
+        "configurability": "hidden",
+        "globalDefault": 22,
+        "label": "Extension for the attribute type",
+        "defaults": [
+          {
+            "type": "int8u",
+            "value": 666
+          }
+        ]
+      }
+    },
+    "deviceType": {
+      "testDeviceTypeExtension": {
+        "type": "path",
+        "configurability": "hidden",
+        "globalDefault": null,
+        "defaults": [
+          {
+            "device": "HA-remote",
+            "value": "path/to/remote.c"
+          }
+        ]
+      }
+    }
+  },
+  "override": "addon-override.js",
+  "helpers": ["addon-helper.js", "external-addon-helper.js"],
+  "templates": [
+    {
+      "path": "simple-test.zapt",
+      "name": "Test template",
+      "output": "simple-test.out"
+    },
+    {
+      "path": "zcl-test.zapt",
+      "name": "Test ZCL template",
+      "output": "zcl-test.out"
+    },
+    {
+      "path": "accumulator.zapt",
+      "name": "Test accumulator template",
+      "output": "accumulator.out"
+    },
+    {
+      "path": "zap-id.zapt",
+      "name": "Various ZCL ids",
+      "output": "zap-id.h"
+    },
+    {
+      "path": "zap-type.zapt",
+      "name": "ZCL types",
+      "output": "zap-type.h"
+    },
+    {
+      "path": "zap-cli.zapt",
+      "name": "ZCL command-line contribution",
+      "output": "zap-cli.c"
+    },
+    {
+      "path": "zap-command-parser.zapt",
+      "name": "ZCL command parsers",
+      "output": "zap-command-parser.c"
+    },
+    {
+      "ignore": true,
+      "path": "zap-command-parser-2.zapt",
+      "name": "ZCL command parsers, v2",
+      "output": "zap-command-parser-2.c"
+    },
+    {
+      "path": "zap-command-parser-ver-3.c.zapt",
+      "name": "Version 3 of zap command parser c file",
+      "output": "zap-command-parser-ver-3.c"
+    },
+    {
+      "path": "zap-command-parser-ver-4.c.zapt",
+      "name": "Version 4 of zap command parser c file",
+      "output": "zap-command-parser-ver-4.c"
+    },
+    {
+      "path": "zap-command-parser-ver-5.c.zapt",
+      "name": "Version 5 of zap command parser c file",
+      "output": "zap-command-parser-ver-5.c"
+    },
+    {
+      "path": "zap-command.zapt",
+      "name": "ZCL command APIs",
+      "output": "zap-command.h"
+    },
+    {
+      "path": "zap-command-ver-2.zapt",
+      "name": "ZCL command APIs version 2",
+      "output": "zap-command-ver-2.h"
+    },
+    {
+      "path": "zap-outgoing-command.zapt",
+      "name": "ZCL outgoing command",
+      "output": "zap-outgoing-command.out"
+    },
+    {
+      "path": "zap-config.zapt",
+      "name": "ZCL endpoint configuration",
+      "output": "zap-config.h"
+    },
+    {
+      "path": "zap-config-version-2.zapt",
+      "name": "ZCL endpoint configuration Version 2",
+      "output": "zap-config-version-2.h"
+    },
+    {
+      "path": "zap-config-version-3.zapt",
+      "name": "ZCL endpoint configuration Version 3",
+      "output": "zap-config-version-3.h"
+    },
+    {
+      "path": "zap-reporting.zapt",
+      "name": "ZCL reporting configuration",
+      "output": "zap-reporting.h"
+    },
+    {
+      "path": "zap-print.zapt",
+      "name": "ZCL human readable strings",
+      "output": "zap-print.h"
+    },
+    {
+      "path": "zap-event.h.zapt",
+      "name": "Generated events header",
+      "output": "zap-event.h"
+    },
+    {
+      "path": "zap-event.c.zapt",
+      "name": "Generated events",
+      "output": "zap-event.c"
+    },
+    {
+      "path": "zap-tokens.zapt",
+      "name": "ZCL tokens",
+      "output": "zap-tokens.h"
+    },
+    {
+      "path": "zap-tokens-version-2.zapt",
+      "name": "ZCL tokens version 2",
+      "output": "zap-tokens-version-2.h"
+    },
+    {
+      "path": "atomics.zapt",
+      "name": "ZCL Atomics",
+      "output": "atomics.out"
+    },
+    {
+      "path": "zap-command-structs.zapt",
+      "name": "Command structs",
+      "output": "zap-command-structs.h"
+    },
+    {
+      "path": "zap-cluster-command-parser.c.zapt",
+      "name": "Command struct parser functions",
+      "output": "zap-cluster-command-parser.c"
+    },
+    {
+      "path": "zap-cluster-command-parser-2.c.zapt",
+      "name": "Command struct parser functions, ver 2",
+      "output": "zap-cluster-command-parser-2.c"
+    },
+    {
+      "path": "zap-cluster-command-parser.h.zapt",
+      "name": "Command struct parser prototypes",
+      "output": "zap-cluster-command-parser.h"
+    },
+    {
+      "path": "sdk-extension.zapt",
+      "name": "SDK Extension",
+      "output": "sdk-extension.out"
+    }
+  ]
+}