handle chef-cli env with the chef-cli hab package and chef-dke hab package

Signed-off-by: nikhil2611 <[email protected]>

Author: nikhil2611

lib/chef-cli/command/env.rb

@@ -40,19 +40,39 @@ def initialize(*args)
 
       def run(params)
         info = {}
-        info[ChefCLI::Dist::PRODUCT] = workstation_info
+        product_name = get_product_info
+        info[product_name] = workstation_info
         info["Ruby"] = ruby_info
         info["Path"] = paths
         ui.msg YAML.dump(info)
       end
 
+      def get_product_info
+        return ChefCLI::Dist::PRODUCT if omnibus_install?
+        return ChefCLI::Dist::CHEF_DK_CLI_PACKAGE if habitat_chef_dke?
+        return ChefCLI::Dist::CHEF_CLI_PACKAGE if habitat_standalone?
+
+        # Default case when no conditions match
+        ChefCLI::Dist::PRODUCT
+      end
+
       def workstation_info
         info = {}
         if omnibus_install?
           info["Version"] = ChefCLI::VERSION
           info["Home"] = package_home
           info["Install Directory"] = omnibus_root
           info["Policyfile Config"] = policyfile_config
+        elsif habitat_chef_dke?
+          info["Version"] = ChefCLI::VERSION
+          info["Home"] = package_home
+          info["Install Directory"] = get_chef_cli_path
+          info["Policyfile Config"] = policyfile_config
+        elsif habitat_standalone?
+          info["Version"] = ChefCLI::VERSION
+          info["Home"] = package_home
+          info["Install Directory"] = get_chef_cli_path
+          info["Policyfile Config"] = policyfile_config
         else
           info["Version"] = "Not running from within Workstation"
         end
@@ -73,14 +93,22 @@ def ruby_info
 
       def gem_environment
         h = {}
-        h["GEM ROOT"] = omnibus_env["GEM_ROOT"]
-        h["GEM HOME"] = omnibus_env["GEM_HOME"]
-        h["GEM PATHS"] = omnibus_env["GEM_PATH"].split(File::PATH_SEPARATOR)
-      rescue OmnibusInstallNotFound
-        h["GEM_ROOT"] = ENV["GEM_ROOT"] if ENV.key?("GEM_ROOT")
-        h["GEM_HOME"] = ENV["GEM_HOME"] if ENV.key?("GEM_HOME")
-        h["GEM PATHS"] = ENV["GEM_PATH"].split(File::PATH_SEPARATOR) if ENV.key?("GEM_PATH") && !ENV.key?("GEM_PATH").nil?
-      ensure
+        if habitat_install?
+          # Habitat-specific environment variables
+          h["GEM ROOT"] = habitat_env["GEM_ROOT"]
+          h["GEM HOME"] = habitat_env["GEM_HOME"]
+          h["GEM PATHS"] = habitat_env["GEM_PATH"].split(File::PATH_SEPARATOR)
+        elsif omnibus_install?
+          # Omnibus-specific environment variables
+          h["GEM ROOT"] = omnibus_env["GEM_ROOT"]
+          h["GEM HOME"] = omnibus_env["GEM_HOME"]
+          h["GEM PATHS"] = omnibus_env["GEM_PATH"].split(File::PATH_SEPARATOR)
+        else
+          # Fallback to system environment variables if neither Omnibus nor Habitat
+          h["GEM_ROOT"] = ENV["GEM_ROOT"] if ENV.key?("GEM_ROOT")
+          h["GEM_HOME"] = ENV["GEM_HOME"] if ENV.key?("GEM_HOME")
+          h["GEM PATHS"] = ENV["GEM_PATH"].split(File::PATH_SEPARATOR) if ENV.key?("GEM_PATH") && !ENV["GEM_PATH"].nil?
+        end
         h
       end
 

lib/chef-cli/dist.rb

@@ -6,6 +6,9 @@ class Dist
     PRODUCT = "Chef Workstation".freeze
     PRODUCT_PKG_HOME = "chef-workstation".freeze
 
+    CHEF_DK_CLI_PACKAGE = "Chef Development Kit Enterprise".freeze
+    CHEF_CLI_PACKAGE = "Chef-Cli Package".freeze
+
     # the name of the chef-cli gem
     CLI_PRODUCT = "Chef CLI".freeze
     CLI_GEM = "chef-cli".freeze

lib/chef-cli/helpers.rb

@@ -98,6 +98,19 @@ def package_home
                        end
     end
 
+    # Function to return the Chef CLI path based on standalone or Chef-DK-enabled package
+    def get_chef_cli_path
+      # Check Chef-DK package path
+      chef_dk_path = get_hab_package_path(ChefCLI::Dist::CHEF_DKE_PKG_NAME)
+      return chef_dk_path if chef_dk_path && File.exist?(chef_dk_path)
+
+      # Check Standalone Chef-CLI package path
+      chef_cli_path = get_hab_package_path(ChefCLI::Dist::HAB_PKG_NAME)
+      return chef_cli_path if chef_cli_path && File.exist?(chef_cli_path)
+    rescue
+      nil
+    end
+
     # Returns the directory that contains our main symlinks.
     # On Mac we place all of our symlinks under /usr/local/bin on other
     # platforms they are under /usr/bin
