Testar um complemento do Editor

Os complementos precisam ser testados completamente antes da publicação para garantir que se comportem conforme o esperado. O Apps Script permite testar os complementos do Editor em desenvolvimento em arquivos específicos das Planilhas, Formulários ou Apresentações Google. Isso pode ser usado para:

  • Verifique se um complemento escrito em um script independente funciona conforme o esperado quando aplicado a uma página, documento, apresentação ou formulário.
  • Verifique se o fluxo de instalação de complementos funciona conforme o esperado, especialmente para diferentes estados do ciclo de vida de autorização (instalados, ativados ou ambos).
  • Verifique se o complemento funciona conforme o esperado ao agir em um documento específico e no conteúdo dele.
  • Teste e compare a versão atual e anterior do complemento.

Criar uma implantação de teste

Uma implantação de teste é a combinação de um complemento e um documento de teste. Siga as etapas abaixo quando tiver desenvolvido uma versão do script e quiser testá-la como um complemento:

  1. Caso ainda não tenha um, crie uma planilha, um documento, uma apresentação ou um formulário para testar o complemento.
  2. Abra o projeto de script que contém o complemento.
  3. Clique em Implantar > Testar implantações.
  4. Ao lado de Selecionar tipo, clique em Ativar tipos de implantação e selecione Complemento Editor.
  5. Clique em Criar novo teste ou Adicionar teste.
  6. Escolha uma versão do código ou selecione Último código.
  7. Na seção Configuração, selecione o estado de autorização inicial para o teste.
  8. Em Documento de teste, clique em Nenhum documento selecionado. Selecione o arquivo do Planilhas, Documentos, Apresentações ou Formulários que você quer usar para testar o complemento e clique em Inserir.
  9. Clique em Salvar teste.

Todas as implantações de teste salvas são exibidas na caixa de diálogo Testar implantações. Isso permite revisitar a mesma implantação de teste mais tarde.

Executar uma implantação de teste

Se você tiver uma ou mais implantações de teste salvas, poderá executar uma delas seguindo estas etapas:

  1. Abra o projeto de script que contém o complemento.
  2. Clique em Implantar > Testar implantações.
  3. Em Testes salvos, selecione o botão de opção ao lado da implantação de teste salva que você quer executar e clique em Executar.

O documento de teste é aberto em uma nova guia. O complemento está no estado de autorização especificado na implantação de teste. Você pode verificar se o complemento funciona conforme o esperado interagindo com os elementos de menu e IU dele.

Detalhes dos testes

É importante lembrar de vários pontos ao testar os complementos do Editor desta maneira:

  • Gatilhos instaláveis não são compatíveis com os testes. A funcionalidade que depende de acionadores instaláveis não pode ser testada.
  • Ao executar uma implantação de teste definida para testar com o código mais recente, é possível ver as alterações salvas no script de complemento atualizando o documento de teste.
  • O documento de teste tem um URL que você pode compartilhar com os editores do documento de teste original. Dessa forma, fica mais fácil colaborar com outras pessoas durante os testes e o desenvolvimento.
  • Se o complemento usar o serviço de propriedades, as propriedades serão mantidas e estarão disponíveis na próxima vez que a implantação de teste for executada.
  • Além disso, qualquer implantação de teste que use a mesma combinação de complemento e documento de teste tem acesso às mesmas informações de propriedade. Por exemplo, se você criar duas implantações de teste, as propriedades salvas durante a execução da primeira estarão disponíveis durante a execução da segunda e vice-versa, mas somente se as implantações usarem o mesmo script e documento de teste.
  • Se você executar uma implantação de teste, talvez receba uma solicitação de autorização se não tiver executado o script antes. A autorização de um script durante o teste também faz com que ele seja autorizado fora do teste.