feat(repo): Add the repo pull command to fetch and integrate changes

The command can be used to bring all repositories up to date with their
respective upstream repositories hosted on gitlab. On top several
subcommand options allow to enhance the output by printing the changed
diff as well as control behavior like discarding changes or auto
stashing on pull.

Fixes #211

Component: pkgctl repo pull
Co-authored-by: Levente Polyak <anthraxx@archlinux.org>
Signed-off-by: Christian Heusel <christian@heusel.eu>

contrib/completion/bash/devtools.in

@@ -305,6 +305,7 @@ _pkgctl_repo_cmds=(
 	clone
 	configure
 	create
+	pull
 	switch
 	web
 )
@@ -334,6 +335,19 @@ _pkgctl_repo_clean_args=(
 )
 _pkgctl_repo_clean_opts() { _filedir -d; }
 
+_pkgctl_repo_pull_args=(
+	--discard-changes
+	--show-diff
+	--quiet
+	--autostash
+	-f --force
+	-j --jobs
+	-h --help
+)
+_pkgctl_repo_pull_args__jobs_opts() { :; }
+_pkgctl_repo_pull_args_j_opts() { _pkgctl_repo_pull_args__jobs_opts; }
+_pkgctl_repo_pull_opts() { _filedir -d; }
+
 _pkgctl_repo_configure_args=(
 	--protocol
 	-j --jobs

contrib/completion/zsh/_devtools.in

@@ -228,6 +228,7 @@ _pkgctl_repo_cmds=(
 	"clone[Clone a package repository]"
 	"configure[Configure a clone according to distro specs]"
 	"create[Create a new GitLab package repository]"
+	"pull[Update package repositories from their git remote]"
 	"switch[Switch a package repository to a specified version]"
 	"web[Open the packaging repository's website]"
 )
@@ -256,6 +257,17 @@ _pkgctl_repo_clone_args=(
 	'*:packages:_devtools_completions_all_packages'
 )
 
+_pkgctl_repo_pull_args=(
+	'--discard-changes[Discard changes if index or working tree is dirty]'
+	'--quiet[Disable printing longer terminal output]'
+	'--show-diff[Always enable showing the diff]'
+	'--autostash[Stash before pulling and unstash afterwards]'
+	'(-f --force)'{-f,--force}'[Alias for --discard-changes]'
+	'(-j --jobs)'{-j,--jobs}'[Run up to N jobs in parallel (default: number of processing units)]:jobs:'
+	'(-h --help)'{-h,--help}'[Display usage]'
+	'*:git_dir:_files -/'
+)
+
 _pkgctl_repo_configure_args=(
 	'--protocol[Configure remote url to use https]:proto:(https)'
 	'(-j --jobs)'{-j,--jobs}'[Run up to N jobs in parallel (default: number of processing units)]:jobs:'

doc/man/pkgctl-repo-pull.1.asciidoc

@@ -0,0 +1,50 @@
+pkgctl-repo-pull(1)
+===================
+
+Name
+----
+pkgctl-repo-pull - Pull in git changes
+
+Synopsis
+--------
+pkgctl repo pull [OPTIONS] [PATH...]
+
+Description
+-----------
+
+Update package repositories from their git remotes.
+
+If only a single package is given the command also automatically shows a diff
+of what has changed since the last time the repository was updated.
+
+Options
+-------
+
+*--discard-changes*::
+	Discard changes if the index or working tree was modified. Otherwise abort
+	if anything was modified.
+
+*--autostash*::
+	Stash before pulling and unstash afterwards
+
+*--quiet*::
+	Do not show any longer terminal output like diffs.
+
+*--show-diff*::
+	Show what has changed since the last time the repository was updated. Is
+	automatically set when only one 'PATH' is given.
+
+*-j, --jobs* 'N'::
+	Run up to N jobs in parallel. By default the number of jobs is equal to the
+	number of available processing units. For sequential processing this option
+	needs to be passed with 1.
+
+*-h, --help*::
+	Show a help text
+
+See Also
+--------
+
+git-pull(1)
+
+include::include/footer.asciidoc[]

doc/man/pkgctl-repo.1.asciidoc

@@ -44,6 +44,9 @@ pkgctl repo configure::
 pkgctl repo create::
 	Create a new GitLab package repository
 
+pkgctl repo pull::
+	Update package repositories from their git remotes
+
 pkgctl repo switch::
 	Switch a package repository to a specified version
 
@@ -57,6 +60,7 @@ pkgctl-repo-clean(1)
 pkgctl-repo-clone(1)
 pkgctl-repo-configure(1)
 pkgctl-repo-create(1)
+pkgctl-repo-pull(1)
 pkgctl-repo-switch(1)
 pkgctl-repo-web(1)
 

src/lib/repo.sh

@@ -31,6 +31,7 @@ pkgctl_repo_usage() {
 		    clone          Clone a package repository
 		    configure      Configure a clone according to distro specs
 		    create         Create a new GitLab package repository
+		    pull           Update package repositories from their git remote
 		    switch         Switch a package repository to a specified version
 		    web            Open the packaging repository's website
 
@@ -40,6 +41,7 @@ pkgctl_repo_usage() {
 		EXAMPLES
 		    $ ${COMMAND} clean --interactive *
 		    $ ${COMMAND} clone libfoo linux libbar
+		    $ ${COMMAND} pull libfoo linux libbar
 		    $ ${COMMAND} clone --maintainer mynickname
 		    $ ${COMMAND} configure *
 		    $ ${COMMAND} create libfoo
@@ -101,6 +103,14 @@ pkgctl_repo() {
 				pkgctl_repo_switch "$@"
 				exit 0
 				;;
+			pull)
+				_DEVTOOLS_COMMAND+=" $1"
+				shift
+				# shellcheck source=src/lib/repo/pull.sh
+				source "${_DEVTOOLS_LIBRARY_DIR}"/lib/repo/pull.sh
+				pkgctl_repo_pull "$@"
+				exit 0
+				;;
 			web)
 				_DEVTOOLS_COMMAND+=" $1"
 				shift

src/lib/repo/pull.sh

@@ -0,0 +1,195 @@
+#!/bin/bash
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+[[ -z ${DEVTOOLS_INCLUDE_REPO_PULL_SH:-} ]] || return 0
+DEVTOOLS_INCLUDE_REPO_PULL_SH=1
+
+_DEVTOOLS_LIBRARY_DIR=${_DEVTOOLS_LIBRARY_DIR:-@pkgdatadir@}
+# shellcheck source=src/lib/common.sh
+source "${_DEVTOOLS_LIBRARY_DIR}"/lib/common.sh
+# shellcheck source=src/lib/util/git.sh
+source "${_DEVTOOLS_LIBRARY_DIR}"/lib/util/git.sh
+
+source /usr/share/makepkg/util/message.sh
+
+set -eo pipefail
+
+
+pkgctl_repo_pull_usage() {
+	local -r COMMAND=${_DEVTOOLS_COMMAND:-${BASH_SOURCE[0]##*/}}
+	cat <<- _EOF_
+		Usage: ${COMMAND} [OPTIONS] [PKGBASE]...
+
+		Update package repositories from their git remotes.
+
+		OPTIONS
+		    --discard-changes   Discard changes if index or working tree is dirty
+		    --show-diff         Always enable showing the diff
+		    --autostash         Stash before pulling and unstash afterwards
+		    -j, --jobs N        Run up to N jobs in parallel (default: $(nproc))
+		    --quiet             Disable printing longer terminal output
+		    -h, --help          Show this help text
+
+		EXAMPLES
+		    $ ${COMMAND} gopass gopass-jsonapi
+_EOF_
+}
+
+pkgctl_repo_pull() {
+	# options
+	local paths path pkgbase branch jobs remote
+	jobs=$(nproc)
+	local command=${_DEVTOOLS_COMMAND:-${BASH_SOURCE[0]##*/}}
+	local git_rebase_options=()
+	local SHOW_DIFF=0
+	local QUIET=0
+	local DISCARD_CHANGES=0
+	local AUTOSTASH=0
+
+	while (( $# )); do
+		case $1 in
+			-h|--help)
+				pkgctl_repo_pull_usage
+				exit 0
+				;;
+			--discard-changes)
+				DISCARD_CHANGES=1
+				shift
+				;;
+			--show-diff)
+				SHOW_DIFF=1
+				shift
+				;;
+			--quiet)
+				QUIET=1
+				shift
+				;;
+			--autostash)
+				AUTOSTASH=1
+				git_rebase_options+=(--autostash)
+				shift
+				;;
+			-j|--jobs)
+				(( $# <= 1 )) && die "missing argument for %s" "$1"
+				jobs=$2
+				shift 2
+				;;
+			--)
+				shift
+				break
+				;;
+			-*)
+				die "invalid argument: %s" "$1"
+				;;
+			*)
+				paths=("$@")
+				break
+				;;
+		esac
+	done
+
+	# check if invoked without any path from within a packaging repo
+	if (( ${#paths[@]} == 0 )); then
+		paths=(".")
+	fi
+
+	# check if we are only working on one repo and enable
+	if (( ${#paths[@]} == 1 )) && (( ! QUIET )); then
+		SHOW_DIFF=1
+	fi
+
+	# parallelization
+	if [[ ${jobs} != 1 ]] && (( ${#paths[@]} > 1 )); then
+		if [[ -n ${BOLD} ]]; then
+			export DEVTOOLS_COLOR=always
+		fi
+
+		# warm up ssh connection as it may require user input (key unlock, hostkey verification etc)
+		git_warmup_ssh_connection
+
+		# disable diffs if not enabled explicitly
+		if (( ! SHOW_DIFF )); then
+			command+=" --quiet"
+		fi
+
+		if (( DISCARD_CHANGES )); then
+			command+=" --discard-changes"
+		fi
+
+		if (( AUTOSTASH )); then
+			command+=" --autostash"
+		fi
+
+		if ! parallel --bar --jobs "${jobs}" "${command}" ::: "${paths[@]}"; then
+			die 'Failed to pull some packages, please check the previous output'
+		fi
+		exit 0
+	fi
+
+	for path in "${paths[@]}"; do
+		# skip paths that are not directories
+		if [[ ! -d "${path}" ]]; then
+			continue
+		fi
+
+		if [[ ! -f "${path}/PKGBUILD" ]]; then
+			msg_error "  Not a package repository: ${path}"
+			continue
+		fi
+
+		if [[ ! -d "${path}/.git" ]]; then
+			msg_error "  Not a Git repository: ${path}"
+			continue
+		fi
+
+		pkgbase=$(basename "$(realpath "${path}")")
+		pkgbase=${pkgbase%.git}
+		msg "Updating ${pkgbase}"
+
+		branch=$(git -C "${path}" symbolic-ref --quiet --short HEAD)
+		if [[ ${branch} != main ]]; then
+			msg_warn "  Current branch is ${branch}, not updating from canonical upstream: ${pkgbase}"
+		fi
+
+		if ! git -C "${path}" diff-files --quiet && (( ! AUTOSTASH )) && (( ! DISCARD_CHANGES )); then
+			msg_error "  Index contains unstaged changes, please stash them or pass --autostash before pulling: ${pkgbase}"
+			continue
+		fi
+
+		if ! git -C "${path}" diff-index --cached --quiet HEAD && (( ! AUTOSTASH )) && (( ! DISCARD_CHANGES )); then
+			msg_error "  Index contains uncommited changes, please commit or stash them before pulling: ${pkgbase}"
+			continue
+		fi
+
+		remote=$(git -C "${path}" config "branch.${branch}.remote")
+		if [[ -z "${remote}" ]]; then
+			msg_error "  No upstream tracking branch configured: ${pkgbase}"
+			continue
+		fi
+
+		if ! git -C "${path}" fetch --quiet "${remote}"; then
+			msg_error "  Error while fetching: ${pkgbase}"
+			continue
+		fi
+
+		if [[ $(git -C "${path}" rev-parse HEAD) == $(git -C "${path}" rev-parse FETCH_HEAD) ]]; then
+			msg2 "Repo is up to date, nothing to do"
+			continue
+		fi
+
+		# discard any local modifications
+		if (( DISCARD_CHANGES )); then
+			git -C "${path}" restore --staged --worktree -- .
+		fi
+
+		if (( SHOW_DIFF )) && (( ! QUIET )); then
+			git -C "${path}" --no-pager diff --color --patch-with-stat HEAD..FETCH_HEAD
+		fi
+
+		if ! git -C "${path}" rebase --quiet "${git_rebase_options[@]}" "${remote}/${branch}"; then
+			msg_error "  Error while pulling in the changes for ${pkgbase}"
+			exit 1
+		fi
+	done
+}