X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;f=spec%2Fclasses%2Fapt_spec.rb;h=a0219933946e168b88810622c4190c80ff4a9caa;hb=0e75ab7ce4b9ebeca33348b19c2957d5870af690;hp=4d44bcc78c726f528c324921882e5362e186de4e;hpb=3684f88372959cb8dd6eb5bce99b6a07db43f058;p=puppet-modules%2Fpuppetlabs-apt.git

diff --git a/spec/classes/apt_spec.rb b/spec/classes/apt_spec.rb
index 4d44bcc..84c6574 100644
--- a/spec/classes/apt_spec.rb
+++ b/spec/classes/apt_spec.rb
@@ -1,136 +1,608 @@
 require 'spec_helper'
-describe 'apt', :type => :class do
-  let :default_params do
+
+sources_list = {  ensure: 'file',
+                  path: '/etc/apt/sources.list',
+                  owner: 'root',
+                  group: 'root',
+                  notify: 'Class[Apt::Update]' }
+
+sources_list_d = { ensure: 'directory',
+                   path: '/etc/apt/sources.list.d',
+                   owner: 'root',
+                   group: 'root',
+                   purge: false,
+                   recurse: false,
+                   notify: 'Class[Apt::Update]' }
+
+preferences = { ensure: 'file',
+                path: '/etc/apt/preferences',
+                owner: 'root',
+                group: 'root',
+                notify: 'Class[Apt::Update]' }
+
+preferences_d = { ensure: 'directory',
+                  path: '/etc/apt/preferences.d',
+                  owner: 'root',
+                  group: 'root',
+                  purge: false,
+                  recurse: false,
+                  notify: 'Class[Apt::Update]' }
+
+apt_conf_d = {    ensure: 'directory',
+                  path: '/etc/apt/apt.conf.d',
+                  owner: 'root',
+                  group: 'root',
+                  purge: false,
+                  recurse: false,
+                  notify: 'Class[Apt::Update]' }
+
+describe 'apt' do
+  let(:facts) do
     {
-      :disable_keys => :undef,
-      :always_apt_update => false,
-      :purge_sources_list => false,
-      :purge_sources_list_d => false,
+      os: { family: 'Debian', name: 'Debian', release: { major: '8', full: '8.0' } },
+      lsbdistid: 'Debian',
+      osfamily: 'Debian',
+      lsbdistcodename: 'jessie',
     }
   end
 
