r10k 1.4.2 → 1.5.1

data/lib/r10k/module/forge.rb

@@ -1,6 +1,7 @@
 require 'r10k/module'
 require 'r10k/errors'
-require 'r10k/module/metadata'
+require 'shared/puppet/module_tool/metadata'
+require 'r10k/module/metadata_file'
 require 'r10k/util/subprocess'
 require 'r10k/module_repository/forge'
 
@@ -18,14 +19,15 @@ class R10K::Module::Forge < R10K::Module::Base
 
   # @!attribute [r] metadata
   #   @api private
-  #   @return [R10K::Module::Metadata]
+  #   @return [Puppet::ModuleTool::Metadata]
   attr_reader :metadata
 
   include R10K::Logging
 
   def initialize(title, dirname, args)
     super
-    @metadata = R10K::Module::Metadata.new(path + 'metadata.json')
+    @metadata_file = R10K::Module::MetadataFile.new(path + 'metadata.json')
+    @metadata = @metadata_file.read
 
     if args.is_a? String
       @expected_version = R10K::SemVer.new(args)
@@ -55,16 +57,14 @@ class R10K::Module::Forge < R10K::Module::Base
 
   # @return [R10K::SemVer] The expected version that the module
   def expected_version
-    if @expected_version == :latest
+    if @expected_version.is_a?(Symbol) && @expected_version == :latest
       set_version_from_forge
     end
     @expected_version
   end
 
-
   # @return [R10K::SemVer] The version of the currently installed module
   def current_version
-    @metadata.read
     @metadata.version
   end
 
@@ -89,7 +89,7 @@ class R10K::Module::Forge < R10K::Module::Base
     if not self.exist?
       # The module is not installed
       return :absent
-    elsif not @metadata.exist?
+    elsif not File.exist?(@path + 'metadata.json')
       # The directory exists but doesn't have a metadata file; it probably
       # isn't a forge module.
       return :mismatched
@@ -97,9 +97,10 @@ class R10K::Module::Forge < R10K::Module::Base
 
     # The module is present and has a metadata file, read the metadata to
     # determine the state of the module.
-    @metadata.read
+    @metadata_file.read(@path + 'metadata.json')
+
+    if not @title.tr('/','-') == @metadata.full_module_name.tr('/','-')
 
-    if not @owner == @metadata.author
       # This is a forge module but the installed module is a different author
       # than the expected author.
       return :mismatched

data/lib/r10k/module/git.rb

@@ -1,5 +1,7 @@
 require 'r10k/module'
 require 'r10k/git'
+require 'r10k/git/stateful_repository'
+require 'forwardable'
 
 class R10K::Module::Git < R10K::Module::Base
 
@@ -11,15 +13,15 @@ class R10K::Module::Git < R10K::Module::Base
     false
   end
 
-  # @!attribute [r] working_dir
+  # @!attribute [r] repo
   #   @api private
-  #   @return [R10K::Git::WorkingDir]
-  attr_reader :working_dir
+  #   @return [R10K::Git::StatefulRepository]
+  attr_reader :repo
 
   def initialize(title, dirname, args)
     super
     parse_options(@args)
-    @working_dir = R10K::Git::WorkingDir.new(@ref, @remote, @dirname, @name)
+    @repo = R10K::Git::StatefulRepository.new(@ref, @remote, @dirname, @name)
   end
 
   def version
@@ -29,69 +31,37 @@ class R10K::Module::Git < R10K::Module::Base
   def properties
     {
       :expected => @ref,
-      :actual   => (@working_dir.current.sha1 rescue "(unresolvable)"),
+      :actual   => (@repo.head || "(unresolvable)"),
       :type     => :git,
     }
   end
 
-  def sync
-    case status
-    when :absent
-      install
-    when :mismatched
-      uninstall
-      install
-    when :outdated
-      @working_dir.sync
-    end
-  end
-
-  def status
-    if not @working_dir.exist?
-      return :absent
-    elsif not @working_dir.git?
-      return :mismatched
-    elsif not @remote == @working_dir.remote
-      return :mismatched
-    end
+  extend Forwardable
 
