Tidy up and first stab at Mac packaging fixes

.github/workflows/linux-ubuntu.yml

@@ -35,44 +35,92 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-18.04, ubuntu-latest]
+        #
+        # See https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources
+        # for info on runner images
+        #
+        # Usually "ubuntu-latest" is the most recent LTS version of Ubuntu, but there can be a bit of lag between a new
+        # LTS release and the update of ubuntu-latest (eg in October 2022, it was still Ubuntu 20.04 rather than 22.04).
+        # So we explicitly specify here which versions we want to build on.
+        #
+        os: [ubuntu-20.04, ubuntu-22.04]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           fetch-depth: 0
 
+      #
       # See https://github.com/Brewken/brewken/wiki/Development:-Getting-Started for more on what is needed to build
       # the software.  It seems we can assume the following packages are already installed:
       #    cmake
       #    git
       #    debhelper
       #    rpm
+      #
+      # Note that we need CMake even for the Meson build because meson uses CMake as one of its library-finding tools
+      #
+      # Some of the things below could be installed via actions (jurplel/install-qt-action@v3) but there's an advantage,
+      # where we can, in doing the exact same steps that give as instructions to developers to set up their build
+      # environment.
+      #
+      # Note that we need Python 3.10 or newer, which means you can't just use `sudo apt install` on older Ubuntus.  (Eg
+      # Ubuntu 18.04 packages have only Python 3.6.7 and Ubuntu 20.04 only have Python 3.8.2.  However Ubuntu 22.04 has
+      # Python 3.10.6.)  There are ways to get around this, but, in this context, it's simplest to use a canned GitHub
+      # action.
+      #
+      # Similarly, Ubuntu 20.04 packages only have Meson 0.53.2, and we need 0.56.0 or later.  In this case it means we
+      # have to install Meson via pip, which is not ideal on Linux (per comments in meson.build).
+      #    sudo apt-get update && sudo apt-get install -y \
+      #      libqt5multimedia5-plugins \
+      #      libqt5sql5-psql \
+      #      libqt5sql5-sqlite \
+      #      libqt5svg5-dev \
+      #      libxalan-c-dev \
+      #      libxerces-c-dev \
+      #      lintian \
+      #      meson \
+      #      ninja-build \
+      #      python3 \
+      #      qtbase5-dev \
+      #      qtmultimedia5-dev \
+      #      qttools5-dev \
+      #      qttools5-dev-tools \
+      #      rpmlint
+      #    cd ~
+      #    mkdir ~/boost-tmp
+      #    cd ~/boost-tmp
+      #    wget https://boostorg.jfrog.io/artifactory/main/release/1.80.0/source/boost_1_80_0.tar.bz2
+      #    tar --bzip2 -xf boost_1_80_0.tar.bz2
+      #    cd boost_1_80_0
+      #    ./bootstrap.sh
+      #    sudo ./b2 install
+      #    cd ~
+      #    sudo rm -rf ~/boost-tmp
+      #
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
       - name: Install Frameworks and Libraries
+        working-directory: ${{github.workspace}}
+        shell: bash
+        run: |
+          pwd
+          ./bt -v setup all
+          if [[ $(lsb_release -r | awk '{print $2}' | awk -F. '{print $1}') -lt 22 ]]
+          then
+            sudo apt remove -y meson
+            sudo pip3 install meson
+          fi
+          ls -l /usr/local/lib/libboost_*
+
+      - name: Setup Build Environment (New)
+        working-directory: ${{github.workspace}}
+        # I'm sure there's a better way to invoke this script, but I haven't yet discovered it
         shell: bash
         run: |
