feat(storage): migrate notifications samples and tests

storage/createNotification.js

@@ -0,0 +1,63 @@
+// Copyright 2020 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+'use strict';
+
+/**
+ * This application demonstrates how to perform basic operations on files with
+ * the Google Cloud Storage API.
+ *
+ * For more information, see the README.md under /storage and the documentation
+ * at https://cloud.google.com/storage/docs.
+ */
+const uuid = require('uuid');
+
+function main(
+  bucketName = 'my-bucket',
+  topic = `nodejs-storage-samples-${uuid.v4()}`
+) {
+  // [START storage_create_bucket_notifications]
+  /**
+   * TODO(developer): Uncomment the following lines before running the sample.
+   */
+  // The ID of your GCS bucket
+  // const bucketName = 'your-unique-bucket-name';
+
+  // The name of a topic
+  // const topic = 'my-topic';
+
+  // Imports the Google Cloud client library
+  const {Storage} = require('@google-cloud/storage');
+
+  // Creates a client
+  const storage = new Storage();
+
+  async function createNotification() {
+    try {
+      // Creates a notification
+      await storage.bucket(bucketName).createNotification(topic);
+
+      console.log('Notification subscription created.');
+    } catch (error) {
+      console.error(
+        'Error executing create notification:',
+        error.message || error
+      );
+    }
+  }
+
+  createNotification();
+  // [END storage_create_bucket_notifications]
+}
+main(...process.argv.slice(2));

storage/deleteNotification.js

@@ -0,0 +1,59 @@
+// Copyright 2020 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+'use strict';
+
+/**
+ * This application demonstrates how to perform basic operations on files with
+ * the Google Cloud Storage API.
+ *
+ * For more information, see the README.md under /storage and the documentation
+ * at https://cloud.google.com/storage/docs.
+ */
+
+function main(bucketName = 'my-bucket', notificationId = '1') {
+  // [START storage_delete_bucket_notification]
+  /**
+   * TODO(developer): Uncomment the following lines before running the sample.
+   */
+  // The ID of your GCS bucket
+  // const bucketName = 'your-unique-bucket-name';
+
+  // The ID of the notification
+  // const notificationId = '1';
+
+  // Imports the Google Cloud client library
+  const {Storage} = require('@google-cloud/storage');
+
+  // Creates a client
+  const storage = new Storage();
+
+  async function deleteNotification() {
+    try {
+      // Deletes the notification from the bucket
+      await storage.bucket(bucketName).notification(notificationId).delete();
+
+      console.log(`Notification ${notificationId} deleted.`);
+    } catch (error) {
+      console.error(
+        'Error executing delete notification:',
+        error.message || error
+      );
+    }
+  }
+
+  deleteNotification();
+  // [END storage_delete_bucket_notification]
+}
+main(...process.argv.slice(2));

storage/getMetadataNotifications.js

@@ -0,0 +1,67 @@
+// Copyright 2020 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+'use strict';
+
+/**
+ * This application demonstrates how to perform basic operations on files with
+ * the Google Cloud Storage API.
+ *
+ * For more information, see the README.md under /storage and the documentation
+ * at https://cloud.google.com/storage/docs.
+ */
+
+function main(bucketName = 'my-bucket', notificationId = '1') {
+  // [START storage_print_pubsub_bucket_notification]
+  /**
+   * TODO(developer): Uncomment the following lines before running the sample.
+   */
+  // The ID of your GCS bucket
+  // const bucketName = 'your-unique-bucket-name';
+
+  // The ID of the notification
+  // const notificationId = '1';
+
+  // Imports the Google Cloud client library
+  const {Storage} = require('@google-cloud/storage');
+
+  // Creates a client
+  const storage = new Storage();
+
+  async function getMetadata() {
+    try {
+      // Get the notification metadata
+      const [metadata] = await storage
+        .bucket(bucketName)
+        .notification(notificationId)
+        .getMetadata();
+
+      console.log(`ID: ${metadata.id}`);
+      console.log(`Topic: ${metadata.topic}`);
+      console.log(`Event Types: ${metadata.event_types}`);
+      console.log(`Custom Attributes: ${metadata.custom_attributes}`);
+      console.log(`Payload Format: ${metadata.payload_format}`);
+      console.log(`Object Name Prefix: ${metadata.object_name_prefix}`);
+      console.log(`Etag: ${metadata.etag}`);
+      console.log(`Self Link: ${metadata.selfLink}`);
+      console.log(`Kind: ${metadata.kind}`);
+    } catch (error) {
+      console.error('Error executing get metadata:', error.message || error);
+    }
+  }
+
+  getMetadata();
+  // [END storage_print_pubsub_bucket_notification]
+}
+main(...process.argv.slice(2));