-    if @working_dir.outdated?
-      return :outdated
-    end
-
-    return :insync
-  end
+  def_delegators :@repo, :sync, :status
 
   private
 
-  def install
-    @working_dir.sync
-  end
-
-  def uninstall
-    @path.rmtree
-  end
-
   def parse_options(options)
     @remote = options.delete(:git)
 
     if options[:branch]
-      @ref = R10K::Git::Head.new(options.delete(:branch))
+      @ref = options.delete(:branch)
     end
 
     if options[:tag]
-      @ref = R10K::Git::Tag.new(options.delete(:tag))
+      @ref = options.delete(:tag)
     end
 
     if options[:commit]
-      @ref = R10K::Git::Commit.new(options.delete(:commit))
+      @ref = options.delete(:commit)
     end
 
     if options[:ref]
-      @ref = R10K::Git::Ref.new(options.delete(:ref))
+      @ref = options.delete(:ref)
     end
 
-    @ref ||= R10K::Git::Ref.new('master')
+    @ref ||= 'master'
 
     unless options.empty?
       raise ArgumentError, "Unhandled options #{options.keys.inspect} specified for #{self.class}"

data/lib/r10k/module/metadata_file.rb

@@ -0,0 +1,31 @@
+require 'r10k/module'
+require 'r10k/errors'
+require 'shared/puppet/module_tool/metadata'
+
+class R10K::Module::MetadataFile
+
+  # @param metadata_path [Pathname] The file path to the metadata
+  def initialize(metadata_file_path)
+    @metadata_file_path = metadata_file_path
+  end
+
+  # Does the metadata file itself exist?
+  def exist?
+    @metadata_file_path.file? and @metadata_file_path.readable?
+  end
+
+  # @return [Puppet::ModuleTool::Metadata ] The metadata object created by the metadatafile
+  def read(metadata_file_path = @metadata_file_path)
+    if self.exist?
+      metadata_file_path.open do |f|
+        begin
+          metadata = Puppet::ModuleTool::Metadata.new
+          metadata.update(JSON.load(f), false)
+        rescue JSON::ParserError => e
+          exception = R10K::Error.wrap(e, "Could not read metadata.json")
+          raise exception
+        end
+      end
+    end
+  end
+end

data/lib/r10k/module/svn.rb

@@ -1,5 +1,4 @@
 require 'r10k/module'
-require 'r10k/execution'
 require 'r10k/svn/working_dir'
 require 'r10k/util/setopts'
 

data/lib/r10k/module_repository/forge.rb

@@ -1,5 +1,7 @@
 require 'r10k/module_repository'
 require 'r10k/version'
+require 'r10k/logging'
+require 'r10k/errors'
 
 require 'faraday'
 require 'faraday_middleware/multi_json'
@@ -7,6 +9,8 @@ require 'faraday_middleware'
 
 class R10K::ModuleRepository::Forge
 
+  include R10K::Logging
+
   # @!attribute [r] forge
   #   @return [String] The forge hostname to use for requests
   attr_reader :forge
@@ -16,7 +20,11 @@ class R10K::ModuleRepository::Forge
   #   @return [Faraday]
   attr_reader :conn
 
-  def initialize(forge = 'forge.puppetlabs.com')
+  def initialize(forge = 'forgeapi.puppetlabs.com')
+    if forge =~ /forge\.puppetlabs\.com/
+      logger.warn("#{forge} does not support the latest puppet forge API. Please update to \"forge 'https://forgeapi.puppetlabs.com'\"")
+      forge = 'forgeapi.puppetlabs.com'
+    end
     @forge = forge
     @conn  = make_conn
   end
@@ -31,10 +39,18 @@ class R10K::ModuleRepository::Forge
   # @param module_name [String] The fully qualified module name
   # @return [Array<String>] All published versions of the given module
   def versions(module_name)
