feat(issue): add subcommand to move issues between projects

The move command allows users to transfer an issue from one project to another
within the Arch Linux packaging group. This is useful when an issue is
identified to be more relevant or better handled in a different project.

By default, the command operates within the current directory, but users can
specify a different package base from which to move the issue.

Users must specify the issue ID (IID) and the destination package to which the
issue should be moved. A comment message explaining the reason for the move can
be provided directly through the command line.

Component: pkgctl issue move
Signed-off-by: Levente Polyak <anthraxx@archlinux.org>

contrib/completion/bash/devtools.in

@@ -450,6 +450,7 @@ _pkgctl_issue_cmds=(
 	close
 	comment
 	list
+	move
 	reopen
 	view
 )
@@ -523,6 +524,29 @@ _pkgctl_issue_list_args__status_opts() { _devtools_completions_issue_status; }
 _pkgctl_issue_list_args__assignee_opts() { :; }
 _pkgctl_issue_list_args__author_opts() { :; }
 
+_pkgctl_issue_move_args=(
+	-p --package
+	-m --message
+	-e --edit
+	-h --help
+)
+
+_pkgctl_issue_move_opts() {
+	local subcommand args
+	subcommand=(repo switch)
+	args=$(__pkgctl_word_count_after_subcommand "${subcommand[@]}")
+
+	if (( args == 0 )); then
+		:
+	elif (( args >= 1 )); then
+		_devtools_completions_all_packages
+	fi
+}
+_pkgctl_issue_move_args__package_opts() { _devtools_completions_all_packages; }
+_pkgctl_issue_move_args_p_opts() { _pkgctl_issue_move_args__package_opts; }
+_pkgctl_issue_move_args__message_opts() { :; }
+_pkgctl_issue_move_args_m_opts() { _pkgctl_issue_move_args__message_opts; }
+
 _pkgctl_issue_reopen_args=(
 	-p --package
 	-m --message

contrib/completion/zsh/_devtools.in

@@ -99,6 +99,7 @@ _pkgctl_issue_cmds=(
 	"close[Close an issue]"
 	"comment[Comment on an issue]"
 	"list[List project or group issues]"
+	"move[Move an issue to another project]"
 	"reopen[Reopen a closed issue]"
 	"view[Display information about an issue]"
 )
@@ -142,6 +143,15 @@ _pkgctl_issue_list_args=(
 	'*:pkgbase:_devtools_completions_all_packages'
 )
 
+_pkgctl_issue_move_args=(
+	'(-p --package)'{-p,--package}'[Interact with <pkgbase> instead of the current directory]:pkgbase:_devtools_completions_all_packages'
+	'(-m --message)'{-m,--message}'[Use the provided message as the comment]:message:'
+	'(-e --edit)'{-e,--edit}'[Edit the comment using an editor]'
+	'(-h --help)'{-h,--help}'[Display usage]'
+	"1:issue_iid:"
+	'1:pkgbase:_devtools_completions_all_packages'
+)
+
 _pkgctl_issue_reopen_args=(
 	'(-p --package)'{-p,--package}'[Interact with <pkgbase> instead of the current directory]:pkgbase:_devtools_completions_all_packages'
 	'(-m --message)'{-m,--message}'[Use the provided message as the comment]:message:'

doc/man/pkgctl-issue-move.1.asciidoc

+pkgctl-issue-move(1)
+====================
+
+Name
+----
+pkgctl-issue-move - Move an issue to another project
+
+Synopsis
+--------
+pkgctl issue move [OPTIONS] [IID] [DESTINATION_PACKAGE]
+
+Description
+-----------
+
+The move command allows users to transfer an issue from one project to another
+within the Arch Linux packaging group. This is useful when an issue is
+identified to be more relevant or better handled in a different project.
+
+By default, the command operates within the current directory, but users can
+specify a different package base from which to move the issue.
+
+Users must specify the issue ID (IID) and the destination package to which the
+issue should be moved. A comment message explaining the reason for the move can
+be provided directly through the command line. For more detailed explanations
+or additional context, users have the option to edit the move comment using a
+text editor before submitting it.
+
+Options
+-------
+
+*-p, --package* 'PKGBASE'::
+	Move from `PKGBASE` instead of the current directory
+
+*-m, --message* 'MSG'::
+	Use the provided message as the comment
+
+*-e, --edit*::
+	Edit the comment using an editor
+
+*-h, --help*::
+	Show a help text
+
+include::include/footer.asciidoc[]

doc/man/pkgctl-issue.1.asciidoc

@@ -32,6 +32,9 @@ pkgctl issue comment::
 pkgctl issue list::
 	List project or group issues
 
+pkgctl issue move::
+	Move an issue to another project
+
 pkgctl issue reopen::
 	Reopen a closed issue
 
@@ -44,6 +47,7 @@ See Also
 pkgctl-issue-close(1)
 pkgctl-issue-comment(1)
 pkgctl-issue-list(1)
+pkgctl-issue-move(1)
 pkgctl-issue-reopen(1)
 pkgctl-issue-view(1)
 

src/lib/api/gitlab.sh

@@ -402,6 +402,25 @@ gitlab_api_search() {
 	return 0
 }
 
+# https://docs.gitlab.com/ee/api/projects.html#get-single-project
+gitlab_project() {
+	local project=$1
+	local outfile project_path
+
+	[[ -z ${WORKDIR:-} ]] && setup_workdir
+	outfile=$(mktemp --tmpdir="${WORKDIR}" pkgctl-gitlab-api.XXXXXXXXXX)
+
+	project_path=$(gitlab_project_name_to_path "${project}")
+
+	if ! gitlab_api_call "${outfile}" GET "projects/archlinux%2fpackaging%2fpackages%2f${project_path}/"; then
+		return 1
+	fi
+
+	cat "${outfile}"
+
+	return 0
+}
+
 # TODO: parallelize
 # https://docs.gitlab.com/ee/api/issues.html#list-project-issues
 gitlab_projects_issues_list() {
@@ -541,6 +560,30 @@ gitlab_create_project_issue_note() {
 	return 0
 }
 
+gitlab_project_issue_move() {
+	local pkgbase=$1
+	local iid=$2
+	local to_project_id=$3
+	local outfile path project_path
+
+	[[ -z ${WORKDIR:-} ]] && setup_workdir
+	outfile=$(mktemp --tmpdir="${WORKDIR}" pkgctl-gitlab-api.XXXXXXXXXX)
+
+	project_path=$(gitlab_project_name_to_path "${pkgbase}")
+
+	if ! gitlab_api_call "${outfile}" POST "/projects/archlinux%2fpackaging%2fpackages%2f${project_path}/issues/${iid}/move?to_project_id=${to_project_id}"; then
+		return 1
+	fi
+
+	if ! path=$(jq --raw-output --exit-status '.title' < "${outfile}"); then
+		msg_error "  failed to move issue: $(cat "${outfile}")"
+		return 1
+	fi
+
+	cat "${outfile}"
+	return 0
+}
+
 gitlab_severity_from_labels() {
 	local labels=("$@")
 	local severity="unknown"

src/lib/issue/issue.sh

@@ -21,6 +21,7 @@ pkgctl_issue_usage() {
 		    close     Close an issue
 		    comment   Comment on an issue
 		    list      List project or group issues
+		    move      Move an issue to another project
 		    reopen    Reopen a closed issue
 		    view      Display information about an issue
 
@@ -70,6 +71,14 @@ pkgctl_issue() {
 				pkgctl_issue_comment "$@"
 				exit 0
 				;;
+			move)
+				_DEVTOOLS_COMMAND+=" $1"
+				shift
+				# shellcheck source=src/lib/issue/move.sh
+				source "${_DEVTOOLS_LIBRARY_DIR}"/lib/issue/move.sh
+				pkgctl_issue_move "$@"
+				exit 0
+				;;
 			reopen)
 				_DEVTOOLS_COMMAND+=" $1"
 				shift

src/lib/issue/move.sh

+#!/hint/bash
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+[[ -z ${DEVTOOLS_INCLUDE_ISSUE_MOVE_SH:-} ]] || return 0
+DEVTOOLS_INCLUDE_ISSUE_MOVE_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/cache.sh
+source "${_DEVTOOLS_LIBRARY_DIR}"/lib/cache.sh
+# shellcheck source=src/lib/api/gitlab.sh
+source "${_DEVTOOLS_LIBRARY_DIR}"/lib/api/gitlab.sh
+
+set -eo pipefail
+
+
+pkgctl_issue_move_usage() {
+	local -r COMMAND=${_DEVTOOLS_COMMAND:-${BASH_SOURCE[0]##*/}}
+	cat <<- _EOF_
+		Usage: ${COMMAND} [OPTIONS] [IID] [DESTINATION_PACKAGE]
+
+		The move command allows users to transfer an issue from one project to another
+		within the Arch Linux packaging group. This is useful when an issue is
+		identified to be more relevant or better handled in a different project.
+
+		By default, the command operates within the current directory, but users can
+		specify a different package base from which to move the issue.
+
+		Users must specify the issue ID (IID) and the destination package to which the
+		issue should be moved. A comment message explaining the reason for the move can
+		be provided directly through the command line.
+
+		OPTIONS
+		    -p, --package PKGBASE  Move from <pkgbase> instead of the current directory
+		    -m, --message MSG      Use the provided message as the comment
+		    -e, --edit             Edit the comment using an editor
+		    -h, --help             Show this help text
+
+		EXAMPLES
+		    $ ${COMMAND} 42 to-bar
+		    $ ${COMMAND} --package from-foo 42 to-bar
+_EOF_
+}
+
+pkgctl_issue_move() {
+	if (( $# < 1 )); then
+		pkgctl_issue_move_usage
+		exit 0
+	fi
+
+	local iid=""
+	local pkgbase=""
+	local message=""
+	local edit=0
+
+	local to_project_name to_project_id project_path issue_url to_iid result
+
+	# option checking
+	while (( $# )); do
+		case $1 in
+			-h|--help)
+				pkgctl_issue_move_usage
+				exit 0
+				;;
+			-p|--package)
+				(( $# <= 1 )) && die "missing argument for %s" "$1"
+				pkgbase=$2
+				shift 2
+				;;
+			-m|--message)
+				(( $# <= 1 )) && die "missing argument for %s" "$1"
+				message=$2
+				shift 2
+				;;
+			-e|--edit)
+				edit=1
+				shift
+				;;
+			-*)
+				die "invalid argument: %s" "$1"
+				;;
+			*)
+				break
+				;;
+		esac
+	done
+
+	if [[ -z ${pkgbase} ]]; then
+		if ! [[ -f PKGBUILD ]]; then
+			die "missing --package option or PKGBUILD in current directory"
+		fi
+		pkgbase=$(realpath --canonicalize-existing .)
+	fi
+	pkgbase=$(basename "${pkgbase}")
+
+	if (( $# < 2 )); then
+		pkgctl_issue_move_usage
+		exit 1
+	fi
+
+	iid=$1
+	to_project_name=$(basename "$2")
+
+	# spawn editor
+	if (( edit )); then
+		msgfile=$(mktemp --tmpdir="${WORKDIR}" pkgctl-issue-note.XXXXXXXXXX.md)
+		printf "%s\n" "${message}" >> "${msgfile}"
+		if [[ -n $VISUAL ]]; then
+			$VISUAL "${msgfile}" || die
+		elif [[ -n $EDITOR ]]; then
+			$EDITOR "${msgfile}" || die
+		else
+			die "No usable editor found (tried \$VISUAL, \$EDITOR)."
+		fi
+		message=$(cat "${msgfile}")
+	fi
+
+	if ! result=$(gitlab_project "${to_project_name}"); then
+		msg_error "Failed to query target project ${BOLD}${to_project_name}${ALL_OFF}"
+		exit 1
+	fi
+
+	if ! to_project_id=$(jq --raw-output ".id" <<< "${result}"); then
+		msg_error "Failed to query project id for ${BOLD}${to_project_name}${ALL_OFF}"
+		exit 1
+	fi
+
+	# comment on issue
+	if [[ -n ${message} ]]; then
+		if ! result=$(gitlab_create_project_issue_note "${pkgbase}" "${iid}" "${message}"); then
+			msg_error "Failed to comment on issue ${BOLD}#${iid}${ALL_OFF}"
+			exit 1
+		fi
+		msg_success "Commented on issue ${BOLD}#${iid}${ALL_OFF}"
+	fi
+
+	if ! result=$(gitlab_project_issue_move "${pkgbase}" "${iid}" "${to_project_id}"); then
+		msg_error "Failed to move issue ${BOLD}#${iid}${ALL_OFF} to ${BOLD}${to_project_name}${ALL_OFF}"
+		exit 1
+	fi
+
+	if ! to_iid=$(jq --raw-output ".iid" <<< "${result}"); then
+		msg_error "Failed to query issue id for ${BOLD}${to_project_name}${ALL_OFF}"
+		exit 1
+	fi
+
+	project_path=$(gitlab_project_name_to_path "${to_project_name}")
+	issue_url="${GIT_PACKAGING_URL_HTTPS}/${project_path}/-/issues/${to_iid}"
+
+	msg_success "Moved issue ${BOLD}${pkgbase}${ALL_OFF} ${BOLD}#${iid}${ALL_OFF} to ${BOLD}${to_project_name}${ALL_OFF} ${BOLD}#${to_iid}${ALL_OFF}"
+	echo
+	printf "%sView this issue on GitLab: %s%s\n" "${GRAY}" "${issue_url}" "${ALL_OFF}"
+}