puppet 6.14.0-x64-mingw32 → 6.19.0-x64-mingw32

data/spec/integration/application/apply_spec.rb

@@ -1,10 +1,13 @@
 require 'spec_helper'
 require 'puppet_spec/files'
 require 'puppet_spec/compiler'
+require 'puppet_spec/https'
 
-describe "apply" do
+describe "apply", unless: Puppet::Util::Platform.jruby? do
   include PuppetSpec::Files
 
+  let(:apply) { Puppet::Application[:apply] }
+
   before :each do
     Puppet[:reports] = "none"
     # Let exceptions be raised instead of exiting
@@ -18,76 +21,51 @@ describe "apply" do
       resource = Puppet::Resource.new(:file, file_to_create, :parameters => {:content => "my stuff"})
       catalog.add_resource resource
 
-      manifest = file_containing("manifest", catalog.to_json)
-
-      puppet = Puppet::Application[:apply]
-      puppet.options[:catalog] = manifest
-
-      puppet.apply
+      apply.command_line.args = ['--catalog', file_containing("manifest", catalog.to_json)]
+      expect {
+        apply.run
+      }.to output(/ensure: defined content as/).to_stdout
 
       expect(Puppet::FileSystem.exist?(file_to_create)).to be_truthy
       expect(File.read(file_to_create)).to eq("my stuff")
     end
 
-    context 'from environment with a pcore defined resource type' do
-      include PuppetSpec::Compiler
-
-      let!(:envdir) { tmpdir('environments') }
+    context 'and pcore types are available' do
+      let(:envdir) { my_fixture('environments') }
       let(:env_name) { 'spec' }
-      let(:dir_structure) {
-        {
-          '.resource_types' => {
-            'applytest.pp' => <<-CODE
-            Puppet::Resource::ResourceType3.new(
-              'applytest',
-              [Puppet::Resource::Param.new(String, 'message')],
-              [Puppet::Resource::Param.new(String, 'name', true)])
-          CODE
-          },
-          'modules' => {
-            'amod' => {
-              'lib' => {
-                'puppet' => {
-                  'type' => { 'applytest.rb' => <<-CODE
-Puppet::Type.newtype(:applytest) do
-newproperty(:message) do
-  def sync
-    Puppet.send(@resource[:loglevel], self.should)
-  end
-
-  def retrieve
-    :absent
-  end
 
-  def insync?(is)
-    false
-  end
+      before(:each) do
+        Puppet[:environmentpath] = envdir
+        Puppet[:environment] = env_name
+      end
 
-  defaultto { @resource[:name] }
-end
+      it 'does not load the pcore type' do
+        apply = Puppet::Application[:apply]
+        apply.command_line.args = [ '-e', "Applytest { message => 'the default'} applytest { 'applytest was here': }" ]
+
+        expect {
+          apply.run
+        }.to exit_with(0)
+         .and output(a_string_matching(
+           /the Puppet::Type says hello/
+         ).and matching(
+           /applytest was here/
+         )).to_stdout
+      end
+    end
 
-newparam(:name) do
-  desc "An arbitrary tag for your own reference; the name of the message."
-  Puppet.notice('the Puppet::Type says hello')
-  isnamevar
-end
-end
-                  CODE
-                  }
-                }
-              }
-            }
-          }
-        }
-      }
+    context 'from environment with a pcore defined resource type' do
+      include PuppetSpec::Compiler
 
+      let(:envdir) { my_fixture('environments') }
+      let(:env_name) { 'spec' }
       let(:environments) { Puppet::Environments::Directories.new(envdir, []) }
       let(:env) { Puppet::Node::Environment.create(:'spec', [File.join(envdir, 'spec', 'modules')]) }
       let(:node) { Puppet::Node.new('test', :environment => env) }
+
       around(:each) do |example|
         Puppet::Type.rmtype(:applytest)
         Puppet[:environment] = env_name
