Merge pull request #1556 from annietllnd/pr-test-framework

Test framework update

.github/workflows/stats-pr.yml

@@ -0,0 +1,44 @@
+name: Open Pull Request with updated stats report
+on:
+    workflow_run:
+      workflows: ["Test Learning Path"]
+      types: [completed]
+permissions:
+  actions: read
+  contents: write
+  pull-requests: write
+jobs:
+  stats-pr:
+    runs-on: ubuntu-24.04-arm
+    steps:
+        - name: Checkout main branch
+          uses: actions/checkout@v2
+          with:
+            ref: main
+        - name: Download stats report as artifact
+          uses: actions/download-artifact@v4
+          with:
+            # Run ID of the workflow that uploaded the artifact
+            run-id: ${{ github.event.workflow_run.id }}
+            github-token: ${{ github.token }}
+        - name: Move stats file
+          # Unpack the artifact and move the stats file to the correct location
+          run: |
+              mv stats_current_test_info/stats_current_test_info.yml data/stats_current_test_info.yml
+              rm -rf stats_current_test_info
+        - name: Set workflow link as environment variable
+          run: echo "WORKFLOW_URL=${{ github.event.workflow_run.workflow_url }}" >> $GITHUB_ENV
+        - name: Echo Workflow URL
+          run: echo $WORKFLOW_URL
+        - name: Create Pull Request
+          uses: peter-evans/create-pull-request@v6
+          if: success()
+          with:
+            commit-message: Update stats_current_test_info.yml
+            title: Update stats_current_test_info.yml
+            body: |
+              Update test result file with recent run
+              Triggered by workflow run ${ WORKFLOW_URL }
+              Auto-generated by create-pull-request: https://github.com/peter-evans/create-pull-request
+            branch: update-stats-current-test-info
+            base: main

.github/workflows/test-lp.yml

@@ -0,0 +1,54 @@
+name: Test Learning Path
+on: pull_request
+jobs:
+  Test-Pull-Request:
+    runs-on: ubuntu-24.04-arm
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ steps.vars.outputs.branch-name }}
+      - name: Get all changed markdown files
+        id: changed-markdown-files
+        uses: tj-actions/changed-files@v44
+        with:
+          files: |
+             **.md
+      - name: Install dependencies
+        if: steps.changed-markdown-files.outputs.any_changed == 'true'
+        run: pip install -r tools/requirements.txt
+      - name: Run test suite for all changed .md files
+        id: run-suite
+        if: steps.changed-markdown-files.outputs.any_changed == 'true'
+        # Run the test suite
+        run: |
+            set -o pipefail; ./tools/test_lp.sh ${{ steps.changed-markdown-files.outputs.all_changed_files }} 2>&1 | tee test-lp-output.txt
+      - name: Parse test suite errors
+        id: test-suite-state
+        if: success()
+        # Catch any missed errors if running multiple tests
+        run: |
+            cat test-lp-output.txt | grep -q 'Tests failed in test suite' && echo "TEST_SUITE_ERRORS=true" >> "$GITHUB_ENV" \
+            || echo "TEST_SUITE_ERRORS=false" >> "$GITHUB_ENV"
+      - name: Check for errors in test suite
+        if: env.TEST_SUITE_ERRORS == 'true' && success()
+        run: |
+          echo "Test failures detected in test suite, check the output in earlier steps"
+          exit 1
+      - name: Parse test maintenance off
+        id: maintenance-state
+        if: success()
+        # Check if maintenance is turned off
+        run: |
+            cat test-lp-output.txt | grep -q 'maintenance is turned off' && echo "MAINTENANCE=off" >> "$GITHUB_ENV" \
+            || echo "MAINTENANCE=on" >> "$GITHUB_ENV"
+      - name: Check if maintenance is turned off
+        if: env.MAINTENANCE == 'off' && success()
+        run: echo "Maintenance is turned off for one or more files"
+      # Only upload artifact if maintenance is on
+      - name: Upload stats artifact
+        uses: actions/upload-artifact@v4
+        if: success() && env.MAINTENANCE == 'on'
+        with:
+          name: stats_current_test_info
+          path: data/stats_current_test_info.yml

.gitignore

@@ -5,6 +5,7 @@ resources/
 node_modules/
 package-lock.json
 .hugo_build.lock
+.vscode
 
 # macOS files
 *.DS_Store

content/install-guides/ambaviz.md

@@ -27,6 +27,10 @@ tool_install: true              # Set to true to be listed in main selection pag
 multi_install: false            # Set to true if first page of multi-page article, else false
 multitool_install_part: false   # Set to true if a sub-page of a multi-page article, else false
 layout: installtoolsall         # DO NOT MODIFY. Always true for tool install articles
