Link images of comparison plots in DokuReport using hookwrapper. #590
Conversation
kdexd
force-pushed
the
embed-plots-in-dokureport
branch
3 times, most recently
from
6e7e286 to
d48bd86
Compare
|
|
||
| def fin(): | ||
| # Adding plots in this manner is temporary. | ||
| plot_obj.add() |
There was a problem hiding this comment.
The way I imagine it, plot_obj.add() is called by the test function.
There was a problem hiding this comment.
Yes it is temporary. It will be changed when pyplot.figures are directly passed on.
kdexd
force-pushed
the
embed-plots-in-dokureport
branch
from
d471f82 to
7480119
Compare
- It picks up the plots from tempdirectory and uploads them to dokuwiki. - Corresponding hyperlinks are set in report.extras, these will be used by pytest-html in its html report.
kdexd
force-pushed
the
embed-plots-in-dokureport
branch
from
340d64f to
47acd6b
Compare
| report = outcome.get_result() | ||
|
|
||
| if report.when == "call": | ||
| plot_obj = getattr(item, "plot_obj", None) |
There was a problem hiding this comment.
I think we can use item.funcargs['plot_object']
Then we don't have to setattr in the fixture
kdexd
changed the title
- Fixture contains the declaration of PlotUploader class and it returns corresponding object, which is responsible for temporary holding and uploading of plots on dokuwiki.
- Plots are stored per test as matplotlb.pyplot.figures and these are uploaded to dokuwiki by first being written on a tempfile and then being read from it. - Added some relevant docstrings as well.
kdexd
force-pushed
the
embed-plots-in-dokureport
branch
from
90916e8 to
18e2f37
Compare
| if report.passed: | ||
| axes.text(0.8, 0.8, 'passed', transform=axes.transAxes, | ||
| bbox={'facecolor': 'green', 'alpha': 0.5, 'pad': 10}) | ||
| elif report.failed: |
There was a problem hiding this comment.
I think we should just use else:
Otherwise it we might get nothing.
There was a problem hiding this comment.
Other case is report.skipped. I think we don't need a plot here.
- Non empty error log is placed below the plots for better readability.
kdexd
force-pushed
the
embed-plots-in-dokureport
branch
from
74fa0e8 to
1430e41
Compare
kdexd
force-pushed
the
embed-plots-in-dokureport
branch
from
e700133 to
e428796
Compare
| @pytest.fixture(scope="function") | ||
| def plot_object(request): | ||
| plot_obj = PlotUploader(request) | ||
| setattr(request.node, "plot_obj", plot_obj) |
There was a problem hiding this comment.
Wo don't need this line anymore.
There was a problem hiding this comment.
@yeganer I'm further simplifying to:
@pytest.fixture(scope="function")
def plot_object(request):
return PlotUploader(request)... in the next commit
|
I made some last comments. I think we are done and ready to merge once they are implemented. @wkerzendorf Can you please have a quick look and merge once the comments are worked on? |
| thumbnail_html = """ | ||
| <div class="image" style="float: left"> | ||
| <a href="#"> | ||
| <img src= "{0}lib/exe/fetch.php?media=plots:{1}_{2}.png" /> |
There was a problem hiding this comment.
As a last exercise, please name the arguments, so it's obvious which is which
kdexd
force-pushed
the
embed-plots-in-dokureport
branch
from
207fbfd to
027d8d1
Compare
|
@wkerzendorf I think we are done here. Please merge if you are happy, too. |
|
|
||
| def add(self, plot, name): | ||
| """ | ||
| Accept a `matplotlib.pyplot.figure` and add it to self._plots. |
There was a problem hiding this comment.
can you please do numpydoc style documentation. for all functions that have documentation.
|
@karandesai-96 looks good. Merging when it passes |
This PR introduces a common object for temporary holding comparison plots and uploading them on DokuWiki. For this purpose, a fixture named
plot_objecthas been created in tests_slow/conftest.py. It returns an object ofPlotUploaderclass.Inclusions in this PR:
PlotUploaderclass in tests_slow/plot_helpers.pyplot_objectfixture in tests_slow/conftest.py which returns object ofPlotUploaderclass.plot_spectrumof ``TestW7returns a figure which is passed directly toPlotUploader.upload()`PlotUploader.upload()handles upload to dokuwiki.