Update CODEOWNERS
[puppet-modules/puppetlabs-apt.git] / spec / defines / ppa_spec.rb
index b5aadff31a5e211994c6a3eea770989b6d870357..05718ebc34ca972b570f65410d95880a2bef8c4c 100644 (file)
@@ -1,6 +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": }'
@@ -14,28 +23,91 @@ describe 'apt::ppa' do
           name: 'Ubuntu',
           release: {
             major: '18',
-            full: '18.04',
+            full: '18.04'
           },
           distro: {
             codename: 'trusty',
-            id: 'Ubuntu',
-          },
+            id: 'Ubuntu'
+          }
         },
+        puppet_vardir: '/opt/puppetlabs/puppet/cache'
       }
     end
 
-    let(:title) { 'ppa:needs/such.substitution/wow+type' }
+    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/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-ubuntu-such_substitution-wow_type-trusty.list && false)', # rubocop:disable Layout/LineLength
-                                                                                                                                      unless: '/usr/bin/test -f /etc/apt/sources.list.d/needs-ubuntu-such_substitution-wow_type-trusty.list && /usr/bin/test -f /etc/apt/trusted.gpg.d/needs_ubuntu_such_substitution-wow_type.gpg', # rubocop:disable Layout/LineLength
-                                                                                                                                      user: 'root',
-                                                                                                                                      logoutput: 'on_failure')
+      expect(subject).to contain_exec('add-apt-repository-ppa:needs/substitution')
+        .that_notifies('Class[Apt::Update]')
+        .with(*ppa_exec_params('needs', 'substitution'))
     }
   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) { value }
+
+      it { is_expected.not_to raise_error }
+      it { is_expected.to contain_exec("add-apt-repository-#{value}") }
+    end
+  end
+
+  [
+    '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
       {
@@ -44,24 +116,23 @@ describe 'apt::ppa' do
           name: 'Ubuntu',
           release: {
             major: '15',
-            full: '15.10',
+            full: '15.10'
           },
           distro: {
             codename: 'wily',
-            id: 'Ubuntu',
-          },
+            id: 'Ubuntu'
+          }
         },
+        puppet_vardir: '/opt/puppetlabs/puppet/cache'
       }
     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)', # rubocop:disable Layout/LineLength
-                                                                                                              unless: '/usr/bin/test -f /etc/apt/sources.list.d/user-ubuntu-foo-wily.list && /usr/bin/test -f /etc/apt/trusted.gpg.d/user_ubuntu_foo.gpg', # rubocop:disable Layout/LineLength
-                                                                                                              user: 'root',
-                                                                                                              logoutput: 'on_failure')
+      expect(subject).to contain_exec('add-apt-repository-ppa:user/foo')
+        .that_notifies('Class[Apt::Update]')
+        .with(*ppa_exec_params('user', 'foo', 'wily'))
     }
   end
 
@@ -69,12 +140,14 @@ describe 'apt::ppa' do
     let :pre_condition do
       'class { "apt": }'
     end
+
     let :params do
       {
         package_name: 'software-properties-common',
-        package_manage: true,
+        package_manage: true
       }
     end
+
     let :facts do
       {
         os: {
@@ -82,29 +155,25 @@ describe 'apt::ppa' do
           name: 'Ubuntu',
           release: {
             major: '18',
-            full: '18.04',
+            full: '18.04'
           },
           distro: {
             codename: 'trusty',
-            id: 'Ubuntu',
-          },
+            id: 'Ubuntu'
+          }
         },
+        puppet_vardir: '/opt/puppetlabs/puppet/cache'
       }
     end
 
-    let(:title) { 'ppa:needs/such.substitution/wow' }
+    let(:title) { 'ppa:needs/substitution' }
 
     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-ubuntu-such_substitution-wow-trusty.list && false)', # rubocop:disable Layout/LineLength
-                                                                                                                                 'unless'      => '/usr/bin/test -f /etc/apt/sources.list.d/needs-ubuntu-such_substitution-wow-trusty.list && /usr/bin/test -f /etc/apt/trusted.gpg.d/needs_ubuntu_such_substitution-wow.gpg', # rubocop:disable Layout/LineLength
-                                                                                                                                 'user'        => 'root',
-                                                                                                                                 'logoutput'   => 'on_failure')
-    }
 
     it {
-      is_expected.to contain_file('/etc/apt/sources.list.d/needs-ubuntu-such_substitution-wow-trusty.list').that_requires('Exec[add-apt-repository-ppa:needs/such.substitution/wow]').with('ensure' => 'file') # rubocop:disable Layout/LineLength
+      expect(subject).to contain_exec('add-apt-repository-ppa:needs/substitution')
+        .that_notifies('Class[Apt::Update]')
+        .with(*ppa_exec_params('needs', 'substitution'))
     }
   end
 
