puppet 7.34.0 → 8.0.1

data/spec/unit/module_tool/application_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'puppet/module_tool'
+
+describe Puppet::ModuleTool::Applications::Application do
+  describe 'app' do
+
+    good_versions = %w{ 1.2.4 0.0.1 0.0.0 0.0.2-git-8-g3d316d1 0.0.3-b1 10.100.10000
+                         0.1.2-rc1 0.1.2-dev-1 0.1.2-svn12345 0.1.2-3 }
+    bad_versions = %w{ 0.1 0 0.1.2.3 dev 0.1.2beta }
+
+    let :app do Class.new(described_class).new end
+
+    good_versions.each do |ver|
+      it "should accept version string #{ver}" do
+        app.parse_filename("puppetlabs-ntp-#{ver}")
+      end
+    end
+
+    bad_versions.each do |ver|
+      it "should not accept version string #{ver}" do
+        expect { app.parse_filename("puppetlabs-ntp-#{ver}") }.to raise_error(ArgumentError, /(Invalid version format|Could not parse filename)/)
+      end
+    end
+  end
+end

data/spec/unit/module_tool/applications/checksummer_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+require 'puppet/module_tool/applications'
+require 'puppet_spec/files'
+require 'pathname'
+
+describe Puppet::ModuleTool::Applications::Checksummer do
+  let(:tmpdir) do
+    Pathname.new(PuppetSpec::Files.tmpdir('checksummer'))
+  end
+
+  let(:checksums) { Puppet::ModuleTool::Checksums.new(tmpdir).data }
+
+  subject do
+    described_class.run(tmpdir)
+  end
+
+  before do
+    File.open(tmpdir + 'README', 'w') { |f| f.puts "This is a README!" }
+    File.open(tmpdir + 'CHANGES', 'w') { |f| f.puts "This is a changelog!" }
+    File.open(tmpdir + 'DELETEME', 'w') { |f| f.puts "I've got a really good feeling about this!" }
+    Dir.mkdir(tmpdir + 'pkg')
+    File.open(tmpdir + 'pkg' + 'build-artifact', 'w') { |f| f.puts "I'm unimportant!" }
+    File.open(tmpdir + 'metadata.json', 'w') { |f| f.puts '{"name": "package-name", "version": "1.0.0"}' }
+    File.open(tmpdir + 'checksums.json', 'w') { |f| f.puts '{}' }
+  end
+
+  context 'with checksums.json' do
+    before do
+      File.open(tmpdir + 'checksums.json', 'w') { |f| f.puts checksums.to_json }
+      File.open(tmpdir + 'CHANGES', 'w') { |f| f.puts "This is a changed log!" }
+      File.open(tmpdir + 'pkg' + 'build-artifact', 'w') { |f| f.puts "I'm still unimportant!" }
+      (tmpdir + 'DELETEME').unlink
+    end
+
+    it 'reports changed files' do
+      expect(subject).to include 'CHANGES'
+    end
+
+    it 'reports removed files' do
+      expect(subject).to include 'DELETEME'
+    end
+
+    it 'does not report unchanged files' do
+      expect(subject).to_not include 'README'
+    end
+
+    it 'does not report build artifacts' do
+      expect(subject).to_not include 'pkg/build-artifact'
+    end
+
+    it 'does not report checksums.json' do
+      expect(subject).to_not include 'checksums.json'
+    end
+  end
+
+  context 'without checksums.json' do
+    context 'but with metadata.json containing checksums' do
+      before do
+        (tmpdir + 'checksums.json').unlink
+        File.open(tmpdir + 'metadata.json', 'w') { |f| f.puts "{\"checksums\":#{checksums.to_json}}" }
+        File.open(tmpdir + 'CHANGES', 'w') { |f| f.puts "This is a changed log!" }
+        File.open(tmpdir + 'pkg' + 'build-artifact', 'w') { |f| f.puts "I'm still unimportant!" }
+        (tmpdir + 'DELETEME').unlink
+      end
+
+      it 'reports changed files' do
+        expect(subject).to include 'CHANGES'
+      end
+
+      it 'reports removed files' do
+        expect(subject).to include 'DELETEME'
+      end
+
+      it 'does not report unchanged files' do
+        expect(subject).to_not include 'README'
+      end
+
+      it 'does not report build artifacts' do
+        expect(subject).to_not include 'pkg/build-artifact'
+      end
+
+      it 'does not report checksums.json' do
+        expect(subject).to_not include 'checksums.json'
+      end
+    end
+
+    context 'and with metadata.json that does not contain checksums' do
+      before do
+        (tmpdir + 'checksums.json').unlink
+        File.open(tmpdir + 'CHANGES', 'w') { |f| f.puts "This is a changed log!" }
+        File.open(tmpdir + 'pkg' + 'build-artifact', 'w') { |f| f.puts "I'm still unimportant!" }
+        (tmpdir + 'DELETEME').unlink
+      end
+
+      it 'fails' do
+        expect { subject }.to raise_error(ArgumentError, 'No file containing checksums found.')
+      end
+    end
+
+    context 'and without metadata.json' do
+      before do
+        (tmpdir + 'checksums.json').unlink
+        (tmpdir + 'metadata.json').unlink
+
+        File.open(tmpdir + 'CHANGES', 'w') { |f| f.puts "This is a changed log!" }
+        File.open(tmpdir + 'pkg' + 'build-artifact', 'w') { |f| f.puts "I'm still unimportant!" }
+        (tmpdir + 'DELETEME').unlink
+      end
+
+      it 'fails' do
+        expect { subject }.to raise_error(ArgumentError, 'No file containing checksums found.')
+      end
+    end
+  end
+end

