Merge branch 'dev'

bash/dup-live-disk.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 #
-# dup-live-disk.sh - duplicate live system partitions on new disk.
+# dup-live-disk.sh - duplicate (possibly live) system partitions
 #
 # (C) Bruno Raoult ("br"), 2007-2021
 # Licensed under the Mozilla Public License (MPL) version 2.0.
@@ -11,63 +11,466 @@
 #
 # SPDX-License-Identifier: MPL-2.0 <https://spdx.org/licenses/MPL-2.0.html>
 #
-# This script will not work for all situations, I strongly suggest you
+#%MAN_BEGIN%
-# don't use it if you don't *fully* understand it.
+# NAME
+#       dup-live-disk.sh - duplicate (possibly live) system partitions
+#
+# SYNOPSIS
+#       dup-live-disk.sh [OPTIONS] [SRC] DST
+#
+# DESCRIPTION
+#       Duplicate SRC disk partitions to same structured DST disk ones.
+#       if SRC is omitted, the running system disk (where root partition
+#       resides) will be used.
+#       Both SRC and DST *must* have same partition base LABELs - as 'LABEL'
+#       field for lsblk(1) and blkid(1), with an ending character (unique per
+#       disk) to differentiate them.
+#       For example, if partitions base labels are 'root', 'export', and 'swap',
+#       SRC disk the ending character '1' and DST disk the character '2', SRC
+#       partitions must be 'root1', 'export1, and 'swap1', and DST partitions
+#       must be 'root2', 'export2, and 'swap2'.
+#
+# OPTIONS
+#       -a, --autofs=DIR
+#          Use DIR as autofs "LABEL-based" automount. See AUTOFS below. Default
+#          is /mnt.
+#
+#       -c, --copy=ACTION
+#          ACTION can be 'yes' (all eligible partitions will be copied), 'no'
+#          (no partition will be copied), or 'ask' (will ask for all eligible
+#          partitions). Default is 'no'.
+#
+#       -d, --dry-run
+#          Dry-run: nothing will be really be done.
+#
+#       -g, --grub
+#          Install grub on destination disk.
+#          Warning: Only works if root partition contains all necessary for
+#          grub: /boot, /usr, etc...
+#
+#       -h, --help
+#          Display short help and exit.
+#
+#       -m, --man
+#          Display a "man-like" description and exit.
+#
+#       --mariadb
+#          Stop mysql/mariadb before effective copies, restart after.
+#
+#       -r, --root=PARTNUM
+#          Mandatory if SRC is provided, forbidden otherwise.
+#          PARTNUM is root partition number on SRC disk.
+#
+# EXAMPLES
+#       Copy sda to sdb, root partition is partition (sda1/sdb1)
+#       $ sudo dup-live-disk.sh --root 1 sda sdb
+#
+#       Copy live system (where / is mounted) to sdb
+#       $ sudo dup-live-disk.sh sdb
+#
+# BUGS
+#       * Cannot generate grub with a separate /boot partition.
+#       * This script will not work for all situations, I strongly suggest you
+#         don't use it if you don't *fully* understand it.
+#       * Extended attributes are not preserved (easy fix, but I cannot test)
+#
+# TODO
+#       * Write about autofs configuration.
+#       * Log levels
+#       * Check existence of prepared fstab on source root partition for
+#         destination root partition, and enable it.
+#%MAN_END%
 
-# dest device (used for grub)
+# command line
-DSTDISK=/dev/sdb
+SCRIPT="$0"
+CMD="${0##*/}"
 
-# partitions suffixes, for source and destination partitions.
+# valid filesystems
-# For example, if we want to copy XX partition, source partition will be
+# shellcheck disable=2034
-# /mnt/XX${SRCNUM}, and destination will be /mnt/XX${DSTNUM}
+VALIDFS=(ext3 ext4 btrfs vfat reiserfs xfs zfs)
-SRCNUM=2
-DSTNUM=1
 
-# array of partitions to copy
+function man {
-TO_COPY=(root export EFI)
+    sed -n '/^#%MAN_BEGIN%/,/^#%MAN_END%$/{//!s/^#[ ]\{0,1\}//p}' "$SCRIPT"
+}
 
