Skip to content

CHEF-37444: add ~/.chef/ruby/VERSION/gems to GEM_PATH for dynamic plugin loading #1963

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

Merged
tpowell-progress merged 2 commits into from
Aug 10, 2026
+58 −3
Merged

CHEF-37444: add ~/.chef/ruby/VERSION/gems to GEM_PATH for dynamic plugin loading #1963

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
c955885
CHEF-37444: add ~/.chef/ruby/VERSION/gems to GEM_PATH for dynamic plu…
sanghinitin Jul 30, 2026
5e65398
Adding ruby version near pkg so we don't forgot to change
sanghinitin Aug 10, 2026
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
16 changes: 15 additions & 1 deletion binstub_patch.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,18 @@
unless ENV["APPBUNDLER_ALLOW_RVM"]
ENV["APPBUNDLER_ALLOW_RVM"] = "true"
ENV["GEM_PATH"] = [File.expand_path(File.join(__dir__, "..", "vendor")), ENV["GEM_PATH"]].compact.join(File::PATH_SEPARATOR)
end

# Prepend the package vendor dir, the current user's gem dir, and the Chef gem dir to
# GEM_PATH so that:
# 1. Ohai's vendored dependencies are always found.
# 2. Plugins installed via `gem install <plugin>` are discoverable on both
# Linux (~/.gem/ruby/VERSION) and Windows (%USERPROFILE%\.gem\ruby\VERSION).
# 3. Gems installed via `chef gem install` (~/.chef/ruby/VERSION/gems) are immediately available.
#
# This block runs before appbundler's env_sanitizer (which calls Gem.clear_paths and
# re-reads GEM_PATH from ENV), so these additions are always picked up correctly.
ohai_vendor = File.expand_path(File.join(__dir__, "..", "vendor"))
# chef-cli gem install places gems under ~/.chef/ruby/RUBY_API_VERSION/gems
chef_gem_dir = File.join(Dir.home, ".chef", "ruby", RbConfig::CONFIG["ruby_version"], "gems")
existing_paths = ENV["GEM_PATH"]&.split(File::PATH_SEPARATOR) || []
ENV["GEM_PATH"] = ([ohai_vendor, Gem.user_dir, chef_gem_dir] + existing_paths).uniq.join(File::PATH_SEPARATOR)
16 changes: 15 additions & 1 deletion habitat/aarch64-darwin/plan.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
export HAB_BLDR_CHANNEL="base-2025"
export HAB_REFRESH_CHANNEL="base-2025"
ruby_pkg="core/ruby3_4"
# Derive the Ruby API version (e.g. 3.4.0) from the packaged Ruby's on-disk gem layout
# rather than executing `ruby -e`. Invoking the hab-provided ruby during the build can
# silently fail (its runtime library paths aren't set up here), which would leave
# ruby_gem_version empty and corrupt every GEM_PATH entry that uses it.
ruby_gem_version="$(basename "$(pkg_path_for "${ruby_pkg}")/lib/ruby/gems/"*)"
if [[ -z "$ruby_gem_version" ]]; then
build_line "WARNING: unable to determine Ruby API version from ${ruby_pkg}; falling back to 3.4.0"
ruby_gem_version="3.4.0"
fi
pkg_name="ohai"
pkg_origin="chef"
pkg_maintainer="The Chef Maintainers <humans@chef.io>"
Expand Down Expand Up @@ -117,7 +126,12 @@ set -e
export PATH="$(pkg_path_for ${ruby_pkg})/bin:/sbin:/usr/sbin:/usr/local/sbin:/usr/local/bin:/usr/bin:/bin:$pkg_prefix/vendor/bin:\$PATH"
export DYLD_LIBRARY_PATH="$(pkg_path_for core/libarchive)/lib:\$DYLD_LIBRARY_PATH"
export GEM_HOME="$pkg_prefix/vendor"
export GEM_PATH="$pkg_prefix/vendor"
# GEM_PATH includes the flat vendor tree, the bundler-nested vendor tree
# (vendor/ruby/VERSION, where train-core and other runtime deps are installed), the
# standard user gem dir (~/.gem/ruby/VERSION), and the Chef gem dir
# (~/.chef/ruby/VERSION/gems) so that both ohai's own runtime deps and plugins installed
# via 'gem install' or 'chef gem install' are found at runtime.
export GEM_PATH="$pkg_prefix/vendor:$pkg_prefix/vendor/ruby/${ruby_gem_version}:\${HOME}/.gem/ruby/${ruby_gem_version}:\${HOME}/.chef/ruby/${ruby_gem_version}/gems"

