Appeler des fonctions Cloud Functions directement

Pour prendre en charge l'itération et le débogage rapides, Cloud Functions fournit une commande call dans l'interface de ligne de commande et des fonctionnalités de test dans l'interface utilisateur de la console Google Cloud. Cela vous permet d'appeler directement une fonction pour vous assurer qu'elle se comporte comme prévu. La fonction s'exécute immédiatement, même si elle a été déployée pour répondre à un événement spécifique.

Remarque : Lorsque vous appelez des fonctions directement, la méthode d'appel est utilisée. Cette méthode dispose d'un quota limité qui ne peut pas être augmenté. Elle est destinée aux tests et ne doit pas être utilisée en production.

Tester votre fonction avec Google Cloud CLI

1re génération

Pour appeler directement une fonction de 1re génération à l'aide de la gcloud CLI, exécutez la commande gcloud functions call et fournissez toutes les données que votre fonction attend au format JSON dans l'argument --data. Par exemple :

gcloud functions call YOUR_FUNCTION_NAME --data '{"name":"Tristan"}'

où YOUR_FUNCTION_NAME correspond au nom de la fonction que vous souhaitez exécuter. L'argument --data est envoyé à votre fonction comme suit :

• Pour les fonctions HTTP, les données que vous fournissez sont envoyées en tant que corps d'une requête POST.
• Pour les fonctions d'arrière-plan, les données sont directement transmises à votre fonction en tant que données d'événement. Pour plus d'informations sur l'accès aux données d'événement dans les fonctions d'arrière-plan, consultez la section Paramètres des fonctions d'arrière-plan.
• Pour les fonctions CloudEvent, les données sont directement transmises à votre fonction en tant que données d'événement. Pour plus d'informations sur l'accès aux données d'événement dans les fonctions CloudEvent, consultez la section Paramètres des fonctions CloudEvent.

2e génération

Pour appeler directement une fonction de 2e génération à l'aide de gcloud CLI, utilisez la version de 2e génération de la commande gcloud functions call et fournissez toutes les données que votre fonction attend au format JSON dans l'argument --data. Par exemple :

gcloud functions call YOUR_FUNCTION_NAME \
  --region=REGION --gen2 \
  --data '{"name":"Kalani"}'

Remplacez :

• YOUR_FUNCTION_NAME : nom de la fonction que vous testez.
• REGION : région Google Cloud dans laquelle votre fonction est déployée

L'argument --data est envoyé à votre fonction comme suit :

• Pour les fonctions HTTP, les données que vous fournissez sont envoyées en tant que corps d'une requête POST.
• Pour les fonctions CloudEvent, les données sont directement transmises à votre fonction en tant que données d'événement. Pour plus d'informations sur l'accès aux données d'événement dans les fonctions CloudEvent, consultez la section Paramètres des fonctions CloudEvent.

Pour en savoir plus, reportez-vous à la documentation gcloud functions call.

Tester votre fonction avec la console Google Cloud

Pour appeler directement une fonction à partir de la console Google Cloud, procédez comme suit :

1re génération

1. Accéder à la page de présentation de Cloud Functions

2. Cliquez sur le nom de la fonction que vous souhaitez appeler.

3. Cliquez sur l'onglet Tests.

4. Dans le champ Configurer un événement déclencheur, saisissez les données que votre fonction attend au format JSON.

5. Cliquez sur Tester la fonction.

La réponse de votre fonction s'affiche dans le champ Sortie et les journaux de l'exécution individuelle s'affichent dans le champ Journaux.

2e génération

1. Accéder à la page de présentation de Cloud Functions

2. Dans la liste, cliquez sur le nom de la fonction que vous souhaitez appeler. La page d'informations de la fonction s'affiche.

3. Cliquez sur l'onglet Tests.

4. Dans le champ Configurer un événement déclencheur, saisissez les données que votre fonction attend au format JSON.

5. Cliquez sur les boutons +Ajouter un paramètre de requête et +Ajouter un paramètre d'en-tête pour ajouter des paramètres de requête et d'en-tête à l'appel de fonction, si nécessaire.

   La console Google Cloud assemble les paramètres que vous spécifiez dans une commande gcloud functions call dans la fenêtre de la commande de test de la CLI.

6. Sélectionnez Exécuter dans Cloud Shell pour ouvrir une fenêtre Cloud Shell afin d'exécuter cette commande.

7. Appuyez sur Entrée pour déclencher la commande gcloud functions call après son affichage dans votre fenêtre Cloud Shell.

Exemple de fonction Cloud Pub/Sub basée sur des événements

Cet exemple montre comment appeler directement une fonction de 1re génération basée sur des événements déclenchée par Cloud Pub/Sub :

Node.js

/**
 * Background Cloud Function to be triggered by Pub/Sub.
 * This function is exported by index.js, and executed when
 * the trigger topic receives a message.
 *
 * @param {object} message The Pub/Sub message.
 * @param {object} context The event metadata.
 */
exports.helloPubSub = (message, context) => {
  const name = message.data
    ? Buffer.from(message.data, 'base64').toString()
    : 'World';

  console.log(`Hello, ${name}!`);
};

Python

