saltstack/salt

View on GitHub
salt/states/mssql_user.py

Summary

Maintainability
F
3 days
Test Coverage
# -*- coding: utf-8 -*-
'''
Management of Microsoft SQLServer Users
=======================================

The mssql_user module is used to create
and manage SQL Server Users

.. code-block:: yaml

    frank:
      mssql_user.present:
        - database: yolo
'''
from __future__ import absolute_import, print_function, unicode_literals
import collections


def __virtual__():
    '''
    Only load if the mssql module is present
    '''
    return 'mssql.version' in __salt__


def _normalize_options(options):
    if type(options) in [dict, collections.OrderedDict]:
        return ['{0}={1}'.format(k, v) for k, v in options.items()]
    if type(options) is list and (not options or type(options[0]) is str):
        return options
    # Invalid options
    if type(options) is not list or type(options[0]) not in [dict, collections.OrderedDict]:
        return []
    return [o for d in options for o in _normalize_options(d)]


def present(name, login=None, domain=None, database=None, roles=None, options=None, **kwargs):
    '''
    Checks existance of the named user.
    If not present, creates the user with the specified roles and options.

    name
        The name of the user to manage
    login
        If not specified, will be created WITHOUT LOGIN
    domain
        Creates a Windows authentication user.
        Needs to be NetBIOS domain or hostname
    database
        The database of the user (not the login)
    roles
        Add this user to all the roles in the list
    options
        Can be a list of strings, a dictionary, or a list of dictionaries
    '''
    ret = {'name': name,
           'changes': {},
           'result': True,
           'comment': ''}

    if domain and not login:
        ret['result'] = False
        ret['comment'] = 'domain cannot be set without login'
        return ret
    if __salt__['mssql.user_exists'](name, domain=domain, database=database, **kwargs):
        ret['comment'] = 'User {0} is already present (Not going to try to set its roles or options)'.format(name)
        return ret
    if __opts__['test']:
        ret['result'] = None
        ret['comment'] = 'User {0} is set to be added'.format(name)
        return ret

    user_created = __salt__['mssql.user_create'](name, login=login,
                                                       domain=domain,
                                                       database=database,
                                                       roles=roles,
                                                       options=_normalize_options(options),
                                                       **kwargs)
    if user_created is not True:  # Non-empty strings are also evaluated to True, so we cannot use if not user_created:
        ret['result'] = False
        ret['comment'] += 'User {0} failed to be added: {1}'.format(name, user_created)
        return ret
    ret['comment'] += 'User {0} has been added'.format(name)
    ret['changes'][name] = 'Present'
    return ret


def absent(name, **kwargs):
    '''
    Ensure that the named user is absent

    name
        The username of the user to remove
    '''
    ret = {'name': name,
           'changes': {},
           'result': True,
           'comment': ''}

    if not __salt__['mssql.user_exists'](name):
        ret['comment'] = 'User {0} is not present'.format(name)
        return ret
    if __opts__['test']:
        ret['result'] = None
        ret['comment'] = 'User {0} is set to be removed'.format(name)
        return ret
    if __salt__['mssql.user_remove'](name, **kwargs):
        ret['comment'] = 'User {0} has been removed'.format(name)
        ret['changes'][name] = 'Absent'
        return ret
    # else:
    ret['result'] = False
    ret['comment'] = 'User {0} failed to be removed'.format(name)
    return ret