r10k 3.7.0 → 3.8.0

data/lib/r10k/puppetfile.rb

@@ -42,11 +42,6 @@ class Puppetfile
   #   @return [Boolean] Overwrite any locally made changes
   attr_accessor :force
 
-  # @!attribute [r] modules_by_vcs_cachedir
-  #   @api private Only exposed for testing purposes
-  #   @return [Hash{:none, String => Array<R10K::Module>}]
-  attr_reader :modules_by_vcs_cachedir
-
   # @param [String] basedir
   # @param [String] moduledir The directory to install the modules, default to #{basedir}/modules
   # @param [String] puppetfile_path The path to the Puppetfile, default to #{basedir}/Puppetfile
@@ -63,7 +58,6 @@ class Puppetfile
 
     @modules = []
     @managed_content = {}
-    @modules_by_vcs_cachedir = {}
     @forge   = 'forgeapi.puppetlabs.com'
 
     @loaded = false
@@ -83,7 +77,7 @@ class Puppetfile
 
     dsl = R10K::Puppetfile::DSL.new(self)
     dsl.instance_eval(puppetfile_contents, @puppetfile_path)
-    
+
     validate_no_duplicate_names(@modules)
     @loaded = true
   rescue SyntaxError, LoadError, ArgumentError, NameError => e
@@ -133,19 +127,23 @@ class Puppetfile
     end
 
     if args.is_a?(Hash) && @default_branch_override != nil
-      args[:default_branch] = @default_branch_override
+      args[:default_branch_override] = @default_branch_override
     end
 
-    # Keep track of all the content this Puppetfile is managing to enable purging.
-    @managed_content[install_path] = Array.new unless @managed_content.has_key?(install_path)
-
     mod = R10K::Module.new(name, install_path, args, @environment)
-    mod.origin = 'Puppetfile'
+    mod.origin = :puppetfile
 
+    # Do not load modules if they would conflict with the attached
+    # environment
+    if environment && environment.module_conflicts?(mod)
+      mod = nil
+      return @modules
+    end
+
+    # Keep track of all the content this Puppetfile is managing to enable purging.
+    @managed_content[install_path] = Array.new unless @managed_content.has_key?(install_path)
     @managed_content[install_path] << mod.name
-    cachedir = mod.cachedir
-    @modules_by_vcs_cachedir[cachedir] ||= []
-    @modules_by_vcs_cachedir[cachedir] << mod
+
     @modules << mod
   end
 
@@ -223,7 +221,7 @@ class Puppetfile
   def modules_queue(visitor)
     Queue.new.tap do |queue|
       visitor.visit(:puppetfile, self) do
-        modules_by_cachedir = modules_by_vcs_cachedir.clone
+        modules_by_cachedir = modules.group_by { |mod| mod.cachedir }
         modules_without_vcs_cachedir = modules_by_cachedir.delete(:none) || []
 
         modules_without_vcs_cachedir.each {|mod| queue << Array(mod) }

data/lib/r10k/settings.rb

@@ -37,6 +37,11 @@ module R10K
                     Only used by the 'rugged' Git provider.",
         }),
 
+        Definition.new(:oauth_token, {
+          :desc => "The path to a token file for Git OAuth remotes.
+                    Only used by the 'rugged' Git provider."
+        }),
+
         URIDefinition.new(:proxy, {
           :desc => "An optional proxy server to use when interacting with Git sources via HTTP(S).",
           :default => :inherit,
@@ -54,11 +59,17 @@ module R10K
               :default => :inherit,
             }),
 
+            Definition.new(:oauth_token, {
+              :desc => "The path to a token file for Git OAuth remotes.
+                        Only used by the 'rugged' Git provider.",
+              :default => :inherit
+            }),
+
             URIDefinition.new(:proxy, {
               :desc => "An optional proxy server to use when interacting with Git sources via HTTP(S).",
               :default => :inherit,
             }),
-            
+
             Definition.new(:ignore_branch_prefixes, {
               :desc => "Array of strings used to prefix branch names that will not be deployed as environments.",
             }),

