Make sure PPA source file is absent when apt-add-repository fails
[puppet-modules/puppetlabs-apt.git] / spec / defines / ppa_spec.rb
index 6944f9b2dfc8f67d951bb3d53a7179759003e4f0..a68dc621502e93108699703e7db34f1e2be8125c 100644 (file)
 require 'spec_helper'
-describe 'apt::ppa', :type => :define do
-  [
-    {
-      :lsbdistrelease  => '11.04',
-      :lsbdistcodename => 'natty',
-      :operatingsystem => 'Ubuntu',
-      :lsbdistid       => 'Ubuntu',
-      :package         => 'python-software-properties'
-    },
-    {
-      :lsbdistrelease  => '12.10',
-      :lsbdistcodename => 'quantal',
-      :operatingsystem => 'Ubuntu',
-      :lsbdistid       => 'Ubuntu',
-      :package         => 'software-properties-common'
-    },
-  ].each do |platform|
-    context "on #{platform[:lsbdistcodename]}" do
+describe 'apt::ppa' do
+  let :pre_condition do
+    'class { "apt": }'
+  end
+
+  describe 'defaults' do
+    let :facts do
+      {
+        os: { family: 'Debian', name: 'Ubuntu', release: { major: '14', full: '41.04' } },
+        lsbdistrelease: '14.04',
+        lsbdistcodename: 'trusty',
+        operatingsystem: 'Ubuntu',
+        osfamily: 'Debian',
+        lsbdistid: 'Ubuntu',
+        puppetversion: Puppet.version,
+      }
+    end
+
+    let(:title) { 'ppa:needs/such.substitution/wow+type' }
+
+    it { is_expected.not_to contain_package('python-software-properties') }
+    it {
+      is_expected.to contain_exec('add-apt-repository-ppa:needs/such.substitution/wow+type').that_notifies('Class[Apt::Update]').with(environment: [],
+                                                                                                                                      command: '/usr/bin/add-apt-repository -y ppa:needs/such.substitution/wow+type || rm /etc/apt/sources.list.d/needs-such_substitution-wow_type-trusty.list && false', # rubocop:disable Metrics/LineLength
+                                                                                                                                      unless: '/usr/bin/test -f /etc/apt/sources.list.d/needs-such_substitution-wow_type-trusty.list', # rubocop:disable Metrics/LineLength
+                                                                                                                                      user: 'root',
+                                                                                                                                      logoutput: 'on_failure')
+    }
+  end
+
+  describe 'Ubuntu 15.10 sources.list filename' do
+    let :facts do
+      {
+        os: { family: 'Debian', name: 'Ubuntu', release: { major: '15', full: '15.10' } },
+        lsbdistrelease: '15.10',
+        lsbdistcodename: 'wily',
+        operatingsystem: 'Ubuntu',
+        osfamily: 'Debian',
+        lsbdistid: 'Ubuntu',
+        puppetversion: Puppet.version,
+      }
+    end
+
+    let(:title) { 'ppa:user/foo' }
+
+    it {
+      is_expected.to contain_exec('add-apt-repository-ppa:user/foo').that_notifies('Class[Apt::Update]').with(environment: [],
+                                                                                                              command: '/usr/bin/add-apt-repository -y ppa:user/foo || rm /etc/apt/sources.list.d/user-ubuntu-foo-wily.list && false',
+                                                                                                              unless: '/usr/bin/test -f /etc/apt/sources.list.d/user-ubuntu-foo-wily.list',
+                                                                                                              user: 'root',
+                                                                                                              logoutput: 'on_failure')
+    }
+  end
+
+  describe 'package_name => software-properties-common' do
+    let :pre_condition do
+      'class { "apt": }'
+    end
+    let :params do
+      {
+        package_name: 'software-properties-common',
+        package_manage: true,
+      }
+    end
+    let :facts do
+      {
+        os: { family: 'Debian', name: 'Ubuntu', release: { major: '14', full: '14.04' } },
+        lsbdistrelease: '14.04',
+        lsbdistcodename: 'trusty',
+        operatingsystem: 'Ubuntu',
+        osfamily: 'Debian',
+        lsbdistid: 'Ubuntu',
+        puppetversion: Puppet.version,
+      }
+    end
+
+    let(:title) { 'ppa:needs/such.substitution/wow' }
+
+    it { is_expected.to contain_package('software-properties-common') }
+    it {
+      is_expected.to contain_exec('add-apt-repository-ppa:needs/such.substitution/wow').that_notifies('Class[Apt::Update]').with('environment' => [],
+                                                                                                                                 'command'     => '/usr/bin/add-apt-repository -y ppa:needs/such.substitution/wow || rm /etc/apt/sources.list.d/needs-such_substitution-wow-trusty.list && false', # rubocop:disable Metrics/LineLength
+                                                                                                                                 'unless'      => '/usr/bin/test -f /etc/apt/sources.list.d/needs-such_substitution-wow-trusty.list', # rubocop:disable Metrics/LineLength
+                                                                                                                                 'user'        => 'root',
+                                                                                                                                 'logoutput'   => 'on_failure')
+    }
+
+    it {
+      is_expected.to contain_file('/etc/apt/sources.list.d/needs-such_substitution-wow-trusty.list').that_requires('Exec[add-apt-repository-ppa:needs/such.substitution/wow]').with('ensure' => 'file')
+    }
+  end
+
+  describe 'package_manage => false' do
+    let :pre_condition do
+      'class { "apt": }'
+    end
+    let :facts do
+      {
+        os: { family: 'Debian', name: 'Ubuntu', release: { major: '14', full: '14.04' } },
+        lsbdistrelease: '14.04',
+        lsbdistcodename: 'trusty',
+        operatingsystem: 'Ubuntu',
+        osfamily: 'Debian',
+        lsbdistid: 'Ubuntu',
+        puppetversion: Puppet.version,
+      }
+    end
+    let :params do
+      {
+        package_manage: false,
+      }
+    end
+
+    let(:title) { 'ppa:needs/such.substitution/wow' }
+
+    it { is_expected.not_to contain_package('python-software-properties') }
+    it {
+      is_expected.to contain_exec('add-apt-repository-ppa:needs/such.substitution/wow').that_notifies('Class[Apt::Update]').with('environment' => [],
+                                                                                                                                 'command'     => '/usr/bin/add-apt-repository -y ppa:needs/such.substitution/wow || rm /etc/apt/sources.list.d/needs-such_substitution-wow-trusty.list && false', # rubocop:disable Metrics/LineLength
+                                                                                                                                 'unless'      => '/usr/bin/test -f /etc/apt/sources.list.d/needs-such_substitution-wow-trusty.list', # rubocop:disable Metrics/LineLength
+                                                                                                                                 'user'        => 'root',
+                                                                                                                                 'logoutput'   => 'on_failure')
+    }
+
+    it {
+      is_expected.to contain_file('/etc/apt/sources.list.d/needs-such_substitution-wow-trusty.list').that_requires('Exec[add-apt-repository-ppa:needs/such.substitution/wow]').with('ensure' => 'file')
+    }
+  end
+
+  describe 'apt included, no proxy' do
+    let :pre_condition do
+      'class { "apt": }
+      apt::ppa { "ppa:user/foo2": }
+      '
+    end
+    let :facts do
+      {
+        os: { family: 'Debian', name: 'Ubuntu', release: { major: '14', full: '14.04' } },
+        lsbdistrelease: '14.04',
+        lsbdistcodename: 'trusty',
+        operatingsystem: 'Ubuntu',
+        lsbdistid: 'Ubuntu',
+        osfamily: 'Debian',
+        puppetversion: Puppet.version,
+      }
+    end
+    let :params do
+      {
+        options: '',
+        package_manage: true,
+        require: 'Apt::Ppa[ppa:user/foo2]',
+      }
+    end
+    let(:title) { 'ppa:user/foo' }
+
+    it { is_expected.to compile.with_all_deps }
+    it { is_expected.to contain_package('software-properties-common') }
+    it {
+      is_expected.to contain_exec('add-apt-repository-ppa:user/foo').that_notifies('Class[Apt::Update]').with(environment: [],
+                                                                                                              command: '/usr/bin/add-apt-repository  ppa:user/foo || rm /etc/apt/sources.list.d/user-foo-trusty.list && false',
+                                                                                                              unless: '/usr/bin/test -f /etc/apt/sources.list.d/user-foo-trusty.list',
+                                                                                                              user: 'root',
+                                                                                                              logoutput: 'on_failure')
+    }
+  end
+
+  describe 'apt included, proxy host' do
+    let :pre_condition do
+      'class { "apt":
+        proxy => { "host" => "localhost" },
+      }'
+    end
+    let :facts do
+      {
+        os: { family: 'Debian', name: 'Ubuntu', release: { major: '14', full: '14.04' } },
+        lsbdistrelease: '14.04',
+        lsbdistcodename: 'trusty',
+        operatingsystem: 'Ubuntu',
+        lsbdistid: 'Ubuntu',
+        osfamily: 'Debian',
+        puppetversion: Puppet.version,
+      }
+    end
+    let :params do
+      {
+        'options' => '',
+        'package_manage' => true,
+      }
+    end
+    let(:title) { 'ppa:user/foo' }
+
+    it { is_expected.to contain_package('software-properties-common') }
+    it {
+      is_expected.to contain_exec('add-apt-repository-ppa:user/foo').that_notifies('Class[Apt::Update]').with(environment: ['http_proxy=http://localhost:8080'],
+                                                                                                              command: '/usr/bin/add-apt-repository  ppa:user/foo || rm /etc/apt/sources.list.d/user-foo-trusty.list && false',
+                                                                                                              unless: '/usr/bin/test -f /etc/apt/sources.list.d/user-foo-trusty.list',
+                                                                                                              user: 'root',
+                                                                                                              logoutput: 'on_failure')
+    }
+  end
+
+  describe 'apt included, proxy host and port' do
+    let :pre_condition do
+      'class { "apt":
+        proxy => { "host" => "localhost", "port" => 8180 },
+      }'
+    end
+    let :facts do
+      {
+        os: { family: 'Debian', name: 'Ubuntu', release: { major: '14', full: '14.04' } },
+        lsbdistrelease: '14.04',
+        lsbdistcodename: 'trusty',
+        operatingsystem: 'Ubuntu',
+        lsbdistid: 'Ubuntu',
+        osfamily: 'Debian',
+        puppetversion: Puppet.version,
+      }
+    end
+    let :params do
+      {
+        options: '',
+        package_manage: true,
+      }
+    end
+    let(:title) { 'ppa:user/foo' }
+
+    it { is_expected.to contain_package('software-properties-common') }
+    it {
+      is_expected.to contain_exec('add-apt-repository-ppa:user/foo').that_notifies('Class[Apt::Update]').with(environment: ['http_proxy=http://localhost:8180'],
+                                                                                                              command: '/usr/bin/add-apt-repository  ppa:user/foo || rm /etc/apt/sources.list.d/user-foo-trusty.list && false',
+                                                                                                              unless: '/usr/bin/test -f /etc/apt/sources.list.d/user-foo-trusty.list',
+                                                                                                              user: 'root',
+                                                                                                              logoutput: 'on_failure')
+    }
+  end
+
+  describe 'apt included, proxy host and port and https' do
+    let :pre_condition do
+      'class { "apt":
+        proxy => { "host" => "localhost", "port" => 8180, "https" => true },
+      }'
+    end
+    let :facts do
+      {
+        os: { family: 'Debian', name: 'Ubuntu', release: { major: '14', full: '14.04' } },
+        lsbdistrelease: '14.04',
+        lsbdistcodename: 'trusty',
+        operatingsystem: 'Ubuntu',
+        lsbdistid: 'Ubuntu',
+        osfamily: 'Debian',
+        puppetversion: Puppet.version,
+      }
+    end
+    let :params do
+      {
+        options: '',
+        package_manage: true,
+      }
+    end
+    let(:title) { 'ppa:user/foo' }
+
+    it { is_expected.to contain_package('software-properties-common') }
+    it {
+      is_expected.to contain_exec('add-apt-repository-ppa:user/foo').that_notifies('Class[Apt::Update]').with(environment: ['http_proxy=http://localhost:8180', 'https_proxy=https://localhost:8180'],
+                                                                                                              command: '/usr/bin/add-apt-repository  ppa:user/foo || rm /etc/apt/sources.list.d/user-foo-trusty.list && false',
+                                                                                                              unless: '/usr/bin/test -f /etc/apt/sources.list.d/user-foo-trusty.list',
+                                                                                                              user: 'root',
+                                                                                                              logoutput: 'on_failure')
+    }
+  end
+
+  describe 'ensure absent' do
+    let :pre_condition do
+      'class { "apt": }'
+    end
+    let :facts do
+      {
+        os: { family: 'Debian', name: 'Ubuntu', release: { major: '14', full: '14.04' } },
+        lsbdistrelease: '14.04',
+        lsbdistcodename: 'trusty',
+        operatingsystem: 'Ubuntu',
+        lsbdistid: 'Ubuntu',
+        osfamily: 'Debian',
+        puppetversion: Puppet.version,
+      }
+    end
+    let(:title) { 'ppa:user/foo' }
+    let :params do
+      {
+        ensure: 'absent',
+      }
+    end
+
+    it {
+      is_expected.to contain_file('/etc/apt/sources.list.d/user-foo-trusty.list').that_notifies('Class[Apt::Update]').with(ensure: 'absent')
+    }
+  end
+
+  context 'with validation' do
+    describe 'no release' do
       let :facts do
         {
-          :lsbdistrelease  => platform[:lsbdistrelease],
-          :lsbdistcodename => platform[:lsbdistcodename],
-          :operatingsystem => platform[:operatingsystem],
-          :lsbdistid       => platform[:lsbdistid],
-          :osfamily        => 'Debian',
+          os: { family: 'Debian', name: 'Ubuntu', release: { major: '14', full: '14.04' } },
+          lsbdistrelease: '14.04',
+          operatingsystem: 'Ubuntu',
+          lsbdistid: 'Ubuntu',
+          osfamily: 'Debian',
+          lsbdistcodeanme: nil,
+          puppetversion: Puppet.version,
         }
       end
