gitlab-org--gitlab-foss/spec/migrations
Rémy Coutable 781d2c22f4 Merge branch '37552-replace-js-true-with-js' into 'master'
Replaces `tag: true` into `:tag` in the specs

Closes #37552

See merge request gitlab-org/gitlab-ce!14653
2017-10-09 12:23:26 +00:00
..
active_record
add_foreign_key_to_merge_requests_spec.rb Use batching to clear orphans in head_pipeline migration 2017-07-18 12:07:12 +02:00
add_head_pipeline_for_each_merge_request_spec.rb Add a project forks spec helper 2017-10-07 11:46:23 +02:00
calculate_conv_dev_index_percentages_spec.rb Store & use ConvDev percentages returned by Version app 2017-08-07 20:52:08 +02:00
clean_appearance_symlinks_spec.rb Merge branch 'bvl-remove-appearance-symlink' into 'security-9-3' 2017-07-19 22:28:17 -05:00
clean_stage_id_reference_migration_spec.rb Fix background migration cleanup specs 2017-07-20 10:53:52 +02:00
clean_stages_statuses_migration_spec.rb Make sure all stages are migrated after a cleanup 2017-09-18 13:47:46 +02:00
clean_upload_symlinks_spec.rb Update migrations to move directly into the -/system folder 2017-08-11 18:15:02 +02:00
cleanup_move_system_upload_folder_symlink_spec.rb Move the uploads/system folder to uploads/-/system 2017-07-18 15:38:54 +02:00
cleanup_namespaceless_pending_delete_projects_spec.rb Refactor project and storage types 2017-08-22 06:33:20 +02:00
cleanup_nonexisting_namespace_pending_delete_projects_spec.rb Migration to remove pending delete projects with non-existing namespace 2017-08-22 14:29:54 +02:00
convert_custom_notification_settings_to_columns_spec.rb Revert "Merge branch 'revert-f2421b2b' into 'master'" 2017-09-11 15:44:42 +00:00
delete_conflicting_redirect_routes_spec.rb Reduce batch size 2017-09-14 14:17:23 -07:00
fix_wrongly_renamed_routes_spec.rb Change all :empty_project to :project 2017-08-02 17:47:31 -04:00
migrate_build_stage_reference_again_spec.rb
migrate_issues_to_ghost_user_spec.rb Migrate issues authored by deleted user to the Ghost user 2017-09-05 16:25:26 +02:00
migrate_old_artifacts_spec.rb Enable Layout/TrailingWhitespace cop and auto-correct offenses 2017-08-15 13:44:37 -04:00
migrate_pipeline_sidekiq_queues_spec.rb Migrate new jobs when reverting pipeline queues migration 2017-08-25 14:25:18 +02:00
migrate_pipeline_stages_spec.rb
migrate_process_commit_worker_jobs_spec.rb Incorporate Gitaly's CommitService.FindCommit RPC 2017-08-07 23:33:43 -04:00
migrate_stage_id_reference_in_background_spec.rb Merge branch 'master' into backstage/gb/migrate-stages-statuses 2017-07-10 13:40:11 +02:00
migrate_stages_statuses_spec.rb Adjust a range and a size in stages statuses migration 2017-08-23 14:48:26 +02:00
migrate_user_activities_to_users_last_activity_on_spec.rb Support multiple Redis instances based on queue type 2017-07-11 03:35:47 +00:00
migrate_user_project_view_spec.rb
move_personal_snippets_files_spec.rb Move the personal snippet uploads from system to -/system 2017-08-11 18:17:45 +02:00
move_system_upload_folder_spec.rb Update migrations to move directly into the -/system folder 2017-08-11 18:15:02 +02:00
move_uploads_to_system_dir_spec.rb Update migrations to move directly into the -/system folder 2017-08-11 18:15:02 +02:00
normalize_ldap_extern_uids_spec.rb Add migration specs 2017-10-07 10:28:13 -07:00
README.md Extend migrations testing documentation 2017-08-16 13:15:41 +02:00
remove_dot_git_from_usernames_spec.rb Fix spec 2017-08-17 14:39:02 -07:00
remove_duplicate_mr_events_spec.rb Don't create event in Merge Request Create Service 2017-08-16 09:41:52 +00:00
rename_duplicated_variable_key_spec.rb
rename_more_reserved_project_names_spec.rb Change all :empty_project to :project 2017-08-02 17:47:31 -04:00
rename_reserved_project_names_spec.rb Change all :empty_project to :project 2017-08-02 17:47:31 -04:00
rename_users_with_renamed_namespace_spec.rb
schedule_create_gpg_key_subkeys_from_gpg_keys_spec.rb Add more specs. 2017-10-05 22:43:44 -05:00
schedule_merge_request_diff_migrations_spec.rb Migrate MR commits and diffs to new tables 2017-08-03 13:20:26 +01:00
schedule_merge_request_diff_migrations_take_two_spec.rb Reschedule merge request diff background migration 2017-09-29 11:56:08 +01:00
turn_nested_groups_into_regular_groups_for_mysql_spec.rb Rename many path_with_namespace -> full_path 2017-08-01 07:26:58 +02:00
update_legacy_diff_notes_type_for_import_spec.rb Fix notes type created from import 2017-09-29 11:18:58 +00:00
update_notes_type_for_import_spec.rb Fix notes type created from import 2017-09-29 11:18:58 +00:00
update_retried_for_ci_build_spec.rb
update_upload_paths_to_system_spec.rb Replaces tag: true into :tag in the specs 2017-10-07 13:57:54 +02:00

