run-vlab.yaml

name: Run VLAB

on:
  workflow_call:
    inputs:
      skip:
        description: "Skip"
        type: boolean
        required: false
        default: false
      fabricatorref:
        description: "Fabricator reference to use"
        type: string
        required: true
      prebuild:
        description: "Pre-build script (e.g. 'just bump fabric v0.42.0')"
        type: string
        required: false
        default: "echo 'Noop pre-build'"
      fabricmode:
        description: "Fabric mode (e.g. spine-leaf, collapsed-core)"
        type: string
        required: false
        default: "spine-leaf"
      mesh:
        description: "Use spine-leaf with mesh-only connections"
        type: boolean
        required: false
        default: false
      gateway:
        description: "Enable gateway"
        type: boolean
        required: false
        default: false
      includeonie:
        description: "Include ONIE into installer"
        type: boolean
        required: false
        default: false
      buildmode:
        description: "Build mode (e.g. iso, usb, manual)"
        type: string
        required: false
        default: "iso"
      vpcmode:
        description: "VPC mode (e.g. l2vni, l3vni)"
        type: string
        required: false
        default: "l2vni"
      releasetest:
        description: "Run Release tests"
        type: boolean
        required: false
        default: false
      release_test_regex:
        description: "Regex pattern to filter release tests"
        type: string
        required: false
        default: ""
      release_test_invert_regex:
        description: "Invert regex selection"
        type: boolean
        required: false
        default: false
      hybrid:
        description: "Enable hybrid mode (use env with physical switches)"
        type: boolean
        required: false
        default: false
      debug:
        description: "Enable tmate debugging"
        type: boolean
        required: false
        default: false
      pause_on_fail:
        description: "Pause release tests on failure for debugging"
        type: boolean
        required: false
        default: false

permissions:
  contents: read

env:
  # global workflow configs
  slug: "${{ inputs.hybrid && 'hlab' || 'vlab' }}-${{ inputs.fabricmode == 'spine-leaf' && 'sl' || 'cc' }}-${{ inputs.mesh && 'mesh-' || '' }}${{ inputs.gateway && 'gw-' || '' }}${{ inputs.includeonie && 'onie-' || '' }}${{ inputs.buildmode }}-${{ inputs.vpcmode }}${{ inputs.releasetest && '-rt' || '' }}"
  # env vars to configure hhfab
  HHFAB_REG_REPO: 127.0.0.1:30000
  HHFAB_VLAB_COLLECT: true

