test(github-actions): migrate tests to GitHub Actions

.github/workflows/commands-handler.yml

@@ -11,11 +11,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           token: ${{ secrets.GH_TOKEN }}
       - name: Checkout release actions
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           repository: pubnub/client-engineering-deployment-tools
           ref: v1

.github/workflows/composite/unit-integration-test-runner/action.yaml

@@ -0,0 +1,71 @@
+---
+name: Tests runner
+description: Unit and integration tests runner for multiple compiler types.
+author: PubNub
+inputs:
+  os:
+    description: Environment in which framework should be built.
+    required: true
+  version:
+    description: "Which version of 'cgreen' should be built."
+    required: true
+  pubNubPubKey:
+    description: "PubNub publish keys which should be used with integration tests"
+    required: true
+  pubNubSubKey:
+    description: "PubNub subscribe keys which should be used with integration tests"
+    required: true
+
+runs:
+  using: "composite"
+  steps:
+    - name: Prepare environments
+      shell: bash
+      run: |
+        echo "PUBNUB_PUBKEY=${{ inputs.pubNubPubKey }}" >> $GITHUB_ENV
+        echo "PUBNUB_KEYSUB=${{ inputs.pubNubSubKey }}" >> $GITHUB_ENV
+    - name: Pull Unit Test framework ('${{ inputs.os }}' gcc, clang)
+      uses: ./.github/workflows/composite/unit-test-framework
+      with:
+        os: ${{ inputs.os }}
+        version: ${{ inputs.version }}
+        compilers: gcc,clang
+    - name: Prepare Unit Test framework ('${{ inputs.os }}' gcc)
+      shell: bash
+      run: |
+        mv "$GITHUB_WORKSPACE/cgreen" "$GITHUB_WORKSPACE/cgreen-universal"
+        cp -r "$GITHUB_WORKSPACE/cgreen-universal/gcc" "$GITHUB_WORKSPACE/cgreen"
+    - name: Run unit tests ('${{ inputs.os }}' gcc)
+      shell: bash
+      env:
+        CC: gcc
+        CXX: "g++"
+      run: .github/workflows/composite/unit-integration-test-runner/run-unit-tests.sh ${{ inputs.os }}
+    - name: Run integration tests ('${{ inputs.os }}' gcc)
+      shell: bash
+      env:
+        CC: gcc
+        CXX: "g++"
+      run: .github/workflows/composite/unit-integration-test-runner/run-integration-tests.sh ${{ inputs.os }}
+    - name: Prepare Unit Test framework ('${{ inputs.os }}' clang)
+      shell: bash
+      run: |
+        rm -rf "$GITHUB_WORKSPACE/cgreen"
+        cp -r "$GITHUB_WORKSPACE/cgreen-universal/clang" "$GITHUB_WORKSPACE/cgreen"
+    - name: Run unit tests ('${{ inputs.os }}' clang)
+      shell: bash
+      env:
+        CC: clang
+        CXX: "clang++"
+      run: .github/workflows/composite/unit-integration-test-runner/run-unit-tests.sh ${{ inputs.os }}
+    - name: Run integration tests ('${{ inputs.os }}' clang)
+      shell: bash
+      env:
+        CC: clang
+        CXX: "clang++"
+      run: .github/workflows/composite/unit-integration-test-runner/run-integration-tests.sh ${{ inputs.os }}
+    - name: Restore Unit Test framework ('${{ inputs.os }}' gcc,clang)
+      shell: bash
+      run: |
+        rm -rf "$GITHUB_WORKSPACE/cgreen"
+        cp -r "$GITHUB_WORKSPACE/cgreen-universal" "$GITHUB_WORKSPACE/cgreen"

.github/workflows/composite/unit-integration-test-runner/run-integration-tests.sh

