ci: Add CMake CI for macOS

Other changes:
* Prevent known warnings from being treated as errors on macOS
* Fix berkdb configure on macOS
* Fix GUI build on macOS

Author: CyberTailor

.github/workflows/cmake-ci.yml

@@ -9,7 +9,8 @@ jobs:
         runs-on: ubuntu-latest
         env:
             CCACHE_DIR: ${{github.workspace}}/ccache
-            CCACHE_MAXSIZE: 100M
+            CCACHE_MAXSIZE: 400M
+            CCACHE_COMPILERCHECK: content
         strategy:
             matrix:
                 tag:
@@ -22,21 +23,28 @@ jobs:
                       deps: null
                       options: -DENABLE_PIE=ON -DUSE_ASM=OFF
                     - tag: gui-full
-                      deps: |
+                      deps: >-
                           libminiupnpc-dev
                           libqrencode-dev
                           qtbase5-dev
                           qttools5-dev
-                      options: -DENABLE_GUI=ON -DENABLE_QRENCODE=ON -DENABLE_UPNP=ON -DUSE_DBUS=ON
+                      options: >-
+                          -DENABLE_GUI=ON
+                          -DENABLE_QRENCODE=ON
+                          -DENABLE_UPNP=ON
+                          -DUSE_DBUS=ON
                     - tag: system-libs
-                      deps: |
+                      deps: >-
                           libdb5.3++-dev
                           libleveldb-dev
                           libsnappy-dev
                           libsecp256k1-dev
                           libunivalue-dev
                           xxd
-                      options: -DSYSTEM_BDB=ON -DSYSTEM_LEVELDB=ON -DSYSTEM_UNIVALUE=ON
+                      options: >-
+                          -DSYSTEM_BDB=ON
+                          -DSYSTEM_LEVELDB=ON
+                          -DSYSTEM_UNIVALUE=ON
         steps:
             - name: Checkout
               uses: actions/checkout@v3
@@ -73,6 +81,7 @@ jobs:
                       -DENABLE_TESTS=ON
             - name: Restore cache
               uses: actions/cache/restore@v3
+              if: always()
               with:
                   path: ${{env.CCACHE_DIR}}
                   key: ccache-linux-${{matrix.tag}}-${{github.run_id}}
@@ -83,6 +92,7 @@ jobs:
                   cmake --build ${{github.workspace}}/build -v -j $(nproc)
             - name: Save cache
               uses: actions/cache/save@v3
+              if: always()
               with:
                   path: ${{env.CCACHE_DIR}}
                   key: ccache-linux-${{matrix.tag}}-${{github.run_id}}
@@ -96,3 +106,89 @@ jobs:
                   name: testlog-linux-${{matrix.tag}}
                   path: ${{github.workspace}}/build/Testing/Temporary/LastTest.log
                   retention-days: 7
