Merge pull request #133 from huguesdevimeux/testings

Add tests with pytest (WIP)

Author: leotrs

.travis.yml

@@ -14,7 +14,7 @@ jobs:
 
     - os: linux
       language: python
-      python: 3.7
+      python: 3.7     
       install:
         - pip3 install --upgrade pip
         - pip3 install -r ./.travis/travis-requirements.txt
@@ -39,6 +39,11 @@ jobs:
       language: sh
       python: 3.6
       env: PYVER="3.6.10"
+      before_install: 
+        - ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" < /dev/null 2> /dev/null
+        - brew install ffmpeg
+        - brew cask install mactex
+        - eval "$(/usr/libexec/path_helper)"
       install:
         - pip3 install --upgrade pip
         - pip3 install -r ./.travis/travis-requirements.txt
@@ -51,6 +56,11 @@ jobs:
       language: sh
       python: 3.7
       env: PYVER="3.7.7"
+      before_install: 
+        - ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" < /dev/null 2> /dev/null
+        - brew install ffmpeg
+        - brew cask install mactex
+        - eval "$(/usr/libexec/path_helper)"
       install:
         - pip3 install --upgrade pip
         - pip3 install -r ./.travis/travis-requirements.txt
@@ -63,6 +73,11 @@ jobs:
       language: sh
       python: 3.8
       env: PYVER="3.8.0" # Using Python 3.8.0 due to error with rich
+      before_install: 
+        - ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" < /dev/null 2> /dev/null
+        - brew install ffmpeg
+        - brew cask install mactex
+        - eval "$(/usr/libexec/path_helper)"
       install:
         - pip3 install --upgrade pip
         - pip3 install -r ./.travis/travis-requirements.txt
@@ -80,15 +95,14 @@ jobs:
       install:
         - choco install python --version=$PYVER
         - export PATH="/c/$PYDIR:/c/$PYDIR/Scripts:$PATH"
-        - choco install ffmpeg
         - cmd.exe //c "RefreshEnv.cmd"
         - python -m pip install --upgrade pip
         - python -m pip install --user -r ./.travis/travis-requirements.txt
         - python ./scripts/pycairoinstall.py
         - cmd.exe //c "RefreshEnv.cmd"
         - python -m pip install --user .
       script: 
-        - python -m pytest
+        - python -m pytest --skip_end_to_end -rs
 
     - os: windows
       language: sh
@@ -97,15 +111,14 @@ jobs:
       install:
         - choco install python --version=$PYVER
         - export PATH="/c/$PYDIR:/c/$PYDIR/Scripts:$PATH"
-        - choco install ffmpeg
         - cmd.exe //c "RefreshEnv.cmd"
         - python -m pip install --upgrade pip
         - python -m pip install --user -r ./.travis/travis-requirements.txt
         - python ./scripts/pycairoinstall.py
         - cmd.exe //c "RefreshEnv.cmd"
         - python -m pip install --user .
       script: 
-        - python -m pytest
+        - python -m pytest --skip_end_to_end -rs
 
     - os: windows
       language: sh
@@ -114,19 +127,18 @@ jobs:
       install:
         - choco install python --version=$PYVER
         - export PATH="/c/$PYDIR:/c/$PYDIR/Scripts:$PATH"
-        - choco install ffmpeg
         - cmd.exe //c "RefreshEnv.cmd"
         - python -m pip install --upgrade pip
         - python -m pip install --user -r ./.travis/travis-requirements.txt
         - python ./scripts/pycairoinstall.py
         - cmd.exe //c "RefreshEnv.cmd"
         - python -m pip install --user .
       script: 
-        - python -m pytest
+        - python -m pytest --skip_end_to_end -rs
 
 before_install:
   - if [ "$TRAVIS_OS_NAME" == "osx" ]; then chmod +x ./.travis/osx.sh; sh ./.travis/osx.sh; fi
-
+  - if [ "$TRAVIS_OS_NAME" == "linux" ]; then chmod +x ./.travis/linux.sh; sh ./.travis/linux.sh; fi
 branches:
   only:
   - master

.travis/linux.sh

@@ -0,0 +1,5 @@
+##### THIS IS FOR TRAVIS BUILDS, DO NOT RUN THIS ON YOUR COMPUTER! #####
+
+sudo apt update
+sudo apt install -y ffmpeg
+sudo apt-get -y install texlive texlive-latex-extra texlive-fonts-extra texlive-latex-recommended texlive-science texlive-fonts-extra tipa

tests/conftest.py

@@ -0,0 +1,63 @@
+from manim import dirs
+from manim import config
+
+import pytest
+import numpy as np
+import os
+import sys
+import logging
+
+
+def pytest_addoption(parser):
+    parser.addoption("--skip_end_to_end", action="store_true", default=False,
+                     help="Will skip all the end-to-end tests. Useful when ffmpeg is not installed, e.g. on Windows jobs.")
+
+
+def pytest_configure(config):
+    config.addinivalue_line(
+        "markers", "skip_end_to_end: mark test as end_to_end test")
+
+
+def pytest_collection_modifyitems(config, items):
+    if not config.getoption("--skip_end_to_end"):
+        return
+    else:
+        skip_end_to_end = pytest.mark.skip(
+            reason="End to end test skipped due to --skip_end_to_end flag")
+        for item in items:
+            if "skip_end_to_end" in item.keywords:
+                item.add_marker(skip_end_to_end)
+
+
+@pytest.fixture(scope="module")
+def python_version():
+    return "python3" if sys.platform == "darwin" else "python"
+
+
+@pytest.fixture
+def get_config_test():
+    """Function used internally by pytest as a fixture. Return the Configuration for the scenes rendered. The config is the one used when 
+        calling the flags -s -l -dry_run
+    """
+    CONFIG = {
+        'camera_config': {
+            'frame_rate': 15,
+            'pixel_height': 480,
+            'pixel_width': 854
+        },
+        'end_at_animation_number': None,
+        'file_writer_config': {
+            'file_name': None,
+            'input_file_path': 'test.py',
+            'movie_file_extension': '.mp4',
+            'png_mode': 'RGB',
+            'save_as_gif': False,
+            'save_last_frame': False,
+            'save_pngs': False,
+            'write_to_movie': False
+        },
+        'leave_progress_bars': False,
+        'skip_animations': True,
+        'start_at_animation_number': None
+    }
+    return CONFIG

