r10k 3.7.0 → 3.9.3

data/lib/r10k/environment/base.rb

@@ -1,10 +1,13 @@
 require 'r10k/util/subprocess'
+require 'r10k/logging'
 
 # This class defines a common interface for environment implementations.
 #
 # @since 1.3.0
 class R10K::Environment::Base
 
+  include R10K::Logging
+
   # @!attribute [r] name
   #   @return [String] A name for this environment that is unique to the given source
   attr_reader :name
@@ -43,12 +46,16 @@ class R10K::Environment::Base
     @basedir = basedir
     @dirname = dirname
     @options = options
-    @puppetfile_name = options[:puppetfile_name]
+    @puppetfile_name = options.delete(:puppetfile_name)
+    @overrides = options.delete(:overrides) || {}
 
     @full_path = File.join(@basedir, @dirname)
     @path = Pathname.new(File.join(@basedir, @dirname))
 
-    @puppetfile  = R10K::Puppetfile.new(@full_path, nil, nil, @puppetfile_name)
+    @puppetfile  = R10K::Puppetfile.new(@full_path,
+                                        {overrides: @overrides,
+                                         force: @overrides.dig(:modules, :force),
+                                         puppetfile_name: @puppetfile_name})
     @puppetfile.environment = self
   end
 
@@ -103,12 +110,32 @@ class R10K::Environment::Base
     @puppetfile.modules
   end
 
+  # @return [Array<R10K::Module::Base>] Whether or not the given module
+  #   conflicts with any modules already defined in the r10k environment
+  #   object.
+  def module_conflicts?(mod)
+    false
+  end
+
   def accept(visitor)
     visitor.visit(:environment, self) do
       puppetfile.accept(visitor)
     end
   end
 
+  def deploy
+    puppetfile.load(@overrides.dig(:environments, :default_branch_override))
+
+    puppetfile.sync
+
+    if (@overrides.dig(:purging, :purge_levels) || []).include?(:puppetfile)
+      logger.debug("Purging unmanaged Puppetfile content for environment '#{dirname}'...")
+      R10K::Util::Cleaner.new(puppetfile.managed_directories,
+                              puppetfile.desired_contents,
+                              puppetfile.purge_exclusions).purge!
+    end
+  end
+
   def whitelist(user_whitelist=[])
     user_whitelist.collect { |pattern| File.join(@full_path, pattern) }
   end

data/lib/r10k/environment/git.rb

@@ -1,4 +1,3 @@
-require 'r10k/logging'
 require 'r10k/puppetfile'
 require 'r10k/git/stateful_repository'
 require 'forwardable'
@@ -8,8 +7,6 @@ require 'forwardable'
 # @since 1.3.0
 class R10K::Environment::Git < R10K::Environment::WithModules
 
-  include R10K::Logging
-
   R10K::Environment.register(:git, self)
   # Register git as the default environment type
   R10K::Environment.register(nil, self)
@@ -27,6 +24,8 @@ class R10K::Environment::Git < R10K::Environment::WithModules
   #   @return [R10K::Git::StatefulRepository] The git repo backing this environment
   attr_reader :repo
 
+  include R10K::Util::Setopts
+
   # Initialize the given Git environment.
   #
   # @param name [String] The unique name describing this environment.
@@ -38,8 +37,21 @@ class R10K::Environment::Git < R10K::Environment::WithModules
   # @param options [String] :ref The git reference to use for this environment
   def initialize(name, basedir, dirname, options = {})
     super
-    @remote = options[:remote]
-    @ref    = options[:ref]
+    setopts(options, {
+      # Standard option interface
+      :version => :ref,
+      :source  => :remote,
+      :type    => ::R10K::Util::Setopts::Ignore,
+
+      # Type-specific options
+      :ref     => :self,
+      :remote  => :self,
+
+    }, raise_on_unhandled: false)
+    # TODO: in r10k 4.0.0, a major version bump, stop allowing garbage options.
+    # We only allow them now, here, on this object, because prior to adopting
+    # setopts in the constructor, this object type didn't do any validation
+    # checking of options passed, and would permit garbage parameters.
 
     @repo = R10K::Git::StatefulRepository.new(@remote, @basedir, @dirname)
   end