+
+    test-macos:
+        runs-on: macos-latest
+        env:
+            CCACHE_DIR: ${{github.workspace}}/ccache
+            CCACHE_MAXSIZE: 400M
+            CCACHE_COMPILERCHECK: content
+        strategy:
+            matrix:
+                tag:
+                    - minimal
+                    - no-asm
+                    - gui-full
+                    - system-libs
+                include:
+                    - tag: no-asm
+                      deps: null
+                      options: -DENABLE_PIE=ON -DUSE_ASM=OFF
+                    - tag: gui-full
+                      deps: >-
+                          miniupnpc
+                          qrencode
+                          qt@5
+                      options: >-
+                          -DENABLE_GUI=ON
+                          -DQt5_DIR=/usr/local/opt/qt5/lib/cmake/Qt5
+                          -DENABLE_QRENCODE=ON
+                          -DENABLE_UPNP=ON
+                    - tag: system-libs
+                      deps: >-
+                          berkeley-db@5
+                          secp256k1
+                          vim
+                      options: >-
+                          -DSYSTEM_BDB=ON
+                          -DBerkeleyDB_INCLUDE_DIR=/usr/local/opt/berkeley-db@5/include
+                          -DBerkeleyDB_CXX_LIBRARY=/usr/local/opt/berkeley-db@5/lib/libdb_cxx.dylib
+                          -DSYSTEM_SECP256K1=ON
+                          -DSYSTEM_XXD=ON
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v3
+            - name: Install dependencies
+              run: |
+                  brew install boost ccache ninja ${{matrix.deps}}
+            - name: Configure
+              run: |
+                  PKG_CONFIG_PATH="/usr/local/opt/openssl@3/lib/pkgconfig:${PKG_CONFIG_PATH}"
+                  export PKG_CONFIG_PATH
+
+                  pushd src
+                  ../contrib/nomacro.pl
+                  popd
+
+                  cmake -B ${{github.workspace}}/build -G Ninja \
+                      -DCMAKE_C_COMPILER_LAUNCHER=ccache \
+                      -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
+                      ${{matrix.options}} \
+                      -DENABLE_TESTS=ON
+            - name: Restore cache
+              uses: actions/cache/restore@v3
+              if: always()
+              with:
+                  path: ${{env.CCACHE_DIR}}
+                  key: ccache-macos-${{matrix.tag}}-${{github.run_id}}
+                  restore-keys: |
+                      ccache-macos-${{matrix.tag}}-
+            - name: Build
+              run: |
+                  cmake --build ${{github.workspace}}/build -v -j $(sysctl -n hw.logicalcpu)
+            - name: Save cache
+              uses: actions/cache/save@v3
+              if: always()
+              with:
+                  path: ${{env.CCACHE_DIR}}
+                  key: ccache-macos-${{matrix.tag}}-${{github.run_id}}
+            - name: Run tests
+              run: |
+                  ctest --test-dir ${{github.workspace}}/build -j $(sysctl -n hw.logicalcpu)
+            - name: Upload test logs
+              uses: actions/upload-artifact@v3
+              if: always()
+              with:
+                  name: testlog-macos-${{matrix.tag}}
+                  path: ${{github.workspace}}/build/Testing/Temporary/LastTest.log
+                  retention-days: 7

CMakeLists.txt

@@ -174,6 +174,13 @@ endif()
 
 set(CMAKE_POSITION_INDEPENDENT_CODE ${ENABLE_PIE})
 
+# Set compiler flags
+if (APPLE)
+    add_compile_options(-Wno-error=deprecated-declarations)
+    add_compile_options(-Wno-error=thread-safety-analysis)
+    add_compile_options(-Wno-error=thread-safety-reference)
+endif()
+
 # Set endianness
 if(CMAKE_CXX_BYTE_ORDER EQUAL BIG_ENDIAN)
     set(WORDS_BIGENDIAN 1)

doc/build-macos.md

@@ -50,6 +50,7 @@ brew install cmake
 brew install automake libtool
 
 brew install berkeley-db@5 boost curl leveldb libzip openssl pkgconf secp256k1
+export PKG_CONFIG_PATH="${PKG_CONFIG_PATH}:/usr/local/opt/openssl@3/lib/pkgconfig"
 ```
 
 ### 4. Clone Gridcoin repository
@@ -165,7 +166,11 @@ pip3 install ds_store mac_alias
 
      ```shell
      mkdir build && cd build
+
      cmake ..
