Feature Request: Tests filters in pipeline

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

維護者通常 3 天內回覆

還沒有人認領這個 Issue。

評估

難度
5/5
預估耗時
一週以上
新手友好度
28/100
Issue 類型
功能
描述清晰度
需要釐清
活躍度
停滯
領域
testing

研究方向

先閱讀 OpenTabletDriver.Plugin/Output/OutputMode.cs 第 62-90 行附近的內容,以了解 PipelinePosition 如何控制篩選器插入。先確定 0.6.x 的測試方案,然後涵蓋未消費的 IDeviceReports 和無效的 PipelinePosition 值,同時不要大幅擴大對 0.5.x API 的涵蓋範圍。

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

描述

The OpenTabletDriver 0.6.x plugin pipeline has edge cases that can cause filter plugins to incorrectly drop reports.

For plugins with filters targeting the 0.6.x plugin API the following tests should be done.

Plugins targeting earlier API's like 0.5.x should preferably not be covered if it significantly increases the amount of code to maintain.

It is unclear how to implement these tests properly. I currently have 2 ideas:

  • Have a separate repository that can be targeted as a GitHub action, that tests the filter in a virtual pipeline, which could be used to test pull requests on this repository in some way.
  • Driver gets a "Plugin Developer" mode that would actively check active filters for these issues - this would help plugin developers from making these mistakes unintentionally.

While outside of the scope of this issue, future driver plugin API's should preferably be designed in a way that removes these necessary tests.

Minimum Test Coverage

At the very minimum, the tests should check for the following

Properly passes through IDeviceReports

Some filters incorrectly only pass through ITabletReports. Normal filters should ensure Consume(IDeviceReport) runs Emit?.Invoke(). Async filters should ensure ConsumeState() runs OnEmit() (or Emit?.Invoke()) on unconsumed reports.

Sets a PipelinePosition that isn't PreTransform or PostTransform (or an alias)

Currently, the driver only links filters that have a PipelinePosition with one of the above values as seen here:
https://github.com/OpenTabletDriver/OpenTabletDriver/blob/aa345e5b7365647f25c8651f3e35fb7dd4c13676/OpenTabletDriver.Plugin/Output/OutputMode.cs#L62-L90

This means that a PipelinePosition of e.g. 0 would result in the filter never being inserted into the pipeline.


If you think of anything else that would be worth testing for, please let us know here.

主要語言
Shell
星號
10
分支
44
平均合併
2 天 15 小時
30 天內合併 PR
5

環境準備

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

從這裡開始

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

OpenTabletDriver/Plugin-Repository 的其他 Issue

查看 OpenTabletDriver/Plugin-Repository 的全部 Issue

相似的 Issue

更多 Shell/Bash Issue

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

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