Jest: テストに合格した場合はコンソールログを非表示にし、失敗した場合は表示します

カスタムレポーターを作成できます。 Cc @aaronabramov

テストの例を次に示します： https ：

こんにちは、役立つ情報をありがとう。

ただし、カスタムレポーターを作成しようとすると、いくつかの問題が発生しました。

• デフォルトのレポーターからすべての機能（有益なテスト出力など）を継承する簡単な方法はありません。すべてを最初から再実装したくありません。
• 構成にデフォルトのレポーターを含め、CLIで--silentを渡して（デフォルトのレポーターがコンソールログを非表示にするため）、カスタムレポーターを構成に追加すると、簡単な方法がわかりません。ログを印刷するカスタムレポーター。 --silentオプションが原因で、レポータークラスはバッファリングされたコンソールにアクセスできなくなったようです。

このため、失敗したテストでのみコンソールを表示する構成値を導入するパッチをJestに提案したいと思います。 そのようなパッチを検討しますか？

これには明らかにテストが必要であり、構成値を確認する必要がありますが、一般的な考え方は次のとおりです（機能しています）。

diff --git a/packages/jest-cli/src/reporters/default_reporter.js b/packages/jest-cli/src/reporters/default_reporter.js
index 08d4a9f2..adedbdd3 100644
--- a/packages/jest-cli/src/reporters/default_reporter.js
+++ b/packages/jest-cli/src/reporters/default_reporter.js
@@ -176,7 +176,8 @@ class DefaultReporter extends BaseReporter {
       this.log(getResultHeader(result, config));

       const consoleBuffer = result.console;
-      if (consoleBuffer && consoleBuffer.length) {
+      const testFailed = result.numFailingTests > 0;
+      if (testFailed && consoleBuffer && consoleBuffer.length) {
         this.log(
           '  ' +
             TITLE_BULLET +

私は実際にこのアイデアが好きですが、考慮しなければならないことがたくさんあります

非表示の出力に関する情報を追加する必要があります

PASS __tests__/my_test.js (hidden output)

また、いくつかのテストまたは単一のテストを実行する場合は無効にする必要があります（ほとんどの場合、完全なテスト実行でのみ有効にする必要があります）

@cpojerこれについて何か考えはありますか？

この動作は紛らわしいと思います。状態に関係なく、Jestがテストごとに出力する内容に一貫性があることを望んでいます。

@cpojer私にとって、失敗した私のテストに関連するコンソールメッセージを見つけようとするのは混乱します：/それを達成するためのより良い方法を提案できるなら、そうしてください。

妥協案として、 jest.jsでDefaultReporterを公​​開するパッチを受け入れて、拡張できるようにしますか？ それ以外の場合は、この機能をカスタムレポーターに実装するために、ワールドをコピーして貼り付ける必要があります。

これは私のテスト出力がどのように見えるかです：

https://github.com/facebook/flow/issues/4673のために警告を取り除くことができず、幸いなことにログメッセージは2つしかありませんが、ログを追加したい場合はさらに悪化します。

次に、

同意しました。PASSテストのコンソール出力を非表示にし、FAILEDテスト用に残すフラグを設定すると、テスト出力を読みやすくするための優れた追加機能になります。

同意します。 私は現在、多数のテストグループを含むプロジェクトに取り組んでおり、テストに合格すると、デバッグ時にワークフローが難しくなります。

PASSテストのコンソール出力を非表示にするフラグについて合意しました。

PASS __tests__/my_test.js (hidden output)

万が一、この追加を再検討してもらえますか？

これで、失敗したテストを実行する方法ができました。これは、このユースケースをカバーするはずです。 ＃4886を参照（jest 22で利用可能）

これで、失敗したテストを実行する方法ができました。これは、このユースケースをカバーするはずです。

ケースを部分的にカバーするだけです。 たとえば、ロギングが多いスイートで100個のテストのうち5個が失敗した場合、失敗したテストのみを再実行して、コンソール出力を理解することができます。 ただし、テストに合格するためにログを非表示にしていた場合は、テストを再実行する必要はありません。

また、失敗したテストのみを再実行すると、コードの編集によって発生した新しいテストの失敗をキャッチできないという欠点があります。

コアチームがこの機能を実装したくない場合、誰かが私の提案を妥協てもらえますか？ この提案により、コンソールの非表示を実装するためのカスタムレポーターをより簡単に作成できるようになります。 パッチを作成することはできますが、受け入れられない場合はプルリクエストを送信したくありません。

@ kumar303はPRを送ってください。維持するのはかなり複雑ではないようです:)

@ kumar303 PRを提出することになったのですか？ これも欲しいです。

まだ提出するつもりですが、他の優先事項の間に時間を見つけることができませんでした。 他の誰かが私を殴ったら、私に知らせてください。私がそれをテストするのを手伝うことができます！

私のアイデアは、カスタムレポーターが拡張できるようにjest.jsからDefaultReporterをエクスポートすることでした。 私はこの行を次のようなものに変更することから始めようと考えていました。

const testFailed = result.numFailingTests > 0;
if (testFailed && consoleBuffer && consoleBuffer.length) {
  // Log console output
}

その後、さらに微調整が必​​要になると確信しています。

@ kumar303 jest設定にコードを追加するにはどうすればよいですか？

私もこれに興味があります。 @ kumar303のアイデアに従って、 default_reporter簡単に拡張するカスタムレポーターを作成し（ただし、 jest-cli/build/reporters/default_reporterから直接インポートしているため、脆弱です）、 result.console変換することができました。適切と思われる

1つのテストを実行する場合、コンソールメッセージはバッファリングされないということを除いて、正常に機能します。 これはここで言及されています： https ：

したがって、これらのシナリオでは、カスタムレポーター内からコンソール出力に影響を与えることはできません。 したがって、カスタムレポーターを使用してコンソール出力を管理するという@thymikeeの当初の提案は、jestにコンソール出力を常にバッファリングさせる方法がない限り、普遍的に機能するとは思いません。

デフォルトのレポーターをよりクリーンな方法で公開できてうれしいです。

console.logsの強制バッファリングに関する別の問題を開いてみませんか？ 一貫している必要があります

showLogsForFailedTests: trueようなグローバル構成変数を持つことには重大な欠点がありますか？ デフォルト値はJestの現在の動作から何も変更されておらず、 falseの値は、テストの読み取りをはるかに快適にします。

この問題は、修正のために何かが行われたためにクローズされたのでしょうか、それとも30人以上の人々が、実際には発生していないJestに問題があると想像しているためにクローズされたのでしょうか。

少年、これは冗談の失敗したログのみを表示するためのほぼ標準的なアプローチだと思いました...これはまだ問題ですか？

これが必要です。 それは本当に混乱します。

参考： https ： @ kumar303のアイデアを実装することに成功しました。 js

• このレポーターなし： https ：
• このレポーターの場合： https ：

@willdurand私はあなたのレポーターを試しました。 そのファイルをレポーターとして選択するだけだったので、何が間違っていたのかわかりません。 テストの最後にこれが表示されないようにするだけでした。

Test Suites: 48 passed, 48 total
Tests:       78 passed, 78 total
Snapshots:   73 passed, 73 total

テスト中のすべてのログはまだ表示されていました。

たぶん1回のテストだけで実行しましたか？ 私の以前のコメントを見て、
関連するバグレポート。 レポーターでログをキャプチャすることはできません
テストを1つだけ実行する場合、これが本当の問題です。

水、2018年8月8日、19:08 jazoomに[email protected]書きました：

@willdurandhttps ：//github.com/willdurandレポーターを試してみました。 私
そのファイルを選択するだけだったので、何が間違っていたのかわからない
レポーターとして。 それがしたのは、これが最後に表示されないようにすることだけでした
テスト：

テストスイート：48合格、合計48
テスト：78合格、合計78
スナップショット：合格73、合計73

テスト中のすべてのログはまだ表示されていました。

—
このスレッドにサブスクライブしているため、これを受け取っています。
このメールに直接返信し、GitHubで表示してください
https://github.com/facebook/jest/issues/4156#issuecomment-411582223 、またはミュート
スレッド
https://github.com/notifications/unsubscribe-auth/AAi-gO9_uEJPO4xnhkpfGore_hEX81fUks5uO29bgaJpZM4OnBQQ
。

@ jamietre48のスイートを実行したテストで使用したのとまったく同じコマンドで実行しました。

編集：明確にするために、同じコマンドを2回実行しました。 カスタムレポーターとの唯一の違いは、最後にこの要約を印刷しなかったことです。

Test Suites: 48 passed, 48 total
Tests:       78 passed, 78 total
Snapshots:   73 passed, 73 total

構成にverbose: trueがある場合、 @ jazoomレポーターは効果がありません。 false設定してみてください。

@jamietre同意します。 1回のテスト実行でコンソール出力がまったくキャプチャまたは表示されないのは奇妙な動作です（https://github.com/facebook/jest/issues/6441）。

また、jestがコンソール出力をテストによってグループ化しない方法も役に立ちません（https://github.com/facebook/jest/issues/2080）。 カスタムレポーターは、スイートの出力（つまり、テストファイル）のみを表示でき、特定の失敗したテストは表示できません。

@jazoomは、レポーターをインストールまたは変更した後、jestを完全に再起動することも確認してください。 jestは実行中に他のソースファイルへの変更を認識しますが（レポーターは認識しないため）、これは明らかではない場合があります。

@ kumar303詳細に設定されていません

「完全に再起動する」とはどういう意味ですか？ 実行されるのは単なるスクリプトです。

「完全に再起動する」とはどういう意味ですか？

つまり、jestのウォッチモードになっている場合は、終了する必要があります。

わかった。 ウォッチモードは使用していません。

ああ、確かに。 私は気づきませんでしたが、いくつかの理由で、すべてのテストスイートが実行されると、Jestは下部に最終的な要約を出力しません。

これは、 SummaryReporterではなくDefaultReporterを拡張するためだと思います。

@willdurandログを正常に非表示にする構成を試しました。 ただし、端末はこれ以上クリアされず（以前のログ）、すべてのログが他のログの下にスタックされます。

注： DefaultReporterクラスをエクスポートするだけで、デフォルトのログにフォールバックしますが、ログもスタックします

@ kumar303 /
ただし、他の人が指摘したように、テストの最後にテストの概要は出力されません。 これは、（私が思うに）デフォルトのJest設定が2つのレポーター（DefaultReporterとSummaryReporter）を使用しているためです。
現在、SummaryReporterはデフォルトでエクスポートされており、インポートできないように見えるため、jest構成に直接インポートできません。 別のファイルから再エクスポートすることで回避できました。

//summary-reporter.js
const SummaryReporter = require('@jest/reporters/build/summary_reporter')
  .default;
module.exports = SummaryReporter;

//log-on-fail-reporter.js
Content: https://gist.github.com/GeeWee/71db0d9911b4a087e4b2486386168b05
Same as reporter above, but with updated import paths for the new jest structure

ジェスト構成

    "reporters": [
      "<rootDir>/src/test-reporters/log-on-fail-reporter.js",
      "<rootDir>/src/test-reporters/summary-reporter.js"
    ],

編集：少し遊んだ後、1​​つのテストが失敗した場合でも、describeブロック全体のログが記録されることがわかります。

jest25のデフォルトのエクスポートのサポートを修正します。

あなたもすることができます

//summary-reporter.js
const {SummaryReporter} = require('@jest/reporters')
module.exports = SummaryReporter;

@jest/reporters/SummaryReporterなどのファイルを追加したいので、中間のjsファイルは必要ありません...そのための別の機能リクエストを開きたいですか？

この機能リクエストがクローズされるのはなぜですか？
多くの人が、この機能をすぐに使える冗談に含めるのが合理的だと思っているようです。 少なくとも構成オプションとして。
@ kumar303でもう一度開けてもらえますか？

@ kumar303でもう一度開けてもらえますか？

ふふ。 いいえ、アクセスできません。 これが閉鎖の理由でした： https ：//github.com/facebook/jest/issues/4156#issuecomment-324638718私はそれが不可欠な機能であることに同意します。 コアジェスト開発者がそれなしで生きることができることに私は驚いていますが、おそらく彼らはバグのあるコードを書かないので、ログを必要としません。

再度開いてください。 これも必要です。

なぜこれがまだ不可能なのですか？

私には簡単な機能のように思えます。 私たちのテストのほとんどは、それぞれ少なくとも1ページのコンソールテキストを生成します。失敗したテストを見つけるためにそれを通り抜けなければならないのは非常に面倒です。

コメントを残す以外に、この動作のサポートを登録する方法はありません。 👍などはあまり役に立たないので、これが私にできる最善の方法です。 関係者の皆様、ありがとうございました！ 私はすべてのスレッドをたどりました、そして人々が人々に彼らが望むものを手に入れるためのサイクルがあるときはいつでもこれを楽しみにしています笑。

この機能が必要なときに、この機能が3年近く実装されていないのは、ちょっと奇妙なことです。

インターネットで見つけたスニペットに基づいて、このためのグローバル構成を思いつきました。 https://stackoverflow.com/questions/58936650/javascript-jest-how-to-show-logs-from-test-case-only-when-test-fails/61909588#61909588を参照して

うまくいけば、これは誰かを助けるでしょう。

非同期キャプチャについては、 https：//github.com/AtakamaLLC/capioを参照して

再度開いて、オプションの構成として実装してください。
PRが受け入れられる現実的なチャンスがあれば、私は自分でそれを行います。
私の見解では、この「小さな」機能要求に対してカスタムレポーターを作成することは、持続不可能なメンテナンスのオーバーヘッドになります。

この機能要求は「クリーン」でも「一貫性」でもありませんが、それでも多くの人々から非常に必要とされています。