data/lib/r10k/version.rb

@@ -2,5 +2,5 @@ module R10K
   # When updating to a new major (X) or minor (Y) version, include `#major` or
   # `#minor` (respectively) in your commit message to trigger the appropriate
   # release. Otherwise, a new patch (Z) version will be released.
-  VERSION = '3.7.0'
+  VERSION = '3.8.0'
 end

data/locales/r10k.pot

@@ -1,16 +1,16 @@
 # SOME DESCRIPTIVE TITLE.
-# Copyright (C) 2020 Puppet, Inc.
+# Copyright (C) 2021 Puppet, Inc.
 # This file is distributed under the same license as the r10k package.
-# FIRST AUTHOR <EMAIL@ADDRESS>, 2020.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2021.
 #
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: r10k 3.4.1-57-g2eb088a\n"
+"Project-Id-Version: r10k 3.4.1-133-g2007a86\n"
 "\n"
 "Report-Msgid-Bugs-To: docs@puppetlabs.com\n"
-"POT-Creation-Date: 2020-07-22 16:41+0000\n"
-"PO-Revision-Date: 2020-07-22 16:41+0000\n"
+"POT-Creation-Date: 2021-02-12 02:00+0000\n"
+"PO-Revision-Date: 2021-02-12 02:00+0000\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
 "Language: \n"
@@ -83,15 +83,15 @@ msgstr ""
 msgid "Cannot track control repo branch for content '%{name}' when not part of a 'deploy' action, will use default if available."
 msgstr ""
 
-#: ../lib/r10k/action/runner.rb:53 ../lib/r10k/deployment/config.rb:42
+#: ../lib/r10k/action/runner.rb:54 ../lib/r10k/deployment/config.rb:42
 msgid "Overriding config file setting '%{key}': '%{old_val}' -> '%{new_val}'"
 msgstr ""
 
-#: ../lib/r10k/action/runner.rb:86
+#: ../lib/r10k/action/runner.rb:91
 msgid "Reading configuration from %{config_path}"
 msgstr ""
 
-#: ../lib/r10k/action/runner.rb:89
+#: ../lib/r10k/action/runner.rb:94
 msgid "No config file explicitly given and no default config file could be found, default settings will be used."
 msgstr ""
 
@@ -107,12 +107,16 @@ msgstr ""
 msgid "%{class} has not implemented method %{method}"
 msgstr ""
 
-#: ../lib/r10k/environment/with_modules.rb:104
-msgid "Puppetfile cannot contain module names defined by environment %{name}"
+#: ../lib/r10k/environment/with_modules.rb:60
+msgid "Environment and %{src} both define the \"%{name}\" module"
 msgstr ""
 
-#: ../lib/r10k/environment/with_modules.rb:106
-msgid "Remove the conflicting definitions of the following modules: %{conflicts}"
+#: ../lib/r10k/environment/with_modules.rb:61
+msgid "#{msg_error}. The %{src} definition will be ignored"
+msgstr ""
+
+#: ../lib/r10k/environment/with_modules.rb:71
+msgid "Unexpected value for `module_conflicts` setting in %{env} environment: %{val}"
 msgstr ""
 
 #: ../lib/r10k/feature.rb:27
@@ -187,11 +191,11 @@ msgstr ""
 msgid "Cannot write %{file}; parent directory does not exist"
 msgstr ""
 
-#: ../lib/r10k/git/cache.rb:55
+#: ../lib/r10k/git/cache.rb:65
 msgid "%{class}#path is deprecated; use #git_dir"
 msgstr ""
 
-#: ../lib/r10k/git/cache.rb:84
+#: ../lib/r10k/git/cache.rb:94
 msgid "Creating new git cache for %{remote}"
 msgstr ""
 
@@ -227,15 +231,31 @@ msgstr ""
 msgid "Unable to use SSH key auth for %{url}: private key %{private_key} is missing or unreadable"
 msgstr ""
 
