Chef CI

.github/workflows/chef.yaml

@@ -0,0 +1,119 @@
+# Copyright (c) 2021 Project CHIP Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: Build Chef CI examples on all platforms
+
+on:
+    push:
+    pull_request:
+
+concurrency:
+    group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }}
+    cancel-in-progress: true
+
+jobs:
+
+    validate_zzz:
+        name: Chef - Validate cached ZAP output
+        runs-on: ubuntu-latest
+        if: github.actor != 'restyled-io[bot]'
+        container:
+            image: connectedhomeip/chip-build:0.5.77
+            options: --user root
+        steps:
+            - uses: Wandalen/[email protected]
+              name: Checkout
+              with:
+                  action: actions/checkout@v3
+                  with: |
+                      token: ${{ github.token }}
+                  attempt_limit: 3
+                  attempt_delay: 2000
+            - name: Chef validate zzz
+              shell: bash
+              run: |
+                cd examples/chef
+                python3 chef.py --validate_zzz
+
+    chef_linux:
+        name: Chef - Linux CI Examples
+        needs: validate_zzz
+        runs-on: ubuntu-latest
+        if: github.actor != 'restyled-io[bot]'
+
+        container:
+            image: connectedhomeip/chip-build:0.5.77
+            options: --user root
+
+        steps:
+            - uses: Wandalen/[email protected]
+              name: Checkout
+              with:
+                  action: actions/checkout@v3
+                  with: |
+                      token: ${{ github.token }}
+                  attempt_limit: 3
+                  attempt_delay: 2000
+            - name: CI Examples Linux
+              shell: bash
+              run: |
+                ./scripts/run_in_build_env.sh "./examples/chef/chef.py --ci -t linux"
+
+    chef_esp32:
+        name: Chef - ESP32 CI Examples
+        needs: validate_zzz
+        runs-on: ubuntu-latest
+        if: github.actor != 'restyled-io[bot]'
+
+        container:
+            image: connectedhomeip/chip-build-esp32:0.5.77
+            options: --user root
+
+        steps:
+            - uses: Wandalen/[email protected]
+              name: Checkout
+              with:
+                  action: actions/checkout@v3
+                  with: |
+                      token: ${{ github.token }}
+                  attempt_limit: 3
+                  attempt_delay: 2000
+            - name: CI Examples ESP32
+              shell: bash
+              run: |
+                ./scripts/run_in_build_env.sh "./examples/chef/chef.py --ci -t esp32"
+
+    chef_nrfconnect:
+        name: Chef - NRFConnect CI Examples
+        needs: validate_zzz
+        runs-on: ubuntu-latest
+        if: github.actor != 'restyled-io[bot]'
+
+        container:
+            image: connectedhomeip/chip-build-nrf-platform:0.5.77
+            options: --user root
+
+        steps:
+            - uses: Wandalen/[email protected]
+              name: Checkout
+              with:
+                  action: actions/checkout@v3
+                  with: |
+                      token: ${{ github.token }}
+                  attempt_limit: 3
+                  attempt_delay: 2000
+            - name: CI Examples NRFConnect
+              shell: bash
+              run: |
+                ./scripts/run_in_build_env.sh "./examples/chef/chef.py --ci -t nrfconnect"

.restyled.yaml

@@ -70,6 +70,7 @@ exclude:
     - "src/controller/python/chip/clusters/Objects.py" # generated file, no point to restyle
     - "src/controller/python/chip/clusters/CHIPClusters.py" # generated file, no point to restyle
     - "scripts/idl/tests/outputs/**/*" # Matches generated output 1:1
+    - "examples/chef/zzz_generated/**/*"
 
 
 changed_paths:

examples/chef/README.md

@@ -58,3 +58,64 @@ Run `chef.py -h` to see the available commands
 3. Click on `Save As` and save the file with the name of your new device type
    into the `devices` folder. This device is now available for the script. See
    `chef.py -h` for a list of devices available.
+
+## CI
+
+### zzz_generated
+
+To eliminate a dependency on ZAP in CI jobs, all chef examples found in
+`examples/chef/devices` must have their output from the ZAP tool cached in
+`examples/chef/zzz_generated`.
+
+To generate the cache, one may execute chef with the option `--generate_zzz`.
+This will run ZAP for all devices in `examples/chef/devices` and place the
+output into the appropriate directory structure.
+
+Other than the output from the ZAP tool, the cache directory contains two
+additional files for each device:
+
+-   `INPUTMD5.txt` contains the md5 hex digest of the ZAP file used to generate
+    the directory.
+-   `ZAPSHA.txt` contains the commit of ZAP in the user's tree when the
+    directory was generated.
+
+```
+zzz_generated/
+└── lighting-app
+    ├── INPUTMD5.txt
+    ├── zap-generated
+    │   ├── access.h
+    │   ├── af-gen-event.h
+    │   └── ...
+    └── ZAPSHA.txt
+```
+
+These additional files will be used by the CI jobs to validate whether the cache
+must be regenerated i.e. regeneration is needed when ZAP or the input ZAP files
+change.
+
+### Workflow
+
+All CI jobs for chef can be found in `.github/workflows/chef.yaml`.
+
+#### Validate
+
+The workflow begins by calling chef with `--validate_zzz`.
+
+`--validate_zzz` will recalculate the current ZAP commit and the md5 of all
+example ZAP files and compare with what is committed to `zzz_generated`.
+
+If the validation job fails, it will provide instructions to repair
+`zzz_generated` and no builds will run.
+
+#### Build
+
+Once the validation job is complete, there is a separate job for each platform,
+which run in parallel.
+
+These jobs use a platform-specific image with base `chip-build`.
+
+The build jobs call chef with the options `--ci -t <PLATFORM>`. The `--ci`
+option will execute builds for all devices specified in `_CI_ALLOW_LIST` defined
+in `chef.py` (so long as these devices are also in `/devices`) on the specified
+platform.