add backend

pyproject.toml

@@ -1,3 +1,19 @@
+[tool.poetry]
+name = "pytest-html"
+description = "pytest plugin for generating HTML reports"
+version = "4.0.0-next"
+authors = ["Jim", "Victor"]
+
+[tool.poetry.dependencies]
+python = ">=3.6"
+Jinja2 = "^2.11.3"
+
+[tool.poetry.dev-dependencies]
+black = "20.8b1"
+flake8 = "3.8.4"
+tox = "^3.23.1"
+pytest = "^6.2.4"
+
 [build-system]
 requires = [
   "pip >= 19.3.1",

setup.py

@@ -10,10 +10,10 @@
     url="https://github.com/pytest-dev/pytest-html",
     package_dir={"": "src"},
     packages=["pytest_html"],
-    package_data={"pytest_html": ["resources/*"]},
+    package_data={"pytest_html": ["resources/*", "scripts/*"]},
     entry_points={"pytest11": ["html = pytest_html.plugin"]},
     setup_requires=["setuptools_scm"],
-    install_requires=["pytest>=5.0,!=6.0.0", "pytest-metadata"],
+    install_requires=["pytest>=5.0,!=6.0.0", "pytest-metadata", "jinja2>=3.0,<4.0"],
     license="Mozilla Public License 2.0 (MPL 2.0)",
     keywords="py.test pytest html report",
     python_requires=">=3.6",

src/pytest_html/hooks.py

@@ -4,20 +4,20 @@
 
 
 def pytest_html_report_title(report):
-    """ Called before adding the title to the report """
+    """Called before adding the title to the report"""
 
 
 def pytest_html_results_summary(prefix, summary, postfix):
-    """ Called before adding the summary section to the report """
+    """Called before adding the summary section to the report"""
 
 
 def pytest_html_results_table_header(cells):
-    """ Called after building results table header. """
+    """Called after building results table header."""
 
 
 def pytest_html_results_table_row(report, cells):
-    """ Called after building results table row. """
+    """Called after building results table row."""
 
 
 def pytest_html_results_table_html(report, data):
-    """ Called after building results table additional HTML. """
+    """Called after building results table additional HTML."""

src/pytest_html/nextgen.py

@@ -1,24 +1,108 @@
+import datetime
 import json
-from typing import Any
-from typing import Dict
+import os
 
 import pytest
+import re
+import shutil
+
+from . import __version__
+from .util import cleanup_unserializable, get_scripts
+
+from jinja2 import Environment, FileSystemLoader, PackageLoader
+
+from _pytest.pathlib import Path
 
 
 class NextGenReport:
-    def __init__(self, config, data_file):
+    def __init__(self, report_path, config):
+        _plugin_path = os.path.dirname(__file__)
+        self._report_absolute_path = Path(report_path).absolute()
+        self._report_path = self._report_absolute_path.parent
+
+        self._assets_path = Path(self._report_path, "assets")
+        self._assets_path.mkdir(parents=True, exist_ok=True)
+
+        self._scripts_dest_path = Path(self._report_path, "scripts")
+        self._scripts_dest_path.mkdir(parents=True, exist_ok=True)
+        self._scripts_src_path = Path(_plugin_path, "scripts")
+
+        self._resources_path = Path(_plugin_path, "resources")
+
+        self._default_css_path = Path(self._resources_path, "style.css")
+
         self._config = config
-        self._data_file = data_file
+        self._data_file = Path(self._assets_path, "test_data.js")
+        self._template = None
+        self._template_filename = "index.jinja2"
 
-        self._title = "Next Gen Report"
         self._data = {
-            "title": self._title,
             "collectedItems": 0,
             "environment": {},
             "tests": [],
         }
 
-        self._data_file.parent.mkdir(parents=True, exist_ok=True)
+    def _generate_environment(self):
+        metadata = self._config._metadata
+        for key in metadata.keys():
+            value = metadata[key]
+            if self._is_redactable_environment_variable(key):
+                black_box_ascii_value = 0x2593
+                metadata[key] = "".join(chr(black_box_ascii_value) for _ in str(value))
+
+        return metadata
+
+    def _generate_report(self):
+        self._template = self._read_template()
+
+        # Copy scripts
+        scripts_dest = shutil.copytree(
+            self._scripts_src_path, self._scripts_dest_path, dirs_exist_ok=True
+        )
+
+        # Copy default css file (style.css) to assets directory
+        new_css_path = shutil.copy(self._default_css_path, self._assets_path)
+
+        generated = datetime.datetime.now()
+        css_files = [new_css_path] + self._config.getoption("css")
+        rendered_report = self._render_html(
+            "Test Report",
+            generated.strftime("%d-%b-%Y"),
+            generated.strftime("%H:%M:%S"),
+            __version__,
+            self._data_file.name,
+            css_files,
+            get_scripts(scripts_dest),
+        )
+
+        with self._report_absolute_path.open("w", encoding="utf-8") as f:
+            f.write(rendered_report)
+
+    def _is_redactable_environment_variable(self, environment_variable):
+        redactable_regexes = self._config.getini("environment_table_redact_list")
+        for redactable_regex in redactable_regexes:
+            if re.match(redactable_regex, environment_variable):
+                return True
+
+        return False
+
+    def _read_template(self):
+        env = Environment(
+            loader=FileSystemLoader(self._resources_path), autoescape=True
+        )
+
+        return env.get_template(self._template_filename)
+
+    def _render_html(self, title, date, time, version, data_file, styles, scripts):
+        return self._template.render(
+            title=title,
+            date=date,
+            time=time,
+            version=version,
+            data_file=data_file,
+            styles=styles,
+            scripts=scripts,
+        )
 
     def _write(self):
         try:
@@ -28,18 +112,17 @@ def _write(self):
             data = json.dumps(data)
 
         with self._data_file.open("w", buffering=1, encoding="UTF-8") as f:
-            f.write("const jsonData = ")
-            f.write(data)
-            f.write("\n")
+            f.write(f"const jsonData = {data}\n")
 
     @pytest.hookimpl(trylast=True)
     def pytest_sessionstart(self, session):
         config = session.config
         if hasattr(config, "_metadata") and config._metadata:
-            metadata = config._metadata
-            self._data["environment"] = metadata
+            self._data["environment"] = self._generate_environment()
             self._write()
 
+        self._generate_report()
+
     @pytest.hookimpl(trylast=True)
     def pytest_collection_finish(self, session):
         self._data["collectedItems"] = len(session.items)
@@ -51,24 +134,11 @@ def pytest_runtest_logreport(self, report):
             config=self._config, report=report
         )
 
