CI: test with multiple Nim versions (#121)

* CI: test with multiple Nim versions and disable C++ testing (linker doesn't like arg order)
2025-02-23 09:48:21 +00:00 · 2021-12-16 23:33:42 +01:00 · 2021-12-16 23:33:42 +01:00 · 24b56c8d2b
commit 24b56c8d2b
parent 59a01aa200
3 changed files with 81 additions and 85 deletions
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@ -1,14 +1,16 @@
-name: nim-json-rpc CI
-on: [push, pull_request]
+name: CI
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+  workflow_dispatch:

 jobs:
  build:
    strategy:
      fail-fast: false
-      max-parallel: 20
      matrix:
-        branch: [master]
-        test_lang: [c, cpp]
        target:
          - os: linux
            cpu: amd64
@ -18,27 +20,33 @@ jobs:
            cpu: amd64
          - os: windows
            cpu: amd64
-          - os: windows
-            cpu: i386
+          #- os: windows
+            #cpu: i386
+        branch: [version-1-2, version-1-4, version-1-6, devel]
        include:
          - target:
              os: linux
            builder: ubuntu-18.04
+            shell: bash
          - target:
              os: macos
            builder: macos-10.15
+            shell: bash
          - target:
              os: windows
            builder: windows-2019
+            shell: msys2 {0}

-    name: '${{ matrix.target.os }}-${{ matrix.target.cpu }}-${{ matrix.test_lang}} (${{ matrix.branch }})'
+    defaults:
+      run:
+        shell: ${{ matrix.shell }}
+
+    name: '${{ matrix.target.os }}-${{ matrix.target.cpu }} (Nim ${{ matrix.branch }})'
    runs-on: ${{ matrix.builder }}
+    continue-on-error: ${{ matrix.branch == 'version-1-6' || matrix.branch == 'devel' }}
    steps:
-      - name: Checkout nim-json-rpc
+      - name: Checkout
        uses: actions/checkout@v2
-        with:
-          path: nim-json-rpc
-          submodules: false

      - name: Install build dependencies (Linux i386)
        if: runner.os == 'Linux' && matrix.target.cpu == 'i386'
@ -60,13 +68,26 @@ jobs:
          chmod 755 external/bin/gcc external/bin/g++
          echo '${{ github.workspace }}/external/bin' >> $GITHUB_PATH

-      - name: Restore MinGW-W64 (Windows) from cache
-        if: runner.os == 'Windows'
-        id: windows-mingw-cache
-        uses: actions/cache@v2
+      - name: MSYS2 (Windows i386)
+        if: runner.os == 'Windows' && matrix.target.cpu == 'i386'
+        uses: msys2/setup-msys2@v2
        with:
-          path: external/mingw-${{ matrix.target.cpu }}
-          key: 'mingw-${{ matrix.target.cpu }}'
+          path-type: inherit
+          msystem: MINGW32
+          install: >-
+            base-devel
+            git
+            mingw-w64-i686-toolchain
+
+      - name: MSYS2 (Windows amd64)
+        if: runner.os == 'Windows' && matrix.target.cpu == 'amd64'
+        uses: msys2/setup-msys2@v2
+        with:
+          path-type: inherit
+          install: >-
+            base-devel
+            git
+            mingw-w64-x86_64-toolchain

      - name: Restore Nim DLLs dependencies (Windows) from cache
        if: runner.os == 'Windows'
@ -76,24 +97,6 @@ jobs:
          path: external/dlls-${{ matrix.target.cpu }}
          key: 'dlls-${{ matrix.target.cpu }}'

-      - name: Install MinGW64 dependency (Windows)
-        if: >
-          steps.windows-mingw-cache.outputs.cache-hit != 'true' &&
-          runner.os == 'Windows'
-        shell: bash
-        run: |
-          mkdir -p external
-          if [[ '${{ matrix.target.cpu }}' == 'amd64' ]]; then
-            MINGW_URL="https://sourceforge.net/projects/mingw-w64/files/Toolchains targetting Win64/Personal Builds/mingw-builds/8.1.0/threads-posix/seh/x86_64-8.1.0-release-posix-seh-rt_v6-rev0.7z"
-            ARCH=64
-          else
-            MINGW_URL="https://sourceforge.net/projects/mingw-w64/files/Toolchains targetting Win32/Personal Builds/mingw-builds/8.1.0/threads-posix/dwarf/i686-8.1.0-release-posix-dwarf-rt_v6-rev0.7z"
-            ARCH=32
-          fi
-          curl -L "$MINGW_URL" -o "external/mingw-${{ matrix.target.cpu }}.7z"
-          7z x -y "external/mingw-${{ matrix.target.cpu }}.7z" -oexternal/
-          mv external/mingw$ARCH external/mingw-${{ matrix.target.cpu }}
-
      - name: Install DLLs dependencies (Windows)
        if: >
          steps.windows-dlls-cache.outputs.cache-hit != 'true' &&
@ -109,49 +112,54 @@ jobs:
          runner.os == 'Windows'
        shell: bash
        run: |
-          echo '${{ github.workspace }}'"/external/mingw-${{ matrix.target.cpu }}/bin" >> $GITHUB_PATH
          echo '${{ github.workspace }}'"/external/dlls-${{ matrix.target.cpu }}" >> $GITHUB_PATH

-      - name: Get latest nimbus-build-system commit hash
-        id: versions
-        shell: bash
+      - name: Derive environment variables
        run: |
-          getHash() {
-            git ls-remote "https://github.com/$1" "${2:-HEAD}" | cut -f 1
-          }
-          nbsHash=$(getHash status-im/nimbus-build-system)
-          echo "::set-output name=nimbus_build_system::$nbsHash"
-
-      - name: Restore prebuilt Nim from cache
-        id: nim-cache
-        uses: actions/cache@v2
-        with:
-          path: NimBinaries
-          key: 'NimBinaries-${{ matrix.target.os }}-${{ matrix.target.cpu }}-${{ steps.versions.outputs.nimbus_build_system }}'
-
-      - name: Build Nim and associated tools
-        shell: bash
-        run: |
-          curl -O -L -s -S https://raw.githubusercontent.com/status-im/nimbus-build-system/master/scripts/build_nim.sh
          if [[ '${{ matrix.target.cpu }}' == 'amd64' ]]; then
            PLATFORM=x64
          else
            PLATFORM=x86
          fi
-          if [[ '${{ matrix.target.os }}' == 'windows' ]]; then
+          echo "PLATFORM=$PLATFORM" >> $GITHUB_ENV
+
+          ncpu=
+          MAKE_CMD="make"
+          case '${{ runner.os }}' in
+          'Linux')
+            ncpu=$(nproc)
+            ;;
+          'macOS')
+            ncpu=$(sysctl -n hw.ncpu)
+            ;;
+          'Windows')
+            ncpu=$NUMBER_OF_PROCESSORS
            MAKE_CMD="mingw32-make"