@@ -0,0 +1,36 @@
+#!/bin/bash
+
+INFO_BG="\033[0m\033[48;2;5;49;70m"
+INFO_FG="\033[38;2;19;181;255m"
+BOLD_INFO_FG="${INFO_FG}\033[1m"
+SUCCESS_BG="\033[0m\033[48;2;30;69;1m"
+SUCCESS_FG="\033[38;2;95;215;0m"
+BOLD_SUCCESS_FG="${SUCCESS_FG}\033[1m"
+CLEAR="\033[0m"
+
+echo "::group::Run integration tests ('$1' $CC / $CXX)"
+cd "$GITHUB_WORKSPACE"
+
+if ! build="$(make -f posix.mk clean all 2>&1)"; then
+  echo "::error file=posix.mk::Unable to build test suite: $build"
+  exit 1
+else
+  echo -e "${SUCCESS_BG}Test suit is built 🎉${CLEAR}"
+fi
+
+[[ "$build" =~ "deprecated" ]] && echo "::warning title=deprecated::There is deprecated functions used in code."
+[[ "$build" =~ "not used" ]] && echo "::warning title=unused::There is unused variables and / or functions in code."
+
+echo -e "${INFO_BG}${INFO_FG}Running ${BOLD_INFO_FG}POSIX ${INFO_BG}${INFO_FG}integration tests...${CLEAR}"
+posix/pubnub_fntest
+echo -e "${SUCCESS_BG}${BOLD_SUCCESS_FG}POSIX ${SUCCESS_BG}${SUCCESS_FG}integration tests completed 🎉${CLEAR}"
+echo -e "${INFO_BG}${INFO_FG}Running ${BOLD_INFO_FG}OpenSSL ${INFO_BG}${INFO_FG}integration tests${CLEAR}"
+openssl/pubnub_fntest
+echo -e "${SUCCESS_BG}${BOLD_SUCCESS_FG}POSIX ${SUCCESS_BG}${SUCCESS_FG}integration tests completed 🎉${CLEAR}"
+echo -e "${INFO_BG}${INFO_FG}Running ${BOLD_INFO_FG}C++ ${INFO_BG}${INFO_FG}integration tests${CLEAR}"
+cpp/fntest_runner
+echo -e "${SUCCESS_BG}${BOLD_SUCCESS_FG}POSIX ${SUCCESS_BG}${SUCCESS_FG}integration tests completed 🎉${CLEAR}"
+echo -e "${INFO_BG}${INFO_FG}Running ${BOLD_INFO_FG}C++ OpenSSL ${INFO_BG}${INFO_FG}integration tests${CLEAR}"
+cpp/openssl/fntest_runner
+echo -e "${SUCCESS_BG}${BOLD_SUCCESS_FG}POSIX ${SUCCESS_BG}${SUCCESS_FG}integration tests completed 🎉${CLEAR}"
+echo "::endgroup::"

.github/workflows/composite/unit-integration-test-runner/run-unit-tests.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+echo "::group::Run unit tests ('$1' $CC / $CXX)"
+cd "$GITHUB_WORKSPACE/core"
+make clean generate_report
+cd "$GITHUB_WORKSPACE/lib"
+make clean generate_report
+echo "::endgroup::"

.github/workflows/composite/unit-test-framework/action.yaml

@@ -0,0 +1,38 @@
+---
+name: Unit Test and Mocking framework
+description: Manage unit test framework build and cache so it can be used with jobs.
+author: PubNub
+inputs:
+  os:
+    description: Environment in which framework should be built.
+    required: true
+  version:
+    description: "Which version of 'cgreen' should be built."
+    required: true
+  compilers:
+    description: "Coma-separated list of currently supported C compilers to be used during build (gcc, clang)."
+    required: true
+
+runs:
+  using: "composite"
+  steps:
+    - name: Build and Cache Unit Test framework ('${{ inputs.os }}' ${{ inputs.compilers }})
+      id: unit-test-framework
+      uses: actions/cache@v3
+      with:
+        path: |
+          cgreen
+        key: ${{ inputs.os }}-cgreen-${{ inputs.version }}-1
+        restore-keys: |
+          ${{ inputs.os }}-cgreen-${{ inputs.version }}-
+    - name: Checkout Unit Test framework
+      if: steps.unit-test-framework.outputs.cache-hit != 'true'
+      uses: actions/checkout@v3
+      with:
+        repository: cgreen-devs/cgreen
+        ref: ${{ matrix.cgreen }}
+        path: cgreen
+    - name: Build Unit Test frameworks
+      if: steps.unit-test-framework.outputs.cache-hit != 'true'
+      shell: bash
+      run: .github/workflows/composite/unit-test-framework/build-framework.sh ${{ inputs.os }} ${{ inputs.compilers }}

.github/workflows/composite/unit-test-framework/build-framework.sh