data/lib/r10k/environment/name.rb

@@ -12,13 +12,13 @@ module R10K
       INVALID_CHARACTERS = %r[\W]
 
       def initialize(name, opts)
-        @name   = name
-        @opts   = opts
-
         @source  = opts[:source]
         @prefix  = opts[:prefix]
         @invalid = opts[:invalid]
 
+        @name = derive_name(name, opts[:strip_component])
+        @opts = opts
+
         case @invalid
         when 'correct_and_warn'
           @validate = true
@@ -71,8 +71,26 @@ module R10K
 
       private
 
-      def derive_prefix(source,prefix)
+      def derive_name(name, strip_component)
+        return name unless strip_component
+
+        unless strip_component.is_a?(String)
+          raise _('Improper configuration value given for strip_component setting in %{src} source. ' \
+                  'Value must be a string, a /regex/, false, or omitted. Got "%{val}" (%{type})' \
+                  % {src: @source, val: strip_component, type: strip_component.class})
+        end
 
+        if %r{^/.*/$}.match(strip_component)
+          regex = Regexp.new(strip_component[1..-2])
+          name.gsub(regex, '')
+        elsif name.start_with?(strip_component)
+          name[strip_component.size..-1]
+        else
+          name
+        end
+      end
+
+      def derive_prefix(source,prefix)
         if prefix == true
           "#{source}_"
         elsif prefix.is_a? String

data/lib/r10k/environment/svn.rb

@@ -7,8 +7,6 @@ require 'r10k/util/setopts'
 # @since 1.3.0
 class R10K::Environment::SVN < R10K::Environment::Base
 
-  include R10K::Logging
-
   R10K::Environment.register(:svn, self)
 
   # @!attribute [r] remote
@@ -44,8 +42,17 @@ class R10K::Environment::SVN < R10K::Environment::Base
   # @option options [String] :password The SVN password
   def initialize(name, basedir, dirname, options = {})
     super
+    setopts(options, {
+      # Standard option interface
+      :source   => :remote,
+      :version  => :expected_revision,
+      :type     => ::R10K::Util::Setopts::Ignore,
 
-    setopts(options, {:remote => :self, :username => :self, :password => :self, :puppetfile_name => :self })
+      # Type-specific options
+      :remote   => :self,
+      :username => :self,
+      :password => :self,
+    })
 
     @working_dir = R10K::SVN::WorkingDir.new(Pathname.new(@full_path), :username => @username, :password => @password)
   end
@@ -61,7 +68,7 @@ class R10K::Environment::SVN < R10K::Environment::Base
     if @working_dir.is_svn?
       @working_dir.update
     else
-      @working_dir.checkout(@remote)
+      @working_dir.checkout(@remote, @expected_revision)
     end
     @synced = true
   end

data/lib/r10k/environment/with_modules.rb

@@ -1,4 +1,3 @@
-require 'r10k/logging'
 require 'r10k/util/purgeable'
 
 # This abstract base class implements an environment that can include module
@@ -7,8 +6,6 @@ require 'r10k/util/purgeable'
 # @since 3.4.0
 class R10K::Environment::WithModules < R10K::Environment::Base
 
-  include R10K::Logging
-
   # @!attribute [r] moduledir
   #   @return [String] The directory to install environment-defined modules
   #     into (default: #{basedir}/modules)
@@ -24,7 +21,7 @@ class R10K::Environment::WithModules < R10K::Environment::Base
   # @param options [String] :moduledir The path to install modules to
   # @param options [Hash] :modules Modules to add to the environment
   def initialize(name, basedir, dirname, options = {})
-    super(name, basedir, dirname, options)
+    super
 
     @managed_content = {}
     @modules = []
@@ -46,38 +43,71 @@ class R10K::Environment::WithModules < R10K::Environment::Base
   #     - The r10k environment object
   #     - A Puppetfile in the environment's content
   def modules
