Add integration test using TFL-Microspeech example. (#21)

This PR adds an integration test using example project from
https://github.com/ARM-software/AVH-TFLmicrospeech.
The example project is pulled in, patched to use the latest generated
pack, and built/executed on Arm Virtual Hardware.

Once this workflow is merged to main it will be triggered whenever the
build workflow completes. The pack generated during build workflow will
then be tested automatically. If the build workflow runs as part as a PR
check the result of this "integration test" is added to the results of
the PR. This can help to check that a PR doesn't break downstream
projects.

.github/workflows/microspeech.yaml

@@ -0,0 +1,217 @@
+# SPDX-FileCopyrightText: Copyright 2022 Arm Limited and/or its affiliates <open-source-office@arm.com>
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+# 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
+#
+# 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: TFL Microspeech Example on Arm Virtual Hardware
+on:
+  push:
+    branches:
+      - microspeech
+  workflow_run:
+    workflows: ["Build documentation and pack"]
+    types:
+      - completed
+  workflow_dispatch:
+
+env:
+  AWS_ASSUME_ROLE: ${{ secrets.AWS_ASSUME_ROLE }}
+  AWS_DEFAULT_REGION: ${{ secrets.AWS_DEFAULT_REGION }}
+  AWS_S3_BUCKET_NAME: ${{ secrets.AWS_S3_BUCKET_NAME }}
+  AWS_IAM_PROFILE: ${{ secrets.AWS_IAM_PROFILE }}
+  AWS_SECURITY_GROUP_ID: ${{ secrets.AWS_SECURITY_GROUP_ID }}
+  AWS_SUBNET_ID: ${{ secrets.AWS_SUBNET_ID }}
+
+jobs:
+  set_pending_status_to_pr:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set a pending status to the PR
+        if: github.event.workflow_run
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          curl --request POST \
+            --url https://api.github.com/repos/${{ github.repository }}/statuses/${{ github.event.workflow_run.head_commit.id }} \
+            --header "authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
+            --header 'content-type: application/json' \
+            --data '{
+              "state": "pending",
+              "context": "Microspeech",
+              "target_url": "https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id	}}"
+              }' \
+            --fail
+
+  build_and_run:
+    name: Build and run projects on AVH
+    runs-on: ubuntu-latest
+    needs: set_pending_status_to_pr
+    permissions:
+      id-token: write
+      contents: read
+      issues: read
+      checks: write
+      pull-requests: write
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          repository: ARM-software/AVH-TFLmicrospeech
+          ref: main
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Install AVH Client for Python
+        run: |
+          pip install arm-avhclient
+
+      - name: Download pack from upstream workflow
+        if: github.event.workflow_run
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+        run: |
+          mkdir -p artifacts && cd artifacts
+
+          artifacts_url=${{ github.event.workflow_run.artifacts_url }}
+
+          gh api "$artifacts_url" -q '.artifacts[] | select(.name=="artifact") | [.name, .archive_download_url] | @tsv' | \
+          while read artifact; do
+            IFS=$'\t' read name url <<< "$artifact"
+            gh api $url > "$name.zip"
+            unzip -d "$name" "$name.zip"
+          done
+
+          cp ARM.CMSIS-NN.*.pack ../Platform_FVP_Corstone_SSE-300_Ethos-U55/
+
+      - name: Download latest release pack
+        if: ${{ ! github.event.workflow_run }}
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+        run: |
+          gh -R ${{ github.repository }} release download -p "*.pack" -D Platform_FVP_Corstone_SSE-300_Ethos-U55
+
+      - name: Configure AWS Credentials
+        uses: aws-actions/configure-aws-credentials@v1-node16
+        with:
+          role-to-assume: ${{ env.AWS_ASSUME_ROLE }}
+          aws-region: ${{ env.AWS_DEFAULT_REGION }}
+
+      - name: Apply patch
+        run: |
+          VERSION=$(\
+            basename $(ls Platform_FVP_Corstone_SSE-300_Ethos-U55/ARM.CMSIS-NN.*.pack) | \
+            cut -d. -f 3-5 | cut -d+ -f 1 \
+          )
+          patch -p0 <<EOF
+          --- Platform_FVP_Corstone_SSE-300_Ethos-U55/microspeech.Example.Reference.cprj
+          +++ Platform_FVP_Corstone_SSE-300_Ethos-U55/microspeech.Example.Reference.cprj
+          @@ -11,2 +11,3 @@
+            <packages>
+          +    <package name="CMSIS-NN" vendor="ARM" version="${VERSION}:${VERSION}"/>
+               <package name="CMSIS" vendor="ARM" version="5.9.0:5.9.0"/>
+          @@ -130,3 +131,2 @@
+                 <file category="sourceCpp" name="../micro_speech/src/recognize_commands.cc"/>
+          -      <file category="sourceC" name="../micro_speech/src/arm_nn_softmax_common_s8.c"/>
+               </group>
+          --- Platform_FVP_Corstone_SSE-300_Ethos-U55/microspeech.Example.SIMD.cprj
+          +++ Platform_FVP_Corstone_SSE-300_Ethos-U55/microspeech.Example.SIMD.cprj
+          @@ -11,2 +11,3 @@
+            <packages>
+          +    <package name="CMSIS-NN" vendor="ARM" version="${VERSION}:${VERSION}"/>
+               <package name="CMSIS" vendor="ARM" version="5.9.0:5.9.0"/>
+          @@ -130,3 +131,2 @@
+                 <file category="sourceCpp" name="../micro_speech/src/recognize_commands.cc"/>
+          -      <file category="sourceC" name="../micro_speech/src/arm_nn_softmax_common_s8.c"/>
+               </group>
+          --- Platform_FVP_Corstone_SSE-300_Ethos-U55/microspeech.Example.Helium.cprj
+          +++ Platform_FVP_Corstone_SSE-300_Ethos-U55/microspeech.Example.Helium.cprj
+          @@ -11,2 +11,3 @@
+            <packages>
+          +    <package name="CMSIS-NN" vendor="ARM" version="${VERSION}:${VERSION}"/>
+               <package name="CMSIS" vendor="ARM" version="5.9.0:5.9.0"/>
+          @@ -130,3 +131,2 @@
+                 <file category="sourceCpp" name="../micro_speech/src/recognize_commands.cc"/>
+          -      <file category="sourceC" name="../micro_speech/src/arm_nn_softmax_common_s8.c"/>
+               </group>
+          --- avh.yml	Tue Nov 22 12:01:56 2022
+          +++ avh.yml	Tue Nov 22 12:02:08 2022
+          @@ -12,2 +12,5 @@
+           steps:
+          +  - run: |
+          +      cd Platform_FVP_Corstone_SSE-300_Ethos-U55
+          +      cpackget add ARM.CMSIS-NN.*.pack
+            - run: |
+          EOF
+
+      - name: Execute test suite on Arm Virtual Hardware at AWS
+        run: |
+          avhclient -b aws execute --specfile ./avh.yml
+
+      - name: Fetch results from Arm Virtual Hardware
+        run: |
+           cat ./Platform_FVP_Corstone_SSE-300_Ethos-U55/microspeech.Reference.log
+           cat ./Platform_FVP_Corstone_SSE-300_Ethos-U55/microspeech.SIMD.log
+           cat ./Platform_FVP_Corstone_SSE-300_Ethos-U55/microspeech.Helium.log
+
+      - name: Decode EventRecorder logs
+        run: |
+           wget https://github.com/ARM-software/CMSIS-View/releases/download/tools%2Feventlist%2F1.0.10/eventlist-linux64.tar.gz
+           tar -xvf eventlist-linux64.tar.gz
+           chmod +x eventlist-linux64/eventlist
+           eventlist-linux64/eventlist -s ./Platform_FVP_Corstone_SSE-300_Ethos-U55/microspeech.Reference.EventRecorder.log
+           eventlist-linux64/eventlist -s ./Platform_FVP_Corstone_SSE-300_Ethos-U55/microspeech.SIMD.EventRecorder.log
+           eventlist-linux64/eventlist -s ./Platform_FVP_Corstone_SSE-300_Ethos-U55/microspeech.Helium.EventRecorder.log
+
+  set_success_status_to_pr:
+    runs-on: ubuntu-latest
+    needs: build_and_run
+    if: github.event.workflow_run && success()
+    steps:
+      - name: Set success status to the PR
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+        run: |
+          curl --request POST \
+            --url https://api.github.com/repos/${{ github.repository }}/statuses/${{ github.event.workflow_run.head_commit.id }} \
+            --header "authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
+            --header 'content-type: application/json' \
+            --data '{
+              "state": "success",
+              "context": "Microspeech",
+              "target_url": "https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id	}}"
+              }' \
+            --fail
+
+  set_failure_status_to_pr:
+    runs-on: ubuntu-latest
+    needs: build_and_run
+    if: github.event.workflow_run && failure()
+    steps:
+      - name: Set failure status to the PR
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+        run: |
+          curl --request POST \
+            --url https://api.github.com/repos/${{ github.repository }}/statuses/${{ github.event.workflow_run.head_commit.id }} \
+            --header "authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
+            --header 'content-type: application/json' \
+            --data '{
+              "state": "failure",
+              "context": "Microspeech",
+              "target_url": "https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id	}}"
+              }' \
+            --fail