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

Add a shared vcr spec helper for access to secrets #23292

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add a shared vcr spec helper for access to secrets #23292

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a284128
Add a shared vcr spec helper for access to secrets
jrafanie Dec 9, 2024
69cd2d0
Extract methods for constants and ensure loads of secrets happen once
jrafanie Dec 10, 2024
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
32 changes: 32 additions & 0 deletions spec/shared/cassette_secrets_helper.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
module Spec
module Shared
module CassetteSecretsHelper
DEFAULT_VCR_SECRETS_PATH = Pathname.new(Dir.pwd).join("config/secrets.defaults.yml")
VCR_SECRETS_PATH = Pathname.new(Dir.pwd).join("config/secrets.yml")
Copy link
Member

@Fryguy Fryguy Dec 10, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

I think this might be a little cleaner, just in case Dir.pwd isn't what we think it is?

Suggested change
DEFAULT_VCR_SECRETS_PATH = Pathname.new(Dir.pwd).join("config/secrets.defaults.yml")
VCR_SECRETS_PATH = Pathname.new(Dir.pwd).join("config/secrets.yml")
if defined?(ENGINE_ROOT)
DEFAULT_VCR_SECRETS_PATH = Pathname.new(ENGINE_ROOT).join("config/secrets.defaults.yml")
VCR_SECRETS_PATH = Rails.root.join("config/secrets.yml")
end

Since this is at the constant level, that's really all we can do, unless we also want to allow Rails.root and allow core to have secrets too. Otherwise, if we move this into a method instead, and load it on-demand, then we could do something like:

Suggested change
DEFAULT_VCR_SECRETS_PATH = Pathname.new(Dir.pwd).join("config/secrets.defaults.yml")
VCR_SECRETS_PATH = Pathname.new(Dir.pwd).join("config/secrets.yml")
def default_vcr_secrets_path
raise "Cassette secrets are only expected to be used from plugins" unless defined?(ENGINE_ROOT)
Pathname.new(ENGINE_ROOT).join("config/secrets.defaults.yml")
end
def vcr_secrets_path
raise "Cassette secrets are only expected to be used from plugins" unless defined?(ENGINE_ROOT)
Rails.root.join("config/secrets.yml")
end

Copy link
Member

Choose a reason for hiding this comment

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

defined?(ENGINE_ROOT) basically means "we are running this from a plugin" as opposed to "we are running in core"

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks, I thought I tried ENGINE_ROOT. I'll take another look.

Copy link
Member Author

Choose a reason for hiding this comment

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

I prefer the 'extract a method' style as we change it if it needs to be handled in core.

Copy link
Member Author

Choose a reason for hiding this comment

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

oh, I remember the hurdle I hit. ENGINE_ROOT is not defined. I could find it but it's the same as what I did:

(byebug) Vmdb::Plugins.paths.detect {|_,path| File.expand_path(path) == File.expand_path(Dir.pwd)}.last
"/Users/joerafaniello/Code/manageiq-providers-vmware"

Copy link
Member

@Fryguy Fryguy Dec 11, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

ENGINE_ROOT is not defined.

yeah, that's why you do defined?(ENGINE_ROOT). If we want to support core also, you just do

root = defined?(ENGINE_ROOT) ? Pathname.new(ENGINE_ROOT) : Rails.root

Then you go from there. I don't like Dir.pwd, because it assumes you are running tests from the root directory, and that's not always the case. For example, it's not wrong to do cd spec; be rspec ./models/foo_spec.rb. If you use a root object though, then you can really be anywhere in the directory tree.

Copy link
Member Author

Choose a reason for hiding this comment

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

Right, but that doesn't really help. If ENGINE_ROOT isn't defined in the plugin context as I'd still need to look at Dir.pwd to determine the plugin's directory since Rails.root is not the location of the engine:

joerafaniello@MacBookPro manageiq-providers-vmware % bin/rails c
...
Loading development environment (Rails 7.0.8.6)
irb(main):001> Rails.root
=> #<Pathname:/Users/joerafaniello/Code/manageiq>

Copy link
Member

Choose a reason for hiding this comment

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

I'm really confused - ENGINE_ROOT is the path to the plugin and will always be available when running from a plugin.

Copy link
Member

Choose a reason for hiding this comment

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

~/dev/manageiq-providers-vmware $ be rails c
irb(main):001> ENGINE_ROOT
=> "/Users/jfrey/dev/manageiq-providers-vmware"
irb(main):002> Rails.root
=> #<Pathname:/Users/jfrey/dev/manageiq>
irb(main):003>
~/dev/manageiq $ be rails c
irb(main):001> defined?(ENGINE_ROOT)
=> nil
irb(main):004> Rails.root
=> #<Pathname:/Users/jfrey/dev/manageiq>

Copy link
Member Author

Choose a reason for hiding this comment

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

I'll have to check when I have time. It was undefined in the context of the plugin at test time.


def load_vcr_secrets(pathname)
if pathname.exist?
YAML.load_file(pathname)
else
{}
end
end

def default_vcr_secrets
@default_vcr_secrets ||= load_vcr_secrets(DEFAULT_VCR_SECRETS_PATH)
end

def vcr_secrets
@vcr_secrets ||= load_vcr_secrets(VCR_SECRETS_PATH)
end

def default_vcr_secret_by_key_path(*args)
default_vcr_secrets.dig(*args)
end

def vcr_secret_by_key_path(*args)
vcr_secrets.dig(*args) || default_vcr_secret_by_key_path(*args)
end
end
end
end
Loading