Merge pull request #312 from wravery/next

Groundwork in CMake, build workflows, and header include cleanup
microsoft · Sep 12, 2024 · e9c7081 · e9c7081
2 parents 681b0e1 + 7dc77fa
commit e9c7081
Show file tree

Hide file tree

Showing 47 changed files with 172 additions and 126 deletions.
diff --git a/.github/workflows/linux.yml b/.github/workflows/linux.yml
@@ -3,13 +3,13 @@ name: Linux
 on: [push, pull_request]
 
 jobs:
-  gcc10:
+  gcc14:
     strategy:
       fail-fast: false
       matrix:
         config: [Debug, Release]
 
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
 
     steps:
     - uses: actions/[email protected]
@@ -19,7 +19,10 @@ jobs:
     - name: Install Dependencies
       run: |
         sudo apt-get update
-        sudo apt-get install -yq libgtest-dev libboost-program-options-dev rapidjson-dev ninja-build gcc-10 g++-10
+        sudo apt-get upgrade
+        sudo add-apt-repository -y universe
+        sudo apt-get update
+        sudo apt-get install -yq libgtest-dev libboost-program-options-dev rapidjson-dev ninja-build gcc-14 g++-14
 
     - name: Build GTest
       run: |
@@ -35,8 +38,8 @@ jobs:
     - name: Configure CMake
       shell: pwsh
       env:
-        CC: gcc-10
-        CXX: g++-10
+        CC: gcc-14
+        CXX: g++-14
       working-directory: build/
       run: |
         $cmakeBuildType = '${{ matrix.config }}'

diff --git a/.github/workflows/macos.yml b/.github/workflows/macos.yml
@@ -9,38 +9,51 @@ jobs:
       matrix:
         config: [Debug, Release]
 
-    runs-on: macos-13
+    runs-on: macos-latest
 
     steps:
     - uses: actions/[email protected]
       with:
         submodules: true
+        fetch-depth: 0
+
+    - uses: seanmiddleditch/gha-setup-ninja@96bed6edff20d1dd61ecff9b75cc519d516e6401
 
     - name: Cache vcpkg
       uses: actions/[email protected]
       id: cache-vcpkg
       with:
         path: build/vcpkg_cache/
-        key: vcpkg-binaries-x64-osx
+        key: vcpkg-binaries-osx-${{ hashFiles('vcpkg.json') }}
 
     - name: Create Build Environment
       if: ${{ !steps.cache-vcpkg.outputs.cache-hit }}
       run: |
         cmake -E make_directory build
         cmake -E make_directory build/vcpkg_cache
 
+    - name: Boostrap vcpkg
+      shell: pwsh
+      working-directory: vcpkg/
+      run: |
+        ./bootstrap-vcpkg.sh
+        ./vcpkg integrate install
+
     - name: Configure
       shell: pwsh
+      env:
+        VCPKG_ROOT: ${{ github.workspace }}/vcpkg
       working-directory: build/
       run: |
-        $vcpkgToolchain = Join-Path $env:VCPKG_INSTALLATION_ROOT './scripts/buildsystems/vcpkg.cmake' -Resolve
+        $vcpkgToolchain = Join-Path $env:VCPKG_ROOT './scripts/buildsystems/vcpkg.cmake' -Resolve
         $cmakeBuildType = '${{ matrix.config }}'
 
         $cachedBinaries = Join-Path $(Get-Location) './vcpkg_cache/' -Resolve
         $cacheAccess = $(if ('${{ steps.cache-vcpkg.outputs.cache-hit }}' -eq 'true') { 'read' } else { 'write' })
         $env:VCPKG_BINARY_SOURCES = "clear;files,$cachedBinaries,$cacheAccess"
 
-        cmake "-DCMAKE_TOOLCHAIN_FILE=$vcpkgToolchain" "-DCMAKE_BUILD_TYPE=$cmakeBuildType" ${{ github.workspace }}
+        $env:PATH = "${env:PATH}:${{ github.workspace }}/ninja-build"
+        cmake "-DCMAKE_TOOLCHAIN_FILE=$vcpkgToolchain" "-DCMAKE_BUILD_TYPE=$cmakeBuildType" -G Ninja ${{ github.workspace }}
 
     - name: Build
       working-directory: build/

diff --git a/.github/workflows/windows.yml b/.github/workflows/windows.yml
@@ -17,6 +17,7 @@ jobs:
     - uses: actions/[email protected]
       with:
         submodules: true
+        fetch-depth: 0
 
     - name: Set target triplet
       id: set-variables
@@ -28,19 +29,28 @@ jobs:
       id: cache-vcpkg
       with:
         path: build/vcpkg_cache/