@@ -112,6 +181,7 @@ describe 'apt::ppa' do
     let :pre_condition do
       'class { "apt": }'
     end
+
     let :facts do
       {
         os: {
@@ -119,34 +189,31 @@ describe 'apt::ppa' do
           name: 'Ubuntu',
           release: {
             major: '18',
-            full: '18.04',
+            full: '18.04'
           },
           distro: {
             codename: 'trusty',
-            id: 'Ubuntu',
-          },
+            id: 'Ubuntu'
+          }
         },
+        puppet_vardir: '/opt/puppetlabs/puppet/cache'
       }
     end
+
     let :params do
       {
-        package_manage: false,
+        package_manage: false
       }
     end
 
-    let(:title) { 'ppa:needs/such.substitution/wow' }
+    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/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-ubuntu-such_substitution-wow-trusty.list && false)', # rubocop:disable Layout/LineLength
-                                                                                                                                 'unless'      => '/usr/bin/test -f /etc/apt/sources.list.d/needs-ubuntu-such_substitution-wow-trusty.list && /usr/bin/test -f /etc/apt/trusted.gpg.d/needs_ubuntu_such_substitution-wow.gpg', # rubocop:disable Layout/LineLength
-                                                                                                                                 'user'        => 'root',
-                                                                                                                                 'logoutput'   => 'on_failure')
-    }
 
     it {
-      is_expected.to contain_file('/etc/apt/sources.list.d/needs-ubuntu-such_substitution-wow-trusty.list').that_requires('Exec[add-apt-repository-ppa:needs/such.substitution/wow]').with('ensure' => 'file') # rubocop:disable Layout/LineLength
+      expect(subject).to contain_exec('add-apt-repository-ppa:needs/substitution')
+        .that_notifies('Class[Apt::Update]')
+        .with(*ppa_exec_params('needs', 'substitution'))
     }
   end
 
@@ -156,6 +223,7 @@ describe 'apt::ppa' do
       apt::ppa { "ppa:user/foo2": }
       '
     end
+
     let :facts do
       {
         os: {
@@ -163,32 +231,33 @@ describe 'apt::ppa' do
           name: 'Ubuntu',
           release: {
             major: '18',
-            full: '18.04',
+            full: '18.04'
           },
           distro: {
             codename: 'trusty',
-            id: 'Ubuntu',
-          },
+            id: 'Ubuntu'
+          }
         },
+        puppet_vardir: '/opt/puppetlabs/puppet/cache'
       }
     end
+
     let :params do
       {
-        options: '',
         package_manage: true,
-        require: 'Apt::Ppa[ppa:user/foo2]',
+        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-ubuntu-foo-trusty.list && false)', # rubocop:disable Layout/LineLength
-                                                                                                              unless: '/usr/bin/test -f /etc/apt/sources.list.d/user-ubuntu-foo-trusty.list && /usr/bin/test -f /etc/apt/trusted.gpg.d/user_ubuntu_foo.gpg', # rubocop:disable Layout/LineLength
-                                                                                                              user: 'root',
-                                                                                                              logoutput: 'on_failure')
+      expect(subject).to contain_exec('add-apt-repository-ppa:user/foo')
+        .that_notifies('Class[Apt::Update]')
+        .with(*ppa_exec_params('user', 'foo'))
     }
   end
 
@@ -198,6 +267,7 @@ describe 'apt::ppa' do
         proxy => { "host" => "localhost" },
       }'
     end
+
     let :facts do
       {
         os: {
@@ -205,30 +275,31 @@ describe 'apt::ppa' do
           name: 'Ubuntu',
           release: {
             major: '18',
-            full: '18.04',
+            full: '18.04'
           },
           distro: {
             codename: 'trusty',
-            id: 'Ubuntu',
-          },
+            id: 'Ubuntu'
+          }
         },
+        puppet_vardir: '/opt/puppetlabs/puppet/cache'
       }
     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:8080'],
-                                                                                                              command: '/usr/bin/add-apt-repository  ppa:user/foo || (rm /etc/apt/sources.list.d/user-ubuntu-foo-trusty.list && false)', # rubocop:disable Layout/LineLength
-                                                                                                              unless: '/usr/bin/test -f /etc/apt/sources.list.d/user-ubuntu-foo-trusty.list && /usr/bin/test -f /etc/apt/trusted.gpg.d/user_ubuntu_foo.gpg', # rubocop:disable Layout/LineLength
-                                                                                                              user: 'root',
-                                                                                                              logoutput: 'on_failure')
+      expect(subject).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
 
