Add tests for valid/invalid resource names
[puppet-modules/puppetlabs-apt.git] / spec / defines / ppa_spec.rb
index ae66087e88ada8af3afa81127b73590292ca9138..8d0c4f926342a9a320f3ebca2429e966021f48b1 100644 (file)
@@ -1,4 +1,15 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
+
+def ppa_exec_params(user, repo, distro = 'trusty', environment = [])
+  [
+    environment: environment,
+    command: "/opt/puppetlabs/puppet/cache/add-apt-repository-#{user}-ubuntu-#{repo}-#{distro}.sh",
+    logoutput: 'on_failure',
+  ]
+end
+
 describe 'apt::ppa' do
   let :pre_condition do
     'class { "apt": }'
@@ -7,135 +18,157 @@ describe 'apt::ppa' do
   describe 'defaults' do
     let :facts do
       {
-        :os => { :family => 'Debian', :name => 'Ubuntu', :release => { :major => '11', :full => '11.04' }},
-        :lsbdistrelease  => '11.04',
-        :lsbdistcodename => 'natty',
-        :operatingsystem => 'Ubuntu',
-        :osfamily        => 'Debian',
-        :lsbdistid       => 'Ubuntu',
-        :puppetversion   => Puppet.version,
+        os: {
+          family: 'Debian',
+          name: 'Ubuntu',
+          release: {
+            major: '18',
+            full: '18.04',
+          },
+          distro: {
+            codename: 'trusty',
+            id: 'Ubuntu',
+          },
+        },
       }
     end
 
-    let(:title) { 'ppa:needs/such.substitution/wow+type' }
-    it { is_expected.to_not 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',
-      :unless      => '/usr/bin/test -f /etc/apt/sources.list.d/needs-such_substitution-wow_type-natty.list',
-      :user        => 'root',
-      :logoutput   => 'on_failure',
-    })
+    let(:title) { 'ppa:needs/substitution' }
+
+    it { is_expected.not_to contain_package('python-software-properties') }
+    it {
+      is_expected.to contain_exec('add-apt-repository-ppa:needs/substitution')
+        .that_notifies('Class[Apt::Update]')
+        .with(*ppa_exec_params('needs', 'substitution'))
     }
   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
+  [
+    'ppa:foo/bar',
+    'ppa:foo/bar1.0',
+    'ppa:foo10/bar10',
+    'ppa:foo-/bar_',
+  ].each do |value|
+    describe 'valid resource names' do
+      let :facts do
+        {
+          os: {
+            family: 'Debian',
+            name: 'Ubuntu',
+            release: {
+              major: '18',
+              full: '18.04',
+            },
+            distro: {
+              codename: 'trusty',
+              id: 'Ubuntu',
+            },
+          },
+        }
+      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',
-      :unless      => '/usr/bin/test -f /etc/apt/sources.list.d/user-ubuntu-foo-wily.list',
-      :user        => 'root',
-      :logoutput   => 'on_failure',
-    })
-    }
-  end
+      let(:title) { value }
 
-  describe 'ppa depending on ppa, MODULES-1156' do
-    let :pre_condition do
-      'class { "apt": }'
+      it { is_expected.not_to raise_error }
+      it { is_expected.to contain_exec("add-apt-repository-#{value}") }
     end
   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,
