Merge 3e6e05a into 9b4d841

Author: jimklimov

.circleci/config.yml

@@ -53,6 +53,12 @@ jobs:
         #type: string
         #default: "/opt/homebrew" # since July 2024 CircleCI only serves Apple Silicon instances
         #default: "/usr/local" # was when CircleCI builders had x86
+      DO_CLEAN_NUTCI_CACHE:
+        type: string
+        default: "no"
+      DO_USE_NUTCI_CACHE:
+        type: string
+        default: "yes"
 
     environment:
       CC: << parameters.CC >>
@@ -64,6 +70,8 @@ jobs:
       CI_BUILDDIR: << parameters.CI_BUILDDIR >>
       BREW_MORE: << parameters.BREW_MORE >>
       #HOMEBREW_PREFIX: << parameters.HOMEBREW_PREFIX >>
+      DO_CLEAN_NUTCI_CACHE: << parameters.DO_CLEAN_NUTCI_CACHE >>
+      DO_USE_NUTCI_CACHE: << parameters.DO_USE_NUTCI_CACHE >>
 
     # Specify the execution environment. You can specify an image from Dockerhub or use one of our Convenience Images from CircleCI's Developer Hub.
     # See: https://circleci.com/docs/2.0/configuration-reference/#docker-machine-macos-windows-executor
@@ -130,6 +138,7 @@ jobs:
           keys:
             - ccache-{{ .Branch }}-{{ arch }}-{{ .Environment.CIRCLE_JOB }}
             - ccache-master-{{ arch }}-{{ .Environment.CIRCLE_JOB }}
+            - config-cache-{{ .Branch }}-{{ arch }}-{{ .Environment.CIRCLE_JOB }}
 
       # Help SEMVER look right (optionally)
       - run:
@@ -198,10 +207,17 @@ jobs:
       # be beneficial to instead share the cache between jobs; more so
       # while we are on free CircleCI tier and run them sequentially.
       - save_cache:
+          name: Save .ccache for later runs
           paths:
             - ~/.ccache
           key: ccache-{{ .Branch }}-{{ arch }}-{{ .Environment.CIRCLE_JOB }}
 
+      - save_cache:
+          name: Save config.cache for later runs
+          paths:
+            - ~/.cache/nut-ci
+          key: config-cache-{{ .Branch }}-{{ arch }}-{{ .Environment.CIRCLE_JOB }}
+
       - store_artifacts:
           path: config.log
 

Makefile.am

@@ -607,8 +607,12 @@ DISTCHECK_LIGHT_FLAGS = --with-all=auto --with-ssl=auto --with-doc=auto --enable
 DISTCHECK_LIGHT_MAN_FLAGS = --with-all=auto --with-ssl=auto --with-doc=man --enable-docs-man-for-progs-built-only=no --with-pynut=app --with-nut_monitor=force CXXFLAGS='@NUT_CONFIG_CXXFLAGS@' CFLAGS='@NUT_CONFIG_CFLAGS@' CPPFLAGS='@NUT_CONFIG_CPPFLAGS@' LDFLAGS='@NUT_CONFIG_LDFLAGS@'
 DISTCHECK_VALGRIND_FLAGS = --with-all=auto --with-ssl=auto --with-doc=skip --with-valgrind CXXFLAGS='@NUT_CONFIG_CXXFLAGS@ -g' CFLAGS='@NUT_CONFIG_CFLAGS@ -g' CPPFLAGS='@NUT_CONFIG_CPPFLAGS@' LDFLAGS='@NUT_CONFIG_LDFLAGS@' --with-pynut=app --with-nut_monitor=force
 
-# Note: this rule uses envvar DISTCHECK_FLAGS expanded at run-time
+# Note: this rule uses envvar DISTCHECK_FLAGS expanded at run-time, which
+# may be passed down from caller and/or one of distcheck-* rules below.
+# The CI_CACHE_NUT_HASHDIR_CFG_OPT can also be passed down (by ci_build.sh
+# as generated for each specific build circumstance).
 DISTCHECK_CONFIGURE_FLAGS = ${DISTCHECK_FLAGS}		\
