🧪 TESTS: Move from unittest to pytest (#88)

Co-authored-by: Chris Sewell <chrisj_sewell@hotmail.com>

Author: foster999

.pre-commit-config.yaml

@@ -7,6 +7,8 @@ repos:
     - id: check-yaml
     - id: end-of-file-fixer
     - id: trailing-whitespace
+      exclude:
+        ".xml"
 
   - repo: https://github.com/mgedmin/check-manifest
     rev: "0.39"
@@ -31,6 +33,6 @@ repos:
       exclude: >
         (?x)^(
           setup.py|
-          test/.*|
+          tests/.*|
           docs/.*
         )$

MANIFEST.in

@@ -1,7 +1,7 @@
 exclude docs
 recursive-exclude docs *
-exclude test
-recursive-exclude test *
+exclude tests
+recursive-exclude tests *
 exclude images
 recursive-exclude images *
 

codecov.yml

@@ -2,4 +2,9 @@ coverage:
   status:
     project:
       default:
+        target: 85%
+        threshold: 0.5%
+    patch:
+      default:
+        target: 80%
         threshold: 0.5%

setup.py

@@ -31,9 +31,10 @@ def get_version():
             "coverage",
             "pytest>=3.6,<4",
             "pytest-cov",
+            "pytest-regressions",
             "pygments",
-            "lxml",
             "sphinx_testing",
+            "bs4",
         ],
         "code_style": ["pre-commit==2.6"],
     },

sphinx_tabs/tabs.py

@@ -2,8 +2,7 @@
 
 import base64
 import json
-import os
-import posixpath
+from pathlib import Path
 
 from docutils import nodes
 from docutils.parsers.rst import Directive, directives
@@ -249,8 +248,8 @@ def run(self):
 
 
 class _FindTabsDirectiveVisitor(nodes.NodeVisitor):
-    """ Visitor pattern than looks for a sphinx tabs
-        directive in a document """
+    """Visitor pattern than looks for a sphinx tabs
+    directive in a document"""
 
     def __init__(self, document):
         nodes.NodeVisitor.__init__(self, document)
@@ -279,17 +278,17 @@ def update_context(app, pagename, templatename, context, doctree):
     visitor = _FindTabsDirectiveVisitor(doctree)
     doctree.walk(visitor)
     if not visitor.found_tabs_directive:
-        paths = [posixpath.join("_static", "sphinx_tabs/" + f) for f in FILES]
+        paths = [Path("_static") / "sphinx_tabs" / f for f in FILES]
         if "css_files" in context:
             context["css_files"] = context["css_files"][:]
             for path in paths:
-                if path.endswith(".css") and path in context["css_files"]:
-                    context["css_files"].remove(path)
+                if path.suffix == ".css" and path in context["css_files"]:
+                    context["css_files"].remove(path.as_posix())
         if "script_files" in context:
             context["script_files"] = context["script_files"][:]
             for path in paths:
-                if path.endswith(".js") and path in context["script_files"]:
-                    context["script_files"].remove(path)
+                if path.suffix == ".js" and path.as_posix() in context["script_files"]:
+                    context["script_files"].remove(path.as_posix())
 
 
 # pylint: enable=unused-argument
@@ -316,15 +315,15 @@ def copy_assets(app, exception):
 
     log("Copying tabs assets")
 
-    installdir = os.path.join(app.builder.outdir, "_static", "sphinx_tabs")
+    installdir = Path(app.builder.outdir) / "_static" / "sphinx_tabs"
 
     for path in FILES:
         source = resource_filename("sphinx_tabs", path)
-        dest = os.path.join(installdir, path)
+        dest = installdir / path
 
-        destdir = os.path.dirname(dest)
-        if not os.path.exists(destdir):
-            os.makedirs(destdir)
+        destdir = dest.parent
+        if not destdir.exists():
+            destdir.mkdir(parents=True)
 
         copyfile(source, dest)
 
@@ -337,17 +336,17 @@ def setup(app):
     app.add_directive("tab", TabDirective)
     app.add_directive("group-tab", GroupTabDirective)
     app.add_directive("code-tab", CodeTabDirective)
-    for path in ["sphinx_tabs/" + f for f in FILES]:
-        if path.endswith(".css"):
+    for path in [Path("sphinx_tabs") / f for f in FILES]:
+        if path.suffix == ".css":
             if "add_css_file" in dir(app):
-                app.add_css_file(path)
+                app.add_css_file(path.as_posix())
             else:
-                app.add_stylesheet(path)
-        if path.endswith(".js"):
+                app.add_stylesheet(path.as_posix())
+        if path.suffix == ".js":
             if "add_script_file" in dir(app):
-                app.add_script_file(path)
+                app.add_script_file(path.as_posix())
             else:
-                app.add_js_file(path)
+                app.add_js_file(path.as_posix())
     app.connect("html-page-context", update_context)
     app.connect("build-finished", copy_assets)