saltstack/salt

# -*- coding: utf-8 -*-
'''
Apache Libcloud Storage State
=============================

Manage cloud storage using libcloud

:codeauthor: ``Anthony Shaw <anthonyshaw@apache.org>``

Apache Libcloud Storage (object/blob) management for a full list
of supported clouds, see http://libcloud.readthedocs.io/en/latest/storage/supported_providers.html

Clouds include Amazon S3, Google Storage, Aliyun, Azure Blobs, Ceph, OpenStack swift

.. versionadded:: 2018.3.0

:configuration:
    This module uses a configuration profile for one or multiple Storage providers

    .. code-block:: yaml

        libcloud_storage:
            profile_test1:
              driver: google_storage
              key: GOOG0123456789ABCXYZ
              secret: mysecret
            profile_test2:
              driver: s3
              key: 12345
              secret: mysecret

Examples
--------

Creating a container and uploading a file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: yaml

    web_things:
      libcloud_storage.container_present:
        name: my_container_name
        profile: profile1
      libcloud_storage.object_present:
        name: my_file.jpg
        container: my_container_name
        path: /path/to/local/file.jpg
        profile: profile1

Downloading a file
~~~~~~~~~~~~~~~~~~

This example will download the file from the remote cloud and keep it locally

.. code-block:: yaml

    web_things:
      libcloud_storage.file_present:
        name: my_file.jpg
        container: my_container_name
        path: /path/to/local/file.jpg
        profile: profile1

:depends: apache-libcloud
'''

# Import Python Libs
from __future__ import absolute_import, unicode_literals, print_function
import logging

# Import salt libs
import salt.utils.compat

log = logging.getLogger(__name__)


def __virtual__():
    return True


def __init__(opts):
    salt.utils.compat.pack_dunder(__name__)


def state_result(result, message, name, changes):
    return {'result': result,
            'comment': message,
            'name': name,
            'changes': changes}


def container_present(name, profile):
    '''
    Ensures a container is present.

    :param name: Container name
    :type  name: ``str``

    :param profile: The profile key
    :type  profile: ``str``
    '''
    containers = __salt__['libcloud_storage.list_containers'](profile)
    match = [z for z in containers if z['name'] == name]
    if match:
        return state_result(True, "Container already exists", name, {})
    else:
        result = __salt__['libcloud_storage.create_container'](name, profile)
        return state_result(True, "Created new container", name, result)


def container_absent(name, profile):
    '''
    Ensures a container is absent.

    :param name: Container name
    :type  name: ``str``

    :param profile: The profile key
    :type  profile: ``str``
    '''
    containers = __salt__['libcloud_storage.list_containers'](profile)
    match = [z for z in containers if z['name'] == name]
    if not match:
        return state_result(True, "Container already absent", name, {})
    else:
        result = __salt__['libcloud_storage.delete_container'](name, profile)
        return state_result(result, "Deleted container", name, {})


def object_present(container, name, path, profile):
    '''
    Ensures a object is presnt.

    :param container: Container name
    :type  container: ``str``

    :param name: Object name in cloud
    :type  name: ``str``

    :param path: Local path to file
    :type  path: ``str``

    :param profile: The profile key
    :type  profile: ``str``
    '''
    existing_object = __salt__['libcloud_storage.get_container_object'](container, name, profile)
    if existing_object is not None:
        return state_result(True, "Object already present", name, {})
    else:
        result = __salt__['libcloud_storage.upload_object'](path, container, name, profile)
        return state_result(result, "Uploaded object", name, {})


def object_absent(container, name, profile):
    '''
    Ensures a object is absent.

    :param container: Container name
    :type  container: ``str``

    :param name: Object name in cloud
    :type  name: ``str``

    :param profile: The profile key
    :type  profile: ``str``
    '''
    existing_object = __salt__['libcloud_storage.get_container_object'](container, name, profile)
    if existing_object is None:
        return state_result(True, "Object already absent", name, {})
    else:
        result = __salt__['libcloud_storage.delete_object'](container, name, profile)
        return state_result(result, "Deleted object", name, {})


def file_present(container, name, path, profile, overwrite_existing=False):
    '''
    Ensures a object is downloaded locally.

    :param container: Container name
    :type  container: ``str``

    :param name: Object name in cloud
    :type  name: ``str``

    :param path: Local path to file
    :type  path: ``str``

    :param profile: The profile key
    :type  profile: ``str``

    :param overwrite_existing: Replace if already exists
    :type  overwrite_existing: ``bool``
    '''
    result = __salt__['libcloud_storage.download_object'](path, container, name, profile, overwrite_existing)
    return state_result(result, "Downloaded object", name, {})