-          sudo apt-get update && sudo apt-get install -y \
-            libqt5multimedia5-plugins \
-            libqt5sql5-psql \
-            libqt5sql5-sqlite \
-            libqt5svg5-dev \
-            libxalan-c-dev \
-            libxerces-c-dev \
-            lintian \
-            qtbase5-dev \
-            qtmultimedia5-dev \
-            qttools5-dev \
-            qttools5-dev-tools \
-            rpmlint
-          cd ~
-          mkdir ~/boost-tmp
-          cd ~/boost-tmp
-          wget https://boostorg.jfrog.io/artifactory/main/release/1.79.0/source/boost_1_79_0.tar.bz2
-          tar --bzip2 -xf boost_1_79_0.tar.bz2
-          cd boost_1_79_0
-          ./bootstrap.sh --prefix=/usr
-          sudo ./b2 install
-          cd ~
-          sudo rm -rf ~/boost-tmp
+          export BOOST_ROOT=/usr
+          ls -l /usr/lib
+          python3 bt setup
 
       - name: Create Build Environment
         run: cmake -E make_directory ${{github.workspace}}/build
@@ -96,6 +144,13 @@ jobs:
           find ../third-party
           make
 
+      - name: Build (New)
+        working-directory: ${{github.workspace}}/mbuild
+        shell: bash
+        run: |
+          pwd
+          meson compile
+
       - name: Test
         working-directory: ${{github.workspace}}/build
         shell: bash
@@ -105,13 +160,26 @@ jobs:
         run: |
           make test
 
+      - name: Test (New)
+        working-directory: ${{github.workspace}}/mbuild
+        shell: bash
+        run: |
+          meson test
+
       - name: Package
         working-directory: ${{github.workspace}}/build
         shell: bash
         run: |
           umask 022
           make package
 
+      - name: Package (New)
+        working-directory: ${{github.workspace}}/mbuild
+        shell: bash
+        run: |
+          umask 022
+          ../bt package
+
       - name: LintianAndRpmLint
         continue-on-error: true
         working-directory: ${{github.workspace}}/build
@@ -120,7 +188,7 @@ jobs:
 
       - name: Upload Linux Packages (Installers)
         if: ${{ success() }}
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: brewken-${{matrix.os}}
           path: |
@@ -134,7 +202,7 @@ jobs:
 
       - name: Recover Debris Artifacts
         if: ${{ failure() }}
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: build-results-${{matrix.os}}
           path: build

.github/workflows/mac.yml

@@ -38,33 +38,60 @@ jobs:
 
     steps:
 
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         fetch-depth: 0
 
     - name: Install Qt
-      uses: jurplel/install-qt-action@v2
+      # Version 5.15.2 is, according to https://github.com/jurplel/install-qt-action, the last Qt 5 LTS
+      # When we're ready to migrate to Qt 6, we'll need to tweak this
+      uses: jurplel/install-qt-action@v3
       with:
-          version: 5.9.5
+        version: 5.15.2
+
+    - name: Install Python
+      # TBD We could probably also install this with brew below
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
 
     - name: Install dependencies
+      #
       # Installing Xalan-C will cause Xerces-C to be installed too (as the former depends on the latter)
+      #
+      # Similarly, installing meson will cause ninja to be installed (and confirm that Python is installed)
+      #
       # .:TBD:. Installing Boost here doesn't seem to give us libboost_stacktrace_backtrace
       #         Also, trying to use the "--cc=clang" option to install boost gives an error ("Error: boost: no bottle
       #         available!")  For the moment, we're just using Boost header files on Mac though, so this should be OK.
+      #
+      # The `brew doctor` command just checks that Homebrew (https://brew.sh/) is installed OK (expected output is "Your
+      # system is ready to brew".  Having Homebrew installed should imply the Xcode Command Line Tools are also
+      # installed, but `xcode-select -p` confirms this (expected output "/Library/Developer/CommandLineTools").  As
+      # elsewhere we use the echo trick to ensure that a non-zero return value from these diagnostic commands is not
+      # treated as a build script failure.
+      #
+      # We use the tree command for diagnosing certain build problems (specifically to see what changes certain parts of
+      # the build have made to the build directory tree).  (If need be, you can also download the entire build directory
+      # within a day of a failed build running, but you need a decent internet connection for this as it's quite large.)
+      #
       run: |
