Golden Master Testing: сложный вид рефакторинга

 require File.expand_path(File.dirname(__FILE__) + '/../test_helper') class LockdownTest < ActionController::TestCase # tell Rails which controller we're using tests StatsController def test_output_does_not_change # do some setup # call the endpoint # write the response to a file # compare the two files and make an assertion end end 

Нам на самом деле нужны два теста, по одному для каждой конечной точки. Все, кроме вызова шага конечной точки , в обоих случаях абсолютно одинаковы, поэтому создайте вспомогательный метод для всей панели:

 def with_golden_master(key) FileUtils.mkdir_p('.lockdown') FileUtils.touch(".lockdown/#{key}-approved.txt") login_as(:admin_user) Timecop.freeze(Time.utc(2014, 6, 5, 4, 3, 2, 1)) do yield end received = @response.body File.open(".lockdown/#{key}-received.txt", 'w') do |f| f.puts received end approved = File.read(".lockdown/#{key}-approved.txt") unless approved == received assert false, approval_message(key) end end def approval_message(key) <<-MSG FAIL: The output changed. Eyeball the differences with: diff .lockdown/#{key}-received.txt .lockdown/#{key}-approved.txt If you like the #{key}-received.txt output, then cp .lockdown/#{key}-received.txt .lockdown/#{key}-approved.txt MSG end 

Данные о приборах генерируются относительно сегодняшней даты, поэтому вам, вероятно, потребуется изменить значение Timecop на что-то через неделю или две в будущем, чтобы запустить тесты.

Затем фактически вызовите действия контроллера:

 def test_visible_running_chart_stays_the_same with_golden_master('vrt') do get :actions_visible_running_time_data end end def test_all_running_chart_stays_the_same with_golden_master('art') do get :actions_running_time_data end end 

Запустите тесты:

 $ ruby -Itest test/functional/lockdown_test.rb 

Скопируйте received файл поверх approved файла и повторите тест, чтобы убедиться, что он пройден.

Насколько хороши эти тесты?

Это зависит от того, насколько хороши данные. У треков есть фиксаторы, и в результате мы имеем более одного пункта данных в диаграммах, поэтому давайте предположим, что все в порядке.

Рефакторинг (наконец-то!)

Мы сделаем это по одному. Вот представление времени выполнения действий :

 <%- url_labels = Array.new(@count){ |i| url_for(:controller => 'stats', :action => 'show_selected_actions_from_chart', :index => i, :id=> "art") } url_labels[@count]=url_for(:controller => 'stats', :action => 'show_selected_actions_from_chart', :index => @count, :id=> "art_end") time_labels = Array.new(@count){ |i| "#{i}-#{i+1}" } time_labels[0] = "< 1" time_labels[@count] = "> #{@count}" -%> &title=<%= t('stats.running_time_all') %>,{font-size:16},& &y_legend=<%= t('stats.running_time_all_legend.actions') %>,10,0x736AFF& &y2_legend=<%= t('stats.running_time_all_legend.percentage') %>,10,0xFF0000& &x_legend=<%= t('stats.running_time_all_legend.running_time') %>,11,0x736AFF& &y_ticks=5,10,5& &filled_bar=50,0x9933CC,0x8010A0& &values=<%= @actions_running_time_array.join(",") -%>& &links=<%= url_labels.join(",") %>& &line_2=2,0xFF0000& &values_2=<%= @cumulative_percent_done.join(",") %>& &x_labels=<%= time_labels.join(",") %> & &y_min=0& <% # add one to @max for people who have no actions completed yet. # OpenFlashChart cannot handle y_max=0 -%> &y_max=<%=1+@max_actions+@max_actions/10-%>& &x_label_style=9,,2,2& &show_y2=true& &y2_lines=2& &y2_min=0& &y2_max=100& 

Во-первых, поскольку значения должны быть разделены между представлением и контроллером, включите url_labels в @url_labels и посмотрите, как проходят тесты. Сделайте то же самое для time_labels .

Когда мы перемещаем @url_labels в контроллер, тест не @url_labels .

 # approved /stats/show_selected_actions_from_chart/avrt?index=0 # received http://test.host/stats/show_selected_actions_from_chart/avrt?index=0 

Контроллер добавил http://test.host к сгенерированным URL. Мы можем заставить его возвращать только путь, передав ему параметр :only_path => true :

 url_for(:controller => 'stats', :action => 'show_selected_actions_from_chart', :index => i, :id=> "avrt", :only_path => true) 

Перемещение time_labels в контроллер работает без time_labels .

Следующие изменения еще проще. Для каждого интерполированного значения убедитесь, что контроллер устанавливает переменную экземпляра для окончательного значения:

 # Normalize all the variable names @title = t('stats.running_time_all') @y_legend = t('stats.running_time_legend.actions') @y2_legend = t('stats.running_time_legend.percentage') @x_legend = t('stats.running_time_legend.weeks') @values = @actions_running_time_array.join(",") @links = @url_labels.join(",") @values_2 = @cumulative_percent_done.join(",") @x_labels = @time_labels.join(",") # add one to @max for people who have no actions completed yet. # OpenFlashChart cannot handle y_max=0 @y_max = 1+@max_actions+@max_actions/10 

Мы можем внести те же изменения в видимые действия во время выполнения . Теперь, когда оба шаблона идентичны, обе конечные точки могут отображать один и тот же шаблон:

 render :actions_running_time_data, :layout => false 

Удалите неиспользованный шаблон и отпразднуйте.

Тогда возьмите лопату, немного пахнущих солей и приготовьтесь атаковать этого контролера. Это, однако, тема для другого поста (скоро, не волнуйтесь.)