-      }
+  [
+    'ppa:foo!/bar',
+    'ppa:foo/bar!',
+    'ppa:foo1.0/bar',
+    'ppa:foo/bar/foobar',
+    '|| ls -la ||',
+    '|| touch /tmp/foo.txt ||',
+  ].each do |value|
+    describe 'invalid resource names' do
+      let :facts do
+        {
+          os: {
+            family: 'Debian',
+            name: 'Ubuntu',
+            release: {
+              major: '18',
+              full: '18.04',
+            },
+            distro: {
+              codename: 'trusty',
+              id: 'Ubuntu',
+            },
+          },
+        }
+      end
+
+      let(:title) { value }
+
+      it { is_expected.to raise_error(Puppet::PreformattedError, %r{Invalid PPA name: #{value}}) }
     end
+  end
+
+  describe 'Ubuntu 15.10 sources.list filename' do
     let :facts do
       {
-        :os => { :family => 'Debian', :name => 'Ubuntu', :release => { :major => '11', :full => '11.04' }},
-        :lsbdistrelease  => '11.04',
-        :lsbdistcodename => 'natty',
-        :operatingsystem => 'Ubuntu',
-        :osfamily        => 'Debian',
-        :lsbdistid       => 'Ubuntu',
-        :puppetversion   => Puppet.version,
+        os: {
+          family: 'Debian',
+          name: 'Ubuntu',
+          release: {
+            major: '15',
+            full: '15.10',
+          },
+          distro: {
+            codename: 'wily',
+            id: 'Ubuntu',
+          },
+        },
       }
     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',
-      'unless'      => '/usr/bin/test -f /etc/apt/sources.list.d/needs-such_substitution-wow-natty.list',
-      'user'        => 'root',
-      'logoutput'   => 'on_failure',
-    })
-    }
+    let(:title) { 'ppa:user/foo' }
 
-    it { is_expected.to contain_file('/etc/apt/sources.list.d/needs-such_substitution-wow-natty.list').that_requires('Exec[add-apt-repository-ppa:needs/such.substitution/wow]').with({
-      'ensure' => 'file',
-    })
+    it {
+      is_expected.to contain_exec('add-apt-repository-ppa:user/foo')
+        .that_notifies('Class[Apt::Update]')
+        .with(*ppa_exec_params('user', 'foo', 'wily'))
     }
   end
 
-  describe 'package_manage => true, multiple ppas, MODULES-2873' do
+  describe 'package_name => software-properties-common' do
     let :pre_condition do
-      'class { "apt": }
-       apt::ppa {"ppa:user/foo":
-         package_manage => true
-       }'
+      'class { "apt": }'
     end
-    let :facts do
+
+    let :params do
       {
-        :os => { :family => 'Debian', :name => 'Ubuntu', :release => { :major => '11', :full => '11.04' }},
-        :lsbdistrelease  => '11.04',
-        :lsbdistcodename => 'natty',
-        :operatingsystem => 'Ubuntu',
-        :osfamily        => 'Debian',
-        :lsbdistid       => 'Ubuntu',
-        :puppetversion   => Puppet.version,
+        package_name: 'software-properties-common',
+        package_manage: true,
       }
     end
-    let :params do
+
+    let :facts do
       {
-        :package_manage => true,
+        os: {
+          family: 'Debian',
+          name: 'Ubuntu',
+          release: {
+            major: '18',
+            full: '18.04',
+          },
+          distro: {
+            codename: 'trusty',
+            id: 'Ubuntu',
+          },
+        },
       }
     end
 
-    let(:title) { 'ppa:user/bar' }
-    it { is_expected.to contain_package('python-software-properties') }
-    it { is_expected.to contain_exec('add-apt-repository-ppa:user/bar').that_notifies('Class[Apt::Update]').with({
-      'environment' => [],
-      'command'     => '/usr/bin/add-apt-repository -y ppa:user/bar',
-      'unless'      => '/usr/bin/test -f /etc/apt/sources.list.d/user-bar-natty.list',
-      'user'        => 'root',
-      'logoutput'   => 'on_failure',
-    })
-    }
+    let(:title) { 'ppa:needs/substitution' }
 
-    it { is_expected.to contain_file('/etc/apt/sources.list.d/user-bar-natty.list').that_requires('Exec[add-apt-repository-ppa:user/bar]').with({
-      'ensure' => 'file',
-    })
+    it { is_expected.to contain_package('software-properties-common') }
+    it {
+      is_expected.to contain_exec('add-apt-repository-ppa:needs/substitution')
+        .that_notifies('Class[Apt::Update]')
+        .with(*ppa_exec_params('needs', 'substitution'))
     }
   end
 
@@ -143,37 +176,37 @@ describe 'apt::ppa' do
     let :pre_condition do
       'class { "apt": }'
     end
+
     let :facts do
       {
-        :os => { :family => 'Debian', :name => 'Ubuntu', :release => { :major => '11', :full => '11.04' }},
-        :lsbdistrelease  => '11.04',
-        :lsbdistcodename => 'natty',
-        :operatingsystem => 'Ubuntu',
-        :osfamily        => 'Debian',
-        :lsbdistid       => 'Ubuntu',
-        :puppetversion   => Puppet.version,
+        os: {
+          family: 'Debian',
+          name: 'Ubuntu',
+          release: {
+            major: '18',
+            full: '18.04',
+          },
+          distro: {
+            codename: 'trusty',
+            id: 'Ubuntu',
+          },
+        },
       }
     end
+
     let :params do
       {
-        :package_manage => false,
+        package_manage: false,
       }
     end
 
-    let(:title) { 'ppa:needs/such.substitution/wow' }
-    it { is_expected.to_not 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',
-      'unless'      => '/usr/bin/test -f /etc/apt/sources.list.d/needs-such_substitution-wow-natty.list',
-      'user'        => 'root',
-      'logoutput'   => 'on_failure',
-    })
-    }
+    let(:title) { 'ppa:needs/substitution' }
 