-# An alternative to SRCNUM, DSTNUM, and TO_COPY variables would be to have
+function usage {
-# an array containing src and destination partitions:
+    cat <<_EOF
-#   (partsrc1 partdst1 partsrc2 partdst2 etc...)
+Usage: $CMD [OPTIONS] [SRC] DST
-# example:
+Duplicate SRC (or live system) disk partitions to DST disk partitions.
-# TO_COPY=(root2 root1 export2 export1)
-# declare -i i
-# for ((i=0; i<${#TO_COPY[@]}; i+=2)); do
-#     SRC=${#TO_COPY[$i]}
-#     DST=${#TO_COPY[$i + 1]}
-# etc...
 
-# where we will configure/install grub: mount point, device
+Options:
-GRUB_ROOT=/mnt/root${DSTNUM}
+      -a, --autofs=DIR     autofs "LABEL-based" directory. Default is '/mnt'.
-GRUB_DEV=/dev/$(lsblk -no pkname /dev/disk/by-label/root${DSTNUM})
+      -c, --copy=ACTION    do partitions copies ('yes'), do not copy then ('no')
+                           or ask for each of them ('ask'). Default is 'no'.
+      -d, --dry-run        dry-run: nothing will be written to disk
+      -g, --grub           install grub on destination disk
+      -h, --help           this help
+      -m, --man            display a "man-like" page and exit
+      --mariadb            stop and restart mysql/mariadb server before and
+                           after copies
+      -r, --root=PARTNUM   root partition number on SRC device
+                           mandatory if and only if SRC is provided
+
+SRC and DST have strong constraints on partitions schemes and naming.
+Type '$CMD --man" for more details"
+_EOF
+    exit 0
+}
+
+# mariadb start/stop
+function mariadb_maybe_stop {
+    if [[ $MARIADB == yes ]] && systemctl is-active --quiet mysql; then
+        #log -n "stopping mariadb/mysql... "
+        echorun systemctl stop mariadb
+        # bug if script stops here
+        MARIADBSTOPPED=yes
+        #log "done."
+    fi
+}
+function mariadb_maybe_start {
+    if [[ $MARIADB == yes && $MARIADBSTOPPED == yes ]]; then
+        #log -n "restarting mariadb/mysql... "
+        echorun systemctl start mariadb
+        MARIADBSTOPPED=no
+        #log "done."
+    fi
+}
+
+# log function
+# parameters:
+# -l, -s: long, or short prefix (default: none). Last one is used.
+# -t: timestamp
+# -n: no newline
+function log {
+    local timestr="" prefix="" opt=y newline=y
+    while [[ $opt = y ]]; do
+        case $1 in
+            -l) prefix=$(printf "*%.s" {1..30});;
+            -s) prefix=$(printf "*%.s" {1..5});;
+            -n) newline=n;;
+            -t) timestr=$(date "+%F %T%z - ");;
+            *) opt=n;;
+        esac
+        [[ $opt = y ]] && shift
+    done
+    [[ $prefix != "" ]] && printf "%s " "$prefix"
+    printf "%s" "$timestr"
+    # shellcheck disable=SC2059
+    printf "$@"
+    [[ $newline = y ]] && printf "\n"
+    return 0
+}
+
+# prints out and run a command.
+function echorun {
+    if [[ "$DRYRUN" == 'yes' ]]; then
+        log "%s " "dry-run: " "$@"
+    else
+        log "%s " "$@"
+        "$@"
+    fi
+}
+
+function error_handler {
+    local ERROR=$2
+    log "FATAL: Error line $1, exit code $2. Aborting."
+    exit "$ERROR"
+}
+trap 'error_handler $LINENO $?' ERR SIGHUP SIGINT SIGTERM
+
+function exit_handler {
+    local mnt
+
+    # log "exit handler (at line $1)"
+    mariadb_maybe_start
+    if [[ -n "$DSTMNT" ]] && mountpoint -q "$DSTMNT"; then
+        for mnt in "$DSTMNT"/{dev,proc,sys}; do
+            if mountpoint -q "$mnt"; then
+                echorun umount "$mnt"
+            fi
+        done
+    fi
+}
+
+trap 'exit_handler $LINENO' EXIT
+
+function check_block_device {
+    local devtype="$1"
+    local mode="$2"
+    local dev="$3"
+
+    if [[ ! -b "$dev" ]]; then
+        log "$CMD: $devtype '$dev' is not a block device."
+        exit 1
+    fi
+    if [[ ! -r "$dev" ]]; then
+        log "$CMD: $devtype '$dev' is not readable."
+        exit 1
+    fi
+    if [[ $mode = "w" && ! -w "$dev" ]]; then
+        log "$CMD: $devtype '$dev' is not writable."
+        exit 1
+    fi
+    return 0
+}
+
+# check if $1 is in array $2 ($2 is by reference)
+function in_array {
+    local elt=$1 i
+    local -n arr=$2
+    for ((i=0; i<${#arr[@]}; ++i)); do
+        [[ ${arr[$i]} == "$elt" ]] && return 0
+    done
+    return 1
+}
+
+# get y/n/q user input
+function yesno {
+    local input
+    while true; do
+        printf "%s " "$1"
+        read -r input
+        case "$input" in
+            y|Y)
+                return 0
+                ;;
+            q|Q)
+                log "aborting..."
+                exit 0
+                ;;
+            n|N)
+                return 1
+                ;;
+            *)
+                printf "invalid answer. "
+        esac
+    done
+}
+
+# source and destination devices, root partition
+SRC=""
+DST=""
+SRCROOT=""
+ROOTPARTNUM=""
+AUTOFS_DIR=/mnt
+
+DRYRUN=no                                         # dry-run
+GRUB=no                                           # install grub
+COPY=no                                           # do FS copies
+MARIADB=no                                        # stop/start mysql/mariadb
+MARIADBSTOPPED=no                                 # mysql stopped ?
+
+# short and long options
+SOPTS="a:c:dghmr:"
+LOPTS="autofs:,copy:,dry-run,grub,help,man,mariadb,root:"
+
+if ! TMP=$(getopt -o "$SOPTS" -l "$LOPTS" -n "$CMD" -- "$@"); then
+    log "Use '$CMD --help' or '$CMD --man' for help."
+    exit 1
+fi
+
+eval set -- "$TMP"
+unset TMP
+
+while true; do
+    case "$1" in
+        '-a'|'--autofs')
+            AUTOFS_DIR="$2"
+            shift
+            ;;
+        '-c'|'--copy')
+            case "$2" in
+                "no") COPY=no;;
+                "yes") COPY=yes;;
+                "ask") COPY=ask;;
+                *) log "invalid '$2' --copy flag"
+                   usage
+                   exit 1
+            esac
+            shift
+            ;;
+        '-d'|'--dry-run')
+            DRYRUN=yes
+            ;;
+        '-g'|'--grub')
+            GRUB=yes
+            ;;
+        '-h'|'--help')
+            usage
+            exit 0
+            ;;
+        '-m'|'--man')
+            man
+            exit 0
+            ;;
+        '--mariadb')
+            MARIADB=yes
+            ;;
+        '-r'|'--root')
+            ROOTPARTNUM="$2"
+            if ! [[ "$ROOTPARTNUM" =~ ^[[:digit:]]+$ ]]; then
+                log "$CMD: $ROOTPARTNUM must be a partition number."
+                exit 1
+            fi
+            shift
+            ;;
+        '--')
+            shift
+            break
+            ;;
+        *)
+            usage
+            log 'Internal error!'
+            exit 1
+            ;;
+    esac
+    shift
+done
+
+case "$#" in
+    1)
+        if [[ -n "$ROOTPARTNUM" ]]; then
+            log "$CMD: cannot have --root option for live system."
+            log "Use '$CMD --help' or '$CMD --man' for help."
+            exit 1
+        fi
+        # guess root partition disk name
+        SRCROOT=$(findmnt -no SOURCE -M /)
+        ROOTPARTNUM=${SRCROOT: -1}
+        SRC="/dev/"$(lsblk -no pkname "$SRCROOT")
+        DST="/dev/$1"
+        ;;
+    2)
+        if [[ -z "$ROOTPARTNUM" ]]; then
+            log "$CMD: missing --root option for non live system."
+            log "Use '$CMD --help' or '$CMD --man' for help."
+            exit 1
+        fi
+        SRC="/dev/$1"
+        SRCROOT="$SRC$ROOTPARTNUM"
+        DST="/dev/$2"
+        ;;
+    *)
+        usage
+        exit 1
+esac
+
+# check SRC and DST are different, find out their characteristics
+if [[ "$SRC" = "$DST" ]]; then
+    log "%s: Fatal: destination disk (%s) cannot be source.\n" "$CMD" "$SRC"
+    log "Use '%s --help' or '%s --man' for help." "$CMD" "$CMD"
+    exit 1
+fi
+check_block_device "source disk" r "$SRC"
+check_block_device "destination disk" w "$DST"
+check_block_device "source root partition" r "$SRCROOT"
+
+SRCROOTLABEL=$(lsblk -no label "$SRCROOT")
+SRCCHAR=${SRCROOTLABEL: -1}
+ROOTLABEL=${SRCROOTLABEL:0:-1}
+
+# find out all partitions labels on SRC disk...
+# shellcheck disable=SC2207
+declare -a SRCLABELS=($(lsblk -lno  LABEL "$SRC"))
+# shellcheck disable=SC2206
+declare -a LABELS=(${SRCLABELS[@]%?})
+
+# ... and corresponding partition device and fstype
+declare -a SRCDEVS SRCFS SRC_VALID_FS
+for ((i=0; i<${#LABELS[@]}; ++i)); do
+    TMP="${LABELS[$i]}$SRCCHAR"
+    TMP="${SRCLABELS[$i]}"
+    TMPDEV=$(findfs LABEL="$TMP")
+    TMPFS=$(lsblk -no fstype "$TMPDEV")
+    log "found LABEL=$TMP DEV=$TMPDEV FSTYPE=$TMPFS"
+    SRCDEVS[$i]="$TMPDEV"
+    SRCFS[$i]="$TMPFS"
+    SRC_VALID_FS[$i]=n
+    in_array "$TMPFS" VALIDFS && SRC_VALID_FS[$i]=y
+    unset TMP TMPDEV TMPFS
+done
+
+DSTROOT="$DST$ROOTPARTNUM"
+check_block_device "destination root partition" w "$DSTROOT"
+DSTROOTLABEL=$(lsblk -no label "$DSTROOT")
+DSTCHAR=${DSTROOTLABEL: -1}
+
+# check DSTROOTLABEL is compatible with ROOTLABEL
+if [[ "$DSTROOTLABEL" != "$ROOTLABEL$DSTCHAR" ]]; then
+    log "%s: Fatal: %s != %s%s." "$CMD" "$DSTROOTLABEL" "$ROOTLABEL" "$DSTCHAR"
+    exit 1
+fi
+
+declare -a DSTLABELS DSTDEVS DSTFS DST_VALID_FS
+# Do the same for corresponding DST partitions labels, device, and fstype
+for ((i=0; i<${#LABELS[@]}; ++i)); do
+    TMP="${LABELS[$i]}$DSTCHAR"
+    log -n "Looking for [%s] label... " "$TMP"
+    if ! TMPDEV=$(findfs LABEL="$TMP"); then
+        log "not found."
+        exit 1
+    fi
+    TMPDISK=${TMPDEV%?}
+    log -n "DEV=%s... DISK=%s..." "$TMPDEV" "$TMPDISK"
+    if [[ "$TMPDISK" != "$DST" ]]; then
+        log "wrong disk (%s != %s)" "$TMPDISK" "$DST"
+        exit 1
+    fi
+    TMPFS=$(lsblk -no fstype "$TMPDEV")
+    log "FSTYPE=%s" "$TMPFS"
+    DSTLABELS[$i]="$TMP"
+    DSTDEVS[$i]="$TMPDEV"
+    DSTFS[$i]="$TMPFS"
+    DST_VALID_FS[$i]=n
+    in_array "$TMPFS" VALIDFS && DST_VALID_FS[$i]=y
+    unset TMP TMPDEV TMPFS
+done
+
+for ((i=0; i<${#LABELS[@]}; ++i)); do
+    log -n "%s %s " "${SRCDEVS[$i]}" "${DSTDEVS[$i]}"
+    log -n "%s %s " "${SRCLABELS[$i]}" "${DSTLABELS[$i]}"
+    log -n "%s %s "  "${SRCFS[$i]}" "${DSTFS[$i]}"
+    log -n "%s %s "  "${SRC_VALID_FS[$i]}" "${DST_VALID_FS[$i]}"
+    [[ "$DSTROOTLABEL" == "${DSTLABELS[$i]}" ]] && log "*"
+    echo
+done | column -N DEV1,DEV2,LABEL1,LABEL2,FS1,FS2,SVALID\?,DVALID\?,ROOT -t -o " | "
 
-# we will use ".rsync-disk-copy" files to exclude files/dirs
 RSYNCOPTS="-axH --delete --delete-excluded"
 FILTER=--filter="dir-merge .rsync-disk-copy"
+# copy loop
+for ((i=0; i<${#LABELS[@]}; ++i)); do
+    if [[ "${SRC_VALID_FS[$i]}" != y ]] || [[ "${DST_VALID_FS[$i]}" != y ]]; then
+        log "skipping label %s" "${LABELS[$i]}"
+        continue
+    fi
+    SRCPART="${AUTOFS_DIR}/${SRCLABELS[$i]}/"
+    DSTPART="$AUTOFS_DIR/${DSTLABELS[$i]}"
 
-# stop what could be problematic (databases, etc...)
+    #log -n "%s -> %s : " "$SRCPART" "$DSTPART"
-systemctl stop mysql
+    #log "\t%s %s %s %s %s" rsync "${RSYNCOPTS}" "$FILTER" "$SRCPART" "$DSTPART"
-
+    copy="$COPY"
-# partitions copy
+    if [[ "$COPY" == 'ask' ]]; then
-for part in ${TO_COPY[@]}; do
+        yesno "Copy $SRCPART to $DSTPART ? [y/n/q]" && copy=yes || copy=no
-    SRCPART=/mnt/${part}${SRCNUM}/
+    fi
-    DSTPART=/mnt/${part}${DSTNUM}
+    if [[ "$copy" == yes ]]; then
-
+        mariadb_maybe_stop
-    echo copy from $SRCPART to $DSTPART
+        # shellcheck disable=SC2086
-    echo -n "press a key to continue..."
+        echorun rsync "$FILTER" ${RSYNCOPTS} "$SRCPART" "$DSTPART"
-    read -r key
+    fi
-    echo rsync ${RSYNCOPTS} "$FILTER" "$SRCPART" "$DSTPART"
+    #log ""
-    rsync ${RSYNCOPTS} "$FILTER" "$SRCPART" "$DSTPART"
 done
 
 # grub install
-# mount virtual devices
+if [[ "$GRUB" == yes ]]; then
-mount -o bind  /sys    ${GRUB_ROOT}/sys
+    log "installing grub on $DST..."
-mount -o bind  /proc   ${GRUB_ROOT}/proc
+    DSTMNT="$AUTOFS_DIR/$DSTROOTLABEL"
-mount -o bind  /dev    ${GRUB_ROOT}/dev
+    # mount virtual devices
+    echorun mount -o bind /sys  "$DSTMNT/sys"
+    echorun mount -o bind /proc "$DSTMNT/proc"
+    echorun mount -o bind /dev  "$DSTMNT/dev"
 
-chroot ${GRUB_ROOT} update-grub
+    echorun chroot "$DSTMNT" update-grub
-chroot ${GRUB_ROOT} grub-install ${GRUB_DEV}
+    echorun chroot "$DSTMNT" grub-install "$DST"
+fi
 
-# restart stopped process (db, etc...)
+exit 0
-systemctl start mysql