Run only image comparison test with python3 -mpytest filename -v -m basleine_image_generation_test

SidharthBansal · SidharthBansal · commit 69d70c9f7a23 · 2020-07-08T21:08:26.000+05:30
diff --git a/.gitignore b/.gitignore
@@ -108,3 +108,7 @@ lib/matplotlib/backends/web_backend/package-lock.json
 # Matplotlib tempenv #
 ######################
 temp/testenv
+
+# Baseline Images #
+###################
+lib/matplotlib/tests/baseline_images/
diff --git a/lib/matplotlib/testing/decorators.py b/lib/matplotlib/testing/decorators.py
@@ -483,65 +483,72 @@ def _image_directories(func):
     doesn't exist.
     """
     module_path = Path(sys.modules[func.__module__].__file__)
-    if func.__module__.startswith("matplotlib."):
-        try:
-            import matplotlib_baseline_images
-        except:
-            generate_matplotlib_baseline_images_from_previous_commit()
-        baseline_dir = (Path(matplotlib_baseline_images.__file__).parent /
-                            module_path.stem)
-    elif func.__module__.startswith("mpl_toolkits."):
-        try:
-            import mpl_toolkits_baseline_images
-        except:
-            generate_matplotlib_baseline_images_from_previous_commit()
-        baseline_dir = (Path(mpl_toolkits_baseline_images.__file__).parent /
-                            module_path.stem)
-    else:
-        baseline_dir = (module_path.parent /
-                            "baseline_images" /
-                            module_path.stem)
+    '''
+ #   if func.__module__.startswith("matplotlib."):
+ #
+ #       try:
+ #          import matplotlib_baseline_images
+ #       except:
+ #           generate_matplotlib_baseline_images_from_previous_commit()
+ #       baseline_dir = (Path(matplotlib_baseline_images.__file__).parent /
+ #                           module_path.stem)
+ #   elif func.__module__.startswith("mpl_toolkits."):
+
+ #       try:
+ #           import mpl_toolkits_baseline_images
+ #       except:
+ #           generate_matplotlib_baseline_images_from_previous_commit()
+
+ #      baseline_dir = (Path(mpl_toolkits_baseline_images.__file__).parent /
+ #                           module_path.stem)
+ #   else:
+    '''
+    baseline_dir = (module_path.parent /
+                      "baseline_images" /
+                       module_path.stem)
     result_dir = Path().resolve() / "result_images" / module_path.stem
     result_dir.mkdir(parents=True, exist_ok=True)
     return baseline_dir, result_dir
 
 
-def generate_matplotlib_baseline_images_from_previous_commit():
-    mplRepoPath = Path(mpl.__file__).parent
-    # Check that git is installed.
-    run_text_mode(shutil.which('git')) == None
-    # Check if current repository is a git repository
-    run_text_mode(['git', 'status'],
-                    cwd = mplRepoPath) == None
-    # Create virtual env in tmpdir.
-    if not (mplRepoPath / 'testenv').exists():
-        modify_existing_baseline_images()
-    else
-        # Clone mpl repo to tmpvenv and run pytests from new mpl repo created
-        run_text_mode(["git", "worktree", "add", "testenv"],
-                        cwd = mplRepoPath)
-        testenvPath = mplRepoPath / testenv
-        run_text_mode([sys.executable, "-mvenv", "venv"],
-                        cwd = testenvPath)
-        run_text_mode(["source", "venv/bin/activate"],
-                        cwd = testenvPath)
-        run_text_mode(["git", "checkout", "HEAD~"],
-                        cwd = testenvPath)
-        run_text_mode(["python", "-mpip", "install", "-e", mplRepoPath],
-                        cwd = testenvPath)
-        run_text_mode(["python", "-mpytest"],
-                        cwd = testenvPath)
-        # Copy result_images in the temporary directory and cache it
-        run_text_mode(shutil.copytree(testenvPath / "result_images",
-                                        mplRepoPath / ".pytest_cache"),
-                        cwd = mplRepoPath)
-
- def modify_existing_baseline_images():
-     # TODO
-     return
-
-def run_text_mode(*args, **kwargs):
-    return subprocess.run(*args, **kwargs,
-                    stderr=subprocess.STDOUT,
-                    stdout = open(os.devnull, 'w'),
-                    universal_newlines=True)
+'''
+#def generate_matplotlib_baseline_images_from_previous_commit():
+#    mplRepoPath = Path(mpl.__file__).parent
+#    # Check that git is installed.
+#    run_text_mode(shutil.which('git')) == None
+#    # Check if current repository is a git repository
+#    run_text_mode(['git', 'status'],
+#                    cwd = mplRepoPath) == None
+#    # Create virtual env in tmpdir.
+#    if not (mplRepoPath / 'testenv').exists():
+#        modify_existing_baseline_images()
+#    else
+#        # Clone mpl repo to tmpvenv and run pytests from new mpl repo created
+#        run_text_mode(["git", "worktree", "add", "testenv"],
+#                        cwd = mplRepoPath)
+#        testenvPath = mplRepoPath / testenv
+#        run_text_mode([sys.executable, "-mvenv", "venv"],
+#                        cwd = testenvPath)
+#        run_text_mode(["source", "venv/bin/activate"],
+#                        cwd = testenvPath)
+#        run_text_mode(["git", "checkout", "HEAD~"],
+#                        cwd = testenvPath)
+#        run_text_mode(["python", "-mpip", "install", "-e", mplRepoPath],
+#                        cwd = testenvPath)
+#        run_text_mode(["python", "-mpytest"],
+#                        cwd = testenvPath)
+#        # Copy result_images in the temporary directory and cache it
+#        run_text_mode(shutil.copytree(testenvPath / "result_images",
+#                                        mplRepoPath / ".pytest_cache"),
+#                        cwd = mplRepoPath)
+
+# def modify_existing_baseline_images():
+##     # TODO
+#     return
+
+#def run_text_mode(*args, **kwargs):
+#    return subprocess.run(*args, **kwargs,
+#                    stderr=subprocess.STDOUT,
+#                    stdout = open(os.devnull, 'w'),
+#                    universal_newlines=True)
+'''
diff --git a/lib/matplotlib/tests/__init__.py b/lib/matplotlib/tests/__init__.py
@@ -1,9 +1 @@
 # Check for the matplotlib_baseline_images.
-try:
-    import matplotlib_baseline_images
-except:
-    raise ImportError(
-        'The baseline image directory does not exist. '
-        'This is most likely because the test data is not installed. '
-        'You may need to install matplotlib_baseline_images to get the '
-        'test data.')
diff --git a/lib/matplotlib/tests/test_agg.py b/lib/matplotlib/tests/test_agg.py
@@ -80,6 +80,7 @@ def test_long_path():
     fig.savefig(buff, format='png')
 
 
+@pytest.mark.baseline_image_generation_test
 @image_comparison(['agg_filter.png'], remove_text=True)
 def test_agg_filter():
     def smooth1d(x, window_len):
diff --git a/lib/matplotlib/tests/test_agg_filter.py b/lib/matplotlib/tests/test_agg_filter.py
@@ -1,9 +1,10 @@
 import numpy as np
-
+import pytest
 import matplotlib.pyplot as plt
 from matplotlib.testing.decorators import image_comparison
 
 
+@pytest.mark.baseline_image_generation_test
 @image_comparison(baseline_images=['agg_filter_alpha'],
                   extensions=['png', 'pdf'])
 def test_agg_filter_alpha():
diff --git a/pytest.ini b/pytest.ini
@@ -5,3 +5,8 @@ minversion = 3.6
 testpaths = lib
 python_files = test_*.py
 junit_family = xunit2
+
+
+markers =
+    baseline_image_generation_test: marks tests as baseline_image_generation_test (deselect with '-m "not baseline_image_generation_test"')
+    serial
