Merge pull request #1797 from beechtom/1779/bolt-gem

(GH-1779) Warn when Bolt is installed as a gem

Author: nicklewis

Gemfile

@@ -5,6 +5,9 @@ source ENV['GEM_SOURCE'] || 'https://rubygems.org'
 # Disable analytics when running in development
 ENV['BOLT_DISABLE_ANALYTICS'] = 'true'
 
+# Disable warning that Bolt may be installed as a gem
+ENV['BOLT_GEM'] = 'true'
+
 gemspec
 
 # Bolt server gems are managed here not in the gemspec

lib/bolt/cli.rb

@@ -804,6 +804,20 @@ def analytics
     end
 
     def bundled_content
+      # If the bundled content directory is empty, Bolt is likely installed as a gem.
+      if ENV['BOLT_GEM'].nil? && incomplete_install?
+        msg = <<~MSG.chomp
+          Bolt may be installed as a gem. To use Bolt reliably and with all of its
+          dependencies, uninstall the 'bolt' gem and install Bolt as a package:
+          https://puppet.com/docs/bolt/latest/bolt_installing.html
+
+          If you meant to install Bolt as a gem and want to disable this warning,
+          set the BOLT_GEM environment variable.
+        MSG
+
+        @logger.warn(msg)
+      end
+
       # We only need to enumerate bundled content when running a task or plan
       content = { 'Plan' => [],
                   'Task' => [],
@@ -827,5 +841,11 @@ def config_loaded
       MSG
       @logger.debug(msg)
     end
+
+    # Gem installs include the aggregate, canary, and puppetdb_fact modules, while
+    # package installs include modules listed in the Bolt repo Puppetfile
+    def incomplete_install?
+      (Dir.children(Bolt::PAL::MODULES_PATH) - %w[aggregate canary puppetdb_fact]).empty?
+    end
   end
 end

spec/bolt/cli_spec.rb

@@ -56,6 +56,37 @@ def stub_config(file_content = {})
     allow(Bolt::Util).to receive(:read_optional_yaml_hash).and_return(file_content)
   end
 
+  context 'gem install' do
+    around(:each) do |example|
+      original_value = ENV['BOLT_GEM']
+      example.run
+    ensure
+      ENV['BOLT_GEM'] = original_value
+    end
+
+    it 'displays a warning when Bolt is installed as a gem' do
+      ENV.delete('BOLT_GEM')
+
+      cli = Bolt::CLI.new(%w[task show])
+      allow(cli).to receive(:incomplete_install?).and_return(true)
+      cli.execute(cli.parse)
+
+      output = @log_output.readlines.join
+      expect(output).to match(/Bolt may be installed as a gem/)
+    end
+
+    it 'does not display a warning when BOLT_GEM is set' do
+      ENV['BOLT_GEM'] = 'true'
+
+      cli = Bolt::CLI.new(%w[task show])
+      allow(cli).to receive(:incomplete_install?).and_return(true)
+      cli.execute(cli.parse)
+
+      output = @log_output.readlines.join
+      expect(output).not_to match(/Bolt may be installed as a gem/)
+    end
+  end
+
   context "without a config file" do
     let(:project) { Bolt::Project.new('.') }
     before(:each) do