Merge pull request #288 from cwellm/Add-Windows-CI

Add basic windows ci

Author: ursfassler

.github/workflows/format.yml

@@ -8,6 +8,10 @@ on:
     branches:
       - main
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.ref || github.run_id }}
+  cancel-in-progress: true
+
 jobs:
   build:
     runs-on: ubuntu-22.04
@@ -23,4 +27,3 @@ jobs:
     - name: check code format
       run: |
         clang-format-15 --style=file --Werror --dry-run --verbose `find . -type d \( -name '3rdparty' \) -prune -o -regex '.*\.\(cpp\|hpp\)' -print`
-

.github/workflows/linux-build.yml

@@ -8,6 +8,11 @@ on:
     branches:
       - main
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.ref || github.run_id }}
+  cancel-in-progress: true
+
+
 jobs:
   build:
     strategy:
@@ -68,4 +73,3 @@ jobs:
     - name: unit tests
       run: |
         cmake --build build --target test
-

.github/workflows/qt5.yml

@@ -8,6 +8,10 @@ on:
     branches:
       - main
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.ref || github.run_id }}
+  cancel-in-progress: true
+
 jobs:
   build:
     runs-on: ubuntu-22.04
@@ -74,4 +78,3 @@ jobs:
           (cd examples/CalcQt; cucumber)
           wait %
         done
-

.github/workflows/run-all.yml

@@ -8,12 +8,19 @@ on:
     branches:
       - main
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.ref || github.run_id }}
+  cancel-in-progress: true
+
 jobs:
-  build:
+  build-linux:
     runs-on: ubuntu-22.04
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
+
+    - name: update package index
+      run: sudo apt-get -y update
 
     - name: setup environment
       run: |
@@ -49,7 +56,7 @@ jobs:
 
     - name: build and run
       run: |
-        ./run-all.sh
+        ./run-linux.sh
 
     - name: code coverage summary report
       uses: irongut/[email protected]
@@ -64,4 +71,3 @@ jobs:
       run: |
         echo '# Code Coverage Report' >> $GITHUB_STEP_SUMMARY
         cat code-coverage-results.md >> $GITHUB_STEP_SUMMARY
-

.github/workflows/windows-build.yml