storage/listNotifications.js

@@ -0,0 +1,61 @@
+// Copyright 2020 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+'use strict';
+
+/**
+ * This application demonstrates how to perform basic operations on files with
+ * the Google Cloud Storage API.
+ *
+ * For more information, see the README.md under /storage and the documentation
+ * at https://cloud.google.com/storage/docs.
+ */
+
+function main(bucketName = 'my-bucket') {
+  // [START storage_list_bucket_notifications]
+  /**
+   * TODO(developer): Uncomment the following lines before running the sample.
+   */
+  // The ID of your GCS bucket
+  // const bucketName = 'your-unique-bucket-name';
+
+  // Imports the Google Cloud client library
+  const {Storage} = require('@google-cloud/storage');
+
+  // Creates a client
+  const storage = new Storage();
+
+  async function listNotifications() {
+    try {
+      // Lists notifications in the bucket
+      const [notifications] = await storage
+        .bucket(bucketName)
+        .getNotifications();
+
+      console.log('Notifications:');
+      notifications.forEach(notification => {
+        console.log(notification.id);
+      });
+    } catch (error) {
+      console.error(
+        'Error executing list notifications:',
+        error.message || error
+      );
+    }
+  }
+
+  listNotifications();
+  // [END storage_list_bucket_notifications]
+}
+main(...process.argv.slice(2));

storage/system-test/notifications.test.js

@@ -0,0 +1,100 @@
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+'use strict';
+
+const {PubSub} = require('@google-cloud/pubsub');
+const {Storage} = require('@google-cloud/storage');
+const {assert} = require('chai');
+const {before, after, it} = require('mocha');
+const cp = require('child_process');
+const uuid = require('uuid');
+
+const execSync = cmd => cp.execSync(cmd, {encoding: 'utf-8'});
+
+const storage = new Storage();
+const bucketName = `nodejs-storage-samples-${uuid.v4()}`;
+const bucket = storage.bucket(bucketName);
+const notificationId = '1';
+const notification = bucket.notification(notificationId);
+const topicName = `nodejs-storage-samples-${uuid.v4()}`;
+const pubsub = new PubSub();
+const topic = pubsub.topic(topicName);
+
+before(async () => {
+  await bucket.create();
+  await topic.create();
+  const [gcsServiceAccount] = await storage.getServiceAccount();
+  await topic.iam.setPolicy({
+    bindings: [
+      {
+        role: 'roles/pubsub.editor',
+        members: [`serviceAccount:${gcsServiceAccount.emailAddress}`],
+      },
+    ],
+  });
+});
+
+after(async () => {
+  await bucket.delete().catch(console.error);
+  await topic.delete().catch(console.error);
+});
+
+it('should create a notification', async () => {
+  const output = execSync(
+    `node createNotification.js ${bucketName} ${topicName}`
+  );
+  assert.match(output, /Notification subscription created./);
+  const [exists] = await notification.exists();
+  assert.strictEqual(exists, true);
+});
+
+it('should list notifications', async () => {
+  const output = execSync(`node listNotifications.js ${bucketName}`);
+  assert.match(output, /Notifications:/);
+  assert.match(output, new RegExp(notificationId));
+});
+
+it('should get metadata', async () => {
+  const metadata = await notification.getMetadata();
+  const output = execSync(
+    `node getMetadataNotifications.js ${bucketName} ${notificationId}`
+  );
+  assert.match(output, /ID:/);
+  assert.match(output, new RegExp(metadata.id));
+  assert.match(output, /Topic:/);
+  assert.match(output, new RegExp(metadata.topic));
+  assert.match(output, /Event Types:/);
+  assert.match(output, new RegExp(metadata.event_types));
+  assert.match(output, /Custom Attributes:/);
+  assert.match(output, new RegExp(metadata.custom_attributes));
+  assert.match(output, /Payload Format:/);
+  assert.match(output, new RegExp(metadata.payload_format));
+  assert.match(output, /Object Name Prefix:/);
+  assert.match(output, new RegExp(metadata.object_name_prefix));
+  assert.match(output, /Etag:/);
+  assert.match(output, /Self Link:/);
+  assert.match(output, new RegExp(metadata.selfLink));
+  assert.match(output, /Kind:/);
+  assert.match(output, new RegExp(metadata.kind));
+});
+
+it('should delete a notification', async () => {
+  const output = execSync(
+    `node deleteNotification.js ${bucketName} ${notificationId}`
+  );
+  assert.match(output, new RegExp(`Notification ${notificationId} deleted.`));
+  const [exists] = await notification.exists();
+  assert.strictEqual(exists, false);
+});