Skip to content

Commit 9c6dbea

Browse files
ArekBalysNordicArekBalysNordic
committed
[nrf noup][west zap] Add unit tests for west zap command
- Now the zcl.json contains the rules for zap-tool that are used with generating a zap file. The rules file is the JSON file that contains relative paths to .js files. To properly synchronize a custom zcl.json file, we must copy this rules file, update all paths to be relative to the custom zcl.json and finally run zap-gui or zap-sync with all proper paths. Apart from the synchronization updates several issues with zap generated and added helper functions for obtaining paths. Covered all major scenarios for all west zap commands in unit tests. Added a github workflow to run the tests if any west script is changed. Signed-off-by: Arkadiusz Balys <arkadiusz.balys@nordicsemi.no>
1 parent 9c4ab17 commit 9c6dbea

13 files changed

Lines changed: 8265 additions & 115 deletions

File tree

‎.github/workflows/west-zap.yaml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Copyright (c) 2025 Project CHIP Authors
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
name: West ZAP Tests
16+
17+
on:
18+
pull_request:
19+
paths:
20+
- 'scripts/west/**'
21+
22+
concurrency:
23+
group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }}
24+
cancel-in-progress: true
25+
26+
jobs:
27+
zap_tests:
28+
name: west zap tests
29+
runs-on: ubuntu-latest
30+
31+
container:
32+
image: ghcr.io/project-chip/chip-build-nrf-platform:174
33+
34+
steps:
35+
- name: Checkout
36+
uses: actions/checkout@v5
37+
- name: Checkout submodules & Bootstrap
38+
uses: ./.github/actions/checkout-submodules-and-bootstrap
39+
with:
40+
platform: nrfconnect
41+
- name: Prepare environment
42+
run: bash -c "source /opt/NordicSemiconductor/nrfconnect/zephyr/zephyr-env.sh && python3 -m pip install wget python-path"
43+
- name: Run ZAP tests
44+
run: bash -c "source /opt/NordicSemiconductor/nrfconnect/zephyr/zephyr-env.sh && python3 scripts/west/tests/zap_tests.py"

‎scripts/west/tests/Cluster1.xml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
2+
<configurator>
3+
<cluster>
4+
<domain>General</domain>
5+
<name>Cluster 1</name>
6+
<code>0xfff1fc01</code>
7+
<define>CLUSTER_1</define>
8+
<description>Cluster1</description>
9+
<command source="client" code="0xfff10000" name="Command1" optional="false">
10+
<description>Command desc</description>
11+
<arg name="Action" type="Enum1" optional="false"/>
12+
</command>
13+
<attribute side="server" code="0xfff10000" define="ATTR_1" type="Enum1" writable="true" optional="false" name="attr1"/>
14+
<attribute side="server" code="0xfff10001" define="ATTR_2" type="Struct1" writable="true" optional="false" name="attr2"/>
15+
<event side="server" code="0xfff10000" name="UserButtonChanged" priority="info" optional="false">
16+
<description>Event desc.</description>
17+
</event>
18+
</cluster>
19+
<enum name="Enum1" type="int8u">
20+
<cluster code="0xfff1fc01"/>
21+
<item name="Off" value="0"/>
22+
<item name="On" value="1"/>
23+
<item name="Toggle" value="2"/>
24+
</enum>
25+
<struct name="Struct1" isFabricScoped="true">
26+
<cluster code="0xfff1fc01"/>
27+
<item fieldId="1" name="Data" type="octet_string" length="128" isFabricSensitive="true"/>
28+
</struct>
29+
<deviceType>
30+
<name>new-device</name>
31+
<domain>CHIP</domain>
32+
<typeName>NewDevice</typeName>
33+
<profileId editable="false">0x10402</profileId>
34+
<deviceId editable="false">0xfff10001</deviceId>
35+
<class>Simple</class>
36+
<scope>Endpoint</scope>
37+
<clusters lockOthers="true">
38+
<include cluster="Cluster1" client="false" server="true" clientLocked="false" serverLocked="false"/>
39+
</clusters>
40+
</deviceType>
41+
</configurator>

‎scripts/west/tests/Cluster2.xml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
2+
<configurator>
3+
<cluster>
4+
<domain>General</domain>
5+
<name>Cluster 2</name>
6+
<code>0xfff1fc02</code>
7+
<define>CLUSTER_2</define>
8+
<description>Cluster1</description>
9+
<command source="client" code="0xfff10000" name="Command2" optional="false">
10+
<description>Command desc</description>
11+
<arg name="Action" type="Enum1" optional="false"/>
12+
</command>
13+
<attribute side="server" code="0xfff10000" define="ATTR_2" type="Enum2" writable="true" optional="false" name="attr2"/>
14+
</cluster>
15+
<enum name="Enum2" type="int8u">
16+
<cluster code="0xfff1fc02"/>
17+
<item name="Off" value="0"/>
18+
<item name="On" value="1"/>
19+
<item name="Toggle" value="2"/>
20+
</enum>
21+
<struct name="Struct2" isFabricScoped="true">
22+
<cluster code="0xfff1fc02"/>
23+
<item fieldId="1" name="Data" type="octet_string" length="128" isFabricSensitive="true"/>
24+
</struct>
25+
</configurator>

0 commit comments

Comments
 (0)