openthread/.github/workflows/otns.yml

#
#  Copyright (c) 2020, The OpenThread Authors.
#  All rights reserved.
#
#  Redistribution and use in source and binary forms, with or without
#  modification, are permitted provided that the following conditions are met:
#  1. Redistributions of source code must retain the above copyright
#     notice, this list of conditions and the following disclaimer.
#  2. Redistributions in binary form must reproduce the above copyright
#     notice, this list of conditions and the following disclaimer in the
#     documentation and/or other materials provided with the distribution.
#  3. Neither the name of the copyright holder nor the
#     names of its contributors may be used to endorse or promote products
#     derived from this software without specific prior written permission.
#
#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
#  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
#  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
#  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
#  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
#  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
#  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
#  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
#  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
#  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
#  POSSIBILITY OF SUCH DAMAGE.
#

name: OTNS

on:
  push:
    branches-ignore:
      - 'dependabot/**'
  pull_request:
    branches:
      - 'main'

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || (github.repository == 'openthread/openthread' && github.run_id) || github.ref }}
  cancel-in-progress: true

env:
  COVERAGE: 1
  REFERENCE_DEVICE: 1
  VIRTUAL_TIME: 1
  VIRTUAL_TIME_UART: 1
  MAX_NETWORK_SIZE: 999
  PR_BODY: "${{ github.event.pull_request.body }}"

permissions:  # added using https://github.com/step-security/secure-workflows
  contents: read

jobs:

  unittests:
    name: Unittests
    runs-on: ubuntu-24.04
    steps:
    - name: Harden Runner
      uses: step-security/harden-runner@0634a2670c59f64b4a01f0f96f84700a4088b9f0 # v2.12.0
      with:
        egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs

    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
    - uses: actions/setup-go@d35c59abb061a4a6fb18e82ac0862c26744d6ab5 # v5.5.0
      with:
        go-version: "1.23"
    - name: Set up Python
      uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
      with:
        python-version: "3.9"
    - name: Bootstrap
      run: |
        sudo apt-get update
        sudo apt-get --no-install-recommends install -y lcov ninja-build
    - name: Run
      run: |
        export OT_DIR=$PWD
        ./script/git-tool clone --depth 1 https://github.com/openthread/ot-ns.git /tmp/otns
        (
          cd /tmp/otns
          ./script/test py-unittests
        )
    - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
      if: ${{ failure() }}
      with:
        name: unittests-pcaps
        path: |
          ./output/*/bin/*.pcap
          ./output/*/bin/*.replay
    - name: Generate Coverage
      run: |
        ./script/test generate_coverage gcc
    - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
      with:
        name: cov-otns-unittests
        path: tmp/coverage.info
        retention-days: 1

  examples:
    name: Examples
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
      - uses: actions/setup-go@d35c59abb061a4a6fb18e82ac0862c26744d6ab5 # v5.5.0
        with:
          go-version: "1.23"
      - name: Set up Python
        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
        with:
          python-version: "3.9"
      - name: Bootstrap
        run: |
          sudo apt-get update
          sudo apt-get --no-install-recommends install -y lcov ninja-build
      - name: Run
        run: |
          export OT_DIR=$PWD
          ./script/git-tool clone --depth 1 https://github.com/openthread/ot-ns.git /tmp/otns
          (
            cd /tmp/otns
            ./script/test py-examples
          )
      - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
        if: ${{ failure() }}
        with:
          name: examples-pcaps
          path: |
            ./output/*/bin/*.pcap
            ./output/*/bin/*.replay
      - name: Generate Coverage
        run: |
          ./script/test generate_coverage gcc
      - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
        with:
          name: cov-otns-examples
          path: tmp/coverage.info

  stress-tests:
    name: Stress ${{ matrix.suite }}
    runs-on: ubuntu-24.04
    strategy:
      fail-fast: false
      matrix:
        include:
          - suite: "network-forming"
            stress_level: 8
          - suite: "commissioning"
            stress_level: 14
          - suite: "connectivity"
            stress_level: 6
          - suite: "network-latency"
            stress_level: 10
          - suite: "multicast-performance"
            stress_level: 10
          - suite: "otns-performance"
            stress_level: 10
    env:
      STRESS_LEVEL: ${{ matrix.stress_level }}
    steps:
      - name: Harden Runner
        uses: step-security/harden-runner@0634a2670c59f64b4a01f0f96f84700a4088b9f0 # v2.12.0
        with:
          egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs

      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
      - uses: actions/setup-go@d35c59abb061a4a6fb18e82ac0862c26744d6ab5 # v5.5.0
        with:
          go-version: "1.23"
      - name: Set up Python
        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
        with:
          python-version: "3.9"
      - name: Bootstrap
        run: |
          sudo apt-get update
          sudo apt-get --no-install-recommends install -y lcov ninja-build
      - name: Run
        run: |
          export OT_DIR=$PWD
          ./script/git-tool clone --depth 1 https://github.com/openthread/ot-ns.git /tmp/otns
          (
            cd /tmp/otns
            ./script/test stress-tests ${{ matrix.suite }}
          )
      - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
        if: ${{ failure() }}
        with:
          name: stress-tests-${{ matrix.suite }}-pcaps
          path: |
            ./output/*/bin/*.pcap
            ./output/*/bin/*.replay
      - name: Generate Coverage
        run: |
          ./script/test generate_coverage gcc
      - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
        with:
          name: cov-otns-stress-tests-${{ matrix.suite }}
          path: tmp/coverage.info
          retention-days: 1

  upload-coverage:
    needs:
      - unittests
      - examples
      - stress-tests
    runs-on: ubuntu-24.04
    steps:
      - name: Harden Runner
        uses: step-security/harden-runner@0634a2670c59f64b4a01f0f96f84700a4088b9f0 # v2.12.0
        with:
          egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs

      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
      - name: Bootstrap
        run: |
          sudo apt-get --no-install-recommends install -y lcov
      - uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
        with:
          path: coverage/
          pattern: cov-*
          merge-multiple: true
      - name: Upload Coverage
        run: |
          script/test upload_codecov