[FEATURE] Improve OS test extendability and readability
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 35/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- c
調査の方向性
まず OS Test モジュール、特に aio.c と、NuttX における既存の Unity testing-framework サポートを確認します。現在のケース構造とコンソール出力を Unity の規約と比較します。Done は、OS Test スイートが一貫性のある読みやすいテストケース構造を備え、成功したテストと失敗したテストを明確に報告することを意味します。
索引モデルが issue の本文から書いたものです。
説明
Is your feature request related to a problem? Please describe.
OS Test is the primary testing mechanism for NuttX. It is used on virtually all PRs to check for regressions in kernel code changes, and is also used as a basis for verifying that a new board has successfully gotten NuttX ported and running.
However, the output from OS test is a little cryptic when looking at it for the first time. It is often difficult to determine what tests have been run, what the output means and which tests have even passed/failed. There are many components to OS test, provided by different contributors, and they all have different outputs in the console which lead to more confusion.
It is also difficult to determine what the tests are right away by looking at the code. For instance, the aio.c test file contains a large code block with tests separated by comments that say "Case 1", "Case 2", etc. It requires effort to read and understand, but could be easier.
Describe the solution you'd like
My proposal is that OS Test be re-factored to use the Unity testing framework already supported by NuttX. This is a very lightweight testing framework that provides a structured approach to adding, writing and running test cases, as well as a nice summary output in the console that makes it clear which tests have passed or failed.
Since Unity is lightweight, works well and is supported by NuttX, I think moving to this approach would provide a clearly defined way for devs to add test cases and review the results of running the tests easily. The separated structure of test cases also means it will be easy to look at the test modules like aio.c and determine what tests already exist, what they do and maybe help to identify gaps that could use more tests.
Describe alternatives you've considered
I have considered just re-factoring the tests to have a more unified and structured output in the console, which would improve the ability of judging pass/fail results from logs, but that would require maintaining our own standard and I think it would be more work in the long run. Same for code-structure wise.
Verification
- I have verified before submitting the report.
- 主要言語
- C
- スター
- 474
- フォーク
- 807
- 平均マージ
- 1日 11時間
- マージ済み PR(30日)
- 181
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
apache/nuttx-apps のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
apache/nuttx-apps#4108 · コメント 4 件 ·
メンテナーはふだん 1 日以内に返信
-
[FEATURE] Shrink getprime runs for OSTest対応中かも @linguini1 が 41 日前に担当しました。 オープンType: Enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
apache/nuttx-apps#3620 · コメント 6 件 · リアクション 1 件 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 50/100
apache/nuttx-apps#4107 · コメント 3 件 ·
メンテナーはふだん 1 日以内に返信
-
[TODO] move graphics/input -> input.再び着手できるかも @cederom が 241 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
apache/nuttx-apps#3436 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
Community: Question
難易度 4/5 3〜5日 初心者へのやさしさ 20/100
apache/nuttx-apps#3134 ·
メンテナーはふだん 1 日以内に返信
apache/nuttx-apps の issue をすべて見る
似ている issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 82/100
trezor/trezor-firmware#8357 ·
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
good first issue kernel
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
JackFurton/who-would-build-a-kernel-in-java#316 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
PE5PVB/TEF6686_ESP32#970 ·
-
bug sev-3
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100