support for google cloud storage module

library/cloud/gcs

@@ -0,0 +1,484 @@
+#!/usr/bin/python
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
+DOCUMENTATION = '''
+---
+module: gcs
+short_description: This module help users manage objects/buckets in GCS (Google Cloud Storage). 
+description:
+    - This module allows users to manage their objects/buckets in GCS in an idempotent way. Users can do operations like PUT, GET and set some pre-canned permissions on those objects.Users can also retrieve the urls to their objects to be used in playbooks. They can also use the module to get the string contents of the objects. Please note that this module is compatible with API version 1 of GCS. so it expects the user to set the default project before using this module, Have a lookt at "https://developers.google.com/storage/docs/reference/v1/apiversion1" to set the default project.
+
+options:
+  bucket:
+    description:
+      - Bucket name. 
+    required: true
+    default: null 
+    aliases: []
+  object:
+    description:
+      - Keyname of the object inside the bucket. Can be also be used to create "virtual directories", see examples.
+    required: false
+    default: null
+    aliases: []
+  src:
+    description:
+      - The source file path when performing a PUT operation.
+    required: false
+    default: null
+    aliases: []
+  dest:
+    description:
+      - The destination file path when downloading an object/key with a GET operation.
+    required: false
+    aliases: []
+  overwrite:
+    description:
+      - Force overwrite either locally on the filesystem or remotely with the object/key. Used with PUT and GET operations.
+    required: false
+    default: false
+  permission:
+    description:
+      - This option let's the user set the canned permissions on the object/bucket that are created. The permissions that can be set are 'private', 'public-read', 'authenticated-read'.
+    required: false
+    default: private 
+  mode:
+    description:
+      - Switches the module behaviour between put (upload), get (download), geturl (return download url) , getstr (download object as string), create (bucket) and delete (bucket). 
+    required: true
+    default: null
+    aliases: []
+  gcs_secret_key:
+    description:
+      - GCS secret key. If not set then the value of the GCS_SECRET_KEY environment variable is used. 
+    required: false
+    default: null
+  gcs_access_key:
+    description:
+      - GCS access key. If not set then the value of the GCS_ACCESS_KEY environment variable is used.
+    required: false
+    default: null
+requirements: [ "boto" ]
+author: benno@ansibleworks.com Note. Most of the code has been taken from the S3 module.
+
+'''
+
+EXAMPLES = '''
+# Simple PUT operation
+- gcs: bucket=mybucket object=key.txt src=/usr/local/myfile.txt mode=put permission=public-read
+# Simple GET operation
+- gs: bucket=mybucket object=key.txt dest=/usr/local/myfile.txt mode=get
+# GET/download and overwrite local file (trust remote)
+- gs: bucket=mybucket object=key.txt dest=/usr/local/myfile.txt mode=get overwrite=true
+# PUT/upload and overwrite remote file (trust local)
+- gs: bucket=mybucket object=key.txt src=/usr/local/myfile.txt mode=put overwrite=true
+# Download an object as a string to use else where in your playbook
+- gs: bucket=mybucket object=key.txt mode=getstr
+# Create an empty bucket
+- gs: bucket=mybucket mode=create
+# Create a bucket with key as directory
+- gs: bucket=mybucket object=/my/directory/path mode=create
+# Delete a bucket and all contents
+- gs: bucket=mybucket mode=delete
+'''
+
+import sys
+import os
+import urlparse
+import hashlib
+
+try:
+    import boto
+except ImportError:
+    print "failed=True msg='boto required for this module'"
+    sys.exit(1)
+
+def grant_check(module, gs, obj):
+    try:
+        acp = obj.get_acl()
+        if module.params.get('permission') == 'public-read':
+            grant = [ x for x in acp.entries.entry_list if x.scope.type == 'AllUsers']
+            if not grant:
+                obj.set_acl('public-read')
+                module.exit_json(changed=True, result="The object's permission as been set to public-read") 
+        if module.params.get('permission') == 'authenticated-read':
+            grant = [ x for x in acp.entries.entry_list if x.scope.type == 'AllAuthenticatedUsers']
+            if not grant:
+                obj.set_acl('authenticated-read')
+                module.exit_json(changed=True, result="The object's permission as been set to authenticated-read") 
+    except gs.provider.storage_response_error, e:
+        module.fail_json(msg= str(e))
+    return True
+
+        
+
+def key_check(module, gs, bucket, obj):
+    try:
+        bucket = gs.lookup(bucket)
+        key_check = bucket.get_key(obj)
+    except gs.provider.storage_response_error, e:
+        module.fail_json(msg= str(e))
+    if key_check:
+        grant_check(module, gs, key_check)
+        return True
+    else:
+        return False
+
+def keysum(module, gs, bucket, obj):
+    bucket = gs.lookup(bucket)
+    key_check = bucket.get_key(obj)
+    if key_check:
+        md5_remote = key_check.etag[1:-1]
+        etag_multipart = md5_remote.find('-')!=-1 #Check for multipart, etag is not md5
+        if etag_multipart is True:
+            module.fail_json(msg="Files uploaded with multipart of gs are not supported with checksum, unable to compute checksum.")
+            sys.exit(0)
+    return md5_remote
+
+def bucket_check(module, gs, bucket):
+    try:
+        result = gs.lookup(bucket)
+    except gs.provider.storage_response_error, e:
+        module.fail_json(msg= str(e))
+    if result:
+        grant_check(module, gs, result)
+        return True
+    else:
+        return False
+
+def create_bucket(module, gs, bucket):
+    try:
+        bucket = gs.create_bucket(bucket)
+        bucket.set_acl(module.params.get('permission'))
+    except gs.provider.storage_response_error, e:
+        module.fail_json(msg= str(e))
+    if bucket:
+        return True
+
+def delete_bucket(module, gs, bucket):
+    try:
+        bucket = gs.lookup(bucket)
+        bucket_contents = bucket.list()
+        for key in bucket_contents:
+            bucket.delete_key(key.name)
+        bucket.delete()
+        return True
+    except gs.provider.storage_response_error, e:
+        module.fail_json(msg= str(e))
+
+def delete_key(module, gs, bucket, obj):
+    try:
+        bucket = gs.lookup(bucket)
+        bucket.delete_key(obj)
+        module.exit_json(msg="Object deleted from bucket ", changed=True)
+    except gs.provider.storage_response_error, e:
+        module.fail_json(msg= str(e))
+ 
+def create_dirkey(module, gs, bucket, obj):
+    try:
+        bucket = gs.lookup(bucket)
+        key = bucket.new_key(obj)
+        key.set_contents_from_string('')
+        module.exit_json(msg="Virtual directory %s created in bucket %s" % (obj, bucket.name), changed=True)
+    except gs.provider.storage_response_error, e:
+        module.fail_json(msg= str(e))
+
+def upload_file_check(src):
+    if os.path.exists(src):
+        file_exists is True
+    else:
+        file_exists is False
+    if os.path.isdir(src):
+        module.fail_json(msg="Specifying a directory is not a valid source for upload.", failed=True)
+        sys.exit(0)
+    return file_exists
+
+def path_check(path):
+    if os.path.exists(path):
+        return True 
+    else:
+        return False
+
+def upload_gsfile(module, gs, bucket, obj, src, expiry):
+    try:
+        bucket = gs.lookup(bucket)
+        key = bucket.new_key(obj)  
+        key.set_contents_from_filename(src)
+        key.set_acl(module.params.get('permission'))
+        url = key.generate_url(expiry)
+        module.exit_json(msg="PUT operation complete", url=url, changed=True)
+        sys.exit(0)
+    except gs.provider.storage_copy_error, e:
+        module.fail_json(msg= str(e))
+
+def download_gsfile(module, gs, bucket, obj, dest):
+    try:
+        bucket = gs.lookup(bucket)
+        key = bucket.lookup(obj)
+        key.get_contents_to_filename(dest)
+        module.exit_json(msg="GET operation complete", changed=True)
+        sys.exit(0)
+    except gs.provider.storage_copy_error, e:
+        module.fail_json(msg= str(e))
+
+def download_gsstr(module, gs, bucket, obj):
+    try:
+        bucket = gs.lookup(bucket)
+        key = bucket.lookup(obj)
+        contents = key.get_contents_as_string()
+        module.exit_json(msg="GET operation complete", contents=contents, changed=True)
+        sys.exit(0)
+    except gs.provider.storage_copy_error, e:
+        module.fail_json(msg= str(e))
+
+def get_download_url(module, gs, bucket, obj, expiry):
+    try:
+        bucket = gs.lookup(bucket)
+        key = bucket.lookup(obj)
+        url = key.generate_url(expiry)
+        module.exit_json(msg="Download url:", url=url, expiry=expiry, changed=True)
+        sys.exit(0)
+    except gs.provider.storage_response_error, e:
+        module.fail_json(msg= str(e))
+
+def main():
+    module = AnsibleModule(
+        argument_spec = dict(
+            bucket         = dict(required=True),
+            object         = dict(default=None),
+            src            = dict(default=None),
+            dest           = dict(default=None),
+            mode           = dict(choices=['get', 'put', 'delete', 'create', 'geturl', 'getstr'], required=True),
+            permission     = dict(choices=['private', 'public-read', 'authenticated-read'], default='private'),
+            gs_secret_key  = dict(no_log=True, required=False),
+            gs_access_key  = dict(required=False),
+            overwrite      = dict(default=False, type='bool'),
+        ),
+    )
+
+    bucket = module.params.get('bucket')
+    obj = module.params.get('object')
+    src = module.params.get('src')
+    dest = module.params.get('dest')
+    if dest:
+        dest = os.path.expanduser(dest)
+    mode = module.params.get('mode')
+    # expiry is not applicable for GCS just adding for compatibility.
+    expiry = 600
+    gs_secret_key = module.params.get('gs_secret_key')
+    gs_access_key = module.params.get('gs_access_key')
+    overwrite = module.params.get('overwrite')
+    if mode == 'put':
+        if not src or not bucket or not object:
+            module.fail_json(msg="When using PUT, src, bucket, object are mandatory paramters") 
+    if mode == 'get':
+        if not dest or not bucket or not object:
+            module.fail_json(msg="When using GET, dest, bucket, object are mandatory paramters") 
+    if obj:
+        obj = os.path.expanduser(module.params['object'])
+
+    if not gs_secret_key:
+        if  'GS_SECRET_KEY' in os.environ:
+            gs_secret_key = os.environ['GS_SECRET_KEY']
+
+    if not gs_access_key:
+        if 'GS_ACCESS_KEY' in os.environ:
+            gs_access_key = os.environ['GS_ACCESS_KEY']
+
+    try:
+        gs = boto.connect_gs(gs_access_key, gs_secret_key)
+    except boto.exception.NoAuthHandlerFound, e:
+        module.fail_json(msg = str(e))
+ 
+    # If our mode is a GET operation (download), go through the procedure as appropriate ...
+    if mode == 'get':
+    
+        # First, we check to see if the bucket exists, we get "bucket" returned.
+        bucketrtn = bucket_check(module, gs, bucket)
+        if bucketrtn is False:
+            module.fail_json(msg="Target bucket cannot be found", failed=True)
+            sys.exit(0)
+
+        # Next, we check to see if the key in the bucket exists. If it exists, it also returns key_matches md5sum check.
+        keyrtn = key_check(module, gs, bucket, obj)    
+        if keyrtn is False:
+            module.fail_json(msg="Target key cannot be found", failed=True)
+            sys.exit(0)
+
+        # If the destination path doesn't exist, no need to md5um etag check, so just download.
+        pathrtn = path_check(dest)
+        if pathrtn is False:
+            download_gsfile(module, gs, bucket, obj, dest)
+
+        # Compare the remote MD5 sum of the object with the local dest md5sum, if it already exists. 
+        if pathrtn is True:
+            md5_remote = keysum(module, gs, bucket, obj)
+            md5_local = hashlib.md5(open(dest, 'rb').read()).hexdigest()
+            if md5_local == md5_remote:
+                sum_matches = True
+                if overwrite is True:
+                    download_gsfile(module, gs, bucket, obj, dest)
+                else:
+                    module.exit_json(msg="Local and remote object are identical, ignoring. Use overwrite parameter to force.", changed=False)
+            else:
+                sum_matches = False
+                if overwrite is True:
+                    download_gsfile(module, gs, bucket, obj, dest)
+                else:
+                    module.fail_json(msg="WARNING: Checksums do not match. Use overwrite parameter to force download.", failed=True)
+        
+        # If destination file doesn't already exist we can go ahead and download.
+        if pathrtn is False:
+            download_gsfile(module, gs, bucket, obj, dest)
+   
+        # Firstly, if key_matches is TRUE and overwrite is not enabled, we EXIT with a helpful message. 
+        if sum_matches is True and overwrite is False:
+            module.exit_json(msg="Local and remote object are identical, ignoring. Use overwrite parameter to force.", changed=False)
+
+        # At this point explicitly define the overwrite condition.
+        if sum_matches is True and pathrtn is True and overwrite is True:
+            download_gsfile(module, gs, bucket, obj, dest)
+
+        # If sum does not match but the destination exists, we 
+               
+    # if our mode is a PUT operation (upload), go through the procedure as appropriate ...        
+    if mode == 'put':
+
+        # Use this snippet to debug through conditionals:
+#       module.exit_json(msg="Bucket return %s"%bucketrtn)
+#       sys.exit(0)
+
+        # Lets check the src path.
+        pathrtn = path_check(src)
+        if pathrtn is False:
+            module.fail_json(msg="Local object for PUT does not exist", failed=True)
+            sys.exit(0)
+        
+        # Lets check to see if bucket exists to get ground truth.
+        bucketrtn = bucket_check(module, gs, bucket)
+        keyrtn = key_check(module, gs, bucket, obj)
+
+        # Lets check key state. Does it exist and if it does, compute the etag md5sum.
+        if bucketrtn is True and keyrtn is True:
+                md5_remote = keysum(module, gs, bucket, obj)
+                md5_local = hashlib.md5(open(src, 'rb').read()).hexdigest()
+                if md5_local == md5_remote:
+                    sum_matches = True
+                    if overwrite is True:
+                        upload_gsfile(module, gs, bucket, obj, src, expiry)
+                    else:
+                        module.exit_json(msg="Local and remote object are identical, ignoring. Use overwrite parameter to force.", changed=False)
+                else:
+                    sum_matches = False
+                    if overwrite is True:
+                        upload_gsfile(module, gs, bucket, obj, src, expiry)
+                    else:
+                        module.exit_json(msg="WARNING: Checksums do not match. Use overwrite parameter to force upload.", failed=True)
+                                                                                                            
+        # If neither exist (based on bucket existence), we can create both.
+        if bucketrtn is False and pathrtn is True:      
+            create_bucket(module, gs, bucket)
+            upload_gsfile(module, gs, bucket, obj, src, expiry)
+
+        # If bucket exists but key doesn't, just upload.
+        if bucketrtn is True and pathrtn is True and keyrtn is False:
+            upload_gsfile(module, gs, bucket, obj, src, expiry)
+    
+    # Support for deleting an object if we have both params.  
+    if mode == 'delete':
+        if bucket and not obj:
+            bucketrtn = bucket_check(module, gs, bucket)
+            if bucketrtn is True:
+                deletertn = delete_bucket(module, gs, bucket)
+                if deletertn is True:
+                    module.exit_json(msg="Bucket %s and all keys have been deleted."%bucket, changed=True)
+            else:
+                module.exit_json(msg="Bucket does not exist.", changed=False)
+        if bucket and obj:
+            bucketrtn = bucket_check(module, gs, bucket)
+            if bucketrtn is True:
+                keyrtn = key_check(module, gs, bucket, obj)
+                if keyrtn is True:
+                    deletertn = delete_key(module, gs, bucket, obj) 
+                    if deletertn is True:
+                        module.exit_json(msg="Object has been deleted.", changed=True)
+                else:
+                    module.exit_json(msg="Object does not exists.", changed=False)
+                   
+            else:
+                module.exit_json(msg="Bucket does not exist.", changed=False)
+        else:
+            module.fail_json(msg="Bucket or Bucket & object  parameter is required.", failed=True)
+ 
+    # Need to research how to create directories without "populating" a key, so this should just do bucket creation for now.
+    # WE SHOULD ENABLE SOME WAY OF CREATING AN EMPTY KEY TO CREATE "DIRECTORY" STRUCTURE, AWS CONSOLE DOES THIS.
+    if mode == 'create':
+        if bucket and not obj: 
+            bucketrtn = bucket_check(module, gs, bucket)
+            if bucketrtn is True:
+                module.exit_json(msg="Bucket already exists.", changed=False)
+            else:
+                module.exit_json(msg="Bucket created succesfully", changed=create_bucket(module, gs, bucket))
+        if bucket and obj:
+            bucketrtn = bucket_check(module, gs, bucket)
+            if obj.endswith('/'):
+                dirobj = obj
+            else:
+                dirobj = obj + "/"
+            if bucketrtn is True:
+                keyrtn = key_check(module, gs, bucket, dirobj)
+                if keyrtn is True: 
+                    module.exit_json(msg="Bucket %s and key %s already exists."% (bucket, obj), changed=False)
+                else:      
+                    create_dirkey(module, gs, bucket, dirobj)
+            if bucketrtn is False:
+                created = create_bucket(module, gs, bucket)
+                create_dirkey(module, gs, bucket, dirobj)
+
+    # Support for grabbing the time-expired URL for an object in S3/Walrus.
+    if mode == 'geturl':
+        if bucket and obj:
+            bucketrtn = bucket_check(module, gs, bucket)
+            if bucketrtn is False:
+                module.fail_json(msg="Bucket %s does not exist."%bucket, failed=True)
+            else:
+                keyrtn = key_check(module, gs, bucket, obj)
+                if keyrtn is True:
+                    get_download_url(module, gs, bucket, obj, expiry)
+                else:
+                    module.fail_json(msg="Key %s does not exist."%obj, failed=True)
+        else:
+            module.fail_json(msg="Bucket and Object parameters must be set", failed=True)
+            sys.exit(0)
+
+    if mode == 'getstr':
+        if bucket and obj:
+            bucketrtn = bucket_check(module, gs, bucket)
+            if bucketrtn is False:
+                module.fail_json(msg="Bucket %s does not exist."%bucket, failed=True)
+            else:
+                keyrtn = key_check(module, gs, bucket, obj)
+                if keyrtn is True:
+                    download_gsstr(module, gs, bucket, obj)
+                else:
+                    module.fail_json(msg="Key %s does not exist."%obj, failed=True)
+
+    sys.exit(0)
+
+# this is magic, see lib/ansible/module_common.py
+#<<INCLUDE_ANSIBLE_MODULE_COMMON>>
+
+main()