Merge pull request #5910 from cjerdonek/add-create-main-file

DRY up the test code that creates a module with a main() function.
pypa · Oct 23, 2018 · cc05433 · cc05433
2 parents 51819cc + ece4866
commit cc05433
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 19 deletions.
diff --git a/news/A6C1E675-2DF0-4D59-9183-19CF908F5CCF.trivial b/news/A6C1E675-2DF0-4D59-9183-19CF908F5CCF.trivial
diff --git a/tests/lib/__init__.py b/tests/lib/__init__.py
@@ -469,13 +469,26 @@ def assert_all_changes(start_state, end_state, expected_changes):
     return diff
 
 
+def _create_main_file(dir_path, name=None, output=None):
+    """
+    Create a module with a main() function that prints the given output.
+    """
+    if name is None:
+        name = 'version_pkg'
+    if output is None:
+        output = '0.1'
+    text = textwrap.dedent("""\
+    def main():
+        print({!r})
+    """.format(output))
+    filename = '{}.py'.format(name)
+    dir_path.join(filename).write(text)
+
+
 def _create_test_package_with_subdirectory(script, subdirectory):
     script.scratch_path.join("version_pkg").mkdir()
     version_pkg_path = script.scratch_path / 'version_pkg'
-    version_pkg_path.join("version_pkg.py").write(textwrap.dedent("""
-                                def main():
-                                    print('0.1')
-                                """))
+    _create_main_file(version_pkg_path, name="version_pkg", output="0.1")
     version_pkg_path.join("setup.py").write(
         textwrap.dedent("""
     from setuptools import setup, find_packages
@@ -488,10 +501,7 @@ def main():
 
     subdirectory_path = version_pkg_path.join(subdirectory)
     subdirectory_path.mkdir()
-    subdirectory_path.join('version_subpkg.py').write(textwrap.dedent("""
-                                def main():
-                                    print('0.1')
-                                """))
+    _create_main_file(subdirectory_path, name="version_subpkg", output="0.1")
 
     subdirectory_path.join('setup.py').write(
         textwrap.dedent("""
@@ -539,10 +549,7 @@ def _create_test_package_with_srcdir(script, name='version_pkg', vcs='git'):
 def _create_test_package(script, name='version_pkg', vcs='git'):
     script.scratch_path.join(name).mkdir()
     version_pkg_path = script.scratch_path / name
-    version_pkg_path.join("%s.py" % name).write(textwrap.dedent("""
-        def main():
-            print('0.1')
-    """))
+    _create_main_file(version_pkg_path, name=name, output='0.1')
     version_pkg_path.join("setup.py").write(textwrap.dedent("""
         from setuptools import setup, find_packages
         setup(
@@ -617,9 +624,9 @@ def _create_svn_repo(script, version_pkg_path):
 
 
 def _change_test_package_version(script, version_pkg_path):
-    version_pkg_path.join("version_pkg.py").write(textwrap.dedent('''\
-        def main():
-            print("some different version")'''))
+    _create_main_file(
+        version_pkg_path, name='version_pkg', output='some different version'
+    )
     script.run(
         'git', 'clean', '-qfdx',
         cwd=version_pkg_path,

diff --git a/tests/lib/git_submodule_helpers.py b/tests/lib/git_submodule_helpers.py
@@ -2,6 +2,8 @@
 
 import textwrap
 
+from tests.lib import _create_main_file
+
 
 def _create_test_package_submodule(env):
     env.scratch_path.join("version_pkg_submodule").mkdir()
@@ -45,10 +47,7 @@ def _create_test_package_with_submodule(env):
     pkg_path = version_pkg_path / 'testpkg'
 
     pkg_path.join("__init__.py").write("# hello there")
-    pkg_path.join("version_pkg.py").write(textwrap.dedent('''\
-                                def main():
-                                    print('0.1')
-                                '''))
+    _create_main_file(pkg_path, name="version_pkg", output="0.1")
     version_pkg_path.join("setup.py").write(textwrap.dedent('''\
                         from setuptools import setup, find_packages
                         setup(name='version_pkg',