An error occurred while fetching the assigned milestone of the selected merge_request.

Load EE factories in Rails console and verify them in specs

Review changes
Download
Patches
Plain diff

Merged Load EE factories in Rails console and verify them in specs

pl-factory-bot-reload into master

Overview 18
Commits 4
Pipelines 12
Changes 5

Merged Peter Leitzen requested to merge pl-factory-bot-reload into master 2 years ago

Overview 18
Commits 4
Pipelines 12
Changes 5

What does this MR do and why?

Previously, factories defined in ee/spec/factories/**/*.rb were not loaded in rails console.

Moreover, they were not verified via spec/models/factories_spec.rb. Some EE factories have been fixed to pass the specs (skip_create was added to play nice with create(...) for non-DB factories).

This MR defines file paths via application configuration instead of overriding definition_file_paths in multiple places.

This allows factories for EE and JH to be loaded also in Rails console if available and make them available in spec/models/factories_spec.rb.

This MR might help to resolve #369851 (closed) 🤞 (no reproduction/evidence though)

Closes #335714 (closed).

How to set up and validate locally

To test production env add this to config/database.yml:

production:
  <<: *test

Before ❌

EE factories are missing ❌

$ bin/rails  console
WARNING: This version of GitLab depends on gitlab-shell 14.10.0, but you're running 14.7.4. Please update gitlab-shell.
--------------------------------------------------------------------------------
 Ruby:         ruby 2.7.5p203 (2021-11-24 revision f69aeb8314) [x86_64-linux]
 GitLab:       15.4.0-pre (25e0d649a8c) EE
 GitLab Shell: 14.7.4
 PostgreSQL:   12.10