-          else
-            MAKE_CMD="make"
-          fi
-          env MAKE="$MAKE_CMD -j2" ARCH_OVERRIDE=$PLATFORM CC=gcc bash build_nim.sh nim csources dist/nimble NimBinaries
+            ;;
+          esac
+          [[ -z "$ncpu" || $ncpu -le 0 ]] && ncpu=1
+          echo "ncpu=$ncpu" >> $GITHUB_ENV
+          echo "MAKE_CMD=${MAKE_CMD}" >> $GITHUB_ENV

-      - name: Setup environment
+      - name: Build Nim and associated tools
        shell: bash
-        run: echo '${{ github.workspace }}/nim/bin' >> $GITHUB_PATH
-
-      - name: Run nim-json-rpc tests
-        shell: bash
-        working-directory: nim-json-rpc
        run: |
+          curl -O -L -s -S https://raw.githubusercontent.com/status-im/nimbus-build-system/master/scripts/build_nim.sh
+          env MAKE="${MAKE_CMD} -j${ncpu}" ARCH_OVERRIDE=${PLATFORM} NIM_COMMIT=${{ matrix.branch }} \
+            QUICK_AND_DIRTY_COMPILER=1 QUICK_AND_DIRTY_NIMBLE=1 CC=gcc \
+            bash build_nim.sh nim csources dist/nimble NimBinaries
+          echo '${{ github.workspace }}/nim/bin' >> $GITHUB_PATH
+
+      - name: Run tests
+        shell: bash
+        run: |
+          if [[ "${{ matrix.target.os }}" == "windows" ]]; then
+            # https://github.com/status-im/nimbus-eth2/issues/3121
+            export NIMFLAGS="-d:nimRawSetjmp"
+          fi
+          nim --version
+          nimble --version
          nimble install -y --depsOnly
-          env TEST_LANG="${{ matrix.test_lang }}" nimble test
+          env TEST_LANG="c" nimble test
+          # C++ is unsupported: https://github.com/status-im/nim-json-rpc/issues/119
+          #env TEST_LANG="cpp" nimble test
--- a/README.md
+++ b/README.md
@ -1,7 +1,5 @@
 # json-rpc

-[![Build Status (Travis)](https://img.shields.io/travis/status-im/nim-json-rpc/master.svg?label=Linux%20/%20macOS "Linux/macOS build status (Travis)")](https://travis-ci.org/status-im/nim-json-rpc)
-[![Windows build status (Appveyor)](https://img.shields.io/appveyor/ci/nimbus/nim-json-rpc/master.svg?label=Windows "Windows build status (Appveyor)")](https://ci.appveyor.com/project/nimbus/nim-json-rpc)
 [![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 ![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg)
--- a/json_rpc.nimble
+++ b/json_rpc.nimble
@ -17,24 +17,14 @@ requires "nim >= 1.2.0",
         "websock",
         "json_serialization"

-proc getLang(): string =
-  # Compilation language is controlled by TEST_LANG
-  result = "c"
-  if existsEnv"TEST_LANG":
-    result = getEnv"TEST_LANG"
-
-proc buildBinary(name: string, srcDir = "./", params = "", cmdParams = "", lang = "c") =
+proc buildBinary(name: string, srcDir = "./", params = "", cmdParams = "") =
  if not dirExists "build":
    mkDir "build"
-  exec "nim " & lang & " --out:./build/" & name & " " & params & " " & srcDir & name & ".nim" & " " & cmdParams
+  exec "nim " & getEnv("TEST_LANG", "c") & " " & getEnv("NIMFLAGS") & " -r -f --skipUserCfg:on --skipParentCfg:on --verbosity:0 --hints:off --debuginfo --path:'.' --threads:on -d:chronicles_log_level=ERROR --out:./build/" & name & " " & params & " " & srcDir & name & ".nim" & " " & cmdParams

 task test, "run tests":
  buildBinary "all", "tests/",
-    params = "-r -f --hints:off --debuginfo --path:'.' --threads:on -d:chronicles_log_level=ERROR -d:json_rpc_websocket_package=websock",
-    cmdParams = "",
-    lang = getLang()
+    params = "-d:json_rpc_websocket_package=websock"

  buildBinary "all", "tests/",
-    params = "-r -f --hints:off --debuginfo --path:'.' --threads:on -d:chronicles_log_level=ERROR -d:json_rpc_websocket_package=news",
-    cmdParams = "",
-    lang = getLang()
+    params = "-d:json_rpc_websocket_package=news"