-#: ../lib/r10k/git/rugged/credentials.rb:80
+#: ../lib/r10k/git/rugged/credentials.rb:72
+msgid "Using OAuth token from stdin for URL %{url}"
+msgstr ""
+
+#: ../lib/r10k/git/rugged/credentials.rb:75
+msgid "Using OAuth token from %{token_path} for URL %{url}"
+msgstr ""
+
+#: ../lib/r10k/git/rugged/credentials.rb:77
+msgid "%{path} is missing or unreadable, cannot load OAuth token"
+msgstr ""
+
+#: ../lib/r10k/git/rugged/credentials.rb:81
+msgid "Supplied OAuth token contains invalid characters."
+msgstr ""
+
+#: ../lib/r10k/git/rugged/credentials.rb:110
 msgid "URL %{url} includes the username %{username}, using that user for authentication."
 msgstr ""
 
-#: ../lib/r10k/git/rugged/credentials.rb:83
+#: ../lib/r10k/git/rugged/credentials.rb:113
 msgid "URL %{url} did not specify a user, using %{user} from configuration"
 msgstr ""
 
-#: ../lib/r10k/git/rugged/credentials.rb:86
+#: ../lib/r10k/git/rugged/credentials.rb:116
 msgid "URL %{url} did not specify a user, using current user %{user}"
 msgstr ""
 
@@ -255,31 +275,31 @@ msgstr ""
 msgid "Found local modifications in %{file_path}"
 msgstr ""
 
-#: ../lib/r10k/git/stateful_repository.rb:40
+#: ../lib/r10k/git/stateful_repository.rb:44
 msgid "Unable to sync repo to unresolvable ref '%{ref}'"
 msgstr ""
 
-#: ../lib/r10k/git/stateful_repository.rb:47
+#: ../lib/r10k/git/stateful_repository.rb:51
 msgid "Cloning %{repo_path} and checking out %{ref}"
 msgstr ""
 
-#: ../lib/r10k/git/stateful_repository.rb:50
+#: ../lib/r10k/git/stateful_repository.rb:54
 msgid "Replacing %{repo_path} and checking out %{ref}"
 msgstr ""
 
-#: ../lib/r10k/git/stateful_repository.rb:54 ../lib/r10k/git/stateful_repository.rb:59
+#: ../lib/r10k/git/stateful_repository.rb:58 ../lib/r10k/git/stateful_repository.rb:63
 msgid "Updating %{repo_path} to %{ref}"
 msgstr ""
 
-#: ../lib/r10k/git/stateful_repository.rb:58
+#: ../lib/r10k/git/stateful_repository.rb:62
 msgid "Overwriting local modifications to %{repo_path}"
 msgstr ""
 
-#: ../lib/r10k/git/stateful_repository.rb:62
+#: ../lib/r10k/git/stateful_repository.rb:66
 msgid "Skipping %{repo_path} due to local modifications"
 msgstr ""
 
-#: ../lib/r10k/git/stateful_repository.rb:65
+#: ../lib/r10k/git/stateful_repository.rb:69
 msgid "%{repo_path} is already at Git ref %{ref}"
 msgstr ""
 
@@ -303,7 +323,7 @@ msgstr ""
 msgid "Module %{name} with args %{args} doesn't have an implementation. (Are you using the right arguments?)"
 msgstr ""
 
-#: ../lib/r10k/module/base.rb:110
+#: ../lib/r10k/module/base.rb:118
 msgid "Module name (%{title}) must match either 'modulename' or 'owner/modulename'"
 msgstr ""
 
@@ -312,10 +332,10 @@ msgid "The module %{title} does not exist on %{url}."
 msgstr ""
 
 #: ../lib/r10k/module/forge.rb:174
-msgid "Forge module names must match 'owner/modulename'"
+msgid "Forge module names must match 'owner/modulename', instead got #{title}"
 msgstr ""
 
-#: ../lib/r10k/module/git.rb:97
+#: ../lib/r10k/module/git.rb:113
 msgid "Unhandled options %{unhandled} specified for %{class}"
 msgstr ""
 
