ciが失敗したときだけログ出力するgemを作った

• willnet/ci_logger

• とりあえず動くのでリリースしようぜ、でv0.1.0をリリースした

  • もうちょい使ってこなれてきたら&&速いのが検証できたらちゃんとブログに書こうと思います

• CIを速くするためのプラクティスとして「ログ出力を止める」というのがある

  • が、それってどうなの、と思っていた
  • 速くなるのはいいけど、ログがないと時々失敗するテストの調査ができないのでは
  • というわけで、テストが失敗したときだけログを出せると全てうまくいくのでは、となりそういうのを作った
    • しかしサバンナはもともとCI時にinfoでログ出力をしていたせいでパット見てわかるほどの差はない
    • debugなプロジェクトと比較する必要がある

• コード自体は基本的には大したことしてないが、RSpecと連携させるところで苦労した

  • 「テストが失敗した」という情報はafter hookでは取れない(RSpec3あたりからそうなった模様)
    • ref: ExecutionResult is coming back empty · Issue #2011 · rspec/rspec-core
  • ↑にあるように、独自のformatterを作り登録する必要があった

• テストのほうが大変だった

  • RSpecを使っていれば自動的に連携するようにしたが、それをテスト上で動かすのがたいへん

• ↓のようなテストを作ることで、minitestの上でRSpecを動かすことができる

  • やろうと思えばRSpecの上でRSpecを動かすこともできる(実際rspec-coreのテストはこのようなコードをRSpec上で動かしていた
  • group.runに対してreporterというものを引数で渡さないとformatterが発火しない(NullReporterがデフォルト値になっている)、というところで1時間ほど溶かした＞＜
  • reporterがイベントを通知して、対応するイベントを購読しているformatterのメソッドが実行されるという構成になっている
  • reporterはformatterと紐付いているので、テスト用にReporter.newのようにするとformatterと紐付いていないreporterができてしまい意図通りにformatterが発火しない
    • これも1時間ほど溶かした
    • 関連コード https://github.com/rspec/rspec-core/blob/97a6f23a6c9e940a9c019d5338250a940d2d5c41/lib/rspec/core/configuration.rb#L1001
    • なので、configからたどってreporterを持ってくる必要があるのだった
      • ex: @reporter = RSpec.configuration.formatter_loader.reporter

  test "success test doesn't write logs on CiLogger enabled" do
    group = RSpec.describe 'hello', type: :request
    group.example do
      get '/users'
      expect(response.status).to eq 200
    end
    group.run(@reporter)
    assert File.empty?(LOGFILE_PATH)
  end   

email_address_with_nameメソッド

• メールの送り先をName <email@example.com>形式にするためのメソッド
• あるの知らなかった
• メールアドレスと名前を引数で渡すのだけど、これまでは名前がないときは" <foo@example.com>"のように微妙な表示になっていたのがメールアドレスだけを返すようになった
• Return just the address if name is blank by thutterer · Pull Request #42970 · rails/rails