-      let :release do
-        "#{platform[:lsbdistcodename]}"
-      end
-      let :package do
-        "#{platform[:package]}"
-      end
-      let :options do
-        "-y"
-      end
-      ['ppa:dans_ppa', 'dans_ppa','ppa:dans-daily/ubuntu'].each do |t|
-        describe "with title #{t}" do
-          let :pre_condition do
-            'class { "apt": }'
-          end
-          let :title do
-            t
-          end
-          let :filename do
-            t.sub(/^ppa:/,'').gsub('/','-') << "-" << "#{release}.list"
-          end
-
-          it { should contain_package("#{package}") }
-
-          it { should contain_exec("apt_update").with(
-            'command'     => '/usr/bin/apt-get update',
-            'refreshonly' => true
-            )
-          }
-
-          it { should contain_exec("add-apt-repository-#{t}").with(
-            'command' => "/usr/bin/add-apt-repository #{options} #{t}",
-            'unless'  => "/usr/bin/test -s /etc/apt/sources.list.d/#{filename}",
-            'require' => ["File[sources.list.d]", "Package[#{package}]"],
-            'notify'  => "Exec[apt_update]"
-            )
-          }
-
-          it { should create_file("/etc/apt/sources.list.d/#{filename}").with(
-            'ensure'  => 'file',
-            'require' => "Exec[add-apt-repository-#{t}]"
-            )
-          }
-        end
-      end
-      describe 'without a proxy defined' do
-        let :title do
-          'rspec_ppa'
-        end
-        let :pre_condition do
-          'class { "apt":
-             proxy_host => false
-          }'
-        end
-        let :filename do
-          "#{title}-#{release}.list"
-        end
-
-        it { should contain_exec("add-apt-repository-#{title}").with(
-          'environment' => [],
-          'command'     => "/usr/bin/add-apt-repository #{options} #{title}",
-          'unless'      => "/usr/bin/test -s /etc/apt/sources.list.d/#{filename}",
-          'require'     => ["File[sources.list.d]", "Package[#{package}]"],
-          'notify'      => "Exec[apt_update]"
-          )
-        }
+      let(:title) { 'ppa:user/foo' }
+
+      it do
+        is_expected.to raise_error(Puppet::Error, %r{lsbdistcodename fact not available: release parameter required})
       end
