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

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

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

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

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

Вспомогательные методы, определенные в фикстуре, не будут доступны в других фикстурах, чтобы предотвратить нежелательные межтестовые зависимости. Методы, используемые несколькими фикстурами, должны быть определены в модуле, который включён в ::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.include FixtureFileHelpers
  

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

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

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

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

class FooTest < ActiveSupport::TestCase
  self.use_transactional_tests = 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 вместо этого.

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

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

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

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

• Ассоциации HABTM как списки в строке

Доступны некоторые более продвинутые функции, даже если ID указан:

• Автозаполняемые столбцы timestamp

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

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

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

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

george:
  id: 1
  name: George the Monkey

reginald:
  id: 2
  name: Reginald the Pirate

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

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

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

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

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

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

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

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

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

### 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) вместо целевого ID для внешнего ключа (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
  email: $LABEL@email.com

Кроме того, иногда (например, при переносе старых фикстур таблиц присоединения) вам необходимо получить идентификатор для данной метки. 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» безопасно игнорируется.

Настройка класса модели фикстуры

Возможна установка класса модели фикстуры непосредственно в файле YAML. Это полезно, когда фикстуры загружаются вне тестов и set_fixture_class недоступны (например, при запуске rails db:fixtures:load).

_fixture:
  model_class: User
david:
  name: David

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