data/spec/unit/module_tool/applications/installer_spec.rb

@@ -0,0 +1,473 @@
+require 'spec_helper'
+require 'puppet/module_tool/applications'
+require 'puppet_spec/module_tool/shared_functions'
+require 'puppet_spec/module_tool/stub_source'
+
+require 'tmpdir'
+
+describe Puppet::ModuleTool::Applications::Installer, :unless => RUBY_PLATFORM == 'java' do
+  include PuppetSpec::ModuleTool::SharedFunctions
+  include PuppetSpec::Files
+  include PuppetSpec::Fixtures
+
+  before do
+    FileUtils.mkdir_p(primary_dir)
+    FileUtils.mkdir_p(secondary_dir)
+  end
+
+  let(:vardir)        { tmpdir('installer') }
+  let(:primary_dir)   { File.join(vardir, "primary") }
+  let(:secondary_dir) { File.join(vardir, "secondary") }
+  let(:remote_source) { PuppetSpec::ModuleTool::StubSource.new }
+
+  let(:install_dir) do
+    dir = double("Puppet::ModuleTool::InstallDirectory")
+    allow(dir).to receive(:prepare)
+    allow(dir).to receive(:target).and_return(primary_dir)
+    dir
+  end
+
+  before do
+    SemanticPuppet::Dependency.clear_sources
+    allow_any_instance_of(Puppet::ModuleTool::Applications::Installer).to receive(:module_repository).and_return(remote_source)
+  end
+
+  if Puppet::Util::Platform.windows?
+    before :each do
+      Puppet[:module_working_dir] = tmpdir('module_tool_install').gsub('/', '\\')
+    end
+  end
+
+  def installer(modname, target_dir, options)
+    Puppet::ModuleTool.set_option_defaults(options)
+    Puppet::ModuleTool::Applications::Installer.new(modname, target_dir, options)
+  end
+
+  let(:environment) do
+    Puppet.lookup(:current_environment).override_with(
+      :vardir     => vardir,
+      :modulepath => [ primary_dir, secondary_dir ]
+    )
+  end
+
+  context '#run' do
+    let(:module) { 'pmtacceptance-stdlib' }
+
+    def options
+      { :environment => environment }
+    end
+
+    let(:application) { installer(self.module, install_dir, options) }
+    subject { application.run }
+
+    it 'installs the specified module' do
+      expect(subject).to include :result => :success
+      graph_should_include 'pmtacceptance-stdlib', nil => v('4.1.0')
+    end
+
+    it 'reports a meaningful error if the name is invalid' do
+      app = installer('ntp', install_dir, options)
+      results = app.run
+      expect(results).to include :result => :failure
+      expect(results[:error][:oneline]).to eq("Could not install 'ntp', did you mean 'puppetlabs-ntp'?")
+      expect(results[:error][:multiline]).to eq(<<~END.chomp)
+        Could not install module 'ntp'
+          The name 'ntp' is invalid
+            Did you mean `puppet module install puppetlabs-ntp`?
+      END
+    end
+
+    context 'with a tarball file' do
+      let(:module) { fixtures('stdlib.tgz') }
+
+      it 'installs the specified tarball' do
+        expect(subject).to include :result => :success
+        graph_should_include 'puppetlabs-stdlib', nil => v('3.2.0')
+      end
+
+      context 'with --ignore-dependencies' do
+        def options
+          super.merge(:ignore_dependencies => true)
+        end
+
+        it 'installs the specified tarball' do
+          expect(remote_source).not_to receive(:fetch)
+          expect(subject).to include :result => :success
+          graph_should_include 'puppetlabs-stdlib', nil => v('3.2.0')
+        end
+      end
+
+      context 'with dependencies' do
+        let(:module) { fixtures('java.tgz') }
+
+        it 'installs the specified tarball' do
+          expect(subject).to include :result => :success
+          graph_should_include 'puppetlabs-java', nil => v('1.0.0')
+          graph_should_include 'puppetlabs-stdlib', nil => v('4.1.0')
+        end
+
+        context 'with --ignore-dependencies' do
+          def options
+            super.merge(:ignore_dependencies => true)
+          end
+
+          it 'installs the specified tarball without dependencies' do
+            expect(remote_source).not_to receive(:fetch)
+            expect(subject).to include :result => :success
+            graph_should_include 'puppetlabs-java', nil => v('1.0.0')
+            graph_should_include 'puppetlabs-stdlib', nil
+          end
+        end
+      end
+    end
+
+    context 'with dependencies' do
+      let(:module) { 'pmtacceptance-apache' }
+
+      it 'installs the specified module and its dependencies' do
+        expect(subject).to include :result => :success
+        graph_should_include 'pmtacceptance-apache', nil => v('0.10.0')
+        graph_should_include 'pmtacceptance-stdlib', nil => v('4.1.0')
+      end
+
+      context 'and using --ignore_dependencies' do
+        def options
+          super.merge(:ignore_dependencies => true)
+        end
+
+        it 'installs only the specified module' do
+          expect(subject).to include :result => :success
+          graph_should_include 'pmtacceptance-apache', nil => v('0.10.0')
+          graph_should_include 'pmtacceptance-stdlib', nil
+        end
+      end
+
+      context 'that are already installed' do
+        context 'and satisfied' do
+          before { preinstall('pmtacceptance-stdlib', '4.1.0') }
+
+          it 'installs only the specified module' do
+            expect(subject).to include :result => :success
+            graph_should_include 'pmtacceptance-apache', nil => v('0.10.0')
+            graph_should_include 'pmtacceptance-stdlib', :path => primary_dir
+          end
+
+          context '(outdated but suitable version)' do
+            before { preinstall('pmtacceptance-stdlib', '2.4.0') }
+
+            it 'installs only the specified module' do
+              expect(subject).to include :result => :success
+              graph_should_include 'pmtacceptance-apache', nil => v('0.10.0')
+              graph_should_include 'pmtacceptance-stdlib', v('2.4.0') => v('2.4.0'), :path => primary_dir
+            end
+          end
+
+          context '(outdated and unsuitable version)' do
+            before { preinstall('pmtacceptance-stdlib', '1.0.0') }
+
+            it 'installs a version that is compatible with the installed dependencies' do
+              expect(subject).to include :result => :success
+              graph_should_include 'pmtacceptance-apache', nil => v('0.0.4')
+              graph_should_include 'pmtacceptance-stdlib', nil
+            end
+          end
+        end
+
+        context 'but not satisfied' do
+          let(:module) { 'pmtacceptance-keystone' }
+
+          def options
+            super.merge(:version => '2.0.0')
+          end
+
+          before { preinstall('pmtacceptance-mysql', '2.1.0') }
+
+          it 'installs only the specified module' do
+            expect(subject).to include :result => :success
+            graph_should_include 'pmtacceptance-keystone', nil => v('2.0.0')
+            graph_should_include 'pmtacceptance-mysql', v('2.1.0') => v('2.1.0')
+            graph_should_include 'pmtacceptance-stdlib', nil
+          end
+        end
+      end
+
+      context 'that are already installed in other modulepath directories' do
+        before { preinstall('pmtacceptance-stdlib', '1.0.0', :into => secondary_dir) }
+        let(:module) { 'pmtacceptance-apache' }
+
+        context 'without dependency updates' do
+          it 'installs the module only' do
+            expect(subject).to include :result => :success
+            graph_should_include 'pmtacceptance-apache', nil => v('0.0.4')
+            graph_should_include 'pmtacceptance-stdlib', nil
+          end
+        end
+
+        context 'with dependency updates' do
+          before { preinstall('pmtacceptance-stdlib', '2.0.0', :into => secondary_dir) }
+
+          it 'installs the module and upgrades dependencies in-place' do
+            expect(subject).to include :result => :success
+            graph_should_include 'pmtacceptance-apache', nil => v('0.10.0')
+            graph_should_include 'pmtacceptance-stdlib', v('2.0.0') => v('2.6.0'), :path => secondary_dir
+          end
+        end
+      end
+    end
+
+    context 'with a specified' do
+
+      context 'version' do
+        def options
+          super.merge(:version => '3.0.0')
+        end
+
+        it 'installs the specified release (or a prerelease thereof)' do
+          expect(subject).to include :result => :success
+          graph_should_include 'pmtacceptance-stdlib', nil => v('3.0.0')
+        end
+      end
+
+      context 'version range' do
+        def options
+          super.merge(:version => '3.x')
+        end
+
+        it 'installs the greatest available version matching that range' do
+          expect(subject).to include :result => :success
+          graph_should_include 'pmtacceptance-stdlib', nil => v('3.2.0')
+        end
+      end
+    end
+
+    context 'when depended upon' do
+      before { preinstall('pmtacceptance-keystone', '2.1.0') }
+      let(:module)  { 'pmtacceptance-mysql' }
+
+      it 'installs the greatest available version meeting the dependency constraints' do
+        expect(subject).to include :result => :success
+        graph_should_include 'pmtacceptance-mysql', nil => v('0.9.0')
+      end
+
+      context 'with a --version that can satisfy' do
+        def options
+          super.merge(:version => '0.8.0')
+        end
+
+        it 'installs the greatest available version satisfying both constraints' do
+          expect(subject).to include :result => :success
+          graph_should_include 'pmtacceptance-mysql', nil => v('0.8.0')
+        end
+
+        context 'with an already installed dependency' do
+          before { preinstall('pmtacceptance-stdlib', '2.6.0') }
+
+          def options
+            super.merge(:version => '0.7.0')
+          end
+
+          it 'installs given version without errors and does not change version of dependency' do
+            expect(subject).to include :result => :success
+            graph_should_include 'pmtacceptance-mysql', nil => v('0.7.0')
+            expect(subject[:error]).to be_nil
+            graph_should_include 'pmtacceptance-stdlib', v('2.6.0') => v('2.6.0')
+          end
+        end
+      end
+
+      context 'with a --version that cannot satisfy' do
+        def options
+          super.merge(:version => '> 1.0.0')
+        end
+
+        it 'fails to install, since there is no version that can satisfy both constraints' do
+          expect(subject).to include :result => :failure
+        end
+
+        context 'with unsatisfiable dependencies' do
+          let(:graph) { double(SemanticPuppet::Dependency::Graph, :modules => ['pmtacceptance-mysql']) }
+          let(:exception) { SemanticPuppet::Dependency::UnsatisfiableGraph.new(graph, constraint) }
+
+          before do
+            allow(SemanticPuppet::Dependency).to receive(:resolve).and_raise(exception)
+          end
+
+          context 'with known constraint' do
+            let(:constraint) { 'pmtacceptance-mysql' }
+
+            it 'prints a detailed error containing the modules that would not be satisfied' do
+              expect(subject[:error]).to include(:multiline)
+              expect(subject[:error][:multiline]).to include("Could not install module 'pmtacceptance-mysql' (> 1.0.0)")
+              expect(subject[:error][:multiline]).to include("The requested version cannot satisfy one or more of the following installed modules:")
+              expect(subject[:error][:multiline]).to include("pmtacceptance-keystone, expects 'pmtacceptance-mysql': >=0.6.1 <1.0.0")
+              expect(subject[:error][:multiline]).to include("Use `puppet module install 'pmtacceptance-mysql' --ignore-dependencies` to install only this module")
+            end
+          end
+
+          context 'with missing constraint' do
+            let(:constraint) { nil }
+
+            it 'prints the generic error message' do
+              expect(subject[:error]).to include(:multiline)
+              expect(subject[:error][:multiline]).to include("Could not install module 'pmtacceptance-mysql' (> 1.0.0)")
+              expect(subject[:error][:multiline]).to include("The requested version cannot satisfy all dependencies")
+            end
+          end
+
+          context 'with unknown constraint' do
+            let(:constraint) { 'another' }
+
+            it 'prints the generic error message' do
+              expect(subject[:error]).to include(:multiline)
+              expect(subject[:error][:multiline]).to include("Could not install module 'pmtacceptance-mysql' (> 1.0.0)")
+              expect(subject[:error][:multiline]).to include("The requested version cannot satisfy all dependencies")
+            end
+          end
+        end
+
+        context 'with --ignore-dependencies' do
+          def options
+            super.merge(:ignore_dependencies => true)
+          end
+
+          it 'fails to install, since ignore_dependencies should still respect dependencies from installed modules' do
+            expect(subject).to include :result => :failure
+          end
+        end
+
+        context 'with --force' do
+          def options
+            super.merge(:force => true)
+          end
+
+          it 'installs the greatest available version, ignoring dependencies' do
+            expect(subject).to include :result => :success
+            graph_should_include 'pmtacceptance-mysql', nil => v('2.1.0')
+          end
+        end
+
+        context 'with an already installed dependency' do
+          let(:graph) {
+            double(SemanticPuppet::Dependency::Graph,
+              :dependencies => {
+                'pmtacceptance-mysql' => {
+                  :version => '2.1.0'
+                }
+              },
+              :modules => ['pmtacceptance-mysql'],
+              :unsatisfied => 'pmtacceptance-stdlib'
+            )
+          }
+
+          let(:unsatisfiable_graph_exception) { SemanticPuppet::Dependency::UnsatisfiableGraph.new(graph) }
+
+          before do
+            allow(SemanticPuppet::Dependency).to receive(:resolve).and_raise(unsatisfiable_graph_exception)
+            allow(unsatisfiable_graph_exception).to receive(:respond_to?).and_return(true)
+            allow(unsatisfiable_graph_exception).to receive(:unsatisfied).and_return(graph.unsatisfied)
+
+            preinstall('pmtacceptance-stdlib', '2.6.0')
+          end
+
+          def options
+            super.merge(:version => '2.1.0')
+          end
+
+          it 'fails to install and outputs a multiline error containing the versions, expectations and workaround' do
+            expect(subject).to include :result => :failure
+            expect(subject[:error]).to include(:multiline)
+            expect(subject[:error][:multiline]).to include("Could not install module 'pmtacceptance-mysql' (v2.1.0)")
+            expect(subject[:error][:multiline]).to include("The requested version cannot satisfy one or more of the following installed modules:")
+            expect(subject[:error][:multiline]).to include("pmtacceptance-stdlib, installed: 2.6.0, expected: >= 2.2.1")
+            expect(subject[:error][:multiline]).to include("Use `puppet module install 'pmtacceptance-mysql' --ignore-dependencies` to install only this module")
+          end
+        end
+      end
+    end
+
+    context 'when already installed' do
+      before { preinstall('pmtacceptance-stdlib', '1.0.0') }
+
+      context 'but matching the requested version' do
+        it 'does nothing, since the installed version satisfies' do
+          expect(subject).to include :result => :noop
+        end
+
+        context 'with --force' do
+          def options
+            super.merge(:force => true)
+          end
+
+          it 'does reinstall the module' do
+            expect(subject).to include :result => :success
+            graph_should_include 'pmtacceptance-stdlib', v('1.0.0') => v('4.1.0')
+          end
+        end
+
+        context 'with local changes' do
+          before do
+            release = application.send(:installed_modules)['pmtacceptance-stdlib']
+            mark_changed(release.mod.path)
+          end
+
+          it 'does nothing, since local changes do not affect that' do
+            expect(subject).to include :result => :noop
+          end
+
+          context 'with --force' do
+            def options
+              super.merge(:force => true)
+            end
+
+            it 'does reinstall the module, since --force ignores local changes' do
+              expect(subject).to include :result => :success
+              graph_should_include 'pmtacceptance-stdlib', v('1.0.0') => v('4.1.0')
+            end
+          end
+        end
+      end
+
+      context 'but not matching the requested version' do
+        def options
+          super.merge(:version => '2.x')
+        end
+
+        it 'fails to install the module, since it is already installed' do
+          expect(subject).to include :result => :failure
+          expect(subject[:error]).to include :oneline => "'pmtacceptance-stdlib' (v2.x) requested; 'pmtacceptance-stdlib' (v1.0.0) already installed"
+        end
+
+        context 'with --force' do
+          def options
+            super.merge(:force => true)
+          end
+
+          it 'installs the greatest version matching the new version range' do
+            expect(subject).to include :result => :success
+            graph_should_include 'pmtacceptance-stdlib', v('1.0.0') => v('2.6.0')
+          end
+        end
+      end
+    end
+
+    context 'when a module with the same name is already installed' do
+      let(:module) { 'pmtacceptance-stdlib' }
+      before { preinstall('puppetlabs-stdlib', '4.1.0') }
+
+      it 'fails to install, since two modules with the same name cannot be installed simultaneously' do
+        expect(subject).to include :result => :failure
+      end
+
+      context 'using --force' do
+        def options
+          super.merge(:force => true)
+        end
+
+        it 'overwrites the existing module with the greatest version of the requested module' do
+          expect(subject).to include :result => :success
+          graph_should_include 'pmtacceptance-stdlib', nil => v('4.1.0')
+        end
+      end
+    end
+  end
+end