Merge pull request signalwire#2657 from signalwire/workflow

[GHA] Refactor workflows

.github/docker/debian/bookworm/amd64/CI/Dockerfile

@@ -0,0 +1,24 @@
+ARG BUILDER_IMAGE=signalwire/freeswitch-public-ci-base:bookworm-amd64
+
+FROM ${BUILDER_IMAGE}
+
+ARG MAINTAINER_EMAIL="andrey@signalwire.com"
+
+LABEL org.opencontainers.image.authors="${MAINTAINER_EMAIL}"
+
+SHELL ["/bin/bash", "-c"]
+
+COPY --from=sofia-sip / /usr/src/sofia-sip
+COPY --from=freeswitch / /usr/src/freeswitch
+
+RUN cd /usr/src/freeswitch && \
+    ./ci.sh -t unit-test -a configure -c sofia-sip -p "/usr/src/sofia-sip" && \
+    ./ci.sh -t unit-test -a build -c sofia-sip -p "/usr/src/sofia-sip" && \
+    ./ci.sh -t unit-test -a install -c sofia-sip -p "/usr/src/sofia-sip" && \
+    ./ci.sh -t unit-test -a configure -c freeswitch -p "/usr/src/freeswitch" && \
+    ./ci.sh -t unit-test -a build -c freeswitch -p "/usr/src/freeswitch" && \
+    ./ci.sh -t unit-test -a install -c freeswitch -p "/usr/src/freeswitch"
+
+WORKDIR /usr/src/freeswitch/tests/unit
+
+ENTRYPOINT ["/usr/src/freeswitch/tests/unit/run-tests.sh"]

.github/workflows/ci.yml

@@ -4,18 +4,45 @@ on:
   push:
     branches:
       - master
+      - v1.10
   pull_request:
     types:
       - opened
       - synchronize
+  workflow_dispatch:
+    inputs:
+      freeswitch_ref:
+        description: 'FreeSWITCH repository ref'
+        required: false
+        type: string
+      sofia-sip_ref:
+        description: 'Sofia-Sip repository ref'
+        required: false
+        type: string
+      dind:
+        description: 'Run tests using Docker-in-Docker'
+        required: false
+        type: boolean
+        default: false
+
+env:
+  CI_BASE_STATIC_IMAGE: signalwire/freeswitch-public-ci-base:bookworm-amd64
+  DOCKER_BUILD_SUMMARY: false
+  DOCKER_BUILD_CHECKS_ANNOTATIONS: false
+  DOCKER_BUILD_RECORD_UPLOAD: false
 
 jobs:
   unit-tests-pre-config:
+    if: ${{ !inputs.dind }}
+    name: "Unit-tests pre-config"
     runs-on: ubuntu-latest
     env:
       TOTAL_GROUPS: 2
     outputs:
       matrix: ${{ steps.set-matrix.outputs.matrix }}
+      container-image: ${{ steps.set-vars.outputs.container-image }}
+      working-directory: ${{ steps.set-vars.outputs.working-directory }}
+      tests-only: ${{ steps.set-vars.outputs.tests-only }}
     steps:
       - id: set-matrix
         shell: bash
@@ -25,81 +52,52 @@ jobs:
               include: [range(1; $groups + 1) | {group: ., total: $groups}]
             }')
           echo "matrix=$MATRIX" | tee -a $GITHUB_OUTPUT
+      - id: set-vars
+        shell: bash
+        run: |
+          echo "tests-only=false" >> $GITHUB_OUTPUT
+          echo "working-directory=freeswitch/tests/unit" >> $GITHUB_OUTPUT
+          echo "container-image=$CI_BASE_STATIC_IMAGE" >> $GITHUB_OUTPUT
 
   unit-tests:
-    needs: unit-tests-pre-config
+    if: ${{ !inputs.dind }}
+    name: "Unit-tests (group ${{ matrix.group }})"
+    needs:
+      - unit-tests-pre-config
     strategy:
+      fail-fast: false
       matrix: ${{ fromJson(needs.unit-tests-pre-config.outputs.matrix) }}
-    name: "unit-tests (group ${{ matrix.group }})"
     uses: ./.github/workflows/unit-test.yml
     with:
       total-groups: ${{ matrix.total }}
       current-group: ${{ matrix.group }}
+      container-image: ${{ needs.unit-tests-pre-config.outputs.container-image }}
+      working-directory: ${{ needs.unit-tests-pre-config.outputs.working-directory }}
+      tests-only: ${{ fromJson(needs.unit-tests-pre-config.outputs.tests-only) }}
     secrets: inherit
 
-  scan-build:
+  validate-unit-tests:
+    if: ${{ always() && !inputs.dind }}
+    name: "Validate Unit-tests"
+    needs: unit-tests
     runs-on: ubuntu-latest
-    container:
-      image: signalwire/freeswitch-public-base:bookworm
-      credentials:
-        username: ${{ secrets.DOCKERHUB_USERNAME }}
-        password: ${{ secrets.DOCKERHUB_TOKEN }}
-      options: --privileged
-    env:
-      REPOTOKEN: ${{ secrets.REPOTOKEN }}
-      DEBIAN_FRONTEND: noninteractive
-
     steps:
