salt/states/svn.py
# -*- coding: utf-8 -*-
'''
Manage SVN repositories
=======================
Manage repository checkouts via the svn vcs system. Note that subversion must
be installed for these states to be available, so svn states should include a
requisite to a pkg.installed state for the package which provides subversion
(``subversion`` in most cases). Example:
.. code-block:: yaml
subversion:
pkg.installed
http://unladen-swallow.googlecode.com/svn/trunk/:
svn.latest:
- target: /tmp/swallow
'''
from __future__ import absolute_import, unicode_literals, print_function
# Import python libs
import logging
import os
# Import salt libs
from salt import exceptions
from salt.states.git import _fail, _neutral_test
# Import 3rd party libs
from salt.ext import six
log = logging.getLogger(__name__)
def __virtual__():
'''
Only load if svn is available
'''
return __salt__['cmd.has_exec']('svn')
def latest(name,
target=None,
rev=None,
user=None,
username=None,
password=None,
force=False,
externals=True,
trust=False,
trust_failures=None):
'''
Checkout or update the working directory to the latest revision from the
remote repository.
name
Address of the name repository as passed to "svn checkout"
target
Name of the target directory where the checkout will put the working
directory
rev : None
The name revision number to checkout. Enable "force" if the directory
already exists.
user : None
Name of the user performing repository management operations
username : None
The user to access the name repository with. The svn default is the
current user
password
Connect to the Subversion server with this password
.. versionadded:: 0.17.0
force : False
Continue if conflicts are encountered
externals : True
Change to False to not checkout or update externals
trust : False
Automatically trust the remote server. SVN's --trust-server-cert
trust_failures : None
Comma-separated list of certificate trust failures, that shall be
ignored. This can be used if trust=True is not sufficient. The
specified string is passed to SVN's --trust-server-cert-failures
option as-is.
.. versionadded:: 2019.2.0
'''
ret = {'name': name, 'result': True, 'comment': '', 'changes': {}}
if not target:
return _fail(ret, 'Target option is required')
svn_cmd = 'svn.checkout'
cwd, basename = os.path.split(target)
opts = tuple()
if os.path.exists(target) and not os.path.isdir(target):
return _fail(ret,
'The path "{0}" exists and is not '
'a directory.'.format(target)
)
if __opts__['test']:
if rev:
new_rev = six.text_type(rev)
else:
new_rev = 'HEAD'
if not os.path.exists(target):
return _neutral_test(
ret,
('{0} doesn\'t exist and is set to be checked out at revision ' + new_rev + '.').format(target))
try:
current_info = __salt__['svn.info'](cwd, target, user=user, username=username, password=password, fmt='dict')
svn_cmd = 'svn.diff'
except exceptions.CommandExecutionError:
return _fail(
ret,
('{0} exists but is not a svn working copy.').format(target))
current_rev = current_info[0]['Revision']
opts += ('-r', current_rev + ':' + new_rev)
if trust:
opts += ('--trust-server-cert',)
out = __salt__[svn_cmd](cwd, target, user, username, password, *opts)
return _neutral_test(
ret,
('{0}').format(out))
try:
current_info = __salt__['svn.info'](cwd, target, user=user, username=username, password=password, fmt='dict')
svn_cmd = 'svn.update'
except exceptions.CommandExecutionError:
pass
if rev:
opts += ('-r', six.text_type(rev))
if force:
opts += ('--force',)
if externals is False:
opts += ('--ignore-externals',)
if trust:
opts += ('--trust-server-cert',)
if trust_failures:
opts += ('--trust-server-cert-failures', trust_failures)
if svn_cmd == 'svn.update':
out = __salt__[svn_cmd](cwd, basename, user, username, password, *opts)
current_rev = current_info[0]['Revision']
new_rev = __salt__['svn.info'](cwd=target,
targets=None,
user=user,
username=username,
password=password,
fmt='dict')[0]['Revision']
if current_rev != new_rev:
ret['changes']['revision'] = "{0} => {1}".format(current_rev, new_rev)
else:
out = __salt__[svn_cmd](cwd, name, basename, user, username, password, *opts)
ret['changes']['new'] = name
ret['changes']['revision'] = __salt__['svn.info'](cwd=target,
targets=None,
user=user,
username=username,
password=password,
fmt='dict')[0]['Revision']
ret['comment'] = out
return ret
def export(name,
target=None,
rev=None,
user=None,
username=None,
password=None,
force=False,
overwrite=False,
externals=True,
trust=False,
trust_failures=None):
'''
Export a file or directory from an SVN repository
name
Address and path to the file or directory to be exported.
target
Name of the target directory where the checkout will put the working
directory
rev : None
The name revision number to checkout. Enable "force" if the directory
already exists.
user : None
Name of the user performing repository management operations
username : None
The user to access the name repository with. The svn default is the
current user
password
Connect to the Subversion server with this password
.. versionadded:: 0.17.0
force : False
Continue if conflicts are encountered
overwrite : False
Overwrite existing target
externals : True
Change to False to not checkout or update externals
trust : False
Automatically trust the remote server. SVN's --trust-server-cert
trust_failures : None
Comma-separated list of certificate trust failures, that shall be
ignored. This can be used if trust=True is not sufficient. The
specified string is passed to SVN's --trust-server-cert-failures
option as-is.
.. versionadded:: 2019.2.0
'''
ret = {'name': name, 'result': True, 'comment': '', 'changes': {}}
if not target:
return _fail(ret, 'Target option is required')
svn_cmd = 'svn.export'
cwd, basename = os.path.split(target)
opts = tuple()
if not overwrite and os.path.exists(target) and not os.path.isdir(target):
return _fail(ret,
'The path "{0}" exists and is not '
'a directory.'.format(target)
)
if __opts__['test']:
if not os.path.exists(target):
return _neutral_test(
ret,
('{0} doesn\'t exist and is set to be checked out.').format(target))
svn_cmd = 'svn.list'
rev = 'HEAD'
out = __salt__[svn_cmd](cwd, target, user, username, password, *opts)
return _neutral_test(
ret,
('{0}').format(out))
if not rev:
rev = 'HEAD'
if force:
opts += ('--force',)
if externals is False:
opts += ('--ignore-externals',)
if trust:
opts += ('--trust-server-cert',)
if trust_failures:
opts += ('--trust-server-cert-failures', trust_failures)
out = __salt__[svn_cmd](cwd, name, basename, user, username, password, rev, *opts)
ret['changes']['new'] = name
ret['changes']['comment'] = name + ' was Exported to ' + target
return ret
def dirty(name,
target,
user=None,
username=None,
password=None,
ignore_unversioned=False):
'''
Determine if the working directory has been changed.
'''
ret = {'name': name, 'result': True, 'comment': '', 'changes': {}}
return _fail(ret, 'This function is not implemented yet.')