Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

A stub emulator for the Google Cloud Storage API

Project description

Local Emulator for Google Cloud Storage

Google doesn't (yet) ship an emulator for the Cloud Storage 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 Storage APIs.

THIS IS A WORK IN PROGRESS AND ONLY SUPPORTS A LIMITED SUBSET OF THE API


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


Installation

pip install gcloud-storage-emulator

CLI Usage

Starting the emulator

Start the emulator with:

$ gcloud-storage-emulator start --port=9090

By default, data is stored under $PWD/.cloudstorage. You can configure the folder using the env variables STORAGE_BASE and STORAGE_DIR.

If you wish to run the emulator in a testing environment or if you don't want to persist any data, you can use the --no-store-on-disk parameter. For tests, you might want to consider starting up the server from your code (see the Python APIs)

If you're using the Google client library (e.g. google-cloud-storage for Python) then you can set the STORAGE_EMULATOR_HOST environment variable to tell the library to connect to your emulator endpoint rather than the standard https://storage.googleapis.com, e.g.:

$ export STORAGE_EMULATOR_HOST=http://localhost:9090

Wiping data

You can wipe the data by running

$ gcloud-storage-emulator wipe

You can pass --keep-buckets to wipe the data while keeping the buckets.

Python APIs

To start a server from your code you can do

from gcloud_storage_emulator.server import create_server

server = create_server("localhost", 9023, in_memory=False)

server.start()
# ........
server.stop()

You can wipe the data (e.g. for text execution) by calling server.wipe()

This can also be achieved (e.g. during tests) by hitting the /wipe endpoint

Running Tests

With Tox

If you have Tox installed then you can run tests with:

tox -e py37 -- {extra_pytest_args}

With Docker

If you don't have Tox installed on your system but you do have Docker, then you can run the tests using the themattrix/tox image:

docker run -v /ABSOLUTE/PATH/TO/THIS/REPO/ON/YOUR/MACHINE:/app themattrix/tox tox -e py37 [optional additional args for tox...]

With unittest

  • Create and activate a virtualenv (optional but recommended)
  • cd into the repository directory
  • pip install -e
  • python -m unittest gcloud_storage_emulator.tests

Project details


Download files

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

Files for gcloud-storage-emulator, version 0.4.0
Filename, size File type Python version Upload date Hashes
Filename, size gcloud_storage_emulator-0.4.0-py3-none-any.whl (19.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size gcloud-storage-emulator-0.4.0.tar.gz (16.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page