@@ -347,19 +367,19 @@ msgstr ""
 msgid "Remove the duplicates of the following modules: %{dupes}"
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:192
+#: ../lib/r10k/puppetfile.rb:201
 msgid "Updating modules with %{pool_size} threads"
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:203
+#: ../lib/r10k/puppetfile.rb:212
 msgid "Error during concurrent deploy of a module: %{message}"
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:225
+#: ../lib/r10k/puppetfile.rb:241
 msgid "Module thread %{id} exiting: %{message}"
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:282
+#: ../lib/r10k/puppetfile.rb:300
 msgid "unrecognized declaration '%{method}'"
 msgstr ""
 

data/spec/fixtures/unit/action/r10k_creds.yaml

@@ -0,0 +1,9 @@
+---
+  git:
+    private_key: '/global/config/private/key'
+    oauth_token: '/global/config/oauth/token'
+    repositories:
+      - remote: 'git@myfakegitserver.com:user/repo.git'
+        private_key: '/config/private/key'
+      - remote: 'https://myfakegitserver.com/user/repo.git'
+        oauth_token: '/config/oauth/token'

data/spec/unit/action/deploy/environment_spec.rb

@@ -27,8 +27,6 @@ describe R10K::Action::Deploy::Environment do
       described_class.new({:'no-force' => true}, [])
     end
 
-    it "normalizes environment names in the arg vector"
-
     it 'can accept a generate-types option' do
       described_class.new({ 'generate-types': true }, [])
     end
@@ -36,6 +34,14 @@ describe R10K::Action::Deploy::Environment do
     it 'can accept a puppet-path option' do
       described_class.new({ 'puppet-path': '/nonexistent' }, [])
     end
+
+    it 'can accept a private-key option' do
+      described_class.new({ 'private-key': '/nonexistent' }, [])
+    end
+
+    it 'can accept a token option' do
+      described_class.new({ 'oauth-token': '/nonexistent' }, [])
+    end
   end
 
   describe "when called" do
@@ -162,6 +168,13 @@ describe R10K::Action::Deploy::Environment do
       end
     end
 
+    describe 'extracting credentials' do
+      let(:deployment) do
+        R10K::Deployment.new(mock_config)
+      end
+
+    end
+
     describe "purge_levels" do
       let(:settings) { { deploy: { purge_levels: purge_levels } } }
 
@@ -219,6 +232,7 @@ describe R10K::Action::Deploy::Environment do
         end
       end
     end
