Фикстуры — способ организации данных, с которыми вы хотите провести тестирование; короче говоря, образцовые данные.

Они хранятся в файлах YAML, по одному файлу на модель, которые размещаются в директории, указанной в ActiveSupport::TestCase.fixture_path=(path) (для Rails эта директория настраивается автоматически, поэтому вы можете просто положить свои файлы в <your-rails-app>/test/fixtures/). Файл фикстуры имеет расширение .yml (пример для Rails: <your-rails-app>/test/fixtures/web_sites.yml). Формат файла фикстуры выглядит так:

rubyonrails:
  id: 1
  name: Ruby on Rails
  url: http://www.rubyonrails.org

google:
  id: 2
  name: Google
  url: http://www.google.com

Этот файл фикстур содержит две фикстуры. Каждая фикстура YAML (т. е. запись) получает имя и за ним следует отстуженный список пар «ключ: значение» в формате «ключ: значение». Записи разделяются пустой строкой для удобства просмотра.

Обратите внимание, что фикстуры не упорядочены. Если вам нужны упорядоченные фикстуры, используйте тип YAML omap. См. yaml.org/type/omap.html для спецификации. Упорядоченные фикстуры понадобятся, если у вас есть ограничения внешних ключей на ключи в одной таблице. Это часто необходимо для древовидных структур. Пример:

--- !omap
- parent:
    id:         1
    parent_id:  NULL
    title:      Parent
- child:
    id:         2
    parent_id:  1
    title:      Child

Использование фикстур в тестовых случаях

Поскольку фикстуры — это инструмент тестирования, мы используем их в наших модульных и функциональных тестах. Существует два способа использования фикстур, но сначала давайте посмотрим на пример модульного теста:

require 'test_helper'

class WebSiteTest < ActiveSupport::TestCase
  test "web_site_count" do
    assert_equal 2, WebSite.count
  end
end

По умолчанию test_helper.rb загрузит все ваши фикстуры в вашу тестовую базу данных, поэтому этот тест будет успешным.

Тестовая среда автоматически загрузит все фикстуры в базу данных перед каждым тестом. Для обеспечения согласованных данных среда удаляет фикстуры перед запуском загрузки.

Помимо доступности в базе данных, данные фикстуры также могут быть доступны с помощью специального динамического метода, имеющего то же имя, что и модель, и принимающего имя фикстуры для создания экземпляра:

test "find" do
  assert_equal "Ruby on Rails", web_sites(:rubyonrails).name
end

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

test "find_alt_method_1" do
  assert_equal "Ruby on Rails", @web_sites['rubyonrails']['name']
end

test "find_alt_method_2" do
  assert_equal "Ruby on Rails", @rubyonrails.name
end

Чтобы использовать эти методы для доступа к данным фикстуры в ваших тестовых случаях, вы должны указать одно из следующих в вашем классе, производном от ActiveSupport::TestCase:

