r10k 1.3.5 → 1.4.0

data/lib/r10k/module/forge.rb

@@ -16,31 +16,16 @@ class R10K::Module::Forge < R10K::Module::Base
     !!(name.match %r[\w+/\w+])
   end
 
-  include R10K::Logging
-
-  # @!attribute [r] author
-  #   @return [String] The Forge module author
-  attr_reader :author
-
-  # @deprecated
-  def owner
-    logger.warn "#{self.inspect}#owner is deprecated; use #author instead"
-    @author
-  end
-
-  # @!attribute [r] full_name
-  #   @return [String] The fully qualified module name
-  attr_reader :full_name
-
-  def initialize(full_name, basedir, args)
-    @full_name = full_name
-    @basedir   = basedir
-
-    @author, @name = full_name.split('/')
+  # @!attribute [r] metadata
+  #   @api private
+  #   @return [R10K::Module::Metadata]
+  attr_reader :metadata
 
-    @full_path = Pathname.new(File.join(@basedir, @name))
+  include R10K::Logging
 
-    @metadata = R10K::Module::Metadata.new(@full_path + 'metadata.json')
+  def initialize(title, dirname, args)
+    super
+    @metadata = R10K::Module::Metadata.new(path + 'metadata.json')
 
     if args.is_a? String
       @expected_version = R10K::SemVer.new(args)
@@ -60,6 +45,14 @@ class R10K::Module::Forge < R10K::Module::Base
     end
   end
 
+  def properties
+    {
+      :expected => expected_version,
+      :actual   => current_version,
+      :type     => :forge,
+    }
+  end
+
   # @return [R10K::SemVer] The expected version that the module
   def expected_version
     if @expected_version == :latest
@@ -71,13 +64,14 @@ class R10K::Module::Forge < R10K::Module::Base
 
   # @return [R10K::SemVer] The version of the currently installed module
   def current_version
+    @metadata.read
     @metadata.version
   end
 
   alias version current_version
 
   def exist?
-    @full_path.exist?
+    path.exist?
   end
 
   def insync?
@@ -105,7 +99,7 @@ class R10K::Module::Forge < R10K::Module::Base
     # determine the state of the module.
     @metadata.read
 
-    if not @author == @metadata.author
+    if not @owner == @metadata.author
       # This is a forge module but the installed module is a different author
       # than the expected author.
       return :mismatched
@@ -121,12 +115,12 @@ class R10K::Module::Forge < R10K::Module::Base
   private
 
   def install
-    FileUtils.mkdir @basedir unless File.directory? @basedir
+    FileUtils.mkdir @dirname unless File.directory? @dirname
     cmd = []
     cmd << 'install'
     cmd << "--version=#{expected_version}" if expected_version
     cmd << "--force"
-    cmd << @full_name
+    cmd << title
     pmt cmd
   end
 
@@ -135,7 +129,7 @@ class R10K::Module::Forge < R10K::Module::Base
     cmd << 'upgrade'
     cmd << "--version=#{expected_version}" if expected_version
     cmd << "--force"
-    cmd << @full_name
+    cmd << title
     pmt cmd
   end
 
@@ -154,7 +148,7 @@ class R10K::Module::Forge < R10K::Module::Base
   #
   # @return [String] The stdout from the executed command
   def pmt(argv)
-    argv = ['puppet', 'module', '--modulepath', @basedir] + argv
+    argv = ['puppet', 'module', '--modulepath', @dirname, '--color', 'false'] + argv
 
     subproc = R10K::Util::Subprocess.new(argv)
     subproc.raise_on_fail = true
@@ -167,7 +161,16 @@ class R10K::Module::Forge < R10K::Module::Base
 
   def set_version_from_forge
     repo = R10K::ModuleRepository::Forge.new
-    expected = repo.latest_version(@full_name)
+    expected = repo.latest_version(title)
     @expected_version = R10K::SemVer.new(expected)
   end
+
+  # Override the base #parse_title to ensure we have a fully qualified name
+  def parse_title(title)
+    if (match = title.match(/\A(\w+)[-\/](\w+)\Z/))
+      [match[1], match[2]]
+    else
+      raise ArgumentError, "Forge module names must match 'owner/modulename'"
+    end
+  end
 end

data/lib/r10k/module/git.rb

@@ -16,20 +16,24 @@ class R10K::Module::Git < R10K::Module::Base
   #   @return [R10K::Git::WorkingDir]
   attr_reader :working_dir
 
-  def initialize(name, basedir, args)
-    @name, @basedir, @args = name, basedir, args
-
-    parse_options(args)
-
-    @full_path = Pathname.new(File.join(basedir, name))
-
-    @working_dir = R10K::Git::WorkingDir.new(@ref, @remote, @basedir, @name)
+  def initialize(title, dirname, args)
+    super
+    parse_options(@args)
+    @working_dir = R10K::Git::WorkingDir.new(@ref, @remote, @dirname, @name)
   end
 
   def version
     @ref
   end
 
