bolt 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7875970096b75c44b55dc718b1586f8b360e11041198893207c9c146649b89b7
-  data.tar.gz: f81ded40f2a72fd9e83b0f63f1ea0d7d4a5148589d1bdb65de82c023335ed611
+  metadata.gz: cbe3b4d356f06d8d5505a490420103678f6cca7551b66eb01d6bdf3e4ab7b41a
+  data.tar.gz: 7d785e1159fea305c370bc5e18b868aa63a176a6666c3d3c469833d310a90729
 SHA512:
-  metadata.gz: 2e4c8c1857380c9177284ce567228058f2bd516541020c7926ebc7ea3af23ab89525f5a3d146b3c40a62721e89401b960e3b7071b3473094caaed00b4225bbb3
-  data.tar.gz: a299f639f5e211c4cee1d3dbca7fb3a5ce4b5a770840c8a7e2da1f620a92b7045637113522fe6e0856fe70a7d3e286d5d5563fae6c53bfc852ec893e87250b86
+  metadata.gz: b7c494d958d4dcbbe61da8dbf9d6a7ab2712ad9e19f91f9917a0e8ec4c95fb9fe463fae868027529c5b7ef51ca410d9d16a22a120bbd0f275e7474c569606041
+  data.tar.gz: 62facbdda41d27006d5f8ece2f79deab5f9df8e2c1fc48890029094348847014e7682bb2586561159230bcaf390eda6d216ab4f1d275aa25e8e89a0a2bb27e06

data/Puppetfile

@@ -24,16 +24,16 @@ mod 'puppetlabs-zone_core', '1.0.3'
 # Useful additional modules
 mod 'puppetlabs-package', '1.1.0'
 mod 'puppetlabs-puppet_conf', '0.6.0'
-mod 'puppetlabs-python_task_helper', '0.3.0'
+mod 'puppetlabs-python_task_helper', '0.4.0'
 mod 'puppetlabs-reboot', '3.0.0'
-mod 'puppetlabs-ruby_task_helper', '0.4.0'
+mod 'puppetlabs-ruby_task_helper', '0.5.1'
 mod 'puppetlabs-ruby_plugin_helper', '0.1.0'
 
 # Plugin modules
 mod 'puppetlabs-azure_inventory', '0.3.0'
 mod 'puppetlabs-terraform', '0.4.0'
 mod 'puppetlabs-vault', '0.3.0'
-mod 'puppetlabs-aws_inventory', '0.4.0'
+mod 'puppetlabs-aws_inventory', '0.5.0'
 mod 'puppetlabs-yaml', '0.2.0'
 
 # If we don't list these modules explicitly, r10k will purge them

data/lib/bolt/analytics.rb

@@ -28,8 +28,12 @@ module Bolt
 
     def self.build_client
       logger = Logging.logger[self]
-      config_file = File.expand_path('~/.puppetlabs/bolt/analytics.yaml')
-      config = load_config(config_file, logger)
+      begin
+        config_file = File.expand_path('~/.puppetlabs/bolt/analytics.yaml')
+        config = load_config(config_file, logger)
+      rescue ArgumentError
+        config = { 'disabled' => true }
+      end
 
       if config['disabled'] || ENV['BOLT_DISABLE_ANALYTICS']
         logger.debug "Analytics opt-out is set, analytics will be disabled"

data/lib/bolt/bolt_option_parser.rb

@@ -76,7 +76,7 @@ module Bolt
       when 'project'
         case action
         when 'init'
