bolt 2.31.0 → 2.32.0

data/lib/bolt/puppetfile.rb

@@ -1,149 +0,0 @@
-# frozen_string_literal: true
-
-require 'bolt/error'
-require 'bolt/puppetfile/module'
-
-# This class manages the logical contents of a Puppetfile. It includes methods
-# for parsing a Puppetfile and its modules, resolving module dependencies,
-# and writing a Puppetfile.
-#
-module Bolt
-  class Puppetfile
-    attr_reader :modules
-
-    def initialize(modules = [])
-      @modules = Set.new
-      add_modules(modules)
-    end
-
-    # Loads a Puppetfile and parses its module specifications, returning a
-    # Bolt::Puppetfile object with the modules set.
-    #
-    def self.parse(path, skip_unsupported_modules: false)
-      require 'puppetfile-resolver'
-      require 'puppetfile-resolver/puppetfile/parser/r10k_eval'
-
-      begin
-        parsed = ::PuppetfileResolver::Puppetfile::Parser::R10KEval.parse(File.read(path))
-      rescue StandardError => e
-        raise Bolt::Error.new(
-          "Unable to parse Puppetfile #{path}: #{e.message}",
-          'bolt/puppetfile-parsing'
-        )
-      end
-
-      unless parsed.valid?
-        # valid? Just checks if validation_errors is empty, so if we get here we know it's not.
-        raise Bolt::ValidationError, <<~MSG
-        Unable to parse Puppetfile #{path}:
-        #{parsed.validation_errors.join("\n\n")}.
-        This may not be a Puppetfile managed by Bolt.
-        MSG
-      end
-
-      modules = parsed.modules.each_with_object([]) do |mod, acc|
-        unless mod.instance_of? PuppetfileResolver::Puppetfile::ForgeModule
-          next if skip_unsupported_modules
-
-          raise Bolt::ValidationError,
-                "Module '#{mod.title}' is not a Puppet Forge module. Unable to "\
-                "parse Puppetfile #{path}."
-        end
-
-        acc << Bolt::Puppetfile::Module.new(mod.owner, mod.name, mod.version)
-      end
-
-      new(modules)
-    end
-
-    # Writes a Puppetfile that includes specifications for each of the
-    # modules.
-    #
-    def write(path, moduledir = nil)
-      File.open(path, 'w') do |file|
-        if moduledir
-          file.puts "# This Puppetfile is managed by Bolt. Do not edit."
-          file.puts "# For more information, see https://pup.pt/bolt-modules"
-          file.puts
-          file.puts "# The following directive installs modules to the managed moduledir."
-          file.puts "moduledir '#{moduledir.basename}'"
-          file.puts
-        end
-
-        modules.each { |mod| file.puts mod.to_spec }
-      end
-    rescue SystemCallError => e
-      raise Bolt::FileError.new(
-        "#{e.message}: unable to write Puppetfile.",
-        path
-      )
-    end
-
-    # Resolves module dependencies using the puppetfile-resolver library. The
-    # resolver will return a document model including all module dependencies
-    # and the latest version that can be installed for each. The document model
-    # is parsed and turned into a Set of Bolt::Puppetfile::Module objects.
-    #
-    def resolve
-      require 'puppetfile-resolver'
-
-      # Build the document model from the modules.
-      model = PuppetfileResolver::Puppetfile::Document.new('')
-
-      @modules.each do |mod|
-        model.add_module(
-          PuppetfileResolver::Puppetfile::ForgeModule.new(mod.title).tap do |tap|
-            tap.version = mod.version || :latest
-          end
-        )
-      end
-
-      # Make sure the Puppetfile model is valid.
-      unless model.valid?
-        raise Bolt::ValidationError,
-              "Unable to resolve dependencies for modules: #{@modules.map(&:title).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, catching any errors
-      # raised by puppetfile-resolver and re-raising them as Bolt errors.
-      begin
-        result = resolver.resolve(
-          cache:                 nil,
-          ui:                    nil,
-          module_paths:          [],
-          allow_missing_modules: false
-        )
-      rescue StandardError => e
-        raise Bolt::Error.new(e.message, 'bolt/puppetfile-resolver-error')
-      end
-
-      # Turn specifications into module objects. This will skip over anything that is not
-      # a module specification (i.e. a Puppet version specification).
-      @modules = result.specifications.each_with_object(Set.new) do |(_name, spec), acc|
-        next unless spec.instance_of? PuppetfileResolver::Models::ModuleSpecification
-        acc << Bolt::Puppetfile::Module.new(spec.owner, spec.name, spec.version.to_s)
-      end
-    end
-
-    # Adds to the set of modules.
-    #
-    def add_modules(modules)
-      Array(modules).each do |mod|
-        case mod
-        when Bolt::Puppetfile::Module
-          @modules << mod
-        when Hash
-          @modules << Bolt::Puppetfile::Module.from_hash(mod)
-        else
-          raise Bolt::ValidationError, "Module must be a Bolt::Puppetfile::Module or Hash."
-        end
-      end
-
-      @modules
-    end
-  end
-end

data/lib/bolt/puppetfile/module.rb

@@ -1,93 +0,0 @@
-# frozen_string_literal: true
-
-require 'bolt/error'
-
-# This class represents a module specification. It used by the Bolt::Puppetfile
-# class to have a consistent API for accessing a module's attributes.
-#
-module Bolt
-  class Puppetfile
-    class Module
-      attr_reader :owner, :name, :version
-
-      def initialize(owner, name, version = nil)
-        @owner   = owner
-        @name    = name
-
-        if version.is_a?(String)
-          @version = version[0] == '=' ? version[1..-1] : version
-        end
-      end
-
-      # Creates a new module from a hash.
-      #
-      def self.from_hash(mod)
-        unless mod['name'].is_a?(String)
-          raise Bolt::ValidationError,
-                "Module name must be a String, not #{mod['name'].inspect}"
-        end
-
-        owner, name = mod['name'].tr('/', '-').split('-', 2)
-
-        unless owner && name
-          raise Bolt::ValidationError, "Module name #{mod['name']} must include both the owner and module name."
-        end
-
-        new(owner, name, mod['version_requirement'])
-      end
-
-      # Returns the module's title.
-      #
-      def title
-        "#{@owner}-#{@name}"
-      end
-      alias to_s title
-
-      # Checks two modules for equality.
-      #
-      def eql?(other)
-        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
-        if @version
-          "mod #{title.inspect}, #{@version.inspect}"
-        else
-          "mod #{title.inspect}"
-        end
-      end
-    end
-  end
-end