storage: add list buckets (GoogleCloudPlatform#2149)

* Add list_buckets sample

* Allow for more if conditions

Author: frankyn

storage/cloud-client/README.rst

@@ -93,8 +93,7 @@ To run this sample:
     $ python snippets.py
 
     usage: snippets.py [-h]
-                       bucket_name
-                       {create-bucket,delete-bucket,get-bucket-labels,add-bucket-label,remove-bucket-label,list,list-with-prefix,upload,enable-default-kms-key,upload-with-kms-key,download,delete,metadata,make-public,signed-url,rename,copy}
+                       {list-buckets,create-bucket,delete-bucket,get-bucket-labels,add-bucket-label,remove-bucket-label,list,list-with-prefix,upload,enable-default-kms-key,upload-with-kms-key,download,delete,metadata,make-public,signed-url,signed-url-download-v4,signed-url-upload-v4,rename,copy}
                        ...
 
     This application demonstrates how to perform basic operations on blobs
@@ -104,8 +103,8 @@ To run this sample:
     at https://cloud.google.com/storage/docs.
 
     positional arguments:
-      bucket_name           Your cloud storage bucket.
-      {create-bucket,delete-bucket,get-bucket-labels,add-bucket-label,remove-bucket-label,list,list-with-prefix,upload,enable-default-kms-key,upload-with-kms-key,download,delete,metadata,make-public,signed-url,rename,copy}
+      {list-buckets,create-bucket,delete-bucket,get-bucket-labels,add-bucket-label,remove-bucket-label,list,list-with-prefix,upload,enable-default-kms-key,upload-with-kms-key,download,delete,metadata,make-public,signed-url,signed-url-download-v4,signed-url-upload-v4,rename,copy}
+        list-buckets        Lists all buckets.
         create-bucket       Creates a new bucket.
         delete-bucket       Deletes a bucket. The bucket must be empty.
         get-bucket-labels   Prints out a bucket's labels.
@@ -133,11 +132,23 @@ To run this sample:
         delete              Deletes a blob from the bucket.
         metadata            Prints out a blob's metadata.
         make-public         Makes a blob publicly accessible.
-        signed-url          Generates a signed URL for a blob. Note that this
-                            method requires a service account key file. You can
-                            not use this if you are using Application Default
-                            Credentials from Google Compute Engine or from the
-                            Google Cloud SDK.
+        signed-url          Generates a v2 signed URL for downloading a blob. Note
+                            that this method requires a service account key file.
+                            You can not use this if you are using Application
+                            Default Credentials from Google Compute Engine or from
+                            the Google Cloud SDK.
+        signed-url-download-v4
+                            Generates a v4 signed URL for downloading a blob. Note
+                            that this method requires a service account key file.
+                            You can not use this if you are using Application
+                            Default Credentials from Google Compute Engine or from
+                            the Google Cloud SDK.
+        signed-url-upload-v4
+                            Generates a v4 signed URL for uploading a blob using
+                            HTTP PUT. Note that this method requires a service
+                            account key file. You can not use this if you are
+                            using Application Default Credentials from Google
+                            Compute Engine or from the Google Cloud SDK.
         rename              Renames a blob.
         copy                Renames a blob.
 

storage/cloud-client/snippets.py

@@ -99,6 +99,17 @@ def remove_bucket_label(bucket_name):
     pprint.pprint(bucket.labels)
 
 
+# [START storage_list_buckets]
+def list_buckets():
+    """Lists all buckets."""
+    storage_client = storage.Client()
+    buckets = storage_client.list_buckets()
+
+    for bucket in buckets:
+        print(bucket.name)
+# [END storage_list_buckets]
+
+
 def list_blobs(bucket_name):
     """Lists all the blobs in the bucket."""
     storage_client = storage.Client()
@@ -352,58 +363,164 @@ def copy_blob(bucket_name, blob_name, new_bucket_name, new_blob_name):
         destination_bucket.name))
 
 
