bolt 2.28.0 → 2.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03de2a7e4d6fa0b9d4120fff783ccb009665077c7b00e910f5e2de14c03a1767
-  data.tar.gz: 511e18c31228338f47519ee02a7b248f4d264b93516a58aa1b063a41bb835e80
+  metadata.gz: ec167b23fc4ceec9d9b3048ae64582a3fcf2baa1eceb8100fb26cc3c6df95cb6
+  data.tar.gz: 4621d274f8c14f4986dae819755c0db162cd056fbd9412275a0bcffc2169edee
 SHA512:
-  metadata.gz: 1956edc3051eae34d25957c7827ce1e1f12bfc7e322d9305a79d9a2cb32cf144309413626cfb9db6667193a8853810dabf8d6004924ad3899633a220f34cecb7
-  data.tar.gz: af2e40875cb54c1e2b4153605ffc6abb6b11a65e2f0abcc30f7eb87701cb3c5c023905dc1709ff0bf7261e856ceaae29fad9df13e4b9b51b9f74a4ef65fb0b74
+  metadata.gz: 1af9a8df65a1a95a7404a0b94f74bfeb9086e3a97ba03e1f19a53acbb626757249b69d812f7afe87e2da05a06d698f515b05313018a649621d98269eabfe2f93
+  data.tar.gz: 24f0b0f56451570d5e97d74ddb66556b48fd8c14a79fd7a0c09f10a4ef1c8590684ccee1675c4dd4126cdbcbc781bad6bf83ba2aa4d8ada0cd13279c15f53876

data/lib/bolt/bolt_option_parser.rb

@@ -746,7 +746,7 @@ module Bolt
              'For SSH, port defaults to `22`',
              'For WinRM, port defaults to `5985` or `5986` based on the --[no-]ssl setting') do |targets|
         @options[:targets] ||= []
-        @options[:targets] << get_arg_input(targets)
+        @options[:targets] << Bolt::Util.get_arg_input(targets)
       end
       define('-q', '--query QUERY', 'Query PuppetDB to determine the targets') do |query|
         @options[:query] = query
@@ -985,27 +985,10 @@ module Bolt
     end
 
     def parse_params(params)
-      json = get_arg_input(params)
+      json = Bolt::Util.get_arg_input(params)
       JSON.parse(json)
     rescue JSON::ParserError => e
       raise Bolt::CLIError, "Unable to parse --params value as JSON: #{e}"
     end
-
-    def get_arg_input(value)
-      if value.start_with?('@')
-        file = value.sub(/^@/, '')
-        read_arg_file(file)
-      elsif value == '-'
-        $stdin.read
-      else
-        value
-      end
-    end
-
-    def read_arg_file(file)
-      File.read(File.expand_path(file))
-    rescue StandardError => e
-      raise Bolt::FileError.new("Error attempting to read #{file}: #{e}", file)
-    end
   end
 end

data/lib/bolt/cli.rb

@@ -107,6 +107,11 @@ module Bolt
 
       options[:object] = remaining.shift
 
+      # Handle reading a command from a file
+      if options[:subcommand] == 'command' && options[:object]
+        options[:object] = Bolt::Util.get_arg_input(options[:object])
+      end
+
       # Only parse task_options for task or plan
       if %w[task plan].include?(options[:subcommand])
         task_options, remaining = remaining.partition { |s| s =~ /.+=/ }
@@ -892,13 +897,17 @@ module Bolt
         unless existing.modules.superset? puppetfile.modules
           missing_modules = puppetfile.modules - existing.modules
 