+     # or, to configure with GUI
+     cmake .. -DENABLE_GUI=ON -DQt5_DIR=/usr/local/opt/qt5/lib/cmake/Qt5
+
      cmake --build .
      ```
    * With Autotools:

src/bdb53/CMakeLists.txt

@@ -13,6 +13,11 @@ if(ENABLE_PIE)
         --with-pic
     )
 endif()
+if(APPLE)
+    list(APPEND BDB_FLAGS
+        CFLAGS=-Wno-implicit-function-declaration
+    )
+endif()
 if(MINGW)
     list(APPEND BDB_FLAGS
         --enable-mingw

src/gridcoin/voting/registry.cpp

@@ -734,7 +734,11 @@ const PollRegistry::Sequence PollRegistry::Polls() const
 {
     LOCK(GetPollRegistry().cs_poll_registry);
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wthread-safety-reference"
     return Sequence(m_polls);
+#pragma clang diagnostic pop
+
 }
 
 const PollReference* PollRegistry::TryLatestActive() const EXCLUSIVE_LOCKS_REQUIRED(PollRegistry::cs_poll_registry)

src/gridcoin/voting/result.cpp

@@ -920,7 +920,10 @@ class VoteCounter
             throw InvalidVoteError();
         }
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wthread-safety-analysis"
         ProcessLegacyVote(candidate.LegacyVote());
+#pragma clang diagnostic pop
     }
 
     //!

src/qt/CMakeLists.txt

@@ -99,6 +99,12 @@ add_library(gridcoinqt STATIC
 
 if(WIN32)
     target_sources(gridcoinqt PRIVATE res/gridcoinresearch.rc)
+elseif(APPLE)
+    target_sources(gridcoinqt PRIVATE
+        macdockiconhandler.mm
+        macnotificationhandler.mm
+        macos_appnap.mm
+    )
 endif()
 
 set_target_properties(gridcoinqt PROPERTIES
@@ -136,6 +142,14 @@ target_link_libraries(gridcoinqt PUBLIC
     gridcoin_util
 )
 
+if(APPLE)
+    target_link_libraries(gridcoinqt PUBLIC
+        "-framework Foundation"
+        "-framework ApplicationServices"
+        "-framework AppKit"
+    )
+endif()
+
 target_compile_definitions(gridcoinqt PUBLIC HAVE_CONFIG_H)
 
 if(USE_DBUS)
@@ -158,14 +172,6 @@ add_dependencies(gridcoinqt gridcoinqt_l10n)
 
 add_executable(gridcoinresearch WIN32 MACOSX_BUNDLE bitcoin.cpp)
 
-if(APPLE)
-    target_sources(gridcoinresearch PRIVATE
-        macdockiconhandler.mm
-        macnotificationhandler.mm
-        macos_appnap.mm
-    )
-endif()
-
 target_link_libraries(gridcoinresearch PRIVATE
     Qt5::Widgets
     gridcoin_util

src/rpc/voting.cpp

@@ -569,9 +569,13 @@ UniValue getpollresults(const UniValue& params, bool fHelp)
 
     // We only need to lock the registry to retrieve the reference. If there is a reorg during the PollResultToJson, it will
     // throw.
-    if (const PollReference* ref = WITH_LOCK(GetPollRegistry().cs_poll_registry, return TryPollByTitleOrId(title_or_id))) {
+
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wthread-safety-analysis"
+   if (const PollReference* ref = WITH_LOCK(GetPollRegistry().cs_poll_registry, return TryPollByTitleOrId(title_or_id))) {
         return PollResultToJson(*ref);
     }
+#pragma clang diagnostic pop
 
     throw JSONRPCError(RPC_MISC_ERROR, "No matching poll found");
 }
@@ -722,9 +726,12 @@ UniValue votedetails(const UniValue& params, bool fHelp)
 
     // We only need to lock the registry to retrieve the reference. If there is a reorg during the PollResultToJson, it will
     // throw.
-    if (const PollReference* ref = WITH_LOCK(GetPollRegistry().cs_poll_registry, return TryPollByTitleOrId(title_or_id))) {
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wthread-safety-analysis"
+   if (const PollReference* ref = WITH_LOCK(GetPollRegistry().cs_poll_registry, return TryPollByTitleOrId(title_or_id))) {
         return VoteDetailsToJson(*ref);
     }
+#pragma clang diagnostic pop
 
     throw JSONRPCError(RPC_MISC_ERROR, "No matching poll found");
 }

src/script.cpp

@@ -3,8 +3,6 @@
 // Distributed under the MIT/X11 software license, see the accompanying
 // file COPYING or https://opensource.org/licenses/mit-license.php.
 
-using namespace std;
-
 #include "script.h"
 #include <crypto/sha1.h>
 #include "keystore.h"
@@ -18,6 +16,8 @@ using namespace std;
 
 #include <stdexcept>
 
+using namespace std;
+
 CScriptID::CScriptID(const CScript& in) : BaseHash(Hash160(in)) {}
 //CScriptID::CScriptID(const ScriptHash& in) : BaseHash(static_cast<uint160>(in)) {}
 

src/serialize.h

@@ -732,7 +732,10 @@ template<typename Stream, typename T> void Unserialize(Stream& os, std::unique_p
 template<typename Stream, typename T>
 inline void Serialize(Stream& os, const T& a)
 {
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wthread-safety-analysis"
     a.Serialize(os);
+#pragma clang diagnostic pop
 }
 
 template<typename Stream, typename T>