+
     describe "generate-types" do
       let(:deployment) do
         R10K::Deployment.new(
@@ -340,6 +354,24 @@ describe R10K::Action::Deploy::Environment do
         expect(subject.instance_variable_get(:@puppet_conf)).to eq('/nonexistent')
       end
     end
+
+    describe 'with private-key' do
+
+      subject { described_class.new({ config: '/some/nonexistent/path', 'private-key': '/nonexistent' }, []) }
+
+      it 'sets private_key' do
+        expect(subject.instance_variable_get(:@private_key)).to eq('/nonexistent')
+      end
+    end
+
+    describe 'with oauth-token' do
+
+      subject { described_class.new({ config: '/some/nonexistent/path', 'oauth-token': '/nonexistent' }, []) }
+
+      it 'sets oauth_token' do
+        expect(subject.instance_variable_get(:@oauth_token)).to eq('/nonexistent')
+      end
+    end
   end
 
   describe "write_environment_info!" do

data/spec/unit/action/deploy/module_spec.rb

@@ -33,6 +33,14 @@ describe R10K::Action::Deploy::Module do
     it 'can accept a cachedir option' do
       described_class.new({ cachedir: '/nonexistent' }, [])
     end
+
+    it 'can accept a private-key option' do
+      described_class.new({ 'private-key': '/nonexistent' }, [])
+    end
+
+    it 'can accept a token option' do
+      described_class.new({ 'oauth-token': '/nonexistent' }, [])
+    end
   end
 
   describe "with no-force" do
@@ -74,8 +82,8 @@ describe R10K::Action::Deploy::Module do
 
       before do
         allow(subject).to receive(:visit_environment).and_wrap_original do |original, environment, &block|
-          expect(environment.puppetfile).to receive(:modules_by_vcs_cachedir).and_return(
-            {none: [R10K::Module::Local.new(environment.name, '/fakedir', [], environment)]}
+          expect(environment.puppetfile).to receive(:modules).and_return(
+            [R10K::Module::Local.new(environment.name, '/fakedir', [], environment)]
           )
           original.call(environment, &block)
         end
@@ -145,8 +153,26 @@ describe R10K::Action::Deploy::Module do
 
     subject { described_class.new({ config: '/some/nonexistent/path', cachedir: '/nonexistent' }, []) }
 
-    it 'sets puppet_path' do
+    it 'sets cachedir' do
       expect(subject.instance_variable_get(:@cachedir)).to eq('/nonexistent')
     end
   end
+
+  describe 'with private-key' do
+
+    subject { described_class.new({ config: '/some/nonexistent/path', 'private-key': '/nonexistent' }, []) }
+
+    it 'sets private_key' do
+      expect(subject.instance_variable_get(:@private_key)).to eq('/nonexistent')
+    end
+  end
+
+  describe 'with oauth-token' do
+
+    subject { described_class.new({ config: '/some/nonexistent/path', 'oauth-token': '/nonexistent' }, []) }
+
+    it 'sets token_path' do
+      expect(subject.instance_variable_get(:@oauth_token)).to eq('/nonexistent')
+    end
+  end
 end

data/spec/unit/action/runner_spec.rb

@@ -10,11 +10,12 @@ describe R10K::Action::Runner do
     Class.new do
       attr_reader :opts
       attr_reader :argv
+      attr_reader :settings
 
       def initialize(opts, argv, settings = {})
         @opts = opts
         @argv = argv
-        @settings = {}
+        @settings = settings
       end
 
       def call
@@ -170,6 +171,52 @@ describe R10K::Action::Runner do
     end
   end
 
+  describe "configuring git credentials" do
+    it 'errors if both token and key paths are passed' do
+      runner = described_class.new({ 'oauth-token': '/nonexistent',
+                                     'private-key': '/also/fake' }, %w[args yes], action_class)
+      expect{ runner.call }.to raise_error(R10K::Error, /Cannot specify both/)
+    end
+
+    it 'saves the sshkey path in settings hash' do
+      runner = described_class.new({ 'private-key': '/my/ssh/key' }, %w[args yes], action_class)
+      runner.call
+      expect(runner.instance.settings[:git][:private_key]).to eq('/my/ssh/key')
+    end
+
+    it 'overrides per-repo sshkey in settings hash' do
+      runner = described_class.new({ config: "spec/fixtures/unit/action/r10k_creds.yaml",
+                                     'private-key': '/my/ssh/key' },
+                                     %w[args yes],
+                                     action_class)
+      runner.call
+      expect(runner.instance.settings[:git][:private_key]).to eq('/my/ssh/key')
+      expect(runner.instance.settings[:git][:repositories].count).to eq(2)
+      runner.instance.settings[:git][:repositories].each do |repo_settings|
+        expect(repo_settings[:private_key]).to eq('/my/ssh/key')
+      end
+    end
+
+    it 'saves the token path in settings hash' do
+      runner = described_class.new({ 'oauth-token': '/my/token/path' }, %w[args yes], action_class)
+      runner.call
+      expect(runner.instance.settings[:git][:oauth_token]).to eq('/my/token/path')
+    end
+
+    it 'overrides per-repo oauth token in settings hash' do
+      runner = described_class.new({ config: "spec/fixtures/unit/action/r10k_creds.yaml",
+                                     'oauth-token': '/my/token' },
+                                     %w[args yes],
+                                     action_class)
+      runner.call
+      expect(runner.instance.settings[:git][:oauth_token]).to eq('/my/token')
+      expect(runner.instance.settings[:git][:repositories].count).to eq(2)
+      runner.instance.settings[:git][:repositories].each do |repo_settings|
+        expect(repo_settings[:oauth_token]).to eq('/my/token')
+      end
+    end
+  end
+
   describe "configuration authorization" do
     context "when license is not present" do
       before(:each) do