Subclass pytest-html's HTMLReport to DokuReport class for report generation and upload. #583

kdexd · 2016-06-07T12:20:20Z

This PR introduces a helper class named DokuReport which serves as a plugin for pytest. This class is subclassed from pytest-html.plugin.HTMLReport class. It handles logging of test execution and upload it to Dokuwiki. It is registered as a plugin by config.pluginmanager in pytest_configure hook and unregistered in pytest_unconfigure. Prior to this, pytest-html plugin was used for report generation - to force pytest use DokuReport instead of HTMLReport, pytest-html has o be unregistered as a plugin during pytest_configure execution.

Checklist maintains the work done so far / work TO-DO in DokuReport:

Include summary and execution duration, generation time and commit hash.
Include test name, duration, result.
Embed plots, and error logs if any.
Handle dokuwiki connection and interaction from within the class.
Handle tempfile writing from within the class.
Make sure that this plugin is not activated when integration tests are not selected.

wkerzendorf · 2016-06-08T08:04:29Z

tardis/tests/tests_slow/report.py

+        """
+        super(DokuReport, self).pytest_sessionstart(session)
+
+    def pytest_runtest_logreport(self, report):


why are these functions here?

These are pytest hooks, this class is registered as a plugin so pytest automatically calls these hook functions. I'll update this PR by their removal if removing them also works (it should, according to inheritance).

wkerzendorf · 2016-06-09T06:58:29Z

setup.cfg

@@ -10,6 +10,7 @@ show-response = 1
 [pytest]
 minversion = 2.2
 norecursedirs = build docs/_build
+addopts = -p no:html


Do we really need this?

- Added pytest-html in requirements as a dependency.

- This tempfile will get deleted upon closing and no longer needs os.unlink while execution of pytest_nconfigure hook.

- Override base class' pytest_terminal_summary method and display message according to success / failure of upload of report. - Try/ except methods are introduced wherever there is an attempt to interact with dokuwiki is made.

yeganer · 2016-06-09T10:45:47Z

tardis/tests/tests_slow/report.py

@@ -32,10 +32,12 @@ def __init__(self, dokuwiki_details):
                    password=dokuwiki_details["password"])
            except gaierror, dokuwiki.DokuWikiError:
                self.doku_conn = None
-                print "Dokuwiki connection could not be established!"
        else:


remove the if/else and add an except for the case dokuwiki=none

- tempfile is no longer used to write the report and upload it to dokuwiki. - _generate_report returns a string which is accepted by _save_report to upload it on Dokuwiki.

- Instead of doing 'if dokuwiki is not None', a try-except block is used to catch a 'TypeError'.

wkerzendorf · 2016-06-09T11:50:42Z

tardis/tests/tests_slow/report.py

+try:
+    import dokuwiki
+except ImportError:
+    dokuwiki = None


why not dokuwiki_available = False

There is no reason to have the dokuwiki_available variable. Since we are
ductyping anyway we can catch the case dokuwiki == None in the same block.

Wolfgang Kerzendorf [email protected] schrieb am Do., 9. Juni 2016
um 13:50 Uhr:

In tardis/tests/tests_slow/report.py
#583 (comment):

+import datetime
+import pkg_resources
+import os
+import time
+
+# For specifying error while exception handling
+from socket import gaierror
+
+from py.xml import html, raw
+from pytest_html.plugin import HTMLReport
+import tardis
+
+try:

import dokuwiki
+except ImportError:

dokuwiki = None

why not dokuwiki_available = False

—
You are receiving this because you commented.

Reply to this email directly, view it on GitHub
https://github.com/tardis-sn/tardis/pull/583/files/39748519f55d18998f52984f9929bfc1876a2782#r66426452,
or mute the thread
https://github.com/notifications/unsubscribe/AF4OjvHknV68nNtK4Rc7R-9fGlF0-7Mzks5qJ_4TgaJpZM4Iv3C8
.

I think that makes for convoluted code, where it is not clear why it is excepting. But I withdraw my comment for now.

- Report content is requested from dokuwiki using pages.get method and report upload is said to be successful if a non empty string is received.

yeganer · 2016-06-09T13:19:26Z

tardis/tests/tests_slow/report.py

+        except (gaierror, TypeError):
+            uploaded_report = ""
+
+        if len(uploaded_report) > 0:
            terminalreporter.write_sep(
                "-", "Successfully uploaded report to Dokuwiki")


It would be great if you could add the URL, too.

wkerzendorf · 2016-06-10T08:46:46Z

@yeganer is this mergeable? I'm happy to.

kdexd force-pushed the dokureport-class branch 3 times, most recently from abd4b6d to fce0b56 Compare June 8, 2016 05:26

wkerzendorf reviewed Jun 8, 2016
View reviewed changes

kdexd force-pushed the dokureport-class branch 2 times, most recently from c3d3f1a to 2ab56ba Compare June 9, 2016 06:49

wkerzendorf reviewed Jun 9, 2016
View reviewed changes

Karan Desai added 6 commits June 9, 2016 13:05

Subclass HTMLReport of pytest-html as DokuReport.

116aeb5

- Added pytest-html in requirements as a dependency.

Split pytest_sessionfinish to generate and save methods.

4e4fadc

Include dokuwiki connection and report upload within class.

dd0666e

Provide a tempfile to HTMLReport from inside DokuReport.

5a56b87

- This tempfile will get deleted upon closing and no longer needs os.unlink while execution of pytest_nconfigure hook.

Add docstrings to DokuReport methods.

a392364

kdexd force-pushed the dokureport-class branch from 2ab56ba to a392364 Compare June 9, 2016 07:38

Move pytest-html to pip install section in ci requirements.

7bc2642

yeganer reviewed Jun 9, 2016
View reviewed changes

Karan Desai added 2 commits June 9, 2016 16:23

Write and directly upload report using a string.

6ec110a

- tempfile is no longer used to write the report and upload it to dokuwiki. - _generate_report returns a string which is accepted by _save_report to upload it on Dokuwiki.

Replace NoneType checks for dokuwiki with try-except blocks.

3974851

- Instead of doing 'if dokuwiki is not None', a try-except block is used to catch a 'TypeError'.

wkerzendorf reviewed Jun 9, 2016
View reviewed changes

Refactor self.is_report_uploaded way of checking status.

889c343

- Report content is requested from dokuwiki using pages.get method and report upload is said to be successful if a non empty string is received.

kdexd changed the title ~~Create standalone DokuReport class for report generation and upload.~~ Subclass pytest-html's HTMLReport to DokuReport class for report generation and upload. Jun 9, 2016

yeganer reviewed Jun 9, 2016
View reviewed changes

Karan Desai added 2 commits June 9, 2016 20:58

Restore 'environment' section to html report.

1868918

Add url of uploaded report in pytest_terminal_summary.

7b6135d

yeganer merged commit 3f14163 into tardis-sn:master Jun 14, 2016

kdexd deleted the dokureport-class branch June 22, 2016 03:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Subclass pytest-html's HTMLReport to DokuReport class for report generation and upload. #583

Subclass pytest-html's HTMLReport to DokuReport class for report generation and upload. #583

kdexd commented Jun 7, 2016 •

edited

Loading

wkerzendorf Jun 8, 2016

kdexd Jun 8, 2016

wkerzendorf Jun 9, 2016

yeganer Jun 9, 2016

wkerzendorf Jun 9, 2016

yeganer Jun 9, 2016

wkerzendorf Jun 9, 2016

yeganer Jun 9, 2016

wkerzendorf commented Jun 10, 2016

Subclass pytest-html's HTMLReport to DokuReport class for report generation and upload. #583

Subclass pytest-html's HTMLReport to DokuReport class for report generation and upload. #583

Conversation

kdexd commented Jun 7, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wkerzendorf commented Jun 10, 2016

kdexd commented Jun 7, 2016 •

edited

Loading