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 directorypip install -e
python -m unittest gcloud_storage_emulator.tests
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for gcloud-storage-emulator-0.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e56e111a962c3dafea1d9a446eb9ef13732bf72009696e9ebebdcb029a16b6df |
|
MD5 | 257b55525dde1bd6a4be5252d8a5cf11 |
|
BLAKE2b-256 | aeb78a1eebed452938e7554b746a3633f59cb09dee1b2f3074d13f92b8920fb5 |
Hashes for gcloud_storage_emulator-0.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 69fe95ab57fc45acdeba7b8dfc44c12b9e7921e640776f7ec79d675d753b03cf |
|
MD5 | d7d0296e2f882d0bf929ca33186ba150 |
|
BLAKE2b-256 | f146b70e4ee5df71b4253c146c3792703c1e63c66c1e63d9bd64dbc07a1c456e |