Utiliser le serveur de développement local

Vous pouvez utiliser le serveur de développement local pour simuler l'exécution de votre application App Engine en production, ainsi que pour accéder aux services groupés App Engine.

L'environnement simulé applique certaines restrictions de bac à sable, telles que des importations de modules Go 1.11 et des fonctions système limitées. Il s'affranchit de certaines autres restrictions, telles que celles applicables aux délais de requêtes ou aux quotas.

Le serveur de développement local simule également les services fournis par les bibliothèques du SDK pour App Engine, y compris Datastore, Memcache et les files de tâches, en effectuant leurs tâches localement. Lorsque votre application s'exécute sur le serveur de développement, vous pouvez toujours effectuer des appels d'API distants vers l'infrastructure de production à l'aide des points de terminaison HTTP des API Google.

Avant de commencer

Go 1.11 ayant atteint la fin de la période de compatibilité, vous ne pouvez plus utiliser la dernière version de dev_appserver.py pour exécuter localement vos applications. Pour télécharger une version archivée de devapp_server.py, procédez comme suit :

  1. À partir des archives, téléchargez le dossier compressé contenant le serveur dev_appserver.py pour les environnements d'exécution qui ne sont plus compatibles.

  2. Extrayez le contenu du répertoire vers votre système de fichiers local, par exemple vers votre répertoire /home. Vous trouverez dev_appserver.py dans le répertoire google_appengine/.

Configurer le serveur de développement local

Pour exécuter l'outil de serveur de développement local, vous devez d'abord appliquer la procédure suivante :

  1. Vérifiez que vous avez installé un interpréteur Python 2 version 2.7.12 ou ultérieure.

  2. Définissez la variable d'environnement DEVAPPSERVER_ROOT dans votre shell sur le chemin d'accès à votre interpréteur Python 2.

Exécuter le serveur de développement local

Après avoir configuré le serveur de développement local et créé le fichier de configuration app.yaml pour votre application, vous pouvez utiliser la commande dev_appserver.py pour exécuter votre application localement.

Pour démarrer le serveur de développement local, procédez comme suit :

  1. Exécutez la commande dev_appserver.py dans le répertoire contenant votre fichier de configuration app.yaml.

    dev_appserver.py

    Spécifiez le chemin d'accès au répertoire de votre application, par exemple :

    python2 DEVAPPSERVER_ROOT/google_appengine/dev_appserver.py PATH_TO_YOUR_APP

    Vous pouvez également spécifier le fichier de configuration d'un service spécifique, par exemple :

    python2 DEVAPPSERVER_ROOT/google_appengine/dev_appserver.py app.yaml

    Pour changer le port, incluez l'option --port :

    python2 DEVAPPSERVER_ROOT/google_appengine/dev_appserver.py --port=9999 PATH_TO_YOUR_APP

    Remplacez DEVAPPSERVER_ROOT par le chemin d'accès au dossier dans lequel vous extrayez la version archivée de devapp_server.py.

    goapp serve

    La commande goapp serve est incluse dans le SDK App Engine pour Go d'origine et encapsule l'outil Python dev_appserver.py sous-jacent. Pour démarrer le serveur de développement local, exécutez :

      goapp serve

    Pour en savoir plus sur les options de la commande dev_appserver.py, consultez la page Options du serveur de développement local.

  2. Le serveur de développement local est désormais en cours d'exécution et à l'écoute des requêtes. Vous pouvez saisir l'adresse http://localhost:8080/ dans votre navigateur Web pour voir l'application en action.

    Si vous avez spécifié un port personnalisé avec l'option --port, n'oubliez pas d'ouvrir votre navigateur pour ce port.

Pour arrêter le serveur local à partir de la ligne de commande, appuyez sur les touches suivantes :

  • macOS ou Linux : Contrôle+C
  • Windows : Contrôle+Pause

Spécifier des ID d'application

Pour accéder à l'ID de votre application sur le serveur local, par exemple pour simuler une adresse e-mail, utilisez la fonction appengine.AppID. Pour obtenir le nom d'hôte de l'application en cours d'exécution, utilisez la fonction appengine.DefaultVersionHostname.

Détecter l'environnement d'exécution de l'application

Pour déterminer si votre code est en cours d'exécution en production ou sur le serveur de développement local, vous pouvez appeler la méthode IsDevAppServer(). Lorsque la valeur est true, le code est exécuté dans l'environnement de développement local. Sinon, vous êtes en production.


package devserver

import (
	"fmt"
	"net/http"

	"google.golang.org/appengine"
)

func init() {
	http.HandleFunc("/", handler)
}

func handler(w http.ResponseWriter, r *http.Request) {
	fmt.Fprintf(w, "IsDevAppServer: %v", appengine.IsDevAppServer())
}