@@ -232,5 +245,13 @@ def macos?
     def hab_pkg_installed?(pkg_name)
       `hab pkg list #{pkg_name} 2>/dev/null`.include?(pkg_name) rescue false
     end
+
+    # Helper function to get the path of the given hab package
+    def get_hab_package_path(pkg_name)
+      `hab pkg path #{pkg_name} 2>/dev/null`.strip || nil
+    rescue
+      nil
+    end
+
   end
 end

spec/unit/command/env_spec.rb

@@ -39,6 +39,7 @@
       allow(command_instance).to receive(:omnibus_install?).and_return true
       allow(command_instance).to receive(:omnibus_embedded_bin_dir).and_return(omnibus_embedded_bin_dir)
       allow(command_instance).to receive(:omnibus_bin_dir).and_return(omnibus_bin_dir)
+      allow(command_instance).to receive(:get_product_info).and_return(ChefCLI::Dist::PRODUCT)
       command_instance.ui = ui
     end
 
@@ -81,6 +82,75 @@
       end
     end
   end
+
+  describe "when running from a Habitat install (Chef DKE)" do
+    before do
+      allow(command_instance).to receive(:habitat_chef_dke?).and_return true
+      allow(command_instance).to receive(:omnibus_install?).and_return false
+      allow(command_instance).to receive(:get_product_info).and_return(ChefCLI::Dist::CHEF_DK_CLI_PACKAGE)
+      allow(command_instance).to receive(:workstation_info).and_return({
+        "Version" => ChefCLI::VERSION,
+        "Home" => "/hab/pkgs/chef/chef-dke",
+        "Install Directory" => "/hab/pkgs/chef/chef-dke/#{ChefCLI::VERSION}",
+        "Policyfile Config" => "/hab/pkgs/chef/chef-dke/#{ChefCLI::VERSION}/config/policyfile.rb"
+      })
+      command_instance.ui = ui
+    end
+
+    describe "and the env command is run" do
+      let(:yaml) { YAML.load(ui.output) }
+      before :each do
+        run_command
+      end
+
+      it "output should be valid yaml" do
+        expect { yaml }.not_to raise_error
+      end
+
+      it "should include correct Habitat Chef-DKE version info" do
+        expect(yaml).to have_key ChefCLI::Dist::CHEF_DK_CLI_PACKAGE
+        expect(yaml[ChefCLI::Dist::CHEF_DK_CLI_PACKAGE]["Version"]).to eql ChefCLI::VERSION
+        expect(yaml[ChefCLI::Dist::CHEF_DK_CLI_PACKAGE]["Home"]).to eql "/hab/pkgs/chef/chef-dke"
+        expect(yaml[ChefCLI::Dist::CHEF_DK_CLI_PACKAGE]["Install Directory"]).to eql "/hab/pkgs/chef/chef-dke/#{ChefCLI::VERSION}"
+        expect(yaml[ChefCLI::Dist::CHEF_DK_CLI_PACKAGE]["Policyfile Config"]).to eql "/hab/pkgs/chef/chef-dke/#{ChefCLI::VERSION}/config/policyfile.rb"
+      end
+    end
+  end
+
+  describe "when running from a Habitat install (Standalone)" do
+    before do
+      allow(command_instance).to receive(:habitat_standalone?).and_return true
+      allow(command_instance).to receive(:omnibus_install?).and_return false
+      allow(command_instance).to receive(:get_product_info).and_return(ChefCLI::Dist::CHEF_CLI_PACKAGE)
+      allow(command_instance).to receive(:workstation_info).and_return({
+        "Version" => ChefCLI::VERSION,
+        "Home" => "/hab/pkgs/chef/chef-cli",
+        "Install Directory" => "/hab/pkgs/chef/chef-cli/#{ChefCLI::VERSION}",
+        "Policyfile Config" => "/hab/pkgs/chef/chef-cli/#{ChefCLI::VERSION}/config/policyfile.rb"
+      })
+      command_instance.ui = ui
+    end
+
+    describe "and the env command is run" do
+      let(:yaml) { YAML.load(ui.output) }
+      before :each do
+        run_command
+      end
+
+      it "output should be valid yaml" do
+        expect { yaml }.not_to raise_error
+      end
+
+      it "should include correct Habitat Standalone version info" do
+        expect(yaml).to have_key ChefCLI::Dist::CHEF_CLI_PACKAGE
+        expect(yaml[ChefCLI::Dist::CHEF_CLI_PACKAGE]["Version"]).to eql ChefCLI::VERSION
+        expect(yaml[ChefCLI::Dist::CHEF_CLI_PACKAGE]["Home"]).to eql "/hab/pkgs/chef/chef-cli"
+        expect(yaml[ChefCLI::Dist::CHEF_CLI_PACKAGE]["Install Directory"]).to eql "/hab/pkgs/chef/chef-cli/#{ChefCLI::VERSION}"
+        expect(yaml[ChefCLI::Dist::CHEF_CLI_PACKAGE]["Policyfile Config"]).to eql "/hab/pkgs/chef/chef-cli/#{ChefCLI::VERSION}/config/policyfile.rb"
+      end
+    end
+  end
+
   def run_command
     command_instance.run_with_default_options(false, command_options)
   end