Testing migrations

In order to reliably test a migration, we need to test it against a database schema that this migration has been written for. In order to achieve that we have some migration helpers and RSpec test tag, called :migration.

If you want to write a test for a migration consider adding :migration tag to the test signature, like describe SomeMigrationClass, :migration.

How does it work?

Adding a :migration tag to a test signature injects a few before / after hooks to the test.

The most important change is that adding a :migration tag adds a before hook that will revert all migrations to the point that a migration under test is not yet migrated.

In other words, our custom RSpec hooks will find a previous migration, and migrate the database down to the previous migration version.

With this approach you can test a migration against a database schema that this migration has been written for.

Use migrate! helper to run the migration that is under test.

The after hook will migrate the database up and reinstitutes the latest schema version, so that the process does not affect subsequent specs and ensures proper isolation.

Testing a class that is not an ActiveRecord::Migration

In order to test a class that is not a migration itself, you will need to manually provide a required schema version. Please add a schema tag to a context that you want to switch the database schema within.

Example: describe SomeClass, :migration, schema: 20170608152748.

Available helpers

Use table helper to create a temporary ActiveRecord::Base derived model for a table.

Use migrate! helper to run the migration that is under test. It will not only run migration, but will also bump the schema version in the schema_migrations table. It is necessary because in the after hook we trigger the rest of the migrations, and we need to know where to start.

See spec/support/migrations_helpers.rb for all the available helpers.

An example

require 'spec_helper'

# Load a migration class.

require Rails.root.join('db', 'post_migrate', '20170526185842_migrate_pipeline_stages.rb')

describe MigratePipelineStages, :migration do

  # Create test data - pipeline and CI/CD jobs.

  let(:jobs) { table(:ci_builds) }
  let(:stages) { table(:ci_stages) }
  let(:pipelines) { table(:ci_pipelines) }
  let(:projects) { table(:projects) }

  before do
    projects.create!(id: 123, name: 'gitlab1', path: 'gitlab1')
    pipelines.create!(id: 1, project_id: 123, ref: 'master', sha: 'adf43c3a')
    jobs.create!(id: 1, commit_id: 1, project_id: 123, stage_idx: 2, stage: 'build')
    jobs.create!(id: 2, commit_id: 1, project_id: 123, stage_idx: 1, stage: 'test')
  end

  # Test the migration.

  it 'correctly migrates pipeline stages' do
    expect(stages.count).to be_zero

    migrate!

    expect(stages.count).to eq 2
    expect(stages.all.pluck(:name)).to match_array %w[test build]
  end
end

Best practices

  1. Note that this type of tests do not run within the transaction, we use a truncation database cleanup strategy. Do not depend on transaction being present.