result_image redundancy

[bjlittle]

In the plugin.ImageComparison.compare_image_to_hash_library method, during hybrid-mode, the result_image appears to be unnecessarily copied into the summary dictionary from the outcome of plugin.ImageComparison.compare_image_to_baseline:

pytest-mpl/pytest_mpl/plugin.py

Lines 571 to 573 in e387618

	for k in ['image_status', 'baseline_image', 'diff_image',
	'rms', 'tolerance', 'result_image']:
	summary[k] = summary[k] or baseline_summary.get(k)

i.e., the summary['result_image'] has already been correctly set within plugin.ImageComparison.compare_image_to_hash:

pytest-mpl/pytest_mpl/plugin.py

Lines 551 to 554 in e387618

	# Save the figure for later summary (will be removed later if not needed)
	test_image = (result_dir / "result.png").absolute()
	fig.savefig(str(test_image), **savefig_kwargs)
	summary['result_image'] = test_image.relative_to(self.results_dir).as_posix()

If this is the case, are you happy for me to remove this behaviour?

[dopplershift]

Actually, it looks like compare_image_to_baseline duplicates the entire 3-line block of setting up the result image, which doesn't seem necessary at all?

[Cadair]

I suspect that it could be tidied up, feel free to go for it.

I think it was @ConorMacBride who touched this section last?

[ConorMacBride]

compare_image_to_baseline runs:

pytest-mpl/pytest_mpl/plugin.py

Lines 445 to 447 in e387618

	test_image = (result_dir / "result.png").absolute()
	fig.savefig(str(test_image), **savefig_kwargs)
	summary['result_image'] = test_image.relative_to(self.results_dir).as_posix()

So technically the result_image file generated in compare_image_to_hash_library is different to the new one generated by compare_image_to_baseline, although it should be at the same path. I just set it to copy the result_image to be safe, as both methods define their own (but equal) path.

These three lines are duplicated because the plugin can do baseline image comparison, hash library comparison or both (hybrid mode). But to prevent saving twice, maybe they should be moved to a separate method which only saves if it doesn't already exist.