37 |
39 | {{docstitle}}
38 |
40 |
41 |
50 | {% endblock %}
51 |
52 | {%- block sidebar1 %}
53 | {%- if not embedded %}{% if not theme_nosidebar|tobool %}
54 | {{ title|striptags }}
-
42 |
43 |
48 |
55 |
104 | {%- endif %}{% endif %}
105 |
106 | {% endblock %}
107 | {%- block document %}
108 |
56 | {%- block sidebarlogo %}
57 | {%- if logo %}
58 |
61 | {%- endif %}
62 | {%- endblock %}
63 | {%- block sidebartoc %}
64 |
65 | {{ toctree() }}
66 | {%- endblock %}
67 | {%- block sidebarrel %}
68 | {%- endblock %}
69 | {%- block sidebarsourcelink %}
70 | {%- if show_source and has_source and sourcename %}
71 |
103 | {{ _('This Page') }}
72 | 76 | {%- endif %} 77 | {%- endblock %} 78 | {%- if customsidebar %} 79 | {% include customsidebar %} 80 | {%- endif %} 81 | {%- block sidebarsearch %} 82 | {%- if pagename != "search" %} 83 | 99 | 100 | {%- endif %} 101 | {%- endblock %} 102 |
109 | {%- if not embedded %}{% if not theme_nosidebar|tobool %}
110 |
119 |
133 | {%- endblock %}
134 | {%- block sidebar2 %}{% endblock %}
135 | {%- block relbar2 %}{% endblock %}
136 | {%- block footer %}
137 |
111 | {%- endif %}{% endif %}
112 |
117 | {%- endif %}{% endif %}
118 |
113 | {% block body %} {% endblock %}
114 |
115 | {%- if not embedded %}{% if not theme_nosidebar|tobool %}
116 |
138 | {%- for parent in parents %}
139 | {{ parent.title|safe }} }})
140 | {%- endfor %}
141 | {{ title|safe|e }}
142 |
143 |
144 |
145 | {%- endblock %}
146 |
--------------------------------------------------------------------------------
/vcs/tests/test_repository.py:
--------------------------------------------------------------------------------
1 | from __future__ import with_statement
2 | import datetime
3 | from vcs.tests.base import BackendTestMixin
4 | from vcs.tests.conf import SCM_TESTS
5 | from vcs.tests.conf import TEST_USER_CONFIG_FILE
6 | from vcs.nodes import FileNode
7 | from vcs.utils.compat import unittest
8 | from vcs.exceptions import ChangesetDoesNotExistError
9 |
10 |
11 | class RepositoryBaseTest(BackendTestMixin):
12 | recreate_repo_per_test = False
13 |
14 | @classmethod
15 | def _get_commits(cls):
16 | return super(RepositoryBaseTest, cls)._get_commits()[:1]
17 |
18 | def test_get_config_value(self):
19 | self.assertEqual(self.repo.get_config_value('universal', 'foo',
20 | TEST_USER_CONFIG_FILE), 'bar')
21 |
22 | def test_get_config_value_defaults_to_None(self):
23 | self.assertEqual(self.repo.get_config_value('universal', 'nonexist',
24 | TEST_USER_CONFIG_FILE), None)
25 |
26 | def test_get_user_name(self):
27 | self.assertEqual(self.repo.get_user_name(TEST_USER_CONFIG_FILE),
28 | 'Foo Bar')
29 |
30 | def test_get_user_email(self):
31 | self.assertEqual(self.repo.get_user_email(TEST_USER_CONFIG_FILE),
32 | 'foo.bar@example.com')
33 |
34 | def test_repo_equality(self):
35 | self.assertTrue(self.repo == self.repo)
36 |
37 | def test_repo_equality_broken_object(self):
38 | import copy
39 | _repo = copy.copy(self.repo)
40 | delattr(_repo, 'path')
41 | self.assertTrue(self.repo != _repo)
42 |
43 | def test_repo_equality_other_object(self):
44 | class dummy(object):
45 | path = self.repo.path
46 | self.assertTrue(self.repo != dummy())
47 |
48 |
49 | class RepositoryGetDiffTest(BackendTestMixin):
50 |
51 | @classmethod
52 | def _get_commits(cls):
53 | commits = [
54 | {
55 | 'message': 'Initial commit',
56 | 'author': 'Joe Doe
140 | {%- endfor %}
141 | {{ title|safe|e }}
142 |
143 | here:
142 | # since the content in the other cell also is wrapped in a div,
143 | # some browsers in some configurations seem to mess up the formatting.
144 | '''
145 | yield 0, ('' % self.cssclass +
146 | '
'
151 |
152 | '''
153 | headers_row = []
154 | if self.headers:
155 | headers_row = ['']
156 | for key in self.order:
157 | td = ''.join(('', self.headers[key], ' '))
158 | headers_row.append(td)
159 | headers_row.append(' ')
160 |
161 | body_row_start = ['']
162 | for key in self.order:
163 | if key == 'ls':
164 | body_row_start.append(
165 | '')
173 | yield 0, ('' % self.cssclass +
174 | ''.join(headers_row) +
175 | ''.join(body_row_start)
176 | )
177 | yield 0, dummyoutfile.getvalue()
178 | yield 0, '
'
179 |
--------------------------------------------------------------------------------
/docs/conf.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | #
3 | # django-projector documentation build configuration file, created by
4 | # sphinx-quickstart on Thu Feb 18 23:18:28 2010.
5 | #
6 | # This file is execfile()d with the current directory set to its containing
7 | # dir.
8 | #
9 | # Note that not all possible configuration values are present in this
10 | # autogenerated file.
11 | #
12 | # All configuration values have a default; values that are commented out
13 | # serve to show the default.
14 |
15 | import sys
16 | import os
17 |
18 | # If extensions (or modules to document with autodoc) are in another directory,
19 | # add these directories to sys.path here. If the directory is relative to the
20 | # documentation root, use os.path.abspath to make it absolute, like shown here.
21 | sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__))))
22 | sys.path.append(os.path.abspath('..'))
23 | vcs = __import__('vcs')
24 |
25 | # -- General configuration -----------------------------------------------------
26 |
27 | # Add any Sphinx extension module names here, as strings. They can be extensions
28 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
29 | extensions = ['sphinx.ext.autodoc', 'exts']
30 | try:
31 | import rst2pdf
32 | if rst2pdf.version >= '0.16':
33 | extensions.append('rst2pdf.pdfbuilder')
34 | except ImportError:
35 | print "[NOTE] In order to build PDF you need rst2pdf with version >=0.16"
36 |
37 | autoclass_content = "both"
38 |
39 | # Add any paths that contain templates here, relative to this directory.
40 | templates_path = ['templates']
41 |
42 | # The suffix of source filenames.
43 | source_suffix = '.rst'
44 |
45 | # The encoding of source files.
46 | #source_encoding = 'utf-8'
47 |
48 | # The master toctree document.
49 | master_doc = 'index'
50 |
51 | # General information about the project.
52 | project = u'vcs'
53 | copyright = u'2010, Marcin Kuzminski & Lukasz Balcerzak'
54 |
55 | # The version info for the project you're documenting, acts as replacement for
56 | # |version| and |release|, also used in various other places throughout the
57 | # built documents.
58 | #
59 | # The short X.Y version.
60 | version = vcs.get_version()
61 | # The full version, including alpha/beta/rc tags.
62 | release = vcs.__version__
63 |
64 | # The language for content autogenerated by Sphinx. Refer to documentation
65 | # for a list of supported languages.
66 | #language = None
67 |
68 | # There are two options for replacing |today|: either, you set today to some
69 | # non-false value, then it is used:
70 | #today = ''
71 | # Else, today_fmt is used as the format for a strftime call.
72 | #today_fmt = '%B %d, %Y'
73 |
74 | # List of documents that shouldn't be included in the build.
75 | #unused_docs = []
76 |
77 | # List of directories, relative to source directory, that shouldn't be searched
78 | # for source files.
79 | exclude_trees = ['build']
80 |
81 | # The reST default role (used for this markup: `text`) to use for all documents.
82 | #default_role = None
83 |
84 | # If true, '()' will be appended to :func: etc. cross-reference text.
85 | #add_function_parentheses = True
86 |
87 | # If true, the current module name will be prepended to all description
88 | # unit titles (such as .. function::).
89 | #add_module_names = True
90 |
91 | # If true, sectionauthor and moduleauthor directives will be shown in the
92 | # output. They are ignored by default.
93 | #show_authors = False
94 |
95 | # The name of the Pygments (syntax highlighting) style to use.
96 | pygments_style = 'sphinx'
97 |
98 | # A list of ignored prefixes for module index sorting.
99 | #modindex_common_prefix = []
100 |
101 |
102 | # -- Options for HTML output ---------------------------------------------------
103 |
104 | # The theme to use for HTML and HTML Help pages. Major themes that come with
105 | # Sphinx are currently 'default' and 'sphinxdoc'.
106 | html_theme = 'ADC'
107 |
108 | # Theme options are theme-specific and customize the look and feel of a theme
109 | # further. For a list of options available for each theme, see the
110 | # documentation.
111 | #html_theme_options = {}
112 |
113 | # Add any paths that contain custom themes here, relative to this directory.
114 | html_theme_path = ['theme']
115 |
116 | # The name for this set of Sphinx documents. If None, it defaults to
117 | # " v documentation".
118 | #html_title = None
119 |
120 | # A shorter title for the navigation bar. Default is the same as html_title.
121 | #html_short_title = None
122 |
123 | # The name of an image file (relative to this directory) to place at the top
124 | # of the sidebar.
125 | #html_logo = None
126 |
127 | # The name of an image file (within the static path) to use as favicon of the
128 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
129 | # pixels large.
130 | #html_favicon = None
131 |
132 | # Add any paths that contain custom static files (such as style sheets) here,
133 | # relative to this directory. They are copied after the builtin static files,
134 | # so a file named "default.css" will overwrite the builtin "default.css".
135 | html_static_path = []
136 |
137 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
138 | # using the given strftime format.
139 | #html_last_updated_fmt = '%b %d, %Y'
140 |
141 | # If true, SmartyPants will be used to convert quotes and dashes to
142 | # typographically correct entities.
143 | #html_use_smartypants = True
144 |
145 | # Custom sidebar templates, maps document names to template names.
146 | #html_sidebars = {}
147 |
148 | # Additional templates that should be rendered to pages, maps page names to
149 | # template names.
150 | #html_additional_pages = {}
151 |
152 | # If false, no module index is generated.
153 | #html_use_modindex = True
154 |
155 | # If false, no index is generated.
156 | #html_use_index = True
157 |
158 | # If true, the index is split into individual pages for each letter.
159 | #html_split_index = False
160 |
161 | # If true, links to the reST sources are added to the pages.
162 | #html_show_sourcelink = True
163 |
164 | # If true, an OpenSearch description file will be output, and all pages will
165 | # contain a tag referring to it. The value of this option must be the
166 | # base URL from which the finished HTML is served.
167 | #html_use_opensearch = ''
168 |
169 | # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
170 | #html_file_suffix = ''
171 |
172 | # Output file base name for HTML help builder.
173 | htmlhelp_basename = 'vcsdoc'
174 |
175 |
176 | # -- Options for LaTeX output --------------------------------------------------
177 |
178 | # The paper size ('letter' or 'a4').
179 | #latex_paper_size = 'letter'
180 |
181 | # The font size ('10pt', '11pt' or '12pt').
182 | #latex_font_size = '10pt'
183 |
184 | # Grouping the document tree into LaTeX files. List of tuples
185 | # (source start file, target name, title, author, documentclass [howto/manual]).
186 | latex_documents = [
187 | ('index', 'vcs.tex', u'vcs Documentation',
188 | u'Marcin Kuzminski & Lukasz Balcerzak', 'manual'),
189 | ]
190 |
191 | # The name of an image file (relative to this directory) to place at the top of
192 | # the title page.
193 | #latex_logo = None
194 |
195 | # For "manual" documents, if this is true, then toplevel headings are parts,
196 | # not chapters.
197 | #latex_use_parts = False
198 |
199 | # Additional stuff for the LaTeX preamble.
200 | #latex_preamble = ''
201 |
202 | # Documents to append as an appendix to all manuals.
203 | #latex_appendices = []
204 |
205 | # If false, no module index is generated.
206 | #latex_use_modindex = True
207 |
208 | pdf_documents = [
209 | ('index', u'vcs', u'vcs Documentation',
210 | u'Marcin Kuzminski & Lukasz Balcerzak') ,
211 | ]
212 | pdf_stylesheets = ['sphinx', 'kerning', 'a4']
213 | pdf_break_level = 1
214 | pdf_inline_footnotes = True
215 |
--------------------------------------------------------------------------------
/vcs/tests/test_nodes.py:
--------------------------------------------------------------------------------
1 | from __future__ import with_statement
2 |
3 | import stat
4 | from vcs.nodes import DirNode
5 | from vcs.nodes import FileNode
6 | from vcs.nodes import Node
7 | from vcs.nodes import NodeError
8 | from vcs.nodes import NodeKind
9 | from vcs.utils.compat import unittest
10 |
11 |
12 | class NodeBasicTest(unittest.TestCase):
13 |
14 | def test_init(self):
15 | """
16 | Cannot innitialize Node objects with path with slash at the beginning.
17 | """
18 | wrong_paths = (
19 | '/foo',
20 | '/foo/bar'
21 | )
22 | for path in wrong_paths:
23 | self.assertRaises(NodeError, Node, path, NodeKind.FILE)
24 |
25 | wrong_paths = (
26 | '/foo/',
27 | '/foo/bar/'
28 | )
29 | for path in wrong_paths:
30 | self.assertRaises(NodeError, Node, path, NodeKind.DIR)
31 |
32 | def test_name(self):
33 | node = Node('', NodeKind.DIR)
34 | self.assertEqual(node.name, '')
35 |
36 | node = Node('path', NodeKind.FILE)
37 | self.assertEqual(node.name, 'path')
38 |
39 | node = Node('path/', NodeKind.DIR)
40 | self.assertEqual(node.name, 'path')
41 |
42 | node = Node('some/path', NodeKind.FILE)
43 | self.assertEqual(node.name, 'path')
44 |
45 | node = Node('some/path/', NodeKind.DIR)
46 | self.assertEqual(node.name, 'path')
47 |
48 | def test_root_node(self):
49 | self.assertRaises(NodeError, Node, '', NodeKind.FILE)
50 |
51 | def test_kind_setter(self):
52 | node = Node('', NodeKind.DIR)
53 | self.assertRaises(NodeError, setattr, node, 'kind', NodeKind.FILE)
54 |
55 | def _test_parent_path(self, node_path, expected_parent_path):
56 | """
57 | Tests if node's parent path are properly computed.
58 | """
59 | node = Node(node_path, NodeKind.DIR)
60 | parent_path = node.get_parent_path()
61 | self.assertTrue(parent_path.endswith('/') or \
62 | node.is_root() and parent_path == '')
63 | self.assertEqual(parent_path, expected_parent_path,
64 | "Node's path is %r and parent path is %r but should be %r"
65 | % (node.path, parent_path, expected_parent_path))
66 |
67 | def test_parent_path(self):
68 | test_paths = (
69 | # (node_path, expected_parent_path)
70 | ('', ''),
71 | ('some/path/', 'some/'),
72 | ('some/longer/path/', 'some/longer/'),
73 | )
74 | for node_path, expected_parent_path in test_paths:
75 | self._test_parent_path(node_path, expected_parent_path)
76 |
77 | '''
78 | def _test_trailing_slash(self, path):
79 | if not path.endswith('/'):
80 | self.fail("Trailing slash tests needs paths to end with slash")
81 | for kind in NodeKind.FILE, NodeKind.DIR:
82 | self.assertRaises(NodeError, Node, path=path, kind=kind)
83 |
84 | def test_trailing_slash(self):
85 | for path in ('/', 'foo/', 'foo/bar/', 'foo/bar/biz/'):
86 | self._test_trailing_slash(path)
87 | '''
88 |
89 | def test_is_file(self):
90 | node = Node('any', NodeKind.FILE)
91 | self.assertTrue(node.is_file())
92 |
93 | node = FileNode('any')
94 | self.assertTrue(node.is_file())
95 | self.assertRaises(AttributeError, getattr, node, 'nodes')
96 |
97 | def test_is_dir(self):
98 | node = Node('any_dir', NodeKind.DIR)
99 | self.assertTrue(node.is_dir())
100 |
101 | node = DirNode('any_dir')
102 |
103 | self.assertTrue(node.is_dir())
104 | self.assertRaises(NodeError, getattr, node, 'content')
105 |
106 | def test_dir_node_iter(self):
107 | nodes = [
108 | DirNode('docs'),
109 | DirNode('tests'),
110 | FileNode('bar'),
111 | FileNode('foo'),
112 | FileNode('readme.txt'),
113 | FileNode('setup.py'),
114 | ]
115 | dirnode = DirNode('', nodes=nodes)
116 | for node in dirnode:
117 | node == dirnode.get_node(node.path)
118 |
119 | def test_node_state(self):
120 | """
121 | Without link to changeset nodes should raise NodeError.
122 | """
123 | node = FileNode('anything')
124 | self.assertRaises(NodeError, getattr, node, 'state')
125 | node = DirNode('anything')
126 | self.assertRaises(NodeError, getattr, node, 'state')
127 |
128 | def test_file_node_stat(self):
129 | node = FileNode('foobar', 'empty... almost')
130 | mode = node.mode # default should be 0100644
131 | self.assertTrue(mode & stat.S_IRUSR)
132 | self.assertTrue(mode & stat.S_IWUSR)
133 | self.assertTrue(mode & stat.S_IRGRP)
134 | self.assertTrue(mode & stat.S_IROTH)
135 | self.assertFalse(mode & stat.S_IWGRP)
136 | self.assertFalse(mode & stat.S_IWOTH)
137 | self.assertFalse(mode & stat.S_IXUSR)
138 | self.assertFalse(mode & stat.S_IXGRP)
139 | self.assertFalse(mode & stat.S_IXOTH)
140 |
141 | def test_file_node_is_executable(self):
142 | node = FileNode('foobar', 'empty... almost', mode=0100755)
143 | self.assertTrue(node.is_executable())
144 |
145 | node = FileNode('foobar', 'empty... almost', mode=0100500)
146 | self.assertTrue(node.is_executable())
147 |
148 | node = FileNode('foobar', 'empty... almost', mode=0100644)
149 | self.assertFalse(node.is_executable())
150 |
151 | def test_mimetype(self):
152 | py_node = FileNode('test.py')
153 | tar_node = FileNode('test.tar.gz')
154 |
155 | ext = 'CustomExtension'
156 |
157 | my_node2 = FileNode('myfile2')
158 | my_node2._mimetype = [ext]
159 |
160 | my_node3 = FileNode('myfile3')
161 | my_node3._mimetype = [ext,ext]
162 |
163 | self.assertEqual(py_node.mimetype,'text/x-python')
164 | self.assertEqual(py_node.get_mimetype(),('text/x-python',None))
165 |
166 | self.assertEqual(tar_node.mimetype,'application/x-tar')
167 | self.assertEqual(tar_node.get_mimetype(),('application/x-tar','gzip'))
168 |
169 | self.assertRaises(NodeError,my_node2.get_mimetype)
170 |
171 | self.assertEqual(my_node3.mimetype,ext)
172 | self.assertEqual(my_node3.get_mimetype(),[ext,ext])
173 |
174 | class NodeContentTest(unittest.TestCase):
175 |
176 | def test_if_binary(self):
177 | data = """\x89PNG\r\n\x1a\n\x00\x00\x00\rIHDR\x00\x00\x00\x10\x00\x00\x00\x10\x08\x06\x00\x00\x00\x1f??a\x00\x00\x00\x04gAMA\x00\x00\xaf?7\x05\x8a?\x00\x00\x00\x19tEXtSoftware\x00Adobe ImageReadyq?e<\x00\x00\x025IDAT8?\xa5\x93?K\x94Q\x14\x87\x9f\xf7?Q\x1bs4?\x03\x9a\xa8?B\x02\x8b$\x10[U;i\x13?6h?&h[?"\x14j?\xa2M\x7fB\x14F\x9aQ?&\x842?\x0b\x89"\x82??!?\x9c!\x9c2l??{N\x8bW\x9dY\xb4\t/\x1c?=\x9b?}????\xa9*;9!?\x83\x91?[?\\v*?D\x04\'`EpNp\xa2X\'U?pVq"Sw.\x1e?\x08\x01D?jw????\xbc??7{|\x9b?\x89$\x01??W@\x15\x9c\x05q`Lt/\x97?\x94\xa1d?\x18~?\x18?\x18W[%\xb0?\x83??\x14\x88\x8dB?\xa6H\tL\tl\x19>/\x01`\xac\xabx?\x9cl\nx\xb0\x98\x07\x95\x88D$"q[\x19?d\x00(o\n\xa0??\x7f\xb9\xa4?\x1bF\x1f\x8e\xac\xa8?j??eUU}?.?\x9f\x8cE??x\x94??\r\xbdtoJU5"0N\x10U?\x00??V\t\x02\x9f\x81?U?\x00\x9eM\xae2?r\x9b7\x83\x82\x8aP3????.?&"?\xb7ZP \x0cJ?\x80\x15T\x95\x9a\x00??S\x8c\r?\xa1\x03\x07?\x96\x9b\xa7\xab=E??\xa4\xb3?\x19q??B\x91=\x8d??k?J\x0bV"??\xf7x?\xa1\x00?\\.\x87\x87???\x02F@D\x99],??\x10#?X\xb7=\xb9\x10?Z\x1by???cI??\x1ag?\x92\xbc?T?t[\x92\x81?<_\x17~\x92\x88?H%?\x10Q\x02\x9f\n\x81qQ\x0bm?\x1bX?\xb1AK\xa6\x9e\xb9?u\xb2?1\xbe|/\x92M@\xa2!F?\xa9>"\r\x92\x8e?>\x9a9Qv\x127?a\xac?Y?8?:??]X???9\x80\xb7?u?\x0b#BZ\x8d=\x1d?p\x00\x00\x00\x00IEND\xaeB`\x82"""
178 | filenode = FileNode('calendar.png', content=data)
179 | self.assertTrue(filenode.is_binary)
180 |
181 |
182 | if __name__ == '__main__':
183 | unittest.main()
184 |
--------------------------------------------------------------------------------
/vcs/backends/git/inmemory.py:
--------------------------------------------------------------------------------
1 | import time
2 | import datetime
3 | import posixpath
4 | from dulwich import objects
5 | from vcs.backends.base import BaseInMemoryChangeset
6 | from vcs.exceptions import RepositoryError
7 | from vcs.utils import safe_str
8 |
9 |
10 | class GitInMemoryChangeset(BaseInMemoryChangeset):
11 |
12 | def commit(self, message, author, parents=None, branch=None, date=None,
13 | **kwargs):
14 | """
15 | Performs in-memory commit (doesn't check workdir in any way) and
16 | returns newly created ``Changeset``. Updates repository's
17 | ``revisions``.
18 |
19 | :param message: message of the commit
20 | :param author: full username, i.e. "Joe Doe "
21 | :param parents: single parent or sequence of parents from which commit
22 | would be derieved
23 | :param date: ``datetime.datetime`` instance. Defaults to
24 | ``datetime.datetime.now()``.
25 | :param branch: branch name, as string. If none given, default backend's
26 | branch would be used.
27 |
28 | :raises ``CommitError``: if any error occurs while committing
29 | """
30 | self.check_integrity(parents)
31 |
32 | from .repository import GitRepository
33 | if branch is None:
34 | branch = GitRepository.DEFAULT_BRANCH_NAME
35 |
36 | repo = self.repository._repo
37 | object_store = repo.object_store
38 |
39 | ENCODING = "UTF-8"
40 | DIRMOD = 040000
41 |
42 | # Create tree and populates it with blobs
43 | commit_tree = self.parents[0] and repo[self.parents[0]._commit.tree] or\
44 | objects.Tree()
45 | for node in self.added + self.changed:
46 | # Compute subdirs if needed
47 | dirpath, nodename = posixpath.split(node.path)
48 | dirnames = dirpath and dirpath.split('/') or []
49 | parent = commit_tree
50 | ancestors = [('', parent)]
51 |
52 | # Tries to dig for the deepest existing tree
53 | while dirnames:
54 | curdir = dirnames.pop(0)
55 | try:
56 | dir_id = parent[curdir][1]
57 | except KeyError:
58 | # put curdir back into dirnames and stops
59 | dirnames.insert(0, curdir)
60 | break
61 | else:
62 | # If found, updates parent
63 | parent = self.repository._repo[dir_id]
64 | ancestors.append((curdir, parent))
65 | # Now parent is deepest existing tree and we need to create subtrees
66 | # for dirnames (in reverse order) [this only applies for nodes from added]
67 | new_trees = []
68 |
69 | if not node.is_binary:
70 | content = node.content.encode(ENCODING)
71 | else:
72 | content = node.content
73 | blob = objects.Blob.from_string(content)
74 |
75 | node_path = node.name.encode(ENCODING)
76 | if dirnames:
77 | # If there are trees which should be created we need to build
78 | # them now (in reverse order)
79 | reversed_dirnames = list(reversed(dirnames))
80 | curtree = objects.Tree()
81 | curtree[node_path] = node.mode, blob.id
82 | new_trees.append(curtree)
83 | for dirname in reversed_dirnames[:-1]:
84 | newtree = objects.Tree()
85 | #newtree.add(DIRMOD, dirname, curtree.id)
86 | newtree[dirname] = DIRMOD, curtree.id
87 | new_trees.append(newtree)
88 | curtree = newtree
89 | parent[reversed_dirnames[-1]] = DIRMOD, curtree.id
90 | else:
91 | parent.add(name=node_path, mode=node.mode, hexsha=blob.id)
92 |
93 | new_trees.append(parent)
94 | # Update ancestors
95 | for parent, tree, path in reversed([(a[1], b[1], b[0]) for a, b in
96 | zip(ancestors, ancestors[1:])]):
97 | parent[path] = DIRMOD, tree.id
98 | object_store.add_object(tree)
99 |
100 | object_store.add_object(blob)
101 | for tree in new_trees:
102 | object_store.add_object(tree)
103 | for node in self.removed:
104 | paths = node.path.split('/')
105 | tree = commit_tree
106 | trees = [tree]
107 | # Traverse deep into the forest...
108 | for path in paths:
109 | try:
110 | obj = self.repository._repo[tree[path][1]]
111 | if isinstance(obj, objects.Tree):
112 | trees.append(obj)
113 | tree = obj
114 | except KeyError:
115 | break
116 | # Cut down the blob and all rotten trees on the way back...
117 | for path, tree in reversed(zip(paths, trees)):
118 | del tree[path]
119 | if tree:
120 | # This tree still has elements - don't remove it or any
121 | # of it's parents
122 | break
123 |
124 | object_store.add_object(commit_tree)
125 |
126 | # Create commit
127 | commit = objects.Commit()
128 | commit.tree = commit_tree.id
129 | commit.parents = [p._commit.id for p in self.parents if p]
130 | commit.author = commit.committer = safe_str(author)
131 | commit.encoding = ENCODING
132 | commit.message = safe_str(message)
133 |
134 | # Compute date
135 | if date is None:
136 | date = time.time()
137 | elif isinstance(date, datetime.datetime):
138 | date = time.mktime(date.timetuple())
139 |
140 | author_time = kwargs.pop('author_time', date)
141 | commit.commit_time = int(date)
142 | commit.author_time = int(author_time)
143 | tz = time.timezone
144 | author_tz = kwargs.pop('author_timezone', tz)
145 | commit.commit_timezone = tz
146 | commit.author_timezone = author_tz
147 |
148 | object_store.add_object(commit)
149 |
150 | ref = 'refs/heads/%s' % branch
151 | repo.refs[ref] = commit.id
152 |
153 | # Update vcs repository object & recreate dulwich repo
154 | self.repository.revisions.append(commit.id)
155 | # invalidate parsed refs after commit
156 | self.repository._parsed_refs = self.repository._get_parsed_refs()
157 | tip = self.repository.get_changeset()
158 | self.reset()
159 | return tip
160 |
161 | def _get_missing_trees(self, path, root_tree):
162 | """
163 | Creates missing ``Tree`` objects for the given path.
164 |
165 | :param path: path given as a string. It may be a path to a file node
166 | (i.e. ``foo/bar/baz.txt``) or directory path - in that case it must
167 | end with slash (i.e. ``foo/bar/``).
168 | :param root_tree: ``dulwich.objects.Tree`` object from which we start
169 | traversing (should be commit's root tree)
170 | """
171 | dirpath = posixpath.split(path)[0]
172 | dirs = dirpath.split('/')
173 | if not dirs or dirs == ['']:
174 | return []
175 |
176 | def get_tree_for_dir(tree, dirname):
177 | for name, mode, id in tree.iteritems():
178 | if name == dirname:
179 | obj = self.repository._repo[id]
180 | if isinstance(obj, objects.Tree):
181 | return obj
182 | else:
183 | raise RepositoryError("Cannot create directory %s "
184 | "at tree %s as path is occupied and is not a "
185 | "Tree" % (dirname, tree))
186 | return None
187 |
188 | trees = []
189 | parent = root_tree
190 | for dirname in dirs:
191 | tree = get_tree_for_dir(parent, dirname)
192 | if tree is None:
193 | tree = objects.Tree()
194 | dirmode = 040000
195 | parent.add(dirmode, dirname, tree.id)
196 | parent = tree
197 | # Always append tree
198 | trees.append(tree)
199 | return trees
200 |
--------------------------------------------------------------------------------
/vcs/tests/test_cli.py:
--------------------------------------------------------------------------------
1 | from __future__ import with_statement
2 |
3 | import datetime
4 | import logging
5 |
6 | import mock
7 | import sys
8 | import subprocess
9 | import vcs
10 | import vcs.cli
11 | from contextlib import nested
12 | from StringIO import StringIO
13 | from vcs.cli import BaseCommand
14 | from vcs.cli import ExecutionManager
15 | from vcs.cli import make_option
16 | from vcs.nodes import FileNode
17 | from vcs.tests.base import BackendTestMixin
18 | from vcs.tests.conf import SCM_TESTS
19 | from vcs.utils.compat import unittest
20 |
21 |
22 | class DummyExecutionManager(ExecutionManager):
23 |
24 | def get_vcsrc(self):
25 | return None
26 |
27 |
28 | class TestExecutionManager(unittest.TestCase):
29 |
30 | def test_default_argv(self):
31 | with mock.patch.object(sys, 'argv', ['vcs', 'foo', 'bar']):
32 | manager = DummyExecutionManager()
33 | self.assertEqual(manager.argv, ['foo', 'bar'])
34 |
35 | def test_default_prog_name(self):
36 | with mock.patch.object(sys, 'argv', ['vcs', 'foo', 'bar']):
37 | manager = DummyExecutionManager()
38 | self.assertEqual(manager.prog_name, 'vcs')
39 |
40 | def test_default_stdout(self):
41 | stream = StringIO()
42 | with mock.patch.object(sys, 'stdout', stream):
43 | manager = DummyExecutionManager()
44 | self.assertEqual(manager.stdout, stream)
45 |
46 | def test_default_stderr(self):
47 | stream = StringIO()
48 | with mock.patch.object(sys, 'stderr', stream):
49 | manager = DummyExecutionManager()
50 | self.assertEqual(manager.stderr, stream)
51 |
52 | def test_get_vcsrc(self):
53 | with nested(mock.patch('vcs.conf.settings.VCSRC_PATH', 'foobar'),
54 | mock.patch('vcs.cli.create_module')) as (VP, m):
55 | # Use not-dummy manager here as we need to test get_vcsrc behavior
56 | m.return_value = mock.Mock()
57 | manager = ExecutionManager()
58 | self.assertEqual(manager.vimrc, m.return_value)
59 | m.assert_called_once_with('vcsrc', 'foobar')
60 |
61 | def test_get_command_class(self):
62 | with mock.patch.object(vcs.cli, 'registry', {
63 | 'foo': 'decimal.Decimal',
64 | 'bar': 'socket.socket'}):
65 | manager = DummyExecutionManager()
66 | from decimal import Decimal
67 | from socket import socket
68 | self.assertEqual(manager.get_command_class('foo'), Decimal)
69 | self.assertEqual(manager.get_command_class('bar'), socket)
70 |
71 | def test_get_commands(self):
72 | with mock.patch.object(vcs.cli, 'registry', {
73 | 'mock': mock,
74 | 'foo': 'vcs.cli.BaseCommand',
75 | 'bar': 'vcs.tests.test_cli.DummyExecutionManager'}):
76 | manager = DummyExecutionManager()
77 |
78 | self.assertItemsEqual(manager.get_commands(), {
79 | 'foo': BaseCommand,
80 | 'bar': DummyExecutionManager,
81 | 'mock': mock,
82 | })
83 |
84 | def test_run_command(self):
85 | manager = DummyExecutionManager(stdout=StringIO(),
86 | stderr=StringIO())
87 |
88 | class Command(BaseCommand):
89 |
90 | def run_from_argv(self, argv):
91 | self.stdout.write(u'foo')
92 | self.stderr.write(u'bar')
93 |
94 | with mock.patch.object(manager, 'get_command_class') as m:
95 | m.return_value = Command
96 | manager.run_command('cmd', manager.argv)
97 | self.assertEqual(manager.stdout.getvalue(), u'foo')
98 | self.assertEqual(manager.stderr.getvalue(), u'bar')
99 |
100 | def test_execute_calls_run_command_if_argv_given(self):
101 | manager = DummyExecutionManager(argv=['vcs', 'show', '-h'])
102 | manager.run_command = mock.Mock()
103 | manager.execute()
104 | # we also check argv passed to the command
105 | manager.run_command.assert_called_once_with('show',
106 | ['vcs', 'show', '-h'])
107 |
108 | def test_execute_calls_show_help_if_argv_not_given(self):
109 | manager = DummyExecutionManager(argv=['vcs'])
110 | manager.show_help = mock.Mock()
111 | manager.execute()
112 | manager.show_help.assert_called_once_with()
113 |
114 | def test_show_help_writes_to_stdout(self):
115 | manager = DummyExecutionManager(stdout=StringIO(), stderr=StringIO())
116 | manager.show_help()
117 | self.assertGreater(len(manager.stdout.getvalue()), 0)
118 |
119 |
120 | class TestBaseCommand(unittest.TestCase):
121 |
122 | def test_default_stdout(self):
123 | stream = StringIO()
124 | with mock.patch.object(sys, 'stdout', stream):
125 | command = BaseCommand()
126 | command.stdout.write(u'foobar')
127 | self.assertEqual(sys.stdout.getvalue(), u'foobar')
128 |
129 | def test_default_stderr(self):
130 | stream = StringIO()
131 | with mock.patch.object(sys, 'stderr', stream):
132 | command = BaseCommand()
133 | command.stderr.write(u'foobar')
134 | self.assertEqual(sys.stderr.getvalue(), u'foobar')
135 |
136 | def test_get_version(self):
137 | command = BaseCommand()
138 | self.assertEqual(command.get_version(), vcs.get_version())
139 |
140 | def test_usage(self):
141 | command = BaseCommand()
142 | command.args = 'foo'
143 | self.assertEqual(command.usage('bar'),
144 | '%prog bar [options] foo')
145 |
146 | def test_get_parser(self):
147 |
148 | class Command(BaseCommand):
149 | option_list = (
150 | make_option('-f', '--foo', action='store', dest='foo',
151 | default='bar'),
152 | )
153 | command = Command()
154 | parser = command.get_parser('vcs', 'cmd')
155 | options, args = parser.parse_args(['-f', 'FOOBAR', 'arg1', 'arg2'])
156 | self.assertEqual(options.__dict__['foo'], 'FOOBAR')
157 | self.assertEqual(args, ['arg1', 'arg2'])
158 |
159 | def test_execute(self):
160 | command = BaseCommand()
161 | command.handle = mock.Mock()
162 | args = ['bar']
163 | kwargs = {'debug': True}
164 | command.execute(*args, **kwargs)
165 | command.handle.assert_called_once_with(*args, **kwargs)
166 |
167 | def test_run_from_argv(self):
168 | command = BaseCommand()
169 | argv = ['vcs', 'foo', '--debug', 'bar', '--traceback']
170 | command.handle = mock.Mock()
171 | command.run_from_argv(argv)
172 | args = ['bar']
173 | kwargs = {'debug': True, 'traceback': True}
174 | command.handle.assert_called_once_with(*args, **kwargs)
175 |
176 |
177 | class RealCliMixin(BackendTestMixin):
178 |
179 | @classmethod
180 | def _get_commits(cls):
181 | commits = [
182 | {
183 | 'message': u'Initial commit',
184 | 'author': u'Joe Doe ',
185 | 'date': datetime.datetime(2010, 1, 1, 20),
186 | 'added': [FileNode('file1', content='Foobar')],
187 | },
188 | {
189 | 'message': u'Added a file',
190 | 'author': u'Joe Doe ',
191 | 'date': datetime.datetime(2010, 1, 1, 20),
192 | 'added': [FileNode('file2', content='Foobar')],
193 | },
194 | ]
195 | return commits
196 |
197 | @unittest.skip("does not work")
198 | def test_log_command(self):
199 | cmd = 'vcs log --template "\$message"'
200 | process = subprocess.Popen(cmd, cwd=self.repo.path, shell=True,
201 | stdout=subprocess.PIPE, stderr=subprocess.PIPE)
202 | so, se = process.communicate()
203 | logging.info('out: %s', so)
204 | logging.info('err: %s', se)
205 | self.assertEqual(process.returncode, 0)
206 | self.assertEqual(so.splitlines(), [
207 | 'Added a file',
208 | 'Initial commit',
209 | ])
210 |
211 |
212 | # For each backend create test case class
213 | for alias in SCM_TESTS:
214 | attrs = {
215 | 'backend_alias': alias,
216 | }
217 | cls_name = ''.join(('%s real cli' % alias).title().split())
218 | bases = (RealCliMixin, unittest.TestCase)
219 | globals()[cls_name] = type(cls_name, bases, attrs)
220 |
221 |
222 | if __name__ == '__main__':
223 | unittest.main()
224 |
--------------------------------------------------------------------------------
/vcs/utils/helpers.py:
--------------------------------------------------------------------------------
1 | """
2 | Utitlites aimed to help achieve mostly basic tasks.
3 | """
4 | from __future__ import division
5 |
6 | import re
7 | import os
8 | import time
9 | import datetime
10 | from subprocess import Popen, PIPE
11 |
12 | from vcs.exceptions import VCSError
13 | from vcs.exceptions import RepositoryError
14 | from vcs.utils.paths import abspath
15 |
16 | ALIASES = ['hg', 'git']
17 |
18 |
19 | def get_scm(path, search_up=False, explicit_alias=None):
20 | """
21 | Returns one of alias from ``ALIASES`` (in order of precedence same as
22 | shortcuts given in ``ALIASES``) and top working dir path for the given
23 | argument. If no scm-specific directory is found or more than one scm is
24 | found at that directory, ``VCSError`` is raised.
25 |
26 | :param search_up: if set to ``True``, this function would try to
27 | move up to parent directory every time no scm is recognized for the
28 | currently checked path. Default: ``False``.
29 | :param explicit_alias: can be one of available backend aliases, when given
30 | it will return given explicit alias in repositories under more than one
31 | version control, if explicit_alias is different than found it will raise
32 | VCSError
33 | """
34 | if not os.path.isdir(path):
35 | raise VCSError("Given path %s is not a directory" % path)
36 |
37 | def get_scms(path):
38 | return [(scm, path) for scm in get_scms_for_path(path)]
39 |
40 | found_scms = get_scms(path)
41 | while not found_scms and search_up:
42 | newpath = abspath(path, '..')
43 | if newpath == path:
44 | break
45 | path = newpath
46 | found_scms = get_scms(path)
47 |
48 | if len(found_scms) > 1:
49 | for scm in found_scms:
50 | if scm[0] == explicit_alias:
51 | return scm
52 | raise VCSError('More than one [%s] scm found at given path %s'
53 | % (','.join((x[0] for x in found_scms)), path))
54 |
55 | if len(found_scms) is 0:
56 | raise VCSError('No scm found at given path %s' % path)
57 |
58 | return found_scms[0]
59 |
60 |
61 | def get_scms_for_path(path):
62 | """
63 | Returns all scm's found at the given path. If no scm is recognized
64 | - empty list is returned.
65 |
66 | :param path: path to directory which should be checked. May be callable.
67 |
68 | :raises VCSError: if given ``path`` is not a directory
69 | """
70 | from vcs.backends import get_backend
71 | if hasattr(path, '__call__'):
72 | path = path()
73 | if not os.path.isdir(path):
74 | raise VCSError("Given path %r is not a directory" % path)
75 |
76 | result = []
77 | for key in ALIASES:
78 | dirname = os.path.join(path, '.' + key)
79 | if os.path.isdir(dirname):
80 | result.append(key)
81 | continue
82 | # We still need to check if it's not bare repository as
83 | # bare repos don't have working directories
84 | try:
85 | get_backend(key)(path)
86 | result.append(key)
87 | continue
88 | except RepositoryError:
89 | # Wrong backend
90 | pass
91 | except VCSError:
92 | # No backend at all
93 | pass
94 | return result
95 |
96 |
97 | def get_repo_paths(path):
98 | """
99 | Returns path's subdirectories which seems to be a repository.
100 | """
101 | repo_paths = []
102 | dirnames = (os.path.abspath(dirname) for dirname in os.listdir(path))
103 | for dirname in dirnames:
104 | try:
105 | get_scm(dirname)
106 | repo_paths.append(dirname)
107 | except VCSError:
108 | pass
109 | return repo_paths
110 |
111 |
112 | def run_command(cmd, *args):
113 | """
114 | Runs command on the system with given ``args``.
115 | """
116 | command = ' '.join((cmd, args))
117 | p = Popen(command, shell=True, stdout=PIPE, stderr=PIPE)
118 | stdout, stderr = p.communicate()
119 | return p.retcode, stdout, stderr
120 |
121 |
122 | def get_highlighted_code(name, code, type='terminal'):
123 | """
124 | If pygments are available on the system
125 | then returned output is colored. Otherwise
126 | unchanged content is returned.
127 | """
128 | import logging
129 | try:
130 | import pygments
131 | pygments
132 | except ImportError:
133 | return code
134 | from pygments import highlight
135 | from pygments.lexers import guess_lexer_for_filename, ClassNotFound
136 | from pygments.formatters import TerminalFormatter
137 |
138 | try:
139 | lexer = guess_lexer_for_filename(name, code)
140 | formatter = TerminalFormatter()
141 | content = highlight(code, lexer, formatter)
142 | except ClassNotFound:
143 | logging.debug("Couldn't guess Lexer, will not use pygments.")
144 | content = code
145 | return content
146 |
147 |
148 | def parse_changesets(text):
149 | """
150 | Returns dictionary with *start*, *main* and *end* ids.
151 |
152 | Examples::
153 |
154 | >>> parse_changesets('aaabbb')
155 | {'start': None, 'main': 'aaabbb', 'end': None}
156 | >>> parse_changesets('aaabbb..cccddd')
157 | {'start': 'aaabbb', 'main': None, 'end': 'cccddd'}
158 |
159 | """
160 | text = text.strip()
161 | CID_RE = r'[a-zA-Z0-9]+'
162 | if not '..' in text:
163 | m = re.match(r'^(?P%s)$' % CID_RE, text)
164 | if m:
165 | return {
166 | 'start': None,
167 | 'main': text,
168 | 'end': None,
169 | }
170 | else:
171 | RE = r'^(?P%s)?\.{2,3}(?P%s)?$' % (CID_RE, CID_RE)
172 | m = re.match(RE, text)
173 | if m:
174 | result = m.groupdict()
175 | result['main'] = None
176 | return result
177 | raise ValueError("IDs not recognized")
178 |
179 |
180 | def parse_datetime(text):
181 | """
182 | Parses given text and returns ``datetime.datetime`` instance or raises
183 | ``ValueError``.
184 |
185 | :param text: string of desired date/datetime or something more verbose,
186 | like *yesterday*, *2weeks 3days*, etc.
187 | """
188 |
189 | text = text.strip().lower()
190 |
191 | INPUT_FORMATS = (
192 | '%Y-%m-%d %H:%M:%S',
193 | '%Y-%m-%d %H:%M',
194 | '%Y-%m-%d',
195 | '%m/%d/%Y %H:%M:%S',
196 | '%m/%d/%Y %H:%M',
197 | '%m/%d/%Y',
198 | '%m/%d/%y %H:%M:%S',
199 | '%m/%d/%y %H:%M',
200 | '%m/%d/%y',
201 | )
202 | for format in INPUT_FORMATS:
203 | try:
204 | return datetime.datetime(*time.strptime(text, format)[:6])
205 | except ValueError:
206 | pass
207 |
208 | # Try descriptive texts
209 | if text == 'tomorrow':
210 | future = datetime.datetime.now() + datetime.timedelta(days=1)
211 | args = future.timetuple()[:3] + (23, 59, 59)
212 | return datetime.datetime(*args)
213 | elif text == 'today':
214 | return datetime.datetime(*datetime.datetime.today().timetuple()[:3])
215 | elif text == 'now':
216 | return datetime.datetime.now()
217 | elif text == 'yesterday':
218 | past = datetime.datetime.now() - datetime.timedelta(days=1)
219 | return datetime.datetime(*past.timetuple()[:3])
220 | else:
221 | days = 0
222 | matched = re.match(
223 | r'^((?P\d+) ?w(eeks?)?)? ?((?P\d+) ?d(ays?)?)?$', text)
224 | if matched:
225 | groupdict = matched.groupdict()
226 | if groupdict['days']:
227 | days += int(matched.groupdict()['days'])
228 | if groupdict['weeks']:
229 | days += int(matched.groupdict()['weeks']) * 7
230 | past = datetime.datetime.now() - datetime.timedelta(days=days)
231 | return datetime.datetime(*past.timetuple()[:3])
232 |
233 | raise ValueError('Wrong date: "%s"' % text)
234 |
235 |
236 | def get_dict_for_attrs(obj, attrs):
237 | """
238 | Returns dictionary for each attribute from given ``obj``.
239 | """
240 | data = {}
241 | for attr in attrs:
242 | data[attr] = getattr(obj, attr)
243 | return data
244 |
245 |
246 | def get_total_seconds(timedelta):
247 | """
248 | Backported for Python 2.5.
249 |
250 | See http://docs.python.org/library/datetime.html.
251 | """
252 | return ((timedelta.microseconds + (
253 | timedelta.seconds +
254 | timedelta.days * 24 * 60 * 60
255 | ) * 10**6) / 10**6)
256 |
--------------------------------------------------------------------------------
/vcs/tests/test_utils_progressbar.py:
--------------------------------------------------------------------------------
1 | from __future__ import with_statement
2 |
3 | import sys
4 | import datetime
5 | from StringIO import StringIO
6 | from vcs.utils.helpers import get_total_seconds
7 | from vcs.utils.progressbar import AlreadyFinishedError
8 | from vcs.utils.progressbar import ProgressBar
9 | from vcs.utils.compat import unittest
10 |
11 |
12 | class TestProgressBar(unittest.TestCase):
13 |
14 | def test_default_get_separator(self):
15 | bar = ProgressBar()
16 | bar.separator = '\t'
17 | self.assertEquals(bar.get_separator(), '\t')
18 |
19 | def test_cast_to_str(self):
20 | bar = ProgressBar()
21 | self.assertEquals(str(bar), bar.get_line())
22 |
23 | def test_default_get_bar_char(self):
24 | bar = ProgressBar()
25 | bar.bar_char = '#'
26 | self.assertEquals(bar.get_bar_char(), '#')
27 |
28 | def test_default_get_elements(self):
29 | bar = ProgressBar(elements=['foo', 'bar'])
30 | self.assertItemsEqual(bar.get_elements(), ['foo', 'bar'])
31 |
32 | def test_get_template(self):
33 | bar = ProgressBar()
34 | bar.elements = ['foo', 'bar']
35 | bar.separator = ' '
36 | self.assertEquals(bar.get_template().template, '$foo $bar')
37 |
38 | def test_default_stream_is_sys_stderr(self):
39 | bar = ProgressBar()
40 | self.assertEquals(bar.stream, sys.stderr)
41 |
42 | def test_get_percentage(self):
43 | bar = ProgressBar()
44 | bar.steps = 120
45 | bar.step = 60
46 | self.assertEquals(bar.get_percentage(), 50.0)
47 | bar.steps = 100
48 | bar.step = 9
49 | self.assertEquals(bar.get_percentage(), 9.0)
50 |
51 | def test_get_rendered_percentage(self):
52 | bar = ProgressBar()
53 | bar.steps = 100
54 | bar.step = 10.5
55 | self.assertEquals(bar.get_percentage(), 10.5)
56 |
57 | def test_bar_width(self):
58 | bar = ProgressBar()
59 | bar.width = 30
60 | self.assertEquals(len(bar.get_bar()), 30)
61 |
62 | def test_write(self):
63 | stream = StringIO()
64 | bar = ProgressBar()
65 | bar.stream = stream
66 | bar.write('foobar')
67 | self.assertEquals(stream.getvalue(), 'foobar')
68 |
69 | def test_change_stream(self):
70 | stream1 = StringIO()
71 | stream2 = StringIO()
72 | bar = ProgressBar()
73 | bar.stream = stream1
74 | bar.write('foo')
75 | bar.stream = stream2
76 | bar.write('bar')
77 | self.assertEquals(stream2.getvalue(), 'bar')
78 |
79 | def test_render_writes_new_line_at_last_step(self):
80 | bar = ProgressBar()
81 | bar.stream = StringIO()
82 | bar.steps = 5
83 | bar.render(5)
84 | self.assertEquals(bar.stream.getvalue()[-1], '\n')
85 |
86 | def test_initial_step_is_zero(self):
87 | bar = ProgressBar()
88 | self.assertEquals(bar.step, 0)
89 |
90 | def test_iter_starts_from_current_step(self):
91 | bar = ProgressBar()
92 | bar.stream = StringIO()
93 | bar.steps = 20
94 | bar.step = 5
95 | stepped = list(bar)
96 | self.assertEquals(stepped[0], 5)
97 |
98 | def test_iter_ends_at_last_step(self):
99 | bar = ProgressBar()
100 | bar.stream = StringIO()
101 | bar.steps = 20
102 | bar.step = 5
103 | stepped = list(bar)
104 | self.assertEquals(stepped[-1], 20)
105 |
106 | def test_get_total_time(self):
107 | bar = ProgressBar()
108 | now = datetime.datetime.now()
109 | bar.started = now - datetime.timedelta(days=1)
110 | self.assertEqual(bar.get_total_time(now), datetime.timedelta(days=1))
111 |
112 | def test_get_total_time_returns_empty_timedelta_if_not_yet_started(self):
113 | bar = ProgressBar()
114 | self.assertEquals(bar.get_total_time(), datetime.timedelta())
115 |
116 | def test_get_render_total_time(self):
117 | p = ProgressBar()
118 | p.time_label = 'FOOBAR'
119 | self.assertTrue(p.get_rendered_total_time().startswith('FOOBAR'))
120 |
121 | def test_get_eta(self):
122 | bar = ProgressBar(100)
123 | bar.stream = StringIO()
124 |
125 | bar.render(50)
126 | now = datetime.datetime.now()
127 | delta = now - bar.started
128 | self.assertEquals(get_total_seconds(bar.get_eta(now)),
129 | int(get_total_seconds(delta) * 0.5))
130 |
131 | bar.render(75)
132 | now = datetime.datetime.now()
133 | delta = now - bar.started
134 | self.assertEquals(get_total_seconds(bar.get_eta(now)),
135 | int(get_total_seconds(delta) * 0.25))
136 |
137 | def test_get_rendered_eta(self):
138 | bar = ProgressBar(100)
139 | bar.eta_label = 'foobar'
140 | self.assertTrue(bar.get_rendered_eta().startswith('foobar'))
141 |
142 | def test_get_rendered_steps(self):
143 | bar = ProgressBar(100)
144 | bar.steps_label = 'foobar'
145 | self.assertTrue(bar.get_rendered_steps().startswith('foobar'))
146 |
147 | def test_get_rendered_speed_respects_speed_label(self):
148 | bar = ProgressBar(100)
149 | bar.speed_label = 'foobar'
150 | self.assertTrue(bar.get_rendered_speed().startswith('foobar'))
151 |
152 | def test_get_rendered_speed(self):
153 | B = 1
154 | KB = B * 1024
155 | MB = KB * 1024
156 | GB = MB * 1024
157 |
158 | bar = ProgressBar(KB)
159 | self.assertEqual(bar.get_rendered_speed(512, 1), 'Speed: 512 B/s')
160 | self.assertEqual(bar.get_rendered_speed(512, 2), 'Speed: 256 B/s')
161 | self.assertEqual(bar.get_rendered_speed(900, 3), 'Speed: 300 B/s')
162 |
163 | bar = ProgressBar(GB * 10)
164 | self.assertEqual(bar.get_rendered_speed(KB, 1), 'Speed: 1 KB/s')
165 | self.assertEqual(bar.get_rendered_speed(MB, 1), 'Speed: 1.0 MB/s')
166 | self.assertEqual(bar.get_rendered_speed(GB * 4, 2), 'Speed: 2.00 GB/s')
167 | self.assertEqual(bar.get_rendered_speed(GB * 5, 2), 'Speed: 2.50 GB/s')
168 |
169 | def test_get_rendered_transfer_respects_transfer_label(self):
170 | bar = ProgressBar(100)
171 | bar.transfer_label = 'foobar'
172 | self.assertTrue(bar.get_rendered_transfer(0).startswith('foobar'))
173 | self.assertTrue(bar.get_rendered_transfer(10).startswith('foobar'))
174 |
175 | def test_get_rendered_transfer(self):
176 | B = 1
177 | KB = B * 1024
178 | MB = KB * 1024
179 | GB = MB * 1024
180 |
181 | bar = ProgressBar()
182 | self.assertEqual(bar.get_rendered_transfer(12, 100),
183 | 'Transfer: 12 B / 100 B')
184 | self.assertEqual(bar.get_rendered_transfer(KB * 5, MB),
185 | 'Transfer: 5 KB / 1.0 MB')
186 | self.assertEqual(bar.get_rendered_transfer(GB * 2.3, GB * 10),
187 | 'Transfer: 2.30 GB / 10.00 GB')
188 |
189 |
190 | def test_context(self):
191 | bar = ProgressBar()
192 | context = bar.get_context()
193 | self.assertItemsEqual(context, [
194 | 'bar',
195 | 'percentage',
196 | 'time',
197 | 'eta',
198 | 'steps',
199 | 'speed',
200 | 'transfer',
201 | ])
202 |
203 | def test_context_has_correct_bar(self):
204 | bar = ProgressBar()
205 | context = bar.get_context()
206 | self.assertEquals(context['bar'], bar.get_bar())
207 |
208 | def test_context_has_correct_percentage(self):
209 | bar = ProgressBar(100)
210 | bar.step = 50
211 | percentage = bar.get_context()['percentage']
212 | self.assertEquals(percentage, bar.get_rendered_percentage())
213 |
214 | def test_context_has_correct_total_time(self):
215 | bar = ProgressBar(100)
216 | time = bar.get_context()['time']
217 | self.assertEquals(time, bar.get_rendered_total_time())
218 |
219 | def test_context_has_correct_eta(self):
220 | bar = ProgressBar(100)
221 | eta = bar.get_context()['eta']
222 | self.assertEquals(eta, bar.get_rendered_eta())
223 |
224 | def test_context_has_correct_steps(self):
225 | bar = ProgressBar(100)
226 | steps = bar.get_context()['steps']
227 | self.assertEquals(steps, bar.get_rendered_steps())
228 |
229 | def context_has_correct_speed(self):
230 | bar = ProgressBar(100)
231 | speed = bar.get_context()['speed']
232 | self.assertEquals(speed, bar.get_rendered_speed())
233 |
234 | def test_render_raises_error_if_bar_already_finished(self):
235 | bar = ProgressBar(10)
236 | bar.stream = StringIO()
237 | bar.render(10)
238 |
239 | with self.assertRaises(AlreadyFinishedError):
240 | bar.render(0)
241 |
242 |
243 | if __name__ == '__main__':
244 | unittest.main()
245 |
--------------------------------------------------------------------------------
/docs/quickstart.rst:
--------------------------------------------------------------------------------
1 | .. _quickstart:
2 |
3 | Quickstart
4 | ==========
5 |
6 | Say you don't want to install ``vcs`` or just want to begin with really fast
7 | tutorial? Not a problem, just follow sections below.
8 |
9 | Prepare
10 | -------
11 |
12 | We will try to show you how you can use ``vcs`` directly on repository. But
13 | hey, ``vcs`` is maintained within git `repository
14 | `_ already, so why not use it? Simply run
15 | following commands in your shell
16 |
17 | .. code-block:: bash
18 |
19 | cd /tmp
20 | git clone git://github.com/codeinn/vcs.git
21 | cd vcs
22 |
23 | Now run your python interpreter of choice::
24 |
25 | $ python
26 | >>>
27 |
28 | .. note::
29 | You may of course put your clone of ``vcs`` wherever you like but running
30 | python shell *inside* of it would allow you to use just cloned version of
31 | ``vcs``.
32 |
33 | Take the shortcut
34 | -----------------
35 |
36 | There is no need to import everything from ``vcs`` - in fact, all you'd need is
37 | to import ``get_repo``, at least for now. Then, simply initialize repository
38 | object by providing it's type and path.
39 |
40 | .. code-block:: python
41 |
42 | >>> import vcs
43 | >>> # create repository representation at current dir
44 | >>> repo = vcs.get_repo(path='')
45 |
46 | .. note::
47 | In above example we didn't specify scm. We can provide as second argument to
48 | the ``get_repo`` function, i.e. ``get_repo('', 'hg')``.
49 |
50 | Basics
51 | ------
52 |
53 | Let's ask repo about the content...
54 |
55 | .. code-block:: python
56 |
57 | >>> root = repo.get_changeset().get_node('')
58 | >>> print root.nodes # prints nodes of the RootNode
59 | [, , , # ... (chopped)
60 | >>>
61 | >>> # get 10th changeset
62 | >>> chset = repo.get_changeset(10)
63 | >>> print chset
64 |
65 | >>>
66 | >>> # any backend would return latest changeset if revision is not given
67 | >>> tip = repo.get_changeset()
68 | >>> tip == repo.get_changeset('tip') # for git/mercurial backend 'tip' is allowed
69 | True
70 | >>> tip == repo.get_changeset(None) # any backend allow revision to be None (default)
71 | True
72 | >>> tip.raw_id == repo.revisions[-1]
73 | True
74 | >>>
75 | >>> # Iterate repository
76 | >>> for cs in repo:
77 | ... print cs
78 | ...
79 | ...
80 | >>>
81 | >>>
82 | >>> ...
83 |
84 | Walking
85 | -------
86 |
87 | Now let's ask for nodes at revision faebbb751cc36c137127c50f57bcdb5f1c540013
88 | (https://github.com/codeinn/vcs/commit/faebbb751cc36c137127c50f57bcdb5f1c540013)
89 |
90 | .. code-block:: python
91 |
92 | >>> chset = repo.get_changeset('faebbb751cc36c137127c50f57bcdb5f1c540013')
93 | >>> root = chset.root
94 | >>> print root.dirs
95 | [, , ]
96 |
97 | .. note::
98 |
99 | :ref:`api-nodes` are objects representing files and directories within the
100 | repository revision.
101 |
102 | .. code-block:: python
103 |
104 | >>> # Fetch vcs directory
105 | >>> vcs = repo.get_changeset('faebbb751cc36c137127c50f57bcdb5f1c540013').get_node('vcs')
106 | >>> print vcs.dirs
107 | [,
108 | ,
109 | ]
110 |
111 | >>> backends_node = vcs.dirs[0]
112 | >>> print backends_node.nodes
113 | [,
114 | ,
115 | ,
116 | ]
117 |
118 | >>> print '\n'.join(backends_node.files[0].content.splitlines()[:4])
119 | # -*- coding: utf-8 -*-
120 | """
121 | vcs.backends
122 | ~~~~~~~~~~~~
123 |
124 |
125 | Getting meta data
126 | -----------------
127 |
128 | Make ``vcs`` show us some meta information
129 |
130 | Tags and branches
131 | ~~~~~~~~~~~~~~~~~
132 |
133 | .. code-block:: python
134 |
135 | >>> print repo.branches
136 | OrderedDict([('master', 'fe568b4081755c12abf6ba673ba777fc02a415f3')])
137 | >>> for tag, raw_id in repo.tags.items():
138 | ... print tag.rjust(10), '|', raw_id
139 | ...
140 | v0.1.9 | 341d28f0eec5ddf0b6b77871e13c2bbd6bec685c
141 | v0.1.8 | 74ebce002c088b8a5ecf40073db09375515ecd68
142 | v0.1.7 | 4d78bf73b5c22c82b68f902f138f7881b4fffa2c
143 | v0.1.6 | 0205cb3f44223fb3099d12a77a69c81b798772d9
144 | v0.1.5 | 6c0ce52b229aa978889e91b38777f800e85f330b
145 | v0.1.4 | 7d735150934cd7645ac3051903add952390324a5
146 | v0.1.3 | 5a3a8fb005554692b16e21dee62bf02667d8dc3e
147 | v0.1.2 | 0ba5f8a4660034ff25c0cac2a5baabf5d2791d63
148 | v0.1.11 | c60f01b77c42dce653d6b1d3b04689862c261929
149 | v0.1.10 | 10cddef6b794696066fb346434014f0a56810218
150 | v0.1.1 | e6ea6d16e2f26250124a1f4b4fe37a912f9d86a0
151 |
152 | Give me a file, finally!
153 | ~~~~~~~~~~~~~~~~~~~~~~~~
154 |
155 | .. code-block:: python
156 |
157 | >>> import vcs
158 | >>> repo = vcs.get_repo('')
159 | >>> chset = repo.get_changeset('faebbb751cc36c137127c50f57bcdb5f1c540013')
160 | >>> root = chset.get_node('')
161 | >>> backends = root.get_node('vcs/backends')
162 | >>> backends.files
163 | [,
164 | ,
165 | ,
166 | ]
167 | >>> f = backends.get_node('hg.py')
168 | >>> f.name
169 | 'hg.py'
170 | >>> f.path
171 | 'vcs/backends/hg.py'
172 | >>> f.size
173 | 28549
174 | >>> f.last_changeset
175 |
176 | >>> f.last_changeset.date
177 | datetime.datetime(2011, 2, 28, 23, 23, 5)
178 | >>> f.last_changeset.message
179 | u'fixed bug in get_changeset when 0 or None was passed'
180 | >>> f.last_changeset.author
181 | u'marcinkuzminski '
182 | >>> f.mimetype
183 | 'text/x-python'
184 | >>> # Following would raise exception unless you have pygments installed
185 | >>> f.lexer
186 |
187 | >>> f.lexer_alias # shortcut to get first of lexers' available aliases
188 | 'python'
189 | >>> # wanna go back? why? oh, whatever...
190 | >>> f.parent
191 |
192 | >>>
193 | >>> # is it cached? Hell yeah...
194 | >>> f is f.parent.get_node('hg.py') is chset.get_node('vcs/backends/hg.py')
195 | True
196 |
197 | How about history?
198 | ~~~~~~~~~~~~~~~~~~
199 |
200 | It is possible to retrieve changesets for which file node has been changed and
201 | this is pretty damn simple. Let's say we want to see history of the file located
202 | at ``vcs/nodes.py``.
203 |
204 | .. code-block:: python
205 |
206 | >>> f = repo.get_changeset().get_node('vcs/nodes.py')
207 | >>> for cs in f.history:
208 | ... print cs
209 | ...
210 |
211 |
212 |
213 |
214 |
215 |
216 |
217 |
218 |
219 |
220 |
221 |
222 |
223 |
224 |
225 |
226 |
227 |
228 |
229 |
230 |
231 |
232 |
233 |
234 |
235 |
236 |
237 |
238 |
239 |
240 |
241 |
242 |
243 |
244 |
245 |
246 |
247 |
248 |
249 |
250 |
251 |
252 |
253 |
254 |
255 |
256 |
257 |
258 |
259 |
260 |
261 |
262 |
263 |
264 |
265 | Note that ``history`` attribute is computed lazily and returned list is reversed
266 | - changesets are retrieved from most recent to oldest.
267 |
268 | Show me the difference!
269 | ~~~~~~~~~~~~~~~~~~~~~~~
270 |
271 | Here we present naive implementation of diff table for the given file node
272 | located at ``vcs/nodes.py``. First we have to get the node from repository.
273 | After that we retrieve last changeset for which the file has been modified
274 | and we create a html file using `difflib`_.
275 |
276 | .. code-block:: python
277 |
278 | >>> new = repo.get_changeset(repo.tags['v0.1.11'])
279 | >>> old = repo.get_changeset(repo.tags['v0.1.10'])
280 | >>> f_old = old.get_node('vcs/nodes.py')
281 | >>> f_new = new.get_node('vcs/nodes.py')
282 | >>> f_old = repo.get_changeset(81).get_node(f.path)
283 | >>> out = open('/tmp/out.html', 'w')
284 | >>> from difflib import HtmlDiff
285 | >>> hd = HtmlDiff(tabsize=4)
286 | >>> diffs = hd.make_file(f_new.content.split('\n'), f_old.content.split('\n'))
287 | >>> out.write(diffs)
288 | >>> out.close()
289 |
290 | Now open file at ``/tmp/out.html`` in your favorite browser.
291 |
292 | .. _difflib: http://docs.python.org/library/difflib.html
293 |
--------------------------------------------------------------------------------
/vcs/tests/test_utils.py:
--------------------------------------------------------------------------------
1 | from __future__ import with_statement
2 |
3 | import os
4 | import mock
5 | import time
6 | import shutil
7 | import tempfile
8 | import datetime
9 | from vcs.utils.compat import unittest
10 | from vcs.utils.paths import get_dirs_for_path
11 | from vcs.utils.helpers import get_dict_for_attrs
12 | from vcs.utils.helpers import get_scm
13 | from vcs.utils.helpers import get_scms_for_path
14 | from vcs.utils.helpers import get_total_seconds
15 | from vcs.utils.helpers import parse_changesets
16 | from vcs.utils.helpers import parse_datetime
17 | from vcs.utils import author_email, author_name
18 | from vcs.utils.paths import get_user_home
19 | from vcs.exceptions import VCSError
20 |
21 | from vcs.tests.conf import TEST_HG_REPO, TEST_GIT_REPO, TEST_TMP_PATH
22 |
23 |
24 | class PathsTest(unittest.TestCase):
25 |
26 | def _test_get_dirs_for_path(self, path, expected):
27 | """
28 | Tests if get_dirs_for_path returns same as expected.
29 | """
30 | expected = sorted(expected)
31 | result = sorted(get_dirs_for_path(path))
32 | self.assertEqual(result, expected,
33 | msg="%s != %s which was expected result for path %s"
34 | % (result, expected, path))
35 |
36 | def test_get_dirs_for_path(self):
37 | path = 'foo/bar/baz/file'
38 | paths_and_results = (
39 | ('foo/bar/baz/file', ['foo', 'foo/bar', 'foo/bar/baz']),
40 | ('foo/bar/', ['foo', 'foo/bar']),
41 | ('foo/bar', ['foo']),
42 | )
43 | for path, expected in paths_and_results:
44 | self._test_get_dirs_for_path(path, expected)
45 |
46 |
47 | def test_get_scm(self):
48 | self.assertEqual(('hg', TEST_HG_REPO), get_scm(TEST_HG_REPO))
49 | self.assertEqual(('git', TEST_GIT_REPO), get_scm(TEST_GIT_REPO))
50 |
51 | def test_get_two_scms_for_path(self):
52 | multialias_repo_path = os.path.join(TEST_TMP_PATH, 'hg-git-repo-2')
53 | if os.path.isdir(multialias_repo_path):
54 | shutil.rmtree(multialias_repo_path)
55 |
56 | os.mkdir(multialias_repo_path)
57 |
58 | self.assertRaises(VCSError, get_scm, multialias_repo_path)
59 |
60 | def test_get_scm_error_path(self):
61 | self.assertRaises(VCSError, get_scm, 'err')
62 |
63 | def test_get_scms_for_path(self):
64 | dirpath = tempfile.gettempdir()
65 | new = os.path.join(dirpath, 'vcs-scms-for-path-%s' % time.time())
66 | os.mkdir(new)
67 | self.assertEqual(get_scms_for_path(new), [])
68 |
69 | os.mkdir(os.path.join(new, '.tux'))
70 | self.assertEqual(get_scms_for_path(new), [])
71 |
72 | os.mkdir(os.path.join(new, '.git'))
73 | self.assertEqual(set(get_scms_for_path(new)), set(['git']))
74 |
75 | os.mkdir(os.path.join(new, '.hg'))
76 | self.assertEqual(set(get_scms_for_path(new)), set(['git', 'hg']))
77 |
78 |
79 | class TestParseChangesets(unittest.TestCase):
80 |
81 | def test_main_is_returned_correctly(self):
82 | self.assertEqual(parse_changesets('123456'), {
83 | 'start': None,
84 | 'main': '123456',
85 | 'end': None,
86 | })
87 |
88 | def test_start_is_returned_correctly(self):
89 | self.assertEqual(parse_changesets('aaabbb..'), {
90 | 'start': 'aaabbb',
91 | 'main': None,
92 | 'end': None,
93 | })
94 |
95 | def test_end_is_returned_correctly(self):
96 | self.assertEqual(parse_changesets('..cccddd'), {
97 | 'start': None,
98 | 'main': None,
99 | 'end': 'cccddd',
100 | })
101 |
102 | def test_that_two_or_three_dots_are_allowed(self):
103 | text1 = 'a..b'
104 | text2 = 'a...b'
105 | self.assertEqual(parse_changesets(text1), parse_changesets(text2))
106 |
107 | def test_that_input_is_stripped_first(self):
108 | text1 = 'a..bb'
109 | text2 = ' a..bb\t\n\t '
110 | self.assertEqual(parse_changesets(text1), parse_changesets(text2))
111 |
112 | def test_that_exception_is_raised(self):
113 | text = '123456.789012' # single dot is not recognized
114 | with self.assertRaises(ValueError):
115 | parse_changesets(text)
116 |
117 | def test_non_alphanumeric_raises_exception(self):
118 | with self.assertRaises(ValueError):
119 | parse_changesets('aaa@bbb')
120 |
121 |
122 | class TestParseDatetime(unittest.TestCase):
123 |
124 | def test_datetime_text(self):
125 | self.assertEqual(parse_datetime('2010-04-07 21:29:41'),
126 | datetime.datetime(2010, 4, 7, 21, 29, 41))
127 |
128 | def test_no_seconds(self):
129 | self.assertEqual(parse_datetime('2010-04-07 21:29'),
130 | datetime.datetime(2010, 4, 7, 21, 29))
131 |
132 | def test_date_only(self):
133 | self.assertEqual(parse_datetime('2010-04-07'),
134 | datetime.datetime(2010, 4, 7))
135 |
136 | def test_another_format(self):
137 | self.assertEqual(parse_datetime('04/07/10 21:29:41'),
138 | datetime.datetime(2010, 4, 7, 21, 29, 41))
139 |
140 | def test_now(self):
141 | self.assertTrue(parse_datetime('now') - datetime.datetime.now() <
142 | datetime.timedelta(seconds=1))
143 |
144 | def test_today(self):
145 | today = datetime.date.today()
146 | self.assertEqual(parse_datetime('today'),
147 | datetime.datetime(*today.timetuple()[:3]))
148 |
149 | def test_yesterday(self):
150 | yesterday = datetime.date.today() - datetime.timedelta(days=1)
151 | self.assertEqual(parse_datetime('yesterday'),
152 | datetime.datetime(*yesterday.timetuple()[:3]))
153 |
154 | def test_tomorrow(self):
155 | tomorrow = datetime.date.today() + datetime.timedelta(days=1)
156 | args = tomorrow.timetuple()[:3] + (23, 59, 59)
157 | self.assertEqual(parse_datetime('tomorrow'), datetime.datetime(*args))
158 |
159 | def test_days(self):
160 | timestamp = datetime.datetime.today() - datetime.timedelta(days=3)
161 | args = timestamp.timetuple()[:3] + (0, 0, 0, 0)
162 | expected = datetime.datetime(*args)
163 | self.assertEqual(parse_datetime('3d'), expected)
164 | self.assertEqual(parse_datetime('3 d'), expected)
165 | self.assertEqual(parse_datetime('3 day'), expected)
166 | self.assertEqual(parse_datetime('3 days'), expected)
167 |
168 | def test_weeks(self):
169 | timestamp = datetime.datetime.today() - datetime.timedelta(days=3 * 7)
170 | args = timestamp.timetuple()[:3] + (0, 0, 0, 0)
171 | expected = datetime.datetime(*args)
172 | self.assertEqual(parse_datetime('3w'), expected)
173 | self.assertEqual(parse_datetime('3 w'), expected)
174 | self.assertEqual(parse_datetime('3 week'), expected)
175 | self.assertEqual(parse_datetime('3 weeks'), expected)
176 |
177 | def test_mixed(self):
178 | timestamp = datetime.datetime.today() - datetime.timedelta(days=2 * 7 + 3)
179 | args = timestamp.timetuple()[:3] + (0, 0, 0, 0)
180 | expected = datetime.datetime(*args)
181 | self.assertEqual(parse_datetime('2w3d'), expected)
182 | self.assertEqual(parse_datetime('2w 3d'), expected)
183 | self.assertEqual(parse_datetime('2w 3 days'), expected)
184 | self.assertEqual(parse_datetime('2 weeks 3 days'), expected)
185 |
186 |
187 | class TestAuthorExtractors(unittest.TestCase):
188 | TEST_AUTHORS = [('Marcin Kuzminski ',
189 | ('Marcin Kuzminski', 'marcin@python-works.com')),
190 | ('Marcin Kuzminski Spaces < marcin@python-works.com >',
191 | ('Marcin Kuzminski Spaces', 'marcin@python-works.com')),
192 | ('Marcin Kuzminski ',
193 | ('Marcin Kuzminski', 'marcin.kuzminski@python-works.com')),
194 | ('mrf RFC_SPEC ',
195 | ('mrf RFC_SPEC', 'marcin+kuzminski@python-works.com')),
196 | ('username ',
197 | ('username', 'user@email.com')),
198 | ('username ',
203 | ('', 'justemail@mail.com')),
204 | ('justname',
205 | ('justname', '')),
206 | ('Mr Double Name withemail@email.com ',
207 | ('Mr Double Name', 'withemail@email.com')),
208 | ]
209 |
210 | def test_author_email(self):
211 |
212 | for test_str, result in self.TEST_AUTHORS:
213 | self.assertEqual(result[1], author_email(test_str))
214 |
215 |
216 | def test_author_name(self):
217 |
218 | for test_str, result in self.TEST_AUTHORS:
219 | self.assertEqual(result[0], author_name(test_str))
220 |
221 |
222 | class TestGetDictForAttrs(unittest.TestCase):
223 |
224 | def test_returned_dict_has_expected_attrs(self):
225 | obj = mock.Mock()
226 | obj.NOT_INCLUDED = 'this key/value should not be included'
227 | obj.CONST = True
228 | obj.foo = 'aaa'
229 | obj.attrs = {'foo': 'bar'}
230 | obj.date = datetime.datetime(2010, 12, 31)
231 | obj.count = 1001
232 |
233 | self.assertEqual(get_dict_for_attrs(obj, ['CONST', 'foo', 'attrs',
234 | 'date', 'count']), {
235 | 'CONST': True,
236 | 'foo': 'aaa',
237 | 'attrs': {'foo': 'bar'},
238 | 'date': datetime.datetime(2010, 12, 31),
239 | 'count': 1001,
240 | })
241 |
242 |
243 | class TestGetTotalSeconds(unittest.TestCase):
244 |
245 | def assertTotalSecondsEqual(self, timedelta, expected_seconds):
246 | result = get_total_seconds(timedelta)
247 | self.assertEqual(result, expected_seconds,
248 | "We computed %s seconds for %s but expected %s"
249 | % (result, timedelta, expected_seconds))
250 |
251 | def test_get_total_seconds_returns_proper_value(self):
252 | self.assertTotalSecondsEqual(datetime.timedelta(seconds=1001), 1001)
253 |
254 | def test_get_total_seconds_returns_proper_value_for_partial_seconds(self):
255 | self.assertTotalSecondsEqual(datetime.timedelta(seconds=50.65), 50.65)
256 |
257 |
258 | class TestGetUserHome(unittest.TestCase):
259 |
260 | @mock.patch.object(os, 'environ', {})
261 | def test_defaults_to_none(self):
262 | self.assertEqual(get_user_home(), '')
263 |
264 | @mock.patch.object(os, 'environ', {'HOME': '/home/foobar'})
265 | def test_unix_like(self):
266 | self.assertEqual(get_user_home(), '/home/foobar')
267 |
268 | @mock.patch.object(os, 'environ', {'USERPROFILE': '/Users/foobar'})
269 | def test_windows_like(self):
270 | self.assertEqual(get_user_home(), '/Users/foobar')
271 |
272 | @mock.patch.object(os, 'environ', {'HOME': '/home/foobar',
273 | 'USERPROFILE': '/Users/foobar'})
274 | def test_prefers_home_over_userprofile(self):
275 | self.assertEqual(get_user_home(), '/home/foobar')
276 |
277 |
278 | if __name__ == '__main__':
279 | unittest.main()
280 |
--------------------------------------------------------------------------------
' + 147 | ls + ' | ' +
148 | '') 149 | yield 0, dummyoutfile.getvalue() 150 | yield 0, ' |
' + 166 | ls + '
' + 170 | annotate + '