Carregando
0x100Lição 17 de 28

Escreva scripts robustos

Faça os scripts falharem com segurança com strict mode, limpe com traps, analise opções com getopts e depure.

30 min Questionário com 7 perguntas 2 exercícios de código
Ao final desta lição, você saberá
  • Explicar o que set -euo pipefail faz, e as pegadinhas dele
  • Relatar erros no stderr, proteger expansões perigosas e fazer a limpeza com trap
  • Analisar opções com getopts e depurar com bash -x e ShellCheck

Por padrão, o Bash continua depois que um comando falha. Isso é amigável no prompt e perigoso num script: se cd /backups falhar, o rm -rf * da linha seguinte roda onde quer que você esteja. Muitos scripts começam com o strict mode:

#!/usr/bin/env bash
set -euo pipefail
OpçãoEfeito
-e (errexit)sai assim que um comando falha
-u (nounset)trata uma variável não definida como erro, em vez de string vazia
-o pipefailum pipeline falha se qualquer etapa falhar, e não só a última
pipefail.sh
1grep reactor /no/such/file 2>/dev/null | sort
2echo "without pipefail, the pipeline's status is $? (sort's)"
3set -o pipefail
4grep reactor /no/such/file 2>/dev/null | sort
5echo "with pipefail, it's $? (grep's)"
Saída
without pipefail, the pipeline's status is 0 (sort's)
with pipefail, it's 2 (grep's)

Hábitos defensivos

  • Coloque aspas em toda expansão: "$file", "${files[@]}", "$(cmd)".
  • Proteja os caminhos perigosos: rm -rf "${build_dir:?}/"* para o script com um erro se build_dir estiver vazia, em vez de apagar a partir de /.
  • Termine as opções com --: rm -- "$file" continua seguro mesmo que um arquivo se chame -rf.
  • Os erros vão para o stderr, com saída diferente de zero: uma pequena função die mantém isso arrumado.
  • Faça a limpeza com trap: crie os arquivos temporários com mktemp e remova-os num trap de EXIT.
  • Verifique as entradas cedo e imprima uma mensagem de uso.
defensive.sh
1set -euo pipefail
2die() { echo "error: $*" >&2; exit 1; }
3work=$(mktemp -d)
4trap 'rm -rf "$work"; echo "cleaned up"' EXIT
5
6target="${1:-}"
7[[ -n $target ]] || target="kestrel"          # a default instead of dying
8printf '%s\n' alpha beta > "$work/list.txt"
9count=$(wc -l < "$work/list.txt")
10echo "processed $count items for $target"
11[[ -d $work ]] && echo "temp dir exists until exit"
Saída
processed 2 items for kestrel
temp dir exists until exit
cleaned up

Experimente

Até 15 XP

Revise este script de backup

Um colega de tripulação escreveu este script de backup noturno. Clique em cada linha que pode causar problemas e depois veja o que deixou passar.

backup.sh (rodada 1 de 1)Sinais encontrados 0/0

Clique em todos os trechos suspeitos. São 6.

#!/usr/bin/env bash backup_dir=$1 cd $backup_dir rm -rf $backup_dir/tmp/* for f in $(ls *.log); do cp $f /archive done echo "Backup complete"

Opções com getopts

Ferramentas reais recebem opções: report -v -n 5 station.log. O built-in getopts analisa as opções curtas para você. A string de opções lista as letras; dois-pontos depois de uma letra significam que ela recebe um valor (em OPTARG); dois-pontos no começo deixam você tratar os erros por conta própria:

