Setup test flakiness monitoring, reporting, and SOP

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

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

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
go

調査の方向性

まず ci-flakiness-badge を含む go-libp2p のツールを確認し、boxo に採用できるものを判断します。flaky なテストの上位を特定し、時間の経過に伴う傾向を測定し、flaky なテストの扱いを文書化するための reporting workflow と SOP を定義します。issue ではファイルやテストは指定されていません。

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

説明

kind/test topic/project-management

Done Criteria

We have data insights showing our top flaky tests, and we can quantify how this is trending with time.
We also have an SOP on how we handle flaky tests. This shouldn't be tribal knowledge or guess work.

Why Important

Flaky tests will doom this endeavor because it will either:

  1. Delay getting releases out, even when a small change was made in a tiny module OR
  2. Catch us in the tar pit of relying on human judgement of whether we can merge/release or not. We won't make this judgement correct all the time, and unnecessary bugs will slip out the door.

We want to be able to quickly spot flakiness so we know where to eradicate it.

Notes

go-libp2p has tooling (including a ci-flakiness-badge) that I think we can follow/adopt/use.

主要言語
Go
スター
326
フォーク
165
PR マージ指標
30日以内にマージされた PR はありません

環境構築

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

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

ipfs/boxo のほかの issue

ipfs/boxo の issue をすべて見る

似ている issue

Go の issue をもっと見る

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

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