+        echo "Output from brew doctor: $(brew doctor)"
+        echo "Output from xcode-select -p: $(xcode-select -p)"
+        brew install meson
         brew install xalan-c
         brew install boost
+        brew install tree
 
     - name: Build
       env:
         QT_QPA_PLATFORM: offscreen
+      # Change `make` to `make VERBOSE=1` to get hugely detailed output
       run: |
         mkdir build
         cd build
         cmake ..
         make
-        ls -ltr
 
     - name: Prep for tests
       # If a test fails and we get a core, we'd like to analyse it.  This will be easier if we have access to the
@@ -93,52 +120,61 @@ jobs:
         ctest --extra-verbose --output-on-failure 2>&1
 
     - name: Make package
+      # Change `make package` to `make package VERBOSE=1` to get hugely detailed output
       run: |
         cd build
+        pwd
         make package
-        ls -ltr
+        pwd
+        tree -sh
 
     - name: Upload Mac Packages (Installers)
       if: ${{ success() }}
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: brewken-dev-mac
         path: |
           ${{github.workspace}}/build/brewken*.dmg
           ${{github.workspace}}/build/brewken*.dmg.sha256
         retention-days: 7
 
-    - name: Post-processing on cores
+    - name: Post-processing on any core dump
       if: ${{ failure() }}
       # It's all very well capturing core files, but if you don't have a Mac to analyse them on they are not a fat lot
       # of use.  So, if we did get a core, let's at least get a stack trace out of it.
+      #
+      # The loop in the last line should run either 0 or 1 times, depending on whether the build failure did or did not
+      # generate a core file.
+      #    ls -1 | while read ii; do echo "bt" | lldb -c $ii; done
       run: |
+        pwd
+        tree -sh
         sudo chmod -R +rwx /cores
         sudo chmod -R +rwx /Library/Logs/DiagnosticReports
         echo "Contents of /cores directory: $(ls -ltr /cores)"
         echo "Contents of /Library/Logs/DiagnosticReports directory: $(ls -ltr /Library/Logs/DiagnosticReports)"
         cd /cores
-        echo "bt" | lldb -c $(ls -1)
+        ls -1 | while read ii; do echo "bt" | lldb -c $ii; done
 
     - name: Recover Debris Artifacts (aka build output)
       if: ${{ failure() }}
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: build-results
         path: ${{github.workspace}}/build
         retention-days: 1
 
     - name: Recover DiagnosticReports (if any)
       if: ${{ failure() }}
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: DiagnosticReports
         path: /Library/Logs/DiagnosticReports
         retention-days: 1
 
     - name: Recover Cores (if any)
       if: ${{ failure() }}
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: cores
         path: /cores

.github/workflows/windows.yml

@@ -46,7 +46,7 @@ jobs:
         ]
     steps:
 
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           path: temp
           fetch-depth: 0
@@ -62,7 +62,10 @@ jobs:
             mingw-w64-${{ matrix.arch }}-gcc
             mingw-w64-${{ matrix.arch }}-libbacktrace
             mingw-w64-${{ matrix.arch }}-make
+            mingw-w64-${{ matrix.arch }}-meson
+            mingw-w64-${{ matrix.arch }}-ninja
             mingw-w64-${{ matrix.arch }}-nsis
+            mingw-w64-${{ matrix.arch }}-python
             mingw-w64-${{ matrix.arch }}-qt5
             mingw-w64-${{ matrix.arch }}-xalan-c
             mingw-w64-${{ matrix.arch }}-xerces-c
@@ -115,7 +118,7 @@ jobs:
 
       - name: Upload Windows binaries (installers)
         if: ${{ success()}}
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: brewken-dev-${{ matrix.msystem }}
           path: |
@@ -125,7 +128,7 @@ jobs:
 
       - name: Upload error info from failed build
         if: ${{ failure() }}
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: ${{ matrix.msystem }}-build
           path: C:/_/build/