-        key: vcpkg-binaries-${{ steps.set-variables.outputs.vcpkg_triplet }}
+        key: vcpkg-binaries-${{ steps.set-variables.outputs.vcpkg_triplet }}-${{ hashFiles('vcpkg.json') }}
 
     - name: Create Build Environment
       if: ${{ !steps.cache-vcpkg.outputs.cache-hit }}
       run: |
         cmake -E make_directory build
         cmake -E make_directory build/vcpkg_cache
 
+    - name: Boostrap vcpkg
+      shell: pwsh
+      working-directory: vcpkg/
+      run: |
+        ./bootstrap-vcpkg.bat
+        ./vcpkg integrate install
+
     - name: Configure
       shell: pwsh
+      env:
+        VCPKG_ROOT: ${{ github.workspace }}\vcpkg
       working-directory: build/
       run: |
-        $vcpkgToolchain = Join-Path $env:VCPKG_INSTALLATION_ROOT '.\scripts\buildsystems\vcpkg.cmake' -Resolve
+        $vcpkgToolchain = Join-Path $env:VCPKG_ROOT './scripts/buildsystems/vcpkg.cmake' -Resolve
         $vcpkgTriplet = '${{ steps.set-variables.outputs.vcpkg_triplet }}'
         $cmakeSharedLibs = $(if ('${{ matrix.libs }}' -eq 'shared') { 'ON' } else { 'OFF' })
         $msbuildArch = $(if ('${{ matrix.arch }}' -eq 'x64') { 'X64' } else { 'Win32' })

diff --git a/.gitmodules b/.gitmodules
@@ -1,3 +1,6 @@
 [submodule "PEGTL"]
 	path = PEGTL
 	url = https://github.com/taocpp/PEGTL.git
+[submodule "vcpkg"]
+	path = vcpkg
+	url = https://github.com/microsoft/vcpkg.git
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,13 +1,12 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 
-cmake_minimum_required(VERSION 3.15)
+cmake_minimum_required(VERSION 3.28)
 
-# Enable CMAKE_MSVC_RUNTIME_LIBRARY on Windows: https://cmake.org/cmake/help/latest/policy/CMP0091.html
-cmake_policy(SET CMP0091 NEW)
-
-# Do not set default MSVC warning flags: https://cmake.org/cmake/help/latest/policy/CMP0092.html
-cmake_policy(SET CMP0092 NEW)
+if(POLICY CMP0167)
+  # Prefer the upstream BoostConfig.cmake file instead of the builtin FindBoost module: https://cmake.org/cmake/help/latest/policy/CMP0167.html
+  cmake_policy(SET CMP0167 NEW)
+endif()
 
 # Export compile commands for other tools, e.g. SonarLint.
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)

diff --git a/cmake/CMakeLists.txt b/cmake/CMakeLists.txt
@@ -1,7 +1,7 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 
-cmake_minimum_required(VERSION 3.15)
+cmake_minimum_required(VERSION 3.28)
 
 # Enable version checks in find_package
 include(CMakePackageConfigHelpers)

diff --git a/include/graphqlservice/GraphQLClient.h b/include/graphqlservice/GraphQLClient.h
@@ -6,21 +6,10 @@
 #ifndef GRAPHQLCLIENT_H
 #define GRAPHQLCLIENT_H
 
-// clang-format off
-#ifdef GRAPHQL_DLLEXPORTS
-	#ifdef IMPL_GRAPHQLCLIENT_DLL
-		#define GRAPHQLCLIENT_EXPORT __declspec(dllexport)
-	#else // !IMPL_GRAPHQLCLIENT_DLL
-		#define GRAPHQLCLIENT_EXPORT __declspec(dllimport)
-	#endif // !IMPL_GRAPHQLCLIENT_DLL
-#else // !GRAPHQL_DLLEXPORTS
-	#define GRAPHQLCLIENT_EXPORT
-#endif // !GRAPHQL_DLLEXPORTS
-// clang-format on
-
-#include "graphqlservice/GraphQLResponse.h"
-
-#include "graphqlservice/internal/Version.h"
+#include "GraphQLResponse.h"
+
+#include "internal/Version.h"
+#include "internal/DllExports.h"
 
 #include <algorithm>
 #include <iterator>

diff --git a/include/graphqlservice/GraphQLParse.h b/include/graphqlservice/GraphQLParse.h
@@ -6,17 +6,7 @@
 #ifndef GRAPHQLPARSE_H
 #define GRAPHQLPARSE_H
 