@@ -0,0 +1,89 @@
+name: Windows build
+
+on:
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        cpp-standard:
+          - 17
+          - 20
+    # You can find specific tool versions for Windows builds in the Runner specification:
+    # https://github.com/actions/runner-images/blob/main/images/windows/Windows2022-Readme.md
+    # In particular, this build uses:
+    # cmake: 3.27.9
+    # VSCode: 2022 Enterprise Edition (corresponding C++ version: https://blog.knatten.org/2022/08/26/microsoft-c-versions-explained/)
+    # Ruby: 3.0.6p216
+    # boost: 1.82.0
+    runs-on: windows-2022
+    env:
+      BOOST_VERSION: 1.82.0
+      NLOHMANN_CLONE_DIR: nlohmann
+      NLOHMANN_TAG: v3.11.3
+      ASIO_CLONE_DIR: asio
+      ASIO_TAG: asio-1-29-0
+      TCLAP_CLONE_DIR: tclap
+      TCLAP_TAG: v1.2.5
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: install ruby tools
+      run: |
+        gem install bundler
+        bundle install
+
+    # - name: Install Google Test
+    #   uses: MarkusJx/[email protected]
+
+    - name: Restore cached boost dependencies
+      id: cache-boost-deps
+      uses: actions/cache@v3
+      with:
+        path: |
+          boost_1_82_0
+        key: ${{ runner.os }}-boost-1820
+
+    - name: install boost
+      if: steps.cache-boost-deps.outputs.cache-hit != 'true'
+      run: |
+        $boost_version_str = ${Env:BOOST_VERSION}.Replace(".","_")
+        $ProgressPreference = 'SilentlyContinue'
+        Invoke-WebRequest -Uri https://boostorg.jfrog.io/artifactory/main/release/${Env:BOOST_VERSION}/source/boost_${boost_version_str}.zip -OutFile boost_${boost_version_str}.zip
+        7z x boost_${boost_version_str}.zip
+        cd boost_${boost_version_str}
+        cmd /C bootstrap
+        ./b2.exe --build-type=complete toolset=msvc --with-regex --with-program_options --with-system --with-test
+
+    - name: Get and build nlohmann-json
+      run: |
+        Start-Process "git" -ArgumentList "clone https://github.com/nlohmann/json.git $Env:NLOHMANN_CLONE_DIR --depth 1 --branch $Env:NLOHMANN_TAG" -PassThru -NoNewWindow -Wait
+        cd $Env:NLOHMANN_CLONE_DIR
+        cmake -B build -S .
+        cd ..
+
+    - name: Get ASIO
+      run: Start-Process "git" -ArgumentList "clone https://github.com/chriskohlhoff/asio.git $Env:ASIO_CLONE_DIR --depth 1 --branch $Env:ASIO_TAG" -PassThru -NoNewWindow -Wait
+
+    - name: Get TCLAP
+      run: Start-Process "git" -ArgumentList "clone https://github.com/mirror/tclap.git $Env:TCLAP_CLONE_DIR --depth 1 --branch $Env:TCLAP_TAG" -PassThru -NoNewWindow -Wait
+
+    - name: build and run
+      run: |
+        $current_script_dir = Get-Location | Select-Object -Expand "Path"
+        $Env:nlohmann_json_DIR = "${current_script_dir}/$Env:NLOHMANN_CLONE_DIR/build"
+        $Env:Asio_ROOT = "${current_script_dir}/$Env:ASIO_CLONE_DIR/asio"
+        $Env:TCLAP_ROOT = "${current_script_dir}/$Env:TCLAP_CLONE_DIR"
+        $Env:cpp_standard = ${{ matrix.cpp-standard }}
+        ./run-windows.ps1

.gitignore

@@ -20,3 +20,5 @@
 # Qt Creator
 /CMakeLists.txt.user
 
+# build folder
+build

CMakeLists.txt

@@ -1,15 +1,14 @@
 cmake_minimum_required(VERSION 3.16)
 
-if(NOT CMAKE_VERSION VERSION_LESS "3.3")
-    # Don't ignore visibility related properties for non-SHARED targets
-    cmake_policy(SET CMP0063 NEW)
-endif()
+cmake_policy(SET CMP0063 NEW)
 
-if (NOT CMAKE_VERSION VERSION_LESS "3.13")
-    # CMP0077: option() honors normal variables
-    # https://cmake.org/cmake/help/latest/policy/CMP0077.html
-    cmake_policy(SET CMP0077 NEW)
-endif()
+# CMP0077: option() honors normal variables
+# https://cmake.org/cmake/help/latest/policy/CMP0077.html
+cmake_policy(SET CMP0077 NEW)
+
+# CMP0074: find_package() makes use of <PackageName>_ROOT variables
+# https://cmake.org/cmake/help/latest/policy/CMP0074.html
+cmake_policy(SET CMP0074 NEW)
 
 project(Cucumber-Cpp)
 

README.md