-          raise Bolt::Error.new(
-            "Puppetfile #{puppetfile_path} is missing specifications for modules: "\
-            "#{missing_modules.map(&:title).join(', ')}. This may not be a Puppetfile "\
-            "managed by Bolt. To forcibly overwrite the Puppetfile, run with the "\
-            "'--force' option.",
-            'bolt/missing-module-specs'
-          )
+          message = <<~MESSAGE.chomp
+            Puppetfile #{puppetfile_path} is missing specifications for the following
+            module declarations:
+            
+            #{missing_modules.map(&:to_hash).to_yaml.lines.drop(1).join.chomp}
+
+            This may not be a Puppetfile managed by Bolt. To forcibly overwrite the
+            Puppetfile, run 'bolt module install --force'.
+          MESSAGE
+
+          raise Bolt::Error.new(message, 'bolt/missing-module-specs')
         end
       else
         outputter.print_message "Resolving module dependencies, this may take a moment"

data/lib/bolt/config/options.rb

@@ -239,11 +239,21 @@ module Bolt
               "name" => {
                 description: "The name of the module.",
                 type: String
+              },
+              "version_requirement" => {
+                description: "The version requirement for the module. Accepts a specific version (1.2.3), version "\
+                             "shorthand (1.2.x), or a version range (>= 1.2.0).",
+                type: String
               }
             }
           },
           _plugin: false,
