Merge pull request #3161 from jimklimov/FTY-obs

Introduce `make distcheck-completeness` to verify that our dist archives exactly reproduce themselves

Author: jimklimov

.github/workflows/01-make-dist.yml

@@ -215,6 +215,16 @@ jobs:
         ( ${{env.compiler}} ; echo "=== CC: $CC => `command -v $CC` =>" ; $CC --version ; echo "=== CXX: $CXX => `command -v $CXX` =>" ; $CXX --version ) || true
         make -s -j 8 distcheck
 
+    - name: NUT CI Build to verify "dist" tarball build self-reproducibility
+      env:
+        compiler: 'CC=gcc CXX=g++'
+      run: |
+        PATH="/usr/lib/ccache:$PATH" ; export PATH
+        CCACHE_COMPRESS=true; export CCACHE_COMPRESS
+        ccache --version || true
+        ( ${{env.compiler}} ; echo "=== CC: $CC => `command -v $CC` =>" ; $CC --version ; echo "=== CXX: $CXX => `command -v $CXX` =>" ; $CXX --version ) || true
+        make -s -j 8 distcheck-completeness
+
     - name: CCache stats after distcheck
       run: ccache -sv || ccache -s || echo "FAILED to read ccache info, oh well"
 
@@ -270,7 +280,7 @@ jobs:
       continue-on-error: true
       with:
         comment-tag: latest-tarball
-        message: Dist and Docs [NUT-tarballs-${{ steps.subst-github-ref-name.outputs.result }}.zip}](${{ steps.upload_artifact.outputs.artifact-url }}) are available for commit ${{ github.sha }}
+        message: Dist and Docs [NUT-tarballs-${{ steps.subst-github-ref-name.outputs.result }}.zip](${{ steps.upload_artifact.outputs.artifact-url }}) are available for commit ${{ github.sha }}
         #github-token: ${{ secrets.MAKE_DIST_TOKEN }}
 
     # https://github.com/marocchino/sticky-pull-request-comment
@@ -280,7 +290,6 @@ jobs:
       continue-on-error: true
       with:
         header: latest-tarball-sticky
-        only_create: true
-        message: Dist and Docs [NUT-tarballs-${{ steps.subst-github-ref-name.outputs.result }}.zip}](${{ steps.upload_artifact.outputs.artifact-url }}) are available for commit ${{ github.sha }}
+        message: Dist and Docs [NUT-tarballs-${{ steps.subst-github-ref-name.outputs.result }}.zip](${{ steps.upload_artifact.outputs.artifact-url }}) are available for commit ${{ github.sha }}
         #github-token: ${{ secrets.MAKE_DIST_TOKEN }}
         #GITHUB_TOKEN: ${{ secrets.MAKE_DIST_TOKEN }}

Makefile.am

@@ -1013,6 +1013,65 @@ libupsclient-version.h clients/libupsclient-version.h:
 tools/gitlog2changelog.py: tools/gitlog2changelog.py.in
 	+cd $(@D) && $(MAKE) $(AM_MAKEFLAGS) -s $(@F)
 
+# Partially snatched from automake generated code
+distcheck-completeness: dist
+	@chmod -R +w $(distdir) $(distdir)-orig-* $(distdir)-derived-* || true
+	@rm -rf $(distdir) $(distdir)-orig-* $(distdir)-derived-* || true
+	@case '$(DIST_ARCHIVES)' in \
+	*.tar.gz*) \
+	  eval GZIP= gzip $(GZIP_ENV) -dc $(distdir).tar.gz | $(am__untar) ;;\
+	*.tar.bz2*) \
+	  bzip2 -dc $(distdir).tar.bz2 | $(am__untar) ;;\
+	*.tar.lz*) \
+	  lzip -dc $(distdir).tar.lz | $(am__untar) ;;\
+	*.tar.xz*) \
+	  xz -dc $(distdir).tar.xz | $(am__untar) ;;\
+	*.tar.Z*) \
+	  uncompress -c $(distdir).tar.Z | $(am__untar) ;;\
+	*.shar.gz*) \
+	  eval GZIP= gzip $(GZIP_ENV) -dc $(distdir).shar.gz | unshar ;;\
+	*.zip*) \
+	  unzip $(distdir).zip ;;\
+	*.tar.zst*) \
+	  zstd -dc $(distdir).tar.zst | $(am__untar) ;;\
+	esac
+	+@RES=0 ; \
+	{ cp -rf $(distdir) $(distdir)-orig-$$$$ \
+	  && am__cwd="`pwd`" \
+	  && $(am__cd) $(distdir) \
+	  && ./configure \
+	      $(AM_DISTCHECK_CONFIGURE_FLAGS) \
+	      $(DISTCHECK_CONFIGURE_FLAGS) \
+	      --prefix="`pwd`/.inst" \
+	  && $(MAKE) $(AM_MAKEFLAGS) dist \
+	  && case '$(DIST_ARCHIVES)' in \
+	      *.tar.gz*) \
+	        eval GZIP= gzip $(GZIP_ENV) -dc $(distdir).tar.gz | $(am__untar) ;;\
+	      *.tar.bz2*) \
+	        bzip2 -dc $(distdir).tar.bz2 | $(am__untar) ;;\
+	      *.tar.lz*) \
+	        lzip -dc $(distdir).tar.lz | $(am__untar) ;;\
+	      *.tar.xz*) \
+	        xz -dc $(distdir).tar.xz | $(am__untar) ;;\
+	      *.tar.Z*) \
+	        uncompress -c $(distdir).tar.Z | $(am__untar) ;;\
+	      *.shar.gz*) \
+	        eval GZIP= gzip $(GZIP_ENV) -dc $(distdir).shar.gz | unshar ;;\
+	      *.zip*) \
+	        unzip $(distdir).zip ;;\
+	      *.tar.zst*) \
+	        zstd -dc $(distdir).tar.zst | $(am__untar) ;;\
+	      esac \
+	  && mv $(distdir) ../$(distdir)-derived-$$$$ \
+	  && $(MAKE) $(AM_MAKEFLAGS) maintainer-clean \
+	  && cd "$$am__cwd" \
+	  && echo "  $@	diff $(distdir)-orig-$$$$ $(distdir)-derived-$$$$" \
+	  && diff $(distdir)-orig-$$$$ $(distdir)-derived-$$$$ ; \
+	  } || RES=$?? ;
+	  rm -rf $(distdir)-orig-$$$$ $(distdir)-derived-$$$$ $(distdir) ; \
+	  exit $$RES
+	@echo "SUCCESS: $(distdir) archives are self-reproducing"
+
 # ----------------------------------------------------------------------
 # Maintainers targets: distribution signature and hashes
 # Assume tools are available (and maintainer GPG keys)

NEWS.adoc

@@ -307,6 +307,9 @@ several `FSD` notifications into one executed action. [PR #3097]
  - The `configure` script should now try harder to report specifically
    the "purelib" location as `PYTHON*_SITE_PACKAGES`. [#1209]
 
+ - Introduce `make distcheck-completeness` goal to verify that our distribution
+   archives can exactly reproduce themselves. [#2829]
+
  - Upstreamed reference packaging recipes (DEB, RPM) from the 42ITy project
    which can be used with OBS (Open Build Service by SUSE), both to support
    end-user testing of NUT development, and to have a yet another NUT CI farm