Script de shell de Linux: ejecute un programa solo si existe, ignórelo si no existe

Estoy programando un script de shell de Linux que imprimirá pancartas de estado durante su ejecución solo si la herramienta adecuada, por ejemplo figlet, está instalada (esto es: accesible en la ruta del sistema ).

Ejemplo:

#!/usr/bin/env bash
echo "foo"
figlet "Starting"
echo "moo"
figlet "Working"
echo "foo moo"
figlet "Finished"

Me gustaría que mi script funcione sin errores incluso cuando nofiglet esté instalado .

¿Cuál podría ser un método práctico ?

Mi interpretación usaría una función de contenedor llamada igual que la herramienta; en esa función, ejecute la herramienta real si existe:

figlet() {
  command -v figlet >/dev/null && command figlet "$@"
}

Entonces puede haber figlet arg1 arg2...cambiado en su secuencia de comandos.

A @Olorin se le ocurrió un método más simple: definir una función de contenedor solo si es necesario (si la herramienta no existe):

if ! command -v figlet > /dev/null; then figlet() { :; }; fi

Si desea que figletse impriman los argumentos incluso si el figlet no está instalado, ajuste la sugerencia de Olorin de la siguiente manera:

if ! command -v figlet > /dev/null; then figlet() { printf '%s\n' "$*"; }; fi

Puedes probar para ver si figletexiste

if type figlet >/dev/null 2>&1
then
    echo Figlet is installed
fi

Una forma común de hacer esto es con test -xaka [ -x. Aquí hay un ejemplo tomado de /etc/init.d/ntpun sistema Linux:

if [ -x /usr/bin/lockfile-create ]; then
    lockfile-create $LOCKFILE
    lockfile-touch $LOCKFILE &
    LOCKTOUCHPID="$!"
fi

Esta variante se basa en conocer la ruta completa del ejecutable. En /bin/lesspipeEncontré un ejemplo que funciona alrededor de eso combinando -xy el whichcomando:

if [ -x "`which bunzip`" ]; then bunzip -c "$1"
else echo "No bunzip available"; fi ;;

De esta forma, esto funcionará sin saber de antemano en qué parte PATHdel bunzipejecutable se encuentra.

Al comienzo de su script, verifique si figletexiste, y si no existe, defina una función de shell que no haga nada:

type figlet >/dev/null 2>&1 || figlet() { :; }

typecomprueba si figletexiste como un shell incorporado, función, alias o palabra clave, >/dev/null 2>&1descarta stdin y stdout para que no obtenga ningún resultado, y si no existe,figlet() { :; } define figletcomo una función que no hace nada.

De esta manera, no tiene que editar cada línea de su script que use figlet , o verificar si existe cada vez que figletse llama.

Puede agregar un mensaje de diagnóstico, si lo desea:

type figlet >/dev/null 2>&1 || { echo 'figlet not installed.' ; figlet() { :; } ; }

Como beneficio adicional, dado que no mencionó qué shell está utilizando, creo que esto es compatible con POSIX, por lo que debería funcionar en la mayoría de los shell.

Otra alternativa: un patrón que he visto en los scripts de configuración automática del proyecto:

if [ -x /usr/bin/figlet ]
then
    FIGLET=/usr/bin/figlet
else
    FIGLET=:
fi

$FIGLET "Hello, world!"

En su caso específico, incluso podría hacer,

if [ -x /usr/bin/figlet ]
then
   SAY=/usr/bin/figlet
elif [ -x /usr/local/bin/figlet ]
then
   SAY=/usr/local/bin/figlet
elif [ -x /usr/bin/banner ]
then
   SAY=/usr/bin/banner
else
   SAY=/usr/bin/echo
fi

$SAY "Hello, world!"

Si no conoce la ruta específica, puede intentar múltiples elif(ver arriba) para probar ubicaciones conocidas, o simplemente usar el PATHpara resolver siempre el comando:

if command -v figlet >/dev/null
then
    SAY=figlet
elif command -v banner >/dev/null
then
    SAY=banner
else
    SAY=echo
fi

En general, cuando escribo guiones, prefiero llamar solo a comandos en ubicaciones específicas especificadas por mí. No me gusta la incertidumbre / riesgo de lo que el usuario final podría haber puesto en ellos PATH, quizás en su propio~/bin .

Si, por ejemplo, estaba escribiendo una secuencia de comandos complicada para otros que podrían eliminar archivos en función de la salida de un comando en particular al que estoy llamando, no quisiera recoger accidentalmente algo en su ~/binque podría o no ser el comando Esperaba.

type -p figlet > /dev/null && figlet "foo"

El typecomando bash encuentra un comando, una función, un alias, una palabra clave o una función incorporada (ver help type) e imprime la ubicación o definición. También devuelve un código de retorno que representa el resultado de la búsqueda; verdadero (0) si se encuentra. Entonces, lo que estamos haciendo aquí es tratar de encontrar figleten la ruta ( -psignifica solo buscar archivos, no funciones integradas o funciones, y también suprime los mensajes de error), descartando la salida (eso es lo que > /dev/nullhace), y si devuelve verdadero ( &&) , se ejecutaráfiglet .

Esto es más simple si figletestá en una ubicación fija:

[ -x /usr/bin/figlet ] && /usr/bin/figlet "foo"

Aquí estamos usando el testcomando (aka [) para ver si /usr/bin/figletes ejecutable ( -x) y si es así ( &&) ejecutarlo. Creo que esta solución es más portátil que usartype que es un bashismo, creo.

Podría hacer una función que haga esto por usted:

function x() {
    if type -p "$1" >/dev/null; then
        cmd="$1"
        shift
        "$cmd" "$@"
    fi
}

(Las citas son necesarias debido a los espacios potenciales)

Entonces simplemente harías:

x figlet "foo"

o /, diría algo como

#!/usr/bin/env bash
# if figlet is installed :
if [ "$(which figlet 2>/dev/null)" ]; then
       # do what you wanted to do
       echo "foo"
       figlet "Starting"
       echo "moo"
       figlet "Working"
       echo "foo moo"
       figlet "Finished"
# if not
else
       # exit program with an error
       echo "please install figlet"
       exit 1
fi

Puede hacer una ejecución de prueba, suprimir cualquier salida y probar el código de éxito / falla. Elija argumentos para figlet para hacer esta prueba de bajo costo. -? o --help o --version son posibilidades obvias.

if figlet --help >/dev/null 2>&1 ; then
    # figlet is available
    echo "foo"
    figlet "starting"
    #etc
else
    rc=$?
    echo "figlet is not installed or not working correctly (return code ${rc})"
fi

Se agregó en respuesta al comentario a continuación: si realmente desea probar que existe el figlet, no que sea utilizable, entonces lo haría

figlet --help >/dev/null 2>&1 
rc=$?
if [ $rc -eq 127 ] ; then # 127 is "command not found" on linux bash 4.4.23(1)
    echo "command figlet not found"
else
    figlet "whatever" # use figlet
fi