Merge ~sylvain-pineau/checkbox-ng:disable-autoescape-html-comments into checkbox-ng:master

[Sylvain Pineau]

Disable autoescape in comments to let tester write text with html tags and preserve the rendering in the final report.

It will allow bug links in comments.

[Sylvain Pineau (sylvain-pineau)]

self-approved

review: Approve

[Devices Certification Bot (ce-certification-qa)]

The merge was fine but running tests failed.

[trusty] starting container
[trusty] (timing) 0.00user 0.00system 0:00.21elapsed 5%CPU (0avgtext+0avgdata 4968maxresident)k
[trusty] (timing) 0inputs+72outputs (0major+1090minor)pagefaults 0swaps
[trusty] provisioning container
[trusty] (timing) 84.91user 124.29system 8:25.48elapsed 41%CPU (0avgtext+0avgdata 69112maxresident)k
[trusty] (timing) 0inputs+1681704outputs (15major+1536516minor)pagefaults 0swaps
[trusty-testing] Starting tests...
Found a test script: ./requirements/001-container-tests-plainbox-egg-info
[trusty-testing] 001-container-tests-plainbox-egg-info: PASS
[trusty-testing] (timing) 0.19user 0.02system 0:00.24elapsed 88%CPU (0avgtext+0avgdata 24372maxresident)k
[trusty-testing] (timing) 0inputs+88outputs (0major+9409minor)pagefaults 0swaps
Found a test script: ./requirements/container-tests-checkbox-documentation
[trusty-testing] container-tests-checkbox-documentation: PASS
[trusty-testing] (timing) 0.02user 0.01system 0:00.05elapsed 61%CPU (0avgtext+0avgdata 10516maxresident)k
[trusty-testing] (timing) 0inputs+0outputs (0major+2635minor)pagefaults 0swaps
Found a test script: ./requirements/container-tests-checkbox-ng-unit
[trusty-testing] container-tests-checkbox-ng-unit: FAIL
[trusty-testing] stdout: https://paste.ubuntu.com/p/vgxZnS5wK4/
[trusty-testing] stderr: https://paste.ubuntu.com/p/Gry7fPSvBW/
[trusty-testing] (timing) Command exited with non-zero status 1
[trusty-testing] (timing) 12.45user 0.70system 0:15.36elapsed 85%CPU (0avgtext+0avgdata 70052maxresident)k
[trusty-testing] (timing) 0inputs+53896outputs (0major+464327minor)pagefaults 0swaps
Found a test script: ./requirements/container-tests-providers-internal
[trusty-testing] container-tests-providers-internal: PASS
[trusty-testing] (timing) 11.04user 0.70system 0:13.61elapsed 86%CPU (0avgtext+0avgdata 60676maxresident)k
[trusty-testing] (timing) 0inputs+48032outputs (0major+461264minor)pagefaults 0swaps
[trusty-testing] Fixing file permissions in source directory
[trusty-testing] Destroying container
Name: trusty-testing
State: STOPPED
[xenial] starting container
[xenial] (timing) 0.00user 0.00system 0:00.30elapsed 2%CPU (0avgtext+0avgdata 5072maxresident)k
[xenial] (timing) 0inputs+72outputs (0major+1086minor)pagefaults 0swaps
[xenial] provisioning container
[xenial] (timing) 39.67user 16.03system 6:33.51elapsed 14%CPU (0avgtext+0avgdata 83764maxresident)k
[xenial] (timing) 64inputs+2000128outputs (0major+1984904minor)pagefaults 0swaps
[xenial-testing] Starting tests...
Found a test script: ./requirements/001-container-tests-plainbox-egg-info
[xenial-testing] 001-container-tests-plainbox-egg-info: PASS
[xenial-testing] (timing) 0.21user 0.02system 0:00.26elapsed 90%CPU (0avgtext+0avgdata 25336maxresident)k
[xenial-testing] (timing) 0inputs+88outputs (0major+9651minor)pagefaults 0swaps
Found a test script: ./requirements/container-tests-checkbox-documentation
[xenial-testing] container-tests-checkbox-documentation: PASS
[xenial-testing] (timing) 1.74user 0.05system 0:02.21elapsed 81%CPU (0avgtext+0avgdata 60452maxr...

review: Needs Fixing

diff --git a/plainbox/impl/exporter/jinja2.py b/plainbox/impl/exporter/jinja2.py
index 3f53908..b02af57 100644
--- a/plainbox/impl/exporter/jinja2.py
+++ b/plainbox/impl/exporter/jinja2.py
@@ -97,7 +97,7 @@ class Jinja2SessionStateExporter(ISessionStateExporter):
             paths.extend(self.data["extra_paths"])
         self.option_list = exporter_unit.option_list
         loader = FileSystemLoader(paths)
-        env = Environment(loader=loader)
+        env = Environment(loader=loader, extensions=['jinja2.ext.autoescape'])
         self.customize_environment(env)
 
         def include_file(name):
diff --git a/plainbox/impl/providers/exporters/data/checkbox.html b/plainbox/impl/providers/exporters/data/checkbox.html
index 01e2b04..97318fd 100644
--- a/plainbox/impl/providers/exporters/data/checkbox.html
+++ b/plainbox/impl/providers/exporters/data/checkbox.html
@@ -165,7 +165,7 @@
                                     {%- else %}
                                     <td style='width:10%'></td>
                                     {%- endif %}
-                                    <td style='width:35%'>{{ job_state.result.comments if job_state.result.comments != None }}</td>
+                                    <td style='width:35%'>{% autoescape false %}{{ job_state.result.comments if job_state.result.comments != None }}{% endautoescape %}</td>
                                 </tr>
                             {%- endfor %}
                             </tbody>
diff --git a/plainbox/impl/providers/exporters/data/multi-page.html b/plainbox/impl/providers/exporters/data/multi-page.html
index c157730..de5c416 100644
--- a/plainbox/impl/providers/exporters/data/multi-page.html
+++ b/plainbox/impl/providers/exporters/data/multi-page.html
@@ -215,7 +215,7 @@
                     {%- else %}
                     <td style='width:10%'></td>
                     {%- endif %}
-                    <td style='width:35%'>{{ job_state.result.comments if job_state.result.comments != None }}</td>
+                    <td style='width:35%'>{% autoescape false %}{{ job_state.result.comments if job_state.result.comments != None }}{% endautoescape %}</td>
                 </tr>
             {%- endfor %}
             </tbody>