Compare commits

...
6 Commits
Author SHA1 Message Date
Daniele Fucini a62b4f3a56 Point the README installation section to the AUR 2026-11-10 21:12:35 +01:00
Daniele Fucini 6633c70433 Update PKGBUILD
Clearer pkgdesc for the AUR release.
2026-11-10 20:45:42 +01:00
Daniele Fucini ba0333988a Update PKGBUILD 2026-11-09 20:49:13 +01:00
Daniele Fucini 3caf4ea96d Empty the default KERNELS map and make tests chroot-safe
Custom kernels are now set only in the config, so the defaults suit any system. The reboot check's modules folder can be overridden with UPDATE_NOTIFY_MODULES_DIR, so the tests no longer need an installed kernel.
2026-11-09 20:48:18 +01:00
Daniele Fucini bd8ded486d Add bats test suite
Black-box tests that run the script with stub commands on a minimal PATH and temp config/state folders.
2026-11-09 19:51:42 +01:00
Daniele Fucini 1328cd5eca Update PKGBUILD 2026-11-07 10:43:04 +01:00
13 changed files with 485 additions and 24 deletions
+13 -4
View File
@@ -3,21 +3,30 @@
# Maintainer: Daniele Fucini <dfucini [at] gmail [dot] com>
pkgname=update-notify
pkgver=3.11.2
pkgrel=1
pkgdesc='Notify when updates are available'
pkgver=3.13
pkgrel=2
pkgdesc='Desktop notifications for pending repo and AUR updates'
arch=('any')
url="https://git.shouldnt.work/fuxino/$pkgname"
license=('GPL-3.0-or-later')
depends=('pacman-contrib'
'libnotify')
makedepends=('git')
checkdepends=('bats'
'bats-assert'
'bats-support')
optdepends=('aurutils: to check AUR packages in the local repo for updates'
'fwupd: to check for firmware updates'
'git-monitor: to check git repos for updates')
source=("git+$url?signed#tag=$pkgver")
validpgpkeys=('7E12BC1FF3B6EDB2CD8053EB981A2B2A3BBF5514')
sha256sums=('1a3859f3c9d3bbcd46c59ccc728f6ffa9a1d162df940bcd31e2b5753a40324f4')
sha256sums=('56bfe7f4a8f8d5c311fe6c7c07f01614111e5c899043d038ce0a1c11362b4a71')
check()
{
cd "$srcdir"/"$pkgname"
bats tests
}
package()
{
+3 -9
View File
@@ -6,7 +6,7 @@ update-notify runs on a systemd user timer and checks:
- **Repo updates**, using `checkupdates` from pacman-contrib.
- **AUR updates** for packages in a local aurutils repository (`aur repo -u`).
- **Custom kernel rebuilds**: when a stock kernel (e.g. `linux-lts`) has a newer version than your custom build of it (e.g. `linux-lts-custom`).
- **Custom kernel rebuilds**: when a stock kernel (e.g. `linux-lts`) has a newer version than your custom build of it (e.g. `linux-lts-custom`), for the kernels set in `KERNELS`.
- **Maintenance**: `.pacnew`/`.pacsave` files to merge (`pacdiff -o`), and a reboot after the running kernel was upgraded.
It sends one notification, and only when its content changes since the last one:
@@ -28,13 +28,7 @@ Optional:
## Installation
Build and install the package with the included PKGBUILD, which builds the signed release tag set in `pkgver`:
```
makepkg -si
```
Or, with aurutils, build it into a local repository with `aur build` and install it with pacman.
update-notify is available in the AUR as [update-notify](https://aur.archlinux.org/packages/update-notify). Install it with your AUR helper, e.g. `aur sync update-notify` with aurutils.
Then enable the timer:
@@ -80,7 +74,7 @@ Settings are read from `$XDG_CONFIG_HOME/update-notify/config` (default `~/.conf
- `THRESHOLD`: minimum number of updates before update counts are shown (default 30).
- `AUR_REPO`: name of the local aurutils repository (default `aur-local`).
- `KERNELS`: maps each stock kernel package to its custom build (default: `linux`, `linux-lts` and `linux-zen` to `<name>-custom`). Kernels where either package isn't installed are skipped. Set `KERNELS=()` to disable the kernel check.
- `KERNELS`: maps each stock kernel package to its custom build, e.g. `KERNELS=([linux-lts]=linux-lts-custom)`. Empty by default, which disables the kernel check. Kernels where either package isn't installed are skipped.
- `PACNEW_CHECK`: set to `0` to disable the `.pacnew`/`.pacsave` reminder (default `1`).
- `REBOOT_CHECK`: set to `0` to disable the reboot reminder (default `1`). A reboot is needed when the running kernel's `/usr/lib/modules/<version>/vmlinuz` is gone.
+3 -4
View File
@@ -9,13 +9,12 @@
# Name of the local aurutils repository.
#AUR_REPO="aur-local"
# Stock kernel package -> your custom build of it. Replaces the whole list;
# kernels where either package isn't installed are skipped.
# Set KERNELS=() to disable the kernel check.
# Stock kernel package -> your custom build of it, to be reminded to rebuild
# it. Empty by default (no kernel check); kernels where either package isn't
# installed are skipped. Example:
#KERNELS=(
# [linux]="linux-custom"
# [linux-lts]="linux-lts-custom"
# [linux-zen]="linux-zen-custom"
#)
# Remind about .pacnew/.pacsave files to merge with pacdiff (0 to disable).
+8
View File
@@ -0,0 +1,8 @@
#!/bin/bash
# "aur repo -u -d <repo>": prints $STUB_DATA/aur, exits $AUR_RC (default 0).
printf '%s %s\n' "${0##*/}" "$*" >> "$STUB_DATA/calls"
[[ ${1:-} == repo ]] || exit 1
if [[ -s $STUB_DATA/aur ]]; then
printf '%s\n' "$(<"$STUB_DATA/aur")"
fi
exit "${AUR_RC:-0}"
+8
View File
@@ -0,0 +1,8 @@
#!/bin/bash
# Prints $STUB_DATA/checkupdates; exits $CHECKUPDATES_RC, else 0 with updates and 2 without, like the real one.
printf '%s %s\n' "${0##*/}" "$*" >> "$STUB_DATA/calls"
if [[ -s $STUB_DATA/checkupdates ]]; then
printf '%s\n' "$(<"$STUB_DATA/checkupdates")"
exit "${CHECKUPDATES_RC:-0}"
fi
exit "${CHECKUPDATES_RC:-2}"
+4
View File
@@ -0,0 +1,4 @@
#!/bin/bash
# Exits $FWUPD_RC: 0 = firmware updates available, 2 (default) = none.
printf '%s %s\n' "${0##*/}" "$*" >> "$STUB_DATA/calls"
exit "${FWUPD_RC:-2}"
+3
View File
@@ -0,0 +1,3 @@
#!/bin/bash
# Only needs to exist: the script checks for it with command -v.
exit 0
+4
View File
@@ -0,0 +1,4 @@
#!/bin/bash
# Appends the title, the body and a "--" line to $STUB_DATA/notify; exits $NOTIFY_RC (default 0).
printf '%s\n' "$1" "$2" -- >> "$STUB_DATA/notify"
exit "${NOTIFY_RC:-0}"
+8
View File
@@ -0,0 +1,8 @@
#!/bin/bash
# "pacdiff -o": prints $STUB_DATA/pacdiff.
printf '%s %s\n' "${0##*/}" "$*" >> "$STUB_DATA/calls"
[[ ${1:-} == -o ]] || exit 1
if [[ -s $STUB_DATA/pacdiff ]]; then
printf '%s\n' "$(<"$STUB_DATA/pacdiff")"
fi
exit 0
+13
View File
@@ -0,0 +1,13 @@
#!/bin/bash
# "pacman -Q <pkg>": looks the package up in $STUB_DATA/installed ("name version" lines).
[[ ${1:-} == -Q && $# == 2 ]] || { echo "pacman stub: unsupported arguments: $*" >&2; exit 1; }
if [[ -f $STUB_DATA/installed ]]; then
while read -r name ver; do
if [[ $name == "$2" ]]; then
printf '%s %s\n' "$name" "$ver"
exit 0
fi
done < "$STUB_DATA/installed"
fi
printf "error: package '%s' was not found\n" "$2" >&2
exit 1
+3
View File
@@ -0,0 +1,3 @@
#!/bin/bash
# "uname -r": prints $STUB_KERNEL.
printf '%s\n' "$STUB_KERNEL"
+410
View File
@@ -0,0 +1,410 @@
#!/usr/bin/env bats
# Black-box tests: the script runs with the stubs in tests/stubs and temp config/state folders.
bats_require_minimum_version 1.5.0
bats_load_library bats-support
bats_load_library bats-assert
SCRIPT=$BATS_TEST_DIRNAME/../update-notify
setup() {
export STUB_DATA=$BATS_TEST_TMPDIR/data
export XDG_CONFIG_HOME=$BATS_TEST_TMPDIR/config
export XDG_STATE_HOME=$BATS_TEST_TMPDIR/state
# The running kernel has its vmlinuz, so the reboot check stays quiet unless a test changes STUB_KERNEL
export STUB_KERNEL=6.1.1-test
export UPDATE_NOTIFY_MODULES_DIR=$BATS_TEST_TMPDIR/modules
STATE=$XDG_STATE_HOME/update-notify
BIN=$BATS_TEST_TMPDIR/bin
mkdir -p "$STUB_DATA" "$XDG_CONFIG_HOME/update-notify" "$BIN" "$UPDATE_NOTIFY_MODULES_DIR/$STUB_KERNEL"
touch "$UPDATE_NOTIFY_MODULES_DIR/$STUB_KERNEL/vmlinuz"
# PATH holds only the stubs and the real tools the script needs, so a removed stub is a missing command
local tool
for tool in mkdir mv rm id timeout vercmp; do
ln -s "$(command -v "$tool")" "$BIN/$tool"
done
for tool in checkupdates aur pacman pacdiff uname notify-send; do
enable_stub "$tool"
done
}
enable_stub() { ln -s "$BATS_TEST_DIRNAME/stubs/$1" "$BIN/$1"; }
disable_stub() { rm "$BIN/$1"; }
config() { printf '%s\n' "$@" >> "$XDG_CONFIG_HOME/update-notify/config"; }
repo_updates() { printf '%s\n' "$@" > "$STUB_DATA/checkupdates"; }
aur_updates() { printf '%s\n' "$@" > "$STUB_DATA/aur"; }
installed() { printf '%s\n' "$@" > "$STUB_DATA/installed"; }
pacnew_files() { printf '%s\n' "$@" > "$STUB_DATA/pacdiff"; }
custom_linux() { config "KERNELS=([linux]=linux-custom)"; }
# Runs the script; notifications and stub calls are logged from this run only
run_script() {
rm -f "$STUB_DATA/notify" "$STUB_DATA/calls"
run /usr/bin/env PATH="$BIN" "$SCRIPT" "$@"
}
# Args: title, then body lines
assert_notification() {
local actual expected
actual=$(<"$STUB_DATA/notify") || fail "no notification sent"
printf -v expected '%s\n' "$@" --
assert_equal "$actual" "${expected%$'\n'}"
}
assert_no_notification() {
[[ ! -e $STUB_DATA/notify ]] || fail "unexpected notification: $(<"$STUB_DATA/notify")"
}
assert_pending() {
local expected
printf -v expected '%s\n' "$@"
assert_equal "$(<"$STATE/pending")" "${expected%$'\n'}"
}
assert_called() {
grep -qxF -- "$1" "$STUB_DATA/calls" || fail "not called: $1"
}
# --- Threshold and arguments ---
@test "no updates: no notification, pending file has only the threshold" {
run_script
assert_success
assert_no_notification
assert_pending "threshold 30"
}
@test "below the threshold: no notification, updates listed in the pending file" {
repo_updates "foo 1-1 -> 2-1"
aur_updates "bar 1-1 -> 1.1-1"
run_script
assert_success
assert_no_notification
assert_pending "threshold 30" "repo foo 2-1" "aur bar 1.1-1"
}
@test "threshold reached: notifies the counts" {
config THRESHOLD=2
repo_updates "foo 1-1 -> 2-1"
aur_updates "bar 1-1 -> 1.1-1"
run_script
assert_success
assert_notification "Updates available" "Arch: 1, AUR: 1"
}
@test "threshold argument overrides the config, pending file keeps the config value" {
config THRESHOLD=5
repo_updates "foo 1-1 -> 2-1" "baz 1-1 -> 2-1"
run_script 2
assert_success
assert_notification "Updates available" "Arch: 2, AUR: 0"
assert_pending "threshold 5" "repo foo 2-1" "repo baz 2-1"
}
@test "threshold with a leading zero is read as decimal" {
repo_updates "a 1 -> 2" "b 1 -> 2" "c 1 -> 2" "d 1 -> 2" "e 1 -> 2" "f 1 -> 2" "g 1 -> 2" "h 1 -> 2" "i 1 -> 2"
run_script 010 # octal would be 8
assert_success
assert_no_notification
}
@test "non-numeric threshold argument fails before touching the state" {
run_script abc
assert_failure 1
assert_output "Threshold must be a number"
[[ ! -e $STATE ]]
}
@test "non-numeric threshold in the config fails" {
config THRESHOLD=many
run_script
assert_failure 1
assert_output "Threshold must be a number"
}
# --- Gathering updates ---
@test "checkupdates failure exits without touching the state" {
config THRESHOLD=1
repo_updates "foo 1-1 -> 2-1"
run_script
assert_notification "Updates available" "Arch: 1, AUR: 0"
cp -r "$STATE" "$BATS_TEST_TMPDIR/before"
repo_updates "foo 1-1 -> 2-1" "baz 1-1 -> 2-1"
CHECKUPDATES_RC=1 run_script
assert_failure 1
assert_output --partial "checkupdates failed"
assert_no_notification
diff -r "$BATS_TEST_TMPDIR/before" "$STATE"
}
@test "aur repo -u failure warns and counts no AUR updates" {
config THRESHOLD=1
repo_updates "foo 1-1 -> 2-1"
aur_updates "bar 1-1 -> 1.1-1"
AUR_RC=1 run_script
assert_success
assert_output --partial "aur repo -u failed"
assert_notification "Updates available" "Arch: 1, AUR: 0"
assert_pending "threshold 1" "repo foo 2-1"
}
@test "aur missing: AUR updates count 0 without a warning" {
disable_stub aur
config THRESHOLD=1
repo_updates "foo 1-1 -> 2-1"
run_script
assert_success
assert_output ""
assert_notification "Updates available" "Arch: 1, AUR: 0"
}
@test "aur is queried for the configured repo" {
config AUR_REPO=myrepo
run_script
assert_success
assert_called "aur repo -u -d myrepo"
}
# --- Kernel check ---
@test "no kernel check by default" {
installed "linux 6.1.1-1" "linux-custom 6.1.1-1"
repo_updates "linux 6.1.1-1 -> 6.1.2-1"
run_script
assert_success
assert_no_notification
assert_pending "threshold 30" "repo linux 6.1.2-1"
}
@test "stock kernel update notifies the rebuild below the threshold" {
custom_linux
installed "linux 6.1.1-1" "linux-custom 6.1.1-1"
repo_updates "linux 6.1.1-1 -> 6.1.2-1"
run_script
assert_success
assert_notification "Kernel update available" "Rebuild linux-custom (linux 6.1.2-1)"
assert_pending "threshold 30" "repo linux 6.1.2-1" "kernel linux-custom 6.1.2-1"
}
@test "kernel rebuild joins the counts over the threshold" {
config THRESHOLD=1
custom_linux
installed "linux 6.1.2-1" "linux-custom 6.1.1-1"
run_script 0
assert_success
assert_notification "Updates available" "Arch: 0, AUR: 0" "Rebuild linux-custom (linux 6.1.2-1)"
}
@test "kernel check ignores pkgrel" {
custom_linux
installed "linux 6.1.1-1" "linux-custom 6.1.1-1"
repo_updates "linux 6.1.1-1 -> 6.1.1-2"
run_script
assert_success
assert_no_notification
}
@test "custom kernel already built into the repo isn't flagged" {
custom_linux
installed "linux 6.1.1-1" "linux-custom 6.1.1-1"
repo_updates "linux 6.1.1-1 -> 6.1.2-1" "linux-custom 6.1.1-1 -> 6.1.2-1"
run_script
assert_success
assert_no_notification
}
@test "kernels without a custom build installed are skipped" {
custom_linux
installed "linux 6.1.1-1"
repo_updates "linux 6.1.1-1 -> 6.1.2-1"
run_script
assert_success
assert_no_notification
}
@test "custom kernel map comes from the config" {
config "KERNELS=([linux-hardened]=linux-hardened-mine)"
installed "linux-hardened 6.1.2-1" "linux-hardened-mine 6.1.1-1"
run_script
assert_success
assert_notification "Kernel update available" "Rebuild linux-hardened-mine (linux-hardened 6.1.2-1)"
}
# --- Notification state ---
@test "same updates don't notify again, a change does" {
config THRESHOLD=1
repo_updates "foo 1-1 -> 2-1"
run_script
assert_notification "Updates available" "Arch: 1, AUR: 0"
run_script
assert_success
assert_no_notification
repo_updates "foo 1-1 -> 2-1" "baz 1-1 -> 2-1"
run_script
assert_notification "Updates available" "Arch: 2, AUR: 0"
}
@test "updates gone: the next ones notify again" {
config THRESHOLD=1
repo_updates "foo 1-1 -> 2-1"
run_script
rm "$STUB_DATA/checkupdates"
run_script
assert_no_notification
[[ ! -e $STATE/updates ]]
repo_updates "foo 1-1 -> 2-1"
run_script
assert_notification "Updates available" "Arch: 1, AUR: 0"
}
@test "failed notify-send isn't remembered, the next run retries" {
config THRESHOLD=1
repo_updates "foo 1-1 -> 2-1"
pacnew_files /etc/a.pacnew
NOTIFY_RC=1 run_script
[[ ! -e $STATE/updates && ! -e $STATE/maintenance ]]
run_script
assert_notification "Updates available" "Arch: 1, AUR: 0" "Config files to merge with pacdiff: 1"
}
# --- Quiet runs (path unit) ---
@test "--quiet writes the pending file but leaves a new notification to the timer" {
config THRESHOLD=1
repo_updates "foo 1-1 -> 2-1"
run_script --quiet
assert_success
assert_no_notification
assert_pending "threshold 1" "repo foo 2-1"
[[ ! -e $STATE/updates ]]
run_script
assert_notification "Updates available" "Arch: 1, AUR: 0"
}
@test "--quiet tracks changes to a shown notification, so the timer doesn't repeat them" {
config THRESHOLD=1
repo_updates "foo 1-1 -> 2-1"
run_script
repo_updates "foo 1-1 -> 2-1" "baz 1-1 -> 2-1"
run_script -q
assert_no_notification
run_script
assert_no_notification
}
@test "--quiet leaves new maintenance items to the timer" {
pacnew_files /etc/a.pacnew
run_script --quiet
assert_no_notification
[[ ! -e $STATE/maintenance ]]
run_script
assert_notification "System maintenance" "Config files to merge with pacdiff: 1"
}
@test "--quiet takes a threshold argument after it" {
repo_updates "foo 1-1 -> 2-1"
run_script --quiet 1
assert_success
assert_no_notification
assert_pending "threshold 30" "repo foo 2-1"
}
# --- Maintenance reminders ---
@test "pacnew files notify alone only when new" {
pacnew_files /etc/a.pacnew /etc/b.pacsave
run_script
assert_success
assert_notification "System maintenance" "Config files to merge with pacdiff: 2"
assert_pending "threshold 30" "pacnew /etc/a.pacnew" "pacnew /etc/b.pacsave"
run_script
assert_no_notification
pacnew_files /etc/a.pacnew /etc/b.pacsave /etc/c.pacnew
run_script
assert_notification "System maintenance" "Config files to merge with pacdiff: 3"
rm "$STUB_DATA/pacdiff"
run_script
assert_no_notification
[[ ! -e $STATE/maintenance ]]
}
@test "maintenance lines join every update notification" {
config THRESHOLD=1
repo_updates "foo 1-1 -> 2-1"
pacnew_files /etc/a.pacnew
run_script
assert_notification "Updates available" "Arch: 1, AUR: 0" "Config files to merge with pacdiff: 1"
repo_updates "foo 1-1 -> 2-1" "baz 1-1 -> 2-1"
run_script
assert_notification "Updates available" "Arch: 2, AUR: 0" "Config files to merge with pacdiff: 1"
}
@test "reboot reminder when the running kernel's vmlinuz is gone" {
STUB_KERNEL=0.0.0-gone run_script
assert_success
assert_notification "System maintenance" "Reboot to load the new kernel (running 0.0.0-gone)"
assert_pending "threshold 30" "reboot 0.0.0-gone"
}
@test "REBOOT_CHECK=0 disables the reboot reminder" {
config REBOOT_CHECK=0
STUB_KERNEL=0.0.0-gone run_script
assert_success
assert_no_notification
}
@test "PACNEW_CHECK=0 skips pacdiff" {
config PACNEW_CHECK=0
pacnew_files /etc/a.pacnew
run_script
assert_success
assert_no_notification
run ! grep -q '^pacdiff' "$STUB_DATA/calls"
}
# --- Reminders over the threshold ---
@test "git-monitor and firmware reminders over the threshold" {
enable_stub git-monitor
enable_stub fwupdmgr
config THRESHOLD=1
repo_updates "foo 1-1 -> 2-1"
FWUPD_RC=0 run_script
assert_success
assert_notification "Updates available" "Arch: 1, AUR: 0" \
"Also check: git-monitor, fwupdmgr (firmware updates available)"
assert_called "fwupdmgr get-updates --no-metadata-check"
}
@test "no firmware reminder without firmware updates" {
enable_stub git-monitor
enable_stub fwupdmgr
config THRESHOLD=1
repo_updates "foo 1-1 -> 2-1"
run_script
assert_notification "Updates available" "Arch: 1, AUR: 0" "Also check: git-monitor"
}
@test "no reminders below the threshold" {
enable_stub git-monitor
enable_stub fwupdmgr
custom_linux
installed "linux 6.1.2-1" "linux-custom 6.1.1-1"
run_script
assert_notification "Kernel update available" "Rebuild linux-custom (linux 6.1.2-1)"
run ! grep -q '^fwupdmgr' "$STUB_DATA/calls"
}
+5 -7
View File
@@ -6,12 +6,9 @@ set -u
# ---------------------------------------------------------------------------
THRESHOLD=30
AUR_REPO="aur-local"
# stock kernel package -> your custom build of it
declare -A KERNELS=(
[linux]="linux-custom"
[linux-lts]="linux-lts-custom"
[linux-zen]="linux-zen-custom"
)
# stock kernel package -> your custom build of it; none by default.
# Declared here so a [stock]=custom list in the config stays associative.
declare -A KERNELS=()
PACNEW_CHECK=1 # remind about .pacnew/.pacsave files (0 to disable)
REBOOT_CHECK=1 # remind to reboot after a kernel upgrade (0 to disable)
config_file="${XDG_CONFIG_HOME:-$HOME/.config}/update-notify/config"
@@ -137,8 +134,9 @@ if [[ $PACNEW_CHECK != 0 ]]; then
fi
fi
running_kernel=$(uname -r)
modules_dir=${UPDATE_NOTIFY_MODULES_DIR:-/usr/lib/modules} # override for tests (build chroots have no kernel)
# vmlinuz belongs to the kernel package, while DKMS files can keep the folder around
if [[ $REBOOT_CHECK != 0 && ! -e /usr/lib/modules/$running_kernel/vmlinuz ]]; then
if [[ $REBOOT_CHECK != 0 && ! -e $modules_dir/$running_kernel/vmlinuz ]]; then
maint_items+=("reboot $running_kernel")
maint_lines+=("Reboot to load the new kernel (running $running_kernel)")
fi