Tester un module complémentaire de l'éditeur

Les modules complémentaires doivent être testés minutieusement avant d'être publiés pour s'assurer qu'ils fonctionnent comme prévu. Apps Script vous permet de tester les modules complémentaires de l'éditeur en développement sur des fichiers Google Docs, Sheets, Forms ou Slides spécifiques. Vous pouvez l'utiliser pour :

  • Vérifiez qu'un module complémentaire écrit dans un script autonome fonctionne comme prévu lorsqu'il est appliqué à une feuille de calcul, un document, une présentation ou un formulaire.
  • Vérifiez que le processus d'installation du module complémentaire fonctionne comme prévu, en particulier pour les différents états du cycle de vie de l'autorisation initiale (installé, activé ou les deux).
  • Vérifiez que le module complémentaire fonctionne comme prévu lorsqu'il agit sur un document spécifique et son contenu.
  • Testez et comparez la version actuelle et la version précédente du module complémentaire.

Créer un déploiement de test

Un déploiement de test est la combinaison d'un module complémentaire et d'un document de test. Une fois que vous avez développé une version de script et que vous souhaitez la tester en tant que module complémentaire, procédez comme suit :

  1. Si vous n'en avez pas encore, créez une feuille de calcul, un document, une présentation ou un formulaire pour tester le module complémentaire.
  2. Ouvrez le projet de script contenant votre module complémentaire.
  3. Cliquez sur Déployer > Tester les déploiements.
  4. En regard de Sélectionner le type, cliquez sur Activer les types de déploiement , puis sélectionnez Module complémentaire de l'éditeur.
  5. Cliquez sur Créer un test ou Ajouter un test.
  6. Choisissez une version du code ou sélectionnez Dernier code.
  7. Dans la section Configuration, sélectionnez l'état d'autorisation initial du test.
  8. Sous Document de test, cliquez sur Aucun document sélectionné. Sélectionnez le fichier Sheets, Docs, Slides ou Forms que vous souhaitez utiliser pour tester le module complémentaire, puis cliquez sur Insérer.
  9. Cliquez sur Enregistrer le test.

Tous les déploiements de test enregistrés s'affichent dans la boîte de dialogue Déploiements de test. Cela vous permet de revenir sur le même déploiement de test ultérieurement.

Exécuter un déploiement test

Si vous avez enregistré un ou plusieurs déploiements de test, vous pouvez en exécuter un en procédant comme suit :

  1. Ouvrez le projet de script contenant votre module complémentaire.
  2. Cliquez sur Déployer > Tester les déploiements.
  3. Sous Tests enregistrés, sélectionnez la case d'option à côté du déploiement de test enregistré que vous souhaitez exécuter, puis cliquez sur Exécuter.

Le document de test s'ouvre dans un nouvel onglet. Le module complémentaire se trouve dans l'état d'autorisation spécifié dans le déploiement de test. Vous pouvez vérifier que le module complémentaire fonctionne comme prévu en interagissant avec son menu et ses éléments d'interface utilisateur.

Pour tester la fonctionnalité OAuth précis sur votre module complémentaire, assurez-vous que votre projet ne dispose pas déjà d'autorisations. Pour invalider les autorisations existantes, utilisez ScriptApp.invalidateAuth.

Détails des tests

Voici quelques points à garder à l'esprit lorsque vous testez des modules complémentaires de l'éditeur de cette manière :

  • Les déclencheurs installables ne sont pas compatibles avec les tests. Les fonctionnalités qui dépendent des déclencheurs installables ne peuvent pas être testées.
  • Lorsque vous exécutez un déploiement de test défini sur "Tester avec le code le plus récent", vous pouvez voir les modifications enregistrées dans le script du module complémentaire en actualisant le document de test.
  • Le document de test possède une URL que vous pouvez partager avec les éditeurs du document de test d'origine. Vous pouvez ainsi collaborer plus facilement avec d'autres personnes lors des tests et du développement.
  • Si votre module complémentaire utilise le service Propriétés, les propriétés sont conservées et restent disponibles la prochaine fois que le déploiement de test est exécuté.
  • De plus, tout déploiement de test qui utilise la même combinaison de module complémentaire et de document de test a accès aux mêmes informations sur la propriété. Par exemple, si vous créez deux déploiements de test, les propriétés enregistrées lors de l'exécution du premier sont disponibles lors de l'exécution du second, et inversement, mais uniquement si les déploiements utilisent le même script et le même document de test.
  • Si vous exécutez un déploiement test, vous pouvez être invité à fournir une autorisation si vous n'avez jamais exécuté le script auparavant. Sachez que l'autorisation d'un script pendant les tests autorise également le script en dehors des tests.