-      - name: Install dependencies
-        shell: bash
+      - name: Check unit tests status
         run: |
-          echo "machine freeswitch.signalwire.com password $REPOTOKEN" > /etc/apt/auth.conf && \
-          apt-get update && \
-          apt-get -y remove \
-            libsofia-sip-ua0 \
-            libspandsp-dev && \
-          apt-get -y install \
-            autoconf \
-            libsofia-sip-ua-dev \
-            libspandsp3-dev && \
-          rm -rf /etc/apt/auth.conf
-
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          path: /__w/freeswitch/freeswitch
+          if [ "${{ needs.unit-tests.result }}" != "success" ]; then
+            exit 1
+          fi
 
-      - name: Bootstrap
-        shell: bash
-        working-directory: /__w/freeswitch/freeswitch
-        run: |
-          ./bootstrap.sh -j || exit 1
+  unit-tests-dind:
+    if: ${{ inputs.dind }}
+    name: "Unit-tests D-in-D"
+    uses: ./.github/workflows/unit-test-dind.yml
+    with:
+      freeswitch_ref: ${{ inputs.freeswitch_ref }}
+      sofia-sip_ref: ${{ inputs.sofia-sip_ref }}
+    secrets: inherit
 
-      - name: Scan-build FreeSwitch
-        shell: bash
-        working-directory: /__w/freeswitch/freeswitch
-        run: |
-          cp build/modules.conf.most modules.conf && \
-          echo 'codecs/mod_openh264' >> modules.conf && \
-          sed -i \
-            -e '/mod_mariadb/s/^#//g' \
-            -e '/mod_v8/s/^#//g' \
-            -e '/mod_ilbc/s/^/#/g' \
-            -e '/mod_isac/s/^/#/g' \
-            -e '/mod_mp4/s/^/#/g' \
-            -e '/mod_mongo/s/^/#/g' \
-            -e '/mod_pocketsphinx/s/^/#/g' \
-            -e '/mod_sangoma_codec/s/^/#/g' \
-            -e '/mod_siren/s/^/#/g' \
-            -e '/mod_avmd/s/^/#/g' \
-            -e '/mod_basic/s/^/#/g' \
-            -e '/mod_cdr_mongodb/s/^/#/g' \
-            -e '/mod_cv/s/^/#/g' \
-            -e '/mod_erlang_event/s/^/#/g' \
-            -e '/mod_perl/s/^/#/g' \
-            -e '/mod_rtmp/s/^/#/g' \
-            -e '/mod_unimrcp/s/^/#/g' \
-            -e '/mod_xml_rpc/s/^/#/g' \
-          modules.conf && \
-          ./configure && \
-          ./scan_build.sh
+  scan-build:
+    name: "Scan Build"
+    uses: ./.github/workflows/scan-build.yml
+    secrets: inherit

.github/workflows/scan-build.yml

@@ -0,0 +1,100 @@
+name: Scan build (Static Analysis)
+
+on:
+  workflow_call:
+    inputs:
+      freeswitch_ref:
+        description: 'FreeSWITCH repository ref'
+        required: false
+        type: string
+      sofia-sip_ref:
+        description: 'Sofia-Sip repository ref'
+        required: false
+        type: string
+
+jobs:
+  scan-build:
+    runs-on: ubuntu-latest
+    container:
+      image: signalwire/freeswitch-public-ci-base:bookworm-amd64
+      options: --privileged
+    env:
+      DEBIAN_FRONTEND: noninteractive
+
+    steps:
+      - name: Checkout Sofia-Sip
+        if: inputs.sofia-sip_ref == ''
+        uses: actions/checkout@v4
+        with:
+          repository: freeswitch/sofia-sip
+          path: sofia-sip
+
+      - name: Checkout Sofia-Sip (via ref)
+        if: inputs.sofia-sip_ref != ''
+        uses: actions/checkout@v4
+        with:
+          repository: freeswitch/sofia-sip
+          ref: ${{ inputs.sofia-sip_ref }}
+          path: sofia-sip
+
+      - name: Checkout FreeSWITCH (via ref)
+        if: inputs.freeswitch_ref != ''
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.freeswitch_ref }}
+          path: freeswitch
+
+      - name: Checkout FreeSWITCH
+        if: inputs.freeswitch_ref == ''
+        uses: actions/checkout@v4
+        with:
+          path: freeswitch
+
+      - name: Configure, Build and Install Sofia-Sip
+        shell: bash
+        working-directory: freeswitch
+        run: |
+          ./ci.sh -t scan-build -a configure -c sofia-sip -p "$GITHUB_WORKSPACE/sofia-sip"
+          ./ci.sh -t scan-build -a build -c sofia-sip -p "$GITHUB_WORKSPACE/sofia-sip"
+          ./ci.sh -t scan-build -a install -c sofia-sip -p "$GITHUB_WORKSPACE/sofia-sip"
+
+      - name: Configure FreeSWITCH
+        shell: bash
+        working-directory: freeswitch
+        run: |
+          ./ci.sh -t scan-build -a configure -c freeswitch -p "$GITHUB_WORKSPACE/freeswitch"
+
+      - name: Run scan-build analysis
+        shell: bash
+        working-directory: freeswitch
+        run: |
+          ./ci.sh -t scan-build -a build -c freeswitch -p "$GITHUB_WORKSPACE/freeswitch"
+
+      - name: Check analysis results
+        if: always()
+        shell: bash
+        working-directory: freeswitch
+        run: |
+          ./ci.sh -t scan-build -a validate -c freeswitch -p "$GITHUB_WORKSPACE/freeswitch"
+
+      - name: Upload Scan-Build logs
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: scan-build-logs
+          path: freeswitch/scan-build
+          retention-days: 3
+          if-no-files-found: ignore
+          compression-level: 9
+
+      - name: Notify run tests result to slack
+        if: |
+          failure() &&
+          github.event_name == 'push' &&
+          (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/v1.10')
+        uses: signalwire/actions-template/.github/actions/slack@main
+        with:
+          CHANNEL: ${{ secrets.SLACK_DEVOPS_CI_CHANNEL }}
+          MESSAGE: Scan-Build ${{ github.repository }} > <${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}|${{ github.run_id }}>. Static analysis failed.
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}