-    return @modules if @puppetfile.nil?
+    return @modules if puppetfile.nil?
+
+    puppetfile.load unless puppetfile.loaded?
+    @modules + puppetfile.modules
+  end
+
+  def module_conflicts?(mod_b)
+    conflict = @modules.any? { |mod_a| mod_a.name == mod_b.name }
+    return false unless conflict
+
+    msg_vars = {src: mod_b.origin, name: mod_b.name}
+    msg_error = _('Environment and %{src} both define the "%{name}" module' % msg_vars)
+    msg_continue = _("#{msg_error}. The %{src} definition will be ignored" % msg_vars)
+
+    case conflict_opt = @options[:module_conflicts]
+    when 'override_and_warn', nil
+      logger.warn msg_continue
+    when 'override'
+      logger.debug msg_continue
+    when 'error'
+      raise R10K::Error, msg_error
+    else
+      raise R10K::Error, _('Unexpected value for `module_conflicts` setting in %{env} ' \
+                           'environment: %{val}' % {env: self.name, val: conflict_opt})
+    end
 
-    @puppetfile.load unless @puppetfile.loaded?
-    @modules + @puppetfile.modules
+    true
   end
 
   def accept(visitor)
     visitor.visit(:environment, self) do
       @modules.each do |mod|
-        mod.accept(visitor)
+        mod.sync
       end
 
       puppetfile.accept(visitor)
-      validate_no_module_conflicts
     end
   end
 
+  def deploy
+    @modules.each do |mod|
+      mod.sync
+    end
+
+    super
+  end
+
   def load_modules(module_hash)
     module_hash.each do |name, args|
+      if !args.is_a?(Hash)
+        args = { version: args }
+      end
+
       add_module(name, args)
     end
   end
 
   # @param [String] name
-  # @param [*Object] args
+  # @param [Hash] args
   def add_module(name, args)
-    if args.is_a?(Hash)
-      # symbolize keys in the args hash
-      args = args.inject({}) { |memo,(k,v)| memo[k.to_sym] = v; memo }
-    end
+    # symbolize keys in the args hash
+    args = args.inject({}) { |memo,(k,v)| memo[k.to_sym] = v; memo }
+    args[:overrides] = @overrides
 
-    if args.is_a?(Hash) && install_path = args.delete(:install_path)
+    if install_path = args.delete(:install_path)
       install_path = resolve_install_path(install_path)
       validate_install_path(install_path, name)
     else
@@ -88,26 +118,12 @@ class R10K::Environment::WithModules < R10K::Environment::Base
     @managed_content[install_path] = Array.new unless @managed_content.has_key?(install_path)
 
     mod = R10K::Module.new(name, install_path, args, self.name)
-    mod.origin = 'Environment'
+    mod.origin = :environment
 
     @managed_content[install_path] << mod.name
     @modules << mod
   end
 
-  def validate_no_module_conflicts
-    @puppetfile.load unless @puppetfile.loaded?
-    conflicts = (@modules + @puppetfile.modules)
-                .group_by { |mod| mod.name }
-                .select { |_, v| v.size > 1 }
-                .map(&:first)
-    unless conflicts.empty?
-      msg = _('Puppetfile cannot contain module names defined by environment %{name}') % {name: self.name}
-      msg += ' '
-      msg += _("Remove the conflicting definitions of the following modules: %{conflicts}" % { conflicts: conflicts.join(' ') })
-      raise R10K::Error.new(msg)
-    end
-  end
-
   include R10K::Util::Purgeable
 
   # Returns an array of the full paths that can be purged.

data/lib/r10k/git.rb

@@ -134,6 +134,7 @@ module R10K
     extend R10K::Settings::Mixin::ClassMethods
 
     def_setting_attr :private_key
+    def_setting_attr :oauth_token
     def_setting_attr :proxy
     def_setting_attr :username
     def_setting_attr :repositories, {}

data/lib/r10k/git/rugged/credentials.rb

@@ -61,11 +61,48 @@ class R10K::Git::Rugged::Credentials
   end
 
   def get_plaintext_credentials(url, username_from_url)