-    response = @conn.get("/api/v1/releases.json", {'module' => module_name})
-    response.body[module_name].map do |version_info|
+    path = "/v3/modules/#{module_name.tr('/','-')}"
+    response = @conn.get(path)
+
+    if response.status != 200
+      raise R10K::Error.new("Request to Puppet Forge '#{path}' failed. Status: #{response.status}")
+    end
+
+    releases = response.body['releases'].reject { |r| r['deleted_at'] }
+    releases = releases.map do |version_info|
       version_info['version']
     end
+    releases.reverse
   end
 
   # Query for the newest published version of a module
@@ -56,10 +72,7 @@ class R10K::ModuleRepository::Forge
     # Force use of json_pure with multi_json on Ruby 1.8.7
     multi_json_opts = (RUBY_VERSION == "1.8.7" ? {:adapter => :json_pure} : {})
 
-    Faraday.new(
-      :url => "https://#{@forge}",
-      :user_agent => "Ruby/r10k #{R10K::VERSION}"
-    ) do |builder|
+    Faraday.new(:url => "https://#{@forge}") do |builder|
       builder.request(:multi_json, multi_json_opts)
       builder.response(:multi_json, multi_json_opts)
 

data/lib/r10k/puppetfile.rb

@@ -37,7 +37,7 @@ class Puppetfile
     @puppetfile_path = puppetfile || File.join(basedir, 'Puppetfile')
 
     @modules = []
-    @forge   = 'forge.puppetlabs.com'
+    @forge   = 'forgeapi.puppetlabs.com'
   end
 
   def load

data/lib/r10k/settings/container.rb

@@ -74,6 +74,12 @@ class R10K::Settings::Container
     end
   end
 
+  # Clear all existing settings in this container. Valid settings are left alone.
+  # @return [void]
+  def reset!
+    @settings = {}
+  end
+
   private
 
   def validate_key!(key)

data/lib/r10k/settings/mixin.rb

@@ -41,5 +41,14 @@ module R10K::Settings::Mixin
     def settings
       @settings ||= R10K::Settings::Container.new(defaults)
     end
+
+    # Allow subclasses to use the settings of the parent class as default values
+    #
+    # @return [void]
+    def inherited(subclass)
+      subclass.instance_eval do
+        @settings = R10K::Settings::Container.new(superclass.settings)
+      end
+    end
   end
 end

data/lib/r10k/source.rb

@@ -1,6 +1,6 @@
 require 'r10k'
 require 'r10k/keyed_factory'
-require 'r10k/util/core_ext/hash_ext'
+require 'r10k/util/symbolize_keys'
 
 module R10K
   module Source
@@ -21,8 +21,7 @@ module R10K
     end
 
     def self.from_hash(name, hash)
-      hash.extend R10K::Util::CoreExt::HashExt::SymbolizeKeys
-      hash.symbolize_keys!
+      R10K::Util::SymbolizeKeys.symbolize_keys!(hash)
 
       basedir = hash.delete(:basedir)
 

data/lib/r10k/source/base.rb

@@ -12,8 +12,8 @@ class R10K::Source::Base
   attr_reader :name
 
   # @!attribute [r] prefix
-  #   @return [true, false] Whether the source name should be prefixed to each
-  #     environment basedir. Defaults to false
+  #   @return [String, nil] The prefix for the environments basedir.
+  #     Defaults to nil.
   attr_reader :prefix
 
   # Initialize the given source.
@@ -23,9 +23,9 @@ class R10K::Source::Base
   # @param options [Hash] An additional set of options for this source. The
   #   semantics of this hash may depend on the source implementation.
   #
-  # @option options [Boolean] :prefix Whether to prefix the source name to the
-  #   environment directory names. All sources should respect this option.
-  #   Defaults to false.
+  # @option options [Boolean, String] :prefix If a String this becomes the prefix.
+  #   If true, will use the source name as the prefix. All sources should respect this option.
+  #   Defaults to false for no environment prefix.
   def initialize(name, basedir, options = {})
     @name    = name
     @basedir = basedir

data/lib/r10k/source/git.rb

@@ -1,7 +1,6 @@
 require 'r10k/git'
 require 'r10k/environment'
