Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow the rails method to be called and change the result only when called from the migration #776

Merged
merged 2 commits into from
Jan 3, 2025
Merged

Allow the rails method to be called and change the result only when called from the migration #776

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7af2420
Allow the rails method to be called, don't expect it
jrafanie Dec 12, 2024
0f2cd76
Extract migration_path method
jrafanie Jan 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/ci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ jobs:
run: bin/setup
- name: Run tests
run: bundle exec rake
continue-on-error: ${{ matrix.rails-version == '7.2' || matrix.rails-version == '7.1'}}
- name: Report code coverage
if: ${{ github.ref == 'refs/heads/master' && matrix.ruby-version == '3.3' && matrix.rails-version == '7.0' }}
continue-on-error: true
Expand Down
12 changes: 6 additions & 6 deletions spec/migrations/20241017013023_reencrypt_password_scramsha_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@

username = ActiveRecord::Base.connection_db_config.configuration_hash[:username]

expect(ActiveRecord::Base.connection_db_config).to receive(:configuration_hash).exactly(10).times.and_call_original
Copy link
Member Author

@jrafanie jrafanie Dec 13, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me explain this... the reason it's called 10 times here is because rails itself is calling it in rails 7.0. Previously, we called the original rails method as is 10 times, then, we change the result on the 11th call to inject a password if it wasn't configured, or in the case of the second test remove the password.

This changed in rails 7.1 as it's only called 1 time and it was in our migration probably due to internal rails changes. To support both versions, I'm checking if the caller locations shows it coming from the migration file and only then change the result for the test scenario.

I guess we could also do a rails version check but felt that it's brittle to expect or not expect a rails method to be called or worse, to modify the result from it if it's originating from rails itself. In fact, my first try at this PR had this failing in CI because on CI the password wasn't configured as I guess it's allowing local socket connections.

expect(ActiveRecord::Base.connection_db_config).to receive(:configuration_hash).and_wrap_original do |original_method, *args, &block|
original_method.call(*args, &block).dup.tap { |i| i[:password] ||= "abc" }
allow(ActiveRecord::Base.connection_db_config).to receive(:configuration_hash).and_wrap_original do |original_method, *args, &block|
# set a value for any calls originating from the migration file, not from rails itself
original_method.call(*args, &block).dup.tap { |i| i[:password] ||= "abc" if caller_locations.any? {|loc| loc.path.include?(migration_path)} }
end
expect(ActiveRecord::Base.connection).to receive(:execute).with(a_string_matching(/ALTER ROLE #{username} WITH PASSWORD \'SCRAM-SHA-256.*\'\;/))

Expand All @@ -23,9 +23,9 @@

username = ActiveRecord::Base.connection_db_config.configuration_hash[:username]

expect(ActiveRecord::Base.connection_db_config).to receive(:configuration_hash).exactly(10).times.and_call_original
expect(ActiveRecord::Base.connection_db_config).to receive(:configuration_hash).and_wrap_original do |original_method, *args, &block|
original_method.call(*args, &block).dup.tap { |i| i.delete(:password) }
allow(ActiveRecord::Base.connection_db_config).to receive(:configuration_hash).and_wrap_original do |original_method, *args, &block|
# set a value for any calls originating from the migration file, not from rails itself
original_method.call(*args, &block).dup.tap { |i| i.delete(:password) if caller_locations.any? {|loc| loc.path.include?(migration_path)} }
end
expect(ActiveRecord::Base.connection).not_to receive(:execute).with(a_string_matching(/ALTER ROLE.*\'\;/))

Expand Down
8 changes: 5 additions & 3 deletions spec/support/migration_name_helper.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
def require_migration
spec_name = caller_locations.first.path
migration_name = spec_name.sub("spec/migrations", "db/migrate").sub("_spec.rb", ".rb")
require migration_path
end

require migration_name
def migration_path
spec_name = caller_locations.detect {|loc| loc.path.end_with?("_spec.rb")}.path
spec_name.sub("spec/migrations", "db/migrate").sub("_spec.rb", ".rb")
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Fryguy finally came back to this... see my commit details below... (the second commit)

Extract migration_path method

Changed the behavior as require_migration expected to be called from
the spec, but this method could be called from the helper or elsewhere.
Therefore, we detect the first caller location with the spec instead of assuming
it's the first one.

end
Loading