-------------------------------------------------------------[ booted in 4.64s ]
Loading development environment (Rails 6.1.6.1)
[1] pry(main)> FactoryBot.definition_file_paths
=> [#<Pathname:/home/peter/devel/gitlab/gdk/gitlab/factories>, #<Pathname:/home/peter/devel/gitlab/gdk/gitlab/test/factories>, #<Pathname:/home/peter/devel/gitlab/gdk/gitlab/spec/factories>]
[2] pry(main)> FactoryBot.reload
=> ["/home/peter/devel/gitlab/gdk/gitlab/factories", "/home/peter/devel/gitlab/gdk/gitlab/test/factories", "/home/peter/devel/gitlab/gdk/gitlab/spec/factories"]

$ bin/rails  console -e production
WARNING: This version of GitLab depends on gitlab-shell 14.10.0, but you're running 14.7.4. Please update gitlab-shell.
--------------------------------------------------------------------------------
 Ruby:         ruby 2.7.5p203 (2021-11-24 revision f69aeb8314) [x86_64-linux]
 GitLab:       15.4.0-pre (25e0d649a8c) EE
 GitLab Shell: 14.7.4
 PostgreSQL:   12.10
-------------------------------------------------------------[ booted in 9.44s ]
Loading production environment (Rails 6.1.6.1)
>> FactoryBot
Traceback (most recent call last):
        1: from (irb):1
NameError (uninitialized constant FactoryBot)

After ✅

EE factories are available ✅

$ bin/rails console
--------------------------------------------------------------------------------
 Ruby:         ruby 2.7.5p203 (2021-11-24 revision f69aeb8314) [x86_64-linux]
 GitLab:       15.4.0-pre (ac4f1ac2435) EE
 GitLab Shell: Unknown
 PostgreSQL:   12.10
-------------------------------------------------------------[ booted in 0.00s ]
Loading test environment (Rails 6.1.6.1)

[1] pry(main)> FactoryBot.definition_file_paths
=> [#<Pathname:/home/peter/devel/gitlab/gdk/gitlab/factories>,
 #<Pathname:/home/peter/devel/gitlab/gdk/gitlab/test/factories>,
 #<Pathname:/home/peter/devel/gitlab/gdk/gitlab/spec/factories>,
 #<Pathname:/home/peter/devel/gitlab/gdk/gitlab/ee/spec/factories>]

[2] pry(main)> FactoryBot.definition_file_paths
=> [#<Pathname:/home/peter/devel/gitlab/gdk/gitlab/factories>,
 #<Pathname:/home/peter/devel/gitlab/gdk/gitlab/test/factories>,
 #<Pathname:/home/peter/devel/gitlab/gdk/gitlab/spec/factories>,
 #<Pathname:/home/peter/devel/gitlab/gdk/gitlab/ee/spec/factories>]
[2] pry(main)> FactoryBot.reload
=> ["/home/peter/devel/gitlab/gdk/gitlab/factories", "/home/peter/devel/gitlab/gdk/gitlab/test/factories", "/home/peter/devel/gitlab/gdk/gitlab/spec/factories", "/home/peter/devel/gitlab/gdk/gitlab/ee/spec/factories"]

# same for 
$ bin/rails console -e test


# Still works in FOSS

$ FOSS_ONLY=1 bin/rails  console
WARNING: This version of GitLab depends on gitlab-shell 14.10.0, but you're running 14.7.4. Please update gitlab-shell.
--------------------------------------------------------------------------------
 Ruby:         ruby 2.7.5p203 (2021-11-24 revision f69aeb8314) [x86_64-linux]
 GitLab:       15.4.0-pre (5f5ad3c3a12) FOSS
 GitLab Shell: 14.7.4
 PostgreSQL:   12.10
-------------------------------------------------------------[ booted in 4.21s ]
Loading development environment (Rails 6.1.6.1)
[1] pry(main)> FactoryBot.definition_file_paths
=> [#<Pathname:/home/peter/devel/gitlab/gdk/gitlab/factories>, #<Pathname:/home/peter/devel/gitlab/gdk/gitlab/test/factories>, #<Pathname:/home/peter/devel/gitlab/gdk/gitlab/spec/factories>]
[2] pry(main)>


$ bin/rails  console -e production
WARNING: This version of GitLab depends on gitlab-shell 14.10.0, but you're running 14.7.4. Please update gitlab-shell.
--------------------------------------------------------------------------------
 Ruby:         ruby 2.7.5p203 (2021-11-24 revision f69aeb8314) [x86_64-linux]
 GitLab:       15.4.0-pre (25e0d649a8c) EE
 GitLab Shell: 14.7.4
 PostgreSQL:   12.10
-------------------------------------------------------------[ booted in 9.44s ]
Loading production environment (Rails 6.1.6.1)
>> FactoryBot
Traceback (most recent call last):
        1: from (irb):1
NameError (uninitialized constant FactoryBot)

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

I have evaluated the MR acceptance checklist for this MR.

Edited 1 year ago by Peter Leitzen

Merge request reports

0 Assignees

None

Select assignees

0 Reviewers

None

Request review from

Labels

None

Select labels

Manage project labels

Milestone

None

Time tracking

No estimate or time spent

0 Participants

Viewing commit 41f26ba3

Show latest version

5 files

+ 5

− 17

Compare changes

Side-by-side
Inline

Show whitespace changes

Show one file at a time

Files

Search (e.g. *.vue) (Ctrl+P)

Verified

41f26ba3

Define FactoryBot file paths only once · 41f26ba3

Peter Leitzen authored 2 years ago

Instead of overriding `definition_file_paths` in multiple places define
file paths via application configuration.

This fixes `FactoryBot.reload` in Rails console.

config/application.rb

+ 5

− 0

@@ -472,6 +472,11 @@ class Application < Rails::Application
      g.factory_bot false
    end

    if defined?(FactoryBotRails)
      config.factory_bot.definition_file_paths << 'ee/spec/factories' if Gitlab.ee?
      config.factory_bot.definition_file_paths << 'jh/spec/factories' if Gitlab.jh?
    end

    # sprocket-rails adds some precompile assets we actually do not need.
    #
    # It copies all _non_ js and CSS files from the app/assets/ older.