-require 'r10k/util/purgeable'
-require 'r10k/util/core_ext/hash_ext'
+require 'r10k/environment/name'
 
 # This class implements a source for Git environments.
 #
@@ -43,8 +42,9 @@ class R10K::Source::Git < R10K::Source::Base
   # @param basedir [String] The base directory where the generated environments will be created.
   # @param options [Hash] An additional set of options for this source.
   #
-  # @option options [Boolean] :prefix Whether to prefix the source name to the
-  #   environment directory names. Defaults to false.
+  # @option options [Boolean, String] :prefix If a String this becomes the prefix.
+  #   If true, will use the source name as the prefix.
+  #   Defaults to false for no environment prefix.
   # @option options [String] :remote The URL to the base directory of the SVN repository
   # @option options [Hash] :remote Additional settings that configure how the
   #   source should behave.
@@ -56,15 +56,17 @@ class R10K::Source::Git < R10K::Source::Base
     @remote           = options[:remote]
     @invalid_branches = (options[:invalid_branches] || 'correct_and_warn')
 
-    @cache  = R10K::Git::Cache.generate(@remote)
+    @cache  = R10K::Git.cache.generate(@remote)
   end
 
   # Update the git cache for this git source to get the latest list of environments.
   #
   # @return [void]
   def preload!
-    logger.debug "Determining current branches for Git source #{@remote.inspect}"
+    logger.debug "Fetching '#{@remote}' to determine current branches."
     @cache.sync
+  rescue => e
+    raise R10K::Error.wrap(e, "Unable to determine current branches for Git source '#{@name}' (#{@basedir})")
   end
   alias fetch_remote preload!
 
@@ -100,24 +102,8 @@ class R10K::Source::Git < R10K::Source::Base
     envs
   end
 
-  include R10K::Util::Purgeable
-
-  def managed_directory
-    @basedir
-  end
-
-  def current_contents
-    dir = self.managed_directory
-    glob_part = @prefix ? @name.to_s() + '_*' : '*'
-    glob_exp = File.join(dir, glob_part)
-
-    Dir.glob(glob_exp).map do |fname|
-      File.basename fname
-    end
-  end
-
   # List all environments that should exist in the basedir for this source
-  # @note This implements a required method for the Purgeable mixin
+  # @note This is required by {R10K::Util::Basedir}
   # @return [Array<String>]
   def desired_contents
     environments.map {|env| env.dirname }
@@ -126,70 +112,9 @@ class R10K::Source::Git < R10K::Source::Base
   private
 
   def branch_names
+    opts = {:prefix => @prefix, :invalid => @invalid_branches, :source => @name}
     @cache.branches.map do |branch|
-      BranchName.new(branch, {
-        :prefix     => @prefix,
-        :sourcename => @name,
-        :invalid    => @invalid_branches,
-      })
-    end
-  end
-
-  # @api private
-  class BranchName
-
-    attr_reader :name
-
-    INVALID_CHARACTERS = %r[\W]
-
-    def initialize(name, opts)
-      @name = name
-      @opts = opts
-
-      @prefix = opts[:prefix]
-      @sourcename = opts[:sourcename]
-      @invalid = opts[:invalid]
-
-      case @invalid
-      when 'correct_and_warn'
-        @validate = true
-        @correct  = true
-      when 'correct'
-        @validate = false
-        @correct  = true
-      when 'error'
-        @validate = true
-        @correct  = false
-      when NilClass
-        @validate = opts[:validate]
-        @correct = opts[:correct]
-      end
+      R10K::Environment::Name.new(branch, opts)
     end
-
-    def correct?; @correct end
-    def validate?; @validate end
-
-    def valid?
-      if @validate
-        ! @name.match(INVALID_CHARACTERS)
-      else
-        true
-      end
-    end
-
-    def dirname
-      dir = @name.dup
-
-      if @prefix
-        dir = "#{@sourcename}_#{dir}"
-      end
-
-      if @correct
-        dir.gsub!(INVALID_CHARACTERS, '_')
-      end
-
-      dir
-    end
-
   end
 end