+test_maintenance: true
+test_images:
+- ubuntu:latest
+
 ---
 
 [Arm AMBA Viz](https://www.arm.com/products/development-tools/embedded-and-software/amba-viz) is a tool to visualize AMBA events to accelerate SoC verification. This guide is for SoC verification and validation engineers to efficiently analyze hardware signals in their designs.
@@ -49,23 +53,23 @@ AMBA Viz requires a Linux host machine with Java 11 or JavaFX.
 
 Extract the software from the bundle to the desired install location. For example:
 
-```command
+```console
 tar -xf ambaviz.tar.gz
 ```
 
 Navigate to the newly-created `ambaviz-<version>` folder, and run the following script to set up environment variables:
 
 #### sh/bash
-```command
+```console
 source sourceMe.sh
 ```
 #### csh
-```command
+```console
 sourceMe.csh
 ```
 
 The AMBA Viz Release Notes provide full installation instructions, located in the extracted directory at:
-```command
+```console
 docs/public/assets/pdfs/ambaviz-release-note.pdf
 ```
 
@@ -78,17 +82,17 @@ License set up instructions are available in the [Arm License install guide](/in
 ## Get started
 
 Typically, AMBA Viz is launched with a waveform file:
-```command
+```console
 ambaviz -f <waveform_file>
 ```
 
 A proprietary `AVDB` waveform format is recommended to improve the performance of AMBA Viz.
 
 To convert `VCD` or `FSDB` files to this format, use the `wave2avdb` script, for example:
-```command
+```console
 wave2avdb -d cmn600 -f waves.vcd -o waves.avdb
 ```
 The User Guide provides full usage instructions, located in the extracted directory at:
-```command
+```console
 docs/public/assets/pdfs/ambaviz-user-guide.pdf
 ```

content/install-guides/ams.md

@@ -28,6 +28,9 @@ tool_install: true              # Set to true to be listed in main selection pag
 multi_install: false            # Set to true if first page of multi-page article, else false
 multitool_install_part: false   # Set to true if a sub-page of a multi-page article, else false
 layout: installtoolsall         # DO NOT MODIFY. Always true for tool install articles
+test_maintenance: true
+test_images:
+  - ubuntu:latest
 ---
 [Arm Performance Studio](https://developer.arm.com/Tools%20and%20Software/Arm%20Performance%20Studio%20for%20Mobile) (formally known as `Arm Mobile Studio`) is a performance analysis tool suite for various application developers:
 
@@ -57,7 +60,7 @@ Run the supplied `Arm_Performance_Studio_<version>_windows_x86-64.exe` installer
 ### Linux
 
 Unpack the supplied `Arm Performance Studio` bundle to the desired location. For example:
-```command
+```console
 tar -xf Arm_Performance_Studio_2024.3_linux_x86-64.tgz
 ```
 ### macOS

content/install-guides/anaconda.md

@@ -22,11 +22,11 @@ tool_install: true
 weight: 1
 ---
 
-[Anaconda Distribution](https://www.anaconda.com/products/distribution) is a popular open-source Python distribution. 
+[Anaconda Distribution](https://www.anaconda.com/products/distribution) is a popular open-source Python distribution.
 
 It includes access to a repository with over 8,000 open-source data science and machine learning packages.
 
-The `conda` command can be used to quickly install and use Python packages. 
+The `conda` command can be used to quickly install and use Python packages.
 
 Follow the instructions below to install and use Anaconda Distribution on an Arm server.
 
@@ -46,11 +46,12 @@ aarch64
 
 If you see a different result, you are not using an Arm computer running 64-bit Linux.
 
-The installer requires some desktop related libraries. The dependencies can be met by installing a desktop environment. 
+The installer requires some desktop related libraries. The dependencies can be met by installing a desktop environment.
 
 For Ubuntu/Debian, run the command:
 
 ```console
+sudo apt update
 sudo apt install xfce4 -y
 ```
 
@@ -60,7 +61,7 @@ For Amazon Linux, run the command:
 sudo amazon-linux-extras install mate-desktop1.x
 ```
 
-## How do I download the latest Anaconda distribution? 
+## How do I download the latest Anaconda distribution?
 
 To download the latest Anaconda distribution, run:
 
@@ -84,7 +85,7 @@ sh ./Anaconda3-2024.10-1-Linux-aarch64.sh -b
 
 The install takes a couple of minutes to complete.
 
-The batch installation will not set up the shell. 
+The batch installation will not set up the shell.
 
 To set up the shell, run:
 
@@ -133,7 +134,7 @@ Run the example code:
 python ./tf.py
 ```
 
-The expected output format is below. Your version may be slightly different. 
+The expected output format is below. Your version may be slightly different.
 
 ```output
 2.12.0
@@ -180,6 +181,6 @@ tensor([[0.9287, 0.5931, 0.0239],
 ```
 
 
-You are ready to use Anaconda Distribution. 
+You are ready to use Anaconda Distribution.
 
 Explore the many machine learning articles and examples using TensorFlow and PyTorch.

content/install-guides/ansible.md

@@ -8,18 +8,18 @@ minutes_to_complete: 10
 multi_install: false
 multitool_install_part: false
 official_docs: https://docs.ansible.com/ansible/latest/index.html
+test_maintenance: true
 test_images:
 - ubuntu:latest
 test_link: null
-test_maintenance: false
 title: Ansible
 tool_install: true
 weight: 1
 ---
 
 Ansible is an open source, command-line automation used to configure systems and deploy software.
 
-Ansible command-line tools can be installed on a variety of Linux distributions. 
+Ansible command-line tools can be installed on a variety of Linux distributions.
 
 [General installation information](https://docs.ansible.com/ansible/latest/installation_guide/installation_distros.html) is available which covers all supported operating systems, but it doesn't talk about Arm-based hosts.
 
@@ -41,7 +41,7 @@ aarch64
 
 If you see a different result, you are not using an Arm-based machine running 64-bit Linux.
 
-## How do I download and install Ansible for Ubuntu on Arm? 
+## How do I download and install Ansible for Ubuntu on Arm?
 
 The easiest way to install the latest version of Ansible for Ubuntu on Arm is to use the PPA (Personal Package Archive).
 
@@ -54,7 +54,7 @@ sudo add-apt-repository --yes --update ppa:ansible/ansible
 sudo apt install ansible -y
 ```
 
-Confirm the Ansible command line tools are installed by running: 
+Confirm the Ansible command line tools are installed by running:
 
 ```bash
 ansible-playbook --version