-// clang-format off
-#ifdef GRAPHQL_DLLEXPORTS
-	#ifdef IMPL_GRAPHQLPEG_DLL
-		#define GRAPHQLPEG_EXPORT __declspec(dllexport)
-	#else // !IMPL_GRAPHQLPEG_DLL
-		#define GRAPHQLPEG_EXPORT __declspec(dllimport)
-	#endif // !IMPL_GRAPHQLPEG_DLL
-#else // !GRAPHQL_DLLEXPORTS
-	#define GRAPHQLPEG_EXPORT
-#endif // !GRAPHQL_DLLEXPORTS
-// clang-format on
+#include "internal/DllExports.h"
 
 #include <memory>
 #include <string_view>

diff --git a/include/graphqlservice/GraphQLResponse.h b/include/graphqlservice/GraphQLResponse.h
@@ -6,19 +6,8 @@
 #ifndef GRAPHQLRESPONSE_H
 #define GRAPHQLRESPONSE_H
 
-// clang-format off
-#ifdef GRAPHQL_DLLEXPORTS
-	#ifdef IMPL_GRAPHQLRESPONSE_DLL
-		#define GRAPHQLRESPONSE_EXPORT __declspec(dllexport)
-	#else // !IMPL_GRAPHQLRESPONSE_DLL
-		#define GRAPHQLRESPONSE_EXPORT __declspec(dllimport)
-	#endif // !IMPL_GRAPHQLRESPONSE_DLL
-#else // !GRAPHQL_DLLEXPORTS
-	#define GRAPHQLRESPONSE_EXPORT
-#endif // !GRAPHQL_DLLEXPORTS
-// clang-format on
-
-#include "graphqlservice/internal/Awaitable.h"
+#include "internal/Awaitable.h"
+#include "internal/DllExports.h"
 
 #include <cstdint>
 #include <initializer_list>

diff --git a/include/graphqlservice/GraphQLService.h b/include/graphqlservice/GraphQLService.h
@@ -6,24 +6,13 @@
 #ifndef GRAPHQLSERVICE_H
 #define GRAPHQLSERVICE_H
 
-// clang-format off
-#ifdef GRAPHQL_DLLEXPORTS
-	#ifdef IMPL_GRAPHQLSERVICE_DLL
-		#define GRAPHQLSERVICE_EXPORT __declspec(dllexport)
-	#else // !IMPL_GRAPHQLSERVICE_DLL
-		#define GRAPHQLSERVICE_EXPORT __declspec(dllimport)
-	#endif // !IMPL_GRAPHQLSERVICE_DLL
-#else // !GRAPHQL_DLLEXPORTS
-	#define GRAPHQLSERVICE_EXPORT
-#endif // !GRAPHQL_DLLEXPORTS
-// clang-format on
-
-#include "graphqlservice/GraphQLParse.h"
-#include "graphqlservice/GraphQLResponse.h"
-
-#include "graphqlservice/internal/Awaitable.h"
-#include "graphqlservice/internal/SortedMap.h"
-#include "graphqlservice/internal/Version.h"
+#include "GraphQLParse.h"
+#include "GraphQLResponse.h"
+
+#include "internal/Awaitable.h"
+#include "internal/DllExports.h"
+#include "internal/SortedMap.h"
+#include "internal/Version.h"
 
 #include <chrono>
 #include <condition_variable>

diff --git a/include/graphqlservice/JSONResponse.h b/include/graphqlservice/JSONResponse.h
@@ -6,19 +6,9 @@
 #ifndef JSONRESPONSE_H
 #define JSONRESPONSE_H
 