+  def properties
+    {
+      :expected => @ref,
+      :actual   => (@working_dir.current.sha1 rescue "(unresolvable)"),
+      :type     => :git,
+    }
+  end
+
   def sync
     case status
     when :absent
@@ -65,7 +69,7 @@ class R10K::Module::Git < R10K::Module::Base
   end
 
   def uninstall
-    @full_path.rmtree
+    @path.rmtree
   end
 
   def parse_options(options)

data/lib/r10k/module/svn.rb

@@ -1,6 +1,7 @@
 require 'r10k/module'
 require 'r10k/execution'
 require 'r10k/svn/working_dir'
+require 'r10k/util/setopts'
 
 class R10K::Module::SVN < R10K::Module::Base
 
@@ -15,22 +16,39 @@ class R10K::Module::SVN < R10K::Module::Base
   attr_reader :expected_revision
   alias expected_version expected_revision
 
-  # @!attribute [r] svn_path
-  #   @return [String] The path inside of the SVN repository to have checked out
-  attr_reader :svn_path
-
   # @!attribute [r] full_path
   #   @return [Pathname] The filesystem path to the SVN repo
   attr_reader :full_path
 
-  def initialize(name, basedir, args)
-    @name = name
-    @basedir = basedir
-
-    parse_options(args)
-
-    @full_path = Pathname.new(File.join(@basedir, @name))
-    @working_dir = R10K::SVN::WorkingDir.new(@full_path)
+  # @!attribute [r] username
+  #   @return [String, nil] The SVN username to be passed to the underlying SVN commands
+  #   @api private
+  attr_reader :username
+
+  # @!attribute [r] password
+  #   @return [String, nil] The SVN password to be passed to the underlying SVN commands
+  #   @api private
+  attr_reader :password
+
+  # @!attribute [r] working_dir
+  #   @return [R10K::SVN::WorkingDir]
+  #   @api private
+  attr_reader :working_dir
+
+  include R10K::Util::Setopts
+
+  INITIALIZE_OPTS = {
+    :svn => :url,
+    :rev => :expected_revision,
+    :revision => :expected_revision,
+    :username => :self,
+    :password => :self
+  }
+
+  def initialize(name, dirname, opts)
+    super
+    setopts(opts, INITIALIZE_OPTS)
+    @working_dir = R10K::SVN::WorkingDir.new(@path, :username => @username, :password => @password)
   end
 
   def status
@@ -59,19 +77,27 @@ class R10K::Module::SVN < R10K::Module::Base
   end
 
   def exist?
-    @full_path.exist?
+    path.exist?
+  end
+
+  def properties
+    {
+      :expected => expected_revision,
+      :actual   => (@working_dir.revision rescue "(unresolvable)"),
+      :type     => :svn,
+    }
   end
 
   private
 
   def install
-    FileUtils.mkdir @basedir unless File.directory? @basedir
+    FileUtils.mkdir @dirname unless File.directory? @dirname
 
     @working_dir.checkout(@url, @expected_revision)
   end
 
   def uninstall
-    @full_path.rmtree
+    path.rmtree
   end
 
   def reinstall
@@ -82,17 +108,4 @@ class R10K::Module::SVN < R10K::Module::Base
   def update
     @working_dir.update(@expected_revision)
   end
-
-  def parse_options(hash)
-    hash.each_pair do |key, value|
-      case key
-      when :svn
-        @url = value
-      when :rev, :revision
-        @expected_revision = value
-      when :svn_path
-        @svn_path = value
-      end
-    end
-  end
 end

data/lib/r10k/puppetfile.rb

@@ -1,5 +1,7 @@
+require 'pathname'
 require 'r10k/module'
 require 'r10k/util/purgeable'
+require 'r10k/errors'
 
 module R10K
 class Puppetfile
@@ -49,6 +51,8 @@ class Puppetfile
   def load!
     dsl = R10K::Puppetfile::DSL.new(self)
     dsl.instance_eval(puppetfile_contents, @puppetfile_path)
+  rescue SyntaxError, LoadError => e
+    raise R10K::Error.wrap(e, "Failed to evaluate #{@puppetfile_path}")
   end
 
   # @param [String] forge
@@ -58,7 +62,11 @@ class Puppetfile
 
   # @param [String] moduledir
   def set_moduledir(moduledir)
-    @moduledir = moduledir
+    @moduledir = if Pathname.new(moduledir).absolute?
+      moduledir
+    else
+      File.join(basedir, moduledir)
+    end
   end
 
   # @param [String] name
@@ -80,6 +88,14 @@ class Puppetfile
     @modules.map { |mod| mod.name }
   end
 
+  def accept(visitor)
+    visitor.visit(:puppetfile, self) do
+      modules.each do |mod|
+        mod.accept(visitor)
+      end
+    end
+  end
+
   private
 
   def puppetfile_contents

data/lib/r10k/semver.rb

@@ -4,6 +4,7 @@
 # and instead use numeric comparisons (eg >, <, >=, <=)
 # Ruby 1.8 already did this for all ranges, but Ruby 1.9 changed range include behavior
 module R10K
