From 3a90419baaa36e206ddad9982ca6463cf367942c Mon Sep 17 00:00:00 2001 From: Craig Gumbley Date: Fri, 12 Aug 2022 12:15:33 +0000 Subject: [PATCH 1/1] Add spec test for add-apt-repository This commit adds spec tests that validate the changes made in the previous commit. --- spec/defines/ppa_spec.rb | 119 ++++++++++++++------------- spec/unit/facter/apt_sources_spec.rb | 20 +++++ 2 files changed, 83 insertions(+), 56 deletions(-) create mode 100644 spec/unit/facter/apt_sources_spec.rb diff --git a/spec/defines/ppa_spec.rb b/spec/defines/ppa_spec.rb index b5aadff..c056b5b 100644 --- a/spec/defines/ppa_spec.rb +++ b/spec/defines/ppa_spec.rb @@ -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": }' @@ -24,15 +33,13 @@ describe 'apt::ppa' do } 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') + is_expected.to contain_exec('add-apt-repository-ppa:needs/substitution') + .that_notifies('Class[Apt::Update]') + .with(*ppa_exec_params('needs', 'substitution')) } end @@ -57,11 +64,9 @@ describe 'apt::ppa' do 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') + is_expected.to contain_exec('add-apt-repository-ppa:user/foo') + .that_notifies('Class[Apt::Update]') + .with(*ppa_exec_params('user', 'foo', 'wily')) } end @@ -69,12 +74,14 @@ describe 'apt::ppa' do let :pre_condition do 'class { "apt": }' end + let :params do { package_name: 'software-properties-common', package_manage: true, } end + let :facts do { os: { @@ -92,19 +99,13 @@ describe 'apt::ppa' do } 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 + is_expected.to contain_exec('add-apt-repository-ppa:needs/substitution') + .that_notifies('Class[Apt::Update]') + .with(*ppa_exec_params('needs', 'substitution')) } end @@ -112,6 +113,7 @@ describe 'apt::ppa' do let :pre_condition do 'class { "apt": }' end + let :facts do { os: { @@ -128,25 +130,20 @@ describe 'apt::ppa' do }, } end + let :params do { 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 + is_expected.to contain_exec('add-apt-repository-ppa:needs/substitution') + .that_notifies('Class[Apt::Update]') + .with(*ppa_exec_params('needs', 'substitution')) } end @@ -156,6 +153,7 @@ describe 'apt::ppa' do apt::ppa { "ppa:user/foo2": } ' end + let :facts do { os: { @@ -172,23 +170,22 @@ describe 'apt::ppa' do }, } 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-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') + is_expected.to contain_exec('add-apt-repository-ppa:user/foo') + .that_notifies('Class[Apt::Update]') + .with(*ppa_exec_params('user', 'foo')) } end @@ -198,6 +195,7 @@ describe 'apt::ppa' do proxy => { "host" => "localhost" }, }' end + let :facts do { os: { @@ -214,21 +212,20 @@ describe 'apt::ppa' do }, } 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-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') + 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 @@ -238,6 +235,7 @@ describe 'apt::ppa' do proxy => { "host" => "localhost", "port" => 8180 }, }' end + let :facts do { os: { @@ -254,21 +252,20 @@ describe 'apt::ppa' do }, } 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-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') + 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 @@ -278,6 +275,7 @@ describe 'apt::ppa' do proxy => { "host" => "localhost", "port" => 8180, "https" => true }, }' end + let :facts do { os: { @@ -294,21 +292,20 @@ describe 'apt::ppa' do }, } 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-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') + 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 @@ -316,6 +313,7 @@ describe 'apt::ppa' do let :pre_condition do 'class { "apt": }' end + let :facts do { os: { @@ -332,7 +330,9 @@ describe 'apt::ppa' do }, } end + let(:title) { 'ppa:user/foo' } + let :params do { ensure: 'absent', @@ -340,7 +340,12 @@ describe 'apt::ppa' do 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') + 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 @@ -362,6 +367,7 @@ describe 'apt::ppa' do }, } end + let(:title) { 'ppa:user/foo' } it do @@ -386,6 +392,7 @@ describe 'apt::ppa' do }, } end + let(:title) { 'ppa:user/foo' } it do diff --git a/spec/unit/facter/apt_sources_spec.rb b/spec/unit/facter/apt_sources_spec.rb new file mode 100644 index 0000000..32d431a --- /dev/null +++ b/spec/unit/facter/apt_sources_spec.rb @@ -0,0 +1,20 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'apt_sources fact' do + subject { Facter.fact(:apt_sources).value } + + before(:each) { Facter.clear } + + describe 'returns a list of .list files' do + let(:sources_raw) { ['/etc/apt/sources.list.d/puppet-tools.list', '/etc/apt/sources.list.d/some-cli.list'] } + let(:sources_want) { ['sources.list', 'puppet-tools.list', 'some-cli.list'] } + + before(:each) do + allow(Dir).to receive(:glob).and_return(sources_raw) + end + + it { is_expected.to eq(sources_want) } + end +end -- 2.32.3