[FEATURE] Improve OS test extendability and readability
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 35/100
- Issue-Typ
- Feature
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- c
- Bereich
- embedded-iot, operating-systems, testing-qa
Rechercherichtung
Beginnen Sie mit der Überprüfung der OS Test-Module, insbesondere von aio.c, sowie der bestehenden Unterstützung für das Unity testing-framework in NuttX. Vergleichen Sie die aktuelle Struktur der Testfälle und die Konsolenausgabe mit den Konventionen von Unity. Done sollte bedeuten, dass die OS Test-Suite über eine konsistente, gut lesbare Struktur für Testfälle verfügt und bestandene sowie fehlgeschlagene Tests eindeutig meldet.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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.
- Vorherrschende Sprache
- C
- Sterne
- 474
- Forks
- 807
- Ø Merge
- 1 T. 11 Std.
- Gemergte PRs (30 T.)
- 181
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Kein Beitragsleitfaden
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus apache/nuttx-apps
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
apache/nuttx-apps#4108 · 4 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
-
[FEATURE] Shrink getprime runs for OSTestEvtl. vergeben @linguini1 hat das vor 41 Tagen übernommen. OffenType: Enhancement
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100
apache/nuttx-apps#3620 · 6 Kommentare · 1 Reaktion · 1 zugewiesene Person ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 50/100
apache/nuttx-apps#4107 · 3 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
-
[TODO] move graphics/input -> input.Evtl. wieder frei @cederom hat das vor 241 Tagen übernommen, und es ist kein Pull Request offen. Offen
apache/nuttx-apps#3436 · 1 zugewiesene Person ·
Maintainer antworten meist innerhalb von 1 Tag
-
Community: Question
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 20/100
apache/nuttx-apps#3134 ·
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in apache/nuttx-apps
Ähnliche Issues
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 82/100
trezor/trezor-firmware#8357 ·
Maintainer antworten meist innerhalb von 2 Tagen
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
Maintainer antworten meist innerhalb von 1 Tag
-
good first issue kernel
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
JackFurton/who-would-build-a-kernel-in-java#316 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 66/100
PE5PVB/TEF6686_ESP32#970 ·
-
bug sev-3
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100