-  [{},
-    {
-      :disable_keys => true,
-      :always_apt_update => true,
-      :proxy_host => true,
-      :proxy_port => '3128',
-      :purge_sources_list => true,
-      :purge_sources_list_d => true,
-    },
-    {
-      :disable_keys => false
+  context 'with defaults' do
+    it {
+      is_expected.to contain_file('sources.list').that_notifies('Class[Apt::Update]').only_with(sources_list)
     }
-  ].each do |param_set|
-    describe "when #{param_set == {} ? "using default" : "specifying"} class parameters" do
-      let :param_hash do
-        default_params.merge(param_set)
-      end
 
-      let :params do
-        param_set
-      end
+    it {
+      is_expected.to contain_file('sources.list.d').that_notifies('Class[Apt::Update]').only_with(sources_list_d)
+    }
 
-      let :refresh_only_apt_update do
-        if param_hash[:always_apt_update]
-          false
-        else
-          true
-        end
-      end
+    it {
+      is_expected.to contain_file('preferences').that_notifies('Class[Apt::Update]').only_with(preferences)
+    }
+
+    it {
+      is_expected.to contain_file('preferences.d').that_notifies('Class[Apt::Update]').only_with(preferences_d)
+    }
+
+    it {
+      is_expected.to contain_file('apt.conf.d').that_notifies('Class[Apt::Update]').only_with(apt_conf_d)
+    }
+
+    it { is_expected.to contain_file('/etc/apt/auth.conf').with_ensure('absent') }
+
+    it 'lays down /etc/apt/apt.conf.d/15update-stamp' do
+      is_expected.to contain_file('/etc/apt/apt.conf.d/15update-stamp').with(group: 'root',
+                                                                             owner: 'root').with_content(
+                                                                               %r{APT::Update::Post-Invoke-Success {"touch /var/lib/apt/periodic/update-success-stamp 2>/dev/null || true";};},
+                                                                             )
+    end
+
+    it {
+      is_expected.to contain_exec('apt_update').with(refreshonly: 'true')
+    }
 
-      it { should include_class("apt::params") }
+    it { is_expected.not_to contain_apt__setting('conf-proxy') }
+  end
 
-      it { should contain_package("python-software-properties") }
+  describe 'proxy=' do
+    context 'when host=localhost' do
+      let(:params) { { proxy: { 'host' => 'localhost' } } }
 
       it {
-        if param_hash[:purge_sources_list]
-        should contain_file("sources.list").with({
-            'path'    => "/etc/apt/sources.list",
-            'ensure'  => "present",
-            'owner'   => "root",
-            'group'   => "root",
-            'mode'    => "0644",
-            "content" => "# Repos managed by puppet.\n"
-          })
-        else
-        should contain_file("sources.list").with({
-            'path'    => "/etc/apt/sources.list",
-            'ensure'  => "present",
-            'owner'   => "root",
-            'group'   => "root",
-            'mode'    => "0644",
-            'content' => nil
-          })
-        end
+        is_expected.to contain_apt__setting('conf-proxy').with(priority: '01').with_content(
+          %r{Acquire::http::proxy "http://localhost:8080/";},
+        ).without_content(
+          %r{Acquire::https::proxy},
+        )
       }
+    end
+
+    context 'when host=localhost and port=8180' do
+      let(:params) { { proxy: { 'host' => 'localhost', 'port' => 8180 } } }
+
       it {
-        if param_hash[:purge_sources_list_d]
-          should create_file("sources.list.d").with({
-            'path'    => "/etc/apt/sources.list.d",
-            'ensure'  => "directory",
-            'owner'   => "root",
-            'group'   => "root",
-            'purge'   => true,
-            'recurse' => true,
-            'notify'  => 'Exec[apt update]'
-          })
-        else
-          should create_file("sources.list.d").with({
-            'path'    => "/etc/apt/sources.list.d",
-            'ensure'  => "directory",
-            'owner'   => "root",
-            'group'   => "root",
-            'purge'   => false,
-            'recurse' => false,
-            'notify'  => 'Exec[apt update]'
-          })
-        end
+        is_expected.to contain_apt__setting('conf-proxy').with(priority: '01').with_content(
+          %r{Acquire::http::proxy "http://localhost:8180/";},
+        ).without_content(
+          %r{Acquire::https::proxy},
+        )
+      }
+    end
+
+    context 'when host=localhost and https=true' do
+      let(:params) { { proxy: { 'host' => 'localhost', 'https' => true } } }
+
+      it {
+        is_expected.to contain_apt__setting('conf-proxy').with(priority: '01').with_content(
+          %r{Acquire::http::proxy "http://localhost:8080/";},
+        ).with_content(
+          %r{Acquire::https::proxy "https://localhost:8080/";},
+        )
       }
+    end
+
+    context 'when host=localhost and direct=true' do
+      let(:params) { { proxy: { 'host' => 'localhost', 'direct' => true } } }
 
       it {
-        should contain_exec("apt update").with({
-          'command'     => "/usr/bin/apt-get update",
-          'refreshonly' => refresh_only_apt_update
-        })
+        is_expected.to contain_apt__setting('conf-proxy').with(priority: '01').with_content(
+          %r{Acquire::http::proxy "http://localhost:8080/";},
+        ).with_content(
+          %r{Acquire::https::proxy "DIRECT";},
+        )
       }
+    end
+
+    context 'when host=localhost and https=true and direct=true' do
+      let(:params) { { proxy: { 'host' => 'localhost', 'https' => true, 'direct' => true } } }
 
       it {
-        if param_hash[:disable_keys] == true
-          should create_file("99unauth").with({
-            'content' => "APT::Get::AllowUnauthenticated 1;\n",
-            'ensure'  => "present",
-            'path'    => "/etc/apt/apt.conf.d/99unauth"
-          })
-        elsif param_hash[:disable_keys] == false
-          should create_file("99unauth").with({
-            'ensure' => "absent",
-            'path'   => "/etc/apt/apt.conf.d/99unauth"
-          })
-        elsif param_hash[:disable_keys] != :undef
-          should_not create_file("99unauth").with({
-            'path'   => "/etc/apt/apt.conf.d/99unauth"
-          })
-        end
+        is_expected.to contain_apt__setting('conf-proxy').with(priority: '01').with_content(
+          %r{Acquire::http::proxy "http://localhost:8080/";},
+        ).with_content(
+          %r{Acquire::https::proxy "https://localhost:8080/";},
+        )
+      }
+      it {
+        is_expected.to contain_apt__setting('conf-proxy').with(priority: '01').with_content(
+          %r{Acquire::http::proxy "http://localhost:8080/";},
+        ).without_content(
+          %r{Acquire::https::proxy "DIRECT";},
+        )
+      }
+    end
+
+    context 'when ensure=absent' do
+      let(:params) { { proxy: { 'ensure' => 'absent' } } }
+
+      it {
+        is_expected.to contain_apt__setting('conf-proxy').with(ensure: 'absent',
+                                                               priority: '01')
+      }
+    end
+  end
+  context 'with lots of non-defaults' do
+    let :params do
+      {
+        update: { 'frequency' => 'always', 'timeout' => 1, 'tries' => 3 },
+        purge: { 'sources.list' => false, 'sources.list.d' => false,
+                 'preferences' => false, 'preferences.d' => false,
+                 'apt.conf.d' => false },
+      }
+    end
+
+    it {
+      is_expected.to contain_file('sources.list').with(content: nil)
+    }
+
+    it {
+      is_expected.to contain_file('sources.list.d').with(purge: false,
+                                                         recurse: false)
+    }
+
+    it {
+      is_expected.to contain_file('preferences').with(ensure: 'file')
+    }
+
+    it {
+      is_expected.to contain_file('preferences.d').with(purge: false,
+                                                        recurse: false)
+    }
+
+    it {
+      is_expected.to contain_file('apt.conf.d').with(purge: false,
+                                                     recurse: false)
+    }
+
+    it {
+      is_expected.to contain_exec('apt_update').with(refreshonly: false,
+                                                     timeout: 1,
+                                                     tries: 3)
+    }
+  end
+
+  context 'with lots of non-defaults' do
+    let :params do
+      {
+        update: { 'frequency' => 'always', 'timeout' => 1, 'tries' => 3 },
+        purge: { 'sources.list' => true, 'sources.list.d' => true,
+                 'preferences' => true, 'preferences.d' => true,
+                 'apt.conf.d' => true },
+      }
+    end
+
+    it {
+      is_expected.to contain_file('sources.list').with(content: "# Repos managed by puppet.\n")
+    }
+
+    it {
+      is_expected.to contain_file('sources.list.d').with(purge: true,
+                                                         recurse: true)
+    }
+
+    it {
+      is_expected.to contain_file('preferences').with(ensure: 'absent')
+    }
+
+    it {
+      is_expected.to contain_file('preferences.d').with(purge: true,
+                                                        recurse: true)
+    }
+
+    it {
+      is_expected.to contain_file('apt.conf.d').with(purge: true,
+                                                     recurse: true)
+    }
+
+    it {
+      is_expected.to contain_exec('apt_update').with(refreshonly: false,
+                                                     timeout: 1,
+                                                     tries: 3)
+    }
+  end
+
+  context 'with defaults for sources_list_force' do
+    let :params do
+      {
+        update: { 'frequency' => 'always', 'timeout' => 1, 'tries' => 3 },
+        purge: { 'sources.list' => true },
+        sources_list_force: false,
       }
-      describe 'when setting a proxy' do
-        it {
-          if param_hash[:proxy_host]
-            should contain_file('configure-apt-proxy').with(
-              'path'    => '/etc/apt/apt.conf.d/proxy',
-              'content' => "Acquire::http::Proxy \"http://#{param_hash[:proxy_host]}:#{param_hash[:proxy_port]}\";",
-              'notify'  => "Exec[apt update]"
-            )
-          else
-            should_not contain_file('configure_apt_proxy')
+    end
+
+    it {
+      is_expected.to contain_file('sources.list').with(content: "# Repos managed by puppet.\n")
+    }
+  end
+
+  context 'with non defaults for sources_list_force' do
+    let :params do
+      {
+        update: { 'frequency' => 'always', 'timeout' => 1, 'tries' => 3 },
+        purge: { 'sources.list' => true },
+        sources_list_force: true,
+      }
+    end
+
+    it {
+      is_expected.to contain_file('sources.list').with(ensure: 'absent')
+    }
+  end
+
+  context 'with entries for /etc/apt/auth.conf' do
+    facts_hash = {
+      'Ubuntu 14.04' => {
+        os: { family: 'Debian', name: 'Ubuntu', release: { major: '14', full: '14.04' } },
+        osfamily: 'Debian',
+        lsbdistcodename: 'trusty',
+        lsbdistid: 'Ubuntu',
+        lsbdistrelease: '14.04',
+      },
+      'Ubuntu 16.04' => {
+        os: { family: 'Debian', name: 'Ubuntu', release: { major: '16', full: '16.04' } },
+        osfamily: 'Debian',
+        lsbdistcodename: 'xenial',
+        lsbdistid: 'Ubuntu',
+        lsbdistrelease: '16.04',
+      },
+      'Ubuntu 18.04' => {
+        os: { family: 'Debian', name: 'Ubuntu', release: { major: '18', full: '18.04' } },
+        osfamily: 'Debian',
+        lsbdistcodename: 'bionic',
+        lsbdistid: 'Ubuntu',
+        lsbdistrelease: '18.04',
+      },
+      'Debian 7.0' => {
+        os: { family: 'Debian', name: 'Debian', release: { major: '7', full: '7.0' } },
+        lsbdistid: 'Debian',
+        osfamily: 'Debian',
+        lsbdistcodename: 'wheezy',
+      },
+      'Debian 8.0' => {
+        os: { family: 'Debian', name: 'Debian', release: { major: '8', full: '8.0' } },
+        lsbdistid: 'Debian',
+        osfamily: 'Debian',
+        lsbdistcodename: 'jessie',
+      },
+      'Debian 9.0' => {
+        os: { family: 'Debian', name: 'Debian', release: { major: '9', full: '9.0' } },
+        lsbdistid: 'Debian',
+        osfamily: 'Debian',
+        lsbdistcodename: 'stretch',
+      },
+      'Debian 10.0' => {
+        os: { family: 'Debian', name: 'Debian', release: { major: '10', full: '10.0' } },
+        lsbdistid: 'Debian',
+        osfamily: 'Debian',
+        lsbdistcodename: 'buster',
+      },
+    }
+
+    facts_hash.each do |os, facts|
+      context "on #{os}" do
+        let(:facts) do
+          facts
+        end
+        let(:params) do
+          {
+            auth_conf_entries: [
+              {
+                machine: 'deb.example.net',
+                login: 'foologin',
+                password: 'secret',
+              },
+              {
+                machine: 'apt.example.com',
+                login: 'aptlogin',
+                password: 'supersecret',
+              },
+            ],
+          }
+        end
+
+        context 'with manage_auth_conf => true' do
+          let(:params) do
+            super().merge(manage_auth_conf: true)
+          end
+
+          # Going forward starting with Ubuntu 16.04 and Debian 9.0
+          # /etc/apt/auth.conf is owned by _apt. In previous versions it is
+          # root.
+          auth_conf_owner = case os
+                            when 'Ubuntu 14.04', 'Debian 7.0', 'Debian 8.0'
+                              'root'
+                            else
+                              '_apt'
+                            end
+
+          auth_conf_content = "// This file is managed by Puppet. DO NOT EDIT.
+machine deb.example.net login foologin password secret
+machine apt.example.com login aptlogin password supersecret
+"
+
+          it {
+            is_expected.to contain_file('/etc/apt/auth.conf').with(ensure: 'present',
+                                                                   owner: auth_conf_owner,
+                                                                   group: 'root',
+                                                                   mode: '0600',
+                                                                   notify: 'Class[Apt::Update]',
+                                                                   content: auth_conf_content)
+          }
+        end
+
+        context 'with manage_auth_conf => false' do
+          let(:params) do
+            super().merge(manage_auth_conf: false)
           end
-        }
+
+          it {
+            is_expected.not_to contain_file('/etc/apt/auth.conf')
+          }
+        end
       end
+
+      context 'with improperly specified entries for /etc/apt/auth.conf' do
+        let(:params) do
+          {
+            auth_conf_entries: [
+              {
+                machinn: 'deb.example.net',
+                username: 'foologin',
+                password: 'secret',
+              },
+              {
+                machine: 'apt.example.com',
+                login: 'aptlogin',
+                password: 'supersecret',
+              },
+            ],
+          }
+        end
+
+        it { is_expected.to raise_error(Puppet::Error) }
+      end
+    end
+  end
+
+  context 'with sources defined on valid osfamily' do
+    let :facts do
+      {
+        os: { family: 'Debian', name: 'Ubuntu', release: { major: '16', full: '16.04' } },
+        osfamily: 'Debian',
+        lsbdistcodename: 'xenial',
+        lsbdistid: 'Ubuntu',
+        lsbdistrelease: '16.04',
+      }
+    end
+    let(:params) do
+      { sources: {
+        'debian_unstable' => {
+          'location'          => 'http://debian.mirror.iweb.ca/debian/',
+          'release'           => 'unstable',
+          'repos'             => 'main contrib non-free',
+          'key'               => { 'id' => '150C8614919D8446E01E83AF9AA38DCD55BE302B', 'server' => 'subkeys.pgp.net' },
+          'pin'               => '-10',
+          'include'           => { 'src' => true },
+        },
+        'puppetlabs' => {
+          'location' => 'http://apt.puppetlabs.com',
+          'repos'      => 'main',
+          'key'        => { 'id' => '6F6B15509CF8E59E6E469F327F438280EF8D349F', 'server' => 'pgp.mit.edu' },
+        },
+      } }
+    end
+
+    it {
+      is_expected.to contain_apt__setting('list-debian_unstable').with(ensure: 'present')
+    }
+
+    it { is_expected.to contain_file('/etc/apt/sources.list.d/debian_unstable.list').with_content(%r{^deb http://debian.mirror.iweb.ca/debian/ unstable main contrib non-free$}) }
+    it { is_expected.to contain_file('/etc/apt/sources.list.d/debian_unstable.list').with_content(%r{^deb-src http://debian.mirror.iweb.ca/debian/ unstable main contrib non-free$}) }
+
+    it {
+      is_expected.to contain_apt__setting('list-puppetlabs').with(ensure: 'present')
+    }
+
+    it { is_expected.to contain_file('/etc/apt/sources.list.d/puppetlabs.list').with_content(%r{^deb http://apt.puppetlabs.com xenial main$}) }
+  end
+
+  context 'with confs defined on valid osfamily' do
+    let :facts do
+      {
+        os: { family: 'Debian', name: 'Ubuntu', release: { major: '16', full: '16.04' } },
+        osfamily: 'Debian',
+        lsbdistcodename: 'xenial',
+        lsbdistid: 'Ubuntu',
+      }
     end
+    let(:params) do
+      { confs: {
+        'foo' => {
+          'content' => 'foo',
+        },
+        'bar' => {
+          'content' => 'bar',
+        },
+      } }
+    end
+
+    it {
+      is_expected.to contain_apt__conf('foo').with(content: 'foo')
+    }
+
+    it {
+      is_expected.to contain_apt__conf('bar').with(content: 'bar')
+    }
   end
 
-  describe "it should not error if package['python-software-properties'] is already defined" do
-    let(:pre_condition) { 'package { "python-software-properties": }->Class["Apt"]' }
-    it { should contain_package("python-software-properties") }
+  context 'with keys defined on valid osfamily' do
+    let :facts do
+      {
+        os: { family: 'Debian', name: 'Ubuntu', release: { major: '16', full: '16.04' } },
+        osfamily: 'Debian',
+        lsbdistcodename: 'xenial',
+        lsbdistid: 'Ubuntu',
+      }
+    end
+    let(:params) do
+      { keys: {
+        '55BE302B' => {
+          'server' => 'subkeys.pgp.net',
+        },
+        'EF8D349F' => {
+          'server' => 'pgp.mit.edu',
+        },
+      } }
+    end
+
+    it {
+      is_expected.to contain_apt__key('55BE302B').with(server: 'subkeys.pgp.net')
+    }
+
+    it {
+      is_expected.to contain_apt__key('EF8D349F').with(server: 'pgp.mit.edu')
+    }
+  end
+
+  context 'with ppas defined on valid osfamily' do
+    let :facts do
+      {
+        os: { family: 'Debian', name: 'Ubuntu', release: { major: '16', full: '16.04' } },
+        osfamily: 'Debian',
+        lsbdistcodename: 'xenial',
+        lsbdistid: 'Ubuntu',
+        lsbdistrelease: '16.04',
+      }
+    end
+    let(:params) do
+      { ppas: {
+        'ppa:drizzle-developers/ppa' => {},
+        'ppa:nginx/stable' => {},
+      } }
+    end
+
+    it { is_expected.to contain_apt__ppa('ppa:drizzle-developers/ppa') }
+    it { is_expected.to contain_apt__ppa('ppa:nginx/stable') }
+  end
+
+  context 'with settings defined on valid osfamily' do
+    let :facts do
+      {
+        os: { family: 'Debian', name: 'Ubuntu', release: { major: '16', full: '16.04' } },
+        osfamily: 'Debian',
+        lsbdistcodename: 'xenial',
+        lsbdistid: 'Ubuntu',
+      }
+    end
+    let(:params) do
+      { settings: {
+        'conf-banana' => { 'content' => 'banana' },
+        'pref-banana' => { 'content' => 'banana' },
+      } }
+    end
+
+    it { is_expected.to contain_apt__setting('conf-banana') }
+    it { is_expected.to contain_apt__setting('pref-banana') }
+  end
+
+  context 'with pins defined on valid osfamily' do
+    let :facts do
+      {
+        os: { family: 'Debian', name: 'Ubuntu', release: { major: '16', full: '16.04' } },
+        osfamily: 'Debian',
+        lsbdistcodename: 'xenial',
+        lsbdistid: 'Ubuntu',
+      }
+    end
+    let(:params) do
+      { pins: {
+        'stable' => { 'priority' => 600, 'order' => 50 },
+        'testing' =>  { 'priority' => 700, 'order' => 100 },
+      } }
+    end
+
+    it { is_expected.to contain_apt__pin('stable') }
+    it { is_expected.to contain_apt__pin('testing') }
+  end
+
+  describe 'failing tests' do
+    context "with purge['sources.list']=>'banana'" do
+      let(:params) { { purge: { 'sources.list' => 'banana' } } }
+
+      it do
+        is_expected.to raise_error(Puppet::Error)
+      end
+    end
+
+    context "with purge['sources.list.d']=>'banana'" do
+      let(:params) { { purge: { 'sources.list.d' => 'banana' } } }
+
+      it do
+        is_expected.to raise_error(Puppet::Error)
+      end
+    end
+
+    context "with purge['preferences']=>'banana'" do
+      let(:params) { { purge: { 'preferences' => 'banana' } } }
+
+      it do
+        is_expected.to raise_error(Puppet::Error)
+      end
+    end
+
+    context "with purge['preferences.d']=>'banana'" do
+      let(:params) { { purge: { 'preferences.d' => 'banana' } } }
+
+      it do
+        is_expected.to raise_error(Puppet::Error)
+      end
+    end
+
+    context "with purge['apt.conf.d']=>'banana'" do
+      let(:params) { { purge: { 'apt.conf.d' => 'banana' } } }
+
+      it do
+        is_expected.to raise_error(Puppet::Error)
+      end
+    end
   end
 end