#!/usr/bin/env python
# Software License Agreement (BSD License)
#
# Copyright (c) 2009, Willow Garage, Inc.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above
# copyright notice, this list of conditions and the following
# disclaimer in the documentation and/or other materials provided
# with the distribution.
# * Neither the name of Willow Garage, Inc. nor the names of its
# contributors may be used to endorse or promote products derived
# from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
# COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
from __future__ import absolute_import, print_function, unicode_literals
import os
import io
import unittest
import subprocess
import tempfile
import shutil
import re
from vcstools.svn import SvnClient, canonical_svn_url_split, get_remote_contents
class SvnClientUtilTest(unittest.TestCase):
def test_canonical_svn_url_split(self):
self.assertEqual({'root': 'foo',
'type': None,
'name': None, 'subfolder': None,
'query': None, 'fragment': None},
canonical_svn_url_split('foo'))
self.assertEqual({'root': None,
'type': None,
'name': None, 'subfolder': None,
'query': None, 'fragment': None},
canonical_svn_url_split(None))
self.assertEqual({'root': 'svn://gcc.gnu.org/svn/gcc',
'type': 'branches',
'name': 'foo', 'subfolder': None,
'query': None, 'fragment': None},
canonical_svn_url_split('svn://gcc.gnu.org/svn/gcc/branches/foo'))
self.assertEqual({'root': 'svn://gcc.gnu.org/svn/gcc',
'type': 'branches',
'name': 'foo', 'subfolder': None,
'query': None, 'fragment': None},
canonical_svn_url_split('svn://gcc.gnu.org/svn/gcc/branches/foo/'))
self.assertEqual({'root': 'svn://gcc.gnu.org/svn/gcc',
'type': 'branches',
'name': 'foo', 'subfolder': 'sub/bar',
'query': None, 'fragment': None},
canonical_svn_url_split('svn://gcc.gnu.org/svn/gcc/branches/foo/sub/bar'))
self.assertEqual({'root': 'svn://gcc.gnu.org/svn/gcc',
'type': 'trunk',
'name': None, 'subfolder': None,
'query': None, 'fragment': None},
canonical_svn_url_split('svn://gcc.gnu.org/svn/gcc/trunk'))
self.assertEqual({'root': 'svn://gcc.gnu.org/svn/gcc',
'type': 'trunk',
'name': None, 'subfolder': 'sub',
'query': None, 'fragment': None},
canonical_svn_url_split('svn://gcc.gnu.org/svn/gcc/trunk/sub'))
self.assertEqual({'root': 'svn://gcc.gnu.org/svn/gcc',
'type': 'trunk',
'name': None, 'subfolder': 'sub/foo',
'query': None, 'fragment': None},
canonical_svn_url_split('svn://gcc.gnu.org/svn/gcc/trunk/sub/foo'))
self.assertEqual({'root': 'svn://gcc.gnu.org/svn/gcc',
'type': 'tags',
'name': '1.2.3', 'subfolder': None,
'query': None, 'fragment': None},
canonical_svn_url_split('svn://gcc.gnu.org/svn/gcc/tags/1.2.3'))
self.assertEqual({'root': 'svn://gcc.gnu.org/svn/gcc',
'type': 'tags',
'name': '1.2.3', 'subfolder': 'sub/foo',
'query': None, 'fragment': None},
canonical_svn_url_split('svn://gcc.gnu.org/svn/gcc/tags/1.2.3/sub/foo'))
self.assertEqual({'root': 'file://localhost/svn/gcc',
'type': 'tags',
'name': '1.2.3', 'subfolder': 'sub/foo',
'query': None, 'fragment': None},
canonical_svn_url_split('file://localhost/svn/gcc/tags/1.2.3/sub/foo'))
self.assertEqual({'root': 'https://frodo@gcc.gnu.org/svn/gcc',
'type': 'tags',
'name': '1.2.3', 'subfolder': 'sub/foo',
'query': 'pw=guest', 'fragment': 'today'},
canonical_svn_url_split('https://frodo@gcc.gnu.org/svn/gcc/tags/1.2.3/sub/foo?pw=guest#today'))
class SvnClientTestSetups(unittest.TestCase):
@classmethod
def setUpClass(self):
self.root_directory = tempfile.mkdtemp()
self.directories = dict(setUp=self.root_directory)
self.remote_path = os.path.join(self.root_directory, "remote")
self.init_path = os.path.join(self.root_directory, "init")
# create a "remote" repo
subprocess.check_call("svnadmin create %s" % self.remote_path, shell=True, cwd=self.root_directory)
self.local_root_url = "file://localhost" + self.remote_path
self.local_url = self.local_root_url + "/trunk"
# create an "init" repo to populate remote repo
subprocess.check_call("svn checkout %s %s" % (self.local_root_url, self.init_path), shell=True, cwd=self.root_directory)
for cmd in [
"mkdir trunk",
"mkdir branches",
"mkdir tags",
"svn add trunk branches tags",
"touch trunk/fixed.txt",
"svn add trunk/fixed.txt",
"svn commit -m initial"]:
subprocess.check_call(cmd, shell=True, cwd=self.init_path)
self.local_version_init = "-r1"
# files to be modified in "local" repo
for cmd in [
"touch trunk/modified.txt",
"touch trunk/modified-fs.txt",
"svn add trunk/modified.txt trunk/modified-fs.txt",
"svn commit -m initial"]:
subprocess.check_call(cmd, shell=True, cwd=self.init_path)
self.local_version_second = "-r2"
for cmd in [
"touch trunk/deleted.txt",
"touch trunk/deleted-fs.txt",
"svn add trunk/deleted.txt trunk/deleted-fs.txt",
"svn commit -m modified"]:
subprocess.check_call(cmd, shell=True, cwd=self.init_path)
self.local_version_master = "-r3"
# files to be modified in "local" repo
for cmd in [
"mkdir branches/foo",
"touch branches/foo/modified.txt",
"svn add branches/foo",
"svn commit -m 'foo branch'"]:
subprocess.check_call(cmd, shell=True, cwd=self.init_path)
self.branch_url = self.local_root_url + "/branches/foo"
self.local_version_foo_branch = "-r4"
self.local_path = os.path.join(self.root_directory, "local")
@classmethod
def tearDownClass(self):
for d in self.directories:
shutil.rmtree(self.directories[d])
def tearDown(self):
if os.path.exists(self.local_path):
shutil.rmtree(self.local_path)
class SvnClientTest(SvnClientTestSetups):
def test_get_url_by_reading(self):
client = SvnClient(self.local_path)
client.checkout(self.local_url)
self.assertTrue(client.path_exists())
self.assertTrue(client.detect_presence())
self.assertEqual(self.local_url, client.get_url())
self.assertEqual(client.get_version(), self.local_version_master)
self.assertEqual(client.get_version("PREV"), "-r2")
self.assertEqual(client.get_version("2"), "-r2")
self.assertEqual(client.get_version("-r2"), "-r2")
# test invalid cient and repo without url
client = SvnClient(os.path.join(self.remote_path, 'foo'))
self.assertEqual(None, client.get_url())
def test_get_type_name(self):
local_path = "/tmp/dummy"
client = SvnClient(local_path)
self.assertEqual(client.get_vcs_type_name(), 'svn')
def test_get_url_nonexistant(self):
local_path = "/tmp/dummy"
client = SvnClient(local_path)
self.assertEqual(client.get_url(), None)
def test_checkout(self):
url = self.local_url
client = SvnClient(self.local_path)
self.assertFalse(client.path_exists())
self.assertFalse(client.detect_presence())
self.assertFalse(client.detect_presence())
self.assertTrue(client.checkout(url))
self.assertTrue(client.path_exists())
self.assertTrue(client.detect_presence())
self.assertEqual(client.get_path(), self.local_path)
self.assertEqual(client.get_url(), url)
def test_checkout_dir_exists(self):
url = self.local_url
client = SvnClient(self.local_path)
self.assertFalse(client.path_exists())
os.makedirs(self.local_path)
self.assertTrue(client.checkout(url))
# non-empty
self.assertFalse(client.checkout(url))
def test_checkout_emptyversion(self):
url = self.local_url
client = SvnClient(self.local_path)
self.assertFalse(client.path_exists())
self.assertFalse(client.detect_presence())
self.assertFalse(client.detect_presence())
self.assertTrue(client.checkout(url, version=''))
self.assertTrue(client.path_exists())
self.assertTrue(client.detect_presence())
self.assertEqual(client.get_path(), self.local_path)
self.assertEqual(client.get_url(), url)
self.assertTrue(client.update(None))
self.assertTrue(client.update(""))
def test_checkout_specific_version_and_update_short(self):
"using just a number as version"
url = self.local_url
version = "3"
client = SvnClient(self.local_path)
self.assertFalse(client.path_exists())
self.assertFalse(client.detect_presence())
self.assertTrue(client.checkout(url, version))
self.assertTrue(client.path_exists())
self.assertTrue(client.detect_presence())
self.assertEqual(client.get_version(), "-r3")
new_version = '2'
self.assertTrue(client.update(new_version))
self.assertEqual(client.get_version(), "-r2")
def test_get_remote_version(self):
url = self.local_url
client = SvnClient(self.local_path)
client.checkout(url)
self.assertEqual(client.get_remote_version(fetch=True),
self.local_version_master)
self.assertEqual(client.get_remote_version(fetch=False),
None)
def test_get_remote_branch_version(self):
url = self.branch_url
client = SvnClient(self.local_path)
client.checkout(url)
self.assertEqual(client.get_remote_version(fetch=True),
self.local_version_foo_branch)
self.assertEqual(client.get_remote_version(fetch=False),
None)
def testDiffClean(self):
client = SvnClient(self.remote_path)
self.assertEquals('', client.get_diff())
def testStatusClean(self):
client = SvnClient(self.remote_path)
self.assertEquals('', client.get_status())
def test_get_environment_metadata(self):
# Verify that metadata is generated
directory = tempfile.mkdtemp()
self.directories['local'] = directory
local_path = os.path.join(directory, "local")
client = SvnClient(local_path)
self.assertTrue('version' in client.get_environment_metadata())
class SvnClientLogTest(SvnClientTestSetups):
@classmethod
def setUpClass(self):
SvnClientTestSetups.setUpClass()
client = SvnClient(self.local_path)
client.checkout(self.local_url)
def test_get_log_defaults(self):
client = SvnClient(self.local_path)
client.checkout(self.local_url)
log = client.get_log()
self.assertEquals(3, len(log))
self.assertEquals('modified', log[0]['message'])
for key in ['id', 'author', 'date', 'message']:
self.assertTrue(log[0][key] is not None, key)
# svn logs don't have email, but key should be in dict
self.assertTrue(log[0]['email'] is None)
def test_get_log_limit(self):
client = SvnClient(self.local_path)
client.checkout(self.local_url)
log = client.get_log(limit=1)
self.assertEquals(1, len(log))
self.assertEquals('modified', log[0]['message'])
def test_get_log_path(self):
client = SvnClient(self.local_path)
client.checkout(self.local_url)
log = client.get_log(relpath='fixed.txt')
self.assertEquals('initial', log[0]['message'])
class SVNClientAffectedFiles(SvnClientTestSetups):
@classmethod
def setUpClass(self):
SvnClientTestSetups.setUpClass()
client = SvnClient(self.local_path)
client.checkout(self.local_url)
def test_get_affected_files(self):
client = SvnClient(self.local_path)
client.checkout(self.local_url)
log = client.get_log(limit=1)[0]
affected = client.get_affected_files(log['id'])
self.assertEqual(sorted(['deleted-fs.txt', 'deleted.txt']),
sorted(affected))
class SvnDiffStatClientTest(SvnClientTestSetups):
@classmethod
def setUpClass(self):
SvnClientTestSetups.setUpClass()
client = SvnClient(self.local_path)
client.checkout(self.local_url)
# after setting up "local" repo, change files and make some changes
subprocess.check_call("rm deleted-fs.txt", shell=True, cwd=self.local_path)
subprocess.check_call("svn rm deleted.txt", shell=True, cwd=self.local_path)
f = io.open(os.path.join(self.local_path, "modified.txt"), 'a')
f.write('0123456789abcdef')
f.close()
f = io.open(os.path.join(self.local_path, "modified-fs.txt"), 'a')
f.write('0123456789abcdef')
f.close()
f = io.open(os.path.join(self.local_path, "added-fs.txt"), 'w')
f.write('0123456789abcdef')
f.close()
f = io.open(os.path.join(self.local_path, "added.txt"), 'w')
f.write('0123456789abcdef')
f.close()
subprocess.check_call("svn add added.txt", shell=True, cwd=self.local_path)
def tearDown(self):
pass
def assertStatusListEqual(self, listexpect, listactual):
"""helper fun to check scm status output while discarding file ordering differences"""
lines_expect = listexpect.splitlines()
lines_actual = listactual.splitlines()
for line in lines_expect:
self.assertTrue(line in lines_actual, 'Missing entry %s in output %s' % (line, listactual))
for line in lines_actual:
self.assertTrue(line in lines_expect, 'Superflous entry %s in output %s' % (line, listactual))
def assertEqualDiffs(self, expected, actual):
"True if actual is similar enough to expected, minus svn properties"
def filter_block(block):
"""removes property information that varies between systems, not relevant fo runit test"""
newblock = []
for line in block.splitlines():
if re.search("[=+-\\@ ].*", line) == None:
break
else:
# new svn versions use different labels for added
# files (working copy) vs (revision x)
fixedline = re.sub('\(revision [0-9]+\)', '(working copy)', line)
# svn 1.9 added (nonexistent)
fixedline = re.sub('\(nonexistent\)', '(working copy)', fixedline)
newblock.append(fixedline)
return "\n".join(newblock)
filtered_actual_blocks = []
# A block starts with \nIndex, and the actual diff goes up to the first line starting with [a-zA-Z], e.g. "Properties changed:"
for block in actual.split("\nIndex: "):
if filtered_actual_blocks != []:
# restore "Index: " removed by split()
block = "Index: " + block
block = filter_block(block)
filtered_actual_blocks.append(block)
expected_blocks = []
for block in expected.split("\nIndex: "):
if expected_blocks != []:
block = "Index: " + block
block = filter_block(block)
expected_blocks.append(block)
filtered = "\n".join(filtered_actual_blocks)
self.assertEquals(set(expected_blocks), set(filtered_actual_blocks))
def test_diff(self):
client = SvnClient(self.local_path)
self.assertTrue(client.path_exists())
self.assertTrue(client.detect_presence())
self.assertEqualDiffs('Index: added.txt\n===================================================================\n--- added.txt\t(revision 0)\n+++ added.txt\t(revision 0)\n@@ -0,0 +1 @@\n+0123456789abcdef\n\\ No newline at end of file\nIndex: modified-fs.txt\n===================================================================\n--- modified-fs.txt\t(revision 3)\n+++ modified-fs.txt\t(working copy)\n@@ -0,0 +1 @@\n+0123456789abcdef\n\\ No newline at end of file\nIndex: modified.txt\n===================================================================\n--- modified.txt\t(revision 3)\n+++ modified.txt\t(working copy)\n@@ -0,0 +1 @@\n+0123456789abcdef\n\\ No newline at end of file',
client.get_diff().rstrip())
def test_diff_relpath(self):
client = SvnClient(self.local_path)
self.assertTrue(client.path_exists())
self.assertTrue(client.detect_presence())
self.assertEqualDiffs('Index: local/added.txt\n===================================================================\n--- local/added.txt\t(revision 0)\n+++ local/added.txt\t(revision 0)\n@@ -0,0 +1 @@\n+0123456789abcdef\n\\ No newline at end of file\nIndex: local/modified-fs.txt\n===================================================================\n--- local/modified-fs.txt\t(revision 3)\n+++ local/modified-fs.txt\t(working copy)\n@@ -0,0 +1 @@\n+0123456789abcdef\n\\ No newline at end of file\nIndex: local/modified.txt\n===================================================================\n--- local/modified.txt\t(revision 3)\n+++ local/modified.txt\t(working copy)\n@@ -0,0 +1 @@\n+0123456789abcdef\n\\ No newline at end of file', client.get_diff(basepath=os.path.dirname(self.local_path)).rstrip())
def test_status(self):
client = SvnClient(self.local_path)
self.assertTrue(client.path_exists())
self.assertTrue(client.detect_presence())
self.assertStatusListEqual('A added.txt\nD deleted.txt\nM modified-fs.txt\n! deleted-fs.txt\nM modified.txt\n', client.get_status())
def test_status_relpath(self):
client = SvnClient(self.local_path)
self.assertTrue(client.path_exists())
self.assertTrue(client.detect_presence())
self.assertStatusListEqual('A local/added.txt\nD local/deleted.txt\nM local/modified-fs.txt\n! local/deleted-fs.txt\nM local/modified.txt\n', client.get_status(basepath=os.path.dirname(self.local_path)))
def test_status_untracked(self):
client = SvnClient(self.local_path)
self.assertTrue(client.path_exists())
self.assertTrue(client.detect_presence())
self.assertStatusListEqual('? added-fs.txt\nA added.txt\nD deleted.txt\nM modified-fs.txt\n! deleted-fs.txt\nM modified.txt\n', client.get_status(untracked=True))
class SvnExportRepositoryClientTest(SvnClientTestSetups):
@classmethod
def setUpClass(self):
SvnClientTestSetups.setUpClass()
client = SvnClient(self.local_path)
client.checkout(self.local_url)
self.basepath_export = os.path.join(self.root_directory, 'export')
def tearDown(self):
pass
def test_export_repository(self):
client = SvnClient(self.local_path)
self.assertTrue(
client.export_repository('',
self.basepath_export)
)
self.assertTrue(os.path.exists(self.basepath_export + '.tar.gz'))
self.assertFalse(os.path.exists(self.basepath_export + '.tar'))
self.assertFalse(os.path.exists(self.basepath_export))
class SvnGetBranchesClientTest(SvnClientTestSetups):
@classmethod
def setUpClass(self):
SvnClientTestSetups.setUpClass()
client = SvnClient(self.local_path)
client.checkout(self.local_url)
# def tearDown(self):
# pass
def test_get_remote_contents(self):
self.assertEqual(['branches', 'tags', 'trunk'], get_remote_contents(self.local_root_url))
def test_get_branches_non_canonical(self):
remote_path = os.path.join(self.root_directory, "remote_nc")
init_path = os.path.join(self.root_directory, "init_nc")
local_path = os.path.join(self.root_directory, "local_nc")
# create a "remote" repo
subprocess.check_call("svnadmin create %s" % remote_path, shell=True, cwd=self.root_directory)
local_root_url = "file://localhost/" + remote_path
local_url = local_root_url + "/footest"
# create an "init" repo to populate remote repo
subprocess.check_call("svn checkout %s %s" % (local_root_url, init_path), shell=True, cwd=self.root_directory)
for cmd in [
"mkdir footest",
"mkdir footest/foosub",
"touch footest/foosub/fixed.txt",
"svn add footest",
"svn commit -m initial"]:
subprocess.check_call(cmd, shell=True, cwd=init_path)
client = SvnClient(local_path)
client.checkout(local_url)
self.assertEqual([], client.get_branches())
def test_get_branches(self):
client = SvnClient(self.local_path)
self.assertEqual(['foo'], client.get_branches())
# slyly create some empty branches
subprocess.check_call("mkdir -p branches/foo2", shell=True, cwd=self.init_path)
subprocess.check_call("mkdir -p branches/bar", shell=True, cwd=self.init_path)
subprocess.check_call("svn add branches/foo2", shell=True, cwd=self.init_path)
subprocess.check_call("svn add branches/bar", shell=True, cwd=self.init_path)
subprocess.check_call("svn commit -m newbranches", shell=True, cwd=self.init_path)
self.assertEqual([], client.get_branches(local_only=True))
self.assertEqual(['bar', 'foo', 'foo2'], client.get_branches())
# checkout branch foo
local_path2 = os.path.join(self.root_directory, "local_foo")
client = SvnClient(local_path2)
client.checkout(self.local_root_url + '/branches/foo')
self.assertEqual(['foo'], client.get_branches(local_only=True))