@@ -2,6 +2,8 @@
 
 [![Join the chat at https://gitter.im/cucumber/cucumber-cpp](https://badges.gitter.im/cucumber/cucumber-cpp.svg)](https://gitter.im/cucumber/cucumber-cpp?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
+## Overview
+
 Cucumber-Cpp allows Cucumber to support step definitions written in C++.
 
 * [Cucumber-Cpp Website](https://github.com/cucumber/cucumber-cpp)
@@ -15,6 +17,8 @@ with [CPP].
 
 If you want to contribute code to the project, guidelines are in [CONTRIBUTING.md](CONTRIBUTING.md).
 
+## Dependencies
+
 It relies on a few executables:
 
 * [cmake](https://cmake.org/download/) 3.16 or later.
@@ -48,6 +52,14 @@ gem install bundler // For windows: gem install bundle
 bundle install
 ```
 
+### Windows vs. Linux
+
+To get an inspiration on how to set up the dependencies on your specific system (Windows or Linux), you may want to have a look at the
+workflow files [for Windows](.github/workflows/windows-build.yml) and [for Linux](.github/workflows/linux-build.yml).
+
+
+## Build
+
 Building Cucumber-Cpp with tests and samples:
 
 ```

run-all.sh renamed to run-linux.sh

@@ -0,0 +1,66 @@
+# --- Function definitions ---
+function Invoke-CMake {
+    param (
+        $Arguments
+    )
+    $process = Start-Process "cmake" -ArgumentList "$Arguments" -NoNewWindow -Wait -PassThru
+    If ($process.ExitCode -ne 0) {
+        Write-Host "Abort script execution due to CMake error."
+        Exit(42)
+    }
+}
+
+function Get-VariableOrEnv {
+    param (
+        [string]$Name
+    )
+
+    $envValue = [Environment]::GetEnvironmentVariable($Name)
+    if ($envValue -ne $null) {
+        return $envValue
+    }
+
+    if (Get-Variable -Name $Name -ErrorAction SilentlyContinue) {
+        return (Get-Variable -Name $Name).Value
+    }
+
+    return $null
+}
+
+# --- Variable definitions ---
+$cpp_standard = Get-VariableOrEnv -Name "cpp_standard"
+
+$nlohmann_json_DIR = Get-VariableOrEnv -Name "nlohmann_json_DIR"
+$Asio_ROOT = Get-VariableOrEnv -Name "Asio_ROOT"
+$TCLAP_ROOT = Get-VariableOrEnv -Name "TCLAP_ROOT"
+$Env:BOOST_ROOT = "boost_${Env:BOOST_VERSION}".Replace(".","_")
+
+$Env:CTEST_OUTPUT_ON_FAILURE="ON"
+
+
+# --- Script ---
+
+Invoke-CMake "-E","make_directory","build"
+
+$cmake_params = "-E chdir build cmake",
+    "-DBUILD_SHARED_LIBS=`"${BUILD_SHARED_LIBS}`"",
+    "-DCMAKE_INSTALL_PREFIX=${HOME}/.local"
+
+$cmake_params += "-DCMAKE_CXX_STANDARD=${cpp_standard}"
+
+$cmake_params += "-DCUKE_ENABLE_BOOST_TEST=OFF"
+$cmake_params += "-DCUKE_ENABLE_GTEST=OFF"
+$cmake_params += "-DCUKE_ENABLE_QT_6=OFF"
+$cmake_params += "-DCUKE_ENABLE_EXAMPLES=OFF"
+$cmake_params += "-DCUKE_TESTS_UNIT=OFF"
+$cmake_params += "-DCUKE_CODE_COVERAGE=OFF"
+
+$cmake_params += "-Dnlohmann_json_DIR=${nlohmann_json_DIR}"
+$cmake_params += "-DAsio_ROOT=${Asio_ROOT}"
+$cmake_params += "-DTCLAP_ROOT=${TCLAP_ROOT}"
+
+$cmake_params += ".."
+
+
+Invoke-CMake "$cmake_params"
+Invoke-CMake "--build","build" #,"--parallel"

run-windows.ps1

@@ -105,11 +105,14 @@ foreach(TARGET
         PUBLIC
             $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}>
             $<BUILD_INTERFACE:${CUKE_INCLUDE_DIR}>
+            $<BUILD_INTERFACE:${ASIO_INCLUDE_DIR}>
+            $<BUILD_INTERFACE:${TCLAP_INCLUDE_DIR}>
             $<INSTALL_INTERFACE:$<INSTALL_PREFIX>/include>
     )
     target_link_libraries(${TARGET}
         PRIVATE
             ${CUKE_EXTRA_PRIVATE_LIBRARIES}
+            nlohmann_json::nlohmann_json
     )
     # Don't export or import symbols for statically linked libraries
     get_property(type TARGET ${TARGET} PROPERTY TYPE)