.github/workflows/unit-test-dind.yml

@@ -0,0 +1,101 @@
+name: Unit-tests D-in-D
+
+on:
+  workflow_call:
+    inputs:
+      freeswitch_ref:
+        description: 'FreeSWITCH repository ref'
+        required: false
+        type: string
+      sofia-sip_ref:
+        description: 'Sofia-Sip repository ref'
+        required: false
+        type: string
+
+env:
+  MAX_CONTAINERS: 8
+  NUM_CPU_PER_CONTAINER: 1
+  DOCKER_BUILD_SUMMARY: false
+  DOCKER_BUILD_CHECKS_ANNOTATIONS: false
+  DOCKER_BUILD_RECORD_UPLOAD: false
+
+jobs:
+  unit-tests:
+    runs-on: ubuntu-latest
+    container:
+      image: signalwire/freeswitch-public-ci-base:bookworm-amd64
+      options: --privileged
+    env:
+      DEBIAN_FRONTEND: noninteractive
+      ASAN_OPTIONS: log_path=stdout:disable_coredump=0:unmap_shadow_on_exit=1:fast_unwind_on_malloc=0
+
+    steps:
+      - name: Checkout Sofia-Sip (via ref)
+        if: inputs.sofia-sip_ref != ''
+        uses: actions/checkout@v4
+        with:
+          repository: freeswitch/sofia-sip
+          ref: ${{ inputs.sofia-sip_ref }}
+          path: sofia-sip
+
+      - name: Checkout Sofia-Sip
+        if: inputs.sofia-sip_ref == ''
+        uses: actions/checkout@v4
+        with:
+          repository: freeswitch/sofia-sip
+          path: sofia-sip
+
+      - name: Checkout FreeSWITCH (via ref)
+        if: inputs.freeswitch_ref != ''
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.freeswitch_ref }}
+          path: freeswitch
+
+      - name: Checkout FreeSWITCH
+        if: inputs.freeswitch_ref == ''
+        uses: actions/checkout@v4
+        with:
+          path: freeswitch
+
+      - name: Run Unit-Test containers and collect artifacts
+        id: unit_tests
+        shell: bash
+        run: |
+          echo "logs_path=${GITHUB_WORKSPACE}/freeswitch/tests/unit/logs" >> $GITHUB_OUTPUT
+
+          "${GITHUB_WORKSPACE}/freeswitch/tests/unit/run-tests-docker.sh" \
+            --base-image signalwire/freeswitch-public-ci-base:bookworm-amd64 \
+            --cpus ${{ env.NUM_CPU_PER_CONTAINER }} \
+            --image-tag ci.local \
+            --max-containers ${{ env.MAX_CONTAINERS }} \
+            --output-dir "${GITHUB_WORKSPACE}/freeswitch/tests/unit/logs" \
+            --sofia-sip-path "${GITHUB_WORKSPACE}/sofia-sip" \
+            --freeswitch-path "${GITHUB_WORKSPACE}/freeswitch"
+
+          test -d "/cores" && ls -lah /cores
+
+          cd "${GITHUB_WORKSPACE}/freeswitch/tests/unit/" && \
+          ./collect-test-logs.sh --dir logs --print
+
+      - name: Upload Unit-Test logs
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-results-${{ github.sha }}-${{ github.run_number }}
+          path: ${{ steps.unit_tests.outputs.logs_path }}
+          retention-days: 3
+          if-no-files-found: ignore
+          compression-level: 9
+
+      - name: Notify run tests result to slack
+        if: |
+          failure() &&
+          github.event_name == 'push' &&
+          (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/v1.10')
+        uses: signalwire/actions-template/.github/actions/slack@main
+        with:
+          CHANNEL: ${{ secrets.SLACK_DEVOPS_CI_CHANNEL }}
+          MESSAGE: Unit-Tests ${{ github.repository }} > <${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}|${{ github.run_id }}>. Some tests are failing.
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}