+ ${CI_CACHE_NUT_HASHDIR_CFG_OPT}			\
  PKG_CONFIG_PATH='@PKG_CONFIG_PATH@'			\
  --with-systemdsystemunitdir='$${prefix}/lib/systemd/system' \
  --with-systemdsystempresetdir='$${prefix}/usr/lib/systemd/system-preset' \

NEWS.adoc

@@ -73,6 +73,14 @@ https://github.com/networkupstools/nut/milestone/13
       This change impacted also the classic C `libupsclient` library.
       [issue #3387, PR #3402]
 
+ - Introduced `ci_build.sh` settings and respective CI workflow settings
+   to optionally re-use a `config.cache` file from older runs, and similar
+   logic for NIT `nit.sh` to re-use generated certificate and private key
+   files. Both can be enabled by `export DO_USE_NUTCI_CACHE=yes` and would
+   store data under a `${CI_CACHE_NUT_BASEDIR}` directory (defaults to
+   `~/.cache/nut-ci`); more fine-tuning environment variables are provided.
+   [issues #3108, #3390, #1711, PR #3109]
+
 
 Release notes for NUT 2.8.5 - what's new since 2.8.4
 ----------------------------------------------------

appveyor.yml

@@ -27,6 +27,8 @@ environment:
   APPVEYOR_SAVE_CACHE_ON_ERROR: true
   APPVEYOR_CACHE_ENTRY_ZIP_ARGS: -t7z -m0=lzma -mx=6
   CCACHE_DIR: /home/appveyor/.ccache
+  DO_CLEAN_NUTCI_CACHE: no
+  DO_USE_NUTCI_CACHE: yes
 
 # Customize GH notification message template
 # TODO: for repetitive commits in a PR consider a clean-up GHA like
@@ -200,7 +202,10 @@ artifacts:
 # Example optional cache (depends on file change):
 # - C:\msys64 -> appveyor.yml
 cache:
+  - C:\projects\nut\config.cache
+  - C:\projects\.cache\nut-ci
   - C:\msys64\home\appveyor\nut-win-deps
+  - C:\msys64\home\appveyor\.cache\nut-ci
   - C:\msys64\home\appveyor\.ccache
   - C:\msys64\home\appveyor\ccache # likely missing, no problem - but the name is reported in ccache status
   - C:\Users\appveyor\AppData\Local\ccache # may be default in newer versions

ci_build.adoc

@@ -94,3 +94,24 @@ another shell at least for the system call-outs, with options like these:
     :; SHELL=/bin/bash CONFIG_SHELL=/bin/bash CI_SHELL_IS_FLAKY=true \
        ./ci_build.sh
 
+Caching!
+--------
+
+The `ci_build.sh` can make use of a persistent cache directory, e.g. to speed
+up repetitive runs of the `configure` script on developer or CI machines when
+our `*.m4` and `*.ac` script sources and the machine remain the same.
+
+It can be stored outside of the build area(s), under `${CI_CACHE_NUT_BASEDIR}`
+(default: `${HOME}/.cache/nut-ci`) if `DO_USE_NUTCI_CACHE=yes` as provided
+by caller (e.g. via `~/.profile` of a developer) or guessed from environment
+variables typical for CI runs.
+
+If something acts up, or the build environment changes invisibly to the
+script, an `export DO_CLEAN_NUTCI_CACHE_BEFORE=yes` (or a more targeted
+`DO_CLEAN_AUTOCONF_CACHE_BEFORE`, since NIT uses similar logic and general
+toggle to retain generated test certificates) should fix that.
+
+You can also always nuke the `${CI_CACHE_NUT_BASEDIR}` directory, or the
+`AUTOCONF_*` subdirectories and stale lock files under it.
+It would likely be needed from time to time anyway, as there is now
+no automated clean-up of no longer relevant caches.