Add tests for skin and yosys_script options

This commit adds the unit tests for skin and yosys_option.
It also provides the basic test mechanism that can be used to
check the correctness of both particular functions and the whole
extension usage in Sphinx.

Signed-off-by: Robert Winkler <rwinkler@antmicro.com>

Author: rw1nkler

.travis.yml

@@ -3,9 +3,28 @@ language: minimal
 before_install:
     - make env
 
-script:
-    - make test
-    - make build
+stages:
+    - name:
+        - Test
+        - Build
+
+jobs:
+    - stage: Tests
+      name: "Test :skin: option"
+      script:
+        - source env/conda/bin/activate sphinxcontrib-verilog-diagrams
+        - cd tests && python3 -m unittest test.TestSkins
+
+    - stage: Tests
+      name: "Test :yosys_script: option"
+      script:
+        - source env/conda/bin/activate sphinxcontrib-verilog-diagrams
+        - cd tests && python3 -m unittest test.TestYosysScript
+
+    - stage: Build
+      name: "Build"
+      script:
+        - make build
 
 before_deploy:
     - make clean

Makefile

@@ -62,5 +62,6 @@ upload: build | $(CONDA_ENV_PYTHON)
 
 test: $(VERSION_PY) | $(CONDA_ENV_PYTHON)
 	$(IN_CONDA_ENV) cd docs; make html
+	$(IN_CONDA_ENV) cd tests; make test
 
 .PHONY: test

requirements.txt

@@ -4,3 +4,6 @@ sphinx
 
 # Needed to upload to PyPi
 twine
+
+# Needed for tests
+jinja2

tests/Makefile

@@ -0,0 +1,8 @@
+test:
+	make clean
+	python3 test.py
+
+clean:
+	-rm -rf build
+
+.PHONY: test clean

tests/conf.py.template

@@ -0,0 +1,58 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+
+sys.path.insert(0, {{ verilog_diagrams_path }})
+
+# -- Project information -----------------------------------------------------
+
+project = 'Sphinx Verilog Diagrams Tests'
+copyright = '2020, SymbiFlow Team'
+author = 'SymbiFlow Team'
+
+# The full version, including alpha/beta/rc tags
+release = '0.1'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinxcontrib_verilog_diagrams',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+
+master_doc = {{ master_doc }}
+{{ custom_variables }}

tests/test.py

@@ -0,0 +1,112 @@
+#!/usr/bin/env python3
+
+import os
+import shutil
+import unittest
+
+from jinja2 import Environment, FileSystemLoader
+from sphinx.application import Sphinx
+from sphinx.util.docutils import docutils_namespace
+
+VERILOG_DIAGRAMS_PATH = os.path.abspath("..")
+
+
+def get_sphinx_dirs(test_build_dir):
+    sphinx_dirs = {
+        "srcdir": test_build_dir,
+        "confdir": test_build_dir,
+        "outdir": os.path.join(test_build_dir, "build"),
+        "doctreedir": os.path.join(test_build_dir, "build", "doctrees")
+    }
+    return sphinx_dirs
+
+
+def generate_sphinx_config(test_build_dir, **jinja_dict):
+    sphinx_config_path = os.path.join(test_build_dir, "conf.py")
+
+    with open(sphinx_config_path, "w") as fd:
+        env = Environment(loader=FileSystemLoader('.'))
+        template = env.get_template("conf.py.template")
+        template.stream(**jinja_dict).dump(fd)
+
+
+class TestSkins(unittest.TestCase):
+
+    TEST_CASE_NAME = "TestSkins"
+    TEST_CASE_BUILD_DIR = os.path.join("build", TEST_CASE_NAME)
+
+    def test_netlistsvg_diagram(self):
+        TEST_NAME = "test_skins"
+        TEST_BUILD_DIR = os.path.join("build", self.TEST_CASE_NAME, TEST_NAME)
+        TEST_FILES = [
+            "test_skins/test_skins.rst",
+            "test_skins/skin-orange.svg",
+            "test_skins/skin-yellow.svg",
+            "verilog/adder.v"
+        ]
+        TEST_JINJA_DICT = {
+            "verilog_diagrams_path": "'{}'".format(VERILOG_DIAGRAMS_PATH),
+            "master_doc": "'test_skins'",
+            "custom_variables": "verilog_diagram_skin = os.path.realpath('skin-orange.svg')"
+        }
+
+        # Create the TestCase build directory
+        os.makedirs(TEST_BUILD_DIR, exist_ok=True)
+
+        # Generate a Sphinx config
+        generate_sphinx_config(TEST_BUILD_DIR, **TEST_JINJA_DICT)
+
+        # Copy the test files
+        for src in TEST_FILES:
+            src_basename = os.path.basename(src)
+            dst = os.path.join(TEST_BUILD_DIR, src_basename)
+            shutil.copyfile(src, dst)
+
+        # Run the Sphinx
+        sphinx_dirs = get_sphinx_dirs(TEST_BUILD_DIR)
+        with docutils_namespace():
+            app = Sphinx(buildername="html", warningiserror=True, **sphinx_dirs)
+            app.build(force_all=True)
+
+
+class TestYosysScript(unittest.TestCase):
+
+    TEST_CASE_NAME = "TestYosysScript"
+    TEST_CASE_BUILD_DIR = os.path.join("build", TEST_CASE_NAME)
+
+    def test_yosys_script(self):
+        TEST_NAME = "test_yosys_script"
+        TEST_BUILD_DIR = os.path.join("build", self.TEST_CASE_NAME, TEST_NAME)
+        TEST_FILES = [
+            "test_yosys_script/test_yosys_script.rst",
+            "test_yosys_script/yosys_script.ys",
+            "test_yosys_script/yosys_script2.ys",
+            "verilog/adder.v"
+        ]
+        TEST_JINJA_DICT = {
+            "verilog_diagrams_path": "'{}'".format(VERILOG_DIAGRAMS_PATH),
+            "master_doc": "'test_yosys_script'",
+            "custom_variables": "verilog_diagram_yosys_script = os.path.realpath('yosys_script.ys')"
+        }
+
+        # Create the TestCase build directory
+        os.makedirs(TEST_BUILD_DIR, exist_ok=True)
+
+        # Generate a Sphinx config
+        generate_sphinx_config(TEST_BUILD_DIR, **TEST_JINJA_DICT)
+
+        # Copy the test files
+        for src in TEST_FILES:
+            src_basename = os.path.basename(src)
+            dst = os.path.join(TEST_BUILD_DIR, src_basename)
+            shutil.copyfile(src, dst)
+
+        # Run the Sphinx
+        sphinx_dirs = get_sphinx_dirs(TEST_BUILD_DIR)
+        with docutils_namespace():
+            app = Sphinx(buildername="html", warningiserror=True, **sphinx_dirs)
+            app.build(force_all=True)
+
+
+if __name__ == '__main__':
+    unittest.main()