-    user = get_git_username(url, username_from_url)
-    password = URI.parse(url).password || ''
+    per_repo_oauth_token = nil
+    if per_repo_settings = R10K::Git.get_repo_settings(url)
+      per_repo_oauth_token = per_repo_settings[:oauth_token]
+    end
+
+    if token_path = per_repo_oauth_token || R10K::Git.settings[:oauth_token]
+      @oauth_token ||= extract_token(token_path, url)
+
+      user = 'x-oauth-token'
+      password = @oauth_token
+    else
+      user = get_git_username(url, username_from_url)
+      password = URI.parse(url).password || ''
+    end
     Rugged::Credentials::UserPassword.new(username: user, password: password)
   end
 
+  def extract_token(token_path, url)
+    if token_path == '-'
+      token = $stdin.read.strip
+      logger.debug2 _("Using OAuth token from stdin for URL %{url}") % { url: url }
+    elsif File.readable?(token_path)
+      token = File.read(token_path).strip
+      logger.debug2 _("Using OAuth token from %{token_path} for URL %{url}") % { token_path: token_path, url: url }
+    else
+      raise R10K::Git::GitError, _("%{path} is missing or unreadable, cannot load OAuth token") % { path: token_path }
+    end
+
+    unless valid_token?(token)
+      raise R10K::Git::GitError, _("Supplied OAuth token contains invalid characters.")
+    end
+
+    token
+  end
+
+  # This regex is the only real requirement for OAuth token format,
+  # per https://www.oauth.com/oauth2-servers/access-tokens/access-token-response/
+  # Bitbucket's tokens also can include an underscore, so that is added here.
+  def valid_token?(token)
+    return token =~ /^[\w\-\.~_\+\/]+$/
+  end
+
   def get_default_credentials(url, username_from_url)
     Rugged::Credentials::Default.new
   end

data/lib/r10k/initializers.rb

@@ -55,6 +55,7 @@ module R10K
         with_setting(:private_key) { |value| R10K::Git.settings[:private_key] = value }
         with_setting(:proxy) { |value| R10K::Git.settings[:proxy] = value }
         with_setting(:repositories) { |value| R10K::Git.settings[:repositories] = value }
+        with_setting(:oauth_token) { |value| R10K::Git.settings[:oauth_token] = value }
       end
     end
 

data/lib/r10k/module.rb

@@ -17,7 +17,7 @@ module R10K::Module
   #
   # @param [String] name The unique name of the module
   # @param [String] basedir The root to install the module in
-  # @param [Object] args An arbitary value or set of values that specifies the implementation
+  # @param [Hash] args An arbitary Hash that specifies the implementation
   # @param [R10K::Environment] environment Optional environment that this module is a part of
   #
   # @return [Object < R10K::Module] A member of the implementing subclass

data/lib/r10k/module/base.rb

@@ -51,7 +51,11 @@ class R10K::Module::Base
     @owner, @name = parse_title(@title)
     @path = Pathname.new(File.join(@dirname, @name))
     @environment = environment
+    @overrides = args.delete(:overrides) || {}
     @origin = 'external' # Expect Puppetfile or R10k::Environment to set this to a specific value
+
+    @requested_modules = @overrides.dig(:modules, :requested_modules) || []
+    @should_sync = (@requested_modules.empty? || @requested_modules.include?(@name))
   end
 
   # @deprecated
@@ -61,11 +65,22 @@ class R10K::Module::Base
   end
 
   # Synchronize this module with the indicated state.
-  # @abstract
+  # @param [Hash] opts Deprecated
   def sync(opts={})
     raise NotImplementedError
   end
 
+  def should_sync?
+    if @should_sync
+      logger.info _("Deploying module to %{path}") % {path: path}
+      true
+    else
+      logger.debug1(_("Only updating modules %{modules}, skipping module %{name}") % {modules: @requested_modules.inspect, name: name})
+      false
+    end
+  end
+
+
   # Return the desired version of this module
   # @abstract
   def version
@@ -87,6 +102,7 @@ class R10K::Module::Base
     raise NotImplementedError
   end
 
+  # Deprecated
   def accept(visitor)
     visitor.visit(:module, self)
   end