Add CI test to ensure installation manifest is correct (#630)

NWilson · web-flow · commit 5b3edae9d255 · 2024-12-18T12:02:23.000Z
The new CI job ensures that `make distcheck` passes.

It also bundles up the tarball and includes in the GitHub artifacts, along with a GitHub-provided attestation that the tarball is derived from the given build steps.
diff --git a/.gitattributes b/.gitattributes
@@ -1 +1,2 @@
-testdata/*    -text
+testdata/*        -text
+maint/manifest-*  -text
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -45,6 +45,11 @@ jobs:
       - name: Test (pcre2posix program)
         run: ./pcre2posix_test -v
 
+      - name: Install
+        run: |
+          make install "DESTDIR=`pwd`/install-dir"
+          maint/RunManifestTest install-dir maint/manifest-makeinstall-linux
+
   alpine:
     name: alpine
     runs-on: ubuntu-latest
@@ -79,6 +84,11 @@ jobs:
       - name: Test (pcre2posix program)
         run: ./pcre2posix_test -v
 
+      - name: Install
+        run: |
+          make install "DESTDIR=`pwd`/install-dir"
+          maint/RunManifestTest install-dir maint/manifest-makeinstall-linux
+
   macos:
     name: macOS universal
     runs-on: macos-latest
@@ -89,14 +99,20 @@ jobs:
           submodules: true
 
       - name: Configure
-        run: cmake -DPCRE2_SUPPORT_JIT=ON -DPCRE2_BUILD_PCRE2_16=ON -DPCRE2_BUILD_PCRE2_32=ON -DPCRE2_SUPPORT_LIBZ=ON -DPCRE2_SUPPORT_LIBBZ2=ON -DCMAKE_OSX_ARCHITECTURES='arm64;x86_64' -DCMAKE_C_FLAGS='-Wall -Wextra' -DCMAKE_COMPILE_WARNING_AS_ERROR=ON -DCMAKE_BUILD_TYPE=Release -B build
+        run: cmake -DPCRE2_SUPPORT_JIT=ON -DPCRE2_BUILD_PCRE2_16=ON -DPCRE2_BUILD_PCRE2_32=ON -DPCRE2_SUPPORT_LIBZ=ON -DPCRE2_SUPPORT_LIBBZ2=ON -DBUILD_SHARED_LIBS=ON -DBUILD_STATIC_LIBS=ON -DCMAKE_OSX_ARCHITECTURES='arm64;x86_64' -DCMAKE_C_FLAGS='-Wall -Wextra' -DCMAKE_COMPILE_WARNING_AS_ERROR=ON -DCMAKE_BUILD_TYPE=Release -B build
 
       - name: Build
         run: cd build && make -j3
 
       - name: Test
         run: cd build && ctest -j3 --output-on-failure
 
+      - name: Install
+        run: |
+          cd build
+          cmake --install . --prefix install-dir
+          ../maint/RunManifestTest install-dir ../maint/manifest-cmakeinstall-macos
+
   windows:
     name: Windows
     runs-on: windows-latest
@@ -111,14 +127,20 @@ jobs:
           submodules: true
 
       - name: Configure
-        run: cmake -DPCRE2_SUPPORT_JIT=ON -DPCRE2_BUILD_PCRE2_16=ON -DPCRE2_BUILD_PCRE2_32=ON -DCMAKE_COMPILE_WARNING_AS_ERROR=ON -B build -A ${{ matrix.arch }}
+        run: cmake -DPCRE2_SUPPORT_JIT=ON -DPCRE2_BUILD_PCRE2_16=ON -DPCRE2_BUILD_PCRE2_32=ON -DBUILD_SHARED_LIBS=ON -DBUILD_STATIC_LIBS=ON -DCMAKE_COMPILE_WARNING_AS_ERROR=ON -B build -A ${{ matrix.arch }}
 
       - name: Build
         run: cmake --build build --config Release
 
       - name: Test
         run: cd build && ctest -C Release -j3 --output-on-failure
 
+      - name: Install
+        run: |
+          cd build
+          cmake --install . --config Release --prefix install-dir
+          ../maint/RunManifestTest.ps1 install-dir ../maint/manifest-cmakeinstall-windows
+
   freebsd:
     name: FreeBSD
     runs-on: ubuntu-latest
@@ -142,6 +164,9 @@ jobs:
             make -j3 CPPFLAGS='-Wall -Wextra -Werror'
             make check
 
+            make install "DESTDIR=`pwd`/install-dir"
+            maint/RunManifestTest install-dir maint/manifest-makeinstall-freebsd
+
   solaris:
     name: Solaris
     runs-on: ubuntu-latest
@@ -192,6 +217,64 @@ jobs:
             make CPPFLAGS='-Wall -Wextra -Werror'
             make check
 
+            make install "DESTDIR=`pwd`/install-dir"
+            maint/RunManifestTest install-dir maint/manifest-makeinstall-linux
+
+  distcheck:
+    name: Build & verify distribution
+    runs-on: ubuntu-24.04 # TODO: Update to ubuntu-latest when that switches to 24.04
+    permissions:
+      id-token: write # Needed to make calls to the Sigstore service
+      attestations: write # Needed to write the attestation to GitHub's database
+      contents: read
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          submodules: true
+
+      - name: Prepare
+        run: |
+          ./autogen.sh
+
+          # Workaround for incorrect filesystem permissions on /usr/share/aclocal, which
+          # causes the m4 macros to be copied with incorrect permissions.
+          chmod u=rw,go=r m4/*.m4
+
+      - name: Configure
+        run: ./configure
+
+      - name: Distcheck
+        run: make distcheck -j3
+
+      - name: Manifest
+        run: |
+          mkdir tarball-dir
+          tar -C tarball-dir -xzf pcre2-*.tar.gz
+          # Budge the directory, so we don't back the version number into the
+          # `manifest-tarball` file:
+          mv tarball-dir/pcre2-* tarball-dir/pcre2-SNAPSHOT
+          maint/RunManifestTest tarball-dir maint/manifest-tarball
+
+      - name: Upload to GitHub artifacts
+        uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3
+        with:
+          name: "Distribution release"
+          path: |
+            pcre2-*.tar.bz2
+            pcre2-*.tar.gz
+            pcre2-*.zip
+          if-no-files-found: error
+
+      - name: Attest
+        uses: actions/attest-build-provenance@7668571508540a607bdfd90a87a560489fe372eb # v2.1.0
+        if: |
+          github.event_name != 'pull_request' &&
+          (startsWith(github.ref, 'refs/heads/release/') ||
+           startsWith(github.ref, 'refs/tags/pcre2-'))
+        with:
+          subject-path: 'pcre2-*.tar.bz2, pcre2-*.tar.gz, pcre2-*.zip'
+
   coverage:
     name: Code coverage
     runs-on: ubuntu-latest
diff --git a/.github/workflows/dev.yml b/.github/workflows/dev.yml
@@ -95,14 +95,20 @@ jobs:
           submodules: true
 
       - name: Configure
-        run: cmake -DPCRE2_SUPPORT_JIT=ON -DPCRE2_BUILD_PCRE2_16=ON -DPCRE2_BUILD_PCRE2_32=ON -DPCRE2_DEBUG=ON -DCMAKE_COMPILE_WARNING_AS_ERROR=ON -DCMAKE_BUILD_TYPE=Release -B build
+        run: cmake -DPCRE2_SUPPORT_JIT=ON -DPCRE2_BUILD_PCRE2_16=ON -DPCRE2_BUILD_PCRE2_32=ON -DBUILD_SHARED_LIBS=ON -DBUILD_STATIC_LIBS=ON -DPCRE2_DEBUG=ON -DCMAKE_COMPILE_WARNING_AS_ERROR=ON -DCMAKE_BUILD_TYPE=Release -B build
 
       - name: Build
         run: cd build && make -j3
 
       - name: Test
         run: cd build && ctest -j3 --output-on-failure
 
+      - name: Install
+        run: |
+          cd build
+          cmake --install . --prefix install-dir
+          ../maint/RunManifestTest install-dir ../maint/manifest-cmakeinstall-linux
+
   dodo:
     # Tests with: Autconf on oldest supported Ubuntu (in non-extended support)
     name: GCC -Os, old Autotools
@@ -125,6 +131,11 @@ jobs:
       - name: Test
         run: make check
 
+      - name: Install
+        run: |
+          make install "DESTDIR=`pwd`/install-dir"
+          maint/RunManifestTest install-dir maint/manifest-makeinstall-linux
+
   wasp:
     # Tests with: French locale; oldest supported CMake; no JIT; -Os; libreadline
     name: GCC -Os, CMake+ninja, no JIT
@@ -157,14 +168,20 @@ jobs:
       - name: Configure
         run: |
           cmake --version | grep "version ${CMAKE_VER}" || (echo "CMake version mismatch" && exit 1)
-          CC='clang' CFLAGS='-fsanitize=undefined,address,integer -fno-sanitize-recover=undefined,integer -fno-sanitize=unsigned-shift-base,function -pedantic -Wall -Wextra -Wpedantic -Wdeclaration-after-statement -Wshadow -Wno-overlength-strings -Werror -Wno-error=incompatible-pointer-types-discards-qualifiers' cmake -G Ninja -DPCRE2_BUILD_PCRE2_16=ON -DPCRE2_BUILD_PCRE2_32=ON -DPCRE2_DEBUG=ON -DPCRE2_SUPPORT_LIBREADLINE=ON -DCMAKE_BUILD_TYPE=MinSizeRel -B build
+          CC='clang' CFLAGS='-fsanitize=undefined,address,integer -fno-sanitize-recover=undefined,integer -fno-sanitize=unsigned-shift-base,function -pedantic -Wall -Wextra -Wpedantic -Wdeclaration-after-statement -Wshadow -Wno-overlength-strings -Werror -Wno-error=incompatible-pointer-types-discards-qualifiers' cmake -G Ninja -DPCRE2_BUILD_PCRE2_16=ON -DPCRE2_BUILD_PCRE2_32=ON -DBUILD_SHARED_LIBS=ON -DBUILD_STATIC_LIBS=ON -DPCRE2_DEBUG=ON -DPCRE2_SUPPORT_LIBREADLINE=ON -DCMAKE_BUILD_TYPE=MinSizeRel -B build
 
       - name: Build
         run: ninja -C build
 
       - name: Test
         run: cd build && ctest -j3 --output-on-failure
 
+      - name: Install
+        run: |
+          cd build
+          cmake --install . --prefix install-dir
+          ../maint/RunManifestTest install-dir ../maint/manifest-cmakeinstall-linux
+
   bat:
     # Tests with: MSVC 32-bit, and a variety of CMake options
     name: Windows (Win32)
diff --git a/maint/CheckTxt b/maint/CheckTxt
@@ -1,4 +1,4 @@
-#!/usr/bin/perl
+#! /usr/bin/perl
 
 # This is a script for checking whether a file contains any carriage return
 # characters, and whether it is valid UTF-8.
diff --git a/maint/Detrail b/maint/Detrail
@@ -1,4 +1,4 @@
-#!/usr/bin/perl
+#! /usr/bin/perl
 
 # This is a script for removing trailing whitespace from lines in files that
 # are listed on the command line.
diff --git a/maint/GenerateCommon.py b/maint/GenerateCommon.py
@@ -1,5 +1,3 @@
-#! /usr/bin/python
-
 #                   PCRE2 UNICODE PROPERTY SUPPORT
 #                   ------------------------------
 
diff --git a/maint/GenerateTest.py b/maint/GenerateTest.py
@@ -1,4 +1,4 @@
-#! /usr/bin/python
+#! /usr/bin/env python3
 
 #                   PCRE2 UNICODE PROPERTY SUPPORT
 #                   ------------------------------
diff --git a/maint/GenerateUcd.py b/maint/GenerateUcd.py
@@ -1,4 +1,4 @@
-#! /usr/bin/python
+#! /usr/bin/env python3
 
 #                   PCRE2 UNICODE PROPERTY SUPPORT
 #                   ------------------------------
diff --git a/maint/GenerateUcpHeader.py b/maint/GenerateUcpHeader.py
@@ -1,4 +1,4 @@
-#! /usr/bin/python
+#! /usr/bin/env python3
 
 #                   PCRE2 UNICODE PROPERTY SUPPORT
 #                   ------------------------------
diff --git a/maint/GenerateUcpTables.py b/maint/GenerateUcpTables.py
@@ -1,4 +1,4 @@
-#! /usr/bin/python
+#! /usr/bin/env python3
 
 #                   PCRE2 UNICODE PROPERTY SUPPORT
 #                   ------------------------------
diff --git a/maint/PrepareRelease b/maint/PrepareRelease
@@ -1,4 +1,4 @@
-#/bin/sh
+#! /bin/bash
 
 # Script to prepare the files for building a PCRE2 release. It does some
 # processing of the documentation and detrails files.
diff --git a/maint/README b/maint/README
@@ -60,6 +60,10 @@ GenerateUcpTables.py
   GenerateCommon.py and Unicode data files. The generated file contains tables
   for looking up Unicode property names.
 
+manifest-*
+  Data files used to verify the contents of the distribution tarball and
+  `make install` file lists.
+
 ManyConfigTests
   A shell script that runs "configure, make, test" a number of times with
   different configuration settings.
@@ -76,6 +80,11 @@ pcre2_chartables.c.non-standard
 README
   This file.
 
+RunManifestTest
+RunManifestTest.ps1
+  Scripts to generate and verify a list of files against an expected 'manifest'
+  detailing what the directory should contain.
+
 Unicode.tables
   The files in this directory were downloaded from the Unicode web site. They
   contain information about Unicode characters and scripts, and are used by the
@@ -151,6 +160,23 @@ are written to testinput and testoutput in the current directory, but they
 should be moved to replace the files inside the main testdata directory and
 that are being used for tests 27 or 26.
 
+In summary:
+
+```
+./GenerateUcd.py       ../src/pcre2_ucd.c
+./GenerateUcpHeader.py ../src/pcre2_ucp.h
+./GenerateUcpTables.py ../src/pcre2_ucptables.c
+./GenerateTest.py
+mv testinput ../testdata/testinput27
+mv testoutput ../testdata/testoutput27
+
+...compile ucptest.c
+for i in 1 2; do
+  ./ucptest < ucptestdata/testinput$i > testoutput$i
+  diff -U3 testoutput$i ucptestdata/testoutput$i
+done
+```
+
 
 Preparing for a PCRE2 release
 =============================
diff --git a/maint/RunManifestTest b/maint/RunManifestTest
@@ -0,0 +1,47 @@
+#! /bin/sh
+
+# Script to test a directory listing. We use this to verify that the list of
+# files installed by "make install" or "cmake --install" matches what we expect.
+
+LANG=C # Ensure stable ordering of `sort` output
+export LANG
+
+if [ "$1" = "" -o "$2" = "" ] ; then
+    echo "Usage: $0 <dir> <manifest name>" >&2
+  exit 1
+fi
+
+input_dir="$1"
+expected_manifest="$2"
+
+base=`basename $expected_manifest`
+
+sed=sed
+grep=grep
+# Helpers for Solaris
+if [ -f /usr/bin/gsed ] ; then
+  sed=/usr/bin/gsed
+fi
+if [ -f /usr/bin/ggrep ] ; then
+  grep=/usr/bin/ggrep
+fi
+
+find "$input_dir" -print | \
+  sort | \
+  xargs -n1 -- ls -l -d -n | \
+  $sed -E -e 's/ {2,}/ /g' | \
+  cut -d' ' -f '1,9-' \
+  > "$base"
+
+if ! diff -u "$expected_manifest" "$base"; then
+  echo "Installed files differ from expected" >&2
+
+  echo "===Actual===" >&2
+  cat "$base" >&2
+  echo "===End===" >&2
+
+  exit 1
+fi
+
+echo "Installed files match expected"
+rm -f "$base"
diff --git a/maint/RunManifestTest.ps1 b/maint/RunManifestTest.ps1
@@ -0,0 +1,36 @@
+# Script to test a directory listing. We use this to verify that the list of
+# files installed by "make install" or "cmake --install" matches what we expect.
+
+param (
+  [Parameter(Mandatory=$true)]
+  [string]$inputDir,
+
+  [Parameter(Mandatory=$true)]
+  [string]$manifestName
+)
+
+if ((-not $inputDir) -or (-not $manifestName)) {
+  throw "Usage: .\RunManifestTest.ps1 <dir> <manifest name>"
+}
+
+$base = [System.IO.Path]::GetFileName($manifestName)
+
+$installedFiles = Get-ChildItem -Recurse -Force -Path $inputDir |
+  Sort-Object {[System.BitConverter]::ToString([system.Text.Encoding]::UTF8.GetBytes($_.FullName))} |
+  ForEach-Object { $_.Mode.Substring(0,5) + " " + ($_.FullName | Resolve-Path -Relative) }
+
+$null = New-Item -Force $base -Value (($installedFiles | Out-String) -replace "`r`n", "`n")
+
+$expectedFiles = Get-Content -Path $manifestName -Raw
+$actualFiles = Get-Content -Path $base -Raw
+
+if ($expectedFiles -ne $actualFiles) {
+  Write-Host "===Actual==="
+  Write-Host $actualFiles
+  Write-Host "===End==="
+
+  throw "Installed files differ from expected"
+}
+
+Write-Host "Installed files match expected"
+Remove-Item -Path $base -Force
diff --git a/maint/manifest-cmakeinstall-linux b/maint/manifest-cmakeinstall-linux
diff --git a/maint/manifest-cmakeinstall-macos b/maint/manifest-cmakeinstall-macos
diff --git a/maint/manifest-cmakeinstall-windows b/maint/manifest-cmakeinstall-windows
diff --git a/maint/manifest-makeinstall-freebsd b/maint/manifest-makeinstall-freebsd
diff --git a/maint/manifest-makeinstall-linux b/maint/manifest-makeinstall-linux
diff --git a/maint/manifest-tarball b/maint/manifest-tarball

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`		`-testdata/* -text`
	`1`	`+testdata/* -text`
	`2`	`+maint/manifest-* -text`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-#!/usr/bin/perl`
	`1`	`+#! /usr/bin/perl`
`2`	`2`
`3`	`3`	`# This is a script for checking whether a file contains any carriage return`
`4`	`4`	`# characters, and whether it is valid UTF-8.`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-#! /usr/bin/python`
`2`		`-`
`3`	`1`	`# PCRE2 UNICODE PROPERTY SUPPORT`
`4`	`2`	`# ------------------------------`
`5`	`3`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-#! /usr/bin/python`
	`1`	`+#! /usr/bin/env python3`
`2`	`2`
`3`	`3`	`# PCRE2 UNICODE PROPERTY SUPPORT`
`4`	`4`	`# ------------------------------`