+def bucket_commands(args):
+    if args.command == 'list-buckets':
+        list_buckets()
+    elif args.command == 'create-bucket':
+        create_bucket(args.bucket_name)
+    elif args.command == 'enable-default-kms-key':
+        enable_default_kms_key(args.bucket_name, args.kms_key_name)
+    elif args.command == 'delete-bucket':
+        delete_bucket(args.bucket_name)
+    elif args.command == 'get-bucket-labels':
+        get_bucket_labels(args.bucket_name)
+    elif args.command == 'add-bucket-label':
+        add_bucket_label(args.bucket_name)
+    elif args.command == 'remove-bucket-label':
+        remove_bucket_label(args.bucket_name)
+
+
+def blob_commands(args):
+    if args.command == 'list':
+        list_blobs(args.bucket_name)
+    elif args.command == 'list-with-prefix':
+        list_blobs_with_prefix(args.bucket_name, args.prefix, args.delimiter)
+    elif args.command == 'upload':
+        upload_blob(
+            args.bucket_name,
+            args.source_file_name,
+            args.destination_blob_name)
+    elif args.command == 'upload-with-kms-key':
+        upload_blob_with_kms(
+            args.bucket_name,
+            args.source_file_name,
+            args.destination_blob_name,
+            args.kms_key_name)
+    elif args.command == 'download':
+        download_blob(
+            args.bucket_name,
+            args.source_blob_name,
+            args.destination_file_name)
+    elif args.command == 'delete':
+        delete_blob(args.bucket_name, args.blob_name)
+    elif args.command == 'metadata':
+        blob_metadata(args.bucket_name, args.blob_name)
+    elif args.command == 'make-public':
+        make_blob_public(args.bucket_name, args.blob_name)
+    elif args.command == 'signed-url':
+        generate_signed_url(args.bucket_name, args.blob_name)
+    elif args.command == 'signed-url-download-v4':
+        generate_download_signed_url_v4(args.bucket_name, args.blob_name)
+    elif args.command == 'signed-url-upload-v4':
+        generate_upload_signed_url_v4(args.bucket_name, args.blob_name)
+    elif args.command == 'rename':
+        rename_blob(args.bucket_name, args.blob_name, args.new_name)
+    elif args.command == 'copy':
+        copy_blob(
+            args.bucket_name,
+            args.blob_name,
+            args.new_bucket_name,
+            args.new_blob_name)
+
+
 def main():
     parser = argparse.ArgumentParser(
         description=__doc__,
         formatter_class=argparse.RawDescriptionHelpFormatter)
-    parser.add_argument('bucket_name', help='Your cloud storage bucket.')
 
     subparsers = parser.add_subparsers(dest='command')