-    it { is_expected.to contain_file('/etc/apt/sources.list.d/needs-such_substitution-wow-natty.list').that_requires('Exec[add-apt-repository-ppa:needs/such.substitution/wow]').with({
-      'ensure' => 'file',
-    })
+    it { is_expected.not_to contain_package('python-software-properties') }
+    it {
+      is_expected.to contain_exec('add-apt-repository-ppa:needs/substitution')
+        .that_notifies('Class[Apt::Update]')
+        .with(*ppa_exec_params('needs', 'substitution'))
     }
   end
 
@@ -183,34 +216,39 @@ describe 'apt::ppa' do
       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,
+        os: {
+          family: 'Debian',
+          name: 'Ubuntu',
+          release: {
+            major: '18',
+            full: '18.04',
+          },
+          distro: {
+            codename: 'trusty',
+            id: 'Ubuntu',
+          },
+        },
       }
     end
+
     let :params do
       {
-        :options        => '',
-        :package_manage => true,
-        :require        => 'Apt::Ppa[ppa:user/foo2]',
+        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',
-      :unless      => '/usr/bin/test -f /etc/apt/sources.list.d/user-foo-trusty.list',
-      :user        => 'root',
-      :logoutput   => 'on_failure',
-    })
+    it {
+      is_expected.to contain_exec('add-apt-repository-ppa:user/foo')
+        .that_notifies('Class[Apt::Update]')
+        .with(*ppa_exec_params('user', 'foo'))
     }
   end
 
@@ -220,32 +258,37 @@ describe 'apt::ppa' do
         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,
+        os: {
+          family: 'Debian',
+          name: 'Ubuntu',
+          release: {
+            major: '18',
+            full: '18.04',
+          },
+          distro: {
+            codename: 'trusty',
+            id: 'Ubuntu',
+          },
+        },
       }
     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',
-      :unless      => '/usr/bin/test -f /etc/apt/sources.list.d/user-foo-trusty.list',
-      :user        => 'root',
-      :logoutput   => 'on_failure',
-    })
+    it {
+      is_expected.to contain_exec('add-apt-repository-ppa:user/foo')
+        .that_notifies('Class[Apt::Update]')
+        .with(*ppa_exec_params('user', 'foo', 'trusty', ['http_proxy=http://localhost:8080']))
     }
   end
 
@@ -255,32 +298,37 @@ describe 'apt::ppa' do
         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,
+        os: {
+          family: 'Debian',
+          name: 'Ubuntu',
+          release: {
+            major: '18',
+            full: '18.04',
+          },
+          distro: {
+            codename: 'trusty',
+            id: 'Ubuntu',
+          },
+        },
       }
     end
+
     let :params do
       {
-        :options => '',
-        :package_manage => true,
+        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',
-      :unless      => '/usr/bin/test -f /etc/apt/sources.list.d/user-foo-trusty.list',
-      :user        => 'root',
-      :logoutput   => 'on_failure',
-    })
+    it {
+      is_expected.to contain_exec('add-apt-repository-ppa:user/foo')
+        .that_notifies('Class[Apt::Update]')
+        .with(*ppa_exec_params('user', 'foo', 'trusty', ['http_proxy=http://localhost:8180']))
     }
   end
 
