aboutsummaryrefslogtreecommitdiffstats
path: root/.github/workflows/tests.yml
blob: 9673c5dda75d95d2315f48147a4fc60728cfc97b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
# Copyright (c) 2023 Sebastian Pipping <sebastian@pipping.org>
# Licensed under GPL v2 or later

name: Build and test

on:
  pull_request:
  push:
  schedule:
    - cron: '0 3 * * 5'  # Every Friday at 3am
  workflow_dispatch:

# Minimum permissions for security
permissions:
  contents: read

jobs:
  tests:
    name: Build (${{ matrix.cc }} and ${{ matrix.fuse_package }} on ${{ matrix.runs-on }})
    runs-on: ${{ matrix.runs-on }}
    strategy:
      fail-fast: false
      matrix:
        include:
          # FUSE 2
          - cc: gcc
            cxx: g++
            clang_major_version: null
            runs-on: ubuntu-22.04
            fuse_package: libfuse-dev
          # FUSE 3
          - cc: gcc
            cxx: g++
            clang_major_version: null
            runs-on: ubuntu-22.04
            fuse_package: libfuse3-dev
          - cc: clang-17
            cxx: clang++-17
            clang_major_version: 17
            runs-on: ubuntu-22.04
            fuse_package: libfuse3-dev
          - cc: clang-18
            cxx: clang++-18
            clang_major_version: 18
            runs-on: ubuntu-22.04
            fuse_package: libfuse3-dev
          # fuse-t, gcc
          - cc: gcc
            cxx: g++
            clang_major_version: null
            runs-on: macos-15
            fuse_package: fuse-t
          # fuse-t, clang
          - cc: clang
            cxx: clang++
            clang_major_version: null
            runs-on: macos-15
            fuse_package: fuse-t
    steps:
      - name: Add Clang/LLVM repositories
        if: "${{ runner.os == 'Linux' && contains(matrix.cxx, 'clang') }}"
        run: |-
          set -x
          source /etc/os-release
          wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
          sudo add-apt-repository "deb http://apt.llvm.org/${UBUNTU_CODENAME}/ llvm-toolchain-${UBUNTU_CODENAME}-${{ matrix.clang_major_version }} main"

      - name: Install build dependencies
        if: "${{ runner.os == 'Linux' }}"
        run: |-
          sudo apt-get update
          sudo apt-get install --yes --no-install-recommends \
            autoconf \
            automake \
            ${{ matrix.fuse_package }} \
            libtool \
            pkg-config \
            valgrind

      - name: Install build dependencies
        if: "${{ runner.os == 'macOS' }}"
        run: |-
          set -x

          # Installing MacFUSE requires visiting the MacOS recovery environment,
          # so testing it in CI seems to be hopeless. Therefore we only test with fuse-t.
          # Apparently the best security is making it so inconvenient that you can't run the thing at all.
          if [[ ${{ matrix.fuse_package }} = fuse-t ]]; then
            sudo mkdir -p /usr/local/include  # https://github.com/macos-fuse-t/fuse-t/issues/77
            brew tap macos-fuse-t/homebrew-cask
            brew install fuse-t
          else
            false  # should never get here
          fi

          brew install \
            autoconf \
            automake \
            libtool \
            pkg-config

      - name: Install build dependency Clang ${{ matrix.clang_major_version }}
        if: "${{ runner.os == 'Linux' && contains(matrix.cxx, 'clang') }}"
        run: |-
          sudo apt-get install --yes --no-install-recommends -V \
              clang-${{ matrix.clang_major_version }}

      - name: Add versioned aliases for Clang ${{ matrix.clang_major_version }}
        if: "${{ runner.os == 'macOS' && matrix.clang_major_version != null }}"
        run: |-
          set -x
          sudo ln -s "$(brew --prefix llvm@${{ matrix.clang_major_version }})"/bin/clang   /usr/local/bin/clang-${{ matrix.clang_major_version }}
          sudo ln -s "$(brew --prefix llvm@${{ matrix.clang_major_version }})"/bin/clang++ /usr/local/bin/clang++-${{ matrix.clang_major_version }}

      - name: Checkout Git branch
        uses: actions/checkout@v4

      - name: 'Bootstrap with ./autogen.sh'
        run: |-
          ./autogen.sh

      - name: 'Configure'
        env:
          CC: ${{ matrix.cc }}
          CXX: ${{ matrix.cxx }}
          CFLAGS: -Werror
        run: |-
          set -x
          ./configure

      - name: 'Build'
        run: |-
          set -x
          cpu_threads="$(nproc 2>/dev/null || sysctl -n hw.logicalcpu || echo 4)"
          make "-j${cpu_threads}" VERBOSE=1

      - name: 'Test as non-root'
        run: |-
          set -x
          whoami
          make check

      - name: 'Test as root'
        run: |-
          set -x
          sudo make check

      - name: 'Install'
        run: |-
          set -x -o pipefail
          make install DESTDIR="${PWD}"/ROOT/
          find ROOT/ | sort | xargs ls -ld

  vagrant:
    name: Run Vagrant tests
    runs-on: ubuntu-24.04
    strategy:
      fail-fast: false
      matrix:
        # TODO: automatically check that this list is up-to-date
        box:
          - debian10
          - debian11
          - freebsd14
          - rockylinux9
          - ubuntu2004
          - ubuntu2204
          - ubuntu2404
    steps:
      - name: Install dependencies
        run: |-
          set -x
          sudo sed -i 's/Types: deb/Types: deb deb-src/' /etc/apt/sources.list.d/ubuntu.sources

          # The following is based on these instructions:
          # https://developer.hashicorp.com/vagrant/install?product_intent=vagrant
          # https://vagrant-libvirt.github.io/vagrant-libvirt/installation.html

          wget -O - https://apt.releases.hashicorp.com/gpg | sudo gpg --dearmor -o /usr/share/keyrings/hashicorp-archive-keyring.gpg
          echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/hashicorp-archive-keyring.gpg] https://apt.releases.hashicorp.com $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/hashicorp.list
          sudo apt-get update
          sudo apt-get build-dep ruby-libvirt
          sudo apt-get install -y vagrant \
            qemu-system-x86 \
            autoconf automake libtool pkg-config \
            libvirt-daemon-system ebtables libguestfs-tools \
            libxslt-dev libxml2-dev zlib1g-dev ruby ruby-dev
          sudo vagrant plugin install vagrant-libvirt

      - name: Checkout Git branch
        uses: actions/checkout@v4

      - name: Check for KVM
        run: |-
          # This check is probably obsolete now: https://github.com/actions/runner-images/discussions/7191
          if [[ -e /dev/kvm ]]; then
            echo "This GitHub Action runner has KVM. This run will be fast."
          else
            echo "This GitHub Action runner does NOT have KVM. This run will be slow."
          fi

      - name: Test with Vagrant box ${{ matrix.box }}
        env:
          VAGRANT_DEFAULT_PROVIDER: libvirt
        run: |-
          # We use vagrant with sudo because it has proven stupendously difficult to
          # get the current shell into group "libvirt" in a way that Vagrant is happy with.
          # https://github.com/actions/runner-images/discussions/5981
          sudo chmod a+rx /root  # Give libvirt access to /root/.vagrant.d which is about to be created
          sudo ruby vagrant/test.rb --print-logs ${{ matrix.box }}