tests/test_CLI.py

@@ -0,0 +1,46 @@
+import subprocess
+import os
+from shutil import rmtree
+import pytest
+
+
+def capture(command):
+    proc = subprocess.Popen(command,
+                            stdout=subprocess.PIPE,
+                            stderr=subprocess.PIPE,
+                            )
+    out, err = proc.communicate()
+    return out, err, proc.returncode
+
+
+def test_help(python_version):
+    command = [python_version, "-m", "manim", "--help"]
+    out, err, exitcode = capture(command)
+    assert exitcode == 0, f"Manim has been installed incorrectly. Please refer to the troubleshooting section on the wiki. Error: {err}"
+
+
+@pytest.mark.skip_end_to_end
+def test_basicScene(python_version):
+    """ Simulate SquareToCircle. The cache will be saved in tests_caches/media_temp (temporary directory). This is mainly intended to test the partial-movies process. """
+    path_basic_scene = os.path.join("tests", "tests_data", "basic_scenes.py")
+    path_output = os.path.join("tests", "tests_cache", "media_temp")
+    command = [python_version, "-m", "manim", path_basic_scene,
+               "SquareToCircle", "-l", "--media_dir", path_output]
+    out, err, exitcode = capture(command)
+    assert exitcode == 0, err
+    assert os.path.exists(os.path.join(
+        path_output, "videos", "basic_scenes", "480p15", "SquareToCircle.mp4")), err
+    rmtree(path_output)
+
+@pytest.mark.skip_end_to_end
+def test_WriteStuff(python_version):
+    """This is mainly intended to test the caching process of the tex objects"""
+    path_basic_scene = os.path.join("tests", "tests_data", "basic_scenes.py")
+    path_output = os.path.join("tests", "tests_cache", "media_temp")
+    command = [python_version, "-m", "manim", path_basic_scene,
+               "WriteStuff", "-l", "--media_dir", path_output]
+    out, err, exitcode = capture(command)
+    assert exitcode == 0, err
+    assert os.path.exists(os.path.join(
+        path_output, "videos", "basic_scenes", "480p15", "WriteStuff.mp4")), err 
+    rmtree(path_output)

tests/test_creation.py

@@ -0,0 +1,93 @@
+from manim import *
+from testing_utils import utils_test_scenes, get_scenes_to_test
+
+
+class ShowCreationTest(Scene):
+    def construct(self):
+        square = Square()
+        self.play(ShowCreation(square))
+
+
+class UncreateTest(Scene):
+    def construct(self):
+        square = Square()
+        self.add(square)
+        self.play(Uncreate(square))
+
+
+class DrawBorderThenFillTest(Scene):
+    def construct(self):
+        square = Square(fill_opacity=1)
+        self.play(DrawBorderThenFill(square))
+
+
+# NOTE : Here should be the Write Test. But for some reasons it appears that this function is untestable (see issue #157)
+
+class FadeOutTest(Scene):
+    def construct(self):
+        square = Square()
+        self.add(square)
+        self.play(FadeOut(square))
+
+
+class FadeInTest(Scene):
+    def construct(self):
+        square = Square()
+        self.play(FadeIn(square))
+
+
+class FadeInFromTest(Scene):
+    def construct(self):
+        square = Square()
+        self.play(FadeInFrom(square, direction=UP))
+
+
+class FadeInFromDownTest(Scene):
+    def construct(self):
+        square = Square()
+        self.play(FadeInFromDown(square))
+
+
+class FadeOutAndShiftTest(Scene):
+    def construct(self):
+        square = Square()
+        self.play(FadeOutAndShift(square, direction=UP))
+
+
+class FadeInFromLargeTest(Scene):
+    def construct(self):
+        square = Square()
+        self.play(FadeInFromLarge(square))
+
+
+class GrowFromPointTest(Scene):
+    def construct(self):
+        square = Square()
+        self.play(GrowFromPoint(square, np.array((1, 1, 0))))
+
+
+class GrowFromCenterTest(Scene):
+    def construct(self):
+        square = Square()
+        self.play(GrowFromCenter(square))
+
+
+class GrowFromEdgeTest(Scene):
+    def construct(self):
+        square = Square()
+        self.play(GrowFromEdge(square, DOWN))
+
+
+class SpinInFromNothingTest(Scene):
+    def construct(self):
+        square = Square()
+        self.play(SpinInFromNothing(square))
+
+
+class ShrinkToCenterTest(Scene):
+    def construct(self):
+        square = Square()
+        self.play(ShrinkToCenter(square))
+
+def test_scenes(get_config_test):
+    utils_test_scenes(get_scenes_to_test(__name__), get_config_test, "creation")