getopts.sh
1set -- -v -n 2 Kestrel        # as if run: ./hail.sh -v -n 2 Kestrel
2usage() { echo "usage: hail [-v] [-n count] name" >&2; exit 2; }
3verbose=false count=1
4while getopts ":vn:h" opt; do
5  case $opt in
6    v) verbose=true ;;
7    n) count=$OPTARG ;;
8    h) usage ;;
9    :) echo "-$OPTARG needs a value" >&2; usage ;;
10    ?) echo "unknown option -$OPTARG" >&2; usage ;;
11  esac
12done
13shift $(( OPTIND - 1 ))          # drop the options; "$@" is now the rest
14name=${1:?missing name}
15$verbose && echo "count=$count name=$name"
16for (( i = 0; i < count; i++ )); do echo "Hailing $name"; done
Saída
count=2 name=Kestrel
Hailing Kestrel
Hailing Kestrel

Depuração

  • bash -n script.sh verifica a sintaxe sem rodar nada.
  • bash -x script.sh, ou set -x dentro dele, imprime cada comando depois da expansão, prefixado com + - você vê exatamente o que rodou. set +x desliga de novo.
  • O ShellCheck é um linter que pega variáveis sem aspas, cats inúteis, laços com $(ls) e centenas de outros erros. A maioria dos editores consegue rodá-lo enquanto você digita. Use-o em todo script.
trace.sh
1deck="deck 4"
2set -x
3ls $deck 2>/dev/null
4set +x
5echo "the trace (on stderr) shows ls received two arguments"
Saída
the trace (on stderr) shows ls received two arguments

Principais conclusões

  • set -euo pipefail para em falhas, variáveis não definidas e pipelines quebrados - cuidado com as pegadinhas.

  • Coloque aspas em tudo, proteja com ${var:?}, use -- e mande os erros para o stderr com saída diferente de zero.

  • trap ... EXIT faz a limpeza; getopts analisa as opções; shift $((OPTIND - 1)) deixa só os argumentos.

  • Depure com bash -x e passe todo script pelo ShellCheck.

Quiz da aula

7 perguntas · aprovação com 5 acertos · até 50 XP

Ao passar, você conclui a aula e mantém sua sequência. As perguntas erradas voltarão em sessões de revisão.

Pratique: escreva código em scripts Bash

Escreva um script no editor e execute-o de verdade com entradas de exemplo. Cada execução ganha um sandbox Linux novo com Bash 5.2 e as ferramentas GNU no Wandbox, um serviço público gratuito, então experimente à vontade, até com rm. Seu script e a entrada de teste são enviados para lá.

Exercício 1

Analise as opções

+25 XP

O código inicial transforma a linha do stdin nos argumentos do script. Use getopts para suportar:

  • -n COUNT - quantas vezes cumprimentar (padrão 1)
  • -u - pôr o nome em maiúsculas
  • -v - imprimir primeiro count=N name=NAME (antes de pôr em maiúsculas)

e depois um argumento nome. Imprima Hello, NAME! COUNT vezes. Por exemplo, -u -n 2 Ada imprime Hello, ADA! duas vezes.

  • -n 2 Kestrel
  • -u -n 2 Ada
  • -v Grace
  • Só um nome
script.sh
Carregando editor…

Seu script roda com Bash 5.2 e ferramentas GNU no Wandbox, um serviço público gratuito, em um sandbox novo a cada execução. Seu script e a entrada de teste são enviados a esse serviço.

Exercício 2

Limpe a sua bagunça

+25 XP

O código inicial cria um diretório temporário e processa algumas amostras, mas nunca faz a limpeza. Acrescente um trap de EXIT que chame cleanup e escreva cleanup de modo que imprima cleaning up N files (o número de arquivos no diretório temporário), apague o diretório e depois imprima removed: yes se ele tiver sumido.

1working...
2result: 3 samples
3cleaning up 3 files
4removed: yes
  • Faz a limpeza
script.sh
Carregando editor…

Seu script roda com Bash 5.2 e ferramentas GNU no Wandbox, um serviço público gratuito, em um sandbox novo a cada execução. Seu script e a entrada de teste são enviados a esse serviço.

Dúvidas sobre esta lição

Travou em algum ponto? Pergunte. Descobriu algo? Compartilhe. Explicar também é uma ótima forma de aprender.

Carregando publicações…