Utiliser le datastore local

Le serveur de développement local simule le datastore App Engine à l'aide d'un fichier local persistant entre les appels du serveur local.

Pour plus d'informations sur les index et index.yaml, consultez les pages Index Datastore et Configurer des index Datastore.

Parcourir le datastore local

Si votre application a écrit des données sur votre datastore local à l'aide du serveur de développement local, vous pouvez les parcourir dans la console de développement local.

Pour parcourir le datastore local :

  1. Démarrez le serveur de développement.

  2. Accédez au lecteur Datastore dans la console de développement local, (URL : http://localhost:8000/datastore)

  3. Affichez le contenu du datastore local.

Spécifier la stratégie d'attribution d'ID

Pour App Engine en production, vous pouvez configurer le datastore pour qu'il génère automatiquement des ID d'entité.

Bien que les stratégies d'attribution automatique d'ID pour le serveur de production soient complètement différentes de celles utilisées par le serveur de développement, vous pouvez également définir la stratégie d'attribution automatique d'ID pour le serveur local.

Pour spécifier la règle d'attribution automatique d'ID, utilisez l'option --auto_id_policy :

python2 DEVAPPSERVER_ROOT/google_appengine/dev_appserver.py --auto_id_policy=sequential

Remplacez :

  • DEVAPPSERVER_ROOT par le chemin d'accès au dossier dans lequel vous extrayez la version archivée de devapp_server.py.

  • --auto_id_policy par l'un des éléments suivants :

    • scattered (par défaut) lorsque les identifiants sont attribués à partir d'une séquence non répétitive d'entiers répartis de manière quasi uniforme.
    • sequential lorsque les ID sont attribués à partir de la séquence d'entiers consécutifs.

Effacer le datastore local

Pour effacer le datastore local d'une application, invoquez le serveur de développement local comme suit :

python2 DEVAPPSERVER_ROOT/google_appengine/dev_appserver.py --clear_datastore=yes app.yaml

Remplacez DEVAPPSERVER_ROOT par le chemin d'accès au dossier dans lequel vous extrayez la version archivée de devapp_server.py.

Modifier l'emplacement du datastore local

Pour modifier l'emplacement utilisé pour le fichier du datastore, employez l'option --datastore_path :

python2 DEVAPPSERVER_ROOT/google_appengine/dev_appserver.py --datastore_path=/tmp/myapp_datastore app.yaml

Remplacez DEVAPPSERVER_ROOT par le chemin d'accès au dossier dans lequel vous extrayez la version archivée de devapp_server.py.

Utiliser le service Users

App Engine fournit un service Users pour simplifier l'authentification et les autorisations de votre application. Le serveur de développement local simule le comportement des comptes Google avec ses propres pages de connexion et de déconnexion. Lorsque qu'elles s'exécutent sur le serveur de développement local, les fonctions LoginURL et LogoutURL renvoient les URL de /_ah/login et /_ah/logout sur le serveur local.

Utiliser la messagerie

Le serveur de développement local peut envoyer des e-mails pour les appels au service de messagerie App Engine à l'aide d'un serveur SMTP ou d'une installation locale de Sendmail.

Utiliser SMTP

Pour activer la messagerie avec un serveur SMTP, appelez dev_appserver.py comme suit :

   python2 [DEVAPPSERVER_ROOT]/google_appengine/dev_appserver.py --smtp_host=smtp.example.com --smtp_port=25 \
    --smtp_user=ajohnson --smtp_password=k1tt3ns [PATH_TO_YOUR_APP]

Remplacez :

  • [DEVAPPSERVER_ROOT] par le chemin d'accès au dossier dans lequel vous extrayez la version archivée de devapp_server.py.
  • Les options --smtp_host, --smtp_port, --smtp_user et --smtp_password par vos propres valeurs de configuration.

Utiliser Sendmail

Pour activer la messagerie avec Sendmail, appelez dev_appserver.py comme suit :

   python2 [DEVAPPSERVER_ROOT]/google_appengine/dev_appserver.py --enable_sendmail=yes [PATH_TO_YOUR_APP]

Remplacez [DEVAPPSERVER_ROOT] par le chemin d'accès au dossier dans lequel vous extrayez la version archivée de devapp_server.py.

Le serveur local utilise la commande sendmail pour envoyer des e-mails avec la configuration par défaut de votre installation.

Utiliser URL Fetch

Lorsque l'application utilise l'API URL Fetch pour exécuter une requête HTTP, le serveur de développement local effectue la requête directement à partir de votre ordinateur. Si vous accédez aux sites Web via un serveur proxy, le comportement du service URL Fetch sur le serveur local peut être différent de celui d'App Engine en production.