@@ -290,32 +338,37 @@ describe 'apt::ppa' do
         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,
+        os: {
+          family: 'Debian',
+          name: 'Ubuntu',
+          release: {
+            major: '18',
+            full: '18.04',
+          },
+          distro: {
+            codename: 'trusty',
+            id: 'Ubuntu',
+          },
+        },
       }
     end
+
     let :params do
       {
-        :options => '',
-        :package_manage => true,
+        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',
-      :unless      => '/usr/bin/test -f /etc/apt/sources.list.d/user-foo-trusty.list',
-      :user        => 'root',
-      :logoutput   => 'on_failure',
-    })
+    it {
+      is_expected.to contain_exec('add-apt-repository-ppa:user/foo')
+        .that_notifies('Class[Apt::Update]')
+        .with(*ppa_exec_params('user', 'foo', 'trusty', ['http_proxy=http://localhost:8180', 'https_proxy=https://localhost:8180']))
     }
   end
 
@@ -323,64 +376,90 @@ describe 'apt::ppa' do
     let :pre_condition do
       'class { "apt": }'
     end
+
     let :facts do
       {
-        :lsbdistrelease  => '14.04',
-        :lsbdistcodename => 'trusty',
-        :operatingsystem => 'Ubuntu',
-        :lsbdistid       => 'Ubuntu',
-        :osfamily        => 'Debian',
-        :puppetversion   => Puppet.version,
+        os: {
+          family: 'Debian',
+          name: 'Ubuntu',
+          release: {
+            major: '18',
+            full: '18.04',
+          },
+          distro: {
+            codename: 'trusty',
+            id: 'Ubuntu',
+          },
+        },
       }
     end
+
     let(:title) { 'ppa:user/foo' }
+
     let :params do
       {
-        :ensure => 'absent'
+        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',
-    })
+
+    it {
+      is_expected.to contain_tidy("remove-apt-repository-script-#{title}")
+        .with('path' => '/opt/puppetlabs/puppet/cache/add-apt-repository-user-ubuntu-foo-trusty.sh')
+
+      is_expected.to contain_tidy("remove-apt-repository-#{title}")
+        .with('path' => '/etc/apt/sources.list.d/user-ubuntu-foo-trusty.list')
+        .that_notifies('Class[Apt::Update]')
     }
   end
 
-  context 'validation' do
+  context 'with validation' do
     describe 'no release' do
       let :facts do
         {
-          :lsbdistrelease  => '14.04',
-          :operatingsystem => 'Ubuntu',
-          :lsbdistid       => 'Ubuntu',
-          :osfamily        => 'Debian',
-          :lsbdistcodeanme => nil,
-          :puppetversion   => Puppet.version,
+          os: {
+            family: 'Debian',
+            name: 'Ubuntu',
+            release: {
+              major: '18',
+              full: '18.04',
+            },
+            distro: {
+              codename: nil,
+              id: 'Ubuntu',
+            },
+          },
         }
       end
+
       let(:title) { 'ppa:user/foo' }
+
       it do
-        expect {
-          subject.call
-        }.to raise_error(Puppet::Error, /lsbdistcodename fact not available: release parameter required/)
+        is_expected.to raise_error(Puppet::Error, %r{os.distro.codename fact not available: release parameter required})
       end
     end
 
     describe 'not ubuntu' do
       let :facts do
         {
-          :lsbdistrelease  => '6.0.7',
-          :lsbdistcodename => 'wheezy',
-          :operatingsystem => 'Debian',
-          :lsbdistid       => 'debian',
-          :osfamily        => 'Debian',
-          :puppetversion   => Puppet.version,
+          os: {
+            family: 'Debian',
+            name: 'Debian',
+            release: {
+              major: '6',
+              full: '6.0.7',
+            },
+            distro: {
+              codename: 'wheezy',
+              id: 'Debian',
+            },
+          },
         }
       end
+
       let(:title) { 'ppa:user/foo' }
+
       it do
-        expect {
-          subject.call
-        }.to raise_error(Puppet::Error, /not currently supported on Debian/)
+        is_expected.to raise_error(Puppet::Error, %r{not currently supported on Debian})
       end
     end
   end