-        dir_contained_in(envdir, env_name => dir_structure)
         Puppet.override(:environments => environments, :current_environment => env) do
           example.run
         end
@@ -95,12 +73,13 @@ end
 
       it 'does not load the pcore type' do
         catalog = compile_to_catalog('applytest { "applytest was here":}', node)
-        apply = Puppet::Application[:apply]
-        apply.options[:catalog] = file_containing('manifest', catalog.to_json)
+        apply.command_line.args = ['--catalog', file_containing('manifest', catalog.to_json)]
 
         Puppet[:environmentpath] = envdir
         expect_any_instance_of(Puppet::Pops::Loader::Runtime3TypeLoader).not_to receive(:find)
-        expect { apply.run }.to have_printed(/the Puppet::Type says hello.*applytest was here/m)
+        expect {
+          apply.run
+        }.to output(/the Puppet::Type says hello.*applytest was here/m).to_stdout
       end
 
       # Test just to verify that the Pcore Resource Type and not the Ruby one is produced when the catalog is produced
@@ -112,7 +91,9 @@ end
 
         expect(compiler.loaders.runtime3_type_loader.instance_variable_get(:@resource_3x_loader)).to receive(:set_entry).once.with(tn, rt, instance_of(String))
           .and_return(Puppet::Pops::Loader::Loader::NamedEntry.new(tn, rt, nil))
-        expect { compiler.compile }.not_to have_printed(/the Puppet::Type says hello/)
+        expect {
+          compiler.compile
+        }.not_to output(/the Puppet::Type says hello/).to_stdout
       end
 
       it "does not fail when pcore type is loaded twice" do
@@ -225,39 +206,39 @@ end
       catalog = compile_to_catalog('include mod', node)
 
       Puppet[:environment] = env_name
-      apply = Puppet::Application[:apply]
-      apply.options[:catalog] = file_containing('manifest', catalog.to_json)
-      expect { apply.run_command; exit(0) }.to exit_with(0)
-      expect(@logs.map(&:to_s)).to include('The Street 23')
+      apply.command_line.args = ['--catalog', file_containing('manifest', catalog.to_json)]
+
+      expect {
+        apply.run
+      }.to output(%r{Notify\[The Street 23\]/message: defined 'message' as 'The Street 23'}).to_stdout
     end
   end
 
-  it "applies a given file even when a directory environment is specified" do
+  it "raises if the environment directory does not exist" do
     manifest = file_containing("manifest.pp", "notice('it was applied')")
+    apply.command_line.args = [manifest]
 
     special = Puppet::Node::Environment.create(:special, [])
     Puppet.override(:current_environment => special) do
       Puppet[:environment] = 'special'
-      puppet = Puppet::Application[:apply]
-      allow(puppet).to receive(:command_line).and_return(double('command_line', :args => [manifest]))
-      expect { puppet.run_command }.to exit_with(0)
+      expect {
+        apply.run
+      }.to raise_error(Puppet::Environments::EnvironmentNotFound,
+                       /Could not find a directory environment named 'special' anywhere in the path/)
     end
-
-    expect(@logs.map(&:to_s)).to include('it was applied')
   end
 
   it "adds environment to the $server_facts variable" do
     manifest = file_containing("manifest.pp", "notice(\"$server_facts\")")
+    apply.command_line.args = [manifest]
 
