Skip to content

Instantly share code, notes, and snippets.

@erikw
Last active December 24, 2023 06:11
Show Gist options
  • Save erikw/5229436 to your computer and use it in GitHub Desktop.
Save erikw/5229436 to your computer and use it in GitHub Desktop.
snp: Wrap shell command in BTRFS snapper pre-post snapshots and log outputs.
#!/usr/bin/env bash
# Runs a command wrapped in btrfs snapper pre-post snapshots.
# Usage: $ snp <commands>
# e.g.: $ snp pacman -Syyu
# Requirements: snapper (https://wiki.archlinux.org/title/snapper)
# The latest version of this script is hosted at https://gist.github.com/erikw/5229436
log_path="/var/local/log/snp"
date=$(date "+%Y-%m-%d-%H%M%S")
log_file="${log_path}/snp_${date}.log"
! [ -d $log_path ] && mkdir -p $log_path
# Log stdout and stderr. Reference: http://stackoverflow.com/questions/3173131/redirect-copy-of-stdout-to-log-file-from-within-bash-script-itself
exec > >(tee -a "$log_file")
exec 2> >(tee -a "$log_file" >&2)
cmd="$@"
echo "> Logging to: ${log_file}"
snapshot_nbr=$(snapper create --type=pre --cleanup-algorithm=number --print-number --description="${cmd}")
echo "> New pre snapshot with number ${snapshot_nbr}."
echo -e "> Running command \"${cmd}\".\n"
eval "$cmd"
snapshot_nbr=$(snapper create --type=post --cleanup-algorithm=number --print-number --pre-number="$snapshot_nbr")
echo -e "\n> New post snapshot with number ${snapshot_nbr}."
# Snapper has a --command option nowadays. But it works worse, the output from the command is not printed separately from the snaptshot number, just becomes a mess.
#echo "> Running command \"${cmd}\"."
#snapshot_nbr=$(snapper create --command "${cmd}" --print-number --cleanup-algorithm=number --description="${cmd}" | tail -1)
#echo -e "\n> New pre-post snapshot with numbers ${snapshot_nbr}."
@Fire100265
Copy link

Fire100265 commented Dec 21, 2020

@erikw Thank you! I have written a PKGBUILD and I will be submitting it to the AUR soon. As you have predicted, gists do not work very well with PKGBUILDs. Due to this, I copied all the text into a file and used it as the source.
Edit: Here is the link to the AUR page. Please let me know of any changes I should make. I can add you as a maintainer if you wish.

@erikw
Copy link
Author

erikw commented Dec 30, 2020

@Fire100265 The PKGBUILD looks great!

There can only be 1 maintainer in AUR right? To distribute comments and future maintenance questions you could tell people to reach out to me as well of your unavailable, here at Github or my AUR profile https://aur.archlinux.org/account/erikw :)

@Fire100265
Copy link

Fire100265 commented Dec 30, 2020

Thank you for your reply! I added you as a maintainer. Please let me know if you can access the package.
Edit: please edit the PKGBUILD to add your email.

@erikw
Copy link
Author

erikw commented Dec 30, 2020

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment