test: extract unitutil.mock and unitutil.file

Steve Canny · Steve Canny · commit 767e4089fece · 2014-06-28T23:28:43.000-07:00
diff --git a/tests/image/test_bmp.py b/tests/image/test_bmp.py
@@ -12,7 +12,7 @@
 from docx.image.constants import MIME_TYPE
 from docx.image.bmp import Bmp
 
-from ..unitutil import initializer_mock
+from ..unitutil.mock import initializer_mock
 
 
 class DescribeBmp(object):
diff --git a/tests/image/test_gif.py b/tests/image/test_gif.py
@@ -12,7 +12,7 @@
 from docx.image.constants import MIME_TYPE
 from docx.image.gif import Gif
 
-from ..unitutil import initializer_mock
+from ..unitutil.mock import initializer_mock
 
 
 class DescribeGif(object):
diff --git a/tests/image/test_image.py b/tests/image/test_image.py
@@ -18,9 +18,9 @@
 from docx.image.tiff import Tiff
 from docx.opc.constants import CONTENT_TYPE as CT
 
-from ..unitutil import (
-    function_mock, class_mock, initializer_mock, instance_mock, method_mock,
-    test_file
+from ..unitutil.file import test_file
+from ..unitutil.mock import (
+    function_mock, class_mock, initializer_mock, instance_mock, method_mock
 )
 
 
diff --git a/tests/image/test_jpeg.py b/tests/image/test_jpeg.py
@@ -17,7 +17,7 @@
 )
 from docx.image.tiff import Tiff
 
-from ..unitutil import (
+from ..unitutil.mock import (
     call, class_mock, initializer_mock, instance_mock, method_mock
 )
 
diff --git a/tests/image/test_png.py b/tests/image/test_png.py
@@ -17,7 +17,7 @@
     Png, _PngParser
 )
 
-from ..unitutil import (
+from ..unitutil.mock import (
     call, class_mock, function_mock, initializer_mock, instance_mock,
     method_mock
 )
diff --git a/tests/image/test_tiff.py b/tests/image/test_tiff.py
@@ -16,7 +16,7 @@
     _LongIfdEntry, _RationalIfdEntry, _ShortIfdEntry, Tiff, _TiffParser
 )
 
-from ..unitutil import (
+from ..unitutil.mock import (
     call, class_mock, function_mock, initializer_mock, instance_mock,
     loose_mock, method_mock
 )
diff --git a/tests/opc/test_oxml.py b/tests/opc/test_oxml.py
@@ -8,8 +8,8 @@
 from docx.opc.oxml import (
     CT_Default, CT_Override, CT_Relationship, CT_Relationships, CT_Types
 )
+from docx.oxml.xmlchemy import serialize_for_reading
 
-from ..unitutil import actual_xml
 from .unitdata.rels import (
     a_Default, an_Override, a_Relationship, a_Relationships, a_Types
 )
@@ -76,7 +76,7 @@ def it_can_construct_a_new_relationships_element(self):
             '<Relationships xmlns="http://schemas.openxmlformats.org/package'
             '/2006/relationships"/>\n'
         )
-        assert actual_xml(rels) == expected_xml
+        assert serialize_for_reading(rels) == expected_xml
 
     def it_can_build_rels_element_incrementally(self):
         # setup ------------------------
@@ -87,7 +87,7 @@ def it_can_build_rels_element_incrementally(self):
         rels.add_rel('rId3', 'http://reltype2', '../slides/slide1.xml')
         # verify -----------------------
         expected_rels_xml = a_Relationships().xml
-        assert actual_xml(rels) == expected_rels_xml
+        assert serialize_for_reading(rels) == expected_rels_xml
 
     def it_can_generate_rels_file_xml(self):
         expected_xml = (
diff --git a/tests/opc/test_package.py b/tests/opc/test_package.py
@@ -16,7 +16,7 @@
 )
 from docx.opc.pkgreader import PackageReader
 
-from ..unitutil import (
+from ..unitutil.mock import (
     call, class_mock, cls_attr_mock, function_mock, instance_mock,
     loose_mock, method_mock, Mock, patch, PropertyMock
 )
diff --git a/tests/opc/test_phys_pkg.py b/tests/opc/test_phys_pkg.py
@@ -22,7 +22,8 @@
     _DirPkgReader, PhysPkgReader, PhysPkgWriter, _ZipPkgReader, _ZipPkgWriter
 )
 
-from ..unitutil import absjoin, class_mock, loose_mock, Mock, test_file_dir
+from ..unitutil.file import absjoin, test_file_dir
+from ..unitutil.mock import class_mock, loose_mock, Mock
 
 
 test_docx_path = absjoin(test_file_dir, 'test.docx')
diff --git a/tests/opc/test_pkgreader.py b/tests/opc/test_pkgreader.py
@@ -19,7 +19,7 @@
 )
 
 from .unitdata.types import a_Default, a_Types, an_Override
-from ..unitutil import (
+from ..unitutil.mock import (
     call, class_mock, function_mock, initializer_mock, instance_mock,
     loose_mock, method_mock, Mock, patch
 )
diff --git a/tests/opc/test_pkgwriter.py b/tests/opc/test_pkgwriter.py
@@ -13,7 +13,7 @@
 from docx.opc.pkgwriter import _ContentTypesItem, PackageWriter
 
 from .unitdata.types import a_Default, a_Types, an_Override
-from ..unitutil import (
+from ..unitutil.mock import (
     call, class_mock, instance_mock, MagicMock, method_mock, Mock, patch
 )
 
diff --git a/tests/opc/test_rels.py b/tests/opc/test_rels.py
@@ -13,7 +13,7 @@
 from docx.opc.package import Part, _Relationship, Relationships
 from docx.opc.packuri import PackURI
 
-from ..unitutil import (
+from ..unitutil.mock import (
     call, class_mock, instance_mock, loose_mock, Mock, patch, PropertyMock
 )
 
diff --git a/tests/parts/test_document.py b/tests/parts/test_document.py
@@ -28,7 +28,7 @@
     a_gridCol, a_tbl, a_tblGrid, a_tblPr, a_tblW, a_tc, a_tr
 )
 from ..oxml.unitdata.text import a_p, a_pPr, a_sectPr, an_r
-from ..unitutil import (
+from ..unitutil.mock import (
     function_mock, class_mock, initializer_mock, instance_mock, loose_mock,
     method_mock, Mock, property_mock
 )
diff --git a/tests/parts/test_image.py b/tests/parts/test_image.py
@@ -15,9 +15,8 @@
 from docx.package import Package
 from docx.parts.image import ImagePart
 
-from ..unitutil import (
-    initializer_mock, instance_mock, method_mock, test_file
-)
+from ..unitutil.file import test_file
+from ..unitutil.mock import initializer_mock, instance_mock, method_mock
 
 
 class DescribeImagePart(object):
diff --git a/tests/parts/test_numbering.py b/tests/parts/test_numbering.py
@@ -16,7 +16,7 @@
 from docx.parts.numbering import NumberingPart, _NumberingDefinitions
 
 from ..oxml.unitdata.numbering import a_num, a_numbering
-from ..unitutil import (
+from ..unitutil.mock import (
     function_mock, class_mock, initializer_mock, instance_mock, method_mock
 )
 
diff --git a/tests/parts/test_styles.py b/tests/parts/test_styles.py
@@ -16,7 +16,7 @@
 from docx.parts.styles import StylesPart, _Styles
 
 from ..oxml.unitdata.styles import a_style, a_styles
-from ..unitutil import (
+from ..unitutil.mock import (
     function_mock, class_mock, initializer_mock, instance_mock, method_mock
 )
 
diff --git a/tests/test_api.py b/tests/test_api.py
@@ -21,7 +21,7 @@
 from docx.table import Table
 from docx.text import Paragraph, Run
 
-from .unitutil import (
+from .unitutil.mock import (
     instance_mock, class_mock, method_mock, property_mock, var_mock
 )
 
diff --git a/tests/test_package.py b/tests/test_package.py
@@ -13,9 +13,8 @@
 from docx.package import ImageParts, Package
 from docx.parts.image import ImagePart
 
-from .unitutil import (
-    docx_path, class_mock, instance_mock, method_mock
-)
+from .unitutil.file import docx_path
+from .unitutil.mock import class_mock, instance_mock, method_mock
 
 
 class DescribePackage(object):
diff --git a/tests/test_shape.py b/tests/test_shape.py
@@ -21,7 +21,7 @@
     an_spPr, an_xfrm
 )
 from .oxml.unitdata.text import an_r
-from .unitutil import instance_mock
+from .unitutil.mock import instance_mock
 
 
 class DescribeInlineShape(object):
diff --git a/tests/test_text.py b/tests/test_text.py
@@ -24,7 +24,7 @@
     an_imprint, an_oMath, a_noProof, an_outline, an_r, an_rPr, an_rStyle,
     an_rtl
 )
-from .unitutil import call, class_mock, instance_mock, Mock
+from .unitutil.mock import call, class_mock, instance_mock, Mock
 
 
 class DescribeParagraph(object):
diff --git a/tests/unitutil/__init__.py b/tests/unitutil/__init__.py
diff --git a/tests/unitutil/file.py b/tests/unitutil/file.py
@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+"""
+Utility functions for loading files for unit testing
+"""
+
+import os
+
+
+_thisdir = os.path.split(__file__)[0]
+test_file_dir = os.path.abspath(os.path.join(_thisdir, '..', 'test_files'))
+
+
+def abspath(relpath):
+    thisdir = os.path.split(__file__)[0]
+    return os.path.abspath(os.path.join(thisdir, relpath))
+
+
+def absjoin(*paths):
+    return os.path.abspath(os.path.join(*paths))
+
+
+def docx_path(name):
+    """
+    Return the absolute path to test .docx file with root name *name*.
+    """
+    return absjoin(test_file_dir, '%s.docx' % name)
+
+
+def test_file(name):
+    """
+    Return the absolute path to test file having *name*.
+    """
+    return absjoin(test_file_dir, name)
diff --git a/tests/unitutil/mock.py b/tests/unitutil/mock.py
@@ -1,10 +1,11 @@
 # encoding: utf-8
 
 """
-Utility functions for unit testing
+Utility functions wrapping the excellent *mock* library.
 """
 
-import os
+from __future__ import absolute_import, print_function
+
 import sys
 
 if sys.version_info >= (3, 3):
@@ -17,45 +18,6 @@
     from mock import create_autospec, Mock, patch, PropertyMock
 
 
-from docx.oxml.xmlchemy import serialize_for_reading
-
-
-_thisdir = os.path.split(__file__)[0]
-test_file_dir = os.path.abspath(os.path.join(_thisdir, 'test_files'))
-
-
-def abspath(relpath):
-    thisdir = os.path.split(__file__)[0]
-    return os.path.abspath(os.path.join(thisdir, relpath))
-
-
-def actual_xml(elm):
-    return serialize_for_reading(elm)
-
-
-def absjoin(*paths):
-    return os.path.abspath(os.path.join(*paths))
-
-
-def docx_path(name):
-    """
-    Return the absolute path to test .docx file with root name *name*.
-    """
-    return absjoin(_thisdir, 'test_files', '%s.docx' % name)
-
-
-def test_file(name):
-    """
-    Return the absolute path to test file having *name*.
-    """
-    return absjoin(_thisdir, 'test_files', name)
-
-
-# ===========================================================================
-# pytest mocking helpers
-# ===========================================================================
-
-
 def class_mock(request, q_class_name, autospec=True, **kwargs):
     """
     Return a mock patching the class with qualified name *q_class_name*.

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`)`
`18`	`18`	`from docx.image.tiff import Tiff`
`19`	`19`
`20`		`-from ..unitutil import (`
	`20`	`+from ..unitutil.mock import (`
`21`	`21`	`call, class_mock, initializer_mock, instance_mock, method_mock`
`22`	`22`	`)`
`23`	`23`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`_LongIfdEntry, _RationalIfdEntry, _ShortIfdEntry, Tiff, _TiffParser`
`17`	`17`	`)`
`18`	`18`
`19`		`-from ..unitutil import (`
	`19`	`+from ..unitutil.mock import (`
`20`	`20`	`call, class_mock, function_mock, initializer_mock, instance_mock,`
`21`	`21`	`loose_mock, method_mock`
`22`	`22`	`)`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,8 @@`
`22`	`22`	`_DirPkgReader, PhysPkgReader, PhysPkgWriter, _ZipPkgReader, _ZipPkgWriter`
`23`	`23`	`)`
`24`	`24`
`25`		`-from ..unitutil import absjoin, class_mock, loose_mock, Mock, test_file_dir`
	`25`	`+from ..unitutil.file import absjoin, test_file_dir`
	`26`	`+from ..unitutil.mock import class_mock, loose_mock, Mock`
`26`	`27`
`27`	`28`
`28`	`29`	`test_docx_path = absjoin(test_file_dir, 'test.docx')`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`)`
`20`	`20`
`21`	`21`	`from .unitdata.types import a_Default, a_Types, an_Override`
`22`		`-from ..unitutil import (`
	`22`	`+from ..unitutil.mock import (`
`23`	`23`	`call, class_mock, function_mock, initializer_mock, instance_mock,`
`24`	`24`	`loose_mock, method_mock, Mock, patch`
`25`	`25`	`)`