jobs:
  run:
    if: ${{ !inputs.skip }}
    runs-on: ${{ inputs.hybrid && 'hlab' || 'vlab' }}
    timeout-minutes: "${{ inputs.releasetest && (inputs.hybrid && 250 || 150) || 60 }}"

    steps:
      - name: Runner host
        run: |
          echo "$KUBE_NODE"

      - name: Inputs summary
        run: |
          echo "Inputs:"
          echo "  Fabricator reference: ${{ inputs.fabricatorref }}"
          echo "  Pre-build script: ${{ inputs.prebuild }}"
          echo "  Fabric mode: ${{ inputs.fabricmode }}"
          echo "  Mesh: ${{ inputs.mesh }}"
          echo "  Gateway: ${{ inputs.gateway }}"
          echo "  Include ONIE: ${{ inputs.includeonie }}"
          echo "  Build mode: ${{ inputs.buildmode }}"
          echo "  VPC mode: ${{ inputs.vpcmode }}"
          echo "  Release test: ${{ inputs.releasetest }}"
          echo "  Hybrid: ${{ inputs.hybrid }}"
          echo "  Debug: ${{ inputs.debug }}"
          echo "Calculated:"
          echo "  Slug: ${{ env.slug }}"

      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          repository: githedgehog/fabricator
          ref: ${{ inputs.fabricatorref }}
          fetch-depth: 0

      - name: Checkout lab-ci repository
        uses: actions/checkout@v4
        if: ${{ inputs.hybrid }}
        with:
          repository: githedgehog/lab-ci
          path: "./lab-ci"

      - name: Pre-populate hhfab-cache
        run: |
          if [ -d "/hostcache/.hhfab-cache" ]; then
            cp -r /hostcache/.hhfab-cache ~/
          else
            echo "Host cache not available"
          fi

      - name: Setup Go
        uses: actions/setup-go@v5
        with:
          go-version: stable
          cache: false

      - name: Setup local registry
        run: |
          just --timestamp _localreg &

      - name: Pre-build script
        run: |
          echo "Running pre-build script"
          ${{ inputs.prebuild }}

      - name: Build hhfab
        run: |
          just --timestamp oci_repo=127.0.0.1:30000 oci=http push

      - name: Init hhfab for virtual mode
        if: ${{ !inputs.hybrid }}
        run: |
          bin/hhfab init -v --dev \
            --fabric-mode=${{ inputs.fabricmode }} \
            --include-onie=${{ inputs.includeonie }} \
            --gateway=${{ inputs.gateway }}

      - name: Generate VLAB wiring
        if: ${{ !inputs.hybrid }}
        run: |
          bin/hhfab vlab gen -v ${{ inputs.mesh && '--mesh-links-count=3' || '' }}

      - name: Init hhfab for hybrid mode
        if: ${{ inputs.hybrid }}
        run: |
          source "./lab-ci/envs/$KUBE_NODE/source.sh"
          bin/hhfab init -v --dev \
            --fabric-mode=${{ inputs.fabricmode }} \
            --include-onie=${{ inputs.includeonie }} \
            --gateway=${{ inputs.gateway }} \
            -w "./lab-ci/envs/$KUBE_NODE/wiring.yaml"

      - name: Print hhfab versions
        run: |
          bin/hhfab versions | tee versions.txt

      - name: Generate VLAB diagrams
        run: |
          bin/hhfab diagram --format=drawio
          bin/hhfab diagram --format=dot
          bin/hhfab diagram --format=mermaid

      # TODO: make controls restricted again when we figure out how to get NTP upstream working for isolated VMs
      - name: Run and test ${{ inputs.hybrid && 'hybrid ' || '' }}VLAB
        run: |
          export HHFAB_JOIN_TOKEN=$(openssl rand -base64 24)
          bin/hhfab vlab up -v \
            --build-mode="${{ inputs.buildmode }}" \
            --vpc-mode="${{ inputs.vpcmode }}" \
            ${{ inputs.hybrid && '--controls-restricted=false' || '' }} \
            ${{ inputs.hybrid && '--ready switch-reinstall' || '' }} \
            --ready=inspect \
            --ready=setup-vpcs \
            ${{ !inputs.gateway && '--ready=setup-peerings' || '' }} \
            --ready=test-connectivity \
            ${{ inputs.releasetest && '--ready=release-test' || '' }} \
            ${{ inputs.release_test_regex && format('--release-test-regex="{0}"', inputs.release_test_regex) || '' }} \
            ${{ inputs.release_test_invert_regex && '--release-test-invert-regex' || '' }} \
            ${{ inputs.pause_on_fail && '--pause-on-fail' || '' }} \
            --ready=exit

      - name: Upload Release Test Results
        uses: actions/upload-artifact@v4
        if: ${{ inputs.releasetest && !cancelled()}}
        with:
          name: ${{ env.slug }}--test-results
          path: release-test.xml

      - name: Prepare debug artifacts
        if: ${{ always() }}
        run: |
          mkdir -p _debug/serial
          cp versions.txt _debug/ || true
          cp result/diagram.* _debug/ || true
          cp vlab.hhs _debug/ || true
          cp -r show-tech-output _debug/ || true
          cp .zot/log _debug/zot.log || true
          find ./vlab/vms -type f -name serial.log -exec bash -c 'cp $0 _debug/serial/$(basename $(dirname $0)).log' {} \; || true
          mv _debug fab-${{ github.run_id }}-${{ env.slug }}

      - name: Upload debug artifacts
        uses: actions/upload-artifact@v4
        if: ${{ always() }}
        with:
          name: fab-${{ github.run_id }}-${{ env.slug }}
          path: fab-${{ github.run_id }}-${{ env.slug }}

      - name: Setup tmate session for debug
        if: ${{ failure() && github.event_name == 'workflow_dispatch' && inputs.debug }}
        uses: mxschmitt/action-tmate@v3
        timeout-minutes: 30
        with:
          limit-access-to-actor: true