-    subparsers.add_parser('create-bucket', help=create_bucket.__doc__)
-    subparsers.add_parser('delete-bucket', help=delete_bucket.__doc__)
-    subparsers.add_parser('get-bucket-labels', help=get_bucket_labels.__doc__)
-    subparsers.add_parser('add-bucket-label', help=add_bucket_label.__doc__)
-    subparsers.add_parser(
+    list_buckets_parser = subparsers.add_parser(
+        'list-buckets', help=list_buckets.__doc__)
+    list_buckets_parser.add_argument(
+        'bucket_name', help='Your cloud storage bucket.')
+
+    create_bucket_parser = subparsers.add_parser(
+        'create-bucket', help=create_bucket.__doc__)
+    create_bucket_parser.add_argument(
+        'bucket_name', help='Your cloud storage bucket.')
+
+    delete_create_parser = subparsers.add_parser(
+        'delete-bucket', help=delete_bucket.__doc__)
+    delete_create_parser.add_argument(
+        'bucket_name', help='Your cloud storage bucket.')
+
+    get_bucket_labels_parser = subparsers.add_parser(
+        'get-bucket-labels', help=get_bucket_labels.__doc__)
+    get_bucket_labels_parser.add_argument(
+        'bucket_name', help='Your cloud storage bucket.')
+
+    add_bucket_label_parser = subparsers.add_parser(
+        'add-bucket-label', help=add_bucket_label.__doc__)
+    add_bucket_label_parser.add_argument(
+        'bucket_name', help='Your cloud storage bucket.')
+
+    remove_bucket_label_parser = subparsers.add_parser(
         'remove-bucket-label', help=remove_bucket_label.__doc__)
-    subparsers.add_parser('list', help=list_blobs.__doc__)
+    remove_bucket_label_parser.add_argument(
+        'bucket_name', help='Your cloud storage bucket.')
+
+    list_blobs_parser = subparsers.add_parser(
+        'list', help=list_blobs.__doc__)
+    list_blobs_parser.add_argument(
+        'bucket_name', help='Your cloud storage bucket.')
 
     list_with_prefix_parser = subparsers.add_parser(
         'list-with-prefix', help=list_blobs_with_prefix.__doc__)
+    list_with_prefix_parser.add_argument(
+        'bucket_name', help='Your cloud storage bucket.')
     list_with_prefix_parser.add_argument('prefix')
     list_with_prefix_parser.add_argument('--delimiter', default=None)
 
-    upload_parser = subparsers.add_parser('upload', help=upload_blob.__doc__)
+    upload_parser = subparsers.add_parser(
+        'upload', help=upload_blob.__doc__)
+    upload_parser.add_argument(
+        'bucket_name', help='Your cloud storage bucket.')
     upload_parser.add_argument('source_file_name')
     upload_parser.add_argument('destination_blob_name')
 
     enable_default_kms_parser = subparsers.add_parser(
         'enable-default-kms-key', help=enable_default_kms_key.__doc__)
+    enable_default_kms_parser.add_argument(
+        'bucket_name', help='Your cloud storage bucket.')
     enable_default_kms_parser.add_argument('kms_key_name')
 
     upload_kms_parser = subparsers.add_parser(
         'upload-with-kms-key', help=upload_blob_with_kms.__doc__)
+    upload_kms_parser.add_argument(
+        'bucket_name', help='Your cloud storage bucket.')
     upload_kms_parser.add_argument('source_file_name')
     upload_kms_parser.add_argument('destination_blob_name')
     upload_kms_parser.add_argument('kms_key_name')
 
     download_parser = subparsers.add_parser(
         'download', help=download_blob.__doc__)
+    download_parser.add_argument(
+        'bucket_name', help='Your cloud storage bucket.')
     download_parser.add_argument('source_blob_name')
     download_parser.add_argument('destination_file_name')
 
-    delete_parser = subparsers.add_parser('delete', help=delete_blob.__doc__)
+    delete_parser = subparsers.add_parser(
+        'delete', help=delete_blob.__doc__)
+    delete_parser.add_argument(
+        'bucket_name', help='Your cloud storage bucket.')
     delete_parser.add_argument('blob_name')
 
     metadata_parser = subparsers.add_parser(
         'metadata', help=blob_metadata.__doc__)
+    metadata_parser.add_argument(
+        'bucket_name', help='Your cloud storage bucket.')
     metadata_parser.add_argument('blob_name')
 
     make_public_parser = subparsers.add_parser(
         'make-public', help=make_blob_public.__doc__)
+    make_public_parser.add_argument(
+        'bucket_name', help='Your cloud storage bucket.')
     make_public_parser.add_argument('blob_name')
 
     signed_url_parser = subparsers.add_parser(
         'signed-url', help=generate_signed_url.__doc__)
+    signed_url_parser.add_argument(
+        'bucket_name', help='Your cloud storage bucket.')
     signed_url_parser.add_argument('blob_name')
 
     signed_url_download_v4_parser = subparsers.add_parser(
@@ -414,69 +531,22 @@ def main():
         'signed-url-upload-v4', help=generate_upload_signed_url_v4.__doc__)
     signed_url_upload_v4_parser.add_argument('blob_name')
 
-    rename_parser = subparsers.add_parser('rename', help=rename_blob.__doc__)
+    rename_parser = subparsers.add_parser(
+        'rename', help=rename_blob.__doc__)
+    rename_parser.add_argument(
+        'bucket_name', help='Your cloud storage bucket.')
     rename_parser.add_argument('blob_name')
     rename_parser.add_argument('new_name')
 
     copy_parser = subparsers.add_parser('copy', help=rename_blob.__doc__)
+    copy_parser.add_argument('bucket_name', help='Your cloud storage bucket.')
     copy_parser.add_argument('blob_name')
     copy_parser.add_argument('new_bucket_name')
     copy_parser.add_argument('new_blob_name')
 
     args = parser.parse_args()
-
-    if args.command == 'create-bucket':
-        create_bucket(args.bucket_name)
-    elif args.command == 'enable-default-kms-key':
-        enable_default_kms_key(args.bucket_name, args.kms_key_name)
-    elif args.command == 'delete-bucket':
-        delete_bucket(args.bucket_name)
-    elif args.command == 'get-bucket-labels':
-        get_bucket_labels(args.bucket_name)
-    elif args.command == 'add-bucket-label':
-        add_bucket_label(args.bucket_name)
-    elif args.command == 'remove-bucket-label':
-        remove_bucket_label(args.bucket_name)
-    elif args.command == 'list':
-        list_blobs(args.bucket_name)
-    elif args.command == 'list-with-prefix':
-        list_blobs_with_prefix(args.bucket_name, args.prefix, args.delimiter)
-    elif args.command == 'upload':
-        upload_blob(
-            args.bucket_name,
-            args.source_file_name,
-            args.destination_blob_name)
-    elif args.command == 'upload-with-kms-key':
-        upload_blob_with_kms(
-            args.bucket_name,
-            args.source_file_name,
-            args.destination_blob_name,
-            args.kms_key_name)
-    elif args.command == 'download':
-        download_blob(
-            args.bucket_name,
-            args.source_blob_name,
-            args.destination_file_name)
-    elif args.command == 'delete':
-        delete_blob(args.bucket_name, args.blob_name)
-    elif args.command == 'metadata':
-        blob_metadata(args.bucket_name, args.blob_name)
-    elif args.command == 'make-public':
-        make_blob_public(args.bucket_name, args.blob_name)
-    elif args.command == 'signed-url':
-        generate_signed_url(args.bucket_name, args.blob_name)
-    elif args.command == 'signed-url-download-v4':
-        generate_download_signed_url_v4(args.bucket_name, args.blob_name)
-    elif args.command == 'signed-url-upload-v4':
-        generate_upload_signed_url_v4(args.bucket_name, args.blob_name)
-    elif args.command == 'rename':
-        rename_blob(args.bucket_name, args.blob_name, args.new_name)
-    elif args.command == 'copy':
-        copy_blob(
-            args.bucket_name,
-            args.blob_name,
-            args.new_bucket_name,
-            args.new_blob_name)
+    bucket_commands(args)
+    blob_commands(args)
 
 
 if __name__ == '__main__':

storage/cloud-client/snippets_test.py

@@ -68,6 +68,12 @@ def test_blob():
     return blob
 
 
+def test_list_buckets(capsys):
+    snippets.list_buckets()
+    out, _ = capsys.readouterr()
+    assert BUCKET in out
+
+
 def test_list_blobs(test_blob, capsys):
     snippets.list_blobs(BUCKET)
     out, _ = capsys.readouterr()