Call local functions
Setup
This document assumes that you've
set up a locally running function on
localhost
using either Functions Framework
or Buildpacks. It also assumes that you've
installed the curl
tool on your local machine.
Sending requests to local functions
You can trigger locally-running functions by sending them HTTP requests routed via a local serving process.
Determine where your function is running locally by checking the URL displayed
when you started running the function. By
default, your function will be hosted at localhost:8080
.
HTTP functions
When you test your HTTP function from your development environment, it normally
listens for requests on localhost:8080
. This interface is only accessible from
the machine or VM your function is running on; requests sent from any other
system can't reach it. For this reason, you must issue the HTTP request from the
same system that your function is running on. In the following examples, if your
function is listening on a port other than 8080, replace the 8080 in the
example with the port number for your function.
Testing HTTP functions with Cloud Shell
If you're using Cloud Shell to build and test your function, start your
function locally in the Cloud Shell terminal window, then issue the HTTP
trigger request from a browser or curl
instance as follows:
Browser
Click the icon on your cloud shell toolbar and choose port 8080 or Change port to pick a different port. This opens a browser window on the correct system and issues a GET request to the indicated port.
Curl
To control the format of your HTTP request or to see the unformatted reply,
use curl
:
- Click the + icon on the Cloud Shell menu bar to open a new terminal window on the same system your function is running on.
From within that window, run the
curl
command to trigger your function. For example:curl localhost:8080
Testing HTTP functions on your desktop server
If you're building and running your function on your local desktop system, first
start your function locally, then issue your HTTP trigger request from a browser
or curl
instance as follows:
Browser
Open a new browser window or tab and type http://localhost:8080
into the
browser address bar. This opens a browser window to localhost:8080
on your
desktop server to trigger your function.
Curl
Open a new terminal window on your local desktop, then run the curl
command
in that window to trigger your function. For example:
curl localhost:8080
This runs the specified curl
command to trigger your function and displays
the unformatted response.
CloudEvent functions
You can send sample events to
CloudEvent functions
using curl
. The following curl
requests show how to send sample
Pub/Sub and
Cloud Storage events to a
CloudEvent function running at localhost:8080
.
Pub/Sub
curl localhost:8080 \ -X POST \ -H "Content-Type: application/json" \ -H "ce-id: 123451234512345" \ -H "ce-specversion: 1.0" \ -H "ce-time: 2020-01-02T12:34:56.789Z" \ -H "ce-type: google.cloud.pubsub.topic.v1.messagePublished" \ -H "ce-source: //pubsub.googleapis.com/projects/MY-PROJECT/topics/MY-TOPIC" \ -d '{ "message": { "data": "d29ybGQ=", "attributes": { "attr1":"attr1-value" } }, "subscription": "projects/MY-PROJECT/subscriptions/MY-SUB" }'
Storage
curl localhost:8080 \ -X POST \ -H "Content-Type: application/json" \ -H "ce-id: 123451234512345" \ -H "ce-specversion: 1.0" \ -H "ce-time: 2020-01-02T12:34:56.789Z" \ -H "ce-type: google.cloud.storage.object.v1.finalized" \ -H "ce-source: //storage.googleapis.com/projects/_/buckets/MY-BUCKET-NAME" \ -H "ce-subject: objects/MY_FILE.txt" \ -d '{ "bucket": "MY_BUCKET", "contentType": "text/plain", "kind": "storage#object", "md5Hash": "...", "metageneration": "1", "name": "MY_FILE.txt", "size": "352", "storageClass": "MULTI_REGIONAL", "timeCreated": "2020-04-23T07:38:57.230Z", "timeStorageClassUpdated": "2020-04-23T07:38:57.230Z", "updated": "2020-04-23T07:38:57.230Z" }'