refactor code and add system tests

Author: nidhiii-27

packages/google-cloud-storage/google/cloud/storage/_grpc_conversions.py

@@ -12,7 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from google.protobuf import field_mask_pb2
 from google.protobuf import timestamp_pb2
 
 from google.cloud import _storage_v2
@@ -109,36 +108,3 @@ def blob_to_proto(blob):
         resource_params["contexts"] = _storage_v2.ObjectContexts(custom=custom_contexts)
 
     return _storage_v2.Object(**resource_params)
-
-
-def get_update_mask(blob, changes):
-    """Generates a FieldMask for gRPC update operations."""
-    # Map REST property names to GCS V2 Object proto field names.
-    property_to_proto_field = {
-        "cacheControl": "cache_control",
-        "contentDisposition": "content_disposition",
-        "contentEncoding": "content_encoding",
-        "contentLanguage": "content_language",
-        "contentType": "content_type",
-        "metadata": "metadata",
-        "eventBasedHold": "event_based_hold",
-        "temporaryHold": "temporary_hold",
-        "kmsKeyName": "kms_key",
-        "customTime": "custom_time",
-        "retention": "retention",
-    }
-    paths = []
-    for change in changes:
-        if change == "contexts":
-            contexts = getattr(blob, "contexts", None)
-            if not (contexts and contexts.custom):
-                paths.append("contexts.custom")
-            else:
-                for key in contexts.custom:
-                    paths.append(f"contexts.custom.{key}")
-        else:
-            proto_field = property_to_proto_field.get(change)
-            if proto_field:
-                paths.append(proto_field)
-
-    return field_mask_pb2.FieldMask(paths=paths)

packages/google-cloud-storage/tests/system/test_blob.py

@@ -554,6 +554,38 @@ def test_blob_patch_metadata(
     assert blob.metadata == {"foo": "Foo"}
 
 
+def test_blob_contexts_crud(
+    shared_bucket,
+    blobs_to_delete,
+    file_data,
+    service_account,
+):
+    from google.cloud.storage.blob import ObjectContexts, ObjectCustomContextPayload
+
+    filename = file_data["logo"]["path"]
+    blob_name = os.path.basename(filename)
+
+    blob = shared_bucket.blob(blob_name)
+    blob.upload_from_filename(filename)
+    blobs_to_delete.append(blob)
+
+    custom = {"foo": ObjectCustomContextPayload(value="bar")}
+    blob.contexts = ObjectContexts(blob, custom=custom)
+    blob.patch()
+    blob.reload()
+    assert "foo" in blob.contexts.custom
+    assert blob.contexts.custom["foo"].value == "bar"
+    assert blob.contexts.custom["foo"].create_time is not None
+    assert blob.contexts.custom["foo"].update_time is not None
+
+    # Ensure that context keys can be deleted by setting equal to None.
+    new_custom = {"foo": None}
+    blob.contexts = ObjectContexts(blob, custom=new_custom)
+    blob.patch()
+    blob.reload()
+    assert "foo" not in blob.contexts.custom
+
+
 def test_blob_direct_write_and_read_into_file(
     shared_bucket,
     blobs_to_delete,

packages/google-cloud-storage/tests/system/test_bucket.py

@@ -731,6 +731,35 @@ def test_bucket_list_blobs_w_match_glob(
         assert [blob.name for blob in blobs] == expected_names
 
 
+@_helpers.retry_failures
+def test_bucket_list_blobs_w_filter(
+    storage_client,
+    buckets_to_delete,
+    blobs_to_delete,
+):
+    from google.cloud.storage.blob import ObjectContexts, ObjectCustomContextPayload
+
+    bucket_name = _helpers.unique_name("w-filter")
+    bucket = _helpers.retry_429_503(storage_client.create_bucket)(bucket_name)
+    buckets_to_delete.append(bucket)
+
+    payload = b"helloworld"
+    blob_names = ["foo", "bar", "baz"]
+    for name in blob_names:
+        blob = bucket.blob(name)
+        blob.upload_from_string(payload)
+        if name == "bar":
+            custom = {"target": ObjectCustomContextPayload(value="match")}
+            blob.contexts = ObjectContexts(blob, custom=custom)
+            blob.patch()
+        blobs_to_delete.append(blob)
+
+    # List with filter matching only 'bar'
+    blob_iter = bucket.list_blobs(filter_='contexts."target"="match"')
+    blobs = list(blob_iter)
+    assert [blob.name for blob in blobs] == ["bar"]
+
+
 def test_bucket_list_blobs_include_managed_folders(
     storage_client,
     buckets_to_delete,

packages/google-cloud-storage/tests/unit/asyncio/test_async_write_object_stream.py

@@ -21,6 +21,7 @@
 
 from google.cloud import _storage_v2
 from google.cloud.storage import Blob, Bucket
+from google.cloud.storage.blob import ObjectContexts, ObjectCustomContextPayload
 from google.cloud.storage.asyncio.async_write_object_stream import (
     _AsyncWriteObjectStream,
 )
@@ -198,6 +199,9 @@ async def test_open_new_object_with_blob_sync_attrs(
             "retain_until_time": retain_until_time,
         }
 
+        payload = ObjectCustomContextPayload(value="context-value")
+        mock_blob.contexts = ObjectContexts(mock_blob, custom={"context-key": payload})
+
         stream = _AsyncWriteObjectStream(mock_client, BUCKET, OBJECT, blob=mock_blob)
         await stream.open()
 
@@ -226,6 +230,9 @@ async def test_open_new_object_with_blob_sync_attrs(
             retain_until_time.timestamp()
         )
 
+        assert "context-key" in resource.contexts.custom
+        assert resource.contexts.custom["context-key"].value == "context-value"
+
     @pytest.mark.asyncio
     async def test_open_already_open_raises(self, mock_client):
         stream = _AsyncWriteObjectStream(mock_client, BUCKET, OBJECT)

packages/google-cloud-storage/tests/unit/test__grpc_conversions.py

@@ -162,35 +162,3 @@ def test_blob_to_proto_contexts():
     assert int(proto.contexts.custom["key"].create_time.timestamp()) == int(
         create_time.timestamp()
     )
-
-
-def test_get_update_mask_contexts():
-    blob = mock.Mock(spec=["contexts"])
-    from google.cloud.storage.blob import ObjectContexts, ObjectCustomContextPayload
-
-    # Partial updates
-    blob.contexts = ObjectContexts(
-        blob,
-        custom={
-            "k1": ObjectCustomContextPayload(value="v1"),
-            "k2": ObjectCustomContextPayload(value="v2"),
-        },
-    )
-    mask = _grpc_conversions.get_update_mask(blob, ["contexts"])
-    assert "contexts.custom.k1" in mask.paths
-    assert "contexts.custom.k2" in mask.paths
-    assert len(mask.paths) == 2
-
-    # Clear all
-    blob.contexts = None
-    mask = _grpc_conversions.get_update_mask(blob, ["contexts"])
-    assert "contexts.custom" in mask.paths
-    assert len(mask.paths) == 1
-
-    # Mixed
-    mask = _grpc_conversions.get_update_mask(
-        blob, ["contexts", "metadata", "customTime"]
-    )
-    assert "contexts.custom" in mask.paths
-    assert "metadata" in mask.paths
-    assert "custom_time" in mask.paths