-// clang-format off
-#ifdef GRAPHQL_DLLEXPORTS
-	#ifdef IMPL_JSONRESPONSE_DLL
-		#define JSONRESPONSE_EXPORT __declspec(dllexport)
-	#else // !IMPL_JSONRESPONSE_DLL
-		#define JSONRESPONSE_EXPORT __declspec(dllimport)
-	#endif // !IMPL_JSONRESPONSE_DLL
-#else // !GRAPHQL_DLLEXPORTS
-	#define JSONRESPONSE_EXPORT
-#endif // !GRAPHQL_DLLEXPORTS
-// clang-format on
-
-#include "graphqlservice/GraphQLResponse.h"
+#include "GraphQLResponse.h"
+
+#include "internal/DllExports.h"
 
 namespace graphql::response {
 

diff --git a/include/graphqlservice/internal/Base64.h b/include/graphqlservice/internal/Base64.h
@@ -6,17 +6,7 @@
 #ifndef GRAPHQLBASE64_H
 #define GRAPHQLBASE64_H
 
-// clang-format off
-#ifdef GRAPHQL_DLLEXPORTS
-	#ifdef IMPL_GRAPHQLRESPONSE_DLL
-		#define GRAPHQLRESPONSE_EXPORT __declspec(dllexport)
-	#else // !IMPL_GRAPHQLRESPONSE_DLL
-		#define GRAPHQLRESPONSE_EXPORT __declspec(dllimport)
-	#endif // !IMPL_GRAPHQLRESPONSE_DLL
-#else // !GRAPHQL_DLLEXPORTS
-	#define GRAPHQLRESPONSE_EXPORT
-#endif // !GRAPHQL_DLLEXPORTS
-// clang-format on
+#include "DllExports.h"
 
 #include <cstdint>
 #include <string>

diff --git a/include/graphqlservice/internal/DllExports.h b/include/graphqlservice/internal/DllExports.h
@@ -0,0 +1,49 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+#pragma once
+
+#ifndef DLLEXPORTS_H
+#define DLLEXPORTS_H
+
+// clang-format off
+#ifdef GRAPHQL_DLLEXPORTS
+	#ifdef IMPL_GRAPHQLCLIENT_DLL
+		#define GRAPHQLCLIENT_EXPORT __declspec(dllexport)
+	#else // !IMPL_GRAPHQLCLIENT_DLL
+		#define GRAPHQLCLIENT_EXPORT __declspec(dllimport)
+	#endif // !IMPL_GRAPHQLCLIENT_DLL
+
+	#ifdef IMPL_GRAPHQLPEG_DLL
+		#define GRAPHQLPEG_EXPORT __declspec(dllexport)
+	#else // !IMPL_GRAPHQLPEG_DLL
+		#define GRAPHQLPEG_EXPORT __declspec(dllimport)
+	#endif // !IMPL_GRAPHQLPEG_DLL
+
+	#ifdef IMPL_GRAPHQLRESPONSE_DLL
+		#define GRAPHQLRESPONSE_EXPORT __declspec(dllexport)
+	#else // !IMPL_GRAPHQLRESPONSE_DLL
+		#define GRAPHQLRESPONSE_EXPORT __declspec(dllimport)
+	#endif // !IMPL_GRAPHQLRESPONSE_DLL
+
+	#ifdef IMPL_GRAPHQLSERVICE_DLL
+		#define GRAPHQLSERVICE_EXPORT __declspec(dllexport)
+	#else // !IMPL_GRAPHQLSERVICE_DLL
+		#define GRAPHQLSERVICE_EXPORT __declspec(dllimport)
+	#endif // !IMPL_GRAPHQLSERVICE_DLL
+
+	#ifdef IMPL_JSONRESPONSE_DLL
+		#define JSONRESPONSE_EXPORT __declspec(dllexport)
+	#else // !IMPL_JSONRESPONSE_DLL
+		#define JSONRESPONSE_EXPORT __declspec(dllimport)
+	#endif // !IMPL_JSONRESPONSE_DLL
+#else // !GRAPHQL_DLLEXPORTS
+	#define GRAPHQLCLIENT_EXPORT
+	#define GRAPHQLPEG_EXPORT
+	#define GRAPHQLRESPONSE_EXPORT
+	#define GRAPHQLSERVICE_EXPORT
+	#define JSONRESPONSE_EXPORT
+#endif // !GRAPHQL_DLLEXPORTS
+// clang-format on
+
+#endif // DLLEXPORTS_H
diff --git a/include/graphqlservice/internal/Grammar.h b/include/graphqlservice/internal/Grammar.h
@@ -9,7 +9,7 @@
 #ifndef GRAPHQLGRAMMAR_H
 #define GRAPHQLGRAMMAR_H
 
-#include "graphqlservice/internal/SyntaxTree.h"
+#include "SyntaxTree.h"
 
 #include <functional>
 

diff --git a/include/graphqlservice/internal/Introspection.h b/include/graphqlservice/internal/Introspection.h
@@ -8,7 +8,8 @@
 
 #include "graphqlservice/introspection/IntrospectionSchema.h"
 
-#include "graphqlservice/internal/Schema.h"
+#include "DllExports.h"
+#include "Schema.h"
 
 namespace graphql::introspection {
 

diff --git a/include/graphqlservice/internal/Schema.h b/include/graphqlservice/internal/Schema.h
@@ -6,9 +6,15 @@
 #ifndef GRAPHQLSCHEMA_H
 #define GRAPHQLSCHEMA_H
 
-#include "graphqlservice/GraphQLService.h"
+#include "DllExports.h"
+#include "SortedMap.h"
+#include "Version.h"
 
+#include <memory>
+#include <optional>
 #include <shared_mutex>
+#include <string_view>
+#include <vector>
 
 namespace graphql {
 namespace introspection {