03-01-minitest_reporters.md

Unit 3

Chapter 1: Minitest Reporters

In this chapter, you will set up Minitest Reporters. It provides features like red/green displays and a list of the most time-consuming tests within your test suite.

New Branch

Enter the command "git checkout -b 03-01-minitest_reporters".

Gemfile

• Add the following lines to the end of the Gemfile:

# Minitest
gem 'minitest', require: :false, group: :testing
gem 'minitest-reporters', require: :false, group: :testing # Adds special features to tests

• Enter the command "sh git_check.sh".
• Enter the following commands:

git add .
git commit -m "Installed minitest-reporters"

Configuration

• Add the file test/rake_rerun_reporter.rb and give it the following contents:

# Providing commands for running failed tests:
# https://gist.github.com/foton/141b9f73caccf13ccfcc

# Providing brighter colors in test reults:
# http://chriskottom.com/blog/2014/06/dress-up-your-minitest-output/

# rubocop:disable Metrics/AbcSize
# rubocop:disable Metrics/LineLength
# rubocop:disable Metrics/MethodLength

require 'minitest/reporters'

module Minitest
  module Reporters
    class RakeRerunReporter < Minitest::Reporters::DefaultReporter
      GREEN = '1;32'.freeze
      RED = '1;31'.freeze

      def color_up(string, color)
        color? ? "\e\[#{color}m#{string}#{ANSI::Code::ENDCODE}" : string
      end

      def red(string)
        color_up(string, RED)
      end

      def green(string)
        color_up(string, GREEN)
      end

      def initialize(options = {})
        @rerun_user_prefix = options.fetch(:rerun_prefix, '')
        super
      end

      def report
        super

        puts

        unless @fast_fail
          # print rerun commands
          failed_or_error_tests = (tests.select { |t| t.failure && !t.skipped? })

          unless failed_or_error_tests.empty?
            puts red("You can rerun failed/error test by commands (you can add rerun prefix with 'rerun_prefix' option):")

            failed_or_error_tests.each do |test|
              print_rerun_command(test)
            end
          end
        end

        # summary for all suites again
        puts
        print colored_for(suite_result, result_line)
        puts
      end

      private

      def print_rerun_command(test)
        message = rerun_message_for(test)
        return if message.nil? || message.strip == ''
        puts
        puts colored_for(result(test), message)
      end

      def rerun_message_for(test)
        file_path = location(test.failure).gsub(/(\:\d*)\z/, '')
        msg = "#{@rerun_user_prefix} rake test TEST=#{file_path} TESTOPTS=\"--name=#{test.name} -v\""
        if test.skipped?
          "Skipped: \n#{msg}"
        elsif test.error?
          "Error:\n#{msg}"
        else
          "Failure:\n#{msg}"
        end
      end

      def location(exception)
        last_before_assertion = ''

        exception.backtrace.reverse_each do |ss|
          break if ss =~ /in .(assert|refute|flunk|pass|fail|raise|must|wont)/
          last_before_assertion = ss
          break if ss =~ /_test.rb\:/
        end

        last_before_assertion.sub(/:in .*$/, '')
      end
    end
  end
end

# rubocop:enable Metrics/AbcSize
# rubocop:enable Metrics/LineLength
# rubocop:enable Metrics/MethodLength

• In the test/test_helper.rb file, insert the code for configuring Minitest Reporters between the line "require 'rails/test_help'" and the line "class ActiveSupport::TestCase". Your code should look like this:

...
require 'rails/test_help'

# BEGIN: use minitest-reporters
require 'minitest/reporters'
require 'rake_rerun_reporter'
Minitest::Reporters.use!

reporter_options = { color: true, slow_count: 5, verbose: false, rerun_prefix: 'rm -f log/test.log && bundle exec' }
Minitest::Reporters.use! [Minitest::Reporters::HtmlReporter.new,
                          Minitest::Reporters::RakeRerunReporter.new(reporter_options)]
# END: use minitest-reporters

class ActiveSupport::TestCase
...

• Add the following line to the end of .gitignore:

test/html_reports/

• Enter the command "sh git_check.sh".
• Enter the following commands:

git add .
git commit -m "Updated test/test_helper.rb for minitest-reporters"

First Test

• Enter the command "rails generate integration_test test1". This creates the file test/integration/test1_test.rb.
• Give test/integration/test1_test.rb the following content:

require 'test_helper'

class Test1Test < ActionDispatch::IntegrationTest
  test 'home page has expected title and heading' do
    get '/'
    assert_select 'title', 'Home'
    assert_select 'h1', 'Home'
  end

  test 'home page has expected content' do
    get '/'
    assert_match 'Welcome to public/index.html!', response.body
  end
end

• Enter the command "rails test". You'll see that the test for the title and heading fail.
• In the test results, you'll see a section that looks something like:

You can rerun failed/error test by commands (you can add rerun prefix with 'reru
n_prefix' option):

Failure:
rm -f log/test.log && bundle exec rake test TEST=/home/winner/shared/generic_rai
ls_2016_09_25/test/integration/test1_test.rb TESTOPTS="--name=test_home_page_has
_expected_title_and_heading -v"

• To rerun just the test that failed, all you have to do is copy and paste the command provided. Just cut, paste, and enter into your shell window the following:

rm -f log/test.log && bundle exec rake test TEST=/home/winner/shared/generic_rai
ls_2016_09_25/test/integration/test1_test.rb TESTOPTS="--name=test_home_page_has
_expected_title_and_heading -v"

• You can also write this command into an alias. Just enter the following command:

alias test1='(command to be copied)'

• Then enter the command "test1" to rerun this test.
• NOTE: All aliases that you create are automatically destroyed upon exiting the tmux window.
• Replace the contents of the public/index.html file with the following:

<html>
    <head>
        <title>Home</title>
    </head>
    <body>
	<h1>Home</h1>	
    Welcome to public/index.html!
    </body>
</html>

• Enter the command "test1". Now the test passes.
• Enter the command "rails test". All of the tests should pass now.
• Enter the command "sh git_check.sh".
• Enter the following commands:

git add .
git commit -m "Successfully completes first test"
git push origin 03-01-minitest_reporters

Wrapping Up

• Go to the GitHub repository and click on the "Compare and pull request" button for this branch.
• Accept this pull request to merge it with the master branch, but do NOT delete this branch.
• Enter the following commands:

git checkout master
git pull
sh heroku.sh