blob: a308851aca7fc9e268e3ddba9e7dd4bb7423c650 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
# Copyright 2022-2025 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2
# @ECLASS: edo.eclass
# @MAINTAINER:
# QA Team <qa@gentoo.org>
# @AUTHOR:
# Sam James <sam@gentoo.org>
# @SUPPORTED_EAPIS: 7 8
# @BLURB: Convenience function to run commands verbosely and die on failure
# @DESCRIPTION:
# This eclass provides the 'edo' command, and an 'edob' variant for ebegin/eend,
# which logs the command used verbosely and dies (exits) on failure.
#
# The 'edo' command should be used only where needed to give a more verbose log,
# e.g. for invoking non-standard ./configure scripts, or building
# objects/binaries directly within ebuilds via compiler invocations. It is NOT
# to be used in place of generic 'command || die' where verbosity is
# unnecessary.
#
# The 'edob' command can be used for long running commands, even if
# those commands produce output. The 'edob' command will suppress the
# command's output and only present it if the command returned with a
# non-zero exit status.
case ${EAPI} in
7|8) ;;
*) die "${ECLASS}: EAPI ${EAPI:-0} not supported" ;;
esac
if [[ -z ${_EDO_ECLASS} ]] ; then
_EDO_ECLASS=1
# @FUNCTION: edo
# @USAGE: <command> [<args>...]
# @DESCRIPTION:
# Executes a short 'command' with any given arguments and exits on failure
# unless called under 'nonfatal'.
edo() {
# list of special characters taken from sh_contains_shell_metas
# in shquote.c (bash-5.2)
local a out regex='[] '\''"\|&;()<>!{}*[?^$`]|^[#~]|[=:]~'
[[ $# -ge 1 ]] || die "edo: at least one argument needed"
if [[ ${EAPI} = 7 ]]; then
# no @Q in bash-4.2
out=" $*"
else
for a; do
# quote if (and only if) necessary
[[ ${a} =~ ${regex} || ! ${a} =~ ^[[:print:]]+$ ]] && a=${a@Q}
out+=" ${a}"
done
fi
einfon
printf '%s\n' "${out:1}" >&2
"$@" || die -n "Failed to run command: ${1}"
}
# @FUNCTION: edob
# @USAGE: [-l <log-name>] [-m <message>] <command> [<args>...]
# @DESCRIPTION:
# Executes 'command' with ebegin & eend with any given arguments and exits
# on failure unless called under 'nonfatal'. This function redirects
# stdout and stderr to a log file. The content of the log file is shown
# if the command returns with a non-zero exit status.
#
# If -m <message> is provided, then invokes ebegin with <message>, otherwise
# a default message is used. If -l <log-name> is provided, then <log-name> is
# used to construct the name of the log file where stdout and stderr of the
# command is redirected to.
edob() {
local message
local log_name
while true; do
case "${1}" in
-l|-m)
[[ $# -lt 2 ]] && die "Must provide an argument to ${1}"
case "${1}" in
-l)
log_name="${2}"
;;
-m)
message="${2}"
;;
esac
shift 2
;;
*)
break
;;
esac
done
[[ -z ${message} ]] && message="Running $@"
[[ -z ${log_name} ]] && log_name="$(basename ${1})"
local log_file="${T}/${log_name}.log"
ebegin "${message}"
"$@" &> "${log_file}"
local ret=$?
if ! eend $ret; then
cat "${log_file}"
die -n "Command \"$@\" failed with exit status $ret"
fi
}
fi
|
