Break out environment generation into its own class

Author: werdeil

README.rst

@@ -115,6 +115,21 @@ via the :code:`pytest_configure` hook:
 The generated table will be sorted alphabetically unless the metadata is a
 :code:`collections.OrderedDict`.
 
+You can edit the environment table header and row by using the :code:`pytest_html_environment_table_header` and `pytest_html_environment_table_row` hooks:
+
+.. code-block:: python
+
+   import pytest
+
+   DESCRIPTION_DICT = {"Packages": "Version of pytest packages", "Python": "Version of Python"}
+
+   def pytest_html_environment_table_header(cells):
+      cells.insert(2, html.th('Description'))
+
+   def pytest_html_environment_table_row(cells):
+      cells.insert(2, html.td(description_dict.get(cells[0], '')))
+
+
 Additional summary information
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

pytest_html/hooks.py

@@ -7,6 +7,14 @@ def pytest_html_report_title(report):
     """ Called before adding the title to the report """
 
 
+def pytest_html_environment_table_header(cells):
+    """ Called after building environment table header. """
+
+
+def pytest_html_environment_table_row(cells):
+    """ Called after building environment table row. """
+
+
 def pytest_html_results_summary(prefix, summary, postfix):
     """ Called before adding the summary section to the report """
 

pytest_html/plugin.py

@@ -25,7 +25,7 @@
     # ansi2html is not installed
     ANSI = False
 
-from py.xml import html, raw, Tag
+from py.xml import html, raw
 
 from . import extras
 from . import __version__, __pypi_url__
@@ -341,6 +341,38 @@ def _append_video(self, extra, extra_index, test_index):
             )
             self.additional_html.append(html.div(html_div, class_="video"))
 
+    class EnvironmentTable:
+        def __init__(self, config):
+            self.metadata = getattr(config, "_metadata", [])
+            self.config = config
+            self.environment_table = []
+
+            rows = []
+
+            header_cells = [html.th("Key"), html.th("Value")]
+            self.config.hook.pytest_html_environment_table_header(cells=header_cells)
+            rows.append(header_cells)
+            if self.metadata:
+                keys = [k for k in self.metadata.keys()]
+                if not isinstance(self.metadata, OrderedDict):
+                    keys.sort()
+
+                for key in keys:
+                    value = self.metadata[key]
+                    if isinstance(value, str) and value.startswith("http"):
+                        value = html.a(value, href=value, target="_blank")
+                    elif isinstance(value, (list, tuple, set)):
+                        value = ", ".join(str(i) for i in sorted(map(str, value)))
+                    elif isinstance(value, dict):
+                        sorted_dict = {k: value[k] for k in sorted(value)}
+                        value = json.dumps(sorted_dict)
+                    raw_value_string = raw(str(value))
+                    row_cells = html.tr(html.td(key), html.td(raw_value_string))
+                    self.config.hook.pytest_html_environment_table_row(cells=row_cells)
+                    rows.append(row_cells)
+
+                self.environment_table.append(html.table(rows, id="environment"))
+
     def _appendrow(self, outcome, report):
         result = self.TestResult(outcome, report, self.logfile, self.config)
         if result.row_table is not None:
@@ -556,30 +588,12 @@ def generate_summary_item(self):
         return unicode_doc.decode("utf-8")
 
     def _generate_environment(self, config):
-        if not hasattr(config, "_metadata") or config._metadata is None:
-            return []
-
-        metadata = config._metadata
-        environment = [html.h2("Environment")]
-        rows = []
-
-        keys = [k for k in metadata.keys()]
-        if not isinstance(metadata, OrderedDict):
-            keys.sort()
-
-        for key in keys:
-            value = metadata[key]
-            if isinstance(value, str) and value.startswith("http"):
-                value = html.a(value, href=value, target="_blank")
-            elif isinstance(value, (list, tuple, set)) and not isinstance(value, Tag):
-                value = ", ".join(str(i) for i in sorted(map(str, value)))
-            elif isinstance(value, dict):
-                sorted_dict = {k: value[k] for k in sorted(value)}
-                value = json.dumps(sorted_dict)
-            raw_value_string = raw(str(value))
-            rows.append(html.tr(html.td(key), html.td(raw_value_string)))
-
-        environment.append(html.table(rows, id="environment"))
+        environment_table = self.EnvironmentTable(config).environment_table
+        if environment_table:
+            environment = [html.h2("Environment")]
+            environment.append(environment_table)
+        else:
+            environment = []
         return environment
 
     def _save_report(self, report_content):