enhance html output structure to allow for easier styling

cleandesign-contrib · cleandesign-contrib · commit 6553da97193b · 2020-06-27T20:44:20.000+10:00
content will be created with the following document structure:
 body
   .content
     .content-header
       h1
       .content-environment
       .content-summary
     .content-results #results-container

Javascript for dealing with table interactivity has been updated to use
container id instead of relying on appending as final element of body.
diff --git a/pytest_html/plugin.py b/pytest_html/plugin.py
@@ -524,29 +524,34 @@ def generate_summary_item(self):
 
         session.config.hook.pytest_html_report_title(report=self)
 
+        content = [html.h1(self.title),
+                   html.p("Report generated on {} at {} by "\
+                          .format(generated.strftime("%d-%b-%Y"),
+                                  generated.strftime("%H:%M:%S")),
+                          html.a("pytest-html", href=__pypi_url__),f" v{__version__}",)]
+
+        summary_prefix, summary_postfix = [], []
+        session.config.hook.pytest_html_results_summary(prefix=summary_prefix,
+                                                        summary=summary,
+                                                        postfix=summary_postfix)
+        summary = [html.h2("Summary"), *summary_prefix, *summary, *summary_postfix]
+
         body = html.body(
             html.script(raw(main_js)),
-            html.h1(self.title),
-            html.p(
-                "Report generated on {} at {} by ".format(
-                    generated.strftime("%d-%b-%Y"), generated.strftime("%H:%M:%S")
-                ),
-                html.a("pytest-html", href=__pypi_url__),
-                f" v{__version__}",
-            ),
+            html.div(html.div(
+                html.h1(self.title),
+                html.p("Report generated on {} at {} by "\
+                       .format(generated.strftime("%d-%b-%Y"),
+                               generated.strftime("%H:%M:%S")),
+                       html.a("pytest-html", href=__pypi_url__),f" v{__version__}",),
+                html.div(*self._generate_environment(session.config), class_="content-environment"),
+                              html.div(*summary, class_="content-summary"),
+                              class_="content-header"),
+                     html.div(*results, class_="content-results", id="results-container"),
+                     class_="content"),
             onLoad="init()",
         )
 
-        body.extend(self._generate_environment(session.config))
-
-        summary_prefix, summary_postfix = [], []
-        session.config.hook.pytest_html_results_summary(
-            prefix=summary_prefix, summary=summary, postfix=summary_postfix
-        )
-        body.extend([html.h2("Summary")] + summary_prefix + summary + summary_postfix)
-
-        body.extend(results)
-
         doc = html.html(head, body)
 
         unicode_doc = "<!DOCTYPE html>\n{}".format(doc.unicode(indent=2))
diff --git a/pytest_html/resources/main.js b/pytest_html/resources/main.js
@@ -139,7 +139,7 @@ function sort_table(clicked, key_func) {
     sorted_rows.forEach(function(elem) {
         parent.appendChild(elem);
     });
-    document.getElementsByTagName("BODY")[0].appendChild(parent);
+    document.getElementById("results-container").appendChild(parent);
 }
 
 function sort(items, key_func, reversed) {

Original file line number	Diff line number	Diff line change
`@@ -139,7 +139,7 @@ function sort_table(clicked, key_func) {`
`139`	`139`	`sorted_rows.forEach(function(elem) {`
`140`	`140`	`parent.appendChild(elem);`
`141`	`141`	`});`
`142`		`- document.getElementsByTagName("BODY")[0].appendChild(parent);`
	`142`	`+ document.getElementById("results-container").appendChild(parent);`
`143`	`143`	`}`
`144`	`144`
`145`	`145`	`function sort(items, key_func, reversed) {`