-          _example: [{ "name" => "puppetlabs-mysql" }, { "name" => "puppetlabs-apache" }]
+          _example: [
+            { "name" => "puppetlabs-mysql" },
+            { "name" => "puppetlabs-apache", "version_requirement" => "5.5.0" },
+            { "name" => "puppetlabs-puppetdb", "version_requirement" => "7.x" },
+            { "name" => "puppetlabs-firewall", "version_requirement" => ">= 1.0.0 < 3.0.0" }
+          ]
         },
         "name" => {
           description: "The name of the Bolt project. When this option is configured, the project is considered a "\

data/lib/bolt/logger.rb

@@ -4,6 +4,10 @@ require 'logging'
 
 module Bolt
   module Logger
+    LEVELS = %w[trace debug info notice warn error fatal].freeze
+    @mutex = Mutex.new
+    @warnings = Set.new
+
     # This method provides a single point-of-entry to setup logging for both
     # the CLI and for tests. This is necessary because we define custom log
     # levels which create corresponding methods on the logger instances;
@@ -11,20 +15,25 @@ module Bolt
     # will fail.
     def self.initialize_logging
       # Initialization isn't idempotent and will result in warnings about const
-      # redefs, so skip it if it's already been initialized
-      return if Logging.initialized?
-
-      Logging.init :trace, :debug, :info, :notice, :warn, :error, :fatal, :any
-      @mutex = Mutex.new
-
-      Logging.color_scheme(
-        'bolt',
-        lines: {
-          warn: :yellow,
-          error: :red,
-          fatal: %i[white on_red]
-        }
-      )
+      # redefs, so skip it if the log levels we expect are present. If it's
+      # already been initialized with an insufficient set of levels, go ahead
+      # and call init anyway or we'll have failures when calling log methods
+      # for missing levels.
+      unless levels & LEVELS == LEVELS
+        Logging.init(*LEVELS)
+      end
+
+      # As above, only create the color scheme if we haven't already created it.
+      unless Logging.color_scheme('bolt')
+        Logging.color_scheme(
+          'bolt',
+          lines: {
+            warn: :yellow,
+            error: :red,
+            fatal: %i[white on_red]
+          }
+        )
+      end
     end
 
     def self.configure(destinations, color)
@@ -115,14 +124,12 @@ module Bolt
     end
 
     def self.warn_once(type, msg)
-      @mutex.synchronize {
-        @warnings ||= []
+      @mutex.synchronize do
         @logger ||= Bolt::Logger.logger(self)
-        unless @warnings.include?(type)
+        if @warnings.add?(type)
           @logger.warn(msg)
-          @warnings << type
         end
-      }
+      end
     end
 
     def self.deprecation_warning(type, msg)

data/lib/bolt/project.rb

@@ -199,10 +199,9 @@ module Bolt
           raise Bolt::ValidationError, "Module declaration #{mod.inspect} must be a hash"
         end
 
-        unknown_keys = data['modules'].flat_map(&:keys).uniq - ['name']
+        unknown_keys = data['modules'].flat_map(&:keys).uniq - %w[name version_requirement]
         if unknown_keys.any?
-          @logs << { warn: "Module declarations in bolt-project.yaml only support a name key. Ignoring "\
-                           "unsupported keys: #{unknown_keys.join(', ')}." }
+          @logs << { warn: "Ignoring unknown keys in module declarations: #{unknown_keys.join(', ')}." }
         end
       end
     end

data/lib/bolt/puppetfile.rb

@@ -82,7 +82,7 @@ module Bolt
       @modules.each do |mod|
         model.add_module(
           PuppetfileResolver::Puppetfile::ForgeModule.new(mod.title).tap do |tap|
-            tap.version = :latest
+            tap.version = mod.version || :latest
           end
         )
       end

data/lib/bolt/puppetfile/module.rb

@@ -30,7 +30,7 @@ module Bolt
           raise Bolt::ValidationError, "Module name #{mod['name']} must include both the owner and module name."
         end
 
-        new(owner, name)
+        new(owner, name, mod['version_requirement'])
       end
 
       # Returns the module's title.
@@ -42,16 +42,39 @@ module Bolt
       # Checks two modules for equality.
       #
       def eql?(other)
-        self.class == other.class && @owner == other.owner && @name == other.name
+        self.class == other.class &&
+          @owner == other.owner &&
+          @name == other.name &&
+          versions_intersect?(other)
       end
       alias == eql?
 
+      # Returns true if the versions of two modules intersect. Used to determine
+      # if an installed module satisfies the version requirement of another.
+      #
+      def versions_intersect?(other)
+        range       = ::SemanticPuppet::VersionRange.parse(@version || '')
+        other_range = ::SemanticPuppet::VersionRange.parse(other.version || '')
+
+        range.intersection(other_range) != ::SemanticPuppet::VersionRange::EMPTY_RANGE
+      end
+
       # Hashes the module.
       #
       def hash
         [@owner, @name].hash
       end
 
+      # Returns a hash representation similar to the module
+      # declaration.
+      #
+      def to_hash
+        {
+          'name'                => title,
+          'version_requirement' => version
+        }.compact
+      end
+
       # Returns the Puppetfile specification for the module.
       #
       def to_spec

data/lib/bolt/util.rb

@@ -3,6 +3,25 @@
 module Bolt
   module Util
     class << self
+      # Gets input for an argument.
+      def get_arg_input(value)
+        if value.start_with?('@')
+          file = value.sub(/^@/, '')
+          read_arg_file(file)
+        elsif value == '-'
+          $stdin.read
+        else
+          value
+        end
+      end
+
+      # Reads a file passed as an argument to a command.
+      def read_arg_file(file)
+        File.read(File.expand_path(file))
+      rescue StandardError => e
+        raise Bolt::FileError.new("Error attempting to read #{file}: #{e}", file)
+      end
+
       def read_yaml_hash(path, file_name)
         require 'yaml'
 

data/lib/bolt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bolt
-  VERSION = '2.28.0'
+  VERSION = '2.29.0'
 end

data/lib/bolt_server/transport_app.rb

@@ -212,7 +212,7 @@ module BoltServer
       return [400, "`project_ref`: #{project_dir} does not exist"] unless Dir.exist?(project_dir)
       @pal_mutex.synchronize do
         project = Bolt::Project.create_project(project_dir)
-        bolt_config = Bolt::Config.from_project(project, {})
+        bolt_config = Bolt::Config.from_project(project, { log: { 'bolt-debug.log' => 'disable' } })
         pal = Bolt::PAL.new(bolt_config.modulepath, nil, nil, nil, nil, nil, bolt_config.project)
         module_path = [
           BoltServer::PE::PAL::PE_BOLTLIB_PATH,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 2.28.0
+  version: 2.29.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-16 00:00:00.000000000 Z
+date: 2020-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -198,14 +198,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: puppet-resource_api
   requirement: !ruby/object:Gem::Requirement