Test improvements

オープン
#1,697 コメント 4 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 2 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
20/100
issue の種類
リファクタリング
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
c, erlang
領域
testing, tooling

調査の方向性

Read the example tests and README.md mentioned in the draft, then compare them with the tests in erlang_tests/ and libs/estdlib/. The issue proposes broad changes to test helpers, naming, organization, summaries, OTP compatibility, Valgrind, and flaky CI steps, so first identify which part remains relevant. Done means an agreed scope and corresponding test and CI changes; the issue gives no specific files or acceptance criteria.

索引モデルが issue の本文から書いたものです。

説明

I was working with tests for some time now and I have few observations:

  • Tests are split to NIFs and Erlang impl.
  • Running tests in BEAM works only from one directory (-pa .).
  • There are a lot of files in erlang_tests/. They're unorganized and few create a series that could be done in one module.
  • Some older tests use magic values for communicating intent, some new have own helpers that are copied around, some are hard to follow.

It should undergo some cleaning.

I'd propose that:

  1. tests should depend on set of common helpers. Some superset of macros in etest would be nice. Having both homebrew framework and etest is quite messy.
  2. we should decide on naming scheme, right now this is the mix of test_name and name.
    • I like prefixed names with category – e.g. nif_binary_match, gc_tree_ast, bin_mqqt, bif_pow, etc.
  3. estdlib should be treated specially and tests from erlang_tests and libs/estdlib should be merged.
  4. atom table shouldn't use atoms defined in default_atoms.def. They're always out of sync and it doesn't bring any value.
  5. TEST_CASE_EXPECTED should be removed prefering TEST_CASE.
  6. Test summary should be aggregated at the bottom, in format of "Test executed: {k}, tests skipped: {k}, tests failed: {k}\nFailed:\n{list of test modules}".
  7. clear designation when tests are available on later versions of BEAM. Would be nice to have macros that compile testing functions conditionally, like ok = ?RUN_WITH_MIN_OTP(24, binary_match_test_fun).
  8. Run Valgrind with full report (--leak-check=full). Right now it only gives a report about leaked memory and you need to run it yourself to see what leaked.
  9. Move known flaky tests (tcp, udp, etc) to separate steps or disable them completely until they're fixed. They very often fail CI and it's hard to see at glance if check failed due to flaky tests or changes to the code.

Draft of what it could look like (or any variation on that). Look in example tests and README.md.

Related: #1060

主要言語
Erlang
スター
2.3k
フォーク
171
平均マージ
5日 11時間
マージ済み PR(30日)
19

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

atomvm/AtomVM のほかの issue

atomvm/AtomVM の issue をすべて見る

似ている issue

Testing & QA の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。