-        # rename to "extras" since list
-        if hasattr(report, "extra"):
-            for extra in report.extra:
-                print(extra)
-                if extra["mime_type"] is not None and "image" in extra["mime_type"]:
-                    data.update({"extras": extra})
+        # # TODO rename to "extras" since list
+        # if hasattr(report, "extra"):
+        #     for extra in report.extra:
+        #         if extra["mime_type"] is not None and "image" in extra["mime_type"]:
+        #             data.update({"extras": extra})
 
         self._data["tests"].append(data)
         self._write()
-
-
-def cleanup_unserializable(d: Dict[str, Any]) -> Dict[str, Any]:
-    """Return new dict with entries that are not json serializable by their str()."""
-    result = {}
-    for k, v in d.items():
-        try:
-            json.dumps({k: v})
-        except TypeError:
-            v = str(v)
-        result[k] = v
-    return result

src/pytest_html/plugin.py

@@ -81,10 +81,10 @@ def pytest_configure(config):
         if not hasattr(config, "workerinput"):
             # prevent opening htmlpath on worker nodes (xdist)
             config._html = HTMLReport(htmlpath, config)
-
-            config._next_gen = NextGenReport(config, Path("nextgendata.js"))
             config.pluginmanager.register(config._html)
-            config.pluginmanager.register(config._next_gen)
+
+            # config._next_gen = NextGenReport(htmlpath, config)
+            # config.pluginmanager.register(config._next_gen)
 
 
 def pytest_unconfigure(config):
@@ -93,10 +93,10 @@ def pytest_unconfigure(config):
         del config._html
         config.pluginmanager.unregister(html)
 
-    next_gen = getattr(config, "_next_gen", None)
-    if next_gen:
-        del config._next_gen
-        config.pluginmanager.unregister(next_gen)
+    # next_gen = getattr(config, "_next_gen", None)
+    # if next_gen:
+    #     del config._next_gen
+    #     config.pluginmanager.unregister(next_gen)
 
 
 @pytest.hookimpl(tryfirst=True, hookwrapper=True)
@@ -105,8 +105,10 @@ def pytest_runtest_makereport(item, call):
     report = outcome.get_result()
     if report.when == "call":
         fixture_extras = getattr(item.config, "extras", [])
-        plugin_extras = getattr(report, "extra", [])
-        report.extra = fixture_extras + plugin_extras
+        plugin_extras = getattr(report, "extras", [])
+        # print("fix: ", fixture_extras)
+        # print("plugin: ", plugin_extras)
+        report.extras = fixture_extras + plugin_extras
 
 
 @pytest.fixture