@@ -0,0 +1,59 @@
+#!/bin/bash
+
+# Identify make tool which depends from environment.
+[[ $1 =~ (ubuntu|macos) ]] && MAKE_TOOL=make || MAKE_TOOL=$(MAKE)
+
+# Iterating over list of passed compilers.
+for compiler in ${2//,/ }
+do
+  # Navigate to unit test framework source folder.
+  cd "$GITHUB_WORKSPACE/cgreen"
+
+  # Clean up previous build results.
+  [[ -d build ]] && $MAKE_TOOL clean && rm -rf build
+
+  echo "::group::Build unit test framework ('$1' $compiler)"
+  if [[ $1 =~ (ubuntu|macos) ]]; then
+    export CC="$compiler"
+    [[ $compiler == "gcc" ]] && export CXX="g++" || export CXX="$compiler++"
+  else
+    echo "::warning title=compiler flags::Here should be some setup for Windows compiler"
+  fi
+
+  echo "::notice title=cgreen::Prepare folders structure"
+  ! [[ -d "$GITHUB_WORKSPACE/cgreen-tmp/$compiler" ]] &&
+    mkdir -p "$GITHUB_WORKSPACE/cgreen-tmp/$compiler"
+  mkdir -p build && cd build
+
+  # Enable 'gcov' only for build on Ubuntu.
+  [[ "$1" == "ubuntu" ]] && WITH_GCOV=ON || WITH_GCOV=OFF
+  if [[ "$WITH_GCOV" == ON ]]; then
+    echo "::notice title=gcov::Installing 'gcov' for code coverage."
+    if ! install="$(pip install --user gcovr)"; then
+      echo "::error title=gcov::Unable to install 'gcov':$install"
+    else
+    echo "::notice title=gcov::Installing 'gcov' for code coverage."
+    fi
+  else
+    echo "::warning title=gcov::'gcov' doesn't work as expected on $1."
+    echo "::warning title=gcov::Configure 'cgreen' without 'gcov' support"
+  fi
+
+  echo "::notice title=cgreen::Configure 'cgreen' build"
+  cmake -E env LDFLAGS="-lm" cmake -DCGREEN_INTERNAL_WITH_GCOV:BOOL=$WITH_GCOV ..
+
+  echo "::notice title=cgreen::Build 'cgreen' framework"
+  make -j2
+
+  echo "::notice::Move built results to compiler specific colder"
+  mv "$GITHUB_WORKSPACE/cgreen/build" "$GITHUB_WORKSPACE/cgreen-tmp/$compiler/build"
+  cp -r "$GITHUB_WORKSPACE/cgreen/include" "$GITHUB_WORKSPACE/cgreen-tmp/$compiler/include"
+
+  # Clean up configured environments.
+  unset CC && unset CXX
+  echo "::endgroup::"
+done
+
+echo "::notice title=cgreen::Prepare files for caching"
+rm -rf "$GITHUB_WORKSPACE/cgreen"
+mv "$GITHUB_WORKSPACE/cgreen-tmp" "$GITHUB_WORKSPACE/cgreen"

.github/workflows/release.yml

@@ -15,25 +15,25 @@ jobs:
       release: ${{ steps.check.outputs.ready }}
     steps:
       - name: Checkout actions
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           repository: pubnub/client-engineering-deployment-tools
           ref: v1
           token: ${{ secrets.GH_TOKEN }}
           path: .github/.release/actions
-      - id: check
-        name: Check pre-release completed
+      - name: Check pre-release completed
+        id: check
         uses: ./.github/.release/actions/actions/checks/release
         with:
           token: ${{ secrets.GH_TOKEN }}
   publish:
     name: Publish package
-    runs-on: macos-11
+    runs-on: ubuntu-latest
     needs: check-release
     if: ${{ needs.check-release.outputs.release == 'true' }}
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           # This should be the same as the one specified for on.pull_request.branches
           ref: master

.github/workflows/run-tests.yml

@@ -0,0 +1,120 @@
+name: Tests
+
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  push:
+  workflow_dispatch:
+
+
+jobs:
+  tests-ubuntu:
+    name: Integration and Unit tests (Ubuntu)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout project
+        uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.GH_TOKEN }}
+      - name: Build and run tests
+        uses: ./.github/workflows/composite/unit-integration-test-runner
+        with:
+          os: ubuntu
+          version: 1.6.0
+          pubNubPubKey: ${{ secrets.PUBNUB_PUBKEY }}
+          pubNubSubKey: ${{ secrets.PUBNUB_KEYSUB }}
+  tests-macos:
+    name: Integration and Unit tests (macOS)
+    runs-on: macos-latest
+    steps:
+      - name: Checkout project
+        uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.GH_TOKEN }}
+      - name: Build and run tests
+        uses: ./.github/workflows/composite/unit-integration-test-runner
+        with:
+          os: macos
+          version: 1.6.0
+          pubNubPubKey: ${{ secrets.PUBNUB_PUBKEY }}
+          pubNubSubKey: ${{ secrets.PUBNUB_KEYSUB }}
+  acceptance:
+    name: Acceptance tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup environment
+        shell: bash
+        run: |
+          sudo apt-get install -y ninja-build libboost-all-dev libssl-dev
+          sudo gem install cucumber
+      - name: Checkout project
+        uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.GH_TOKEN }}
+      - name: Checkout mock-server action
+        uses: actions/checkout@v3
+        with:
+          repository: pubnub/client-engineering-deployment-tools
+          ref: v1
+          token: ${{ secrets.GH_TOKEN }}
+          path: .github/.release/actions
+      - name: Run mock server action
+        uses: ./.github/.release/actions/actions/mock-server
+        with:
+          token: ${{ secrets.GH_TOKEN }}
+      - name: Pull Cucumber cache
+        id: cucumber-cpp
+        uses: actions/cache@v3
+        with:
+          path: |
+            cucumber-cpp
+          key: ${{ runner.os }}-cucumber-cpp-c79100eb70fbb34f6ea10030cec051c2cc9f7961
+          restore-keys: |
+            ${{ runner.os }}-cucumber-cpp-
+      - name: Checkout Cucumber
+        if: steps.cucumber-cpp.outputs.cache-hit != 'true'
+        uses: actions/checkout@v3
+        with:
+          repository: cucumber/cucumber-cpp
+          ref: c79100eb70fbb34f6ea10030cec051c2cc9f7961
+          path: cucumber-cpp-src
+      - name: Build Cucumber
+        if: steps.cucumber-cpp.outputs.cache-hit != 'true'
+        shell: bash
+        run: |
+          cd ./cucumber-cpp-src
+          cmake -B build -DCMAKE_BUILD_TYPE=Debug
+          cmake --build build --config Debug
+          cd "$GITHUB_WORKSPACE"
+          mkdir -p cucumber-cpp
+          mv cucumber-cpp-src/build cucumber-cpp/build
+          mv cucumber-cpp-src/include cucumber-cpp/include
+          rm -rf cucumber-cpp-src
+      - name: Build acceptance tests
+        shell: bash
+        run: |
+          cd cpp
+          make -f posix_openssl.mk openssl/pubnub_sync
+          cd "$GITHUB_WORKSPACE"
+          g++ -std=c++11 -g -o BoostSteps.o -c features/step_definitions/BoostSteps.cpp -Icucumber-cpp/include -Icucumber-cpp/build/src/ -Iposix -Icore -I. -Icpp -D PUBNUB_CRYPTO_API=1 -D PUBNUB_USE_SSL=0
+          g++ -o steps BoostSteps.o cpp/pubnub_sync.a cucumber-cpp/build/src/libcucumber-cpp.a -Lboost -lboost_unit_test_framework -lpthread -lboost_regex -lboost_thread -lboost_program_options -lboost_filesystem -lssl -lcrypto -D PUBNUB_USE_SSL=0
+      - name: Run acceptance tests
+        shell: bash
+        env:
+          PAM_PUB_KEY: "pub_key"
+          PAM_SUB_KEY: "sub_key"
+          PAM_SEC_KEY: "sec_key"
+        run: |
+          mv sdk-specifications/features/access features
+          sudo python3 run_contract_tests.py features/access/grant-token.feature
+          sudo python3 run_contract_tests.py features/access/revoke-token.feature
+          ls -la results
+      - name: Expose acceptance tests reports
+        if: always()
+        uses: actions/upload-artifact@v3
+        with:
+          name: acceptance-test-reports
+          path: ./results/**
+          retention-days: 7