exec $(pkg_path_for ${ruby_pkg})/bin/ruby $pkg_prefix/libexec/ohai "\$@"
EOF
Expand Down
13 changes: 13 additions & 0 deletions habitat/plan.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,19 @@ function Invoke-Install {
Write-BuildLine "** generating binstubs for ohai with precise version pins $project_root $pkg_prefix/bin "
Invoke-Expression -Command "appbundler.bat $project_root $pkg_prefix/bin ohai"
If ($lastexitcode -ne 0) { Exit $lastexitcode }

Write-BuildLine "** patching binstubs for direct execution and dynamic plugin loading"
$binstubPatch = Get-Content -Path "$project_root\binstub_patch.rb"
Get-ChildItem "$pkg_prefix\bin" | Where-Object { $_.Extension -notin @(".bat", ".ps1") } | ForEach-Object {
$lines = Get-Content -Path $_.FullName
$matchLine = $lines | Select-String -Pattern 'require "rubygems"' | Select-Object -First 1
if ($matchLine) {
$lineNum = $matchLine.LineNumber # 1-based; insert patch after this line
$newLines = $lines[0..($lineNum - 1)] + $binstubPatch + $lines[$lineNum..($lines.Count - 1)]
Set-Content -Path $_.FullName -Value $newLines
}
}

Write-BuildLine " ** Running the ohai project's 'rake install' to install the path-based gems so they look like any other installed gem."

If ($lastexitcode -ne 0) { Exit $lastexitcode }
Expand Down
16 changes: 15 additions & 1 deletion habitat/plan.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
export HAB_BLDR_CHANNEL="base-2025"
export HAB_REFRESH_CHANNEL="base-2025"
ruby_pkg="core/ruby3_4"
# Derive the Ruby API version (e.g. 3.4.0) from the packaged Ruby's on-disk gem layout
# rather than executing `ruby -e`. Invoking the hab-provided ruby during the build can
# silently fail (its runtime library paths aren't set up here), which would leave
# ruby_gem_version empty and corrupt every GEM_PATH entry that uses it.
ruby_gem_version="$(basename "$(pkg_path_for "${ruby_pkg}")/lib/ruby/gems/"*)"
if [[ -z "$ruby_gem_version" ]]; then
build_line "WARNING: unable to determine Ruby API version from ${ruby_pkg}; falling back to 3.4.0"
ruby_gem_version="3.4.0"
fi
pkg_name="ohai"
pkg_origin="chef"
pkg_maintainer="The Chef Maintainers <humans@chef.io>"
Expand Down Expand Up @@ -99,7 +108,12 @@ set -e
export PATH="$(pkg_path_for ${ruby_pkg})/bin:/sbin:/usr/sbin:/usr/local/sbin:/usr/local/bin:/usr/bin:/bin:\$PATH"
export LD_LIBRARY_PATH="$(pkg_path_for core/libarchive)/lib:\$LD_LIBRARY_PATH"
export GEM_HOME="$pkg_prefix/vendor"
export GEM_PATH="$pkg_prefix/vendor"
# GEM_PATH includes the flat vendor tree, the bundler-nested vendor tree
# (vendor/ruby/VERSION, where train-core and other runtime deps are installed), the
# standard user gem dir (~/.gem/ruby/VERSION), and the Chef gem dir
# (~/.chef/ruby/VERSION/gems) so that both ohai's own runtime deps and plugins installed
# via 'gem install' or 'chef gem install' are found at runtime.
export GEM_PATH="$pkg_prefix/vendor:$pkg_prefix/vendor/ruby/${ruby_gem_version}:\${HOME}/.gem/ruby/${ruby_gem_version}:\${HOME}/.chef/ruby/${ruby_gem_version}/gems"

exec $(pkg_path_for ${ruby_pkg})/bin/ruby $pkg_prefix/libexec/ohai "\$@"
EOF
Expand Down
Loading