module-concat/spec/acceptance/deprecation_warnings_spec.rb

require 'spec_helper_acceptance'

describe 'deprecation warnings' do

  shared_examples 'has_warning'do |pp, w|
    it 'applies the manifest twice with a stderr regex' do
      expect(apply_manifest(pp, :catch_failures => true).stderr).to match(/#{Regexp.escape(w)}/m)
      expect(apply_manifest(pp, :catch_changes => true).stderr).to match(/#{Regexp.escape(w)}/m)
    end
  end

  context 'concat gnu parameter' do
    pp = <<-EOS
      concat { '/tmp/concat/file':
        gnu => 'foo',
      }
      concat::fragment { 'foo':
        target  => '/tmp/concat/file',
        content => 'bar',
      }
    EOS
    w = 'The $gnu parameter to concat is deprecated and has no effect'

    it_behaves_like 'has_warning', pp, w
  end

  context 'concat warn parameter =>' do
    ['true', 'yes', 'on'].each do |warn|
      context warn do
        pp = <<-EOS
          concat { '/tmp/concat/file':
            warn => '#{warn}',
          }
          concat::fragment { 'foo':
            target  => '/tmp/concat/file',
            content => 'bar',
          }
        EOS
        w = 'Using stringified boolean values (\'true\', \'yes\', \'on\', \'false\', \'no\', \'off\') to represent boolean true/false as the $warn parameter to concat is deprecated and will be treated as the warning message in a future release'

        it_behaves_like 'has_warning', pp, w

        describe file('/tmp/concat/file') do
          it { should be_file }
          it { should contain '# This file is managed by Puppet. DO NOT EDIT.' }
          it { should contain 'bar' }
        end
      end
    end

    ['false', 'no', 'off'].each do |warn|
      context warn do
        pp = <<-EOS
          concat { '/tmp/concat/file':
            warn => '#{warn}',
          }
          concat::fragment { 'foo':
            target  => '/tmp/concat/file',
            content => 'bar',
          }
        EOS
        w = 'Using stringified boolean values (\'true\', \'yes\', \'on\', \'false\', \'no\', \'off\') to represent boolean true/false as the $warn parameter to concat is deprecated and will be treated as the warning message in a future release'

        it_behaves_like 'has_warning', pp, w

        describe file('/tmp/concat/file') do
          it { should be_file }
          it { should_not contain '# This file is managed by Puppet. DO NOT EDIT.' }
          it { should contain 'bar' }
        end
      end
    end
  end

  context 'concat::fragment ensure parameter' do
    context 'target file exists' do
      before(:all) do
        shell("/bin/echo 'file1 contents' > /tmp/concat/file1")
      end
      after(:all) do
        # XXX this test may leave behind a symlink in the fragment directory
        # which could cause warnings and/or breakage from the subsequent tests
        # unless we clean it up. 
        shell('rm -rf /tmp/concat /var/lib/puppet/concat')
        shell('mkdir -p /tmp/concat')
      end

      pp = <<-EOS
        concat { '/tmp/concat/file': }
        concat::fragment { 'foo':
          target => '/tmp/concat/file',
          ensure => '/tmp/concat/file1',
        }
      EOS
      w = 'Passing a value other than \'present\' or \'absent\' as the $ensure parameter to concat::fragment is deprecated.  If you want to use the content of a file as a fragment please use the $source parameter.'

      it_behaves_like 'has_warning', pp, w

      describe file('/tmp/concat/file') do
        it { should be_file }
        it { should contain 'file1 contents' }
      end

      describe 'the fragment can be changed from a symlink to a plain file' do
        pp = <<-EOS
          concat { '/tmp/concat/file': }
          concat::fragment { 'foo':
            target  => '/tmp/concat/file',
            content => 'new content',
          }
        EOS

        it 'applies the manifest twice with no stderr' do
          expect(apply_manifest(pp, :catch_failures => true).stderr).to eq("")
          expect(apply_manifest(pp, :catch_changes => true).stderr).to eq("")
        end

        describe file('/tmp/concat/file') do
          it { should be_file }
          it { should contain 'new content' }
          it { should_not contain 'file1 contents' }
        end
      end
    end # target file exists

    context 'target does not exist' do
      pp = <<-EOS
        concat { '/tmp/concat/file': }
        concat::fragment { 'foo':
          target => '/tmp/concat/file',
          ensure => '/tmp/concat/file1',
        }
      EOS
      w = 'Passing a value other than \'present\' or \'absent\' as the $ensure parameter to concat::fragment is deprecated.  If you want to use the content of a file as a fragment please use the $source parameter.'

      it_behaves_like 'has_warning', pp, w

      describe file('/tmp/concat/file') do
        it { should be_file }
      end

      describe 'the fragment can be changed from a symlink to a plain file' do
        pp = <<-EOS
          concat { '/tmp/concat/file': }
          concat::fragment { 'foo':
            target  => '/tmp/concat/file',
            content => 'new content',
          }
        EOS

        it 'applies the manifest twice with no stderr' do
          expect(apply_manifest(pp, :catch_failures => true).stderr).to eq("")
          expect(apply_manifest(pp, :catch_changes => true).stderr).to eq("")
        end

        describe file('/tmp/concat/file') do
          it { should be_file }
          it { should contain 'new content' }
        end
      end
    end # target file exists

  end # concat::fragment ensure parameter

  context 'concat::fragment mode parameter' do
    pp = <<-EOS
      concat { '/tmp/concat/file': }
      concat::fragment { 'foo':
        target  => '/tmp/concat/file',
        content => 'bar',
        mode    => 'bar',
      }
    EOS
    w = 'The $mode parameter to concat::fragment is deprecated and has no effect'

    it_behaves_like 'has_warning', pp, w
  end

  context 'concat::fragment owner parameter' do
    pp = <<-EOS
      concat { '/tmp/concat/file': }
      concat::fragment { 'foo':
        target  => '/tmp/concat/file',
        content => 'bar',
        owner   => 'bar',
      }
    EOS
    w = 'The $owner parameter to concat::fragment is deprecated and has no effect'

    it_behaves_like 'has_warning', pp, w
  end

  context 'concat::fragment group parameter' do
    pp = <<-EOS
      concat { '/tmp/concat/file': }
      concat::fragment { 'foo':
        target  => '/tmp/concat/file',
        content => 'bar',
        group   => 'bar',
      }
    EOS
    w = 'The $group parameter to concat::fragment is deprecated and has no effect'

    it_behaves_like 'has_warning', pp, w
  end

  context 'concat::fragment backup parameter' do
    pp = <<-EOS
      concat { '/tmp/concat/file': }
      concat::fragment { 'foo':
        target  => '/tmp/concat/file',
        content => 'bar',
        backup  => 'bar',
      }
    EOS
    w = 'The $backup parameter to concat::fragment is deprecated and has no effect'

    it_behaves_like 'has_warning', pp, w
  end

  context 'include concat::setup' do
    pp = <<-EOS
      include concat::setup
    EOS
    w = 'concat::setup is deprecated as a public API of the concat module and should no longer be directly included in the manifest.'

    it_behaves_like 'has_warning', pp, w
  end

end