-    puppet = Puppet::Application[:apply]
-    allow(puppet).to receive(:command_line).and_return(double('command_line', :args => [manifest]))
-
-    expect { puppet.run_command }.to exit_with(0)
-
-    expect(@logs.map(&:to_s)).to include(/{environment =>.*/)
+    expect {
+      apply.run
+    }.to exit_with(0)
+     .and output(/{environment => production}/).to_stdout
   end
 
-  it "applies a given file even when an ENC is configured", :unless => Puppet::Util::Platform.windows? || RUBY_PLATFORM == 'java' do
+  it "applies a given file even when an ENC is configured", :unless => Puppet::Util::Platform.windows? || Puppet::Util::Platform.jruby? do
     manifest = file_containing("manifest.pp", "notice('specific manifest applied')")
     enc = script_containing('enc_script',
       :windows => '@echo classes: []' + "\n" + '@echo environment: special',
@@ -270,48 +251,36 @@ end
       Puppet[:environment] = 'special'
       Puppet[:node_terminus] = 'exec'
       Puppet[:external_nodes] = enc
-      puppet = Puppet::Application[:apply]
-      allow(puppet).to receive(:command_line).and_return(double('command_line', :args => [manifest]))
-      expect { puppet.run_command }.to exit_with(0)
+      apply.command_line.args = [manifest]
+      expect {
+        apply.run
+      }.to exit_with(0)
+       .and output(/Notice: Scope\(Class\[main\]\): specific manifest applied/).to_stdout
     end
-
-    expect(@logs.map(&:to_s)).to include('specific manifest applied')
   end
 
   context "handles errors" do
     it "logs compile errors once" do
-      Puppet.initialize_settings([])
-      apply = Puppet::Application.find(:apply).new(double('command_line', :subcommand_name => :apply, :args => []))
-      apply.options[:code] = '08'
-
-      msg = 'valid octal'
-      callback = Proc.new do |actual|
-        expect(actual.scan(Regexp.new(msg))).to eq([msg])
-      end
-
-      expect do
+      apply.command_line.args = ['-e', '08']
+      expect {
         apply.run
-      end.to have_printed(callback).and_exit_with(1)
+      }.to exit_with(1)
+       .and output(/Not a valid octal number/).to_stderr
     end
 
     it "logs compile post processing errors once" do
-      Puppet.initialize_settings([])
-      apply = Puppet::Application.find(:apply).new(double('command_line', :subcommand_name => :apply, :args => []))
       path = File.expand_path('/tmp/content_file_test.Q634Dlmtime')
-      apply.options[:code] = "file { '#{path}':
+      apply.command_line.args = ['-e', "file { '#{path}':
         content => 'This is the test file content',
         ensure => present,
         checksum => mtime
-      }"
-
-      msg = 'You cannot specify content when using checksum'
-      callback = Proc.new do |actual|
-        expect(actual.scan(Regexp.new(msg))).to eq([msg])
-      end
+      }"]
 
-      expect do
+      expect {
         apply.run
-      end.to have_printed(callback).and_exit_with(1)
+      }.to exit_with(1)
+       .and output(/Compiled catalog/).to_stdout
+       .and output(/You cannot specify content when using checksum/).to_stderr
     end
   end
 
@@ -336,51 +305,42 @@ end
       Puppet[:environmentpath] = envdir
     end
 
-    def init_cli_args_and_apply_app(args, execute)
-      Puppet.initialize_settings(args)
-      puppet = Puppet::Application.find(:apply).new(double('command_line', :subcommand_name => :apply, :args => args))
-      puppet.options[:code] = execute
-      return puppet
-    end
+    context "given a modulepath" do
+      let(:args) { ['-e', execute] }
 
-    context "given the --modulepath option" do
-      let(:args) { ['-e', execute, '--modulepath', modulepath] }
+      before :each do
+        Puppet[:modulepath] = modulepath
 
-      it "looks in --modulepath even when the default directory environment exists" do
-        apply = init_cli_args_and_apply_app(args, execute)
+        apply.command_line.args = args
+      end
 
-        expect do
-          expect { apply.run }.to exit_with(0)
-        end.to have_printed('amod class included')
+      it "looks in modulepath even when the default directory environment exists" do
+        expect {
+          apply.run
+        }.to exit_with(0)
+         .and output(/amod class included/).to_stdout
       end
 
-      it "looks in --modulepath even when given a specific directory --environment" do
-        args << '--environment' << 'production'
-        apply = init_cli_args_and_apply_app(args, execute)
+      it "looks in modulepath even when given a specific directory --environment" do
+        apply.command_line.args = args << '--environment' << 'production'
 
-        expect do
-          expect { apply.run }.to exit_with(0)
-        end.to have_printed('amod class included')
+        expect {
+          apply.run
+        }.to exit_with(0)
+         .and output(/amod class included/).to_stdout
       end
 
-      it "looks in --modulepath when given multiple paths in --modulepath" do
-        args = ['-e', execute, '--modulepath', [tmpdir('notmodulepath'), modulepath].join(File::PATH_SEPARATOR)]
-        apply = init_cli_args_and_apply_app(args, execute)
+      it "looks in modulepath when given multiple paths in modulepath" do
+        Puppet[:modulepath] = [tmpdir('notmodulepath'), modulepath].join(File::PATH_SEPARATOR)
 
-        expect do
-          expect { apply.run }.to exit_with(0)
-        end.to have_printed('amod class included')
+        expect {
+          apply.run
+        }.to exit_with(0)
+         .and output(/amod class included/).to_stdout
       end
     end
 
-    # When executing an ENC script, output cannot be captured using
-    # expect { }.to have_printed(...)
-    # External node script execution will fail, likely due to the tampering
-    # with the basic file descriptors.
-    # Workaround: Define a log destination and merely inspect logs.
-    context "with an ENC", :unless => RUBY_PLATFORM == 'java' do
-      let(:logdest) { tmpfile('logdest') }
-      let(:args) { ['-e', execute, '--logdest', logdest ] }
+    context "with an ENC" do
       let(:enc) do
         script_containing('enc_script',
           :windows => '@echo environment: spec',
@@ -393,17 +353,23 @@ end
       end
 
       it "should use the environment that the ENC mandates" do
-        apply = init_cli_args_and_apply_app(args, execute)
-        expect { apply.run }.to exit_with(0)
-        expect(@logs.map(&:to_s)).to include('amod class included')
+        apply.command_line.args = ['-e', execute]
+
+        expect {
+          apply.run
+       }.to exit_with(0)
+        .and output(a_string_matching(/amod class included/)
+        .and matching(/Compiled catalog for .* in environment spec/)).to_stdout
       end
 
       it "should prefer the ENC environment over the configured one and emit a warning" do
-        apply = init_cli_args_and_apply_app(args + [ '--environment', 'production' ], execute)
-        expect { apply.run }.to exit_with(0)
-        logs = @logs.map(&:to_s)
-        expect(logs).to include('amod class included')
-        expect(logs).to include(match(/doesn't match server specified environment/))
+        apply.command_line.args = ['-e', execute, '--environment', 'production']
+
+        expect {
+          apply.run
+        }.to exit_with(0)
+         .and output(a_string_matching('amod class included')
+         .and matching(/doesn't match server specified environment/)).to_stdout
       end
     end
   end
@@ -474,8 +440,7 @@ class amod::bad_type {
     context 'and the file is not serialized with rich_data' do
       it 'will notify a string that is the result of Regexp#inspect (from Runtime3xConverter)' do
         catalog = compile_to_catalog(execute, node)
-        apply = Puppet::Application[:apply]
-        apply.options[:catalog] = file_containing('manifest', catalog.to_json)
+        apply.command_line.args = ['--catalog', file_containing('manifest', catalog.to_json)]
         expect(apply).to receive(:apply_catalog) do |cat|
           expect(cat.resource(:notify, 'rx')['message']).to be_a(String)
           expect(cat.resource(:notify, 'bin')['message']).to be_a(String)
@@ -490,8 +455,7 @@ class amod::bad_type {
 
       it 'will notify a string that is the result of to_s on uknown data types' do
         json = compile_to_catalog('include amod::bad_type', node).to_json
-        apply = Puppet::Application[:apply]
-        apply.options[:catalog] = file_containing('manifest', json)
+        apply.command_line.args = ['--catalog', file_containing('manifest', json)]
         expect(apply).to receive(:apply_catalog) do |catalog|
           expect(catalog.resource(:notify, 'bogus')['message']).to be_a(String)
         end
@@ -513,11 +477,10 @@ class amod::bad_type {
     context 'and the file is serialized with rich_data' do
       it 'will notify a regexp using Regexp#to_s' do
         catalog = compile_to_catalog(execute, node)
-        apply = Puppet::Application[:apply]
         serialized_catalog = Puppet.override(rich_data: true) do
           catalog.to_json
         end
-        apply.options[:catalog] = file_containing('manifest', serialized_catalog)
+        apply.command_line.args = ['--catalog', file_containing('manifest', serialized_catalog)]
         expect(apply).to receive(:apply_catalog) do |cat|
           expect(cat.resource(:notify, 'rx')['message']).to be_a(Regexp)
           # The resource return in this expect is a String, but since it was a Binary type that
@@ -534,4 +497,170 @@ class amod::bad_type {
       end
     end
   end
+
+  context 'puppet file sources' do
+    let(:env_name) { 'dev' }
+    let(:env_dir) { File.join(Puppet[:environmentpath], env_name) }
+    let(:env) { Puppet::Node::Environment.create(env_name.to_sym, [File.join(env_dir, 'modules')]) }
+    let(:node) { Puppet::Node.new(Puppet[:certname], environment: environment) }
+
+    before :each do
+      Puppet[:environment] = env_name
+      Puppet::FileSystem.mkpath(env_dir)
+    end
+
+    it "recursively copies a directory from a module" do
+      dir = File.join(env.full_modulepath, 'amod', 'files', 'dir1', 'dir2')
+      Puppet::FileSystem.mkpath(dir)
+      File.write(File.join(dir, 'file'), 'content from the module')
+
+      base_dir = tmpdir('apply_spec_base')
+      manifest = file_containing("manifest.pp", <<-MANIFEST)
+        file { "#{base_dir}/dir1":
+          ensure  => file,
+          source  => "puppet:///modules/amod/dir1",
+          recurse => true,
+        }
+      MANIFEST
+
+      expect {
+        apply.command_line.args << manifest
+        apply.run
+      }.to exit_with(0)
+       .and output(a_string_matching(
+         /dir1\]\/ensure: created/
+      ).and matching(
+         /dir1\/dir2\]\/ensure: created/
+      ).and matching(
+         /dir1\/dir2\/file\]\/ensure: defined content as '{md5}51f37efb13c3a1e486106f90db6490a5'/
+      )).to_stdout
+
+      dest_file = File.join(base_dir, 'dir1', 'dir2', 'file')
+      expect(File.read(dest_file)).to eq("content from the module")
+    end
+  end
+
+  context 'http file sources' do
+    include_context 'https client'
+
+    it "requires the caller to URL encode special characters in the request path and query" do
+      Puppet[:server] = '127.0.0.1'
+      request = nil
+
+      response_proc = -> (req, res) {
+        request = req
+
+        res['Content-Type'] = 'text/plain'
+        res.body = "from the server"
+      }
+
+      https = PuppetSpec::HTTPSServer.new
+      https.start_server(response_proc: response_proc) do |https_port|
+        dest = tmpfile('http_file_source')
+
+        # spaces in path are encoded as %20 and '[' in query is encoded as %5B,
+        # but ':', '=', '-' are not encoded
+        manifest = file_containing("manifest.pp", <<~MANIFEST)
+          file { "#{dest}":
+            ensure  => file,
+            source  => "https://#{Puppet[:server]}:#{https_port}/path%20to%20file?x=b%5Bc&sv=2019-02-02&st=2020-07-28T20:18:53Z&se=2020-07-28T21:03:00Z&sr=b&sp=r&sig=JaZhcqxT4akJcOwUdUGrQB2m1geUoh89iL8WMag8a8c=",
+          }
+        MANIFEST
+
+        expect {
+          apply.command_line.args << manifest
+          apply.run
+        }.to exit_with(0)
+         .and output(%r{Main/File\[#{dest}\]/ensure: defined content as}).to_stdout
+
+        expect(request.path).to eq('/path to file')
+        expect(request.query).to include('x' => 'b[c')
+        expect(request.query).to include('sig' => 'JaZhcqxT4akJcOwUdUGrQB2m1geUoh89iL8WMag8a8c=')
+      end
+    end
+  end
+
+  context 'http report processor' do
+    include_context 'https client'
+
+    before :each do
+      Puppet[:reports] = 'http'
+    end
+
+    let(:unknown_server) do
+      unknown_ca_cert = cert_fixture('unknown-ca.pem')
+      PuppetSpec::HTTPSServer.new(
+        ca_cert: unknown_ca_cert,
+        server_cert: cert_fixture('unknown-127.0.0.1.pem'),
+        server_key: key_fixture('unknown-127.0.0.1-key.pem')
+      )
+    end
+
+    it 'submits a report via reporturl' do
+      report = nil
+
+      response_proc = -> (req, res) {
+        report = Puppet::Transaction::Report.convert_from(:yaml, req.body)
+      }
+
+      https = PuppetSpec::HTTPSServer.new
+      https.start_server(response_proc: response_proc) do |https_port|
+        Puppet[:reporturl] = "https://127.0.0.1:#{https_port}/reports/upload"
+
+        expect {
+          apply.command_line.args = ['-e', 'notify { "hi": }']
+          apply.run
+        }.to exit_with(0)
+         .and output(/Applied catalog/).to_stdout
+
+        expect(report).to be_a(Puppet::Transaction::Report)
+        expect(report.resource_statuses['Notify[hi]']).to be_a(Puppet::Resource::Status)
+      end
+    end
+
+    it 'rejects an HTTPS report server whose root cert is not the puppet CA' do
+      unknown_server.start_server do |https_port|
+        Puppet[:reporturl] = "https://127.0.0.1:#{https_port}/reports/upload"
+
+        # processing the report happens after the transaction is finished,
+        # so we expect exit code 0, with a later failure on stderr
+        expect {
+          apply.command_line.args = ['-e', 'notify { "hi": }']
+          apply.run
+        }.to exit_with(0)
+         .and output(/Applied catalog/).to_stdout
+         .and output(/Report processor failed: certificate verify failed \[self signed certificate in certificate chain for CN=Unknown CA\]/).to_stderr
+      end
+    end
+
+    it 'accepts an HTTPS report servers whose cert is in the system CA store' do
+      Puppet[:report_include_system_store] = true
+      report = nil
+
+      response_proc = -> (req, res) {
+        report = Puppet::Transaction::Report.convert_from(:yaml, req.body)
+      }
+
+      # create a temp cacert bundle
+      ssl_file = tmpfile('systemstore')
+      File.write(ssl_file, unknown_server.ca_cert.to_pem)
+
+      unknown_server.start_server(response_proc: response_proc) do |https_port|
+        Puppet[:reporturl] = "https://127.0.0.1:#{https_port}/reports/upload"
+
+        # override path to system cacert bundle, this must be done before
+        # the SSLContext is created and the call to X509::Store.set_default_paths
+        Puppet::Util.withenv("SSL_CERT_FILE" => ssl_file) do
+          expect {
+            apply.command_line.args = ['-e', 'notify { "hi": }']
+            apply.run
+          }.to exit_with(0)
+           .and output(/Applied catalog/).to_stdout
+        end
+
+        expect(report).to be_a(Puppet::Transaction::Report)
+        expect(report.resource_statuses['Notify[hi]']).to be_a(Puppet::Resource::Status)
+      end
+    end
+  end
 end