Realizar testes locais com o emulador do Pub/Sub

É possível testar as funções localmente antes de implantá-las usando o Framework de funções com o emulador do Pub/Sub. Os exemplos desta página são baseados nas funções do Cloud Run

Usar o Functions Framework com o emulador do Pub/Sub

É possível acionar uma função localmente usando uma mensagem push do emulador do Pub/Sub.

Teste esse recurso conforme descrito aqui. Observe que ele requer o uso de três instâncias de terminal separadas:

  1. Verifique se você tem a ferramenta pack e o Docker instalados.

  2. No primeiro terminal, inicie o emulador do Pub/Sub na porta 8043 em um projeto local:

    gcloud beta emulators pubsub start \
    --project=abc \
    --host-port='localhost:8043'

  3. No segundo terminal, crie um tópico e uma assinatura do Pub/Sub:

    curl -s -X PUT 'http://localhost:8043/v1/projects/abc/topics/mytopic'

    Use http://localhost:8080 como o endpoint de assinatura de push.

    curl -s -X PUT 'http://localhost:8043/v1/projects/abc/subscriptions/mysub' \
    -H 'Content-Type: application/json' \
    --data '{"topic":"projects/abc/topics/mytopic","pushConfig":{"pushEndpoint":"http://localhost:8080/projects/abc/topics/mytopic"}}'

  4. No terceiro terminal, clone o repositório de amostra para sua máquina local:

    Node.js 

    git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git

    Outra alternativa é fazer o download da amostra como um arquivo ZIP e extraí-lo.

    Python 

    git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git

    Outra alternativa é fazer o download da amostra como um arquivo ZIP e extraí-lo.

    Go

    git clone https://github.com/GoogleCloudPlatform/golang-samples.git

    Outra alternativa é fazer o download da amostra como um arquivo ZIP e extraí-lo.

    Mude para o diretório que contém o código de amostra das funções do Cloud Run:

    Node.js 

    cd nodejs-docs-samples/functions/v2/helloPubSub/

    Python 

    cd python-docs-samples/functions/v2/pubsub/

    Go

    cd golang-samples/functions/functionsv2/hellopubsub/

    Confira o código de amostra:

    Node.js 

    const functions = require('@google-cloud/functions-framework');

// Register a CloudEvent callback with the Functions Framework that will
// be executed when the Pub/Sub trigger topic receives a message.
functions.cloudEvent('helloPubSub', cloudEvent => {
  // The Pub/Sub message is passed as the CloudEvent's data payload.
  const base64name = cloudEvent.data.message.data;

  const name = base64name
    ? Buffer.from(base64name, 'base64').toString()
    : 'World';

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

    Python 

    import base64

from cloudevents.http import CloudEvent
import functions_framework


# Triggered from a message on a Cloud Pub/Sub topic.
@functions_framework.cloud_event
def subscribe(cloud_event: CloudEvent) -> None:
    # Print out the data from Pub/Sub, to prove that it worked
    print(
        "Hello, " + base64.b64decode(cloud_event.data["message"]["data"]).decode() + "!"
    )

    Go

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

import (
	"context"
	"fmt"
	"log"

	"github.com/GoogleCloudPlatform/functions-framework-go/functions"
	"github.com/cloudevents/sdk-go/v2/event"
)

func init() {
	functions.CloudEvent("HelloPubSub", helloPubSub)
}

// MessagePublishedData contains the full Pub/Sub message
// See the documentation for more details:
// https://cloud.google.com/eventarc/docs/cloudevents#pubsub
type MessagePublishedData struct {
	Message PubSubMessage
}

// 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 CloudEvent message and extracts the Pub/Sub message.
func helloPubSub(ctx context.Context, e event.Event) error {
	var msg MessagePublishedData
	if err := e.DataAs(&msg); err != nil {
		return fmt.Errorf("event.DataAs: %w", err)
	}

	name := string(msg.Message.Data) // Automatically decoded from base64.
	if name == "" {
		name = "World"
	}
	log.Printf("Hello, %s!", name)
	return nil
}

    Criar o buildpack (isso pode levar alguns minutos):

    Node.js 

    pack build \
  --builder gcr.io/buildpacks/builder:v1 \
  --env GOOGLE_FUNCTION_SIGNATURE_TYPE=event \
  --env GOOGLE_FUNCTION_TARGET=helloPubSub \
  my-function

    Python 

    pack build \
  --builder gcr.io/buildpacks/builder:v1 \
  --env GOOGLE_FUNCTION_SIGNATURE_TYPE=event \
  --env GOOGLE_FUNCTION_TARGET=subscribe \
  my-function

    Go

    pack build \
  --builder gcr.io/buildpacks/builder:v1 \
  --env GOOGLE_FUNCTION_SIGNATURE_TYPE=event \
  --env GOOGLE_FUNCTION_TARGET=HelloPubSub \
  my-function

    Inicie a função Pub/Sub na porta 8080. O emulador enviará mensagens push:

    docker run --rm -p 8080:8080 my-function

  5. No segundo terminal, invoque a função publicando uma mensagem. Os dados da mensagem precisam ser codificados em base64. Este exemplo usa a string {"foo":"bar"} codificada em base64.

    curl -s -X POST 'http://localhost:8043/v1/projects/abc/topics/mytopic:publish' \
    -H 'Content-Type: application/json' \
    --data '{"messages":[{"data":"eyJmb28iOiJiYXIifQ=="}]}'

    Você verá a saída da função no terceiro terminal.

    Pressione Ctrl+C para cancelar.