Merge branch 'version_upgrade_confirm' into 'master'

feat(version upgrade): Add diff & confirmation for pkgctl version upgrade

Closes #239

See merge request archlinux/devtools!274

contrib/completion/bash/devtools.in

@@ -150,6 +150,7 @@ _pkgctl_cmds=(
 	db
 	diff
 	issue
+	license
 	release
 	repo
 	search
@@ -417,6 +418,7 @@ _pkgctl_version_setup_args__url_opts() { :; }
 
 _pkgctl_version_upgrade_args=(
 	--no-update-checksums
+	--noconfirm
 	-v --verbose
 	-h --help
 )

contrib/completion/zsh/_devtools.in

@@ -456,6 +456,7 @@ _pkgctl_version_setup_args=(
 
 _pkgctl_version_upgrade_args=(
 	'--no-update-checksums[Disable computation and update of the checksums]'
+	'--noconfirm[Do not ask to confirm changes made to the PKGBUILD file]'
 	'(-v --verbose)'{-v,--verbose}'[Display results including up-to-date versions]'
 	'(-h --help)'{-h,--help}'[Display usage]'
 	'*:git_dir:_files -/'

doc/man/pkgctl-version-upgrade.1.asciidoc

@@ -38,6 +38,9 @@ Options
 *--no-update-checksums*::
 	Disable computation and update of the checksums
 
+*--noconfirm*::
+	Do not ask to confirm changes made to the PKGBUILD file
+
 *-v, --verbose*::
 	Display results including up-to-date versions
 

src/lib/util/pkgbuild.sh

@@ -21,15 +21,21 @@ pkgbuild_set_pkgver() {
 	local new_pkgver=$1
 	local pkgver=${pkgver}
 
+	if [[ -n $2 ]]; then
+		pkgbuild_file=$2
+	else
+		pkgbuild_file="PKGBUILD"
+	fi
+
 	if [[ $(type -t pkgver) == function ]]; then
 		# TODO: check if die or warn, if we provide _commit _gitcommit setter maybe?
 		warning 'setting pkgver variable has no effect if the PKGBUILD has a pkgver() function'
 	fi
 
-	if ! grep --extended-regexp --quiet --max-count=1 "^pkgver=${pkgver}$" PKGBUILD; then
+	if ! grep --extended-regexp --quiet --max-count=1 "^pkgver=${pkgver}$" "${pkgbuild_file}"; then
 		die "Non-standard pkgver declaration"
 	fi
-	sed --regexp-extended "s|^(pkgver=)${pkgver}$|\1${new_pkgver}|g" --in-place PKGBUILD
+	sed --regexp-extended "s|^(pkgver=)${pkgver}$|\1${new_pkgver}|g" --in-place "${pkgbuild_file}"
 }
 
 # set the pkgrel variable in a PKGBUILD
@@ -38,10 +44,16 @@ pkgbuild_set_pkgrel() {
 	local new_pkgrel=$1
 	local pkgrel=${pkgrel}
 
-	if ! grep --extended-regexp --quiet --max-count=1 "^pkgrel=${pkgrel}$" PKGBUILD; then
+	if [[ -n $2 ]]; then
+		pkgbuild_file=$2
+	else
+		pkgbuild_file="PKGBUILD"
+	fi
+
+	if ! grep --extended-regexp --quiet --max-count=1 "^pkgrel=${pkgrel}$" "${pkgbuild_file}"; then
 		die "Non-standard pkgrel declaration"
 	fi
-	sed --regexp-extended "s|^(pkgrel=)${pkgrel}$|\1${new_pkgrel}|g" --in-place PKGBUILD
+	sed --regexp-extended "s|^(pkgrel=)${pkgrel}$|\1${new_pkgrel}|g" --in-place "${pkgbuild_file}"
 }
 
 pkgbuild_update_checksums() {
@@ -53,6 +65,14 @@ pkgbuild_update_checksums() {
 	builddir=$(mktemp --tmpdir="${WORKDIR}" --directory update-checksums.XXXXXX)
 	newbuildfile="${builddir}/PKGBUILD"
 
+	if [[ -n $2 ]]; then
+		pkgbuild_file=$2
+		cp PKGBUILD "${builddir}/PKGBUILD-tmp" && mv -f "${pkgbuild_file}" PKGBUILD && mv "${builddir}/PKGBUILD-tmp" "${pkgbuild_file}"
+	else
+		pkgbuild_file="PKGBUILD"
+	fi
+
+
 	# generate new integrity checksums
 	if ! newsums=$(BUILDDIR=${builddir} makepkg_generate_integrity 2>"${status_file}"); then
 		printf 'Failed to generate new checksums'
@@ -81,9 +101,13 @@ pkgbuild_update_checksums() {
 		return 1
 	fi
 
+	if [[ "${pkgbuild_file}" != "PKGBUILD" ]]; then
+		cp PKGBUILD "${builddir}/PKGBUILD-tmp" && mv -f "${pkgbuild_file}" PKGBUILD && mv "${builddir}/PKGBUILD-tmp" "${pkgbuild_file}"
+	fi
+
 	# overwrite the original PKGBUILD while preserving permissions
-	if ! cat -- "${newbuildfile}" > PKGBUILD; then
+	if ! cat -- "${newbuildfile}" > "${pkgbuild_file}"; then
-		printf "Failed to write to the PKGBUILD file"
+		printf "Failed to write to the ${pkgbuild_file} file"
 		return 1
 	fi
 

src/lib/version/upgrade.sh

@@ -37,6 +37,7 @@ pkgctl_version_upgrade_usage() {
 
 		OPTIONS
 		    --no-update-checksums  Disable computation and update of the checksums
+		    --noconfirm            Do not ask to confirm changes made to the PKGBUILD file
 		    -v, --verbose          Display results including up-to-date versions
 		    -h, --help             Show this help text
 
@@ -52,6 +53,8 @@ pkgctl_version_upgrade() {
 	local exit_code=0
 	local current_item=0
 	local update_checksums=1
+	local noconfirm=0
+	local apply_changes=0
 
 	while (( $# )); do
 		case $1 in
@@ -63,6 +66,10 @@ pkgctl_version_upgrade() {
 				update_checksums=0
 				shift
 				;;
+			--noconfirm)
+				noconfirm=1
+				shift
+				;;
 			-v|--verbose)
 				verbose=1
 				shift
@@ -123,7 +130,8 @@ pkgctl_version_upgrade() {
 		# reset common PKGBUILD variables
 		unset pkgbase pkgname arch source pkgver pkgrel validpgpkeys
 		# shellcheck source=contrib/makepkg/PKGBUILD.proto
-		. ./PKGBUILD
+		cp -f PKGBUILD PKGBUILD_version_upgrade.tmp
+		. ./PKGBUILD_version_upgrade.tmp
 		pkgbase=${pkgbase:-$pkgname}
 
 		# update the current terminal spinner status
@@ -140,6 +148,7 @@ pkgctl_version_upgrade() {
 		if ! result=$(get_upstream_version); then
 			result="${BOLD}${pkgbase}${ALL_OFF}: ${result}"
 			failure+=("${result}")
+			rm -f PKGBUILD_version_upgrade.tmp
 			popd >/dev/null
 			continue
 		fi
@@ -148,6 +157,7 @@ pkgctl_version_upgrade() {
 		if ! result=$(vercmp "${upstream_version}" "${pkgver}"); then
 			result="${BOLD}${pkgbase}${ALL_OFF}: failed to compare version ${upstream_version} against ${pkgver}"
 			failure+=("${result}")
+			rm -f PKGBUILD_version_upgrade.tmp
 			popd >/dev/null
 			continue
 		fi
@@ -155,16 +165,19 @@ pkgctl_version_upgrade() {
 		if (( result == 0 )); then
 			result="${BOLD}${pkgbase}${ALL_OFF}: current version ${PURPLE}${pkgver}${ALL_OFF} is latest"
 			up_to_date+=("${result}")
+			rm -f PKGBUILD_version_upgrade.tmp
 		elif (( result < 0 )); then
 			result="${BOLD}${pkgbase}${ALL_OFF}: current version ${PURPLE}${pkgver}${ALL_OFF} is newer than ${DARK_GREEN}${upstream_version}${ALL_OFF}"
 			up_to_date+=("${result}")
+			rm -f PKGBUILD_version_upgrade.tmp
 		elif (( result > 0 )); then
 			result="${BOLD}${pkgbase}${ALL_OFF}: upgraded from version ${PURPLE}${pkgver}${ALL_OFF} to ${DARK_GREEN}${upstream_version}${ALL_OFF}"
 			out_of_date+=("${result}")
+			out_of_date_paths+=("${path}")
 
-			# change the PKGBUILD
+			# make changes to the temporary PKGBUILD file
-			pkgbuild_set_pkgver "${upstream_version}"
+			pkgbuild_set_pkgver "${upstream_version}" PKGBUILD_version_upgrade.tmp
-			pkgbuild_set_pkgrel 1
+			pkgbuild_set_pkgrel 1 PKGBUILD_version_upgrade.tmp
 
 			# download sources and update the checksums
 			if (( update_checksums )); then
@@ -178,9 +191,10 @@ pkgctl_version_upgrade() {
 					"${pkgbase}" \
 					"updating checksums"
 
-				if ! result=$(pkgbuild_update_checksums /dev/null); then
+				if ! result=$(pkgbuild_update_checksums /dev/null PKGBUILD_version_upgrade.tmp); then
 					result="${BOLD}${pkgbase}${ALL_OFF}: failed to update checksums for version ${DARK_GREEN}${upstream_version}${ALL_OFF}"
 					failure+=("${result}")
+					cp PKGBUILD "${status_dir}/PKGBUILD-tmp" && mv -f PKGBUILD_version_upgrade.tmp PKGBUILD && mv "${status_dir}/PKGBUILD-tmp" PKGBUILD_version_upgrade.tmp
 				fi
 			fi
 		fi
@@ -225,6 +239,47 @@ pkgctl_version_upgrade() {
 			"${#failure[@]}"
 	fi
 
+	# upgrade out of date packages
+	for ood_path in "${out_of_date_paths[@]}"; do
+		pushd "${ood_path}" >/dev/null
+
+		# print changes
+		echo
+		diff --unified --color PKGBUILD PKGBUILD_version_upgrade.tmp || true
+
+		# if --noconfirm is passed, directly apply changes without asking for confirmation
+		if (( noconfirm == 1 )); then
+			apply_changes=1
+		else
+			apply_changes=0
+		fi
+
+		# ask confirmation before making changes to the actual PKGBUILD
+		if (( apply_changes == 0 )); then
+			echo
+			if prompt "${GREEN}${BOLD}?${ALL_OFF} Apply changes to the PKGBUILD?"; then
+				apply_changes=1
+			fi
+		fi
+
+		# apply changes to the actual PKGBUILD
+		if (( apply_changes == 1 )); then
+			if ! (diff --unified PKGBUILD PKGBUILD_version_upgrade.tmp || true) | git apply; then
+				msg_error " Fail to apply changes" 2>&1
+				exit_code=1
+			else
+				echo
+				msg_success " Changes applied"
+			fi
+		fi
+
+		# delete temporary PKGBUILD file
+		rm -f PKGBUILD_version_upgrade.tmp
+
+		popd >/dev/null
+
+	done
+
 	# return status based on results
 	return "${exit_code}"
 }