New media-container hides information from user

未關閉
#780 1 則留言 1 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

評估

難度
4/5
預估耗時
3-5 天
新手友好度
35/100
Issue 類型
功能
描述清晰度
基本清楚
活躍度
停滯
技術堆疊
python
領域
frontend

研究方向

首先定位建立 media-container 的 report-rendering 進入點,並檢視 pytest-html v4.x 中影像的顯示方式。將該行為與所要求的 non-carousel 呈現方式進行比較。當使用者可以在不使用 media-container 的情況下顯示所有 plot,同時保留報告的其他媒體行為時,即表示完成。

由索引模型根據 Issue 內容生成。

描述

Hi there,

Currently porting my project to using the new pytest-html v4.x version.

I noticed that images (haven't tried any other of the extra types yet) are now put in a media-container that can be scrolled through using small arrow buttons. Previously in v3.x the plots were put in a grid in the right hand side of the test log for each test case.

This is purely my opinion based on my usage and needs for pytest-html. At first I was confused since I initially though only a single plot had been added to the report. Some debugging and staring later I noticed that the rest of the plots were hidden in the carousel.

I discussed it with my colleagues and we agree that the new behavior effectively hides a lot of information from the user/engineer. Whether a test passes or not, a lot of information can be gained at a glance by quickly looking at all the images/plots at the same time. Eg. if we have plots for current, voltage and power consumption, you could easily see whether some condition in test caused a spike in current consumption and/or a voltage drop. This behavior might not be a show-stopper or cause the test to fail (this time around anyway), but it would make the engineers aware of the behavior and either start an investigation now or in the future. It might also save a lot of time during debugging down the road because "someone noticed something" in one of the plots at an earlier time.

We usually scroll through the test cases in the report after a test run and look briefly at the graphs whether a test passed or not. This was also more in line of the "show all details" button, since we aren't shown all the details anymore.

Also, some of the senior engineers and project managers haven't been too happy being sent a .zip with a HTML file, assets folder and a folder full of plots. A nice side effects of the old behavior was that I could quickly save the report as a PDF and send it to them for inspection. While not a full-blown PDF export feature, it did the trick.

Otherwise, super happy with this plugin!

TL;DR: We would want a way to remove the media-container and display all the plots to avoid hiding information in the report.

主要語言
Python
星號
779
分支
263
PR 合併指標
30 天內沒有已合併 PR

環境準備

這個專案沒有提供開發容器、Dockerfile 或貢獻指南,環境需要你自己搭建:先看它的 README,通用步驟見我們的新手貢獻指南。

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

pytest-dev/pytest-html 的其他 Issue

查看 pytest-dev/pytest-html 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。