def hello_pubsub(event, context):
    """Background Cloud Function to be triggered by Pub/Sub.
    Args:
         event (dict):  The dictionary with data specific to this type of
                        event. The `@type` field maps to
                         `type.googleapis.com/google.pubsub.v1.PubsubMessage`.
                        The `data` field maps to the PubsubMessage data
                        in a base64-encoded string. The `attributes` field maps
                        to the PubsubMessage attributes if any is present.
         context (google.cloud.functions.Context): Metadata of triggering event
                        including `event_id` which maps to the PubsubMessage
                        messageId, `timestamp` which maps to the PubsubMessage
                        publishTime, `event_type` which maps to
                        `google.pubsub.topic.publish`, and `resource` which is
                        a dictionary that describes the service API endpoint
                        pubsub.googleapis.com, the triggering topic's name, and
                        the triggering event type
                        `type.googleapis.com/google.pubsub.v1.PubsubMessage`.
    Returns:
        None. The output is written to Cloud Logging.
    """
    import base64

    print(
        """This Function was triggered by messageId {} published at {} to {}
    """.format(
            context.event_id, context.timestamp, context.resource["name"]
        )
    )

    if "data" in event:
        name = base64.b64decode(event["data"]).decode("utf-8")
    else:
        name = "World"
    print(f"Hello {name}!")

Go

// Package helloworld provides a set of Cloud Functions samples.
package helloworld

import (
	"context"
	"log"
)

// PubSubMessage is the payload of a Pub/Sub event.
// See the documentation for more details:
// https://cloud.google.com/pubsub/docs/reference/rest/v1/PubsubMessage
type PubSubMessage struct {
	Data []byte `json:"data"`
}

// HelloPubSub consumes a Pub/Sub message.
func HelloPubSub(ctx context.Context, m PubSubMessage) error {
	name := string(m.Data) // Automatically decoded from base64.
	if name == "" {
		name = "World"
	}
	log.Printf("Hello, %s!", name)
	return nil
}

Java

import com.google.cloud.functions.BackgroundFunction;
import com.google.cloud.functions.Context;
import functions.eventpojos.PubsubMessage;
import java.nio.charset.StandardCharsets;
import java.util.Base64;
import java.util.logging.Level;
import java.util.logging.Logger;

public class HelloPubSub implements BackgroundFunction<PubsubMessage> {
  private static final Logger logger = Logger.getLogger(HelloPubSub.class.getName());

  @Override
  public void accept(PubsubMessage message, Context context) {
    String name = "world";
    if (message != null && message.getData() != null) {
      name = new String(
          Base64.getDecoder().decode(message.getData().getBytes(StandardCharsets.UTF_8)),
          StandardCharsets.UTF_8);
    }
    logger.info(String.format("Hello %s!", name));
    return;
  }
}

C#

using CloudNative.CloudEvents;
using Google.Cloud.Functions.Framework;
using Google.Events.Protobuf.Cloud.PubSub.V1;
using Microsoft.Extensions.Logging;
using System.Threading;
using System.Threading.Tasks;

namespace HelloPubSub;

public class Function : ICloudEventFunction<MessagePublishedData>
{
    private readonly ILogger _logger;

    public Function(ILogger<Function> logger) =>
        _logger = logger;

    public Task HandleAsync(CloudEvent cloudEvent, MessagePublishedData data, CancellationToken cancellationToken)
    {
        string nameFromMessage = data.Message?.TextData;
        string name = string.IsNullOrEmpty(nameFromMessage) ? "world" : nameFromMessage;
        _logger.LogInformation("Hello {name}", name);
        return Task.CompletedTask;
    }
}

Ruby

require "functions_framework"
require "base64"

FunctionsFramework.cloud_event "hello_pubsub" do |event|
  # The event parameter is a CloudEvents::Event::V1 object.
  # See https://cloudevents.github.io/sdk-ruby/latest/CloudEvents/Event/V1.html
  name = Base64.decode64 event.data["message"]["data"] rescue "World"

  # A cloud_event function does not return a response, but you can log messages
  # or cause side effects such as sending additional events.
  logger.info "Hello, #{name}!"
end

PHP

use CloudEvents\V1\CloudEventInterface;
use Google\CloudFunctions\FunctionsFramework;

// Register the function with Functions Framework.
// This enables omitting the `FUNCTIONS_SIGNATURE_TYPE=cloudevent` environment
// variable when deploying. The `FUNCTION_TARGET` environment variable should
// match the first parameter.
FunctionsFramework::cloudEvent('helloworldPubsub', 'helloworldPubsub');

function helloworldPubsub(CloudEventInterface $event): void
{
    $log = fopen(getenv('LOGGER_OUTPUT') ?: 'php://stderr', 'wb');

    $cloudEventData = $event->getData();
    $pubSubData = base64_decode($cloudEventData['message']['data']);

    $name = $pubSubData ? htmlspecialchars($pubSubData) : 'World';
    fwrite($log, "Hello, $name!" . PHP_EOL);
}

Pour appeler directement la fonction, envoyez une requête PubsubMessage, qui attend des données encodées en base64 en tant que données d'événement :

Node.js

DATA=$(printf 'Hello!'|base64) && gcloud functions call helloPubSub --data '{"data":"'$DATA'"}'

Python

DATA=$(printf 'Hello!'|base64) && gcloud functions call hello_pubsub --data '{"data":"'$DATA'"}'

Go

DATA=$(printf 'Hello!'|base64) && gcloud functions call HelloPubSub --data '{"data":"'$DATA'"}'

Java

DATA=$(printf 'Hello!'|base64) && gcloud functions call java-hello-pubsub --data '{"data":"'$DATA'"}'

C#

DATA=$(printf 'Hello!'|base64) && gcloud functions call csharp-hello-pubsub --data '{"data":"'$DATA'"}'

Ruby

DATA=$(printf 'Hello!'|base64) && gcloud functions call hello_pubsub --data '{"data":"'$DATA'"}'

PHP

DATA=$(printf 'Hello!'|base64) && gcloud functions call helloworldPubsub --data '{"data":"'$DATA'"}'

Cet exemple de la CLI utilise la syntaxe bash ou sh. Il fonctionne sous Linux et Mac, mais pas sous Windows.

Vous pouvez également appeler la fonction depuis la console Google Cloud en utilisant les mêmes données d'événement dans le champ Événement déclencheur.