+# :nocov:
 class SemVer < Numeric
   include Comparable
 
@@ -123,4 +124,5 @@ class SemVer < Numeric
   MAX.instance_variable_set(:@major, (1.0/0)) # => Infinity
   MAX.instance_variable_set(:@vstring, 'vMAX')
 end
+# :nocov:
 end

data/lib/r10k/source/base.rb

@@ -57,4 +57,12 @@ class R10K::Source::Base
   def environments
     raise NotImplementedError, "#{self.class} has not implemented method #{__method__}"
   end
+
+  def accept(visitor)
+    visitor.visit(:source, self) do
+      environments.each do |env|
+        env.accept(visitor)
+      end
+    end
+  end
 end

data/lib/r10k/source/git.rb

@@ -63,7 +63,7 @@ class R10K::Source::Git < R10K::Source::Base
   #
   # @return [void]
   def preload!
-    logger.info "Determining current branches for #{@remote.inspect}"
+    logger.debug "Determining current branches for Git source #{@remote.inspect}"
     @cache.sync
   end
   alias fetch_remote preload!

data/lib/r10k/source/svn.rb

@@ -2,6 +2,7 @@ require 'r10k/svn'
 require 'r10k/environment'
 require 'r10k/util/purgeable'
 require 'r10k/util/core_ext/hash_ext'
+require 'r10k/util/setopts'
 
 # This class implements a source for SVN environments.
 #
@@ -27,6 +28,18 @@ class R10K::Source::SVN < R10K::Source::Base
   #   @return [R10K::SVN::Remote]
   attr_reader :svn_remote
 
+  # @!attribute [r] username
+  #   @return [String, nil] The SVN username to be passed to the underlying SVN commands
+  #   @api private
+  attr_reader :username
+
+  # @!attribute [r] password
+  #   @return [String, nil] The SVN password to be passed to the underlying SVN commands
+  #   @api private
+  attr_reader :password
+
+  include R10K::Util::Setopts
+
   # Initialize the given source.
   #
   # @param name [String] The identifier for this source.
@@ -36,13 +49,14 @@ class R10K::Source::SVN < R10K::Source::Base
   # @option options [Boolean] :prefix Whether to prefix the source name to the
   #   environment directory names. Defaults to false.
   # @option options [String] :remote The URL to the base directory of the SVN repository
+  # @option options [String] :username The SVN username
+  # @option options [String] :password The SVN password
   def initialize(name, basedir, options = {})
     super
 
-    @remote = options[:remote]
+    setopts(options, {:remote => :self, :username => :self, :password => :self})
     @environments = []
-
-    @svn_remote = R10K::SVN::Remote.new(@remote)
+    @svn_remote = R10K::SVN::Remote.new(@remote, :username => @username, :password => @password)
   end
 
   # Enumerate the environments associated with this SVN source.
@@ -67,8 +81,12 @@ class R10K::Source::SVN < R10K::Source::Base
   def generate_environments
 
     branch_names.map do |branch|
-      R10K::Environment::SVN.new(branch.name, @basedir, branch.dirname,
-                                 { :remote => branch.remote })
+      options = {
+        :remote   => branch.remote,
+        :username => @username,
+        :password => @password
+      }
+      R10K::Environment::SVN.new(branch.name, @basedir, branch.dirname, options)
     end
   end
 

data/lib/r10k/svn/remote.rb

@@ -1,9 +1,17 @@
 require 'r10k/util/subprocess'
+require 'r10k/util/setopts'
 
+# Inspect and interact with SVN remote repositories
+#
+# @api private
+# @since 1.3.0
 class R10K::SVN::Remote
 
-  def initialize(baseurl)
+  include R10K::Util::Setopts
+
+  def initialize(baseurl, opts = {})
     @baseurl = baseurl
+    setopts(opts, {:username => :self, :password => :self})
   end
 
   # @todo validate that the path to trunk exists in the remote
@@ -13,7 +21,9 @@ class R10K::SVN::Remote
 
   # @todo gracefully handle cases where no branches exist
   def branches
-    text = svn ['ls', "#{@baseurl}/branches"]
+    argv = ['ls', "#{@baseurl}/branches"]
+    argv.concat(auth)
+    text = svn(argv)
     text.lines.map do |line|
       line.chomp!
       line.gsub!(%r[/$], '')
@@ -23,6 +33,16 @@ class R10K::SVN::Remote
 
   private
 
+  # Format authentication information for SVN command args, if applicable
+  def auth
+    auth = []
+    if @username
+      auth << "--username" << @username
+      auth << "--password" << @password
+    end
+    auth
+  end
+
   include R10K::Logging
 
   # Wrap SVN commands
@@ -34,7 +54,7 @@ class R10K::SVN::Remote
   #
   # @return [String] The stdout from the given command
   def svn(argv, opts = {})
-    argv.unshift('svn')
+    argv.unshift('svn', '--non-interactive')
 
     subproc = R10K::Util::Subprocess.new(argv)
     subproc.raise_on_fail = true