• для полного включения экземпляризованных фикстур (включите альтернативные методы #1 и #2 выше)

  self.use_instantiated_fixtures = true
  

• создать только хеш для фикстур, не «находя» каждый экземпляр (включить только альтернативный метод #1)

  self.use_instantiated_fixtures = :no_instances
  

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

Динамические фикстуры с ERB

Иногда вам не так важно содержимое фикстур, как их объем. В этих случаях вы можете смешать ERB со своими фикстурами YAML, чтобы создать множество фикстур для тестирования на нагрузку, например:

<% 1.upto(1000) do |i| %>
fix_<%= i %>:
  id: <%= i %>
  name: guy_<%= 1 %>
<% end %>

Это создаст 1000 очень простых фикстур.

Используя ERB, вы также можете вводить динамические значения в свои фикстуры с помощью встроек, например, <%= Date.today.strftime("%Y-%m-%d") %>. Однако это функция, которую следует использовать с осторожностью. Суть фикстур состоит в том, что они являются стабильными единицами предсказуемых образцовых данных. Если вы чувствуете необходимость вводить динамические значения, возможно, вам следует пересмотреть, можно ли должным образом тестировать ваше приложение. Следовательно, динамические значения в фикстурах следует рассматривать как признак плохой практики.

Вспомогательные методы, определенные в фикстуре, недоступны в других фикстурах, чтобы предотвратить нежелательные межтестовые зависимости. Методы, используемые несколькими фикстурами, должны быть определены в модуле, включенном в ActiveRecord::FixtureSet.context_class.

• определить вспомогательный метод в `test_helper.rb`

  module FixtureFileHelpers
    def file_sha(path)
      Digest::SHA2.hexdigest(File.read(Rails.root.join('test/fixtures', path)))
    end
  end
  ActiveRecord::FixtureSet.context_class.send :include, FixtureFileHelpers
  

• использовать вспомогательный метод в фикстуре

  photo:
    name: kitten.png
    sha: <%= file_sha 'files/kitten.png' %>

Транзакционные фикстуры

Тестовые случаи могут использовать begin+rollback, чтобы изолировать свои изменения в базе данных вместо необходимости удалять+вставлять для каждого тестового случая.

class FooTest < ActiveSupport::TestCase
  self.use_transactional_fixtures = true

  test "godzilla" do
    assert !Foo.all.empty?
    Foo.destroy_all
    assert Foo.all.empty?
  end

  test "godzilla aftermath" do
    assert !Foo.all.empty?
  end
end

Если вы предварительно загружаете свою тестовую базу данных всеми данными фикстур (вероятно, в задаче rake) и используете транзакционные фикстуры, то вы можете опустить все объявления фикстур в своих тестовых случаях, так как все данные уже там и каждый случай отменяет свои изменения.

Для использования экземпляризованных фикстур с предварительно загруженными данными установите self.pre_loaded_fixtures в значение true. Это обеспечит доступ к данным фикстур для каждой таблицы, которая была загружена с помощью фикстур (в зависимости от значения use_instantiated_fixtures).

Когда не следует использовать транзакционные фикстуры:

1. Вы тестируете, работает ли транзакция правильно. Вложенные транзакции не подтверждаются до тех пор, пока все родительские транзакции не подтвердятся, в частности, транзакция фикстур, которая начинается в настройке и отменяется в завершении. Таким образом, вы не сможете проверить результаты своей транзакции до тех пор, пока Active Record не будет поддерживать вложенные транзакции или точки сохранения (в разработке).

2. Ваша база данных не поддерживает транзакции. Каждая база данных Active Record поддерживает транзакции, за исключением MySQL MyISAM. Используйте InnoDB, MaxDB или NDB вместо этого.

Расширенные фикстуры

Фикстуры, которые не указывают идентификатор, получают дополнительные функции:

• Стабильные, автоматически сгенерированные идентификаторы

• Ссылки на метки для ассоциаций (belongs_to, has_one, has_many)

• Ассоциации HABTM в виде встроенных списков

• Автоматическое заполнение столбцов timestamp

• Интерполяция меток фикстур

• Поддержка значений по умолчанию YAML

Стабильные, автоматически сгенерированные идентификаторы

Вот фикстура обезьяны:

george:
  id: 1
  name: George the Monkey

reginald:
  id: 2
  name: Reginald the Pirate

Каждая из этих фикстур имеет два уникальных идентификатора: один для базы данных и один для человека. Почему бы нам не сгенерировать первичный ключ? Хэширование каждой метки фикстуры дает постоянный идентификатор:

george: # generated id: 503576764
  name: George the Monkey

reginald: # generated id: 324201669
  name: Reginald the Pirate

Active Record смотрит на класс модели фикстуры, определяет правильный первичный ключ и генерирует его прямо перед вставкой фикстуры в базу данных.

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

Ссылки на метки для ассоциаций (belongs_to, has_one, has_many)

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

belongs_to

Давайте выделим больше обезьян и пиратов.

### in pirates.yml

reginald:
  id: 1
  name: Reginald the Pirate
  monkey_id: 1

### in monkeys.yml

george:
  id: 1
  name: George the Monkey
  pirate_id: 1

Добавьте несколько обезьян и пиратов и разбейте это на несколько файлов, и становится довольно трудно отслеживать происходящее. Давайте вместо идентификаторов будем использовать метки:

### in pirates.yml

reginald:
  name: Reginald the Pirate
  monkey: george

### in monkeys.yml

george:
  name: George the Monkey
  pirate: reginald

Всё стало ясно. Active Record анализирует класс модели фикстуры, находит все belongs_to ассоциации и позволяет вам указать целевую **метку** для **ассоциации** (обезьяна: george) вместо целевого **идентификатора** для **внешнего ключа** (monkey_id: 1).

Полиморфные belongs_to

Поддержка полиморфных отношений немного сложнее, так как Active Record должен знать, к какому типу относится ваша ассоциация. Что-то вроде этого должно быть знакомо:

### in fruit.rb

belongs_to :eater, polymorphic: true

### in fruits.yml

apple:
  id: 1
  name: apple
  eater_id: 1
  eater_type: Monkey

Можем ли мы сделать лучше? Конечно!

apple:
  eater: george (Monkey)

Просто укажите тип целевого объекта полиморфной связи, и Active Record позаботится обо всём остальном.

has_and_belongs_to_many

Время дать нашей обезьяне немного фруктов.

### in monkeys.yml

george:
  id: 1
  name: George the Monkey

### in fruits.yml

apple:
  id: 1
  name: apple

orange:
  id: 2
  name: orange

grape:
  id: 3
  name: grape

### in fruits_monkeys.yml

apple_george:
  fruit_id: 1
  monkey_id: 1

orange_george:
  fruit_id: 2
  monkey_id: 1

grape_george:
  fruit_id: 3
  monkey_id: 1

Давайте уберем фикстуру HABTM.

### in monkeys.yml

george:
  id: 1
  name: George the Monkey
  fruits: apple, orange, grape

### in fruits.yml

apple:
  name: apple

orange:
  name: orange

grape:
  name: grape

Всё готово! Больше нет файла fruits_monkeys.yml. Мы указали список фруктов для фикстуры Джорджа, но мы могли бы с таким же успехом указать список обезьян для каждого фрукта. Как и в случае с belongs_to, Active Record анализирует класс модели фикстуры и определяет has_and_belongs_to_many ассоциации.

Автоматическое заполнение столбцов Timestamp

Если ваша таблица/модель определяет стандартные столбцы timestamp Active Record (created_at, created_on, updated_at, updated_on), они автоматически будут установлены в значение Time.now.

Если вы установили определённые значения, они останутся без изменений.

Интерполяция метки фикстуры

Метка текущей фикстуры всегда доступна как значение столбца:

geeksomnia:
  name: Geeksomnia's Account
  subdomain: $LABEL

Также иногда (например, при переносе более старых фикстур таблиц слияния) вам нужно получить идентификатор для заданной метки. ERB на помощь:

george_reginald:
  monkey_id: <%= ActiveRecord::FixtureSet.identify(:reginald) %>
  pirate_id: <%= ActiveRecord::FixtureSet.identify(:george) %>

Поддержка значений по умолчанию YAML

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

DEFAULTS: &DEFAULTS
  created_on: <%= 3.weeks.ago.to_s(:db) %>

first:
  name: Smurf
  <<: *DEFAULTS

second:
  name: Fraggle
  <<: *DEFAULTS

Любая фикстура с меткой «DEFAULTS» безопасно игнорируется.