Programação Expectativas

Transcrição

1 Programação Expectativas Aprenda a automatizar processos interativos com o Expect. por Aeleen Frisch O Bash contempla uma série de mecanismos para automatizar processos interativos. Por exemplo, o recurso de redirecionamento de input chamado here document pode posicionar o input padrão para um comando dentro de um script, conforme mostra a listagem 1. O pacote de simulação químicocomputacional Gaussian 09 (g09) utiliza um pequeno input que informa qual tipo de previsões são desejadas e qual molécula ou reação deve ser estudada. Um arquivo de input específico pode ser criado para uma tarefa específica, mas inserir comandos como esses em um script permite que o usuário execute uma série de tarefas em cada molécula em um conjunto de forma automatizada. Esta abordagem é claramente mais fácil e mais eficiente do que a criação de dezenas ou centenas de arquivos de entrada manualmente, e torna trivial a Listagem 1: Redirecionamento de entrada 01 for jobname in $jobs; do for molecule in $mlist; do g09 <<END >$molecule.log $charge $spin END done 13 done execução de nova simulação em um conjunto molecular existente. No entanto, como uma solução geral, a técnica do here document tem várias desvantagens. Em primeiro lugar, nem todos os prompts interativos aceitarão o input de scripts dessa forma. Por exemplo, muitas solicitações de senha e o prompt de troca de chaves em uma conexão SSH inicial são configurados para aceitar o input apenas a partir do terminal. Em segundo lugar, quando se usa esta técnica, não é fácil para o script processar a saída do comando e tomar decisões com base nele. Mais importante, embora as respostas a vários comandos possam ser incluídas antes do final do here document, o script não pode examinar as respostas às solicitações individuais para responder adequadamente a elas em tempo real. A facilidade do Expect é um ambiente de script projetado especificamente para automatizar verdadeiros processos interativos. Scripts Expect são exemplos de chat scripts : consistem de uma série de pares esperados de pronta-resposta. O Expect foi escrito por Don Libes e está incluído no Ubuntu por padrão. Podemos encontrar recursos do Expect online [1] [2]. Introdução ao Expect A melhor introdução ao Expect é um simples script que automatiza a conexão SSH inicial para um host especificado como o argumento do roteiro (listagem 2). A versão standalone do Expect é automaticamente combinada com uma linguagem de script chamada Tcl (pronunciase tickle ). A primeira linha neste exemplo é a construção Tcl para atribuir um valor a uma variável neste caso, a variável host. A forma [lindex $argv n] retorna o argumento nth para o script (a numeração começa em 0), assim, o primeiro comando coloca o primeiro argumento de script em uma variável host. O segundo comando atribui o valor 5 à variável timeout, que é uma variável Expect incorporada que define um limite sobre quan- Listagem 2: Conexão SSH automática 03 set host lindex $argv 04 set timeout 5 05 spawn /usr/bin/ssh aefrisch@$host 06 expect "(yes/no)? " { 07 send "yes\r" expect "password:" 10 send "secret\r" 11 expect "$ " 12 interact Linux Magazine #109 Março de

2 to tempo uma declaração expect examinará a saída. O restante do script é Expect puro, e ilustra as três mais importantes construções do Expect: spawn Inicia um comando e estabelece uma conversação com o processo. expect Examina a saída de comando para uma string ou expressão; espere até que ele apareça ou que o tempo limite expire, ou seja, qualquer coisa que aparece na saída antes que o item especificado seja ignorado, assim o usuário só terá que olhar para a última parte do que deseja. Uma declaração expect expira se não conseguir encontrar o item especificado dentro dos segundos correspondentes ao valor da variável timeout. O padrão é 10 segundos, e um valor de -1 desativa o tempo limite. send Envia uma string para o processo que começou com um spawn. A conversa de script (pelo número da linha) na listagem 2 é: (5) spawn Tente conectar-se ao host remoto com ssh. (6) expect Aguarde pelo "(yes/ no)?" na saída. Este é o fim de várias linhas de saída sobre a troca de chave de host. (7) send Envie a string "yes" mais um retorno de procedimento (\r) se "(yes/no)?" for encontrado. (9) expect Aguarde por "password:" na saída. Este é o prompt de senha. (10) send Envie a sequência de senha mais um retorno de procedimento. (11) expect Espere por um sinal de dólar, o Shell prompt. (12) interact Transferência de controle de input para o terminal, permitindo que o usuário digite os comandos. Observe a diferença entre as duas primeiras declarações expect. Na primeira, o comando send é subordinado ao comando expect, pois está fechado entre chaves. O comando send é executado somente se o comando expect localizar o item especificado na saída do comando. Se o tempo expirar, o comando send é ignorado. Em contraste, os segundos comandos expect e send são independentes um do outro. Se o comando expect falhar ao encontrar uma solicitação de senha dentro do tempo limite, ele vai se encerrar, mas o comando send será executado de qualquer maneira. Uma declaração expect possui o seguinte formato: expect { item1 { statements item2 { statements... As chaves imediatamente após o comando expect somente são necessárias quando mais de um item de pesquisa é especificado. Mostraremos exemplos de declarações expect múltiplas mais à frente neste artigo. Itens são procurados na ordem em que aparecem na declaração, mas o primeiro item correspondente ganha, e as declarações a seguir são executadas. Normalmente, a declaração expect termina neste ponto. Máquina virtual na nuvem Em seguida, examinaremos o script usado para iniciar uma máquina virtual na Amazon Cloud. O objetivo deste script é estabelecer conexões SSH sem senha com uma máquina virtual tanto para o usuário padrão, chamado ec2- -user, como para o root. Ele envia Listagem 3: ec2_ssh_init (Parte 1) 03 set h lindex $argv 04 spawn /usr/bin/scp i /home/aefrisch/. ec2/aef.pem/home/aefrisch/.ssh/id_rsa.pub ec2 user@${h: 06 expect "(yes/no)? " 07 send "yes\r" 08 expect "known hosts" 09 close 10 sleep 10 a chave pública do usuário atual para o host remoto e adiciona-o ao arquivo ~/.ssh/authorized_keys para ambos os usuários remotos. Também muda a configuração SSH para o usuário root remoto, bem como as opções para o servidor sshd remoto, reiniciando o último depois. Uma vez que estas atividades estejam concluídas, nem o ssh nem comando scp exigirão o uso da chave de instância ou de uma senha, e ao usuário atual será permitido executar comandos remotos como root usando ssh. Este script é chamado de ec2_ ssh_init e a listagem 3 exibe sua seção inicial. O script começa salvando seu primeiro argumento na variável h. Em seguida, ele inicia um comando scp e se conecta a ele; o comando scp usa o arquivo de chave EC2 para autenticação através da opção -i. Em seguida, o script procura pelo prompt de troca de chaves de host, responde sim para ele, e aguarda a resposta. Quando o script recebe uma resposta, ele fecha a conexão e, em seguida, aguarda 10 segundos para permitir que o comando scp tenha tempo suficiente para se completar. O restante do script (listagem 4) executa uma série de comandos no sistema remoto gerando um comando ssh. Todos os comandos expect procuram por prompts Shell, tanto para contas ec2-user ou root. Primeiro, o script adicio- 70

3 Listagem 4: ec2_ssh_init (Parte 2) 01 spawn /usr/bin/ssh i /home/aefrisch/.ec2/aef.pem ec2 user@$h expect "$" 03 send " cat id_rsa.pub >>.ssh/authorized_keys; rm id_rsa.pub\r" 04 expect "$" 05 send "sudo tcsh\r" 06 expect "#" 07 send " cp.ssh/authorized_keys ~root/.ssh\r" 08 expect "#" 09 send " cd /etc/ssh; cp sshd_config{,.0\r" 10 expect "#" 11 se nd " cat sshd_config.0 sed e 's/forced commands only/yes/' > sshd_config\r" 12 expect "#" 13 send "/etc/init.d/sshd restart\r" 14 expect "#" 15 send "exit\r" 16 expect "$" 17 send "logout\r" 18 close na o arquivo de chave copiado anteriormente para o arquivo authorized_keys para ec2-user no host remoto. Em seguida, ele inicia um Shell root via sudo. Como root, o script copia o arquivo authorized_keys do ec2-user para a conta root. Em seguida, ele muda para o diretório de configuração do servidor SSH, edita a cópia principal do arquivo de configuração do servidor (via sed), instala-o como o arquivo de configuração ativo e reinicia o daemon sshd. O restante do script conclui o Shell root, faz o logout da sessão SSH, e depois encerra o comando spawn. Comunicação com o dispositivo O Expect pode ser utilizado para se comunicar com os dispositivos, bem como com os processos. A listagem 5 mostra a comunicação com um relógio atômico sobre a porta serial para recuperar o tempo atual. O script começa com a definição da variável clock para o arquivo de dispositivo correspondente à porta serial onde o relógio está conectado. Em seguida, ele começa uma conversa com o dispositivo com o comando spawn. O comando stty define as características da linha serial necessária para a comunicação com o dispositivo de acordo com as especificações do fabricante. A recuperação de dados real acontece por meio de dois pares send expect; neste caso, o script desempenha o papel do iniciador, e o dispositivo é a resposta. O Listagem 5: Comunicando com um relógio script começa enviando o caractere o ; o dispositivo irá responder com um caractere qualquer. A opção -re ao comando expect revela que o item especificado é uma expressão regular, ao invés de uma string literal. O script, em seguida, envia um retorno de procedimento, que informa ao dispositivo que deve enviar o tempo. O tempo é devolvido sob a forma de um caractere inicial que não é parte do tempo, seguido de 16 ou mais caracteres. Para capturar este último, a declaração expect novamente usa expressões regulares. A primeira expressão consiste de um período, que vai coincidir com o caractere inicial indesejado. A segunda consiste de 16 pontos e um asterisco entre parênteses. Esta última irá corresponder a 16 ou mais caracteres. Os parênteses não são caracteres literais a serem correspondidos, mas sim definem esta parte da expressão regular como uma entidade que pode ser referenciada posteriormente. O script termina neste ponto, mas ele retorna automaticamente a mais recente expressão correspondente a qualquer processo que o tenha chamado. Neste caso, a string de tempo do dispositivo será retornada. 03 set clock /dev/ttys0 04 spawn open open $clock # set line characteristics for talking to clock 07 stty ispeed 300 ospeed 300 parenb parodd cs7 hupcl cstopb cread clocal icrnl opost isig icanon iexten echo noflsh < $clock send "o" 10 expect re "." 11 send "\r" 12 expect re "." 13 expect re "(...*)" 14 exit Linux Magazine #109 Março de

4 Listagem 6: loop (Parte 1) 03 set cmd lindex $argv 04 if {"$cmd" == "" { 05 se nd "Usage: loop command [refresh\]\n" 06 exit set tout lindex $argv 09 if {"$tout" == "" {set tout 5 10 set timeout $tout Listagem 7: loop (Parte 2) 01 set done 0 stty echo 03 while {$done == 0 { 04 system /usr/bin/clear 05 system $cmd 06 stty raw 07 expect re "." {set done 1 08 stty raw 09 # end while 10 stty echo 11 exit Listagem 8: Script ssh 03 set host lindex $argv 04 set timeout 2 05 set user lindex $argv 06 if {"$user" == "" { set user $env(user) 07 spawn /usr/bin/ssh $user@$host 08 expect { 09 "(yes/no)? " { 10 send "yes\r" 11 exp_continue "word:" { 15 send "whatever\r" 16 send_tty " Key exchange needed with $host\n" 17 exp_continue re "($ % >) " { interact timeout { 23 send_tty " No response from $host\n" 24 exit Comandos no estilo top O próximo script que cobriremos, o loop (listagem 6), permite que qualquer função de comando seja executado como o comando top: o comando é executado novamente de maneira repetida até que uma tecla seja pressionada. O início do script processa seu argumento (se existir) e define o intervalo de retorno da atualização (que também é o período de tempo limite do Expect). Este script ilustra um método para a verificação da presença de argumentos necessários através da declaração Tcl if. O comando send é usado para imprimir uma mensagem de erro quando o primeiro argumento de script necessário o comando a ser executado é omitido. Antes de qualquer comando spawn, os comandos expect e send interagem com a entrada e saída padrão do script (respectivamente), então o comando send pode ser usado para mensagens do script. O segundo argumento do script pode ser usado opcionalmente para especificar o intervalo de retorno da atualização para o comando especificado; por padrão, é de 5 segundos. A variável timeout do Expect é definida para este valor. O restante do script (listagem 7) executa o comando e espera por um comando de conclusão, quando o usuário pressiona alguma tecla. A variável done é definida como 0, e o caractere repetido está desativado antes do Tcl de loop while. O while se repete desde que o valor de done seja 0. O loop body executa dois comandos Unix externos através do comando system do Expect. Ao contrário de spawn, system executa o comando especificado sem atribuir entrada e retorno. No caso deste script, toda a comunicação ocorre através do padrão I/O (entrada e saída). Note que os colchetes dentro da mensagem de erro (indicando que o segundo argumento do script é opcional) devem ser citados com barras invertidas (listagem 6), porque os colchetes possuem um significado especial para Tcl. Uma vez que o comando especificado pelo usuário é executado, o tty é definido em modo raw. Assim, a entrada do usuário é processada caractere por caractere, em vez de linhas individuais (isto é, à espera de um retorno de procedimento). A declaração expect procura uma expressão regular que consiste de qualquer caractere. Quando um caractere é recebido porque o usuário pressionou uma tecla done é definido como 1 e o script irá terminar na próxima iteração do while loop. Se a declaração expect expirar, o valor de done permanece inalterado. O modo raw é, então, desativado novamente para evitar a interferência com o display de retorno do comando, e a próxima interação do loop while começa. Depois que o loop 72

5 Listagem 9: Processamento de argumentos de comando 03 set xfer lindex $argv 04 set user lindex $argv 05 if {"$user" == "" { set user "root" 06 if {"$xfer" == "" { 07 se nd_user "Usage: xfer item \[user\]\n" 08 exit set timeout 10 termina, a saída do terminal é restaurada e o script termina. Esperando mais de uma coisa A listagem 8 mostra outra versão do script ssh descrita anteriormente. Neste caso, foram combinadas todas as várias declarações expect em uma única declaração, que também funciona como um loop. O script começa como de costume, salvando os argumentos em variáveis (host e user) e definindo seus timeouts. Também ilustra a utilização de uma variável de ambiente Shell dentro de um script Expect. O formulário $env(name) retorna o valor da variável de ambiente NAME. Neste script, evitamos amarrar o nome de usuário ao comando spawn e usar a variável de ambiente USER como um nome de usuário remoto padrão. Desta forma, o script pode ser utilizado por um usuário e não apenas pelo administrador do sistema. O comando expect possui quatro itens de pesquisa: (yes/ no)? O aviso de troca de chaves do host. Se encontrado, a resposta "sim" é enviada, e a declaração expect continua via exp_continue, em vez de terminar, como aconteceria por padrão. word Solicitação da senha, que o script responde com a senha. O script em seguida imprime uma mensagem na tela indicando que a troca de chaves do usuário ainda não foi concluída para o host remoto. O comando send_tty sempre envia um retorno para a tela, independentemente de onde a saída padrão estiver indicada. A declaração expect continua novamente depois de executar as declarações anteriores porque exp_continue está incluído. ($ % >) Uma expressão regular que corresponde a várias versões do prompt de comando do Shell. Quando encontrado, o script executa o comando interact, que permite que o usuário assuma o controle da sessão SSH. O comando expect vai se encerrar neste momento. timeout Esta palavra-chave indica que o tempo limite do Expect expirou. Neste caso, isso normalmente significa que o computador remoto não respondeu. O script imprime uma mensagem na tela indicando isso, e tanto a declaração expect como o script terminam naquele ponto. Coperações de root Embora o script Expect anterior seja bastante útil, ele possui um problema de segurança: a presença da senha do usuário. Esta não é uma boa ideia, no geral, e, no mínimo, o arquivo de script que precisa ser armazenado em um local seguro e devidamente protegido. O próximo script supera esse problema. Ele ilustra a obtenção de uma senha pelo usuário uma vez no início da execução do script e fazendo o loop em uma lista de itens em um script Expect. A listagem 9 exibe a primeira parte do script, que processa os argumentos do comando: o item a se copiar para hosts remotos e o usuário remoto para especificar no comando scp (negligenciado pelo root). Ele também define o período de tempo limite do Expect. O script seguinte lê um arquivo externo chamado xferhosts (no diretório atual) para obter as listas de hosts para as quais deve copiar o item. Podemos usar isso como uma receita para a leitura de itens de um arquivo externo via Tcl: set file [open "xferhosts" r] set hlist [split [read $file] "\n"] close $file Em seguida, o script solicitará a senha remota, uma operação que é especialmente importante quando o usuário remoto é root. Observe o uso da palavra-chave echo para o comando tty para ativar/desativar o caractere de saída de dados na tela: stty echo send_tty "_" Listagem 10: Looping sobre a lista 01 foreach h $hlist { if {"$h"!= "" { 03 spawn scp r $xfer $user@$h:/tmp 04 expect { 05 "(yes/no)? " { 06 send "yes\r" 07 exp_continue "word:" { 11 send "$pwd\r" 12 exp_continue re "." { exp_continue timeout { break Linux Magazine #109 Março de

6 expect_tty "\n" set pwd [string trimright U "$expect_out(buffer)" "\n"] stty echo if {"$pwd" == "" { exit Listagem 12: Exemplo de timed prompt O comando set que define a variável pwd usa uma construção Tcl para recuperar o conteúdo do buffer do Expect. Este último consiste de todos os caracteres que recebeu da correspondência anterior através da correspondência atual. Neste exemplo, é o que o usuário digitou no prompt de senha. O script remove a nova linha a partir do fim dos dados interpretados como uma string de caracteres. A listagem 10 mostra o laço sobre a lista de hosts do arquivo. O comando foreach Tcl é executado sobre cada item, por sua vez, e a declaração if assegura que o hostname não seja null. A declaração expect é semelhante no script anterior. Ela lida com a troca de chave de host e solicitação de senha, se ocorrerem, e também conclui a iteração do loop atual se o período de tempo limite expirar através do comando break. O outro item na declaração expect é uma expressão regular que corresponde a qualquer caractere único. O comando scp envia o retorno conforme é executado e, enquanto os caracteres forem recebidos, sabemos que o comando ainda está em execução. A expressão regular será correspondente, e o comando exp_continue será executado, que também possui o efeito de resetar o contador de tempo de espera. Quando nenhum caractere é recebido para a duração do período de tempo limite, então a iteração loop termina. Um prompt com tempo de espera O Shell Bash fornece uma maneira de solicitar a entrada do usuário através do comando read e o salva em uma variável, como neste exemplo: read p "Prompt string: " answer < /dev/tty O prompt irá esperar para sempre até que o usuário insira uma resposta. Às vezes, o usuário pode desejar que o prompt tenha um tempo limite, se o u- suário não responder. Com o Expect, podemos criar um prompt com um período de tempo limite embutido. O script para fazê-lo (listagem 11) começa o processamento dos argumentos. O prompt padrão é "Enter response", e o período de tempo limite padrão é de 5 segundos. O código a seguir mostra a parte do script que exibe prompt string e processa a resposta do usuário (se houver): send_tty "$prompt: " set timeout $tout set response "" expect "\n" { set response [string trimright "$expect_out(buffer)" "\n"] 01 #!/bin/bash 03 # Example use of timed prompt script: 04 # The default response is '"'red'"' 05 color=`./timed_prompt "What is your favorite color? " red 2` 06 echo "Your color is $color" 07 echo 08 color=`./timed_prompt "What is your favorite color? " red 20` 09 echo "Your color is $color" Listagem 11: Prompt e timeout 03 set prompt lindex $argv 04 set response lindex $argv 05 set tout lindex $argv 06 if {"$prompt" == "" { 07 set prompt "Enter response" if {"$tout" == "" {set tout 5 send "$response" O script exibe o prompt string na tela, define o valor do tempo limite, e atribui um valor padrão para a variável response. A declaração expect altera o valor de response para qualquer entrada que o usuário digitar. O script termina retornando o valor da resposta ao seu interlocutor. A listagem 12 mostra um exemplo. As linhas a seguir são a saída do script, quando uma resposta é dada para ao segundo e não ao primeiro prompt: $./use_prompt What is your favorite color? Your color is red What is your favorite color? green Your color is green $ O script mostra a cor padrão (vermelha) na primeira mensagem e a cor escolhida no segunda. Esperamos que tenham gostado do Expect. Temos certeza que o usuário encontrar muitos usos para esta excelente ferramenta de automação de processos interativos. n Gostou do artigo? Queremos ouvir sua opinião. Fale conosco em: cartas@linuxmagazine.com.br Este artigo no nosso site: Mais informações [1] NIST Expect: gov/el/msid/expect.cfm [2] Site do Expect: sourceforge.net 74