Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add 'Bucket.notification' factory #3958

Merged
merged 1 commit into from
Sep 15, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions storage/google/cloud/storage/bucket.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
from google.cloud.storage.acl import DefaultObjectACL
from google.cloud.storage.blob import Blob
from google.cloud.storage.blob import _get_encryption_headers
from google.cloud.storage.notification import BucketNotification


def _blobs_page_start(iterator, page, response):
Expand Down Expand Up @@ -159,6 +160,28 @@ def blob(self, blob_name, chunk_size=None, encryption_key=None):
return Blob(name=blob_name, bucket=self, chunk_size=chunk_size,
encryption_key=encryption_key)

def notification(self, topic_name,
topic_project=None,
custom_attributes=None,
event_types=None,
blob_name_prefix=None,
payload_format=None):
"""Factory: create a notification resource for the bucket.

See: :class:`google.cloud.storage.notification.BucketNotification`
for parameters.

:rtype: :class:`google.cloud.storage.notification.BucketNotification`
"""
return BucketNotification(
self, topic_name,
topic_project=topic_project,
custom_attributes=custom_attributes,
event_types=event_types,
blob_name_prefix=blob_name_prefix,
payload_format=payload_format,
)

def exists(self, client=None):
"""Determines whether or not this bucket exists.

Expand Down
57 changes: 57 additions & 0 deletions storage/tests/unit/test_bucket.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,63 @@ def test_blob(self):
self.assertEqual(blob.chunk_size, CHUNK_SIZE)
self.assertEqual(blob._encryption_key, KEY)

def test_notification_defaults(self):
from google.cloud.storage.notification import BucketNotification

PROJECT = 'PROJECT'
BUCKET_NAME = 'BUCKET_NAME'
TOPIC_NAME = 'TOPIC_NAME'
client = _Client(_Connection(), project=PROJECT)
bucket = self._make_one(client, name=BUCKET_NAME)

notification = bucket.notification(TOPIC_NAME)

self.assertIsInstance(notification, BucketNotification)
self.assertIs(notification.bucket, bucket)
self.assertEqual(notification.topic_project, PROJECT)
self.assertIsNone(notification.custom_attributes)
self.assertIsNone(notification.event_types)
self.assertIsNone(notification.blob_name_prefix)
self.assertIsNone(notification.payload_format)

def test_notification_explicit(self):
from google.cloud.storage.notification import (
BucketNotification,
OBJECT_FINALIZE_EVENT_TYPE,
OBJECT_DELETE_EVENT_TYPE,
JSON_API_V1_PAYLOAD_FORMAT)

PROJECT = 'PROJECT'
BUCKET_NAME = 'BUCKET_NAME'
TOPIC_NAME = 'TOPIC_NAME'
TOPIC_ALT_PROJECT = 'topic-project-456'
CUSTOM_ATTRIBUTES = {
'attr1': 'value1',
'attr2': 'value2',
}
EVENT_TYPES = [OBJECT_FINALIZE_EVENT_TYPE, OBJECT_DELETE_EVENT_TYPE]
BLOB_NAME_PREFIX = 'blob-name-prefix/'
client = _Client(_Connection(), project=PROJECT)
bucket = self._make_one(client, name=BUCKET_NAME)

notification = bucket.notification(
TOPIC_NAME,
topic_project=TOPIC_ALT_PROJECT,
custom_attributes=CUSTOM_ATTRIBUTES,
event_types=EVENT_TYPES,
blob_name_prefix=BLOB_NAME_PREFIX,
payload_format=JSON_API_V1_PAYLOAD_FORMAT,
)

self.assertIsInstance(notification, BucketNotification)
self.assertIs(notification.bucket, bucket)
self.assertEqual(notification.topic_project, TOPIC_ALT_PROJECT)
self.assertEqual(notification.custom_attributes, CUSTOM_ATTRIBUTES)
self.assertEqual(notification.event_types, EVENT_TYPES)
self.assertEqual(notification.blob_name_prefix, BLOB_NAME_PREFIX)
self.assertEqual(
notification.payload_format, JSON_API_V1_PAYLOAD_FORMAT)

def test_bucket_name_value(self):
bucket_name = 'testing123'
mixin = self._make_one(name=bucket_name)
Expand Down