+    end
 
-      describe 'behind a proxy' do
-        let :title do
-          'rspec_ppa'
-        end
-        let :pre_condition do
-          'class { "apt":
-            proxy_host => "user:pass@proxy",
-          }'
-        end
-          let :filename do
-            "#{title}-#{release}.list"
-          end
-
-        it { should contain_exec("add-apt-repository-#{title}").with(
-          'environment' => [
-            "http_proxy=http://user:pass@proxy:8080",
-            "https_proxy=http://user:pass@proxy:8080",
-          ],
-          'command'     => "/usr/bin/add-apt-repository #{options} #{title}",
-          'unless'      => "/usr/bin/test -s /etc/apt/sources.list.d/#{filename}",
-          'require'     => ["File[sources.list.d]", "Package[#{package}]"],
-          'notify'      => "Exec[apt_update]"
-          )
+    describe 'not ubuntu' do
+      let :facts do
+        {
+          os: { family: 'Debian', name: 'Debian', release: { major: '6', full: '6.0.7' } },
+          lsbdistrelease: '6.0.7',
+          lsbdistcodename: 'wheezy',
+          operatingsystem: 'Debian',
+          lsbdistid: 'debian',
+          osfamily: 'Debian',
+          puppetversion: Puppet.version,
         }
       end
-    end
-  end
+      let(:title) { 'ppa:user/foo' }
 
-  [ { :lsbdistcodename => 'natty',
-      :package => 'python-software-properties' },
-    { :lsbdistcodename => 'quantal',
-      :package => 'software-properties-common'},
-  ].each do |platform|
-    context "on #{platform[:lsbdistcodename]}" do
-      describe "it should not error if package['#{platform[:package]}'] is already defined" do
-        let :pre_condition do
-           'class {"apt": }' +
-           'package { "#{platform[:package]}": }->Apt::Ppa["ppa"]'
-        end
-        let :facts do
-          {:lsbdistcodename => '#{platform[:lsbdistcodename]}',
-           :operatingsystem => 'Ubuntu',
-           :lsbdistid => 'Ubuntu',
-           :osfamily => 'Debian'}
-        end
-        let(:title) { "ppa" }
-        let(:release) { "#{platform[:lsbdistcodename]}" }
-        it { should contain_package('#{platform[:package]}') }
+      it do
+        is_expected.to raise_error(Puppet::Error, %r{not currently supported on Debian})
       end
     end
   end
-
-  describe "without Class[apt] should raise a Puppet::Error" do
-    let(:release) { "natty" }
-    let(:title) { "ppa" }
-    it { expect { should contain_apt__ppa(title) }.to raise_error(Puppet::Error) }
-  end
-
-  describe "without release should raise a Puppet::Error" do
-    let(:title) { "ppa:" }
-    it { expect { should contain_apt__ppa(:release) }.to raise_error(Puppet::Error) }
-  end
 end