Merge lp:~kissiel/checkbox/export-report-ap-scenario into lp:checkbox

[Maciej Kisielewski]

This MR brings autopilot scenario that checks if exported html report contains proper content.

[Sylvain Pineau (sylvain-pineau)]

I'd compare the created report with a reference one instead of relying on complex regexp.
The motivation behind this being that it's easier to tweak or replace the reference report than updating the regexp IMHO (if the html jinja2 template evolves in the future)

[Zygmunt Krynicki (zyga)]

Looks great, just one comment below

[Maciej Kisielewski (kissiel)]

Reporting is now reworked.
Dropping MR.

review: Disapprove

Unmerged revisions

3894. By Maciej Kisielewski on 2015-07-16

checkbox-touch:autopilot: add html exporter scenario

Signed-off-by: Maciej Kisielewski <email address hidden>

3893. By Maciej Kisielewski on 2015-07-16

checkbox-touch: add objectName to resultsPage component

Signed-off-by: Maciej Kisielewski <email address hidden>

3892. By Maciej Kisielewski on 2015-07-16

checkbox-touch: add objectName to dialog component

Signed-off-by: Maciej Kisielewski <email address hidden>

=== modified file 'checkbox-touch/components/CbtDialog.qml'
--- checkbox-touch/components/CbtDialog.qml	2015-05-08 08:27:42 +0000
+++ checkbox-touch/components/CbtDialog.qml	2015-07-16 19:56:50 +0000
@@ -49,6 +49,7 @@
 
         Dialog {
             id: dlg
+            objectName: "dialog"
             title: i18n.tr("")
             modal: true
 

=== modified file 'checkbox-touch/components/ResultsPage.qml'
--- checkbox-touch/components/ResultsPage.qml	2015-03-31 20:36:41 +0000
+++ checkbox-touch/components/ResultsPage.qml	2015-07-16 19:56:50 +0000
@@ -147,6 +147,7 @@
 
         LatchButton {
             id: saveResultsButton
+            objectName: "saveReportButton"
             unlatchedColor: UbuntuColors.green
             Layout.fillWidth: true
             text: i18n.tr("Save detailed report")

=== modified file 'checkbox-touch/tests/autopilot/checkbox_touch/test_checkbox_touch.py'
--- checkbox-touch/tests/autopilot/checkbox_touch/test_checkbox_touch.py	2015-07-15 15:32:57 +0000
+++ checkbox-touch/tests/autopilot/checkbox_touch/test_checkbox_touch.py	2015-07-16 19:56:50 +0000
@@ -1,5 +1,9 @@
 # -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
 
+import os
+import re
+import time
+
 from testtools.matchers import Equals
 from autopilot.matchers import Eventually
 
@@ -228,3 +232,55 @@
         text_area = output_page.wait_select_single(
             objectName='textArea', visible=True)
         self.assertThat(text_area.text, Eventually(Equals("foobar\n")))
+
+
+class ExporterTests(checkbox_touch.ClickAppTestCase):
+
+    def test_html_exporter(self):
+        tests = ['automated-test-that-fails', 'automated-test-that-passes']
+        prefix = '2015.com.canonical.certification::autopilot/'
+        self.start_and_select_tests(
+            '2015.com.canonical.certification::normal',
+            [prefix + test for test in tests])
+        results_page = self.long_wait_select_single(
+            self.app, objectName='resultsPage', visible=True)
+        save_btn = results_page.wait_select_single(
+            objectName='saveReportButton', visible=True)
+        self.pointing_device.click_object(save_btn)
+        self.app.wait_select_single(
+            objectName='dialog', visible=True)
+        results = self._get_results_from_report()
+        self.assertThat(
+            results['autopilot/automated-test-that-fails'], Equals('failed'))
+        self.assertThat(
+            results['autopilot/automated-test-that-passes'], Equals('passed'))
+
+    def _get_documents_dir(self):
+        xdg_config_home = os.environ.get('XDG_CONFIG_HOME') or \
+            os.path.expanduser('~/.config')
+        with open(os.path.join(xdg_config_home, 'user-dirs.dirs')) as f:
+            match = re.search(r'XDG_DOCUMENTS_DIR="(.*)"\n', f.read())
+            if match:
+                return match.group(1).replace("$HOME", os.getenv("HOME"))
+            else:
+                return os.path.expanduser('~/Documents')
+
+    def _extract_results_from_html(self, html):
+        pattern = (r'<tr>.*?<td>(.*?)</td>.*?<td.*?>(.*?)'
+                   r'</td>(?:.*?<td>.*?</td>){3}.*?</tr>')
+        return dict(re.findall(pattern, html, re.MULTILINE | re.DOTALL))
+
+    def _get_young_files(self, path, max_age):
+        # max_age in seconds
+        files = []
+        for f in os.listdir(path):
+            file_path = os.path.join(path, f)
+            if os.stat(file_path).st_mtime > time.time() - max_age:
+                files.append(file_path)
+        return files
+
+    def _get_results_from_report(self):
+        for f in self._get_young_files(self._get_documents_dir(), 60):
+            if os.path.splitext(f)[1].lower() == '.html':
+                results = self._extract_results_from_html(open(f, "rt").read())
+                return results