Skip to main content

A stub emulator for the Google Cloud Tasks API

Project description

Local Emulator for Google Cloud Tasks

Google doesn't (yet) ship an emulator for the Cloud Tasks API like they do for Cloud Datastore.

This is a stub emulator so you can run your tests and do local development without having to connect to the production Tasks API.

THIS IS A WORK IN PROGRESS NOT ALL API CALLS ARE COMPLETE


Looking for Commercial Support?

Potato offers Commercial Support for all its Open Source projects and we can tailor a support package to your needs.

If you're interested in commercial support, training, or consultancy then go ahead and contact us at opensource@potatolondon.com


Usage

Start the emulator with:

gcloud-tasks-emulator start --port=9090

Then from within your code, use the following (instead of your normal production client connection)

Python

import grpc
from google.cloud.tasks_v2 import CloudTasksClient
from google.cloud.tasks_v2.services.cloud_tasks.transports import CloudTasksGrpcTransport

client = CloudTasksClient(
    transport=CloudTasksGrpcTransport(channel=grpc.insecure_channel("127.0.0.1:9090"))
)

Node.js

const grpc = require("@grpc/grpc-js");
const { CloudTasksClient } = require('@google-cloud/tasks');

const client = new CloudTasksClient({
    servicePath: "localhost",
    port: 9090,
    sslCreds: grpc.credentials.createInsecure()
});

Java

import com.google.api.gax.core.NoCredentialsProvider;
import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider;
import com.google.cloud.tasks.v2.CloudTasksClient;
import com.google.cloud.tasks.v2.CloudTasksSettings;
import io.grpc.ManagedChannelBuilder;

CloudTasksSettings settings = CloudTasksSettings.newBuilder()
        .setCredentialsProvider(NoCredentialsProvider.create())
        .setTransportChannelProvider(
                InstantiatingGrpcChannelProvider.newBuilder()
                        .setEndpoint("localhost:9090")
                        .setChannelConfigurator(ManagedChannelBuilder::usePlaintext)
                        .build()
        )
        .build();
CloudTasksClient client = CloudTasksClient.create(settings);

The 'default' queue

By default, the emulator won't create a 'default' queue, however you can enable this by passing the fully-qualified name of the queue:

gcloud-tasks-emulator start --default-queue=projects/[PROJECT]/locations/[LOCATION]/queues/default

Specifying a queue.yaml

If your project uses a queue.yaml file, you can create default queues by passing its path to the --queue-yaml argument.

Additionally, you'll likely want to pass --queue-yaml-project and --queue-yaml-location to generate the correct fully qualified queue names. These settings will otherwise default to "[PROJECT]" and "[LOCATION]" respectively.

Specifying a target

Task queue needs to point at a service for outgoing requests. You can specify this with --target-host and --target-port

Testing

Run:

python gcloud_tasks_emulator/tests.py

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gcloud-tasks-emulator-0.6.1.tar.gz (16.6 kB view details)

Uploaded Source

Built Distribution

gcloud_tasks_emulator-0.6.1-py3-none-any.whl (17.7 kB view details)

Uploaded Python 3

File details

Details for the file gcloud-tasks-emulator-0.6.1.tar.gz.

File metadata

  • Download URL: gcloud-tasks-emulator-0.6.1.tar.gz
  • Upload date:
  • Size: 16.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.17

File hashes

Hashes for gcloud-tasks-emulator-0.6.1.tar.gz
Algorithm Hash digest
SHA256 eadcd7be2c14145dfe41ea86ced55bf444f787adf25be5aa8491fb2f0ac37264
MD5 55a9fec262362388e3924e8b8331ce18
BLAKE2b-256 d6d38c251543ef6bcb16a222d6166da7b341b5b4327ec80f7ecf59d9a70089be

See more details on using hashes here.

File details

Details for the file gcloud_tasks_emulator-0.6.1-py3-none-any.whl.

File metadata

File hashes

Hashes for gcloud_tasks_emulator-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d0c015cb4fb58d18c0b7445f58f7f52250c76ba45fcccddd1bc94a024e114734
MD5 0db27c693d46528964abc289216856af
BLAKE2b-256 50cc382b6a9d20f04d3cd1269d362aeb168dda69e5ec10ed32d1db90d0d44390

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page