-          { flags: OPTIONS[:global],
+          { flags: OPTIONS[:global] + %w[modules],
             banner: PROJECT_INIT_HELP }
         when 'migrate'
           { flags: OPTIONS[:global] + %w[inventoryfile boltdir configfile],
@@ -391,6 +391,8 @@ module Bolt
             bolt project init
           Create a new Bolt project at a specified path.
             bolt project init ~/path/to/project
+          Create a new Bolt project with existing modules.
+            bolt project init --modules puppetlabs-apt,puppetlabs-ntp
     HELP
 
     PROJECT_MIGRATE_HELP = <<~HELP
@@ -763,6 +765,13 @@ module Bolt
         @options[:trace] = true
       end
 
+      separator "\nADDITIONAL OPTIONS"
+      define('--modules MODULES',
+             'A comma-separated list of modules to install from the Puppet Forge',
+             'when initializing a project. Resolves and installs all dependencies.') do |modules|
+        @options[:modules] = modules.split(',')
+      end
+
       separator "\nGLOBAL OPTIONS"
       define('-h', '--help', 'Display help') do |_|
         @options[:help] = true

data/lib/bolt/cli.rb

@@ -564,19 +564,116 @@ module Bolt
       0
     end
 
+    # Initializes a specified directory as a Bolt project and installs any modules
+    # specified by the user, along with their dependencies
     def initialize_project
-      path = File.expand_path(options[:object] || Dir.pwd)
-      FileUtils.mkdir_p(path)
-      ok = FileUtils.touch(File.join(path, 'bolt.yaml'))
+      boltdir    = Pathname.new(File.expand_path(options[:object] || Dir.pwd))
+      config     = boltdir + 'bolt.yaml'
+      puppetfile = boltdir + 'Puppetfile'
+      modulepath = [boltdir + 'modules']
+
+      # If modules were specified, first check if there is already a Puppetfile at the project
+      # directory, erroring if there is. If there is no Puppetfile, generate the Puppetfile
+      # content by resolving the specified modules and all their dependencies.
+      # We generate the Puppetfile first so that any errors in resolving modules and their
+      # dependencies are caught early and do not create a project directory.
+      if options[:modules]
+        if puppetfile.exist?
+          raise Bolt::CLIError,
+                "Found existing Puppetfile at #{puppetfile}, unable to initialize project with "\
+                "#{options[:modules].join(', ')}"
+        else
+          puppetfile_specs = resolve_puppetfile_specs
+        end
+      end
 
-      result = if ok
-                 "Successfully created Bolt project directory at #{path}"
-               else
-                 "Could not create Bolt project directory at #{path}"
-               end
-      outputter.print_message result
+      # Warn the user if the project directory already exists. We don't error here since users
+      # might not have installed any modules yet.
+      if config.exist?
+        @logger.warn "Found existing project directory at #{boltdir}"
+      end
 
-      ok ? 0 : 1
+      # Create the project directory
+      FileUtils.mkdir_p(boltdir)
+
+      # Bless the project directory as a boltdir
+      if FileUtils.touch(config)
+        outputter.print_message "Successfully created Bolt project at #{boltdir}"
+      else
+        raise Bolt::FileError.new("Could not create Bolt project directory at #{boltdir}", nil)
+      end
+
+      # Write the generated Puppetfile to the fancy new boltdir
+      if puppetfile_specs
+        File.write(puppetfile, puppetfile_specs.join("\n"))
+        outputter.print_message "Successfully created Puppetfile at #{puppetfile}"
+        # Install the modules from our shiny new Puppetfile
+        if install_puppetfile({}, puppetfile, modulepath)
+          outputter.print_message "Successfully installed #{options[:modules].join(', ')}"
+        else
+          raise Bolt::CLIError, "Could not install #{options[:modules].join(', ')}"
+        end
+      end
+
+      0
+    end
+
+    # Resolves Puppetfile specs from user-specified modules and dependencies resolved
+    # by the puppetfile-resolver gem.
+    def resolve_puppetfile_specs
+      require 'puppetfile-resolver'
+
+      # Build the document model from the module names, defaulting to the latest version of each module
+      model = PuppetfileResolver::Puppetfile::Document.new('')
+      options[:modules].each do |mod_name|
+        model.add_module(
+          PuppetfileResolver::Puppetfile::ForgeModule.new(mod_name).tap { |mod| mod.version = :latest }
+        )
+      end
+
+      # Make sure the Puppetfile model is valid
+      unless model.valid?
+        raise Bolt::ValidationError,
+              "Unable to resolve dependencies for #{options[:modules].join(', ')}"
+      end
+
+      # Create the resolver using the Puppetfile model. nil disables Puppet version restrictions.
+      resolver = PuppetfileResolver::Resolver.new(model, nil)
+
+      # Configure and resolve the dependency graph
+      result = resolver.resolve(
+        cache:                 nil,
+        ui:                    nil,
+        module_paths:          [],
+        allow_missing_modules: true
+      )
+
+      # Validate that the modules exist
+      missing_graph = result.specifications.select do |_name, spec|
+        spec.instance_of? PuppetfileResolver::Models::MissingModuleSpecification
+      end
+
+      if missing_graph.any?
+        titles = model.modules.each_with_object({}) do |mod, acc|
+          acc[mod.name] = mod.title
+        end
+
+        names = titles.values_at(*missing_graph.keys)
+        plural = names.count == 1 ? '' : 's'
+
+        raise Bolt::ValidationError,
+              "Unknown module name#{plural} #{names.join(', ')}"
+      end
+
+      # Filter the dependency graph to only include module specifications
+      spec_graph = result.specifications.select do |_name, spec|
+        spec.instance_of? PuppetfileResolver::Models::ModuleSpecification
+      end
+
+      # Map specification models to a Puppetfile specification
+      spec_graph.values.map do |spec|
+        "mod '#{spec.owner}-#{spec.name}', '#{spec.version}'"
+      end
     end
 
     def migrate_project

data/lib/bolt/config.rb

@@ -137,10 +137,15 @@ module Bolt
                     else
                       Pathname.new(File.join('/etc', 'puppetlabs', 'bolt', 'bolt.yaml'))
                     end
-      user_path = Pathname.new(File.expand_path(File.join('~', '.puppetlabs', 'etc', 'bolt', 'bolt.yaml')))
-
-      [{ filepath: system_path, data: Bolt::Util.read_optional_yaml_hash(system_path, 'config') },
-       { filepath: user_path, data: Bolt::Util.read_optional_yaml_hash(user_path, 'config') }]
+      user_path = begin
+                    Pathname.new(File.expand_path(File.join('~', '.puppetlabs', 'etc', 'bolt', 'bolt.yaml')))
+                  rescue ArgumentError
+                    nil
+                  end
+
+      confs = [{ filepath: system_path, data: Bolt::Util.read_optional_yaml_hash(system_path, 'config') }]
+      confs << { filepath: user_path, data: Bolt::Util.read_optional_yaml_hash(user_path, 'config') } if user_path
+      confs
     end
 
     def initialize(boltdir, config_data, overrides = {})

data/lib/bolt/config/transport/winrm.rb

@@ -8,6 +8,8 @@ module Bolt
     module Transport
       class WinRM < Base
         OPTIONS = {
+          "basic-auth-only" => { type: TrueClass,
+                                 desc: "Force basic authentication. This option is only available when using SSL." },
           "cacert"          => { type: String,
                                  desc: "The path to the CA certificate." },
           "connect-timeout" => { type: Integer,
@@ -50,6 +52,7 @@ module Bolt
         }.freeze
 
         DEFAULTS = {
+          "basic-auth-only" => false,
           "connect-timeout" => 10,
           "ssl"             => true,
           "ssl-verify"      => true,
@@ -70,6 +73,10 @@ module Bolt
             end
           end
 
+          if !@config['ssl'] && @config['basic-auth-only']
+            raise Bolt::ValidationError, "Basic auth is only allowed when using SSL"
+          end
+
           if @config['interpreters']
             @config['interpreters'] = normalize_interpreters(@config['interpreters'])
           end

data/lib/bolt/transport/winrm/connection.rb

@@ -49,6 +49,7 @@ module Bolt
                       password: target.options['realm'] ? 'dummy' : target.password,
                       retry_limit: 1,
                       transport: transport,
+                      basic_auth_only: target.options['basic-auth-only'],
                       ca_trust_path: cacert,
                       realm: target.options['realm'],
                       no_ssl_peer_verification: !target.options['ssl-verify'] }

data/lib/bolt/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-10 00:00:00.000000000 Z
+date: 2020-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -212,6 +212,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: puppetfile-resolver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: r10k
   requirement: !ruby/object:Gem::Requirement