@@ -238,6 +309,7 @@ describe 'apt::ppa' do
         proxy => { "host" => "localhost", "port" => 8180 },
       }'
     end
+
     let :facts do
       {
         os: {
@@ -245,30 +317,31 @@ describe 'apt::ppa' do
           name: 'Ubuntu',
           release: {
             major: '18',
-            full: '18.04',
+            full: '18.04'
           },
           distro: {
             codename: 'trusty',
-            id: 'Ubuntu',
-          },
+            id: 'Ubuntu'
+          }
         },
+        puppet_vardir: '/opt/puppetlabs/puppet/cache'
       }
     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 || (rm /etc/apt/sources.list.d/user-ubuntu-foo-trusty.list && false)', # rubocop:disable Layout/LineLength
-                                                                                                              unless: '/usr/bin/test -f /etc/apt/sources.list.d/user-ubuntu-foo-trusty.list && /usr/bin/test -f /etc/apt/trusted.gpg.d/user_ubuntu_foo.gpg', # rubocop:disable Layout/LineLength
-                                                                                                              user: 'root',
-                                                                                                              logoutput: 'on_failure')
+      expect(subject).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
 
@@ -278,6 +351,7 @@ describe 'apt::ppa' do
         proxy => { "host" => "localhost", "port" => 8180, "https" => true },
       }'
     end
+
     let :facts do
       {
         os: {
@@ -285,30 +359,31 @@ describe 'apt::ppa' do
           name: 'Ubuntu',
           release: {
             major: '18',
-            full: '18.04',
+            full: '18.04'
           },
           distro: {
             codename: 'trusty',
-            id: 'Ubuntu',
-          },
+            id: 'Ubuntu'
+          }
         },
+        puppet_vardir: '/opt/puppetlabs/puppet/cache'
       }
     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 || (rm /etc/apt/sources.list.d/user-ubuntu-foo-trusty.list && false)', # rubocop:disable Layout/LineLength
-                                                                                                              unless: '/usr/bin/test -f /etc/apt/sources.list.d/user-ubuntu-foo-trusty.list && /usr/bin/test -f /etc/apt/trusted.gpg.d/user_ubuntu_foo.gpg', # rubocop:disable Layout/LineLength
-                                                                                                              user: 'root',
-                                                                                                              logoutput: 'on_failure')
+      expect(subject).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
 
@@ -316,6 +391,7 @@ describe 'apt::ppa' do
     let :pre_condition do
       'class { "apt": }'
     end
+
     let :facts do
       {
         os: {
@@ -323,24 +399,32 @@ describe 'apt::ppa' do
           name: 'Ubuntu',
           release: {
             major: '18',
-            full: '18.04',
+            full: '18.04'
           },
           distro: {
             codename: 'trusty',
-            id: 'Ubuntu',
-          },
+            id: 'Ubuntu'
+          }
         },
+        puppet_vardir: '/opt/puppetlabs/puppet/cache'
       }
     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-ubuntu-foo-trusty.list').that_notifies('Class[Apt::Update]').with(ensure: 'absent')
+      expect(subject).to contain_tidy("remove-apt-repository-script-#{title}")
+        .with('path' => '/opt/puppetlabs/puppet/cache/add-apt-repository-user-ubuntu-foo-trusty.sh')
+
+      expect(subject).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
 
@@ -353,19 +437,20 @@ describe 'apt::ppa' do
             name: 'Ubuntu',
             release: {
               major: '18',
-              full: '18.04',
+              full: '18.04'
             },
             distro: {
               codename: nil,
-              id: 'Ubuntu',
-            },
-          },
+              id: 'Ubuntu'
+            }
+          }
         }
       end
+
       let(:title) { 'ppa:user/foo' }
 
       it do
-        is_expected.to raise_error(Puppet::Error, %r{os.distro.codename fact not available: release parameter required})
+        expect(subject).to raise_error(Puppet::Error, %r{os.distro.codename fact not available: release parameter required})
       end
     end
 
@@ -377,19 +462,20 @@ describe 'apt::ppa' do
             name: 'Debian',
             release: {
               major: '6',
-              full: '6.0.7',
+              full: '6.0.7'
             },
             distro: {
               codename: 'wheezy',
-              id: 'Debian',
-            },
-          },
+              id: 'Debian'
+            }
+          }
         }
       end
+
       let(:title) { 'ppa:user/foo' }
 
       it do
-        is_expected.to raise_error(Puppet::Error, %r{not currently supported on Debian})
+        expect(subject).to raise_error(Puppet::Error, %r{not currently supported on Debian})
       end
     end
   end